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

Kernel driver ucd9000
=====================

Supported chips:

  * TI UCD90120, UCD90124, UCD90160, UCD9090, and UCD90910

    Prefixes: 'ucd90120', 'ucd90124', 'ucd90160', 'ucd9090', 'ucd90910'

    Addresses scanned: -

    Datasheets:

	- http://focus.ti.com/lit/ds/symlink/ucd90120.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd90124.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd90160.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd9090.pdf
	- http://focus.ti.com/lit/ds/symlink/ucd90910.pdf

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


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

From datasheets:

The UCD90120 Power Supply Sequencer and System Health Monitor monitors and
sequences up to 12 independent voltage rails. The device integrates a 12-bit
ADC with a 2.5V internal reference for monitoring up to 13 power supply voltage,
current, or temperature inputs.

The UCD90124 is a 12-rail PMBus/I2C addressable power-supply sequencer and
system-health monitor. The device integrates a 12-bit ADC for monitoring up to
13 power-supply voltage, current, or temperature inputs. Twenty-six GPIO pins
can be used for power supply enables, power-on reset signals, external
interrupts, cascading, or other system functions. Twelve of these pins offer PWM
functionality. Using these pins, the UCD90124 offers support for fan control,
margining, and general-purpose PWM functions.

The UCD90160 is a 16-rail PMBus/I2C addressable power-supply sequencer and
monitor. The device integrates a 12-bit ADC for monitoring up to 16 power-supply
voltage inputs. Twenty-six GPIO pins can be used for power supply enables,
power-on reset signals, external interrupts, cascading, or other system
functions. Twelve of these pins offer PWM functionality. Using these pins, the
UCD90160 offers support for margining, and general-purpose PWM functions.

The UCD9090 is a 10-rail PMBus/I2C addressable power-supply sequencer and
monitor. The device integrates a 12-bit ADC for monitoring up to 10 power-supply
voltage inputs. Twenty-three GPIO pins can be used for power supply enables,
power-on reset signals, external interrupts, cascading, or other system
functions. Ten of these pins offer PWM functionality. Using these pins, the
UCD9090 offers support for margining, and general-purpose PWM functions.

The UCD90910 is a ten-rail I2C / PMBus addressable power-supply sequencer and
system-health monitor. The device integrates a 12-bit ADC for monitoring up to
13 power-supply voltage, current, or temperature inputs.

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.

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

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

			For each attribute index, either voltage or current is
			reported, but not both. If voltage or current is
			reported depends on the chip configuration.

temp[1-2]_input		Measured temperatures. From READ_TEMPERATURE_1 and
			READ_TEMPERATURE_2 registers.
temp[1-2]_max		Maximum temperature. From OT_WARN_LIMIT register.
temp[1-2]_crit		Critical high temperature. From OT_FAULT_LIMIT register.
temp[1-2]_max_alarm	Temperature high alarm.
temp[1-2]_crit_alarm	Temperature critical high alarm.

fan[1-4]_input		Fan RPM.
fan[1-4]_alarm		Fan alarm.
fan[1-4]_fault		Fan fault.

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