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