hwmon: Document the sensor enable attribute
Document new ABI attributes: in[0-*]_enable fan[1-*]_enable temp[1-*]_enable curr[1-*]_enable power[1-*]_enable energy[1-*]_enable humidity[1-*]_enable Signed-off-by: Shilpasri G Bhat <shilpa.bhat@linux.vnet.ibm.com> [groeck: Updated commit text, removed unnecessary details from ABI description] Signed-off-by: Guenter Roeck <linux@roeck-us.net>
This commit is contained in:
parent
65afb4c8e7
commit
fb41a710f8
|
@ -171,6 +171,13 @@ in[0-*]_label Suggested voltage channel label.
|
|||
user-space.
|
||||
RO
|
||||
|
||||
in[0-*]_enable
|
||||
Enable or disable the sensors.
|
||||
When disabled the sensor read will return -ENODATA.
|
||||
1: Enable
|
||||
0: Disable
|
||||
RW
|
||||
|
||||
cpu[0-*]_vid CPU core reference voltage.
|
||||
Unit: millivolt
|
||||
RO
|
||||
|
@ -236,6 +243,13 @@ fan[1-*]_label Suggested fan channel label.
|
|||
In all other cases, the label is provided by user-space.
|
||||
RO
|
||||
|
||||
fan[1-*]_enable
|
||||
Enable or disable the sensors.
|
||||
When disabled the sensor read will return -ENODATA.
|
||||
1: Enable
|
||||
0: Disable
|
||||
RW
|
||||
|
||||
Also see the Alarms section for status flags associated with fans.
|
||||
|
||||
|
||||
|
@ -409,6 +423,13 @@ temp_reset_history
|
|||
Reset temp_lowest and temp_highest for all sensors
|
||||
WO
|
||||
|
||||
temp[1-*]_enable
|
||||
Enable or disable the sensors.
|
||||
When disabled the sensor read will return -ENODATA.
|
||||
1: Enable
|
||||
0: Disable
|
||||
RW
|
||||
|
||||
Some chips measure temperature using external thermistors and an ADC, and
|
||||
report the temperature measurement as a voltage. Converting this voltage
|
||||
back to a temperature (or the other way around for limits) requires
|
||||
|
@ -468,6 +489,13 @@ curr_reset_history
|
|||
Reset currX_lowest and currX_highest for all sensors
|
||||
WO
|
||||
|
||||
curr[1-*]_enable
|
||||
Enable or disable the sensors.
|
||||
When disabled the sensor read will return -ENODATA.
|
||||
1: Enable
|
||||
0: Disable
|
||||
RW
|
||||
|
||||
Also see the Alarms section for status flags associated with currents.
|
||||
|
||||
*********
|
||||
|
@ -566,6 +594,13 @@ power[1-*]_crit Critical maximum power.
|
|||
Unit: microWatt
|
||||
RW
|
||||
|
||||
power[1-*]_enable Enable or disable the sensors.
|
||||
When disabled the sensor read will return
|
||||
-ENODATA.
|
||||
1: Enable
|
||||
0: Disable
|
||||
RW
|
||||
|
||||
Also see the Alarms section for status flags associated with power readings.
|
||||
|
||||
**********
|
||||
|
@ -576,6 +611,12 @@ energy[1-*]_input Cumulative energy use
|
|||
Unit: microJoule
|
||||
RO
|
||||
|
||||
energy[1-*]_enable Enable or disable the sensors.
|
||||
When disabled the sensor read will return
|
||||
-ENODATA.
|
||||
1: Enable
|
||||
0: Disable
|
||||
RW
|
||||
|
||||
************
|
||||
* Humidity *
|
||||
|
@ -586,6 +627,13 @@ humidity[1-*]_input Humidity
|
|||
RO
|
||||
|
||||
|
||||
humidity[1-*]_enable Enable or disable the sensors
|
||||
When disabled the sensor read will return
|
||||
-ENODATA.
|
||||
1: Enable
|
||||
0: Disable
|
||||
RW
|
||||
|
||||
**********
|
||||
* Alarms *
|
||||
**********
|
||||
|
|
Loading…
Reference in New Issue