Merge tag 'armsoc-dt' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / hwmon / max16064.rst
1 Kernel driver max16064
2 ======================
3
4 Supported chips:
5
6   * Maxim MAX16064
7
8     Prefix: 'max16064'
9
10     Addresses scanned: -
11
12     Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX16064.pdf
13
14 Author: Guenter Roeck <linux@roeck-us.net>
15
16
17 Description
18 -----------
19
20 This driver supports hardware monitoring for Maxim MAX16064 Quad Power-Supply
21 Controller with Active-Voltage Output Control and PMBus Interface.
22
23 The driver is a client driver to the core PMBus driver.
24 Please see 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 in[1-4]_label           "vout[1-4]"
49 in[1-4]_input           Measured voltage. From READ_VOUT register.
50 in[1-4]_min             Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
51 in[1-4]_max             Maximum voltage. From VOUT_OV_WARN_LIMIT register.
52 in[1-4]_lcrit           Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
53 in[1-4]_crit            Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
54                         register.
55 in[1-4]_min_alarm       Voltage low alarm. From VOLTAGE_UV_WARNING status.
56 in[1-4]_max_alarm       Voltage high alarm. From VOLTAGE_OV_WARNING status.
57 in[1-4]_lcrit_alarm     Voltage critical low alarm. From VOLTAGE_UV_FAULT
58                         status.
59 in[1-4]_crit_alarm      Voltage critical high alarm. From VOLTAGE_OV_FAULT
60                         status.
61 in[1-4]_highest         Historical maximum voltage.
62 in[1-4]_reset_history   Write any value to reset history.
63
64 temp1_input             Measured temperature. From READ_TEMPERATURE_1 register.
65 temp1_max               Maximum temperature. From OT_WARN_LIMIT register.
66 temp1_crit              Critical high temperature. From OT_FAULT_LIMIT register.
67 temp1_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.
70 temp1_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.
73 temp1_highest           Historical maximum temperature.
74 temp1_reset_history     Write any value to reset history.
75 ======================= ========================================================