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

docs: hwmon: misc files: convert to ReST format 



Convert other files maintained by Guenter 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 1f234ff1

Documentation/hwmon/ina209

+12 −6
Original line number Diff line number Diff line 
Kernel driver ina209

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

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



Supported chips:



  * Burr-Brown / Texas Instruments INA209



    Prefix: 'ina209'



    Addresses scanned: -



    Datasheet:

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



Author: Paul Hays <Paul.Hays@cattail.ca>

Author: Ira W. Snyder <iws@ovro.caltech.edu>

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

Author:

	- Paul Hays <Paul.Hays@cattail.ca>

	- Ira W. Snyder <iws@ovro.caltech.edu>

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





Description
@@ -31,7 +36,7 @@ the I2C bus. See the datasheet for details. 
This tries to expose most monitoring features of the hardware via

sysfs. It does not support every feature of this chip.





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

in0_input		shunt voltage (mV)

in0_input_highest	shunt voltage historical maximum reading (mV)

in0_input_lowest	shunt voltage historical minimum reading (mV)
@@ -70,6 +75,7 @@ curr1_input current measurement (mA) 


update_interval		data conversion time; affects number of samples used

			to average results for shunt and bus voltages.

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



General Remarks

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

Documentation/hwmon/ina2xx

+32 −7
Original line number Diff line number Diff line
@@ -2,34 +2,55 @@ Kernel driver ina2xx 
====================



Supported chips:



  * Texas Instruments INA219





    Prefix: 'ina219'

    Addresses: I2C 0x40 - 0x4f



    Datasheet: Publicly available at the Texas Instruments website



	       http://www.ti.com/



  * Texas Instruments INA220



    Prefix: 'ina220'



    Addresses: I2C 0x40 - 0x4f



    Datasheet: Publicly available at the Texas Instruments website



	       http://www.ti.com/



  * Texas Instruments INA226



    Prefix: 'ina226'



    Addresses: I2C 0x40 - 0x4f



    Datasheet: Publicly available at the Texas Instruments website



	       http://www.ti.com/



  * Texas Instruments INA230



    Prefix: 'ina230'



    Addresses: I2C 0x40 - 0x4f



    Datasheet: Publicly available at the Texas Instruments website



	       http://www.ti.com/



  * Texas Instruments INA231



    Prefix: 'ina231'



    Addresses: I2C 0x40 - 0x4f



    Datasheet: Publicly available at the Texas Instruments website



	       http://www.ti.com/



Author: Lothar Felten <lothar.felten@gmail.com>
@@ -64,16 +85,20 @@ lower limit of the update_interval is 2 ms, the upper limit is 2253 ms. 
The actual programmed interval may vary from the desired value.



General sysfs entries

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

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



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

in0_input		Shunt voltage(mV) channel

in1_input		Bus voltage(mV) channel

curr1_input		Current(mA) measurement channel

power1_input		Power(uW) measurement channel

shunt_resistor		Shunt resistance(uOhm) channel

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



Sysfs entries for ina226, ina230 and ina231 only

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

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



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

update_interval		data conversion time; affects number of samples used

			to average results for shunt and bus voltages.

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

Documentation/hwmon/jc42

+52 −3
Original line number Diff line number Diff line
@@ -2,53 +2,100 @@ Kernel driver jc42 
==================



Supported chips:



  * Analog Devices ADT7408



    Datasheets:



	http://www.analog.com/static/imported-files/data_sheets/ADT7408.pdf



  * Atmel AT30TS00, AT30TS002A/B, AT30TSE004A



    Datasheets:



	http://www.atmel.com/Images/doc8585.pdf



	http://www.atmel.com/Images/doc8711.pdf



	http://www.atmel.com/Images/Atmel-8852-SEEPROM-AT30TSE002A-Datasheet.pdf



	http://www.atmel.com/Images/Atmel-8868-DTS-AT30TSE004A-Datasheet.pdf



  * IDT TSE2002B3, TSE2002GB2, TSE2004GB2, TS3000B3, TS3000GB0, TS3000GB2,



	TS3001GB2



    Datasheets:



	Available from IDT web site



  * Maxim MAX6604



    Datasheets:



	http://datasheets.maxim-ic.com/en/ds/MAX6604.pdf



  * Microchip MCP9804, MCP9805, MCP9808, MCP98242, MCP98243, MCP98244, MCP9843



    Datasheets:



	http://ww1.microchip.com/downloads/en/DeviceDoc/22203C.pdf



	http://ww1.microchip.com/downloads/en/DeviceDoc/21977b.pdf



	http://ww1.microchip.com/downloads/en/DeviceDoc/25095A.pdf



	http://ww1.microchip.com/downloads/en/DeviceDoc/21996a.pdf



	http://ww1.microchip.com/downloads/en/DeviceDoc/22153c.pdf



	http://ww1.microchip.com/downloads/en/DeviceDoc/22327A.pdf



  * NXP Semiconductors SE97, SE97B, SE98, SE98A



    Datasheets:



	http://www.nxp.com/documents/data_sheet/SE97.pdf



	http://www.nxp.com/documents/data_sheet/SE97B.pdf



	http://www.nxp.com/documents/data_sheet/SE98.pdf



	http://www.nxp.com/documents/data_sheet/SE98A.pdf



  * ON Semiconductor CAT34TS02, CAT6095



    Datasheet:



	http://www.onsemi.com/pub_link/Collateral/CAT34TS02-D.PDF



	http://www.onsemi.com/pub/Collateral/CAT6095-D.PDF



  * ST Microelectronics STTS424, STTS424E02, STTS2002, STTS2004, STTS3000



    Datasheets:



	http://www.st.com/web/en/resource/technical/document/datasheet/CD00157556.pdf



	http://www.st.com/web/en/resource/technical/document/datasheet/CD00157558.pdf



	http://www.st.com/web/en/resource/technical/document/datasheet/CD00266638.pdf



	http://www.st.com/web/en/resource/technical/document/datasheet/CD00225278.pdf



	http://www.st.com/web/en/resource/technical/document/datasheet/DM00076709.pdf



  * JEDEC JC 42.4 compliant temperature sensor chips



    Datasheet:



	http://www.jedec.org/sites/default/files/docs/4_01_04R19.pdf





  Common for all chips:



    Prefix: 'jc42'



    Addresses scanned: I2C 0x18 - 0x1f



Author:
@@ -67,7 +114,7 @@ The driver auto-detects the chips listed above, but can be manually instantiated 
to support other JC 42.4 compliant chips.



Example: the following will load the driver for a generic JC 42.4 compliant

temperature sensor at address 0x18 on I2C bus #1:

temperature sensor at address 0x18 on I2C bus #1::



	# modprobe jc42

	# echo jc42 0x18 > /sys/bus/i2c/devices/i2c-1/new_device
@@ -90,6 +137,7 @@ cannot be changed. 
Sysfs entries

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



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

temp1_input		Temperature (RO)

temp1_min		Minimum temperature (RO or RW)

temp1_max		Maximum temperature (RO or RW)
@@ -101,3 +149,4 @@ temp1_max_hyst Maximum hysteresis temperature (RO) 
temp1_min_alarm		Temperature low alarm

temp1_max_alarm		Temperature high alarm

temp1_crit_alarm	Temperature critical alarm

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

Documentation/hwmon/lm95234

+9 −2
Original line number Diff line number Diff line
@@ -2,15 +2,22 @@ Kernel driver lm95234 
=====================



Supported chips:



  * National Semiconductor / Texas Instruments LM95233



    Addresses scanned: I2C 0x18, 0x2a, 0x2b



    Datasheet: Publicly available at the Texas Instruments website



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



  * National Semiconductor / Texas Instruments LM95234



    Addresses scanned: I2C 0x18, 0x4d, 0x4e



    Datasheet: Publicly available at the Texas Instruments website

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



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



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

Documentation/hwmon/ltc4261

+12 −4
Original line number Diff line number Diff line
@@ -2,10 +2,15 @@ Kernel driver ltc4261 
=====================



Supported chips:



  * Linear Technology LTC4261



    Prefix: 'ltc4261'



    Addresses scanned: -



    Datasheet:



	http://cds.linear.com/docs/Datasheet/42612fb.pdf



Author: Guenter Roeck <linux@roeck-us.net>
@@ -26,7 +31,8 @@ which can be safely used to identify the chip. You will have to instantiate 
the devices explicitly.



Example: the following will load the driver for an LTC4261 at address 0x10

on I2C bus #1:

on I2C bus #1::



	$ modprobe ltc4261

	$ echo ltc4261 0x10 > /sys/bus/i2c/devices/i2c-1/new_device
@@ -51,6 +57,7 @@ the proximity of the ADIN2 pin to the OV pin. ADIN2 is, however, not available 
on all chip variants. To ensure that the alarm condition is reported to the user,

report it with both voltage sensors.



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

in1_input		ADIN2 voltage (mV)

in1_min_alarm		ADIN/ADIN2 Undervoltage alarm

in1_max_alarm		ADIN/ADIN2 Overvoltage alarm
@@ -61,3 +68,4 @@ in2_max_alarm ADIN/ADIN2 Overvoltage alarm 


curr1_input		SENSE current (mA)

curr1_alarm		SENSE overcurrent alarm

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