1Kernel driver max8688
2=====================
3
4Supported chips:
5
6  * Maxim MAX8688
7
8    Prefix: 'max8688'
9
10    Addresses scanned: -
11
12    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf
13
14Author: Guenter Roeck <linux@roeck-us.net>
15
16
17Description
18-----------
19
20This driver supports hardware monitoring for Maxim MAX8688 Digital Power-Supply
21Controller/Monitor with PMBus Interface.
22
23The driver is a client driver to the core PMBus driver. Please see
24Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
25
26
27Usage Notes
28-----------
29
30This driver does not auto-detect devices. You will have to instantiate the
31devices explicitly. Please see Documentation/i2c/instantiating-devices for
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
47======================= ========================================================
48in1_label		"vout1"
49in1_input		Measured voltage. From READ_VOUT register.
50in1_min			Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
51in1_max			Maximum voltage. From VOUT_OV_WARN_LIMIT register.
52in1_lcrit		Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
53in1_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
54			register.
55in1_min_alarm		Voltage low alarm. From VOLTAGE_UV_WARNING status.
56in1_max_alarm		Voltage high alarm. From VOLTAGE_OV_WARNING status.
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.
61in1_highest		Historical maximum voltage.
62in1_reset_history	Write any value to reset history.
63
64curr1_label		"iout1"
65curr1_input		Measured current. From READ_IOUT register.
66curr1_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
67curr1_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT
68			register.
69curr1_max_alarm		Current high alarm. From IOUT_OC_WARN_LIMIT register.
70curr1_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.
71curr1_highest		Historical maximum current.
72curr1_reset_history	Write any value to reset history.
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.
83temp1_highest		Historical maximum temperature.
84temp1_reset_history	Write any value to reset history.
85======================= ========================================================
86