Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 06b76d44ba25e52711dc7cc4fc75b50907bc6b8e / . / Documentation / hwmon / adm1275.rst
blob: 49966ed70ec682fdb1f02187cccb2139f26ca96e [file] [log] [blame]
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]1Kernel driver adm1275
2=====================
3
4Supported chips:
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]5
Guenter Roeck92711262012-02-24 03:40:53 -0800[diff] [blame]6 * Analog Devices ADM1075
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]7
Guenter Roeck92711262012-02-24 03:40:53 -0800[diff] [blame]8 Prefix: 'adm1075'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]9
Guenter Roeck92711262012-02-24 03:40:53 -0800[diff] [blame]10 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]11
Guenter Roeck92711262012-02-24 03:40:53 -0800[diff] [blame]12 Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]13
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]14 * Analog Devices ADM1272
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]15
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]16 Prefix: 'adm1272'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]17
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]18 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]19
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]20 Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1272.pdf
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]21
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]22 * Analog Devices ADM1275
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]23
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]24 Prefix: 'adm1275'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]25
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]26 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]27
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]28 Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]29
Guenter Roeck5cf231a2011-07-14 11:55:35 -0700[diff] [blame]30 * Analog Devices ADM1276
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]31
Guenter Roeck5cf231a2011-07-14 11:55:35 -0700[diff] [blame]32 Prefix: 'adm1276'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]33
Guenter Roeck5cf231a2011-07-14 11:55:35 -0700[diff] [blame]34 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]35
Guenter Roeck5cf231a2011-07-14 11:55:35 -0700[diff] [blame]36 Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]37
Guenter Roeck709066ac2015-07-05 11:04:56 -0700[diff] [blame]38 * Analog Devices ADM1278
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]39
Guenter Roeck709066ac2015-07-05 11:04:56 -0700[diff] [blame]40 Prefix: 'adm1278'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]41
Guenter Roeck709066ac2015-07-05 11:04:56 -0700[diff] [blame]42 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]43
Guenter Roeck709066ac2015-07-05 11:04:56 -0700[diff] [blame]44 Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]45
Guenter Roeck68a40382015-03-17 13:19:51 -0700[diff] [blame]46 * Analog Devices ADM1293/ADM1294
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]47
Guenter Roeck68a40382015-03-17 13:19:51 -0700[diff] [blame]48 Prefix: 'adm1293', 'adm1294'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]49
Guenter Roeck68a40382015-03-17 13:19:51 -0700[diff] [blame]50 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]51
Guenter Roeck68a40382015-03-17 13:19:51 -0700[diff] [blame]52 Datasheet: http://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]53
Guenter Roecke3333e52013-02-20 20:58:42 -0800[diff] [blame]54Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]55
56
57Description
58-----------
59
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]60This driver supports hardware monitoring for Analog Devices ADM1075, ADM1272,
61ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 Hot-Swap Controller and
62Digital Power Monitors.
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]63
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]64ADM1075, ADM1272, ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 are hot-swap
Guenter Roeck709066ac2015-07-05 11:04:56 -0700[diff] [blame]65controllers that allow a circuit board to be removed from or inserted into
66a live backplane. They also feature current and voltage readback via an
67integrated 12 bit analog-to-digital converter (ADC), accessed using a
68PMBus interface.
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]69
70The driver is a client driver to the core PMBus driver. Please see
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300[diff] [blame]71Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]72
73
74Usage Notes
75-----------
76
77This driver does not auto-detect devices. You will have to instantiate the
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -0300[diff] [blame]78devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]79details.
80
Guenter Roeck92711262012-02-24 03:40:53 -0800[diff] [blame]81The ADM1075, unlike many other PMBus devices, does not support internal voltage
82or current scaling. Reported voltages, currents, and power are raw measurements,
83and will typically have to be scaled.
84
Kun Yi6e5c06a2018-10-17 15:26:39 -0700[diff] [blame]85The shunt value in micro-ohms can be set via device tree at compile-time. Please
86refer to the Documentation/devicetree/bindings/hwmon/adm1275.txt for bindings
87if the device tree is used.
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]88
89Platform data support
90---------------------
91
92The driver supports standard PMBus driver platform data. Please see
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300[diff] [blame]93Documentation/hwmon/pmbus.rst for details.
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]94
95
96Sysfs entries
97-------------
98
Guenter Roeckc576e302011-07-09 11:17:33 -0700[diff] [blame]99The following attributes are supported. Limits are read-write, history reset
100attributes are write-only, all other attributes are read-only.
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]101
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]102======================= =======================================================
Guenter Roeck68a40382015-03-17 13:19:51 -0700[diff] [blame]103inX_label "vin1" or "vout1" depending on chip variant and
104 configuration. On ADM1075, ADM1293, and ADM1294,
105 vout1 reports the voltage on the VAUX pin.
106inX_input Measured voltage.
107inX_min Minimum Voltage.
108inX_max Maximum voltage.
109inX_min_alarm Voltage low alarm.
110inX_max_alarm Voltage high alarm.
111inX_highest Historical maximum voltage.
112inX_reset_history Write any value to reset history.
Guenter Roeck83f76492011-03-17 13:16:01 -0700[diff] [blame]113
114curr1_label "iout1"
Guenter Roeck5cf231a2011-07-14 11:55:35 -0700[diff] [blame]115curr1_input Measured current.
116curr1_max Maximum current.
117curr1_max_alarm Current high alarm.
Guenter Roeckc5e67632011-08-02 11:08:57 -0700[diff] [blame]118curr1_lcrit Critical minimum current. Depending on the chip
119 configuration, either curr1_lcrit or curr1_crit is
120 supported, but not both.
121curr1_lcrit_alarm Critical current low alarm.
122curr1_crit Critical maximum current. Depending on the chip
123 configuration, either curr1_lcrit or curr1_crit is
124 supported, but not both.
125curr1_crit_alarm Critical current high alarm.
Guenter Roeckc576e302011-07-09 11:17:33 -0700[diff] [blame]126curr1_highest Historical maximum current.
127curr1_reset_history Write any value to reset history.
Guenter Roeck92711262012-02-24 03:40:53 -0800[diff] [blame]128
129power1_label "pin1"
130power1_input Input power.
Guenter Roeck68a40382015-03-17 13:19:51 -0700[diff] [blame]131power1_input_lowest Lowest observed input power. ADM1293 and ADM1294 only.
132power1_input_highest Highest observed input power.
Guenter Roeck92711262012-02-24 03:40:53 -0800[diff] [blame]133power1_reset_history Write any value to reset history.
134
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]135 Power attributes are supported on ADM1075, ADM1272,
136 ADM1276, ADM1293, and ADM1294.
Guenter Roeck709066ac2015-07-05 11:04:56 -0700[diff] [blame]137
138temp1_input Chip temperature.
Guenter Roeck709066ac2015-07-05 11:04:56 -0700[diff] [blame]139temp1_max Maximum chip temperature.
140temp1_max_alarm Temperature alarm.
141temp1_crit Critical chip temperature.
142temp1_crit_alarm Critical temperature high alarm.
143temp1_highest Highest observed temperature.
144temp1_reset_history Write any value to reset history.
145
Guenter Roeck4ff0ce22018-03-10 18:59:04 -0800[diff] [blame]146 Temperature attributes are supported on ADM1272 and
147 ADM1278.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]148======================= =======================================================