Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 77a31246836019c8de7d1a82636ca0020c4e96c6 / . / Documentation / hwmon / max16064.rst
blob: c06249292557a03935cd9f28329d61b4c25d1e58 [file] [log] [blame]
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]1Kernel driver max16064
2======================
3
4Supported chips:
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]5
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]6 * Maxim MAX16064
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]7
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]8 Prefix: 'max16064'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]9
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]10 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]11
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]12 Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX16064.pdf
13
Guenter Roecke3333e52013-02-20 20:58:42 -0800[diff] [blame]14Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]15
16
17Description
18-----------
19
Masanari Iida92417da2016-02-28 12:57:57 +0900[diff] [blame]20This driver supports hardware monitoring for Maxim MAX16064 Quad Power-Supply
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]21Controller with Active-Voltage Output Control and PMBus Interface.
22
23The driver is a client driver to the core PMBus driver.
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300[diff] [blame]24Please see Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]25
26
27Usage Notes
28-----------
29
30This driver does not auto-detect devices. You will have to instantiate the
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -0300[diff] [blame]31devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]32details.
33
34
35Platform data support
36---------------------
37
38The driver supports standard PMBus driver platform data.
39
40
41Sysfs entries
42-------------
43
44The following attributes are supported. Limits are read-write; all other
45attributes are read-only.
46
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]47======================= ========================================================
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]48in[1-4]_label "vout[1-4]"
49in[1-4]_input Measured voltage. From READ_VOUT register.
Masanari Iida40e47122012-03-04 23:16:11 +0900[diff] [blame]50in[1-4]_min Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]51in[1-4]_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
Masanari Iida40e47122012-03-04 23:16:11 +0900[diff] [blame]52in[1-4]_lcrit Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]53in[1-4]_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
54 register.
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]55in[1-4]_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
56in[1-4]_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]57in[1-4]_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT
58 status.
59in[1-4]_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT
60 status.
Guenter Roeck8ebed852011-07-09 13:10:19 -0700[diff] [blame]61in[1-4]_highest Historical maximum voltage.
62in[1-4]_reset_history Write any value to reset history.
Guenter Roeck4af33f12011-04-18 09:53:54 -0700[diff] [blame]63
64temp1_input Measured temperature. From READ_TEMPERATURE_1 register.
65temp1_max Maximum temperature. From OT_WARN_LIMIT register.
66temp1_crit Critical high temperature. From OT_FAULT_LIMIT register.
67temp1_max_alarm Chip temperature high alarm. Set by comparing
68 READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING
69 status is set.
70temp1_crit_alarm Chip temperature critical high alarm. Set by comparing
71 READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT
72 status is set.
Guenter Roeck8ebed852011-07-09 13:10:19 -0700[diff] [blame]73temp1_highest Historical maximum temperature.
74temp1_reset_history Write any value to reset history.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]75======================= ========================================================