[mirror_ubuntu-artful-kernel.git] / Documentation / hwmon / lm25066

Kernel driver lm25066
=====================

Supported chips:
  * TI LM25056
    Prefix: 'lm25056'
    Addresses scanned: -
    Datasheets:
	http://www.ti.com/lit/gpn/lm25056
	http://www.ti.com/lit/gpn/lm25056a
  * TI LM25063
    Prefix: 'lm25063'
    Addresses scanned: -
    Datasheet:
	To be announced
  * National Semiconductor LM25066
    Prefix: 'lm25066'
    Addresses scanned: -
    Datasheets:
	http://www.national.com/pf/LM/LM25066.html
	http://www.national.com/pf/LM/LM25066A.html
  * National Semiconductor LM5064
    Prefix: 'lm5064'
    Addresses scanned: -
    Datasheet:
	http://www.national.com/pf/LM/LM5064.html
  * National Semiconductor LM5066
    Prefix: 'lm5066'
    Addresses scanned: -
    Datasheet:
	http://www.national.com/pf/LM/LM5066.html

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


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

This driver supports hardware monitoring for National Semiconductor / TI LM25056,
LM25063, LM25066, LM5064, and LM5066 Power Management, Monitoring, Control, and
Protection ICs.

The driver is a client driver to the core PMBus driver. Please see
Documentation/hwmon/pmbus 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 for
details.


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

The driver supports standard PMBus driver platform data.


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

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

in1_label		"vin"
in1_input		Measured input voltage.
in1_average		Average measured input voltage.
in1_min			Minimum input voltage.
in1_max			Maximum input voltage.
in1_crit		Critical high input voltage (LM25063 only).
in1_lcrit		Critical low input voltage (LM25063 only).
in1_min_alarm		Input voltage low alarm.
in1_max_alarm		Input voltage high alarm.
in1_lcrit_alarm		Input voltage critical low alarm (LM25063 only).
in1_crit_alarm		Input voltage critical high alarm. (LM25063 only).

in2_label		"vmon"
in2_input		Measured voltage on VAUX pin
in2_min			Minimum VAUX voltage (LM25056 only).
in2_max			Maximum VAUX voltage (LM25056 only).
in2_min_alarm		VAUX voltage low alarm (LM25056 only).
in2_max_alarm		VAUX voltage high alarm (LM25056 only).

in3_label		"vout1"
			Not supported on LM25056.
in3_input		Measured output voltage.
in3_average		Average measured output voltage.
in3_min			Minimum output voltage.
in3_min_alarm		Output voltage low alarm.
in3_highest		Historical minimum output voltage (LM25063 only).
in3_lowest		Historical maximum output voltage (LM25063 only).

curr1_label		"iin"
curr1_input		Measured input current.
curr1_average		Average measured input current.
curr1_max		Maximum input current.
curr1_crit		Critical input current (LM25063 only).
curr1_max_alarm		Input current high alarm.
curr1_crit_alarm	Input current critical high alarm (LM25063 only).

power1_label		"pin"
power1_input		Measured input power.
power1_average		Average measured input power.
power1_max		Maximum input power limit.
power1_alarm		Input power alarm
power1_input_highest	Historical maximum power.
power1_reset_history	Write any value to reset maximum power history.

power2_label		"pout". LM25063 only.
power2_input		Measured output power.
power2_max		Maximum output power limit.
power2_crit		Critical output power limit.

temp1_input		Measured temperature.
temp1_max		Maximum temperature.
temp1_crit		Critical high temperature.
temp1_max_alarm		Chip temperature high alarm.
temp1_crit_alarm	Chip temperature critical high alarm.
Commit	Line	Data
58615a94	1	Kernel driver lm25066
03e9bd8d GR	2	=====================
	3
	4	Supported chips:
58615a94 GR	5	* TI LM25056
	6	Prefix: 'lm25056'
	7	Addresses scanned: -
	8	Datasheets:
	9	http://www.ti.com/lit/gpn/lm25056
	10	http://www.ti.com/lit/gpn/lm25056a
c8ccab7a GR	11	* TI LM25063
	12	Prefix: 'lm25063'
	13	Addresses scanned: -
	14	Datasheet:
	15	To be announced
03e9bd8d GR	16	* National Semiconductor LM25066
	17	Prefix: 'lm25066'
	18	Addresses scanned: -
	19	Datasheets:
	20	http://www.national.com/pf/LM/LM25066.html
	21	http://www.national.com/pf/LM/LM25066A.html
	22	* National Semiconductor LM5064
	23	Prefix: 'lm5064'
	24	Addresses scanned: -
	25	Datasheet:
	26	http://www.national.com/pf/LM/LM5064.html
	27	* National Semiconductor LM5066
	28	Prefix: 'lm5066'
	29	Addresses scanned: -
	30	Datasheet:
	31	http://www.national.com/pf/LM/LM5066.html
	32
e3333e57	33	Author: Guenter Roeck <linux@roeck-us.net>
03e9bd8d GR	34
	35
	36	Description
	37	-----------
	38
92417dad	39	This driver supports hardware monitoring for National Semiconductor / TI LM25056,
c8ccab7a	40	LM25063, LM25066, LM5064, and LM5066 Power Management, Monitoring, Control, and
58615a94	41	Protection ICs.
03e9bd8d GR	42
	43	The driver is a client driver to the core PMBus driver. Please see
	44	Documentation/hwmon/pmbus for details on PMBus client drivers.
	45
	46
	47	Usage Notes
	48	-----------
	49
	50	This driver does not auto-detect devices. You will have to instantiate the
	51	devices explicitly. Please see Documentation/i2c/instantiating-devices for
	52	details.
	53
	54
	55	Platform data support
	56	---------------------
	57
	58	The driver supports standard PMBus driver platform data.
	59
	60
	61	Sysfs entries
	62	-------------
	63
	64	The following attributes are supported. Limits are read-write; all other
	65	attributes are read-only.
	66
	67	in1_label "vin"
	68	in1_input Measured input voltage.
	69	in1_average Average measured input voltage.
	70	in1_min Minimum input voltage.
	71	in1_max Maximum input voltage.
c8ccab7a GR	72	in1_crit Critical high input voltage (LM25063 only).
c8ccab7a GR	73	in1_lcrit Critical low input voltage (LM25063 only).
03e9bd8d GR	74	in1_min_alarm Input voltage low alarm.
03e9bd8d GR	75	in1_max_alarm Input voltage high alarm.
c8ccab7a GR	76	in1_lcrit_alarm Input voltage critical low alarm (LM25063 only).
c8ccab7a GR	77	in1_crit_alarm Input voltage critical high alarm. (LM25063 only).
03e9bd8d	78
a7c69118 GR	79	in2_label "vmon"
a7c69118 GR	80	in2_input Measured voltage on VAUX pin
58615a94 GR	81	in2_min Minimum VAUX voltage (LM25056 only).
	82	in2_max Maximum VAUX voltage (LM25056 only).
	83	in2_min_alarm VAUX voltage low alarm (LM25056 only).
	84	in2_max_alarm VAUX voltage high alarm (LM25056 only).
a7c69118 GR	85
a7c69118 GR	86	in3_label "vout1"
58615a94	87	Not supported on LM25056.
a7c69118 GR	88	in3_input Measured output voltage.
	89	in3_average Average measured output voltage.
	90	in3_min Minimum output voltage.
	91	in3_min_alarm Output voltage low alarm.
c8ccab7a GR	92	in3_highest Historical minimum output voltage (LM25063 only).
c8ccab7a GR	93	in3_lowest Historical maximum output voltage (LM25063 only).
03e9bd8d GR	94
	95	curr1_label "iin"
	96	curr1_input Measured input current.
	97	curr1_average Average measured input current.
	98	curr1_max Maximum input current.
c8ccab7a	99	curr1_crit Critical input current (LM25063 only).
03e9bd8d	100	curr1_max_alarm Input current high alarm.
c8ccab7a	101	curr1_crit_alarm Input current critical high alarm (LM25063 only).
03e9bd8d GR	102
	103	power1_label "pin"
	104	power1_input Measured input power.
	105	power1_average Average measured input power.
	106	power1_max Maximum input power limit.
	107	power1_alarm Input power alarm
	108	power1_input_highest Historical maximum power.
	109	power1_reset_history Write any value to reset maximum power history.
	110
c8ccab7a GR	111	power2_label "pout". LM25063 only.
	112	power2_input Measured output power.
	113	power2_max Maximum output power limit.
	114	power2_crit Critical output power limit.
	115
03e9bd8d GR	116	temp1_input Measured temperature.
	117	temp1_max Maximum temperature.
	118	temp1_crit Critical high temperature.
	119	temp1_max_alarm Chip temperature high alarm.
	120	temp1_crit_alarm Chip temperature critical high alarm.