1Kernel Driver IBMPOWERNV
2========================
3
4Supported systems:
5
6  * Any recent IBM P servers based on POWERNV platform
7
8Author: Neelesh Gupta
9
10Description
11-----------
12
13This driver implements reading the platform sensors data like temperature/fan/
14voltage/power for 'POWERNV' platform.
15
16The driver uses the platform device infrastructure. It probes the device tree
17for sensor devices during the __init phase and registers them with the 'hwmon'.
18'hwmon' populates the 'sysfs' tree having attribute files, each for a given
19sensor type and its attribute data.
20
21All the nodes in the DT appear under "/ibm,opal/sensors" and each valid node in
22the DT maps to an attribute file in 'sysfs'. The node exports unique 'sensor-id'
23which the driver uses to make an OPAL call to the firmware.
24
25Usage notes
26-----------
27The driver is built statically with the kernel by enabling the config
28CONFIG_SENSORS_IBMPOWERNV. It can also be built as module 'ibmpowernv'.
29
30Sysfs attributes
31----------------
32
33======================= =======================================================
34fanX_input		Measured RPM value.
35fanX_min		Threshold RPM for alert generation.
36fanX_fault		- 0: No fail condition
37			- 1: Failing fan
38
39tempX_input		Measured ambient temperature.
40tempX_max		Threshold ambient temperature for alert generation.
41tempX_highest		Historical maximum temperature
42tempX_lowest		Historical minimum temperature
43tempX_enable		Enable/disable all temperature sensors belonging to the
44			sub-group. In POWER9, this attribute corresponds to
45			each OCC. Using this attribute each OCC can be asked to
46			disable/enable all of its temperature sensors.
47
48			- 1: Enable
49			- 0: Disable
50
51inX_input		Measured power supply voltage (millivolt)
52inX_fault		- 0: No fail condition.
53			- 1: Failing power supply.
54inX_highest		Historical maximum voltage
55inX_lowest		Historical minimum voltage
56inX_enable		Enable/disable all voltage sensors belonging to the
57			sub-group. In POWER9, this attribute corresponds to
58			each OCC. Using this attribute each OCC can be asked to
59			disable/enable all of its voltage sensors.
60
61			- 1: Enable
62			- 0: Disable
63
64powerX_input		Power consumption (microWatt)
65powerX_input_highest	Historical maximum power
66powerX_input_lowest	Historical minimum power
67powerX_enable		Enable/disable all power sensors belonging to the
68			sub-group. In POWER9, this attribute corresponds to
69			each OCC. Using this attribute each OCC can be asked to
70			disable/enable all of its power sensors.
71
72			- 1: Enable
73			- 0: Disable
74
75currX_input		Measured current (milliampere)
76currX_highest		Historical maximum current
77currX_lowest		Historical minimum current
78currX_enable		Enable/disable all current sensors belonging to the
79			sub-group. In POWER9, this attribute corresponds to
80			each OCC. Using this attribute each OCC can be asked to
81			disable/enable all of its current sensors.
82
83			- 1: Enable
84			- 0: Disable
85
86energyX_input		Cumulative energy (microJoule)
87======================= =======================================================
88