Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / e3333e572f29109740b48302035a59f9db0fa8e9 / . / Documentation / hwmon / max8688
blob: e78078638b9142906b8308c4700f25d2f8a2ef88 [file] [log] [blame]
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]1Kernel driver max8688
2=====================
3
4Supported chips:
5 * Maxim MAX8688
6 Prefix: 'max8688'
7 Addresses scanned: -
8 Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf
9
Guenter Roecke3333e52013-02-20 20:58:42 -0800[diff] [blame^]10Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]11
12
13Description
14-----------
15
16This driver supports hardware montoring for Maxim MAX8688 Digital Power-Supply
17Controller/Monitor with PMBus Interface.
18
19The driver is a client driver to the core PMBus driver. Please see
20Documentation/hwmon/pmbus for details on PMBus client drivers.
21
22
23Usage Notes
24-----------
25
26This driver does not auto-detect devices. You will have to instantiate the
27devices explicitly. Please see Documentation/i2c/instantiating-devices for
28details.
29
30
31Platform data support
32---------------------
33
34The driver supports standard PMBus driver platform data.
35
36
37Sysfs entries
38-------------
39
40The following attributes are supported. Limits are read-write; all other
41attributes are read-only.
42
43in1_label "vout1"
44in1_input Measured voltage. From READ_VOUT register.
Masanari Iida40e47122012-03-04 23:16:11 +0900[diff] [blame]45in1_min Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]46in1_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
Masanari Iida40e47122012-03-04 23:16:11 +0900[diff] [blame]47in1_lcrit Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]48in1_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
49in1_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
50in1_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
51in1_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
52in1_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
Guenter Roeck70e94b22011-07-09 13:11:44 -0700[diff] [blame]53in1_highest Historical maximum voltage.
54in1_reset_history Write any value to reset history.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]55
56curr1_label "iout1"
57curr1_input Measured current. From READ_IOUT register.
58curr1_max Maximum current. From IOUT_OC_WARN_LIMIT register.
59curr1_crit Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
60curr1_max_alarm Current high alarm. From IOUT_OC_WARN_LIMIT register.
61curr1_crit_alarm Current critical high alarm. From IOUT_OC_FAULT status.
Guenter Roeck70e94b22011-07-09 13:11:44 -0700[diff] [blame]62curr1_highest Historical maximum current.
63curr1_reset_history Write any value to reset history.
Guenter Roeck2669d9f2011-04-18 09:51:04 -0700[diff] [blame]64
65temp1_input Measured temperature. From READ_TEMPERATURE_1 register.
66temp1_max Maximum temperature. From OT_WARN_LIMIT register.
67temp1_crit Critical high temperature. From OT_FAULT_LIMIT register.
68temp1_max_alarm Chip temperature high alarm. Set by comparing
69 READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING
70 status is set.
71temp1_crit_alarm Chip temperature critical high alarm. Set by comparing
72 READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT
73 status is set.
Guenter Roeck70e94b22011-07-09 13:11:44 -0700[diff] [blame]74temp1_highest Historical maximum temperature.
75temp1_reset_history Write any value to reset history.