Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorris...
[platform/adaptation/renesas_rcar/renesas_kernel.git] / Documentation / hwmon / adm1275
1 Kernel driver adm1275
2 =====================
3
4 Supported chips:
5   * Analog Devices ADM1075
6     Prefix: 'adm1075'
7     Addresses scanned: -
8     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf
9   * Analog Devices ADM1275
10     Prefix: 'adm1275'
11     Addresses scanned: -
12     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
13   * Analog Devices ADM1276
14     Prefix: 'adm1276'
15     Addresses scanned: -
16     Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
17
18 Author: Guenter Roeck <guenter.roeck@ericsson.com>
19
20
21 Description
22 -----------
23
24 This driver supports hardware montoring for Analog Devices ADM1075, ADM1275,
25 and ADM1276 Hot-Swap Controller and Digital Power Monitor.
26
27 ADM1075, ADM1275, and ADM1276 are hot-swap controllers that allow a circuit
28 board to be removed from or inserted into a live backplane. They also feature
29 current and voltage readback via an integrated 12-bit analog-to-digital
30 converter (ADC), accessed using a PMBus interface.
31
32 The driver is a client driver to the core PMBus driver. Please see
33 Documentation/hwmon/pmbus for details on PMBus client drivers.
34
35
36 Usage Notes
37 -----------
38
39 This driver does not auto-detect devices. You will have to instantiate the
40 devices explicitly. Please see Documentation/i2c/instantiating-devices for
41 details.
42
43 The ADM1075, unlike many other PMBus devices, does not support internal voltage
44 or current scaling. Reported voltages, currents, and power are raw measurements,
45 and will typically have to be scaled.
46
47
48 Platform data support
49 ---------------------
50
51 The driver supports standard PMBus driver platform data. Please see
52 Documentation/hwmon/pmbus for details.
53
54
55 Sysfs entries
56 -------------
57
58 The following attributes are supported. Limits are read-write, history reset
59 attributes are write-only, all other attributes are read-only.
60
61 in1_label               "vin1" or "vout1" depending on chip variant and
62                         configuration. On ADM1075, vout1 reports the voltage on
63                         the VAUX pin.
64 in1_input               Measured voltage.
65 in1_min                 Minimum Voltage.
66 in1_max                 Maximum voltage.
67 in1_min_alarm           Voltage low alarm.
68 in1_max_alarm           Voltage high alarm.
69 in1_highest             Historical maximum voltage.
70 in1_reset_history       Write any value to reset history.
71
72 curr1_label             "iout1"
73 curr1_input             Measured current.
74 curr1_max               Maximum current.
75 curr1_max_alarm         Current high alarm.
76 curr1_lcrit             Critical minimum current. Depending on the chip
77                         configuration, either curr1_lcrit or curr1_crit is
78                         supported, but not both.
79 curr1_lcrit_alarm       Critical current low alarm.
80 curr1_crit              Critical maximum current. Depending on the chip
81                         configuration, either curr1_lcrit or curr1_crit is
82                         supported, but not both.
83 curr1_crit_alarm        Critical current high alarm.
84 curr1_highest           Historical maximum current.
85 curr1_reset_history     Write any value to reset history.
86
87 power1_label            "pin1"
88 power1_input            Input power.
89 power1_reset_history    Write any value to reset history.
90
91                         Power attributes are supported on ADM1075 and ADM1276
92                         only.