Merge tag 'bitmain-soc-5.2' of git://git.kernel.org/pub/scm/linux/kernel/git/mani...
[sfrench/cifs-2.6.git] / Documentation / hwmon / ucd9000
1 Kernel driver ucd9000
2 =====================
3
4 Supported chips:
5   * TI UCD90120, UCD90124, UCD90160, UCD9090, and UCD90910
6     Prefixes: 'ucd90120', 'ucd90124', 'ucd90160', 'ucd9090', 'ucd90910'
7     Addresses scanned: -
8     Datasheets:
9         http://focus.ti.com/lit/ds/symlink/ucd90120.pdf
10         http://focus.ti.com/lit/ds/symlink/ucd90124.pdf
11         http://focus.ti.com/lit/ds/symlink/ucd90160.pdf
12         http://focus.ti.com/lit/ds/symlink/ucd9090.pdf
13         http://focus.ti.com/lit/ds/symlink/ucd90910.pdf
14
15 Author: Guenter Roeck <linux@roeck-us.net>
16
17
18 Description
19 -----------
20
21 From datasheets:
22
23 The UCD90120 Power Supply Sequencer and System Health Monitor monitors and
24 sequences up to 12 independent voltage rails. The device integrates a 12-bit
25 ADC with a 2.5V internal reference for monitoring up to 13 power supply voltage,
26 current, or temperature inputs.
27
28 The UCD90124 is a 12-rail PMBus/I2C addressable power-supply sequencer and
29 system-health monitor. The device integrates a 12-bit ADC for monitoring up to
30 13 power-supply voltage, current, or temperature inputs. Twenty-six GPIO pins
31 can be used for power supply enables, power-on reset signals, external
32 interrupts, cascading, or other system functions. Twelve of these pins offer PWM
33 functionality. Using these pins, the UCD90124 offers support for fan control,
34 margining, and general-purpose PWM functions.
35
36 The UCD90160 is a 16-rail PMBus/I2C addressable power-supply sequencer and
37 monitor. The device integrates a 12-bit ADC for monitoring up to 16 power-supply
38 voltage inputs. Twenty-six GPIO pins can be used for power supply enables,
39 power-on reset signals, external interrupts, cascading, or other system
40 functions. Twelve of these pins offer PWM functionality. Using these pins, the
41 UCD90160 offers support for margining, and general-purpose PWM functions.
42
43 The UCD9090 is a 10-rail PMBus/I2C addressable power-supply sequencer and
44 monitor. The device integrates a 12-bit ADC for monitoring up to 10 power-supply
45 voltage inputs. Twenty-three GPIO pins can be used for power supply enables,
46 power-on reset signals, external interrupts, cascading, or other system
47 functions. Ten of these pins offer PWM functionality. Using these pins, the
48 UCD9090 offers support for margining, and general-purpose PWM functions.
49
50 The UCD90910 is a ten-rail I2C / PMBus addressable power-supply sequencer and
51 system-health monitor. The device integrates a 12-bit ADC for monitoring up to
52 13 power-supply voltage, current, or temperature inputs.
53
54 This driver is a client driver to the core PMBus driver. Please see
55 Documentation/hwmon/pmbus for details on PMBus client drivers.
56
57
58 Usage Notes
59 -----------
60
61 This driver does not auto-detect devices. You will have to instantiate the
62 devices explicitly. Please see Documentation/i2c/instantiating-devices for
63 details.
64
65
66 Platform data support
67 ---------------------
68
69 The driver supports standard PMBus driver platform data. Please see
70 Documentation/hwmon/pmbus for details.
71
72
73 Sysfs entries
74 -------------
75
76 The following attributes are supported. Limits are read-write; all other
77 attributes are read-only.
78
79 in[1-12]_label          "vout[1-12]".
80 in[1-12]_input          Measured voltage. From READ_VOUT register.
81 in[1-12]_min            Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
82 in[1-12]_max            Maximum voltage. From VOUT_OV_WARN_LIMIT register.
83 in[1-12]_lcrit          Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
84 in[1-12]_crit           Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
85 in[1-12]_min_alarm      Voltage low alarm. From VOLTAGE_UV_WARNING status.
86 in[1-12]_max_alarm      Voltage high alarm. From VOLTAGE_OV_WARNING status.
87 in[1-12]_lcrit_alarm    Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
88 in[1-12]_crit_alarm     Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
89
90 curr[1-12]_label        "iout[1-12]".
91 curr[1-12]_input        Measured current. From READ_IOUT register.
92 curr[1-12]_max          Maximum current. From IOUT_OC_WARN_LIMIT register.
93 curr[1-12]_lcrit        Critical minimum output current. From IOUT_UC_FAULT_LIMIT
94                         register.
95 curr[1-12]_crit         Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
96 curr[1-12]_max_alarm    Current high alarm. From IOUT_OC_WARNING status.
97 curr[1-12]_crit_alarm   Current critical high alarm. From IOUT_OC_FAULT status.
98
99                         For each attribute index, either voltage or current is
100                         reported, but not both. If voltage or current is
101                         reported depends on the chip configuration.
102
103 temp[1-2]_input         Measured temperatures. From READ_TEMPERATURE_1 and
104                         READ_TEMPERATURE_2 registers.
105 temp[1-2]_max           Maximum temperature. From OT_WARN_LIMIT register.
106 temp[1-2]_crit          Critical high temperature. From OT_FAULT_LIMIT register.
107 temp[1-2]_max_alarm     Temperature high alarm.
108 temp[1-2]_crit_alarm    Temperature critical high alarm.
109
110 fan[1-4]_input          Fan RPM.
111 fan[1-4]_alarm          Fan alarm.
112 fan[1-4]_fault          Fan fault.
113
114                         Fan attributes are only available on chips supporting
115                         fan control (UCD90124, UCD90910). Attribute files are
116                         created only for enabled fans.
117                         Note that even though UCD90910 supports up to 10 fans,
118                         only up to four fans are currently supported.