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

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