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

blob: f997aa53eb95c373872241c7ad8c8e238f049365 [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	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	9	* Linear Technology LTC2975
				10	Prefix: 'ltc2975'
				11	Addresses scanned: -
				12	Datasheet: http://www.linear.com/product/ltc2975
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	13	* Linear Technology LTC2977
				14	Prefix: 'ltc2977'
				15	Addresses scanned: -
				16	Datasheet: http://www.linear.com/product/ltc2977
Guenter Roeck	3f08d7f	2013-09-23 11:23:37 -0700	[diff] [blame]	17	* Linear Technology LTC2978, LTC2978A
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	18	Prefix: 'ltc2978'
				19	Addresses scanned: -
Guenter Roeck	6d21a41	2013-01-27 09:36:36 -0800	[diff] [blame]	20	Datasheet: http://www.linear.com/product/ltc2978
Guenter Roeck	3f08d7f	2013-09-23 11:23:37 -0700	[diff] [blame]	21	http://www.linear.com/product/ltc2978a
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	22	* Linear Technology LTC2980
				23	Prefix: 'ltc2980'
				24	Addresses scanned: -
				25	Datasheet: http://www.linear.com/product/ltc2980
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	26	* Linear Technology LTC3880
				27	Prefix: 'ltc3880'
				28	Addresses scanned: -
Guenter Roeck	6d21a41	2013-01-27 09:36:36 -0800	[diff] [blame]	29	Datasheet: http://www.linear.com/product/ltc3880
Guenter Roeck	bf89386	2015-06-08 10:29:45 -0700	[diff] [blame]	30	* Linear Technology LTC3882
				31	Prefix: 'ltc3882'
				32	Addresses scanned: -
				33	Datasheet: http://www.linear.com/product/ltc3882
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	34	* Linear Technology LTC3883
				35	Prefix: 'ltc3883'
				36	Addresses scanned: -
				37	Datasheet: http://www.linear.com/product/ltc3883
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	38	* Linear Technology LTC3886
				39	Prefix: 'ltc3886'
				40	Addresses scanned: -
				41	Datasheet: http://www.linear.com/product/ltc3886
Guenter Roeck	1539856	2015-08-07 09:06:37 -0700	[diff] [blame]	42	* Linear Technology LTC3887
				43	Prefix: 'ltc3887'
				44	Addresses scanned: -
				45	Datasheet: http://www.linear.com/product/ltc3887
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	46	* Linear Technology LTM2987
				47	Prefix: 'ltm2987'
				48	Addresses scanned: -
				49	Datasheet: http://www.linear.com/product/ltm2987
Guenter Roeck	f76992b	2014-03-05 21:23:01 -0800	[diff] [blame]	50	* Linear Technology LTM4676
				51	Prefix: 'ltm4676'
				52	Addresses scanned: -
				53	Datasheet: http://www.linear.com/product/ltm4676
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	54
Guenter Roeck	e3333e5	2013-02-20 20:58:42 -0800	[diff] [blame]	55	Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	56
				57
				58	Description
				59	-----------
				60
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	61	LTC2974 and LTC2975 are quad digital power supply managers.
Guenter Roeck	bf89386	2015-06-08 10:29:45 -0700	[diff] [blame]	62	LTC2978 is an octal power supply monitor.
				63	LTC2977 is a pin compatible replacement for LTC2978.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	64	LTC2980 is a 16-channel Power System Manager, consisting of two LTC2977
				65	in a single die. The chip is instantiated and reported as two separate chips
				66	on two different I2C bus addresses.
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	67	LTC3880, LTC3882, LTC3886, and LTC3887 are dual output poly-phase step-down
				68	DC/DC controllers.
Guenter Roeck	bf89386	2015-06-08 10:29:45 -0700	[diff] [blame]	69	LTC3883 is a single phase step-down DC/DC controller.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	70	LTM2987 is a 16-channel Power System Manager with two LTC2977 plus
				71	additional components on a single die. The chip is instantiated and reported
				72	as two separate chips on two different I2C bus addresses.
Guenter Roeck	bf89386	2015-06-08 10:29:45 -0700	[diff] [blame]	73	LTM4676 is a dual 13A or single 26A uModule regulator.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	74
				75
				76	Usage Notes
				77	-----------
				78
				79	This driver does not probe for PMBus devices. You will have to instantiate
				80	devices explicitly.
				81
				82	Example: the following commands will load the driver for an LTC2978 at address
				83	0x60 on I2C bus #1:
				84
				85	# modprobe ltc2978
				86	# echo ltc2978 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
				87
				88
				89	Sysfs attributes
				90	----------------
				91
				92	in1_label "vin"
				93	in1_input Measured input voltage.
				94	in1_min Minimum input voltage.
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	95	in1_max Maximum input voltage.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	96	LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and
				97	LTM2987 only.
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	98	in1_lcrit Critical minimum input voltage.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	99	LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and
				100	LTM2987 only.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	101	in1_crit Critical maximum input voltage.
				102	in1_min_alarm Input voltage low alarm.
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	103	in1_max_alarm Input voltage high alarm.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	104	LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and
				105	LTM2987 only.
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	106	in1_lcrit_alarm Input voltage critical low alarm.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	107	LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and
				108	LTM2987 only.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	109	in1_crit_alarm Input voltage critical high alarm.
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	110	in1_lowest Lowest input voltage.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	111	LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and
				112	LTM2987 only.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	113	in1_highest Highest input voltage.
Guenter Roeck	8c770f3	2013-02-22 07:52:39 -0800	[diff] [blame]	114	in1_reset_history Reset input voltage history.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	115
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	116	in[N]_label "vout[1-8]".
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	117	LTC2974, LTC2975: N=2-5
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	118	LTC2977, LTC2980, LTM2987: N=2-9
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	119	LTC2978: N=2-9
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	120	LTC3880, LTC3882, LTC23886 LTC3887, LTM4676: N=2-3
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	121	LTC3883: N=2
				122	in[N]_input Measured output voltage.
				123	in[N]_min Minimum output voltage.
				124	in[N]_max Maximum output voltage.
				125	in[N]_lcrit Critical minimum output voltage.
				126	in[N]_crit Critical maximum output voltage.
				127	in[N]_min_alarm Output voltage low alarm.
				128	in[N]_max_alarm Output voltage high alarm.
				129	in[N]_lcrit_alarm Output voltage critical low alarm.
				130	in[N]_crit_alarm Output voltage critical high alarm.
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	131	in[N]_lowest Lowest output voltage. LTC2974, LTC2975,
				132	and LTC2978 only.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	133	in[N]_highest Highest output voltage.
				134	in[N]_reset_history Reset output voltage history.
Guenter Roeck	c3ff9a6	2011-09-02 09:58:37 -0700	[diff] [blame]	135
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	136	temp[N]_input Measured temperature.
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	137	On LTC2974 and LTC2975, temp[1-4] report external
				138	temperatures, and temp5 reports the chip temperature.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	139	On LTC2977, LTC2980, LTC2978, and LTM2987, only one
				140	temperature measurement is supported and reports
				141	the chip temperature.
Guenter Roeck	1539856	2015-08-07 09:06:37 -0700	[diff] [blame]	142	On LTC3880, LTC3882, LTC3887, and LTM4676, temp1 and
				143	temp2 report external temperatures, and temp3 reports
Guenter Roeck	bf89386	2015-06-08 10:29:45 -0700	[diff] [blame]	144	the chip temperature.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	145	On LTC3883, temp1 reports an external temperature,
				146	and temp2 reports the chip temperature.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	147	temp[N]_min Mimimum temperature. LTC2974, LCT2977, LTM2980, LTC2978,
				148	and LTM2987 only.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	149	temp[N]_max Maximum temperature.
				150	temp[N]_lcrit Critical low temperature.
				151	temp[N]_crit Critical high temperature.
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	152	temp[N]_min_alarm Temperature low alarm.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	153	LTC2974, LTC2975, LTC2977, LTM2980, LTC2978, and
				154	LTM2987 only.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	155	temp[N]_max_alarm Temperature high alarm.
				156	temp[N]_lcrit_alarm Temperature critical low alarm.
				157	temp[N]_crit_alarm Temperature critical high alarm.
Guenter Roeck	c24c407e	2013-09-23 10:56:48 -0700	[diff] [blame]	158	temp[N]_lowest Lowest measured temperature.
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	159	LTC2974, LTC2975, LTC2977, LTM2980, LTC2978, and
				160	LTM2987 only.
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	161	Not supported for chip temperature sensor on LTC2974 and
				162	LTC2975.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	163	temp[N]_highest Highest measured temperature. Not supported for chip
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	164	temperature sensor on LTC2974 and LTC2975.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	165	temp[N]_reset_history Reset temperature history. Not supported for chip
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	166	temperature sensor on LTC2974 and LTC2975.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	167
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	168	power1_label "pin". LTC3883 and LTC3886 only.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	169	power1_input Measured input power.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	170
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	171	power[N]_label "pout[1-4]".
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	172	LTC2974, LTC2975: N=1-4
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	173	LTC2977, LTC2980, LTM2987: Not supported
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	174	LTC2978: Not supported
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	175	LTC3880, LTC3882, LTC3886, LTC3887, LTM4676: N=1-2
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	176	LTC3883: N=2
				177	power[N]_input Measured output power.
				178
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	179	curr1_label "iin". LTC3880, LTC3883, LTC3886, LTC3887, and LTM4676
				180	only.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	181	curr1_input Measured input current.
				182	curr1_max Maximum input current.
				183	curr1_max_alarm Input current high alarm.
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	184	curr1_highest Highest input current. LTC3883 and LTC3886 only.
				185	curr1_reset_history Reset input current history. LTC3883 and LTC3886 only.
Guenter Roeck	ddfb41c	2011-09-11 20:31:09 -0700	[diff] [blame]	186
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	187	curr[N]_label "iout[1-4]".
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	188	LTC2974, LTC2975: N=1-4
Guenter Roeck	52aae6a	2015-08-17 06:38:01 -0700	[diff] [blame]	189	LTC2977, LTC2980, LTM2987: not supported
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	190	LTC2978: not supported
Guenter Roeck	228b687	2015-08-17 07:21:43 -0700	[diff] [blame^]	191	LTC3880, LTC3882, LTC3886, LTC3887, LTM4676: N=2-3
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	192	LTC3883: N=2
				193	curr[N]_input Measured output current.
				194	curr[N]_max Maximum output current.
				195	curr[N]_crit Critical high output current.
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	196	curr[N]_lcrit Critical low output current. LTC2974 and LTC2975 only.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	197	curr[N]_max_alarm Output current high alarm.
				198	curr[N]_crit_alarm Output current critical high alarm.
Guenter Roeck	649ca82	2015-06-08 09:56:20 -0700	[diff] [blame]	199	curr[N]_lcrit_alarm Output current critical low alarm.
				200	LTC2974 and LTC2975 only.
				201	curr[N]_lowest Lowest output current. LTC2974 and LTC2975 only.
Guenter Roeck	fd9175d	2013-01-27 09:24:28 -0800	[diff] [blame]	202	curr[N]_highest Highest output current.
				203	curr[N]_reset_history Reset output current history.