[PATCH] HWMON: w83791d: New hardware monitoring driver for the Winbond W83791D

[linux-2.6-omap-h63xx.git] / Documentation / hwmon / sysfs-interface

diff --git a/Documentation/hwmon/sysfs-interface b/Documentation/hwmon/sysfs-interface
index 764cdc5480e79e7318b9e3139c1cee088e58b92a..eeb912254db434bc8127d850254a00afe7b972c5 100644 (file)
--- a/Documentation/hwmon/sysfs-interface
+++ b/Documentation/hwmon/sysfs-interface
@@ -179,11 +179,12 @@ temp[1-*]_auto_point[1-*]_temp_hyst
 ****************
 
 temp[1-3]_type Sensor type selection.
-               Integers 1, 2, 3 or thermistor Beta value (3435)
+               Integers 1 to 4 or thermistor Beta value (typically 3435)
                Read/Write.
                1: PII/Celeron Diode
                2: 3904 transistor
                3: thermal diode
+               4: thermistor (default/unknown Beta)
                Not all types are supported by all chips
 
 temp[1-4]_max  Temperature max value.
@@ -217,6 +218,12 @@ temp[1-2]_crit_hyst
                from the critical value.
                Read/Write value.
 
+temp[1-4]_offset
+               Temperature offset which is added to the temperature reading
+               by the chip.
+               Unit: millidegree Celsius
+               Read/Write value.
+
                If there are multiple temperature sensors, temp1_* is
                generally the sensor inside the chip itself,
                reported as "motherboard temperature".  temp2_* to
@@ -245,9 +252,68 @@ curr[1-n]_input    Current input value
                Read only.
 
 
-*********
-* Other *
-*********
+**********
+* Alarms *
+**********
+
+Each channel or limit may have an associated alarm file, containing a
+boolean value. 1 means than an alarm condition exists, 0 means no alarm.
+
+Usually a given chip will either use channel-related alarms, or
+limit-related alarms, not both. The driver should just reflect the hardware
+implementation.
+
+in[0-n]_alarm
+fan[1-n]_alarm
+temp[1-n]_alarm
+               Channel alarm
+               Boolean
+               Read-only
+
+OR
+
+in[0-n]_min_alarm
+in[0-n]_max_alarm
+fan[1-n]_min_alarm
+temp[1-n]_min_alarm
+temp[1-n]_max_alarm
+temp[1-n]_crit_alarm
+               Limit alarm
+               Boolean
+               Read-only
+
+Each input channel may have an associated fault file. This can be used
+to notify open diodes, unconnected fans etc. where the hardware
+supports it. When this boolean has value 1, the measurement for that
+channel should not be trusted.
+
+in[0-n]_input_fault
+fan[1-n]_input_fault
+temp[1-n]_input_fault
+               Input fault condition
+               Boolean
+               Read-only
+
+Some chips also offer the possibility to get beeped when an alarm occurs:
+
+beep_enable    Master beep enable
+               Boolean
+               Read/Write
+
+in[0-n]_beep
+fan[1-n]_beep
+temp[1-n]_beep
+               Channel beep
+               0 to disable.
+               1 to enable.
+               Read/write
+
+In theory, a chip could provide per-limit beep masking, but no such chip
+was seen so far.
+
+Old drivers provided a different, non-standard interface to alarms and
+beeps. These interface files are deprecated, but will be kept around
+for compatibility reasons:
 
 alarms         Alarm bitmask.
                Read only.
@@ -258,18 +324,22 @@ alarms            Alarm bitmask.
                if it is still valid.
                Generally a direct representation of a chip's internal
                alarm registers; there is no standard for the position
-               of individual bits.
+               of individual bits. For this reason, the use of this
+               interface file for new drivers is discouraged. Use
+               individual *_alarm and *_fault files instead.
                Bits are defined in kernel/include/sensors.h.
 
-beep_enable    Beep/interrupt enable
-               0 to disable.
-               1 to enable.
-               Read/Write
-
 beep_mask      Bitmask for beep.
-               Same format as 'alarms' with the same bit locations.
+               Same format as 'alarms' with the same bit locations,
+               use discouraged for the same reason. Use individual
+               *_beep files instead.
                Read/Write
 
+
+*********
+* Other *
+*********
+
 eeprom         Raw EEPROM data in binary form.
                Read only.