summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-04-17 06:46:28 -0300
committerGuenter Roeck <linux@roeck-us.net>2019-04-17 10:36:05 -0700
commitb04f2f7d387b3160883c2a1f5e2285483a791e82 (patch)
treeb834fd1570d09542b32408c5b1a03d57db6f9dd5
parentb32570a4f0919569bcba13a5419ea97ca5c1d3cf (diff)
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: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
-rw-r--r--Documentation/hwmon/ab85008
-rw-r--r--Documentation/hwmon/abituguru97
-rw-r--r--Documentation/hwmon/abituguru-datasheet160
-rw-r--r--Documentation/hwmon/abituguru336
-rw-r--r--Documentation/hwmon/abx5008
-rw-r--r--Documentation/hwmon/acpi_power_meter23
-rw-r--r--Documentation/hwmon/ad73149
-rw-r--r--Documentation/hwmon/adc128d8187
-rw-r--r--Documentation/hwmon/adm102144
-rw-r--r--Documentation/hwmon/adm102513
-rw-r--r--Documentation/hwmon/adm102624
-rw-r--r--Documentation/hwmon/adm103116
-rw-r--r--Documentation/hwmon/adm924050
-rw-r--r--Documentation/hwmon/ads782829
-rw-r--r--Documentation/hwmon/adt741049
-rw-r--r--Documentation/hwmon/adt741120
-rw-r--r--Documentation/hwmon/adt746210
-rw-r--r--Documentation/hwmon/adt74708
-rw-r--r--Documentation/hwmon/adt747538
-rw-r--r--Documentation/hwmon/amc682119
-rw-r--r--Documentation/hwmon/asb10054
-rw-r--r--Documentation/hwmon/ds1621156
-rw-r--r--Documentation/hwmon/ds62012
-rw-r--r--Documentation/hwmon/emc140333
-rw-r--r--Documentation/hwmon/emc6w2015
-rw-r--r--Documentation/hwmon/f71805f36
-rw-r--r--Documentation/hwmon/f71882fg56
-rw-r--r--Documentation/hwmon/ftsteutates14
-rw-r--r--Documentation/hwmon/g760a4
-rw-r--r--Documentation/hwmon/g76249
-rw-r--r--Documentation/hwmon/gl518sm21
-rw-r--r--Documentation/hwmon/hih613014
-rw-r--r--Documentation/hwmon/hwmon-kernel-api.txt346
-rw-r--r--Documentation/hwmon/ibmaem10
-rw-r--r--Documentation/hwmon/ina322121
-rw-r--r--Documentation/hwmon/it87102
-rw-r--r--Documentation/hwmon/lineage-pem16
-rw-r--r--Documentation/hwmon/lm6324
-rw-r--r--Documentation/hwmon/lm7013
-rw-r--r--Documentation/hwmon/lm7316
-rw-r--r--Documentation/hwmon/lm7596
-rw-r--r--Documentation/hwmon/lm779
-rw-r--r--Documentation/hwmon/lm7820
-rw-r--r--Documentation/hwmon/lm8019
-rw-r--r--Documentation/hwmon/lm8316
-rw-r--r--Documentation/hwmon/lm8597
-rw-r--r--Documentation/hwmon/lm8723
-rw-r--r--Documentation/hwmon/lm90174
-rw-r--r--Documentation/hwmon/lm9217
-rw-r--r--Documentation/hwmon/lm93157
-rw-r--r--Documentation/hwmon/lm9524513
-rw-r--r--Documentation/hwmon/ltc294516
-rw-r--r--Documentation/hwmon/ltc299023
-rw-r--r--Documentation/hwmon/ltc415116
-rw-r--r--Documentation/hwmon/ltc421516
-rw-r--r--Documentation/hwmon/ltc424517
-rw-r--r--Documentation/hwmon/ltc426016
-rw-r--r--Documentation/hwmon/max161911
-rw-r--r--Documentation/hwmon/max166814
-rw-r--r--Documentation/hwmon/max19736
-rw-r--r--Documentation/hwmon/max3172212
-rw-r--r--Documentation/hwmon/max317906
-rw-r--r--Documentation/hwmon/max663916
-rw-r--r--Documentation/hwmon/max664210
-rw-r--r--Documentation/hwmon/max665016
-rw-r--r--Documentation/hwmon/mc13783-adc27
-rw-r--r--Documentation/hwmon/mcp302115
-rw-r--r--Documentation/hwmon/mlxreg-fan60
-rw-r--r--Documentation/hwmon/nct668311
-rw-r--r--Documentation/hwmon/nct780211
-rw-r--r--Documentation/hwmon/nct79049
-rw-r--r--Documentation/hwmon/npcm750-pwm-fan4
-rw-r--r--Documentation/hwmon/nsa32015
-rw-r--r--Documentation/hwmon/ntc_thermistor123
-rw-r--r--Documentation/hwmon/occ93
-rw-r--r--Documentation/hwmon/pc874274
-rw-r--r--Documentation/hwmon/pcf859152
-rw-r--r--Documentation/hwmon/powr122012
-rw-r--r--Documentation/hwmon/raspberrypi-hwmon3
-rw-r--r--Documentation/hwmon/sch56363
-rw-r--r--Documentation/hwmon/scpi-hwmon7
-rw-r--r--Documentation/hwmon/sht1528
-rw-r--r--Documentation/hwmon/sht2124
-rw-r--r--Documentation/hwmon/sht3x42
-rw-r--r--Documentation/hwmon/shtc119
-rw-r--r--Documentation/hwmon/sis559540
-rw-r--r--Documentation/hwmon/smsc47b397162
-rw-r--r--Documentation/hwmon/smsc47m143
-rw-r--r--Documentation/hwmon/smsc47m19297
-rw-r--r--Documentation/hwmon/submitting-patches15
-rw-r--r--Documentation/hwmon/sysfs-interface731
-rw-r--r--Documentation/hwmon/tc6549
-rw-r--r--Documentation/hwmon/tc743
-rw-r--r--Documentation/hwmon/thmc5038
-rw-r--r--Documentation/hwmon/tmp1025
-rw-r--r--Documentation/hwmon/tmp1035
-rw-r--r--Documentation/hwmon/tmp1085
-rw-r--r--Documentation/hwmon/tmp42126
-rw-r--r--Documentation/hwmon/twl4030-madc-hwmon8
-rw-r--r--Documentation/hwmon/userspace-tools3
-rw-r--r--Documentation/hwmon/via686a30
-rw-r--r--Documentation/hwmon/w83627ehf162
-rw-r--r--Documentation/hwmon/w83627hf65
-rw-r--r--Documentation/hwmon/w83773g12
-rw-r--r--Documentation/hwmon/w83781d330
-rw-r--r--Documentation/hwmon/w83792d112
-rw-r--r--Documentation/hwmon/w83795223
-rw-r--r--Documentation/hwmon/w83l785ts9
-rw-r--r--Documentation/hwmon/w83l786ng42
-rw-r--r--Documentation/hwmon/xgene-hwmon24
110 files changed, 3551 insertions, 1746 deletions
diff --git a/Documentation/hwmon/ab8500 b/Documentation/hwmon/ab8500
index cf169c8ef4e3..d87c61151239 100644
--- a/Documentation/hwmon/ab8500
+++ b/Documentation/hwmon/ab8500
@@ -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
-----------
diff --git a/Documentation/hwmon/abituguru b/Documentation/hwmon/abituguru
index 44013d23b3f0..d8243c827de9 100644
--- a/Documentation/hwmon/abituguru
+++ b/Documentation/hwmon/abituguru
@@ -2,69 +2,85 @@ 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.
+ 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
- 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
- revison 1 motherboards the correct use of this param is:
- 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,
- the abituguru (without the 3 !) driver will not work on these
- motherboards (and visa versa)!
+
+ - 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
+ revison 1 motherboards the correct use of this param is:
+ 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,
+ 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
- <ollebull@gmail.com>)
+ - 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
diff --git a/Documentation/hwmon/abituguru-datasheet b/Documentation/hwmon/abituguru-datasheet
index 86c0b1251c81..6d5253e2223b 100644
--- a/Documentation/hwmon/abituguru-datasheet
+++ b/Documentation/hwmon/abituguru-datasheet
@@ -1,3 +1,4 @@
+===============
uGuru datasheet
===============
@@ -168,34 +169,35 @@ This bank contains 0 sensors, iow the sensor address is ignored (but must be
written) just use 0. Bank 0x20 contains 3 bytes:
Byte 0:
-This byte holds the alarm flags for sensor 0-7 of Sensor Bank1, with bit 0
-corresponding to sensor 0, 1 to 1, etc.
+ This byte holds the alarm flags for sensor 0-7 of Sensor Bank1, with bit 0
+ corresponding to sensor 0, 1 to 1, etc.
Byte 1:
-This byte holds the alarm flags for sensor 8-15 of Sensor Bank1, with bit 0
-corresponding to sensor 8, 1 to 9, etc.
+ This byte holds the alarm flags for sensor 8-15 of Sensor Bank1, with bit 0
+ corresponding to sensor 8, 1 to 9, etc.
Byte 2:
-This byte holds the alarm flags for sensor 0-5 of Sensor Bank2, with bit 0
-corresponding to sensor 0, 1 to 1, etc.
+ This byte holds the alarm flags for sensor 0-5 of Sensor Bank2, with bit 0
+ corresponding to sensor 0, 1 to 1, etc.
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
-volt and temp sensors, this is motherboard specific. The uGuru however does
-seem to know (be programmed with) what kindoff sensor is attached see Sensor
-Bank1 Settings description.
+ This byte holds the reading from the sensor. Sensors in Bank1 can be both
+ volt and temp sensors, this is motherboard specific. The uGuru however does
+ seem to know (be programmed with) what kindoff sensor is attached see Sensor
+ Bank1 Settings description.
Volt sensors use a linear scale, a reading 0 corresponds with 0 volt and a
reading of 255 with 3494 mV. The sensors for higher voltages however are
@@ -207,96 +209,118 @@ 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)
+------------------------------------------------------------------------