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

docs: hwmon: w83791d: convert to ReST format 



Convert w83791d to ReST format, in order to allow it 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 b413e3fa

Documentation/hwmon/w83791d

+71 −52
Original line number Diff line number Diff line
@@ -2,9 +2,13 @@ Kernel driver w83791d 
=====================



Supported chips:



  * Winbond W83791D



    Prefix: 'w83791d'



    Addresses scanned: I2C 0x2c - 0x2f



    Datasheet: http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83791D_W83791Gb.pdf



Author: Charles Spirakis <bezaur@gmail.com>
@@ -12,23 +16,29 @@ Author: Charles Spirakis <bezaur@gmail.com> 
This driver was derived from the w83781d.c and w83792d.c source files.



Credits:



  w83781d.c:

    Frodo Looijaard <frodol@dds.nl>,

    Philip Edelbrock <phil@netroedge.com>,

    and Mark Studebaker <mdsxyz123@yahoo.com>



    - Frodo Looijaard <frodol@dds.nl>,

    - Philip Edelbrock <phil@netroedge.com>,

    - Mark Studebaker <mdsxyz123@yahoo.com>



  w83792d.c:

    Shane Huang (Winbond),

    Rudolf Marek <r.marek@assembler.cz>



    - Shane Huang (Winbond),

    - Rudolf Marek <r.marek@assembler.cz>



Additional contributors:

    Sven Anders <anders@anduras.de>

    Marc Hulsman <m.hulsman@tudelft.nl>



    - Sven Anders <anders@anduras.de>

    - Marc Hulsman <m.hulsman@tudelft.nl>



Module Parameters

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



* init boolean

    (default 0)



    Use 'init=1' to have the driver do extra software initializations.

    The default behavior is to do the minimum initialization possible

    and depend on the BIOS to properly setup the chip. If you know you
@@ -37,12 +47,13 @@ Module Parameters 


* reset boolean

    (default 0)



    Use 'reset=1' to reset the chip (via index 0x40, bit 7). The default

    behavior is no chip reset to preserve BIOS settings.



* force_subclients=bus,caddr,saddr,saddr

    This is used to force the i2c addresses for subclients of

  a certain chip. Example usage is `force_subclients=0,0x2f,0x4a,0x4b'

    a certain chip. Example usage is `force_subclients=0,0x2f,0x4a,0x4b`

    to force the subclients of chip 0x2f on bus 0 to i2c addresses

    0x4a and 0x4b.
@@ -91,11 +102,11 @@ This file is used for both legacy and new code. 


The sysfs interface to the beep bitmask has migrated from the original legacy

method of a single sysfs beep_mask file to a newer method using multiple

*_beep files as described in .../Documentation/hwmon/sysfs-interface.

`*_beep` files as described in `Documentation/hwmon/sysfs-interface`.



A similar change has occurred for the bitmap corresponding to the alarms. The

original legacy method used a single sysfs alarms file containing a bitmap

of triggered alarms. The newer method uses multiple sysfs *_alarm files

of triggered alarms. The newer method uses multiple sysfs `*_alarm` files

(again following the pattern described in sysfs-interface).



Since both methods read and write the underlying hardware, they can be used
@@ -116,46 +127,54 @@ User mode code requesting values more often will receive cached values. 
The sysfs-interface is documented in the 'sysfs-interface' file. Only

chip-specific options are documented here.



pwm[1-3]_enable -	this file controls mode of fan/temperature control for

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

pwm[1-3]_enable		this file controls mode of fan/temperature control for

			fan 1-3. Fan/PWM 4-5 only support manual mode.



			    * 1 Manual mode

			    * 2 Thermal Cruise mode

			    * 3 Fan Speed Cruise mode (no further support)



temp[1-3]_target -	defines the target temperature for Thermal Cruise mode.

temp[1-3]_target	defines the target temperature for Thermal Cruise mode.

			Unit: millidegree Celsius

			RW



temp[1-3]_tolerance -	temperature tolerance for Thermal Cruise mode.

temp[1-3]_tolerance	temperature tolerance for Thermal Cruise mode.

			Specifies an interval around the target temperature

			in which the fan speed is not changed.

			Unit: millidegree Celsius

			RW

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



Alarms bitmap vs. beep_mask bitmask

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

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



For legacy code using the alarms and beep_mask files:



in0 (VCORE)  :  alarms: 0x000001 beep_mask: 0x000001

in1 (VINR0)  :  alarms: 0x000002 beep_mask: 0x002000 <== mismatch

in2 (+3.3VIN):  alarms: 0x000004 beep_mask: 0x000004

in3 (5VDD)   :  alarms: 0x000008 beep_mask: 0x000008

in4 (+12VIN) :  alarms: 0x000100 beep_mask: 0x000100

in5 (-12VIN) :  alarms: 0x000200 beep_mask: 0x000200

in6 (-5VIN)  :  alarms: 0x000400 beep_mask: 0x000400

in7 (VSB)    :  alarms: 0x080000 beep_mask: 0x010000 <== mismatch

in8 (VBAT)   :  alarms: 0x100000 beep_mask: 0x020000 <== mismatch

in9 (VINR1)  :  alarms: 0x004000 beep_mask: 0x004000

temp1        :  alarms: 0x000010 beep_mask: 0x000010

temp2        :  alarms: 0x000020 beep_mask: 0x000020

temp3        :  alarms: 0x002000 beep_mask: 0x000002 <== mismatch

fan1         :  alarms: 0x000040 beep_mask: 0x000040

fan2         :  alarms: 0x000080 beep_mask: 0x000080

fan3         :  alarms: 0x000800 beep_mask: 0x000800

fan4         :  alarms: 0x200000 beep_mask: 0x200000

fan5         :  alarms: 0x400000 beep_mask: 0x400000

tart1        :  alarms: 0x010000 beep_mask: 0x040000 <== mismatch

tart2        :  alarms: 0x020000 beep_mask: 0x080000 <== mismatch

tart3        :  alarms: 0x040000 beep_mask: 0x100000 <== mismatch

case_open    :  alarms: 0x001000 beep_mask: 0x001000

global_enable:  alarms: -------- beep_mask: 0x800000 (modified via beep_enable)
 
=============  ========  ========= ==========================

Signal         Alarms    beep_mask Obs

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

in0 (VCORE)    0x000001  0x000001

in1 (VINR0)    0x000002  0x002000  <== mismatch

in2 (+3.3VIN)  0x000004  0x000004

in3 (5VDD)     0x000008  0x000008

in4 (+12VIN)   0x000100  0x000100

in5 (-12VIN)   0x000200  0x000200

in6 (-5VIN)    0x000400  0x000400

in7 (VSB)      0x080000  0x010000  <== mismatch

in8 (VBAT)     0x100000  0x020000  <== mismatch

in9 (VINR1)    0x004000  0x004000

temp1          0x000010  0x000010

temp2          0x000020  0x000020

temp3          0x002000  0x000002  <== mismatch

fan1           0x000040  0x000040

fan2           0x000080  0x000080

fan3           0x000800  0x000800

fan4           0x200000  0x200000

fan5           0x400000  0x400000

tart1          0x010000  0x040000  <== mismatch

tart2          0x020000  0x080000  <== mismatch

tart3          0x040000  0x100000  <== mismatch

case_open      0x001000  0x001000

global_enable  -         0x800000  (modified via beep_enable)

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