treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / hwmon / lm25066.rst
blob30e6e77fb3c8f0437694d42ddf13a46bee7accbe
1 Kernel driver lm25066
2 =====================
4 Supported chips:
6   * TI LM25056
8     Prefix: 'lm25056'
10     Addresses scanned: -
12     Datasheets:
14         http://www.ti.com/lit/gpn/lm25056
16         http://www.ti.com/lit/gpn/lm25056a
18   * National Semiconductor LM25066
20     Prefix: 'lm25066'
22     Addresses scanned: -
24     Datasheets:
26         http://www.national.com/pf/LM/LM25066.html
28         http://www.national.com/pf/LM/LM25066A.html
30   * National Semiconductor LM5064
32     Prefix: 'lm5064'
34     Addresses scanned: -
36     Datasheet:
38         http://www.national.com/pf/LM/LM5064.html
40   * National Semiconductor LM5066
42     Prefix: 'lm5066'
44     Addresses scanned: -
46     Datasheet:
48         http://www.national.com/pf/LM/LM5066.html
50   * Texas Instruments LM5066I
52     Prefix: 'lm5066i'
54     Addresses scanned: -
56         Datasheet:
58     http://www.ti.com/product/LM5066I
61 Author: Guenter Roeck <linux@roeck-us.net>
64 Description
65 -----------
67 This driver supports hardware monitoring for National Semiconductor / TI LM25056,
68 LM25066, LM5064, and LM5066/LM5066I Power Management, Monitoring,
69 Control, and Protection ICs.
71 The driver is a client driver to the core PMBus driver. Please see
72 Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
75 Usage Notes
76 -----------
78 This driver does not auto-detect devices. You will have to instantiate the
79 devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
80 details.
83 Platform data support
84 ---------------------
86 The driver supports standard PMBus driver platform data.
89 Sysfs entries
90 -------------
92 The following attributes are supported. Limits are read-write; all other
93 attributes are read-only.
95 ======================= =======================================================
96 in1_label               "vin"
97 in1_input               Measured input voltage.
98 in1_average             Average measured input voltage.
99 in1_min                 Minimum input voltage.
100 in1_max                 Maximum input voltage.
101 in1_min_alarm           Input voltage low alarm.
102 in1_max_alarm           Input voltage high alarm.
104 in2_label               "vmon"
105 in2_input               Measured voltage on VAUX pin
106 in2_min                 Minimum VAUX voltage (LM25056 only).
107 in2_max                 Maximum VAUX voltage (LM25056 only).
108 in2_min_alarm           VAUX voltage low alarm (LM25056 only).
109 in2_max_alarm           VAUX voltage high alarm (LM25056 only).
111 in3_label               "vout1"
112                         Not supported on LM25056.
113 in3_input               Measured output voltage.
114 in3_average             Average measured output voltage.
115 in3_min                 Minimum output voltage.
116 in3_min_alarm           Output voltage low alarm.
118 curr1_label             "iin"
119 curr1_input             Measured input current.
120 curr1_average           Average measured input current.
121 curr1_max               Maximum input current.
122 curr1_max_alarm         Input current high alarm.
124 power1_label            "pin"
125 power1_input            Measured input power.
126 power1_average          Average measured input power.
127 power1_max              Maximum input power limit.
128 power1_alarm            Input power alarm
129 power1_input_highest    Historical maximum power.
130 power1_reset_history    Write any value to reset maximum power history.
132 temp1_input             Measured temperature.
133 temp1_max               Maximum temperature.
134 temp1_crit              Critical high temperature.
135 temp1_max_alarm         Chip temperature high alarm.
136 temp1_crit_alarm        Chip temperature critical high alarm.
137 ======================= =======================================================