Commit 176544dc authored by Jean Delvare's avatar Jean Delvare Committed by Mark M. Hoffman

hwmon: Update the sysfs interface documentation

* Document the name attribute.
* Document the *_label attributes.
* Drop "typical usage" lists, they no longer match the reality.
* Drop non hardware-monitoring related entries.
Signed-off-by: default avatarJean Delvare <khali@linux-fr.org>
Acked-by: default avatarHans de Goede <j.w.r.degoede@hhs.nl>
Signed-off-by: default avatarMark M. Hoffman <mhoffman@lightlink.com>
parent 8477d026
...@@ -78,8 +78,21 @@ RW read/write value ...@@ -78,8 +78,21 @@ RW read/write value
Read/write values may be read-only for some chips, depending on the Read/write values may be read-only for some chips, depending on the
hardware implementation. hardware implementation.
All entries are optional, and should only be created in a given driver All entries (except name) are optional, and should only be created in a
if the chip has the feature. given driver if the chip has the feature.
********
* Name *
********
name The chip name.
This should be a short, lowercase string, not containing
spaces nor dashes, representing the chip name. This is
the only mandatory attribute.
I2C devices get this attribute created automatically.
RO
************ ************
* Voltages * * Voltages *
...@@ -104,18 +117,17 @@ in[0-*]_input Voltage input value. ...@@ -104,18 +117,17 @@ in[0-*]_input Voltage input value.
by the chip driver, and must be done by the application. by the chip driver, and must be done by the application.
However, some drivers (notably lm87 and via686a) However, some drivers (notably lm87 and via686a)
do scale, because of internal resistors built into a chip. do scale, because of internal resistors built into a chip.
These drivers will output the actual voltage. These drivers will output the actual voltage. Rule of
thumb: drivers should report the voltage values at the
Typical usage: "pins" of the chip.
in0_* CPU #1 voltage (not scaled)
in1_* CPU #2 voltage (not scaled) in[0-*]_label Suggested voltage channel label.
in2_* 3.3V nominal (not scaled) Text string
in3_* 5.0V nominal (scaled) Should only be created if the driver has hints about what
in4_* 12.0V nominal (scaled) this voltage channel is being used for, and user-space
in5_* -12.0V nominal (scaled) doesn't. In all other cases, the label is provided by
in6_* -5.0V nominal (scaled) user-space.
in7_* varies RO
in8_* varies
cpu[0-*]_vid CPU core reference voltage. cpu[0-*]_vid CPU core reference voltage.
Unit: millivolt Unit: millivolt
...@@ -159,6 +171,13 @@ fan[1-*]_target ...@@ -159,6 +171,13 @@ fan[1-*]_target
Only makes sense if the chip supports closed-loop fan speed Only makes sense if the chip supports closed-loop fan speed
control based on the measured fan speed. control based on the measured fan speed.
fan[1-*]_label Suggested fan channel label.
Text string
Should only be created if the driver has hints about what
this fan channel is being used for, and user-space doesn't.
In all other cases, the label is provided by user-space.
RO
Also see the Alarms section for status flags associated with fans. Also see the Alarms section for status flags associated with fans.
...@@ -260,18 +279,19 @@ temp[1-*]_crit_hyst ...@@ -260,18 +279,19 @@ temp[1-*]_crit_hyst
from the critical value. from the critical value.
RW RW
temp[1-4]_offset temp[1-*]_offset
Temperature offset which is added to the temperature reading Temperature offset which is added to the temperature reading
by the chip. by the chip.
Unit: millidegree Celsius Unit: millidegree Celsius
Read/Write value. Read/Write value.
If there are multiple temperature sensors, temp1_* is temp[1-*]_label Suggested temperature channel label.
generally the sensor inside the chip itself, Text string
reported as "motherboard temperature". temp2_* to Should only be created if the driver has hints about what
temp4_* are generally sensors external to the chip this temperature channel is being used for, and user-space
itself, for example the thermal diode inside the CPU or doesn't. In all other cases, the label is provided by
a thermistor nearby. user-space.
RO
Some chips measure temperature using external thermistors and an ADC, and Some chips measure temperature using external thermistors and an ADC, and
report the temperature measurement as a voltage. Converting this voltage report the temperature measurement as a voltage. Converting this voltage
...@@ -391,16 +411,3 @@ beep_mask Bitmask for beep. ...@@ -391,16 +411,3 @@ beep_mask Bitmask for beep.
use discouraged for the same reason. Use individual use discouraged for the same reason. Use individual
*_beep files instead. *_beep files instead.
RW RW
*********
* Other *
*********
eeprom Raw EEPROM data in binary form.
RO
pec Enable or disable PEC (SMBus only)
0: disable
1: enable
RW
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment