treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / hwmon / max16065.rst
blob45f69f334f252c5c346ccc4cff86047891e00fc5
1 Kernel driver max16065
2 ======================
5 Supported chips:
7   * Maxim MAX16065, MAX16066
9     Prefixes: 'max16065', 'max16066'
11     Addresses scanned: -
13     Datasheet:
15         http://datasheets.maxim-ic.com/en/ds/MAX16065-MAX16066.pdf
17  *  Maxim MAX16067
19     Prefix: 'max16067'
21     Addresses scanned: -
23     Datasheet:
25         http://datasheets.maxim-ic.com/en/ds/MAX16067.pdf
27  *  Maxim MAX16068
29     Prefix: 'max16068'
31     Addresses scanned: -
33     Datasheet:
35         http://datasheets.maxim-ic.com/en/ds/MAX16068.pdf
37  *  Maxim MAX16070/MAX16071
39     Prefixes: 'max16070', 'max16071'
41     Addresses scanned: -
43     Datasheet:
45         http://datasheets.maxim-ic.com/en/ds/MAX16070-MAX16071.pdf
47 Author: Guenter Roeck <linux@roeck-us.net>
50 Description
51 -----------
53 [From datasheets] The MAX16065/MAX16066 flash-configurable system managers
54 monitor and sequence multiple system voltages. The MAX16065/MAX16066 can also
55 accurately monitor (+/-2.5%) one current channel using a dedicated high-side
56 current-sense amplifier. The MAX16065 manages up to twelve system voltages
57 simultaneously, and the MAX16066 manages up to eight supply voltages.
59 The MAX16067 flash-configurable system manager monitors and sequences multiple
60 system voltages. The MAX16067 manages up to six system voltages simultaneously.
62 The MAX16068 flash-configurable system manager monitors and manages up to six
63 system voltages simultaneously.
65 The MAX16070/MAX16071 flash-configurable system monitors supervise multiple
66 system voltages. The MAX16070/MAX16071 can also accurately monitor (+/-2.5%)
67 one current channel using a dedicated high-side current-sense amplifier. The
68 MAX16070 monitors up to twelve system voltages simultaneously, and the MAX16071
69 monitors up to eight supply voltages.
71 Each monitored channel has its own low and high critical limits. MAX16065,
72 MAX16066, MAX16070, and MAX16071 support an additional limit which is
73 configurable as either low or high secondary limit. MAX16065, MAX16066,
74 MAX16070, and MAX16071 also support supply current monitoring.
77 Usage Notes
78 -----------
80 This driver does not probe for devices, since there is no register which
81 can be safely used to identify the chip. You will have to instantiate
82 the devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
83 details.
85 WARNING: Do not access chip registers using the i2cdump command, and do not use
86 any of the i2ctools commands on a command register (0xa5 to 0xac). The chips
87 supported by this driver interpret any access to a command register (including
88 read commands) as request to execute the command in question. This may result in
89 power loss, board resets, and/or Flash corruption. Worst case, your board may
90 turn into a brick.
93 Sysfs entries
94 -------------
96 ======================= ========================================================
97 in[0-11]_input          Input voltage measurements.
99 in12_input              Voltage on CSP (Current Sense Positive) pin.
100                         Only if the chip supports current sensing and if
101                         current sensing is enabled.
103 in[0-11]_min            Low warning limit.
104                         Supported on MAX16065, MAX16066, MAX16070, and MAX16071
105                         only.
107 in[0-11]_max            High warning limit.
108                         Supported on MAX16065, MAX16066, MAX16070, and MAX16071
109                         only.
111                         Either low or high warning limits are supported
112                         (depending on chip configuration), but not both.
114 in[0-11]_lcrit          Low critical limit.
116 in[0-11]_crit           High critical limit.
118 in[0-11]_alarm          Input voltage alarm.
120 curr1_input             Current sense input; only if the chip supports current
121                         sensing and if current sensing is enabled.
122                         Displayed current assumes 0.001 Ohm current sense
123                         resistor.
125 curr1_alarm             Overcurrent alarm; only if the chip supports current
126                         sensing and if current sensing is enabled.
127 ======================= ========================================================