xref: /linux/Documentation/hwmon/adm1275.rst (revision b615879dbfea6cf1236acbc3f2fb25ae84e07071)
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  * Silergy SQ24905C
71
72    Prefix: 'mc09c'
73
74    Addresses scanned: -
75
76    Datasheet: https://www.silergy.com/download/downloadFile?id=5669&type=product&ftype=note
77
78Author: Guenter Roeck <linux@roeck-us.net>
79
80
81Description
82-----------
83
84This driver supports hardware monitoring for Analog Devices ADM1075, ADM1272,
85ADM1273, ADM1275, ADM1276, ADM1278, ADM1281, ADM1293, ADM1294, and SQ24905C
86Hot-Swap Controller and Digital Power Monitors.
87
88ADM1075, ADM1272, ADM1273, ADM1275, ADM1276, ADM1278, ADM1281, ADM1293,
89ADM1294 and SQ24905C are hot-swap controllers that allow a circuit board to be
90removed from or inserted into a live backplane. They also feature current and
91voltage readback via an integrated 12 bit analog-to-digital converter (ADC),
92accessed using a PMBus interface.
93
94The driver is a client driver to the core PMBus driver. Please see
95Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
96
97
98Usage Notes
99-----------
100
101This driver does not auto-detect devices. You will have to instantiate the
102devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
103details.
104
105The ADM1075, unlike many other PMBus devices, does not support internal voltage
106or current scaling. Reported voltages, currents, and power are raw measurements,
107and will typically have to be scaled.
108
109The shunt value in micro-ohms can be set via device tree at compile-time. Please
110refer to the Documentation/devicetree/bindings/hwmon/adi,adm1275.yaml for bindings
111if the device tree is used.
112
113Platform data support
114---------------------
115
116The driver supports standard PMBus driver platform data. Please see
117Documentation/hwmon/pmbus.rst for details.
118
119
120Sysfs entries
121-------------
122
123The following attributes are supported. Limits are read-write, history reset
124attributes are write-only, all other attributes are read-only.
125
126======================= =======================================================
127inX_label		"vin1" or "vout1" depending on chip variant and
128			configuration. On ADM1075, ADM1293, and ADM1294,
129			vout1 reports the voltage on the VAUX pin.
130inX_input		Measured voltage.
131inX_min			Minimum Voltage.
132inX_max			Maximum voltage.
133inX_min_alarm		Voltage low alarm.
134inX_max_alarm		Voltage high alarm.
135inX_highest		Historical maximum voltage.
136inX_reset_history	Write any value to reset history.
137
138curr1_label		"iout1"
139curr1_input		Measured current.
140curr1_max		Maximum current.
141curr1_max_alarm		Current high alarm.
142curr1_lcrit		Critical minimum current. Depending on the chip
143			configuration, either curr1_lcrit or curr1_crit is
144			supported, but not both.
145curr1_lcrit_alarm	Critical current low alarm.
146curr1_crit		Critical maximum current. Depending on the chip
147			configuration, either curr1_lcrit or curr1_crit is
148			supported, but not both.
149curr1_crit_alarm	Critical current high alarm.
150curr1_highest		Historical maximum current.
151curr1_reset_history	Write any value to reset history.
152
153power1_label		"pin1"
154power1_input		Input power.
155power1_input_lowest	Lowest observed input power. ADM1293 and ADM1294 only.
156power1_input_highest	Highest observed input power.
157power1_reset_history	Write any value to reset history.
158
159			Power attributes are supported on ADM1075, ADM1272,
160			ADM1273, ADM1276, ADM1293, and ADM1294.
161
162temp1_input		Chip temperature.
163temp1_max		Maximum chip temperature.
164temp1_max_alarm		Temperature alarm.
165temp1_crit		Critical chip temperature.
166temp1_crit_alarm	Critical temperature high alarm.
167temp1_highest		Highest observed temperature.
168temp1_reset_history	Write any value to reset history.
169
170			Temperature attributes are supported on ADM1272,
171			ADM1273, ADM1278, ADM1281 and SQ24905C.
172======================= =======================================================
173