]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - Documentation/hwmon/adm1275
Merge tag 'fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/rusty...
[karo-tx-linux.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   * Analog Devices ADM1293/ADM1294
18     Prefix: 'adm1293', 'adm1294'
19     Addresses scanned: -
20     Datasheet: http://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf
21
22 Author: Guenter Roeck <linux@roeck-us.net>
23
24
25 Description
26 -----------
27
28 This driver supports hardware montoring for Analog Devices ADM1075, ADM1275,
29 ADM1276, ADM1293, and ADM1294 Hot-Swap Controller and Digital Power Monitors.
30
31 ADM1075, ADM1275, ADM1276, ADM1293, and ADM1294 are hot-swap controllers that
32 allow a circuit board to be removed from or inserted into a live backplane.
33 They also feature current and voltage readback via an integrated 12
34 bit analog-to-digital converter (ADC), accessed using a PMBus interface.
35
36 The driver is a client driver to the core PMBus driver. Please see
37 Documentation/hwmon/pmbus for details on PMBus client drivers.
38
39
40 Usage Notes
41 -----------
42
43 This driver does not auto-detect devices. You will have to instantiate the
44 devices explicitly. Please see Documentation/i2c/instantiating-devices for
45 details.
46
47 The ADM1075, unlike many other PMBus devices, does not support internal voltage
48 or current scaling. Reported voltages, currents, and power are raw measurements,
49 and will typically have to be scaled.
50
51
52 Platform data support
53 ---------------------
54
55 The driver supports standard PMBus driver platform data. Please see
56 Documentation/hwmon/pmbus for details.
57
58
59 Sysfs entries
60 -------------
61
62 The following attributes are supported. Limits are read-write, history reset
63 attributes are write-only, all other attributes are read-only.
64
65 inX_label               "vin1" or "vout1" depending on chip variant and
66                         configuration. On ADM1075, ADM1293, and ADM1294,
67                         vout1 reports the voltage on the VAUX pin.
68 inX_input               Measured voltage.
69 inX_min                 Minimum Voltage.
70 inX_max                 Maximum voltage.
71 inX_min_alarm           Voltage low alarm.
72 inX_max_alarm           Voltage high alarm.
73 inX_highest             Historical maximum voltage.
74 inX_reset_history       Write any value to reset history.
75
76 curr1_label             "iout1"
77 curr1_input             Measured current.
78 curr1_max               Maximum current.
79 curr1_max_alarm         Current high alarm.
80 curr1_lcrit             Critical minimum current. Depending on the chip
81                         configuration, either curr1_lcrit or curr1_crit is
82                         supported, but not both.
83 curr1_lcrit_alarm       Critical current low alarm.
84 curr1_crit              Critical maximum current. Depending on the chip
85                         configuration, either curr1_lcrit or curr1_crit is
86                         supported, but not both.
87 curr1_crit_alarm        Critical current high alarm.
88 curr1_highest           Historical maximum current.
89 curr1_reset_history     Write any value to reset history.
90
91 power1_label            "pin1"
92 power1_input            Input power.
93 power1_input_lowest     Lowest observed input power. ADM1293 and ADM1294 only.
94 power1_input_highest    Highest observed input power.
95 power1_reset_history    Write any value to reset history.
96
97                         Power attributes are supported on ADM1075, ADM1276,
98                         ADM1293, and ADM1294.