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