[linux-2.6-block.git] / Documentation / hwmon / ucd9200.rst

Kernel driver ucd9200
=====================

Supported chips:

  * TI UCD9220, UCD9222, UCD9224, UCD9240, UCD9244, UCD9246, and UCD9248

    Prefixes: 'ucd9220', 'ucd9222', 'ucd9224', 'ucd9240', 'ucd9244', 'ucd9246',
    'ucd9248'

    Addresses scanned: -

    Datasheets:

	- http://focus.ti.com/lit/ds/symlink/ucd9220.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd9222.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd9224.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd9240.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd9244.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd9246.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd9248.pdf

Author: Guenter Roeck <linux@roeck-us.net>


Description
-----------

[From datasheets] UCD9220, UCD9222, UCD9224, UCD9240, UCD9244, UCD9246, and
UCD9248 are multi-rail, multi-phase synchronous buck digital PWM controllers
designed for non-isolated DC/DC power applications. The devices integrate
dedicated circuitry for DC/DC loop management with flash memory and a serial
interface to support configuration, monitoring and management.

This driver is a client driver to the core PMBus driver. Please see
Documentation/hwmon/pmbus.rst for details on PMBus client drivers.


Usage Notes
-----------

This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details.


Platform data support
---------------------

The driver supports standard PMBus driver platform data. Please see
Documentation/hwmon/pmbus.rst for details.


Sysfs entries
-------------

The following attributes are supported. Limits are read-write; all other
attributes are read-only.

======================= ========================================================
in1_label		"vin".
in1_input		Measured voltage. From READ_VIN register.
in1_min			Minimum Voltage. From VIN_UV_WARN_LIMIT register.
in1_max			Maximum voltage. From VIN_OV_WARN_LIMIT register.
in1_lcrit		Critical minimum Voltage. VIN_UV_FAULT_LIMIT register.
in1_crit		Critical maximum voltage. From VIN_OV_FAULT_LIMIT
			register.
in1_min_alarm		Voltage low alarm. From VIN_UV_WARNING status.
in1_max_alarm		Voltage high alarm. From VIN_OV_WARNING status.
in1_lcrit_alarm		Voltage critical low alarm. From VIN_UV_FAULT status.
in1_crit_alarm		Voltage critical high alarm. From VIN_OV_FAULT status.

in[2-5]_label		"vout[1-4]".
in[2-5]_input		Measured voltage. From READ_VOUT register.
in[2-5]_min		Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
in[2-5]_max		Maximum voltage. From VOUT_OV_WARN_LIMIT register.
in[2-5]_lcrit		Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
in[2-5]_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
			register.
in[2-5]_min_alarm	Voltage low alarm. From VOLTAGE_UV_WARNING status.
in[2-5]_max_alarm	Voltage high alarm. From VOLTAGE_OV_WARNING status.
in[2-5]_lcrit_alarm	Voltage critical low alarm. From VOLTAGE_UV_FAULT
			status.
in[2-5]_crit_alarm	Voltage critical high alarm. From VOLTAGE_OV_FAULT
			status.

curr1_label		"iin".
curr1_input		Measured current. From READ_IIN register.

curr[2-5]_label		"iout[1-4]".
curr[2-5]_input		Measured current. From READ_IOUT register.
curr[2-5]_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
curr[2-5]_lcrit		Critical minimum output current. From
			IOUT_UC_FAULT_LIMIT register.
curr[2-5]_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT
			register.
curr[2-5]_max_alarm	Current high alarm. From IOUT_OC_WARNING status.
curr[2-5]_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.

power1_input		Measured input power. From READ_PIN register.
power1_label		"pin"

power[2-5]_input	Measured output power. From READ_POUT register.
power[2-5]_label	"pout[1-4]"

			The number of output voltage, current, and power
			attribute sets is determined by the number of enabled
			rails. See chip datasheets for details.

temp[1-5]_input		Measured temperatures. From READ_TEMPERATURE_1 and
			READ_TEMPERATURE_2 registers.
			temp1 is the chip internal temperature. temp[2-5] are
			rail temperatures.  temp[2-5] attributes are only
			created for enabled rails. See chip datasheets for
			details.
temp[1-5]_max		Maximum temperature. From OT_WARN_LIMIT register.
temp[1-5]_crit		Critical high temperature. From OT_FAULT_LIMIT register.
temp[1-5]_max_alarm	Temperature high alarm.
temp[1-5]_crit_alarm	Temperature critical high alarm.

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