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