Commit 1f234ff1 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Guenter Roeck
Browse files

docs: hwmon: pmbus files: convert to ReST format 



Convert pmbus files to ReST format, in order to allow them to
be parsed by Sphinx.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
parent 0d925626

Documentation/hwmon/adm1275

+26 −0
Original line number Diff line number Diff line
@@ -2,29 +2,53 @@ Kernel driver adm1275 
=====================



Supported chips:



  * Analog Devices ADM1075



    Prefix: 'adm1075'



    Addresses scanned: -



    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf



  * Analog Devices ADM1272



    Prefix: 'adm1272'



    Addresses scanned: -



    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1272.pdf



  * Analog Devices ADM1275



    Prefix: 'adm1275'



    Addresses scanned: -



    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf



  * Analog Devices ADM1276



    Prefix: 'adm1276'



    Addresses scanned: -



    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf



  * Analog Devices ADM1278



    Prefix: 'adm1278'



    Addresses scanned: -



    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf



  * Analog Devices ADM1293/ADM1294



    Prefix: 'adm1293', 'adm1294'



    Addresses scanned: -



    Datasheet: http://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf



Author: Guenter Roeck <linux@roeck-us.net>
@@ -75,6 +99,7 @@ Sysfs entries 
The following attributes are supported. Limits are read-write, history reset

attributes are write-only, all other attributes are read-only.



======================= =======================================================

inX_label		"vin1" or "vout1" depending on chip variant and

			configuration. On ADM1075, ADM1293, and ADM1294,

			vout1 reports the voltage on the VAUX pin.
@@ -120,3 +145,4 @@ temp1_reset_history Write any value to reset history. 


			Temperature attributes are supported on ADM1272 and

			ADM1278.

======================= =======================================================

Documentation/hwmon/ibm-cffps

+3 −0
Original line number Diff line number Diff line
@@ -2,6 +2,7 @@ Kernel driver ibm-cffps 
=======================



Supported chips:



  * IBM Common Form Factor power supply



Author: Eddie James <eajames@us.ibm.com>
@@ -24,6 +25,7 @@ Sysfs entries 


The following attributes are supported:



======================= ======================================================

curr1_alarm		Output current over-current alarm.

curr1_input		Measured output current in mA.

curr1_label		"iout1"
@@ -52,3 +54,4 @@ temp2_alarm Secondary rectifier temp over-temperature alarm. 
temp2_input		Measured secondary rectifier temp in millidegrees C.

temp3_alarm		ORing FET temperature over-temperature alarm.

temp3_input		Measured ORing FET temperature in millidegrees C.

======================= ======================================================

Documentation/hwmon/ir35221

+8 −3
Original line number Diff line number Diff line
@@ -3,8 +3,11 @@ Kernel driver ir35221 


Supported chips:

  * Infineon IR35221



    Prefix: 'ir35221'



    Addresses scanned: -



    Datasheet: Datasheet is not publicly available.



Author: Samuel Mendoza-Jonas <sam@mendozajonas.com>
@@ -23,7 +26,7 @@ This driver does not probe for PMBus devices. You will have to instantiate 
devices explicitly.



Example: the following commands will load the driver for an IR35221

at address 0x70 on I2C bus #4:

at address 0x70 on I2C bus #4::



	# modprobe ir35221

	# echo ir35221 0x70 > /sys/bus/i2c/devices/i2c-4/new_device
@@ -32,6 +35,7 @@ at address 0x70 on I2C bus #4: 
Sysfs attributes

----------------



======================= =======================================================

curr1_label		"iin"

curr1_input		Measured input current

curr1_max		Maximum current
@@ -85,3 +89,4 @@ temp[1-2]_highest Highest temperature 
temp[1-2]_lowest	Lowest temperature

temp[1-2]_max		Maximum temperature

temp[1-2]_max_alarm	Chip temperature high alarm

======================= =======================================================

Documentation/hwmon/lm25066

+30 −0
Original line number Diff line number Diff line
@@ -2,34 +2,62 @@ Kernel driver lm25066 
=====================



Supported chips:



  * TI LM25056



    Prefix: 'lm25056'



    Addresses scanned: -



    Datasheets:



	http://www.ti.com/lit/gpn/lm25056



	http://www.ti.com/lit/gpn/lm25056a



  * National Semiconductor LM25066



    Prefix: 'lm25066'



    Addresses scanned: -



    Datasheets:



	http://www.national.com/pf/LM/LM25066.html



	http://www.national.com/pf/LM/LM25066A.html



  * National Semiconductor LM5064



    Prefix: 'lm5064'



    Addresses scanned: -



    Datasheet:



	http://www.national.com/pf/LM/LM5064.html



  * National Semiconductor LM5066



    Prefix: 'lm5066'



    Addresses scanned: -



    Datasheet:



	http://www.national.com/pf/LM/LM5066.html



  * Texas Instruments LM5066I



    Prefix: 'lm5066i'



    Addresses scanned: -



	Datasheet:



    http://www.ti.com/product/LM5066I





Author: Guenter Roeck <linux@roeck-us.net>
@@ -64,6 +92,7 @@ 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_average		Average measured input voltage.
@@ -105,3 +134,4 @@ temp1_max Maximum temperature. 
temp1_crit		Critical high temperature.

temp1_max_alarm		Chip temperature high alarm.

temp1_crit_alarm	Chip temperature critical high alarm.

======================= =======================================================

Documentation/hwmon/ltc2978

+203 −64
Original line number Diff line number Diff line
@@ -2,85 +2,143 @@ Kernel driver ltc2978 
=====================



Supported chips:



  * Linear Technology LTC2974



    Prefix: 'ltc2974'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc2974



  * Linear Technology LTC2975



    Prefix: 'ltc2975'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc2975



  * Linear Technology LTC2977



    Prefix: 'ltc2977'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc2977



  * Linear Technology LTC2978, LTC2978A



    Prefix: 'ltc2978'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc2978



	       http://www.linear.com/product/ltc2978a



  * Linear Technology LTC2980



    Prefix: 'ltc2980'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc2980



  * Linear Technology LTC3880



    Prefix: 'ltc3880'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc3880



  * Linear Technology LTC3882



    Prefix: 'ltc3882'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc3882



  * Linear Technology LTC3883



    Prefix: 'ltc3883'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc3883



  * Linear Technology LTC3886



    Prefix: 'ltc3886'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc3886



  * Linear Technology LTC3887



    Prefix: 'ltc3887'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltc3887



  * Linear Technology LTM2987



    Prefix: 'ltm2987'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltm2987



  * Linear Technology LTM4675



    Prefix: 'ltm4675'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltm4675



  * Linear Technology LTM4676



    Prefix: 'ltm4676'



    Addresses scanned: -



    Datasheet: http://www.linear.com/product/ltm4676



  * Analog Devices LTM4686



    Prefix: 'ltm4686'



    Addresses scanned: -



    Datasheet: http://www.analog.com/ltm4686





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





Description

-----------



LTC2974 and LTC2975 are quad digital power supply managers.

LTC2978 is an octal power supply monitor.

LTC2977 is a pin compatible replacement for LTC2978.

LTC2980 is a 16-channel Power System Manager, consisting of two LTC2977

in a single die. The chip is instantiated and reported as two separate chips

on two different I2C bus addresses.

LTC3880, LTC3882, LTC3886, and LTC3887 are dual output poly-phase step-down

DC/DC controllers.

LTC3883 is a single phase step-down DC/DC controller.

LTM2987 is a 16-channel Power System Manager with two LTC2977 plus

additional components on a single die. The chip is instantiated and reported

as two separate chips on two different I2C bus addresses.

LTM4675 is a dual 9A or single 18A μModule regulator

LTM4676 is a dual 13A or single 26A uModule regulator.

LTM4686 is a dual 10A or single 20A uModule regulator.

- LTC2974 and LTC2975 are quad digital power supply managers.

- LTC2978 is an octal power supply monitor.

- LTC2977 is a pin compatible replacement for LTC2978.

- LTC2980 is a 16-channel Power System Manager, consisting of two LTC2977

- in a single die. The chip is instantiated and reported as two separate chips

- on two different I2C bus addresses.

- LTC3880, LTC3882, LTC3886, and LTC3887 are dual output poly-phase step-down

- DC/DC controllers.

- LTC3883 is a single phase step-down DC/DC controller.

- LTM2987 is a 16-channel Power System Manager with two LTC2977 plus

- additional components on a single die. The chip is instantiated and reported

- as two separate chips on two different I2C bus addresses.

- LTM4675 is a dual 9A or single 18A μModule regulator

- LTM4676 is a dual 13A or single 26A uModule regulator.

- LTM4686 is a dual 10A or single 20A uModule regulator.





Usage Notes
@@ -90,7 +148,7 @@ This driver does not probe for PMBus devices. You will have to instantiate 
devices explicitly.



Example: the following commands will load the driver for an LTC2978 at address

0x60 on I2C bus #1:

0x60 on I2C bus #1::



	# modprobe ltc2978

	# echo ltc2978 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
@@ -99,118 +157,199 @@ Example: the following commands will load the driver for an LTC2978 at address 
Sysfs attributes

----------------



======================= ========================================================

in1_label		"vin"



in1_input		Measured input voltage.



in1_min			Minimum input voltage.



in1_max			Maximum input voltage.



			LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and

			LTM2987 only.



in1_lcrit		Critical minimum input voltage.



			LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and

			LTM2987 only.



in1_crit		Critical maximum input voltage.



in1_min_alarm		Input voltage low alarm.



in1_max_alarm		Input voltage high alarm.



			LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and

			LTM2987 only.

in1_lcrit_alarm		Input voltage critical low alarm.



			LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and

			LTM2987 only.

in1_crit_alarm		Input voltage critical high alarm.



in1_lowest		Lowest input voltage.



			LTC2974, LTC2975, LTC2977, LTC2980, LTC2978, and

			LTM2987 only.

in1_highest		Highest input voltage.



in1_reset_history	Reset input voltage history.



in[N]_label		"vout[1-8]".

			LTC2974, LTC2975: N=2-5

			LTC2977, LTC2980, LTM2987: N=2-9

			LTC2978: N=2-9

			LTC3880, LTC3882, LTC23886 LTC3887, LTM4675, LTM4676:



			- LTC2974, LTC2975: N=2-5

			- LTC2977, LTC2980, LTM2987: N=2-9

			- LTC2978: N=2-9

			- LTC3880, LTC3882, LTC23886 LTC3887, LTM4675, LTM4676:

			  N=2-3

			LTC3883: N=2

			- LTC3883: N=2



in[N]_input		Measured output voltage.



in[N]_min		Minimum output voltage.



in[N]_max		Maximum output voltage.



in[N]_lcrit		Critical minimum output voltage.



in[N]_crit		Critical maximum output voltage.



in[N]_min_alarm		Output voltage low alarm.



in[N]_max_alarm		Output voltage high alarm.



in[N]_lcrit_alarm	Output voltage critical low alarm.



in[N]_crit_alarm	Output voltage critical high alarm.

in[N]_lowest		Lowest output voltage. LTC2974, LTC2975,

			and LTC2978 only.



in[N]_lowest		Lowest output voltage.





			LTC2974, LTC2975,and LTC2978 only.



in[N]_highest		Highest output voltage.



in[N]_reset_history	Reset output voltage history.



temp[N]_input		Measured temperature.

			On LTC2974 and LTC2975, temp[1-4] report external



			- On LTC2974 and LTC2975, temp[1-4] report external

			  temperatures, and temp5 reports the chip temperature.

			On LTC2977, LTC2980, LTC2978, and LTM2987, only one

			- On LTC2977, LTC2980, LTC2978, and LTM2987, only one

			  temperature measurement is supported and reports

			  the chip temperature.

			On LTC3880, LTC3882, LTC3887, LTM4675, and LTM4676,

			temp1 and temp2 report external temperatures, and temp3

			reports the chip temperature.

			On LTC3883, temp1 reports an external temperature,

			- On LTC3880, LTC3882, LTC3887, LTM4675, and LTM4676,

			  temp1 and temp2 report external temperatures, and

			  temp3 reports the chip temperature.

			- On LTC3883, temp1 reports an external temperature,

			  and temp2 reports the chip temperature.

temp[N]_min		Mimimum temperature. LTC2974, LCT2977, LTM2980, LTC2978,

			and LTM2987 only.



temp[N]_min		Mimimum temperature.



			LTC2974, LCT2977, LTM2980, LTC2978, and LTM2987 only.



temp[N]_max		Maximum temperature.



temp[N]_lcrit		Critical low temperature.



temp[N]_crit		Critical high temperature.



temp[N]_min_alarm	Temperature low alarm.



			LTC2974, LTC2975, LTC2977, LTM2980, LTC2978, and

			LTM2987 only.



temp[N]_max_alarm	Temperature high alarm.





temp[N]_lcrit_alarm	Temperature critical low alarm.



temp[N]_crit_alarm	Temperature critical high alarm.



temp[N]_lowest		Lowest measured temperature.

			LTC2974, LTC2975, LTC2977, LTM2980, LTC2978, and



			- LTC2974, LTC2975, LTC2977, LTM2980, LTC2978, and

			  LTM2987 only.

			Not supported for chip temperature sensor on LTC2974 and

			LTC2975.

temp[N]_highest		Highest measured temperature. Not supported for chip

			temperature sensor on LTC2974 and LTC2975.

temp[N]_reset_history	Reset temperature history. Not supported for chip

			temperature sensor on LTC2974 and LTC2975.

			- Not supported for chip temperature sensor on LTC2974

			  and LTC2975.



temp[N]_highest		Highest measured temperature.



			Not supported for chip temperature sensor on

			LTC2974 and LTC2975.



temp[N]_reset_history	Reset temperature history.



			Not supported for chip temperature sensor on

			LTC2974 and LTC2975.



power1_label		"pin". LTC3883 and LTC3886 only.



power1_input		Measured input power.



power[N]_label		"pout[1-4]".

			LTC2974, LTC2975: N=1-4

			LTC2977, LTC2980, LTM2987: Not supported

			LTC2978: Not supported

			LTC3880, LTC3882, LTC3886, LTC3887, LTM4675, LTM4676:



			- LTC2974, LTC2975: N=1-4

			- LTC2977, LTC2980, LTM2987: Not supported

			- LTC2978: Not supported

			- LTC3880, LTC3882, LTC3886, LTC3887, LTM4675, LTM4676:

			  N=1-2

			LTC3883: N=2

			- LTC3883: N=2



power[N]_input		Measured output power.



curr1_label		"iin". LTC3880, LTC3883, LTC3886, LTC3887, LTM4675,

curr1_label		"iin".



			LTC3880, LTC3883, LTC3886, LTC3887, LTM4675,

			and LTM4676 only.



curr1_input		Measured input current.



curr1_max		Maximum input current.



curr1_max_alarm		Input current high alarm.

curr1_highest		Highest input current. LTC3883 and LTC3886 only.

curr1_reset_history	Reset input current history. LTC3883 and LTC3886 only.



curr1_highest		Highest input current.



			LTC3883 and LTC3886 only.



curr1_reset_history	Reset input current history.



			LTC3883 and LTC3886 only.



curr[N]_label		"iout[1-4]".

			LTC2974, LTC2975: N=1-4

			LTC2977, LTC2980, LTM2987: not supported

			LTC2978: not supported

			LTC3880, LTC3882, LTC3886, LTC3887, LTM4675, LTM4676:



			- LTC2974, LTC2975: N=1-4

			- LTC2977, LTC2980, LTM2987: not supported

			- LTC2978: not supported

			- LTC3880, LTC3882, LTC3886, LTC3887, LTM4675, LTM4676:

			  N=2-3

			LTC3883: N=2

			- LTC3883: N=2



curr[N]_input		Measured output current.



curr[N]_max		Maximum output current.



curr[N]_crit		Critical high output current.

curr[N]_lcrit		Critical low output current. LTC2974 and LTC2975 only.



curr[N]_lcrit		Critical low output current.



			LTC2974 and LTC2975 only.



curr[N]_max_alarm	Output current high alarm.



curr[N]_crit_alarm	Output current critical high alarm.



curr[N]_lcrit_alarm	Output current critical low alarm.



			LTC2974 and LTC2975 only.



curr[N]_lowest		Lowest output current.



			LTC2974 and LTC2975 only.

curr[N]_lowest		Lowest output current. LTC2974 and LTC2975 only.



curr[N]_highest		Highest output current.



curr[N]_reset_history	Reset output current history.

======================= ========================================================