xref: /linux/Documentation/hwmon/adm1275.rst (revision 3a2c4d55e32ad65efebdb6de44eef3bfa08bb49d)
1Kernel driver adm1275
2=====================
3
4Supported 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 ADM1273
23
24    Prefix: 'adm1273'
25
26    Addresses scanned: -
27
28    Datasheet: Not yet publicly available
29
30  * Analog Devices ADM1275
31
32    Prefix: 'adm1275'
33
34    Addresses scanned: -
35
36    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
37
38  * Analog Devices ADM1276
39
40    Prefix: 'adm1276'
41
42    Addresses scanned: -
43
44    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
45
46  * Analog Devices ADM1278
47
48    Prefix: 'adm1278'
49
50    Addresses scanned: -
51
52    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf
53
54  * Analog Devices ADM1281
55
56    Prefix: 'adm1281'
57
58    Addresses scanned: -
59
60    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/adm1281.pdf
61
62  * Analog Devices ADM1293/ADM1294
63
64    Prefix: 'adm1293', 'adm1294'
65
66    Addresses scanned: -
67
68    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf
69
70  * ROHM Semiconductor BD12780
71
72    Prefix: 'bd12780'
73
74    Addresses scanned: -
75
76    Datasheet: https://fscdn.rohm.com/en/products/databook/datasheet/ic/power/power_switch/bd12780muv-lb-e.pdf
77
78  * ROHM Semiconductor BD12780A
79
80    Prefix: 'bd12780'
81
82    Addresses scanned: -
83
84    Datasheet: https://fscdn.rohm.com/en/products/databook/datasheet/ic/power/power_switch/bd12780amuv-lb-e.pdf
85
86  * ROHM Semiconductor BD12790
87
88    Prefix: 'bd12790'
89
90    Addresses scanned: -
91
92    Datasheet: -
93
94  * Silergy SQ24905C
95
96    Prefix: 'mc09c'
97
98    Addresses scanned: -
99
100    Datasheet: https://www.silergy.com/download/downloadFile?id=5669&type=product&ftype=note
101
102Author: Guenter Roeck <linux@roeck-us.net>
103
104
105Description
106-----------
107
108This driver supports hardware monitoring for Analog Devices ADM1075, ADM1272,
109ADM1273, ADM1275, ADM1276, ADM1278, ADM1281, ADM1293, ADM1294, and SQ24905C
110Hot-Swap Controller and Digital Power Monitors.
111
112ADM1075, ADM1272, ADM1273, ADM1275, ADM1276, ADM1278, ADM1281, ADM1293,
113ADM1294 and SQ24905C are hot-swap controllers that allow a circuit board to be
114removed from or inserted into a live backplane. They also feature current and
115voltage readback via an integrated 12 bit analog-to-digital converter (ADC),
116accessed using a PMBus interface.
117
118The driver is a client driver to the core PMBus driver. Please see
119Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
120
121
122Usage Notes
123-----------
124
125This driver does not auto-detect devices. You will have to instantiate the
126devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
127details.
128
129The ADM1075, unlike many other PMBus devices, does not support internal voltage
130or current scaling. Reported voltages, currents, and power are raw measurements,
131and will typically have to be scaled.
132
133The shunt value in micro-ohms can be set via device tree at compile-time. Please
134refer to the Documentation/devicetree/bindings/hwmon/adi,adm1275.yaml for bindings
135if the device tree is used.
136
137Platform data support
138---------------------
139
140The driver supports standard PMBus driver platform data. Please see
141Documentation/hwmon/pmbus.rst for details.
142
143
144Sysfs entries
145-------------
146
147The following attributes are supported. Limits are read-write, history reset
148attributes are write-only, all other attributes are read-only.
149
150======================= =======================================================
151inX_label		"vin1" or "vout1" depending on chip variant and
152			configuration. On ADM1075, ADM1293, and ADM1294,
153			vout1 reports the voltage on the VAUX pin.
154inX_input		Measured voltage.
155inX_min			Minimum Voltage.
156inX_max			Maximum voltage.
157inX_min_alarm		Voltage low alarm.
158inX_max_alarm		Voltage high alarm.
159inX_highest		Historical maximum voltage.
160inX_reset_history	Write any value to reset history.
161
162curr1_label		"iout1"
163curr1_input		Measured current.
164curr1_max		Maximum current.
165curr1_max_alarm		Current high alarm.
166curr1_lcrit		Critical minimum current. Depending on the chip
167			configuration, either curr1_lcrit or curr1_crit is
168			supported, but not both.
169curr1_lcrit_alarm	Critical current low alarm.
170curr1_crit		Critical maximum current. Depending on the chip
171			configuration, either curr1_lcrit or curr1_crit is
172			supported, but not both.
173curr1_crit_alarm	Critical current high alarm.
174curr1_highest		Historical maximum current.
175curr1_reset_history	Write any value to reset history.
176
177power1_label		"pin1"
178power1_input		Input power.
179power1_input_lowest	Lowest observed input power. ADM1293 and ADM1294 only.
180power1_input_highest	Highest observed input power.
181power1_reset_history	Write any value to reset history.
182
183			Power attributes are supported on ADM1075, ADM1272,
184			ADM1273, ADM1276, ADM1293, and ADM1294.
185
186temp1_input		Chip temperature.
187temp1_max		Maximum chip temperature.
188temp1_max_alarm		Temperature alarm.
189temp1_crit		Critical chip temperature.
190temp1_crit_alarm	Critical temperature high alarm.
191temp1_highest		Highest observed temperature.
192temp1_reset_history	Write any value to reset history.
193
194			Temperature attributes are supported on ADM1272,
195			ADM1273, ADM1278, ADM1281 and SQ24905C.
196======================= =======================================================
197