hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: hwmon: k8temp, w83793: convert to ReST format 

Convert k8temp and w83793 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>
This commit is contained in:
Mauro Carvalho Chehab 2019-04-17 06:46:25 -03:00 committed by Guenter Roeck
parent 08fae079ea
commit 0d9256262f
2 changed files with 77 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/hwmon/k8temp
View File

@ -2,12 +2,17 @@ Kernel driver k8temp
==================== ====================
Supported chips: Supported chips:
* AMD Athlon64/FX or Opteron CPUs * AMD Athlon64/FX or Opteron CPUs
Prefix: 'k8temp' Prefix: 'k8temp'
Addresses scanned: PCI space Addresses scanned: PCI space
Datasheet: http://support.amd.com/us/Processor_TechDocs/32559.pdf Datasheet: http://support.amd.com/us/Processor_TechDocs/32559.pdf
Author: Rudolf Marek Author: Rudolf Marek
Contact: Rudolf Marek <r.marek@assembler.cz> Contact: Rudolf Marek <r.marek@assembler.cz>
Description Description
@ -27,10 +32,12 @@ implemented sensors.
Mapping of /sys files is as follows: Mapping of /sys files is as follows:
temp1_input - temperature of Core 0 and "place" 0 ============= ===================================
temp2_input - temperature of Core 0 and "place" 1 temp1_input temperature of Core 0 and "place" 0
temp3_input - temperature of Core 1 and "place" 0 temp2_input temperature of Core 0 and "place" 1
temp4_input - temperature of Core 1 and "place" 1 temp3_input temperature of Core 1 and "place" 0
temp4_input temperature of Core 1 and "place" 1
============= ===================================
Temperatures are measured in degrees Celsius and measurement resolution is Temperatures are measured in degrees Celsius and measurement resolution is
1 degree C. It is expected that future CPU will have better resolution. The 1 degree C. It is expected that future CPU will have better resolution. The
@ -48,7 +55,7 @@ computed temperature called TControl, which must be lower than TControlMax.
The relationship is following: The relationship is following:
temp1_input - TjOffset*2 < TControlMax, temp1_input - TjOffset*2 < TControlMax,
TjOffset is not yet exported by the driver, TControlMax is usually TjOffset is not yet exported by the driver, TControlMax is usually
70 degrees C. The rule of the thumb -> CPU temperature should not cross 70 degrees C. The rule of the thumb -> CPU temperature should not cross

13
Documentation/hwmon/w83793
View File

@ -2,14 +2,18 @@ Kernel driver w83793
==================== ====================
Supported chips: Supported chips:
* Winbond W83793G/W83793R * Winbond W83793G/W83793R
Prefix: 'w83793' Prefix: 'w83793'
Addresses scanned: I2C 0x2c - 0x2f Addresses scanned: I2C 0x2c - 0x2f
Datasheet: Still not published Datasheet: Still not published
Authors: Authors:
Yuan Mu (Winbond Electronics) - Yuan Mu (Winbond Electronics)
Rudolf Marek <r.marek@assembler.cz> - Rudolf Marek <r.marek@assembler.cz>
Module parameters Module parameters
@ -17,12 +21,13 @@ Module parameters
* reset int * reset int
(default 0) (default 0)
This parameter is not recommended, it will lose motherboard specific This parameter is not recommended, it will lose motherboard specific
settings. Use 'reset=1' to reset the chip when loading this module. settings. Use 'reset=1' to reset the chip when loading this module.
* force_subclients=bus,caddr,saddr1,saddr2 * force_subclients=bus,caddr,saddr1,saddr2
This is used to force the i2c addresses for subclients of This is used to force the i2c addresses for subclients of
a certain chip. Typical usage is `force_subclients=0,0x2f,0x4a,0x4b' a certain chip. Typical usage is `force_subclients=0,0x2f,0x4a,0x4b`
to force the subclients of chip 0x2f on bus 0 to i2c addresses to force the subclients of chip 0x2f on bus 0 to i2c addresses
0x4a and 0x4b. 0x4a and 0x4b.
@ -47,10 +52,12 @@ This driver implements support for Winbond W83793G/W83793R chips.
* Temperature sensor types * Temperature sensor types
Temp1-4 have 2 possible types. It can be read from (and written to) Temp1-4 have 2 possible types. It can be read from (and written to)
temp[1-4]_type. temp[1-4]_type.
- If the value is 3, it starts monitoring using a remote termal diode - If the value is 3, it starts monitoring using a remote termal diode
(default). (default).
- If the value is 6, it starts monitoring using the temperature sensor - If the value is 6, it starts monitoring using the temperature sensor
in Intel CPU and get result by PECI. in Intel CPU and get result by PECI.
Temp5-6 can be connected to external thermistors (value of Temp5-6 can be connected to external thermistors (value of
temp[5-6]_type is 4). temp[5-6]_type is 4).