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