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

docs: hwmon: convert remaining files to ReST format 



Convert all other hwmon 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 b32570a4

Documentation/hwmon/ab8500

+6 −2
Original line number Diff line number Diff line
@@ -2,14 +2,18 @@ Kernel driver ab8500 
====================



Supported chips:



  * ST-Ericsson AB8500



    Prefix: 'ab8500'



    Addresses scanned: -



    Datasheet: http://www.stericsson.com/developers/documentation.jsp



Authors:

        Martin Persson <martin.persson@stericsson.com>

        Hongbo Zhang <hongbo.zhang@linaro.org>

	- Martin Persson <martin.persson@stericsson.com>

	- Hongbo Zhang <hongbo.zhang@linaro.org>



Description

-----------

Documentation/hwmon/abituguru

+59 −38
Original line number Diff line number Diff line
@@ -2,27 +2,34 @@ Kernel driver abituguru 
=======================



Supported chips:



  * Abit uGuru revision 1 & 2 (Hardware Monitor part only)



    Prefix: 'abituguru'



    Addresses scanned: ISA 0x0E0



    Datasheet: Not available, this driver is based on reverse engineering.

    A "Datasheet" has been written based on the reverse engineering it

    should be available in the same dir as this file under the name

    abituguru-datasheet.



    Note:

	The uGuru is a microcontroller with onboard firmware which programs

	it to behave as a hwmon IC. There are many different revisions of the

	firmware and thus effectivly many different revisions of the uGuru.

	Below is an incomplete list with which revisions are used for which

	Motherboards:

	uGuru 1.00    ~ 1.24    (AI7, KV8-MAX3, AN7) (1)

	uGuru 2.0.0.0 ~ 2.0.4.2 (KV8-PRO)

	uGuru 2.1.0.0 ~ 2.1.2.8 (AS8, AV8, AA8, AG8, AA8XE, AX8)

	uGuru 2.2.0.0 ~ 2.2.0.6 (AA8 Fatal1ty)

	uGuru 2.3.0.0 ~ 2.3.0.9 (AN8)

	uGuru 3.0.0.0 ~ 3.0.x.x (AW8, AL8, AT8, NI8 SLI, AT8 32X, AN8 32X,

				 AW9D-MAX) (2)

	1) For revisions 2 and 3 uGuru's the driver can autodetect the



	- uGuru 1.00    ~ 1.24    (AI7, KV8-MAX3, AN7) [1]_

	- uGuru 2.0.0.0 ~ 2.0.4.2 (KV8-PRO)

	- uGuru 2.1.0.0 ~ 2.1.2.8 (AS8, AV8, AA8, AG8, AA8XE, AX8)

	- uGuru 2.2.0.0 ~ 2.2.0.6 (AA8 Fatal1ty)

	- uGuru 2.3.0.0 ~ 2.3.0.9 (AN8)

	- uGuru 3.0.0.0 ~ 3.0.x.x (AW8, AL8, AT8, NI8 SLI, AT8 32X, AN8 32X,

	  AW9D-MAX) [2]_



.. [1]  For revisions 2 and 3 uGuru's the driver can autodetect the

	sensortype (Volt or Temp) for bank1 sensors, for revision 1 uGuru's

	this does not always work. For these uGuru's the autodetection can

	be overridden with the bank1_types module param. For all 3 known
@@ -30,41 +37,50 @@ Supported chips: 
	bank1_types=1,1,0,0,0,0,0,2,0,0,0,0,2,0,0,1

	You may also need to specify the fan_sensors option for these boards

	fan_sensors=5

	2) There is a separate abituguru3 driver for these motherboards,



.. [2]  There is a separate abituguru3 driver for these motherboards,

	the abituguru (without the 3 !) driver will not work on these

	motherboards (and visa versa)!



Authors:

	Hans de Goede <j.w.r.degoede@hhs.nl>,

	(Initial reverse engineering done by Olle Sandberg

	- Hans de Goede <j.w.r.degoede@hhs.nl>,

	- (Initial reverse engineering done by Olle Sandberg

	  <ollebull@gmail.com>)





Module Parameters

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



* force: bool		Force detection. Note this parameter only causes the

* force: bool

			Force detection. Note this parameter only causes the

			detection to be skipped, and thus the insmod to

			succeed. If the uGuru can't be read the actual hwmon

			driver will not load and thus no hwmon device will get

			registered.

* bank1_types: int[]	Bank1 sensortype autodetection override:

			  -1 autodetect (default)

			   0 volt sensor

			   1 temp sensor

			   2 not connected

* fan_sensors: int	Tell the driver how many fan speed sensors there are

* bank1_types: int[]

			Bank1 sensortype autodetection override:



			  * -1 autodetect (default)

			  *  0 volt sensor

			  *  1 temp sensor

			  *  2 not connected

* fan_sensors: int

			Tell the driver how many fan speed sensors there are

			on your motherboard. Default: 0 (autodetect).

* pwms: int		Tell the driver how many fan speed controls (fan

* pwms: int

			Tell the driver how many fan speed controls (fan

			pwms) your motherboard has. Default: 0 (autodetect).

* verbose: int		How verbose should the driver be? (0-3):

			   0 normal output

			   1 + verbose error reporting

			   2 + sensors type probing info (default)

			   3 + retryable error reporting

* verbose: int

			How verbose should the driver be? (0-3):



			   * 0 normal output

			   * 1 + verbose error reporting

			   * 2 + sensors type probing info (default)

			   * 3 + retryable error reporting



			Default: 2 (the driver is still in the testing phase)



Notice if you need any of the first three options above please insmod the

Notice: if you need any of the first three options above please insmod the

driver with verbose set to 3 and mail me <j.w.r.degoede@hhs.nl> the output of:

dmesg | grep abituguru
@@ -90,3 +106,8 @@ Known Issues 
------------



The voltage and frequency control parts of the Abit uGuru are not supported.



.. toctree::

   :maxdepth: 1



   abituguru-datasheet.rst

Documentation/hwmon/abituguru-datasheet

+92 −68
Original line number Diff line number Diff line 
===============

uGuru datasheet

===============
@@ -184,12 +185,13 @@ Bank 0x21 Sensor Bank1 Values / Readings (R) 
--------------------------------------------

This bank contains 16 sensors, for each sensor it contains 1 byte.

So far the following sensors are known to be available on all motherboards:

Sensor  0 CPU temp

Sensor  1 SYS temp

Sensor  3 CPU core volt

Sensor  4 DDR volt

Sensor 10 DDR Vtt volt

Sensor 15 PWM temp



- Sensor  0 CPU temp

- Sensor  1 SYS temp

- Sensor  3 CPU core volt

- Sensor  4 DDR volt

- Sensor 10 DDR Vtt volt

- Sensor 15 PWM temp



Byte 0:

  This byte holds the reading from the sensor. Sensors in Bank1 can be both
@@ -207,49 +209,65 @@ Temp sensors also use a linear scale, a reading of 0 corresponds with 0 degree 
Celsius and a reading of 255 with a reading of 255 degrees Celsius.





Bank 0x22 Sensor Bank1 Settings (R)

Bank 0x23 Sensor Bank1 Settings (W)

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

Bank 0x22 Sensor Bank1 Settings (R) and Bank 0x23 Sensor Bank1 Settings (W)

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



This bank contains 16 sensors, for each sensor it contains 3 bytes. Each

Those banks contain 16 sensors, for each sensor it contains 3 bytes. Each

set of 3 bytes contains the settings for the sensor with the same sensor

address in Bank 0x21 .



Byte 0:

Alarm behaviour for the selected sensor. A 1 enables the described behaviour.

Bit 0: Give an alarm if measured temp is over the warning threshold	(RW) *

Bit 1: Give an alarm if measured volt is over the max threshold		(RW) **

Bit 2: Give an alarm if measured volt is under the min threshold	(RW) **

Bit 3: Beep if alarm							(RW)

Bit 4: 1 if alarm cause measured temp is over the warning threshold	(R)

Bit 5: 1 if alarm cause measured volt is over the max threshold		(R)

Bit 6: 1 if alarm cause measured volt is under the min threshold	(R)

Bit 7: Volt sensor: Shutdown if alarm persist for more than 4 seconds	(RW)

       Temp sensor: Shutdown if temp is over the shutdown threshold	(RW)



*  This bit is only honored/used by the uGuru if a temp sensor is connected

** This bit is only honored/used by the uGuru if a volt sensor is connected

Note with some trickery this can be used to find out what kinda sensor is

detected see the Linux kernel driver for an example with many comments on

how todo this.

  Alarm behaviour for the selected sensor. A 1 enables the described

  behaviour.



Bit 0:

  Give an alarm if measured temp is over the warning threshold		(RW) [1]_



Bit 1:

  Give an alarm if measured volt is over the max threshold		(RW) [2]_



Bit 2:

  Give an alarm if measured volt is under the min threshold		(RW) [2]_



Bit 3:

  Beep if alarm								(RW)



Bit 4:

  1 if alarm cause measured temp is over the warning threshold		(R)



Bit 5:

  1 if alarm cause measured volt is over the max threshold		(R)



Bit 6:

  1 if alarm cause measured volt is under the min threshold		(R)



Bit 7:

  - Volt sensor: Shutdown if alarm persist for more than 4 seconds	(RW)

  - Temp sensor: Shutdown if temp is over the shutdown threshold	(RW)



.. [1] This bit is only honored/used by the uGuru if a temp sensor is connected



.. [2] This bit is only honored/used by the uGuru if a volt sensor is connected

       Note with some trickery this can be used to find out what kinda sensor

       is detected see the Linux kernel driver for an example with many

       comments on how todo this.



Byte 1:

Temp sensor: warning threshold  (scale as bank 0x21)

Volt sensor: min threshold      (scale as bank 0x21)

  - Temp sensor: warning threshold  (scale as bank 0x21)

  - Volt sensor: min threshold      (scale as bank 0x21)



Byte 2:

Temp sensor: shutdown threshold (scale as bank 0x21)

Volt sensor: max threshold      (scale as bank 0x21)

  - Temp sensor: shutdown threshold (scale as bank 0x21)

  - Volt sensor: max threshold      (scale as bank 0x21)





Bank 0x24 PWM outputs for FAN's (R)

Bank 0x25 PWM outputs for FAN's (W)

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

Bank 0x24 PWM outputs for FAN's (R) and Bank 0x25 PWM outputs for FAN's (W)

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



This bank contains 3 "sensors", for each sensor it contains 5 bytes.

Sensor 0 usually controls the CPU fan

Sensor 1 usually controls the NB (or chipset for single chip) fan

Sensor 2 usually controls the System fan

Those banks contain 3 "sensors", for each sensor it contains 5 bytes.

  - Sensor 0 usually controls the CPU fan

  - Sensor 1 usually controls the NB (or chipset for single chip) fan

  - Sensor 2 usually controls the System fan



Byte 0:

  Flag 0x80 to enable control, Fan runs at 100% when disabled.
@@ -274,26 +292,32 @@ Bank 0x26 Sensors Bank2 Values / Readings (R) 
---------------------------------------------



This bank contains 6 sensors (AFAIK), for each sensor it contains 1 byte.



So far the following sensors are known to be available on all motherboards:

Sensor 0: CPU fan speed

Sensor 1: NB (or chipset for single chip) fan speed

Sensor 2: SYS fan speed

  - Sensor 0: CPU fan speed

  - Sensor 1: NB (or chipset for single chip) fan speed

  - Sensor 2: SYS fan speed



Byte 0:

  This byte holds the reading from the sensor. 0-255 = 0-15300 (linear)





Bank 0x27 Sensors Bank2 Settings (R)

Bank 0x28 Sensors Bank2 Settings (W)

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

Bank 0x27 Sensors Bank2 Settings (R) and Bank 0x28 Sensors Bank2 Settings (W)

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



This bank contains 6 sensors (AFAIK), for each sensor it contains 2 bytes.

Those banks contain 6 sensors (AFAIK), for each sensor it contains 2 bytes.



Byte 0:

  Alarm behaviour for the selected sensor. A 1 enables the described behaviour.

Bit 0: Give an alarm if measured rpm is under the min threshold	(RW)

Bit 3: Beep if alarm						(RW)

Bit 7: Shutdown if alarm persist for more than 4 seconds	(RW)



Bit 0:

  Give an alarm if measured rpm is under the min threshold	(RW)



Bit 3:

  Beep if alarm							(RW)



Bit 7:

  Shutdown if alarm persist for more than 4 seconds		(RW)



Byte 1:

  min threshold (scale as bank 0x26)

Documentation/hwmon/abituguru3

+23 −13
Original line number Diff line number Diff line
@@ -3,41 +3,51 @@ Kernel driver abituguru3 


Supported chips:

  * Abit uGuru revision 3 (Hardware Monitor part, reading only)



    Prefix: 'abituguru3'



    Addresses scanned: ISA 0x0E0



    Datasheet: Not available, this driver is based on reverse engineering.



    Note:

	The uGuru is a microcontroller with onboard firmware which programs

	it to behave as a hwmon IC. There are many different revisions of the

	firmware and thus effectivly many different revisions of the uGuru.

	Below is an incomplete list with which revisions are used for which

	Motherboards:

	uGuru 1.00    ~ 1.24    (AI7, KV8-MAX3, AN7)

	uGuru 2.0.0.0 ~ 2.0.4.2 (KV8-PRO)

	uGuru 2.1.0.0 ~ 2.1.2.8 (AS8, AV8, AA8, AG8, AA8XE, AX8)

	uGuru 2.3.0.0 ~ 2.3.0.9 (AN8)

	uGuru 3.0.0.0 ~ 3.0.x.x (AW8, AL8, AT8, NI8 SLI, AT8 32X, AN8 32X,



	- uGuru 1.00    ~ 1.24    (AI7, KV8-MAX3, AN7)

	- uGuru 2.0.0.0 ~ 2.0.4.2 (KV8-PRO)

	- uGuru 2.1.0.0 ~ 2.1.2.8 (AS8, AV8, AA8, AG8, AA8XE, AX8)

	- uGuru 2.3.0.0 ~ 2.3.0.9 (AN8)

	- uGuru 3.0.0.0 ~ 3.0.x.x (AW8, AL8, AT8, NI8 SLI, AT8 32X, AN8 32X,

	  AW9D-MAX)



	The abituguru3 driver is only for revison 3.0.x.x motherboards,

	this driver will not work on older motherboards. For older

	motherboards use the abituguru (without the 3 !) driver.



Authors:

	Hans de Goede <j.w.r.degoede@hhs.nl>,

	(Initial reverse engineering done by Louis Kruger)

	- Hans de Goede <j.w.r.degoede@hhs.nl>,

	- (Initial reverse engineering done by Louis Kruger)





Module Parameters

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



* force: bool		Force detection. Note this parameter only causes the

* force: bool

			Force detection. Note this parameter only causes the

			detection to be skipped, and thus the insmod to

			succeed. If the uGuru can't be read the actual hwmon

			driver will not load and thus no hwmon device will get

			registered.

* verbose: bool		Should the driver be verbose?

			0/off/false  normal output

			1/on/true    + verbose error reporting (default)

* verbose: bool

			Should the driver be verbose?



			* 0/off/false  normal output

			* 1/on/true    + verbose error reporting (default)



			Default: 1 (the driver is still in the testing phase)



Description
@@ -62,4 +72,4 @@ neither is writing any of the sensor settings and writing / reading the 
fanspeed control registers (FanEQ)



If you encounter any problems please mail me <j.w.r.degoede@hhs.nl> and

include the output of: "dmesg | grep abituguru"
 
include the output of: `dmesg | grep abituguru`

Documentation/hwmon/abx500

+6 −2
Original line number Diff line number Diff line
@@ -2,9 +2,13 @@ Kernel driver abx500 
====================



Supported chips:



  * ST-Ericsson ABx500 series



    Prefix: 'abx500'



    Addresses scanned: -



    Datasheet: http://www.stericsson.com/developers/documentation.jsp



Authors: