Blame - Documentation/hwmon/ltc2978 - kernel/msm-4.9

blob: dc0d08c61305469305d86f2f3cd04a32fa2e56c6 [file] [log] [blame]

Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	1	Kernel driver ltc2978
				2	=====================
				3
				4	Supported chips:
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	5	* Linear Technology LTC2974
				6	Prefix: 'ltc2974'
				7	Addresses scanned: -
				8	Datasheet: http://www.linear.com/product/ltc2974
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	9	* Linear Technology LTC2978
				10	Prefix: 'ltc2978'
				11	Addresses scanned: -
Guenter Roeck	6d21a41	2013-01-27 09:36:36 -0800	[diff] [blame]	12	Datasheet: http://www.linear.com/product/ltc2978
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	13	* Linear Technology LTC3880
				14	Prefix: 'ltc3880'
				15	Addresses scanned: -
Guenter Roeck	6d21a41	2013-01-27 09:36:36 -0800	[diff] [blame]	16	Datasheet: http://www.linear.com/product/ltc3880
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	17	* Linear Technology LTC3883
				18	Prefix: 'ltc3883'
				19	Addresses scanned: -
				20	Datasheet: http://www.linear.com/product/ltc3883
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	21
Guenter Roeck	e3333e5	2013-02-20 20:58:42 -0800	[diff] [blame]	22	Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	23
				24
				25	Description
				26	-----------
				27
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	28	LTC2974 is a quad digital power supply manager. LTC2978 is an octal power supply
				29	monitor. LTC3880 is a dual output poly-phase step-down DC/DC controller. LTC3883
				30	is a single phase step-down DC/DC controller.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	31
				32
				33	Usage Notes
				34	-----------
				35
				36	This driver does not probe for PMBus devices. You will have to instantiate
				37	devices explicitly.
				38
				39	Example: the following commands will load the driver for an LTC2978 at address
				40	0x60 on I2C bus #1:
				41
				42	# modprobe ltc2978
				43	# echo ltc2978 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
				44
				45
				46	Sysfs attributes
				47	----------------
				48
				49	in1_label "vin"
				50	in1_input Measured input voltage.
				51	in1_min Minimum input voltage.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	52	in1_max Maximum input voltage. LTC2974 and LTC2978 only.
				53	in1_lcrit Critical minimum input voltage. LTC2974 and LTC2978
				54	only.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	55	in1_crit Critical maximum input voltage.
				56	in1_min_alarm Input voltage low alarm.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	57	in1_max_alarm Input voltage high alarm. LTC2974 and LTC2978 only.
				58	in1_lcrit_alarm Input voltage critical low alarm. LTC2974 and LTC2978
				59	only.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	60	in1_crit_alarm Input voltage critical high alarm.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	61	in1_lowest Lowest input voltage. LTC2974 and LTC2978 only.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	62	in1_highest Highest input voltage.
Guenter Roeck	8c770f3	2013-02-22 07:52:39 -0800	[diff] [blame]	63	in1_reset_history Reset input voltage history.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	64
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	65	in[N]_label "vout[1-8]".
				66	LTC2974: N=2-5
				67	LTC2978: N=2-9
				68	LTC3880: N=2-3
				69	LTC3883: N=2
				70	in[N]_input Measured output voltage.
				71	in[N]_min Minimum output voltage.
				72	in[N]_max Maximum output voltage.
				73	in[N]_lcrit Critical minimum output voltage.
				74	in[N]_crit Critical maximum output voltage.
				75	in[N]_min_alarm Output voltage low alarm.
				76	in[N]_max_alarm Output voltage high alarm.
				77	in[N]_lcrit_alarm Output voltage critical low alarm.
				78	in[N]_crit_alarm Output voltage critical high alarm.
				79	in[N]_lowest Lowest output voltage. LTC2974 and LTC2978 only.
				80	in[N]_highest Highest output voltage.
				81	in[N]_reset_history Reset output voltage history.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	82
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	83	temp[N]_input Measured temperature.
				84	On LTC2974, temp[1-4] report external temperatures,
				85	and temp5 reports the chip temperature.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	86	On LTC2978, only one temperature measurement is
Guenter Roeck	8c770f3	2013-02-22 07:52:39 -0800	[diff] [blame]	87	supported and reports the chip temperature.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	88	On LTC3880, temp1 and temp2 report external
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	89	temperatures, and temp3 reports the chip temperature.
				90	On LTC3883, temp1 reports an external temperature,
				91	and temp2 reports the chip temperature.
				92	temp[N]_min Mimimum temperature. LTC2974 and LTC2978 only.
				93	temp[N]_max Maximum temperature.
				94	temp[N]_lcrit Critical low temperature.
				95	temp[N]_crit Critical high temperature.
				96	temp[N]_min_alarm Temperature low alarm. LTC2974 and LTC2978 only.
				97	temp[N]_max_alarm Temperature high alarm.
				98	temp[N]_lcrit_alarm Temperature critical low alarm.
				99	temp[N]_crit_alarm Temperature critical high alarm.
				100	temp[N]_lowest Lowest measured temperature. LTC2974 and LTC2978 only.
				101	Not supported for chip temperature sensor on LTC2974.
				102	temp[N]_highest Highest measured temperature. Not supported for chip
				103	temperature sensor on LTC2974.
				104	temp[N]_reset_history Reset temperature history. Not supported for chip
				105	temperature sensor on LTC2974.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	106
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	107	power1_label "pin". LTC3883 only.
				108	power1_input Measured input power.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	109
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	110	power[N]_label "pout[1-4]".
				111	LTC2974: N=1-4
				112	LTC2978: Not supported
				113	LTC3880: N=1-2
				114	LTC3883: N=2
				115	power[N]_input Measured output power.
				116
				117	curr1_label "iin". LTC3880 and LTC3883 only.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	118	curr1_input Measured input current.
				119	curr1_max Maximum input current.
				120	curr1_max_alarm Input current high alarm.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	121	curr1_highest Highest input current. LTC3883 only.
				122	curr1_reset_history Reset input current history. LTC3883 only.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	123
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame^]	124	curr[N]_label "iout[1-4]".
				125	LTC2974: N=1-4
				126	LTC2978: not supported
				127	LTC3880: N=2-3
				128	LTC3883: N=2
				129	curr[N]_input Measured output current.
				130	curr[N]_max Maximum output current.
				131	curr[N]_crit Critical high output current.
				132	curr[N]_lcrit Critical low output current. LTC2974 only.
				133	curr[N]_max_alarm Output current high alarm.
				134	curr[N]_crit_alarm Output current critical high alarm.
				135	curr[N]_lcrit_alarm Output current critical low alarm. LTC2974 only.
				136	curr[N]_lowest Lowest output current. LTC2974 only.
				137	curr[N]_highest Highest output current.
				138	curr[N]_reset_history Reset output current history.