Blame - Documentation/hwmon/zl6100 - kernel/msm-4.19

blob: d3bca065cb7ecb988c74c8c975f3fe6bde8e9116 [file] [log] [blame]

Guenter Roeck	200855e	2011-07-29 22:21:53 -0700	[diff] [blame]	1	Kernel driver zl6100
				2	====================
				3
				4	Supported chips:
				5	* Intersil / Zilker Labs ZL2004
				6	Prefix: 'zl2004'
				7	Addresses scanned: -
				8	Datasheet: http://www.intersil.com/data/fn/fn6847.pdf
Guenter Roeck	bc581e6	2011-10-01 16:50:36 -0700	[diff] [blame^]	9	* Intersil / Zilker Labs ZL2005
				10	Prefix: 'zl2005'
				11	Addresses scanned: -
				12	Datasheet: http://www.intersil.com/data/fn/fn6848.pdf
Guenter Roeck	200855e	2011-07-29 22:21:53 -0700	[diff] [blame]	13	* Intersil / Zilker Labs ZL2006
				14	Prefix: 'zl2006'
				15	Addresses scanned: -
				16	Datasheet: http://www.intersil.com/data/fn/fn6850.pdf
				17	* Intersil / Zilker Labs ZL2008
				18	Prefix: 'zl2008'
				19	Addresses scanned: -
				20	Datasheet: http://www.intersil.com/data/fn/fn6859.pdf
				21	* Intersil / Zilker Labs ZL2105
				22	Prefix: 'zl2105'
				23	Addresses scanned: -
				24	Datasheet: http://www.intersil.com/data/fn/fn6851.pdf
				25	* Intersil / Zilker Labs ZL2106
				26	Prefix: 'zl2106'
				27	Addresses scanned: -
				28	Datasheet: http://www.intersil.com/data/fn/fn6852.pdf
				29	* Intersil / Zilker Labs ZL6100
				30	Prefix: 'zl6100'
				31	Addresses scanned: -
				32	Datasheet: http://www.intersil.com/data/fn/fn6876.pdf
				33	* Intersil / Zilker Labs ZL6105
				34	Prefix: 'zl6105'
				35	Addresses scanned: -
				36	Datasheet: http://www.intersil.com/data/fn/fn6906.pdf
				37
				38	Author: Guenter Roeck <guenter.roeck@ericsson.com>
				39
				40
				41	Description
				42	-----------
				43
				44	This driver supports hardware montoring for Intersil / Zilker Labs ZL6100 and
				45	compatible digital DC-DC controllers.
				46
				47	The driver is a client driver to the core PMBus driver. Please see
				48	Documentation/hwmon/pmbus and Documentation.hwmon/pmbus-core for details
				49	on PMBus client drivers.
				50
				51
				52	Usage Notes
				53	-----------
				54
				55	This driver does not auto-detect devices. You will have to instantiate the
				56	devices explicitly. Please see Documentation/i2c/instantiating-devices for
				57	details.
				58
				59	WARNING: Do not access chip registers using the i2cdump command, and do not use
				60	any of the i2ctools commands on a command register used to save and restore
				61	configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
				62	this driver interpret any access to those command registers (including read
				63	commands) as request to execute the command in question. Unless write accesses
				64	to those registers are protected, this may result in power loss, board resets,
				65	and/or Flash corruption. Worst case, your board may turn into a brick.
				66
				67
				68	Platform data support
				69	---------------------
				70
				71	The driver supports standard PMBus driver platform data.
				72
				73
				74	Module parameters
				75	-----------------
				76
				77	delay
				78	-----
				79
				80	Some Intersil/Zilker Labs DC-DC controllers require a minimum interval between
				81	I2C bus accesses. According to Intersil, the minimum interval is 2 ms, though
				82	1 ms appears to be sufficient and has not caused any problems in testing.
				83	The problem is known to affect ZL6100, ZL2105, and ZL2008. It is known not to
				84	affect ZL2004 and ZL6105. The driver automatically sets the interval to 1 ms
				85	except for ZL2004 and ZL6105. To enable manual override, the driver provides a
				86	writeable module parameter, 'delay', which can be used to set the interval to
				87	a value between 0 and 65,535 microseconds.
				88
				89
				90	Sysfs entries
				91	-------------
				92
				93	The following attributes are supported. Limits are read-write; all other
				94	attributes are read-only.
				95
				96	in1_label "vin"
				97	in1_input Measured input voltage.
				98	in1_min Minimum input voltage.
				99	in1_max Maximum input voltage.
				100	in1_lcrit Critical minumum input voltage.
				101	in1_crit Critical maximum input voltage.
				102	in1_min_alarm Input voltage low alarm.
				103	in1_max_alarm Input voltage high alarm.
				104	in1_lcrit_alarm Input voltage critical low alarm.
				105	in1_crit_alarm Input voltage critical high alarm.
				106
				107	in2_label "vout1"
				108	in2_input Measured output voltage.
				109	in2_lcrit Critical minumum output Voltage.
				110	in2_crit Critical maximum output voltage.
				111	in2_lcrit_alarm Critical output voltage critical low alarm.
				112	in2_crit_alarm Critical output voltage critical high alarm.
				113
				114	curr1_label "iout1"
				115	curr1_input Measured output current.
				116	curr1_lcrit Critical minimum output current.
				117	curr1_crit Critical maximum output current.
				118	curr1_lcrit_alarm Output current critical low alarm.
				119	curr1_crit_alarm Output current critical high alarm.
				120
				121	temp[12]_input Measured temperature.
				122	temp[12]_min Minimum temperature.
				123	temp[12]_max Maximum temperature.
				124	temp[12]_lcrit Critical low temperature.
				125	temp[12]_crit Critical high temperature.
				126	temp[12]_min_alarm Chip temperature low alarm.
				127	temp[12]_max_alarm Chip temperature high alarm.
				128	temp[12]_lcrit_alarm Chip temperature critical low alarm.
				129	temp[12]_crit_alarm Chip temperature critical high alarm.