Merge git://git.infradead.org/battery-2.6
[pandora-kernel.git] / Documentation / hwmon / max8688
1 Kernel driver max8688
2 =====================
3
4 Supported chips:
5   * Maxim MAX8688
6     Prefix: 'max8688'
7     Addresses scanned: -
8     Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf
9
10 Author: Guenter Roeck <guenter.roeck@ericsson.com>
11
12
13 Description
14 -----------
15
16 This driver supports hardware montoring for Maxim MAX8688 Digital Power-Supply
17 Controller/Monitor with PMBus Interface.
18
19 The driver is a client driver to the core PMBus driver. Please see
20 Documentation/hwmon/pmbus for details on PMBus client drivers.
21
22
23 Usage Notes
24 -----------
25
26 This driver does not auto-detect devices. You will have to instantiate the
27 devices explicitly. Please see Documentation/i2c/instantiating-devices for
28 details.
29
30
31 Platform data support
32 ---------------------
33
34 The driver supports standard PMBus driver platform data.
35
36
37 Sysfs entries
38 -------------
39
40 The following attributes are supported. Limits are read-write; all other
41 attributes are read-only.
42
43 in1_label               "vout1"
44 in1_input               Measured voltage. From READ_VOUT register.
45 in1_min                 Minumum Voltage. From VOUT_UV_WARN_LIMIT register.
46 in1_max                 Maximum voltage. From VOUT_OV_WARN_LIMIT register.
47 in1_lcrit               Critical minumum Voltage. VOUT_UV_FAULT_LIMIT register.
48 in1_crit                Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
49 in1_min_alarm           Voltage low alarm. From VOLTAGE_UV_WARNING status.
50 in1_max_alarm           Voltage high alarm. From VOLTAGE_OV_WARNING status.
51 in1_lcrit_alarm         Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
52 in1_crit_alarm          Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
53
54 curr1_label             "iout1"
55 curr1_input             Measured current. From READ_IOUT register.
56 curr1_max               Maximum current. From IOUT_OC_WARN_LIMIT register.
57 curr1_crit              Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
58 curr1_max_alarm         Current high alarm. From IOUT_OC_WARN_LIMIT register.
59 curr1_crit_alarm        Current critical high alarm. From IOUT_OC_FAULT status.
60
61 temp1_input             Measured temperature. From READ_TEMPERATURE_1 register.
62 temp1_max               Maximum temperature. From OT_WARN_LIMIT register.
63 temp1_crit              Critical high temperature. From OT_FAULT_LIMIT register.
64 temp1_max_alarm         Chip temperature high alarm. Set by comparing
65                         READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING
66                         status is set.
67 temp1_crit_alarm        Chip temperature critical high alarm. Set by comparing
68                         READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT
69                         status is set.