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