[linux-block.git] / Documentation / hwmon / zl6100.rst

Kernel driver zl6100
====================

Supported chips:

  * Renesas / Intersil / Zilker Labs ZL2004

    Prefix: 'zl2004'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl2004-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL2005

    Prefix: 'zl2005'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl2005-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL2006

    Prefix: 'zl2006'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl2006-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL2008

    Prefix: 'zl2008'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl2008-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL2105

    Prefix: 'zl2105'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl2105-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL2106

    Prefix: 'zl2106'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl2106-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL6100

    Prefix: 'zl6100'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl6100-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL6105

    Prefix: 'zl6105'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl6105-datasheet.pdf

  * Renesas / Intersil / Zilker Labs ZL8802

    Prefix: 'zl8802'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl8802-datasheet

  * Renesas / Intersil / Zilker Labs ZL9101M

    Prefix: 'zl9101'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl9101m-datasheet

  * Renesas / Intersil / Zilker Labs ZL9117M

    Prefix: 'zl9117'

    Addresses scanned: -

    Datasheet: https://www.renesas.com/us/en/document/dst/zl9117m-datasheet

  * Renesas / Intersil / Zilker Labs ZLS1003, ZLS4009

    Prefix: 'zls1003', zls4009

    Addresses scanned: -

    Datasheet: Not published

  * Flex BMR450, BMR451

    Prefix: 'bmr450', 'bmr451'

    Addresses scanned: -

    Datasheet:

https://flexpowermodules.com/resources/fpm-techspec-bmr450-digital-pol-regulators-20a

  * Flex BMR462, BMR463, BMR464

    Prefixes: 'bmr462', 'bmr463', 'bmr464'

    Addresses scanned: -

    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr462

  * Flex BMR465, BMR467

    Prefixes: 'bmr465', 'bmr467'

    Addresses scanned: -

    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr465-digital-pol

  * Flex BMR466

    Prefixes: 'bmr466'

    Addresses scanned: -

    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr466-8x12

  * Flex BMR469

    Prefixes: 'bmr469'

    Addresses scanned: -

    Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr4696001

Author: Guenter Roeck <linux@roeck-us.net>


Description
-----------

This driver supports hardware monitoring for Renesas / Intersil / Zilker Labs
ZL6100 and compatible digital DC-DC controllers.

The driver is a client driver to the core PMBus driver. Please see
Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
on PMBus client drivers.


Usage Notes
-----------

This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details.

.. warning::

  Do not access chip registers using the i2cdump command, and do not use
  any of the i2ctools commands on a command register used to save and restore
  configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
  this driver interpret any access to those command registers (including read
  commands) as request to execute the command in question. Unless write accesses
  to those registers are protected, this may result in power loss, board resets,
  and/or Flash corruption. Worst case, your board may turn into a brick.


Platform data support
---------------------

The driver supports standard PMBus driver platform data.


Module parameters
-----------------

delay
-----

Renesas/Intersil/Zilker Labs DC-DC controllers require a minimum interval
between I2C bus accesses. According to Intersil, the minimum interval is 2 ms,
though 1 ms appears to be sufficient and has not caused any problems in testing.
The problem is known to affect all currently supported chips. For manual override,
the driver provides a writeable module parameter, 'delay', which can be used
to set the interval to a value between 0 and 65,535 microseconds.


Sysfs entries
-------------

The following attributes are supported. Limits are read-write; all other
attributes are read-only.

======================= ========================================================
in1_label		"vin"
in1_input		Measured input voltage.
in1_min			Minimum input voltage.
in1_max			Maximum input voltage.
in1_lcrit		Critical minimum input voltage.
in1_crit		Critical maximum input voltage.
in1_min_alarm		Input voltage low alarm.
in1_max_alarm		Input voltage high alarm.
in1_lcrit_alarm		Input voltage critical low alarm.
in1_crit_alarm		Input voltage critical high alarm.

in2_label		"vmon"
in2_input		Measured voltage on VMON (ZL2004) or VDRV (ZL9101M,
			ZL9117M) pin. Reported voltage is 16x the voltage on the
			pin (adjusted internally by the chip).
in2_lcrit		Critical minimum VMON/VDRV Voltage.
in2_crit		Critical maximum VMON/VDRV voltage.
in2_lcrit_alarm		VMON/VDRV voltage critical low alarm.
in2_crit_alarm		VMON/VDRV voltage critical high alarm.

			vmon attributes are supported on ZL2004, ZL8802,
			ZL9101M, ZL9117M and ZLS4009 only.

inX_label		"vout[12]"
inX_input		Measured output voltage.
inX_lcrit		Critical minimum output Voltage.
inX_crit		Critical maximum output voltage.
inX_lcrit_alarm		Critical output voltage critical low alarm.
inX_crit_alarm		Critical output voltage critical high alarm.

			X is 3 for ZL2004, ZL9101M, and ZL9117M,
			3, 4 for ZL8802 and 2 otherwise.

curr1_label		"iin"
curr1_input		Measured input current.

			iin attributes are supported on ZL8802 only

currY_label		"iout[12]"
currY_input		Measured output current.
currY_lcrit		Critical minimum output current.
currY_crit		Critical maximum output current.
currY_lcrit_alarm	Output current critical low alarm.
currY_crit_alarm	Output current critical high alarm.

			Y is 2, 3 for ZL8802, 1 otherwise

temp[12]_input		Measured temperature.
temp[12]_min		Minimum temperature.
temp[12]_max		Maximum temperature.
temp[12]_lcrit		Critical low temperature.
temp[12]_crit		Critical high temperature.
temp[12]_min_alarm	Chip temperature low alarm.
temp[12]_max_alarm	Chip temperature high alarm.
temp[12]_lcrit_alarm	Chip temperature critical low alarm.
temp[12]_crit_alarm	Chip temperature critical high alarm.
======================= ========================================================
Commit	Line	Data
200855e5 GR	1	Kernel driver zl6100
	2	====================
	3
	4	Supported chips:
1f234ff1	5
6e954d2e	6	* Renesas / Intersil / Zilker Labs ZL2004
1f234ff1	7
200855e5	8	Prefix: 'zl2004'
1f234ff1	9
200855e5	10	Addresses scanned: -
1f234ff1	11
6e954d2e	12	Datasheet: https://www.renesas.com/us/en/document/dst/zl2004-datasheet.pdf
1f234ff1	13
6e954d2e	14	* Renesas / Intersil / Zilker Labs ZL2005
1f234ff1	15
bc581e6f	16	Prefix: 'zl2005'
1f234ff1	17
bc581e6f	18	Addresses scanned: -
1f234ff1	19
6e954d2e	20	Datasheet: https://www.renesas.com/us/en/document/dst/zl2005-datasheet.pdf
1f234ff1	21
6e954d2e	22	* Renesas / Intersil / Zilker Labs ZL2006
1f234ff1	23
200855e5	24	Prefix: 'zl2006'
1f234ff1	25
200855e5	26	Addresses scanned: -
1f234ff1	27
6e954d2e	28	Datasheet: https://www.renesas.com/us/en/document/dst/zl2006-datasheet.pdf
1f234ff1	29
6e954d2e	30	* Renesas / Intersil / Zilker Labs ZL2008
1f234ff1	31
200855e5	32	Prefix: 'zl2008'
1f234ff1	33
200855e5	34	Addresses scanned: -
1f234ff1	35
6e954d2e	36	Datasheet: https://www.renesas.com/us/en/document/dst/zl2008-datasheet.pdf
1f234ff1	37
6e954d2e	38	* Renesas / Intersil / Zilker Labs ZL2105
1f234ff1	39
200855e5	40	Prefix: 'zl2105'
1f234ff1	41
200855e5	42	Addresses scanned: -
1f234ff1	43
6e954d2e	44	Datasheet: https://www.renesas.com/us/en/document/dst/zl2105-datasheet.pdf
1f234ff1	45
6e954d2e	46	* Renesas / Intersil / Zilker Labs ZL2106
1f234ff1	47
200855e5	48	Prefix: 'zl2106'
1f234ff1	49
200855e5	50	Addresses scanned: -
1f234ff1	51
6e954d2e	52	Datasheet: https://www.renesas.com/us/en/document/dst/zl2106-datasheet.pdf
1f234ff1	53
6e954d2e	54	* Renesas / Intersil / Zilker Labs ZL6100
1f234ff1	55
200855e5	56	Prefix: 'zl6100'
1f234ff1	57
200855e5	58	Addresses scanned: -
1f234ff1	59
6e954d2e	60	Datasheet: https://www.renesas.com/us/en/document/dst/zl6100-datasheet.pdf
1f234ff1	61
6e954d2e	62	* Renesas / Intersil / Zilker Labs ZL6105
1f234ff1	63
200855e5	64	Prefix: 'zl6105'
1f234ff1	65
200855e5	66	Addresses scanned: -
1f234ff1	67
6e954d2e	68	Datasheet: https://www.renesas.com/us/en/document/dst/zl6105-datasheet.pdf
1f234ff1	69
6e954d2e ER	70	* Renesas / Intersil / Zilker Labs ZL8802
	71
	72	Prefix: 'zl8802'
	73
	74	Addresses scanned: -
	75
	76	Datasheet: https://www.renesas.com/us/en/document/dst/zl8802-datasheet
	77
	78	* Renesas / Intersil / Zilker Labs ZL9101M
1f234ff1	79
3360a106	80	Prefix: 'zl9101'
1f234ff1	81
3360a106	82	Addresses scanned: -
1f234ff1	83
6e954d2e	84	Datasheet: https://www.renesas.com/us/en/document/dst/zl9101m-datasheet
1f234ff1	85
6e954d2e	86	* Renesas / Intersil / Zilker Labs ZL9117M
1f234ff1	87
3360a106	88	Prefix: 'zl9117'
1f234ff1	89
3360a106	90	Addresses scanned: -
1f234ff1	91
6e954d2e ER	92	Datasheet: https://www.renesas.com/us/en/document/dst/zl9117m-datasheet
	93
	94	* Renesas / Intersil / Zilker Labs ZLS1003, ZLS4009
	95
	96	Prefix: 'zls1003', zls4009
	97
	98	Addresses scanned: -
	99
	100	Datasheet: Not published
1f234ff1	101
6e954d2e	102	* Flex BMR450, BMR451
1f234ff1	103
443830f6	104	Prefix: 'bmr450', 'bmr451'
1f234ff1	105
443830f6	106	Addresses scanned: -
1f234ff1	107
443830f6	108	Datasheet:
1f234ff1	109
6e954d2e	110	https://flexpowermodules.com/resources/fpm-techspec-bmr450-digital-pol-regulators-20a
1f234ff1	111
6e954d2e	112	* Flex BMR462, BMR463, BMR464
1f234ff1	113
443830f6	114	Prefixes: 'bmr462', 'bmr463', 'bmr464'
1f234ff1	115
443830f6	116	Addresses scanned: -
1f234ff1	117
6e954d2e ER	118	Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr462
	119
	120	* Flex BMR465, BMR467
	121
	122	Prefixes: 'bmr465', 'bmr467'
	123
	124	Addresses scanned: -
	125
	126	Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr465-digital-pol
	127
	128	* Flex BMR466
	129
	130	Prefixes: 'bmr466'
	131
	132	Addresses scanned: -
	133
	134	Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr466-8x12
443830f6	135
6e954d2e ER	136	* Flex BMR469
	137
	138	Prefixes: 'bmr469'
	139
	140	Addresses scanned: -
	141
	142	Datasheet: https://flexpowermodules.com/resources/fpm-techspec-bmr4696001
200855e5	143
e3333e57	144	Author: Guenter Roeck <linux@roeck-us.net>
200855e5 GR	145
	146
	147	Description
	148	-----------
	149
6e954d2e ER	150	This driver supports hardware monitoring for Renesas / Intersil / Zilker Labs
6e954d2e ER	151	ZL6100 and compatible digital DC-DC controllers.
200855e5 GR	152
200855e5 GR	153	The driver is a client driver to the core PMBus driver. Please see
7ebd8b66	154	Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
200855e5 GR	155	on PMBus client drivers.
	156
	157
	158	Usage Notes
	159	-----------
	160
	161	This driver does not auto-detect devices. You will have to instantiate the
ccf988b6	162	devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
200855e5 GR	163	details.
200855e5 GR	164
1f234ff1 MCC	165	.. warning::
	166
	167	Do not access chip registers using the i2cdump command, and do not use
	168	any of the i2ctools commands on a command register used to save and restore
	169	configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
	170	this driver interpret any access to those command registers (including read
	171	commands) as request to execute the command in question. Unless write accesses
	172	to those registers are protected, this may result in power loss, board resets,
	173	and/or Flash corruption. Worst case, your board may turn into a brick.
200855e5 GR	174
	175
	176	Platform data support
	177	---------------------
	178
	179	The driver supports standard PMBus driver platform data.
	180
	181
	182	Module parameters
	183	-----------------
	184
	185	delay
	186	-----
	187
6e954d2e ER	188	Renesas/Intersil/Zilker Labs DC-DC controllers require a minimum interval
	189	between I2C bus accesses. According to Intersil, the minimum interval is 2 ms,
	190	though 1 ms appears to be sufficient and has not caused any problems in testing.
	191	The problem is known to affect all currently supported chips. For manual override,
	192	the driver provides a writeable module parameter, 'delay', which can be used
	193	to set the interval to a value between 0 and 65,535 microseconds.
200855e5 GR	194
	195
	196	Sysfs entries
	197	-------------
	198
	199	The following attributes are supported. Limits are read-write; all other
	200	attributes are read-only.
	201
1f234ff1	202	======================= ========================================================
200855e5 GR	203	in1_label "vin"
	204	in1_input Measured input voltage.
	205	in1_min Minimum input voltage.
	206	in1_max Maximum input voltage.
40e47125	207	in1_lcrit Critical minimum input voltage.
200855e5 GR	208	in1_crit Critical maximum input voltage.
	209	in1_min_alarm Input voltage low alarm.
	210	in1_max_alarm Input voltage high alarm.
	211	in1_lcrit_alarm Input voltage critical low alarm.
	212	in1_crit_alarm Input voltage critical high alarm.
	213
1640eaec GR	214	in2_label "vmon"
	215	in2_input Measured voltage on VMON (ZL2004) or VDRV (ZL9101M,
	216	ZL9117M) pin. Reported voltage is 16x the voltage on the
	217	pin (adjusted internally by the chip).
1754e4c5	218	in2_lcrit Critical minimum VMON/VDRV Voltage.
1640eaec GR	219	in2_crit Critical maximum VMON/VDRV voltage.
	220	in2_lcrit_alarm VMON/VDRV voltage critical low alarm.
	221	in2_crit_alarm VMON/VDRV voltage critical high alarm.
	222
6e954d2e ER	223	vmon attributes are supported on ZL2004, ZL8802,
6e954d2e ER	224	ZL9101M, ZL9117M and ZLS4009 only.
1640eaec	225
6e954d2e	226	inX_label "vout[12]"
1640eaec GR	227	inX_input Measured output voltage.
	228	inX_lcrit Critical minimum output Voltage.
	229	inX_crit Critical maximum output voltage.
	230	inX_lcrit_alarm Critical output voltage critical low alarm.
	231	inX_crit_alarm Critical output voltage critical high alarm.
	232
6e954d2e ER	233	X is 3 for ZL2004, ZL9101M, and ZL9117M,
	234	3, 4 for ZL8802 and 2 otherwise.
	235
	236	curr1_label "iin"
	237	curr1_input Measured input current.
	238
	239	iin attributes are supported on ZL8802 only
	240
	241	currY_label "iout[12]"
	242	currY_input Measured output current.
	243	currY_lcrit Critical minimum output current.
	244	currY_crit Critical maximum output current.
	245	currY_lcrit_alarm Output current critical low alarm.
	246	currY_crit_alarm Output current critical high alarm.
200855e5	247
6e954d2e	248	Y is 2, 3 for ZL8802, 1 otherwise
200855e5 GR	249
	250	temp[12]_input Measured temperature.
	251	temp[12]_min Minimum temperature.
	252	temp[12]_max Maximum temperature.
	253	temp[12]_lcrit Critical low temperature.
	254	temp[12]_crit Critical high temperature.
	255	temp[12]_min_alarm Chip temperature low alarm.
	256	temp[12]_max_alarm Chip temperature high alarm.
	257	temp[12]_lcrit_alarm Chip temperature critical low alarm.
	258	temp[12]_crit_alarm Chip temperature critical high alarm.
1f234ff1	259	======================= ========================================================