Commit 6e954d2e authored by Erik Rosen's avatar Erik Rosen Committed by Guenter Roeck
Browse files

hwmon: (pmbus/zl6100) Update documentation for zl6100 driver 



Update documentation for zl6100 driver and fix dead links to technical
specifications

Signed-off-by: default avatarErik Rosen <erik.rosen@metormote.com>
Link: https://lore.kernel.org/r/20210423153329.33457-3-erik.rosen@metormote.com


Signed-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
parent ab9d85e9

Documentation/hwmon/zl6100.rst

+89 −43
Original line number Original line Diff line number Diff line
@@ -3,87 +3,103 @@ Kernel driver zl6100 




Supported chips:

Supported chips:





  * Intersil / Zilker Labs ZL2004

  * Renesas / Intersil / Zilker Labs ZL2004





    Prefix: 'zl2004'

    Prefix: 'zl2004'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6847.pdf

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





  * Intersil / Zilker Labs ZL2005

  * Renesas / Intersil / Zilker Labs ZL2005





    Prefix: 'zl2005'

    Prefix: 'zl2005'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6848.pdf

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





  * Intersil / Zilker Labs ZL2006

  * Renesas / Intersil / Zilker Labs ZL2006





    Prefix: 'zl2006'

    Prefix: 'zl2006'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6850.pdf

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





  * Intersil / Zilker Labs ZL2008

  * Renesas / Intersil / Zilker Labs ZL2008





    Prefix: 'zl2008'

    Prefix: 'zl2008'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6859.pdf

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





  * Intersil / Zilker Labs ZL2105

  * Renesas / Intersil / Zilker Labs ZL2105





    Prefix: 'zl2105'

    Prefix: 'zl2105'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6851.pdf

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





  * Intersil / Zilker Labs ZL2106

  * Renesas / Intersil / Zilker Labs ZL2106





    Prefix: 'zl2106'

    Prefix: 'zl2106'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6852.pdf

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





  * Intersil / Zilker Labs ZL6100

  * Renesas / Intersil / Zilker Labs ZL6100





    Prefix: 'zl6100'

    Prefix: 'zl6100'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6876.pdf

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





  * Intersil / Zilker Labs ZL6105

  * Renesas / Intersil / Zilker Labs ZL6105





    Prefix: 'zl6105'

    Prefix: 'zl6105'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn6906.pdf

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





  * Intersil / Zilker Labs ZL9101M

  * 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'

    Prefix: 'zl9101'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn7669.pdf

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





  * Intersil / Zilker Labs ZL9117M

  * Renesas / Intersil / Zilker Labs ZL9117M





    Prefix: 'zl9117'

    Prefix: 'zl9117'





    Addresses scanned: -

    Addresses scanned: -





    Datasheet: http://www.intersil.com/data/fn/fn7914.pdf

    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





  * Ericsson BMR450, BMR451

  * Flex BMR450, BMR451





    Prefix: 'bmr450', 'bmr451'

    Prefix: 'bmr450', 'bmr451'
@@ -91,17 +107,39 @@ Supported chips: 




    Datasheet:

    Datasheet:





http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146401

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





  * Ericsson BMR462, BMR463, BMR464

  * Flex BMR462, BMR463, BMR464





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

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





    Addresses scanned: -

    Addresses scanned: -





    Datasheet:

    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





	http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146256

  * Flex BMR469



    Prefixes: 'bmr469'



    Addresses scanned: -



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





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

Author: Guenter Roeck <linux@roeck-us.net>
@@ -109,8 +147,8 @@ Author: Guenter Roeck <linux@roeck-us.net> 
Description

Description

-----------

-----------





This driver supports hardware monitoring for Intersil / Zilker Labs ZL6100 and

This driver supports hardware monitoring for Renesas / Intersil / Zilker Labs

compatible digital DC-DC controllers.

ZL6100 and compatible digital DC-DC controllers.





The driver is a client driver to the core PMBus driver. Please see

The driver is a client driver to the core PMBus driver. Please see

Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details

Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
@@ -147,12 +185,12 @@ Module parameters 
delay

delay

-----

-----





Intersil/Zilker Labs DC-DC controllers require a minimum interval between I2C

Renesas/Intersil/Zilker Labs DC-DC controllers require a minimum interval

bus accesses. According to Intersil, the minimum interval is 2 ms, though 1 ms

between I2C bus accesses. According to Intersil, the minimum interval is 2 ms,

appears to be sufficient and has not caused any problems in testing. The problem

though 1 ms appears to be sufficient and has not caused any problems in testing.

is known to affect all currently supported chips. For manual override, the

The problem is known to affect all currently supported chips. For manual override,

driver provides a writeable module parameter, 'delay', which can be used to set

the driver provides a writeable module parameter, 'delay', which can be used

the interval to a value between 0 and 65,535 microseconds.

to set the interval to a value between 0 and 65,535 microseconds.









Sysfs entries

Sysfs entries
@@ -182,24 +220,32 @@ in2_crit Critical maximum VMON/VDRV voltage. 
in2_lcrit_alarm		VMON/VDRV voltage critical low alarm.

in2_lcrit_alarm		VMON/VDRV voltage critical low alarm.

in2_crit_alarm		VMON/VDRV voltage critical high alarm.

in2_crit_alarm		VMON/VDRV voltage critical high alarm.





			vmon attributes are supported on ZL2004, ZL9101M,

			vmon attributes are supported on ZL2004, ZL8802,

			and ZL9117M only.

			ZL9101M, ZL9117M and ZLS4009 only.





inX_label		"vout1"

inX_label		"vout[12]"

inX_input		Measured output voltage.

inX_input		Measured output voltage.

inX_lcrit		Critical minimum output Voltage.

inX_lcrit		Critical minimum output Voltage.

inX_crit		Critical maximum output voltage.

inX_crit		Critical maximum output voltage.

inX_lcrit_alarm		Critical output voltage critical low alarm.

inX_lcrit_alarm		Critical output voltage critical low alarm.

inX_crit_alarm		Critical output voltage critical high alarm.

inX_crit_alarm		Critical output voltage critical high alarm.





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

			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.





curr1_label		"iout1"

			Y is 2, 3 for ZL8802, 1 otherwise

curr1_input		Measured output current.

curr1_lcrit		Critical minimum output current.

curr1_crit		Critical maximum output current.

curr1_lcrit_alarm	Output current critical low alarm.

curr1_crit_alarm	Output current critical high alarm.





temp[12]_input		Measured temperature.

temp[12]_input		Measured temperature.

temp[12]_min		Minimum temperature.

temp[12]_min		Minimum temperature.