Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / e37b12e4bb21e7c81732370b0a2b34bd196f380b / . / Documentation / hwmon / max8688.rst
blob: 71e7f2cbe2e20c533bf1b112776b2a5f4dc03388 [file] [log] [blame]
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]1Kernel driver max8688
2=====================
3
4Supported chips:
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]5
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]6 * Maxim MAX8688
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]7
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]8 Prefix: 'max8688'
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]9
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]10 Addresses scanned: -
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]11
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]12 Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf
13
Guenter Roecke3333e52013-02-20 20:58:42 -0800[diff] [blame]14Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roeck2669d9f2011-04-18 09:51:04 -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 MAX8688 Digital Power-Supply
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]21Controller/Monitor with PMBus Interface.
22
23The driver is a client driver to the core PMBus driver. Please see
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300[diff] [blame]24Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
Guenter Roeck2669d9f2011-04-18 09:51:04 -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 Roeck2669d9f2011-04-18 09:51:04 -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 Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]48in1_label "vout1"
49in1_input Measured voltage. From READ_VOUT register.
Masanari Iida40e47122012-03-04 23:16:11 +0900[diff] [blame]50in1_min Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]51in1_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
Masanari Iida40e47122012-03-04 23:16:11 +0900[diff] [blame]52in1_lcrit Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]53in1_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
54 register.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]55in1_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
56in1_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]57in1_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT
58 status.
59in1_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT
60 status.
Guenter Roeck70e94b22011-07-09 13:11:44 -0700[diff] [blame]61in1_highest Historical maximum voltage.
62in1_reset_history Write any value to reset history.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]63
64curr1_label "iout1"
65curr1_input Measured current. From READ_IOUT register.
66curr1_max Maximum current. From IOUT_OC_WARN_LIMIT register.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]67curr1_crit Critical maximum current. From IOUT_OC_FAULT_LIMIT
68 register.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]69curr1_max_alarm Current high alarm. From IOUT_OC_WARN_LIMIT register.
70curr1_crit_alarm Current critical high alarm. From IOUT_OC_FAULT status.
Guenter Roeck70e94b22011-07-09 13:11:44 -0700[diff] [blame]71curr1_highest Historical maximum current.
72curr1_reset_history Write any value to reset history.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]73
74temp1_input Measured temperature. From READ_TEMPERATURE_1 register.
75temp1_max Maximum temperature. From OT_WARN_LIMIT register.
76temp1_crit Critical high temperature. From OT_FAULT_LIMIT register.
77temp1_max_alarm Chip temperature high alarm. Set by comparing
78 READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING
79 status is set.
80temp1_crit_alarm Chip temperature critical high alarm. Set by comparing
81 READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT
82 status is set.
Guenter Roeck70e94b22011-07-09 13:11:44 -0700[diff] [blame]83temp1_highest Historical maximum temperature.
84temp1_reset_history Write any value to reset history.
Mauro Carvalho Chehab1f234ff2019-04-17 06:46:26 -0300[diff] [blame]85======================= ========================================================