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

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