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

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