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