diff options
-rw-r--r-- | Documentation/hwmon/sysfs-interface | 75 |
1 files changed, 41 insertions, 34 deletions
diff --git a/Documentation/hwmon/sysfs-interface b/Documentation/hwmon/sysfs-interface index 331fa7a1d7d5..db7bb4a659c4 100644 --- a/Documentation/hwmon/sysfs-interface +++ b/Documentation/hwmon/sysfs-interface | |||
@@ -78,8 +78,21 @@ RW read/write value | |||
78 | Read/write values may be read-only for some chips, depending on the | 78 | Read/write values may be read-only for some chips, depending on the |
79 | hardware implementation. | 79 | hardware implementation. |
80 | 80 | ||
81 | All entries are optional, and should only be created in a given driver | 81 | All entries (except name) are optional, and should only be created in a |
82 | if the chip has the feature. | 82 | given driver if the chip has the feature. |
83 | |||
84 | |||
85 | ******** | ||
86 | * Name * | ||
87 | ******** | ||
88 | |||
89 | name The chip name. | ||
90 | This should be a short, lowercase string, not containing | ||
91 | spaces nor dashes, representing the chip name. This is | ||
92 | the only mandatory attribute. | ||
93 | I2C devices get this attribute created automatically. | ||
94 | RO | ||
95 | |||
83 | 96 | ||
84 | ************ | 97 | ************ |
85 | * Voltages * | 98 | * Voltages * |
@@ -104,18 +117,17 @@ in[0-*]_input Voltage input value. | |||
104 | by the chip driver, and must be done by the application. | 117 | by the chip driver, and must be done by the application. |
105 | However, some drivers (notably lm87 and via686a) | 118 | However, some drivers (notably lm87 and via686a) |
106 | do scale, because of internal resistors built into a chip. | 119 | do scale, because of internal resistors built into a chip. |
107 | These drivers will output the actual voltage. | 120 | These drivers will output the actual voltage. Rule of |
108 | 121 | thumb: drivers should report the voltage values at the | |
109 | Typical usage: | 122 | "pins" of the chip. |
110 | in0_* CPU #1 voltage (not scaled) | 123 | |
111 | in1_* CPU #2 voltage (not scaled) | 124 | in[0-*]_label Suggested voltage channel label. |
112 | in2_* 3.3V nominal (not scaled) | 125 | Text string |
113 | in3_* 5.0V nominal (scaled) | 126 | Should only be created if the driver has hints about what |
114 | in4_* 12.0V nominal (scaled) | 127 | this voltage channel is being used for, and user-space |
115 | in5_* -12.0V nominal (scaled) | 128 | doesn't. In all other cases, the label is provided by |
116 | in6_* -5.0V nominal (scaled) | 129 | user-space. |
117 | in7_* varies | 130 | RO |
118 | in8_* varies | ||
119 | 131 | ||
120 | cpu[0-*]_vid CPU core reference voltage. | 132 | cpu[0-*]_vid CPU core reference voltage. |
121 | Unit: millivolt | 133 | Unit: millivolt |
@@ -159,6 +171,13 @@ fan[1-*]_target | |||
159 | Only makes sense if the chip supports closed-loop fan speed | 171 | Only makes sense if the chip supports closed-loop fan speed |
160 | control based on the measured fan speed. | 172 | control based on the measured fan speed. |
161 | 173 | ||
174 | fan[1-*]_label Suggested fan channel label. | ||
175 | Text string | ||
176 | Should only be created if the driver has hints about what | ||
177 | this fan channel is being used for, and user-space doesn't. | ||
178 | In all other cases, the label is provided by user-space. | ||
179 | RO | ||
180 | |||
162 | Also see the Alarms section for status flags associated with fans. | 181 | Also see the Alarms section for status flags associated with fans. |
163 | 182 | ||
164 | 183 | ||
@@ -260,18 +279,19 @@ temp[1-*]_crit_hyst | |||
260 | from the critical value. | 279 | from the critical value. |
261 | RW | 280 | RW |
262 | 281 | ||
263 | temp[1-4]_offset | 282 | temp[1-*]_offset |
264 | Temperature offset which is added to the temperature reading | 283 | Temperature offset which is added to the temperature reading |
265 | by the chip. | 284 | by the chip. |
266 | Unit: millidegree Celsius | 285 | Unit: millidegree Celsius |
267 | Read/Write value. | 286 | Read/Write value. |
268 | 287 | ||
269 | If there are multiple temperature sensors, temp1_* is | 288 | temp[1-*]_label Suggested temperature channel label. |
270 | generally the sensor inside the chip itself, | 289 | Text string |
271 | reported as "motherboard temperature". temp2_* to | 290 | Should only be created if the driver has hints about what |
272 | temp4_* are generally sensors external to the chip | 291 | this temperature channel is being used for, and user-space |
273 | itself, for example the thermal diode inside the CPU or | 292 | doesn't. In all other cases, the label is provided by |
274 | a thermistor nearby. | 293 | user-space. |
294 | RO | ||
275 | 295 | ||
276 | Some chips measure temperature using external thermistors and an ADC, and | 296 | Some chips measure temperature using external thermistors and an ADC, and |
277 | report the temperature measurement as a voltage. Converting this voltage | 297 | report the temperature measurement as a voltage. Converting this voltage |
@@ -391,16 +411,3 @@ beep_mask Bitmask for beep. | |||
391 | use discouraged for the same reason. Use individual | 411 | use discouraged for the same reason. Use individual |
392 | *_beep files instead. | 412 | *_beep files instead. |
393 | RW | 413 | RW |
394 | |||
395 | |||
396 | ********* | ||
397 | * Other * | ||
398 | ********* | ||
399 | |||
400 | eeprom Raw EEPROM data in binary form. | ||
401 | RO | ||
402 | |||
403 | pec Enable or disable PEC (SMBus only) | ||
404 | 0: disable | ||
405 | 1: enable | ||
406 | RW | ||