xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/adm1275.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunKernel driver adm1275
2*4882a593Smuzhiyun=====================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunSupported chips:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun  * Analog Devices ADM1075
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun    Prefix: 'adm1075'
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun    Addresses scanned: -
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun  * Analog Devices ADM1272
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun    Prefix: 'adm1272'
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun    Addresses scanned: -
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1272.pdf
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun  * Analog Devices ADM1275
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun    Prefix: 'adm1275'
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun    Addresses scanned: -
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun  * Analog Devices ADM1276
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun    Prefix: 'adm1276'
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun    Addresses scanned: -
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun  * Analog Devices ADM1278
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun    Prefix: 'adm1278'
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun    Addresses scanned: -
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun  * Analog Devices ADM1293/ADM1294
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun    Prefix: 'adm1293', 'adm1294'
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun    Addresses scanned: -
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf
53*4882a593Smuzhiyun
54*4882a593SmuzhiyunAuthor: Guenter Roeck <linux@roeck-us.net>
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun
57*4882a593SmuzhiyunDescription
58*4882a593Smuzhiyun-----------
59*4882a593Smuzhiyun
60*4882a593SmuzhiyunThis driver supports hardware monitoring for Analog Devices ADM1075, ADM1272,
61*4882a593SmuzhiyunADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 Hot-Swap Controller and
62*4882a593SmuzhiyunDigital Power Monitors.
63*4882a593Smuzhiyun
64*4882a593SmuzhiyunADM1075, ADM1272, ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 are hot-swap
65*4882a593Smuzhiyuncontrollers that allow a circuit board to be removed from or inserted into
66*4882a593Smuzhiyuna live backplane. They also feature current and voltage readback via an
67*4882a593Smuzhiyunintegrated 12 bit analog-to-digital converter (ADC), accessed using a
68*4882a593SmuzhiyunPMBus interface.
69*4882a593Smuzhiyun
70*4882a593SmuzhiyunThe driver is a client driver to the core PMBus driver. Please see
71*4882a593SmuzhiyunDocumentation/hwmon/pmbus.rst for details on PMBus client drivers.
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun
74*4882a593SmuzhiyunUsage Notes
75*4882a593Smuzhiyun-----------
76*4882a593Smuzhiyun
77*4882a593SmuzhiyunThis driver does not auto-detect devices. You will have to instantiate the
78*4882a593Smuzhiyundevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
79*4882a593Smuzhiyundetails.
80*4882a593Smuzhiyun
81*4882a593SmuzhiyunThe ADM1075, unlike many other PMBus devices, does not support internal voltage
82*4882a593Smuzhiyunor current scaling. Reported voltages, currents, and power are raw measurements,
83*4882a593Smuzhiyunand will typically have to be scaled.
84*4882a593Smuzhiyun
85*4882a593SmuzhiyunThe shunt value in micro-ohms can be set via device tree at compile-time. Please
86*4882a593Smuzhiyunrefer to the Documentation/devicetree/bindings/hwmon/adm1275.txt for bindings
87*4882a593Smuzhiyunif the device tree is used.
88*4882a593Smuzhiyun
89*4882a593SmuzhiyunPlatform data support
90*4882a593Smuzhiyun---------------------
91*4882a593Smuzhiyun
92*4882a593SmuzhiyunThe driver supports standard PMBus driver platform data. Please see
93*4882a593SmuzhiyunDocumentation/hwmon/pmbus.rst for details.
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun
96*4882a593SmuzhiyunSysfs entries
97*4882a593Smuzhiyun-------------
98*4882a593Smuzhiyun
99*4882a593SmuzhiyunThe following attributes are supported. Limits are read-write, history reset
100*4882a593Smuzhiyunattributes are write-only, all other attributes are read-only.
101*4882a593Smuzhiyun
102*4882a593Smuzhiyun======================= =======================================================
103*4882a593SmuzhiyuninX_label		"vin1" or "vout1" depending on chip variant and
104*4882a593Smuzhiyun			configuration. On ADM1075, ADM1293, and ADM1294,
105*4882a593Smuzhiyun			vout1 reports the voltage on the VAUX pin.
106*4882a593SmuzhiyuninX_input		Measured voltage.
107*4882a593SmuzhiyuninX_min			Minimum Voltage.
108*4882a593SmuzhiyuninX_max			Maximum voltage.
109*4882a593SmuzhiyuninX_min_alarm		Voltage low alarm.
110*4882a593SmuzhiyuninX_max_alarm		Voltage high alarm.
111*4882a593SmuzhiyuninX_highest		Historical maximum voltage.
112*4882a593SmuzhiyuninX_reset_history	Write any value to reset history.
113*4882a593Smuzhiyun
114*4882a593Smuzhiyuncurr1_label		"iout1"
115*4882a593Smuzhiyuncurr1_input		Measured current.
116*4882a593Smuzhiyuncurr1_max		Maximum current.
117*4882a593Smuzhiyuncurr1_max_alarm		Current high alarm.
118*4882a593Smuzhiyuncurr1_lcrit		Critical minimum current. Depending on the chip
119*4882a593Smuzhiyun			configuration, either curr1_lcrit or curr1_crit is
120*4882a593Smuzhiyun			supported, but not both.
121*4882a593Smuzhiyuncurr1_lcrit_alarm	Critical current low alarm.
122*4882a593Smuzhiyuncurr1_crit		Critical maximum current. Depending on the chip
123*4882a593Smuzhiyun			configuration, either curr1_lcrit or curr1_crit is
124*4882a593Smuzhiyun			supported, but not both.
125*4882a593Smuzhiyuncurr1_crit_alarm	Critical current high alarm.
126*4882a593Smuzhiyuncurr1_highest		Historical maximum current.
127*4882a593Smuzhiyuncurr1_reset_history	Write any value to reset history.
128*4882a593Smuzhiyun
129*4882a593Smuzhiyunpower1_label		"pin1"
130*4882a593Smuzhiyunpower1_input		Input power.
131*4882a593Smuzhiyunpower1_input_lowest	Lowest observed input power. ADM1293 and ADM1294 only.
132*4882a593Smuzhiyunpower1_input_highest	Highest observed input power.
133*4882a593Smuzhiyunpower1_reset_history	Write any value to reset history.
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun			Power attributes are supported on ADM1075, ADM1272,
136*4882a593Smuzhiyun			ADM1276, ADM1293, and ADM1294.
137*4882a593Smuzhiyun
138*4882a593Smuzhiyuntemp1_input		Chip temperature.
139*4882a593Smuzhiyuntemp1_max		Maximum chip temperature.
140*4882a593Smuzhiyuntemp1_max_alarm		Temperature alarm.
141*4882a593Smuzhiyuntemp1_crit		Critical chip temperature.
142*4882a593Smuzhiyuntemp1_crit_alarm	Critical temperature high alarm.
143*4882a593Smuzhiyuntemp1_highest		Highest observed temperature.
144*4882a593Smuzhiyuntemp1_reset_history	Write any value to reset history.
145*4882a593Smuzhiyun
146*4882a593Smuzhiyun			Temperature attributes are supported on ADM1272 and
147*4882a593Smuzhiyun			ADM1278.
148*4882a593Smuzhiyun======================= =======================================================
149