1Kernel driver ucd9200
2=====================
3
4Supported chips:
5
6  * TI UCD9220, UCD9222, UCD9224, UCD9240, UCD9244, UCD9246, and UCD9248
7
8    Prefixes: 'ucd9220', 'ucd9222', 'ucd9224', 'ucd9240', 'ucd9244', 'ucd9246',
9    'ucd9248'
10
11    Addresses scanned: -
12
13    Datasheets:
14
15	- http://focus.ti.com/lit/ds/symlink/ucd9220.pdf
16	- http://focus.ti.com/lit/ds/symlink/ucd9222.pdf
17	- http://focus.ti.com/lit/ds/symlink/ucd9224.pdf
18	- http://focus.ti.com/lit/ds/symlink/ucd9240.pdf
19	- http://focus.ti.com/lit/ds/symlink/ucd9244.pdf
20	- http://focus.ti.com/lit/ds/symlink/ucd9246.pdf
21	- http://focus.ti.com/lit/ds/symlink/ucd9248.pdf
22
23Author: Guenter Roeck <linux@roeck-us.net>
24
25
26Description
27-----------
28
29[From datasheets] UCD9220, UCD9222, UCD9224, UCD9240, UCD9244, UCD9246, and
30UCD9248 are multi-rail, multi-phase synchronous buck digital PWM controllers
31designed for non-isolated DC/DC power applications. The devices integrate
32dedicated circuitry for DC/DC loop management with flash memory and a serial
33interface to support configuration, monitoring and management.
34
35This driver is a client driver to the core PMBus driver. Please see
36Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
37
38
39Usage Notes
40-----------
41
42This driver does not auto-detect devices. You will have to instantiate the
43devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
44details.
45
46
47Platform data support
48---------------------
49
50The driver supports standard PMBus driver platform data. Please see
51Documentation/hwmon/pmbus.rst for details.
52
53
54Sysfs entries
55-------------
56
57The following attributes are supported. Limits are read-write; all other
58attributes are read-only.
59
60======================= ========================================================
61in1_label		"vin".
62in1_input		Measured voltage. From READ_VIN register.
63in1_min			Minimum Voltage. From VIN_UV_WARN_LIMIT register.
64in1_max			Maximum voltage. From VIN_OV_WARN_LIMIT register.
65in1_lcrit		Critical minimum Voltage. VIN_UV_FAULT_LIMIT register.
66in1_crit		Critical maximum voltage. From VIN_OV_FAULT_LIMIT
67			register.
68in1_min_alarm		Voltage low alarm. From VIN_UV_WARNING status.
69in1_max_alarm		Voltage high alarm. From VIN_OV_WARNING status.
70in1_lcrit_alarm		Voltage critical low alarm. From VIN_UV_FAULT status.
71in1_crit_alarm		Voltage critical high alarm. From VIN_OV_FAULT status.
72
73in[2-5]_label		"vout[1-4]".
74in[2-5]_input		Measured voltage. From READ_VOUT register.
75in[2-5]_min		Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
76in[2-5]_max		Maximum voltage. From VOUT_OV_WARN_LIMIT register.
77in[2-5]_lcrit		Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
78in[2-5]_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
79			register.
80in[2-5]_min_alarm	Voltage low alarm. From VOLTAGE_UV_WARNING status.
81in[2-5]_max_alarm	Voltage high alarm. From VOLTAGE_OV_WARNING status.
82in[2-5]_lcrit_alarm	Voltage critical low alarm. From VOLTAGE_UV_FAULT
83			status.
84in[2-5]_crit_alarm	Voltage critical high alarm. From VOLTAGE_OV_FAULT
85			status.
86
87curr1_label		"iin".
88curr1_input		Measured current. From READ_IIN register.
89
90curr[2-5]_label		"iout[1-4]".
91curr[2-5]_input		Measured current. From READ_IOUT register.
92curr[2-5]_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
93curr[2-5]_lcrit		Critical minimum output current. From
94			IOUT_UC_FAULT_LIMIT register.
95curr[2-5]_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT
96			register.
97curr[2-5]_max_alarm	Current high alarm. From IOUT_OC_WARNING status.
98curr[2-5]_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.
99
100power1_input		Measured input power. From READ_PIN register.
101power1_label		"pin"
102
103power[2-5]_input	Measured output power. From READ_POUT register.
104power[2-5]_label	"pout[1-4]"
105
106			The number of output voltage, current, and power
107			attribute sets is determined by the number of enabled
108			rails. See chip datasheets for details.
109
110temp[1-5]_input		Measured temperatures. From READ_TEMPERATURE_1 and
111			READ_TEMPERATURE_2 registers.
112			temp1 is the chip internal temperature. temp[2-5] are
113			rail temperatures.  temp[2-5] attributes are only
114			created for enabled rails. See chip datasheets for
115			details.
116temp[1-5]_max		Maximum temperature. From OT_WARN_LIMIT register.
117temp[1-5]_crit		Critical high temperature. From OT_FAULT_LIMIT register.
118temp[1-5]_max_alarm	Temperature high alarm.
119temp[1-5]_crit_alarm	Temperature critical high alarm.
120
121fan1_input		Fan RPM. ucd9240 only.
122fan1_alarm		Fan alarm. ucd9240 only.
123fan1_fault		Fan fault. ucd9240 only.
124======================= ========================================================
125