diff options
author | Rudolf Marek <r.marek@sh.cvut.cz> | 2006-06-04 14:03:39 -0400 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@suse.de> | 2006-06-22 14:10:33 -0400 |
commit | 057bc350992fa2ac31fcd2ff80add269bdf32a80 (patch) | |
tree | e07c0d21c7f8f1df8dace43004bdd2c5aa0682de | |
parent | 18f98b1e3147afdb51e545cc6ff2b016c7d088a7 (diff) |
[PATCH] hwmon: Sysfs interface documentation update, 1 of 2
This patch cleans up hwmon sysfs documentation file, plus introduces
the description of DC/PWM selection for fan speed control.
Signed-off-by: Rudolf Marek <r.marek@sh.cvut.cz>
Signed-off-by: Jean Delvare <khali@linux-fr.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
-rw-r--r-- | Documentation/hwmon/sysfs-interface | 181 |
1 files changed, 107 insertions, 74 deletions
diff --git a/Documentation/hwmon/sysfs-interface b/Documentation/hwmon/sysfs-interface index eeb912254db4..bc59a5113d17 100644 --- a/Documentation/hwmon/sysfs-interface +++ b/Documentation/hwmon/sysfs-interface | |||
@@ -69,28 +69,37 @@ to cause an alarm) is chip-dependent. | |||
69 | 69 | ||
70 | ------------------------------------------------------------------------- | 70 | ------------------------------------------------------------------------- |
71 | 71 | ||
72 | [0-*] denotes any positive number starting from 0 | ||
73 | [1-*] denotes any positive number starting from 1 | ||
74 | RO read only value | ||
75 | RW read/write value | ||
76 | |||
77 | Read/write values may be read-only for some chips, depending on the | ||
78 | hardware implementation. | ||
79 | |||
72 | ************ | 80 | ************ |
73 | * Voltages * | 81 | * Voltages * |
74 | ************ | 82 | ************ |
75 | 83 | ||
76 | in[0-8]_min Voltage min value. | 84 | in[0-*]_min Voltage min value. |
77 | Unit: millivolt | 85 | Unit: millivolt |
78 | Read/Write | 86 | RW |
79 | 87 | ||
80 | in[0-8]_max Voltage max value. | 88 | in[0-*]_max Voltage max value. |
81 | Unit: millivolt | 89 | Unit: millivolt |
82 | Read/Write | 90 | RW |
83 | 91 | ||
84 | in[0-8]_input Voltage input value. | 92 | in[0-*]_input Voltage input value. |
85 | Unit: millivolt | 93 | Unit: millivolt |
86 | Read only | 94 | RO |
95 | Voltage measured on the chip pin. | ||
87 | Actual voltage depends on the scaling resistors on the | 96 | Actual voltage depends on the scaling resistors on the |
88 | motherboard, as recommended in the chip datasheet. | 97 | motherboard, as recommended in the chip datasheet. |
89 | This varies by chip and by motherboard. | 98 | This varies by chip and by motherboard. |
90 | Because of this variation, values are generally NOT scaled | 99 | Because of this variation, values are generally NOT scaled |
91 | by the chip driver, and must be done by the application. | 100 | by the chip driver, and must be done by the application. |
92 | However, some drivers (notably lm87 and via686a) | 101 | However, some drivers (notably lm87 and via686a) |
93 | do scale, with various degrees of success. | 102 | do scale, because of internal resistors built into a chip. |
94 | These drivers will output the actual voltage. | 103 | These drivers will output the actual voltage. |
95 | 104 | ||
96 | Typical usage: | 105 | Typical usage: |
@@ -104,58 +113,72 @@ in[0-8]_input Voltage input value. | |||
104 | in7_* varies | 113 | in7_* varies |
105 | in8_* varies | 114 | in8_* varies |
106 | 115 | ||
107 | cpu[0-1]_vid CPU core reference voltage. | 116 | cpu[0-*]_vid CPU core reference voltage. |
108 | Unit: millivolt | 117 | Unit: millivolt |
109 | Read only. | 118 | RO |
110 | Not always correct. | 119 | Not always correct. |
111 | 120 | ||
112 | vrm Voltage Regulator Module version number. | 121 | vrm Voltage Regulator Module version number. |
113 | Read only. | 122 | RW (but changing it should no more be necessary) |
114 | Two digit number, first is major version, second is | 123 | Originally the VRM standard version multiplied by 10, but now |
115 | minor version. | 124 | an arbitrary number, as not all standards have a version |
125 | number. | ||
116 | Affects the way the driver calculates the CPU core reference | 126 | Affects the way the driver calculates the CPU core reference |
117 | voltage from the vid pins. | 127 | voltage from the vid pins. |
118 | 128 | ||
129 | Also see the Alarms section for status flags associated with voltages. | ||
130 | |||
119 | 131 | ||
120 | ******** | 132 | ******** |
121 | * Fans * | 133 | * Fans * |
122 | ******** | 134 | ******** |
123 | 135 | ||
124 | fan[1-3]_min Fan minimum value | 136 | fan[1-*]_min Fan minimum value |
125 | Unit: revolution/min (RPM) | 137 | Unit: revolution/min (RPM) |
126 | Read/Write. | 138 | RW |
127 | 139 | ||
128 | fan[1-3]_input Fan input value. | 140 | fan[1-*]_input Fan input value. |
129 | Unit: revolution/min (RPM) | 141 | Unit: revolution/min (RPM) |
130 | Read only. | 142 | RO |
131 | 143 | ||
132 | fan[1-3]_div Fan divisor. | 144 | fan[1-*]_div Fan divisor. |
133 | Integer value in powers of two (1, 2, 4, 8, 16, 32, 64, 128). | 145 | Integer value in powers of two (1, 2, 4, 8, 16, 32, 64, 128). |
146 | RW | ||
134 | Some chips only support values 1, 2, 4 and 8. | 147 | Some chips only support values 1, 2, 4 and 8. |
135 | Note that this is actually an internal clock divisor, which | 148 | Note that this is actually an internal clock divisor, which |
136 | affects the measurable speed range, not the read value. | 149 | affects the measurable speed range, not the read value. |
137 | 150 | ||
151 | Also see the Alarms section for status flags associated with fans. | ||
152 | |||
153 | |||
138 | ******* | 154 | ******* |
139 | * PWM * | 155 | * PWM * |
140 | ******* | 156 | ******* |
141 | 157 | ||
142 | pwm[1-3] Pulse width modulation fan control. | 158 | pwm[1-*] Pulse width modulation fan control. |
143 | Integer value in the range 0 to 255 | 159 | Integer value in the range 0 to 255 |
144 | Read/Write | 160 | RW |
145 | 255 is max or 100%. | 161 | 255 is max or 100%. |
146 | 162 | ||
147 | pwm[1-3]_enable | 163 | pwm[1-*]_enable |
148 | Switch PWM on and off. | 164 | Switch PWM on and off. |
149 | Not always present even if fan*_pwm is. | 165 | Not always present even if fan*_pwm is. |
150 | 0 to turn off | 166 | 0: turn off |
151 | 1 to turn on in manual mode | 167 | 1: turn on in manual mode |
152 | 2 to turn on in automatic mode | 168 | 2+: turn on in automatic mode |
153 | Read/Write | 169 | Check individual chip documentation files for automatic mode details. |
170 | RW | ||
171 | |||
172 | pwm[1-*]_mode | ||
173 | 0: DC mode | ||
174 | 1: PWM mode | ||
175 | RW | ||
154 | 176 | ||
155 | pwm[1-*]_auto_channels_temp | 177 | pwm[1-*]_auto_channels_temp |
156 | Select which temperature channels affect this PWM output in | 178 | Select which temperature channels affect this PWM output in |
157 | auto mode. Bitfield, 1 is temp1, 2 is temp2, 4 is temp3 etc... | 179 | auto mode. Bitfield, 1 is temp1, 2 is temp2, 4 is temp3 etc... |
158 | Which values are possible depend on the chip used. | 180 | Which values are possible depend on the chip used. |
181 | RW | ||
159 | 182 | ||
160 | pwm[1-*]_auto_point[1-*]_pwm | 183 | pwm[1-*]_auto_point[1-*]_pwm |
161 | pwm[1-*]_auto_point[1-*]_temp | 184 | pwm[1-*]_auto_point[1-*]_temp |
@@ -163,6 +186,7 @@ pwm[1-*]_auto_point[1-*]_temp_hyst | |||
163 | Define the PWM vs temperature curve. Number of trip points is | 186 | Define the PWM vs temperature curve. Number of trip points is |
164 | chip-dependent. Use this for chips which associate trip points | 187 | chip-dependent. Use this for chips which associate trip points |
165 | to PWM output channels. | 188 | to PWM output channels. |
189 | RW | ||
166 | 190 | ||
167 | OR | 191 | OR |
168 | 192 | ||
@@ -172,51 +196,52 @@ temp[1-*]_auto_point[1-*]_temp_hyst | |||
172 | Define the PWM vs temperature curve. Number of trip points is | 196 | Define the PWM vs temperature curve. Number of trip points is |
173 | chip-dependent. Use this for chips which associate trip points | 197 | chip-dependent. Use this for chips which associate trip points |
174 | to temperature channels. | 198 | to temperature channels. |
199 | RW | ||
175 | 200 | ||
176 | 201 | ||
177 | **************** | 202 | **************** |
178 | * Temperatures * | 203 | * Temperatures * |
179 | **************** | 204 | **************** |
180 | 205 | ||
181 | temp[1-3]_type Sensor type selection. | 206 | temp[1-*]_type Sensor type selection. |
182 | Integers 1 to 4 or thermistor Beta value (typically 3435) | 207 | Integers 1 to 4 or thermistor Beta value (typically 3435) |
183 | Read/Write. | 208 | RW |
184 | 1: PII/Celeron Diode | 209 | 1: PII/Celeron Diode |
185 | 2: 3904 transistor | 210 | 2: 3904 transistor |
186 | 3: thermal diode | 211 | 3: thermal diode |
187 | 4: thermistor (default/unknown Beta) | 212 | 4: thermistor (default/unknown Beta) |
188 | Not all types are supported by all chips | 213 | Not all types are supported by all chips |
189 | 214 | ||
190 | temp[1-4]_max Temperature max value. | 215 | temp[1-*]_max Temperature max value. |
191 | Unit: millidegree Celcius | 216 | Unit: millidegree Celcius |
192 | Read/Write value. | 217 | RW |
193 | 218 | ||
194 | temp[1-3]_min Temperature min value. | 219 | temp[1-*]_min Temperature min value. |
195 | Unit: millidegree Celcius | 220 | Unit: millidegree Celcius |
196 | Read/Write value. | 221 | RW |
197 | 222 | ||
198 | temp[1-3]_max_hyst | 223 | temp[1-*]_max_hyst |
199 | Temperature hysteresis value for max limit. | 224 | Temperature hysteresis value for max limit. |
200 | Unit: millidegree Celcius | 225 | Unit: millidegree Celcius |
201 | Must be reported as an absolute temperature, NOT a delta | 226 | Must be reported as an absolute temperature, NOT a delta |
202 | from the max value. | 227 | from the max value. |
203 | Read/Write value. | 228 | RW |
204 | 229 | ||
205 | temp[1-4]_input Temperature input value. | 230 | temp[1-*]_input Temperature input value. |
206 | Unit: millidegree Celcius | 231 | Unit: millidegree Celcius |
207 | Read only value. | 232 | RO |
208 | 233 | ||
209 | temp[1-4]_crit Temperature critical value, typically greater than | 234 | temp[1-*]_crit Temperature critical value, typically greater than |
210 | corresponding temp_max values. | 235 | corresponding temp_max values. |
211 | Unit: millidegree Celcius | 236 | Unit: millidegree Celcius |
212 | Read/Write value. | 237 | RW |
213 | 238 | ||
214 | temp[1-2]_crit_hyst | 239 | temp[1-*]_crit_hyst |
215 | Temperature hysteresis value for critical limit. | 240 | Temperature hysteresis value for critical limit. |
216 | Unit: millidegree Celcius | 241 | Unit: millidegree Celcius |
217 | Must be reported as an absolute temperature, NOT a delta | 242 | Must be reported as an absolute temperature, NOT a delta |
218 | from the critical value. | 243 | from the critical value. |
219 | Read/Write value. | 244 | RW |
220 | 245 | ||
221 | temp[1-4]_offset | 246 | temp[1-4]_offset |
222 | Temperature offset which is added to the temperature reading | 247 | Temperature offset which is added to the temperature reading |
@@ -231,6 +256,8 @@ temp[1-4]_offset | |||
231 | itself, for example the thermal diode inside the CPU or | 256 | itself, for example the thermal diode inside the CPU or |
232 | a thermistor nearby. | 257 | a thermistor nearby. |
233 | 258 | ||
259 | Also see the Alarms section for status flags associated with temperatures. | ||
260 | |||
234 | 261 | ||
235 | ************ | 262 | ************ |
236 | * Currents * | 263 | * Currents * |
@@ -239,17 +266,17 @@ temp[1-4]_offset | |||
239 | Note that no known chip provides current measurements as of writing, | 266 | Note that no known chip provides current measurements as of writing, |
240 | so this part is theoretical, so to say. | 267 | so this part is theoretical, so to say. |
241 | 268 | ||
242 | curr[1-n]_max Current max value | 269 | curr[1-*]_max Current max value |
243 | Unit: milliampere | 270 | Unit: milliampere |
244 | Read/Write. | 271 | RW |
245 | 272 | ||
246 | curr[1-n]_min Current min value. | 273 | curr[1-*]_min Current min value. |
247 | Unit: milliampere | 274 | Unit: milliampere |
248 | Read/Write. | 275 | RW |
249 | 276 | ||
250 | curr[1-n]_input Current input value | 277 | curr[1-*]_input Current input value |
251 | Unit: milliampere | 278 | Unit: milliampere |
252 | Read only. | 279 | RO |
253 | 280 | ||
254 | 281 | ||
255 | ********** | 282 | ********** |
@@ -263,50 +290,54 @@ Usually a given chip will either use channel-related alarms, or | |||
263 | limit-related alarms, not both. The driver should just reflect the hardware | 290 | limit-related alarms, not both. The driver should just reflect the hardware |
264 | implementation. | 291 | implementation. |
265 | 292 | ||
266 | in[0-n]_alarm | 293 | in[0-*]_alarm |
267 | fan[1-n]_alarm | 294 | fan[1-*]_alarm |
268 | temp[1-n]_alarm | 295 | temp[1-*]_alarm |
269 | Channel alarm | 296 | Channel alarm |
270 | Boolean | 297 | 0: no alarm |
271 | Read-only | 298 | 1: alarm |
299 | RO | ||
272 | 300 | ||
273 | OR | 301 | OR |
274 | 302 | ||
275 | in[0-n]_min_alarm | 303 | in[0-*]_min_alarm |
276 | in[0-n]_max_alarm | 304 | in[0-*]_max_alarm |
277 | fan[1-n]_min_alarm | 305 | fan[1-*]_min_alarm |
278 | temp[1-n]_min_alarm | 306 | temp[1-*]_min_alarm |
279 | temp[1-n]_max_alarm | 307 | temp[1-*]_max_alarm |
280 | temp[1-n]_crit_alarm | 308 | temp[1-*]_crit_alarm |
281 | Limit alarm | 309 | Limit alarm |
282 | Boolean | 310 | 0: no alarm |
283 | Read-only | 311 | 1: alarm |
312 | RO | ||
284 | 313 | ||
285 | Each input channel may have an associated fault file. This can be used | 314 | Each input channel may have an associated fault file. This can be used |
286 | to notify open diodes, unconnected fans etc. where the hardware | 315 | to notify open diodes, unconnected fans etc. where the hardware |
287 | supports it. When this boolean has value 1, the measurement for that | 316 | supports it. When this boolean has value 1, the measurement for that |
288 | channel should not be trusted. | 317 | channel should not be trusted. |
289 | 318 | ||
290 | in[0-n]_input_fault | 319 | in[0-*]_input_fault |
291 | fan[1-n]_input_fault | 320 | fan[1-*]_input_fault |
292 | temp[1-n]_input_fault | 321 | temp[1-*]_input_fault |
293 | Input fault condition | 322 | Input fault condition |
294 | Boolean | 323 | 0: no fault occured |
295 | Read-only | 324 | 1: fault condition |
325 | RO | ||
296 | 326 | ||
297 | Some chips also offer the possibility to get beeped when an alarm occurs: | 327 | Some chips also offer the possibility to get beeped when an alarm occurs: |
298 | 328 | ||
299 | beep_enable Master beep enable | 329 | beep_enable Master beep enable |
300 | Boolean | 330 | 0: no beeps |
301 | Read/Write | 331 | 1: beeps |
332 | RW | ||
302 | 333 | ||
303 | in[0-n]_beep | 334 | in[0-*]_beep |
304 | fan[1-n]_beep | 335 | fan[1-*]_beep |
305 | temp[1-n]_beep | 336 | temp[1-*]_beep |
306 | Channel beep | 337 | Channel beep |
307 | 0 to disable. | 338 | 0: disable |
308 | 1 to enable. | 339 | 1: enable |
309 | Read/write | 340 | RW |
310 | 341 | ||
311 | In theory, a chip could provide per-limit beep masking, but no such chip | 342 | In theory, a chip could provide per-limit beep masking, but no such chip |
312 | was seen so far. | 343 | was seen so far. |
@@ -316,7 +347,7 @@ beeps. These interface files are deprecated, but will be kept around | |||
316 | for compatibility reasons: | 347 | for compatibility reasons: |
317 | 348 | ||
318 | alarms Alarm bitmask. | 349 | alarms Alarm bitmask. |
319 | Read only. | 350 | RO |
320 | Integer representation of one to four bytes. | 351 | Integer representation of one to four bytes. |
321 | A '1' bit means an alarm. | 352 | A '1' bit means an alarm. |
322 | Chips should be programmed for 'comparator' mode so that | 353 | Chips should be programmed for 'comparator' mode so that |
@@ -333,7 +364,7 @@ beep_mask Bitmask for beep. | |||
333 | Same format as 'alarms' with the same bit locations, | 364 | Same format as 'alarms' with the same bit locations, |
334 | use discouraged for the same reason. Use individual | 365 | use discouraged for the same reason. Use individual |
335 | *_beep files instead. | 366 | *_beep files instead. |
336 | Read/Write | 367 | RW |
337 | 368 | ||
338 | 369 | ||
339 | ********* | 370 | ********* |
@@ -341,7 +372,9 @@ beep_mask Bitmask for beep. | |||
341 | ********* | 372 | ********* |
342 | 373 | ||
343 | eeprom Raw EEPROM data in binary form. | 374 | eeprom Raw EEPROM data in binary form. |
344 | Read only. | 375 | RO |
345 | 376 | ||
346 | pec Enable or disable PEC (SMBus only) | 377 | pec Enable or disable PEC (SMBus only) |
347 | Read/Write | 378 | 0: disable |
379 | 1: enable | ||
380 | RW | ||