Merge tag 'armsoc-dt' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / hwmon / max8688.rst
1 Kernel driver max8688
2 =====================
3
4 Supported 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
14 Author: Guenter Roeck <linux@roeck-us.net>
15
16
17 Description
18 -----------
19
20 This driver supports hardware monitoring for Maxim MAX8688 Digital Power-Supply
21 Controller/Monitor with PMBus Interface.
22
23 The driver is a client driver to the core PMBus driver. Please see
24 Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
25
26
27 Usage Notes
28 -----------
29
30 This driver does not auto-detect devices. You will have to instantiate the
31 devices explicitly. Please see Documentation/i2c/instantiating-devices for
32 details.
33
34
35 Platform data support
36 ---------------------
37
38 The driver supports standard PMBus driver platform data.
39
40
41 Sysfs entries
42 -------------
43
44 The following attributes are supported. Limits are read-write; all other
45 attributes are read-only.
46
47 ======================= ========================================================
48 in1_label               "vout1"
49 in1_input               Measured voltage. From READ_VOUT register.
50 in1_min                 Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
51 in1_max                 Maximum voltage. From VOUT_OV_WARN_LIMIT register.
52 in1_lcrit               Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
53 in1_crit                Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
54                         register.
55 in1_min_alarm           Voltage low alarm. From VOLTAGE_UV_WARNING status.
56 in1_max_alarm           Voltage high alarm. From VOLTAGE_OV_WARNING status.
57 in1_lcrit_alarm         Voltage critical low alarm. From VOLTAGE_UV_FAULT
58                         status.
59 in1_crit_alarm          Voltage critical high alarm. From VOLTAGE_OV_FAULT
60                         status.
61 in1_highest             Historical maximum voltage.
62 in1_reset_history       Write any value to reset history.
63
64 curr1_label             "iout1"
65 curr1_input             Measured current. From READ_IOUT register.
66 curr1_max               Maximum current. From IOUT_OC_WARN_LIMIT register.
67 curr1_crit              Critical maximum current. From IOUT_OC_FAULT_LIMIT
68                         register.
69 curr1_max_alarm         Current high alarm. From IOUT_OC_WARN_LIMIT register.
70 curr1_crit_alarm        Current critical high alarm. From IOUT_OC_FAULT status.
71 curr1_highest           Historical maximum current.
72 curr1_reset_history     Write any value to reset history.
73
74 temp1_input             Measured temperature. From READ_TEMPERATURE_1 register.
75 temp1_max               Maximum temperature. From OT_WARN_LIMIT register.
76 temp1_crit              Critical high temperature. From OT_FAULT_LIMIT register.
77 temp1_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.
80 temp1_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.
83 temp1_highest           Historical maximum temperature.
84 temp1_reset_history     Write any value to reset history.
85 ======================= ========================================================