Merge tag 'armsoc-dt' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / hwmon / adm1275.rst
1 Kernel driver adm1275
2 =====================
3
4 Supported chips:
5
6   * Analog Devices ADM1075
7
8     Prefix: 'adm1075'
9
10     Addresses scanned: -
11
12     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf
13
14   * Analog Devices ADM1272
15
16     Prefix: 'adm1272'
17
18     Addresses scanned: -
19
20     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1272.pdf
21
22   * Analog Devices ADM1275
23
24     Prefix: 'adm1275'
25
26     Addresses scanned: -
27
28     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
29
30   * Analog Devices ADM1276
31
32     Prefix: 'adm1276'
33
34     Addresses scanned: -
35
36     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
37
38   * Analog Devices ADM1278
39
40     Prefix: 'adm1278'
41
42     Addresses scanned: -
43
44     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf
45
46   * Analog Devices ADM1293/ADM1294
47
48     Prefix: 'adm1293', 'adm1294'
49
50     Addresses scanned: -
51
52     Datasheet: http://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf
53
54 Author: Guenter Roeck <linux@roeck-us.net>
55
56
57 Description
58 -----------
59
60 This driver supports hardware monitoring for Analog Devices ADM1075, ADM1272,
61 ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 Hot-Swap Controller and
62 Digital Power Monitors.
63
64 ADM1075, ADM1272, ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 are hot-swap
65 controllers that allow a circuit board to be removed from or inserted into
66 a live backplane. They also feature current and voltage readback via an
67 integrated 12 bit analog-to-digital converter (ADC), accessed using a
68 PMBus interface.
69
70 The driver is a client driver to the core PMBus driver. Please see
71 Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
72
73
74 Usage Notes
75 -----------
76
77 This driver does not auto-detect devices. You will have to instantiate the
78 devices explicitly. Please see Documentation/i2c/instantiating-devices for
79 details.
80
81 The ADM1075, unlike many other PMBus devices, does not support internal voltage
82 or current scaling. Reported voltages, currents, and power are raw measurements,
83 and will typically have to be scaled.
84
85 The shunt value in micro-ohms can be set via device tree at compile-time. Please
86 refer to the Documentation/devicetree/bindings/hwmon/adm1275.txt for bindings
87 if the device tree is used.
88
89 Platform data support
90 ---------------------
91
92 The driver supports standard PMBus driver platform data. Please see
93 Documentation/hwmon/pmbus.rst for details.
94
95
96 Sysfs entries
97 -------------
98
99 The following attributes are supported. Limits are read-write, history reset
100 attributes are write-only, all other attributes are read-only.
101
102 ======================= =======================================================
103 inX_label               "vin1" or "vout1" depending on chip variant and
104                         configuration. On ADM1075, ADM1293, and ADM1294,
105                         vout1 reports the voltage on the VAUX pin.
106 inX_input               Measured voltage.
107 inX_min                 Minimum Voltage.
108 inX_max                 Maximum voltage.
109 inX_min_alarm           Voltage low alarm.
110 inX_max_alarm           Voltage high alarm.
111 inX_highest             Historical maximum voltage.
112 inX_reset_history       Write any value to reset history.
113
114 curr1_label             "iout1"
115 curr1_input             Measured current.
116 curr1_max               Maximum current.
117 curr1_max_alarm         Current high alarm.
118 curr1_lcrit             Critical minimum current. Depending on the chip
119                         configuration, either curr1_lcrit or curr1_crit is
120                         supported, but not both.
121 curr1_lcrit_alarm       Critical current low alarm.
122 curr1_crit              Critical maximum current. Depending on the chip
123                         configuration, either curr1_lcrit or curr1_crit is
124                         supported, but not both.
125 curr1_crit_alarm        Critical current high alarm.
126 curr1_highest           Historical maximum current.
127 curr1_reset_history     Write any value to reset history.
128
129 power1_label            "pin1"
130 power1_input            Input power.
131 power1_input_lowest     Lowest observed input power. ADM1293 and ADM1294 only.
132 power1_input_highest    Highest observed input power.
133 power1_reset_history    Write any value to reset history.
134
135                         Power attributes are supported on ADM1075, ADM1272,
136                         ADM1276, ADM1293, and ADM1294.
137
138 temp1_input             Chip temperature.
139 temp1_max               Maximum chip temperature.
140 temp1_max_alarm         Temperature alarm.
141 temp1_crit              Critical chip temperature.
142 temp1_crit_alarm        Critical temperature high alarm.
143 temp1_highest           Highest observed temperature.
144 temp1_reset_history     Write any value to reset history.
145
146                         Temperature attributes are supported on ADM1272 and
147                         ADM1278.
148 ======================= =======================================================