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