From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
linux-hwmon@vger.kernel.org
Subject: [PATCH v2 17/21] docs: hwmon: k8temp, w83793: convert to ReST format
Date: Wed, 10 Apr 2019 16:22:54 -0300 [thread overview]
Message-ID: <8657404c1bc52e957402b30f271ef5f857bf1cf0.1554923967.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1554923967.git.mchehab+samsung@kernel.org>
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>
---
Documentation/hwmon/k8temp | 17 +++--
Documentation/hwmon/w83793 | 123 ++++++++++++++++++++-----------------
2 files changed, 77 insertions(+), 63 deletions(-)
diff --git a/Documentation/hwmon/k8temp b/Documentation/hwmon/k8temp
index 716dc24c7237..72da12aa17e5 100644
--- a/Documentation/hwmon/k8temp
+++ b/Documentation/hwmon/k8temp
@@ -2,12 +2,17 @@ Kernel driver k8temp
====================
Supported chips:
+
* AMD Athlon64/FX or Opteron CPUs
+
Prefix: 'k8temp'
+
Addresses scanned: PCI space
+
Datasheet: http://support.amd.com/us/Processor_TechDocs/32559.pdf
Author: Rudolf Marek
+
Contact: Rudolf Marek <r.marek@assembler.cz>
Description
@@ -27,10 +32,12 @@ implemented sensors.
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
-temp3_input - temperature of Core 1 and "place" 0
-temp4_input - temperature of Core 1 and "place" 1
+============= ===================================
+temp1_input temperature of Core 0 and "place" 0
+temp2_input temperature of Core 0 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
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:
-temp1_input - TjOffset*2 < TControlMax,
+ temp1_input - TjOffset*2 < TControlMax,
TjOffset is not yet exported by the driver, TControlMax is usually
70 degrees C. The rule of the thumb -> CPU temperature should not cross
diff --git a/Documentation/hwmon/w83793 b/Documentation/hwmon/w83793
index 6cc5f639b721..83bb40c48645 100644
--- a/Documentation/hwmon/w83793
+++ b/Documentation/hwmon/w83793
@@ -2,29 +2,34 @@ Kernel driver w83793
====================
Supported chips:
+
* Winbond W83793G/W83793R
+
Prefix: 'w83793'
+
Addresses scanned: I2C 0x2c - 0x2f
+
Datasheet: Still not published
Authors:
- Yuan Mu (Winbond Electronics)
- Rudolf Marek <r.marek@assembler.cz>
+ - Yuan Mu (Winbond Electronics)
+ - Rudolf Marek <r.marek@assembler.cz>
Module parameters
-----------------
* reset int
- (default 0)
- This parameter is not recommended, it will lose motherboard specific
- settings. Use 'reset=1' to reset the chip when loading this module.
+ (default 0)
+
+ This parameter is not recommended, it will lose motherboard specific
+ settings. Use 'reset=1' to reset the chip when loading this module.
* force_subclients=bus,caddr,saddr1,saddr2
- This is used to force the i2c addresses for subclients of
- 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
- 0x4a and 0x4b.
+ This is used to force the i2c addresses for subclients of
+ 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
+ 0x4a and 0x4b.
Description
@@ -33,70 +38,72 @@ Description
This driver implements support for Winbond W83793G/W83793R chips.
* Exported features
- This driver exports 10 voltage sensors, up to 12 fan tachometer inputs,
- 6 remote temperatures, up to 8 sets of PWM fan controls, SmartFan
- (automatic fan speed control) on all temperature/PWM combinations, 2
- sets of 6-pin CPU VID input.
+ This driver exports 10 voltage sensors, up to 12 fan tachometer inputs,
+ 6 remote temperatures, up to 8 sets of PWM fan controls, SmartFan
+ (automatic fan speed control) on all temperature/PWM combinations, 2
+ sets of 6-pin CPU VID input.
* Sensor resolutions
- If your motherboard maker used the reference design, the resolution of
- voltage0-2 is 2mV, resolution of voltage3/4/5 is 16mV, 8mV for voltage6,
- 24mV for voltage7/8. Temp1-4 have a 0.25 degree Celsius resolution,
- temp5-6 have a 1 degree Celsiis resolution.
+ If your motherboard maker used the reference design, the resolution of
+ voltage0-2 is 2mV, resolution of voltage3/4/5 is 16mV, 8mV for voltage6,
+ 24mV for voltage7/8. Temp1-4 have a 0.25 degree Celsius resolution,
+ temp5-6 have a 1 degree Celsiis resolution.
* Temperature sensor types
- Temp1-4 have 2 possible types. It can be read from (and written to)
- temp[1-4]_type.
- - If the value is 3, it starts monitoring using a remote termal diode
- (default).
- - If the value is 6, it starts monitoring using the temperature sensor
- in Intel CPU and get result by PECI.
- Temp5-6 can be connected to external thermistors (value of
- temp[5-6]_type is 4).
+ Temp1-4 have 2 possible types. It can be read from (and written to)
+ temp[1-4]_type.
+
+ - If the value is 3, it starts monitoring using a remote termal diode
+ (default).
+ - If the value is 6, it starts monitoring using the temperature sensor
+ in Intel CPU and get result by PECI.
+
+ Temp5-6 can be connected to external thermistors (value of
+ temp[5-6]_type is 4).
* Alarm mechanism
- For voltage sensors, an alarm triggers if the measured value is below
- the low voltage limit or over the high voltage limit.
- For temperature sensors, an alarm triggers if the measured value goes
- above the high temperature limit, and wears off only after the measured
- value drops below the hysteresis value.
- For fan sensors, an alarm triggers if the measured value is below the
- low speed limit.
+ For voltage sensors, an alarm triggers if the measured value is below
+ the low voltage limit or over the high voltage limit.
+ For temperature sensors, an alarm triggers if the measured value goes
+ above the high temperature limit, and wears off only after the measured
+ value drops below the hysteresis value.
+ For fan sensors, an alarm triggers if the measured value is below the
+ low speed limit.
* SmartFan/PWM control
- If you want to set a pwm fan to manual mode, you just need to make sure it
- is not controlled by any temp channel, for example, you want to set fan1
- to manual mode, you need to check the value of temp[1-6]_fan_map, make
- sure bit 0 is cleared in the 6 values. And then set the pwm1 value to
- control the fan.
+ If you want to set a pwm fan to manual mode, you just need to make sure it
+ is not controlled by any temp channel, for example, you want to set fan1
+ to manual mode, you need to check the value of temp[1-6]_fan_map, make
+ sure bit 0 is cleared in the 6 values. And then set the pwm1 value to
+ control the fan.
- Each temperature channel can control all the 8 PWM outputs (by setting the
- corresponding bit in tempX_fan_map), you can set the temperature channel
- mode using temp[1-6]_pwm_enable, 2 is Thermal Cruise mode and 3
- is the SmartFanII mode. Temperature channels will try to speed up or
- slow down all controlled fans, this means one fan can receive different
- PWM value requests from different temperature channels, but the chip
- will always pick the safest (max) PWM value for each fan.
+ Each temperature channel can control all the 8 PWM outputs (by setting the
+ corresponding bit in tempX_fan_map), you can set the temperature channel
+ mode using temp[1-6]_pwm_enable, 2 is Thermal Cruise mode and 3
+ is the SmartFanII mode. Temperature channels will try to speed up or
+ slow down all controlled fans, this means one fan can receive different
+ PWM value requests from different temperature channels, but the chip
+ will always pick the safest (max) PWM value for each fan.
- In Thermal Cruise mode, the chip attempts to keep the temperature at a
- predefined value, within a tolerance margin. So if tempX_input >
- thermal_cruiseX + toleranceX, the chip will increase the PWM value,
- if tempX_input < thermal_cruiseX - toleranceX, the chip will decrease
- the PWM value. If the temperature is within the tolerance range, the PWM
- value is left unchanged.
+ In Thermal Cruise mode, the chip attempts to keep the temperature at a
+ predefined value, within a tolerance margin. So if tempX_input >
+ thermal_cruiseX + toleranceX, the chip will increase the PWM value,
+ if tempX_input < thermal_cruiseX - toleranceX, the chip will decrease
+ the PWM value. If the temperature is within the tolerance range, the PWM
+ value is left unchanged.
- SmartFanII works differently, you have to define up to 7 PWM, temperature
- trip points, defining a PWM/temperature curve which the chip will follow.
- While not fundamentally different from the Thermal Cruise mode, the
- implementation is quite different, giving you a finer-grained control.
+ SmartFanII works differently, you have to define up to 7 PWM, temperature
+ trip points, defining a PWM/temperature curve which the chip will follow.
+ While not fundamentally different from the Thermal Cruise mode, the
+ implementation is quite different, giving you a finer-grained control.
* Chassis
- If the case open alarm triggers, it will stay in this state unless cleared
- by writing 0 to the sysfs file "intrusion0_alarm".
+ If the case open alarm triggers, it will stay in this state unless cleared
+ by writing 0 to the sysfs file "intrusion0_alarm".
* VID and VRM
- The VRM version is detected automatically, don't modify the it unless you
- *do* know the cpu VRM version and it's not properly detected.
+ The VRM version is detected automatically, don't modify the it unless you
+ *do* know the cpu VRM version and it's not properly detected.
Notes
--
2.20.1
next prev parent reply other threads:[~2019-04-10 19:25 UTC|newest]
Thread overview: 73+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-10 19:22 [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-11 13:05 ` Liviu Dudau
2019-04-10 19:22 ` [PATCH v2 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-11 0:27 ` Andrew Jeffery
2019-04-10 19:22 ` [PATCH v2 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-10 19:22 ` Mauro Carvalho Chehab [this message]
2019-04-10 19:22 ` [PATCH v2 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-11 13:07 ` Liviu Dudau
2019-04-11 18:43 ` [PATCH v2 00/21] Convert hwmon documentation to ReST Jonathan Corbet
2019-04-11 20:43 ` Mauro Carvalho Chehab
2019-04-11 21:07 ` Guenter Roeck
2019-04-11 23:54 ` Mauro Carvalho Chehab
2019-04-12 16:04 ` Jonathan Corbet
2019-04-12 16:12 ` Guenter Roeck
2019-04-13 0:25 ` Mauro Carvalho Chehab
2019-04-13 0:52 ` Guenter Roeck
2019-04-13 3:09 ` Guenter Roeck
2019-04-16 20:19 ` Jonathan Corbet
2019-04-16 20:31 ` Guenter Roeck
2019-04-17 1:58 ` Mauro Carvalho Chehab
2019-04-17 3:49 ` Guenter Roeck
2019-04-17 9:46 ` [PATCH v3 00/21]Convert " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-17 10:24 ` Liviu Dudau
2019-04-17 10:31 ` Mauro Carvalho Chehab
2019-04-17 11:29 ` Liviu Dudau
2019-04-17 9:46 ` [PATCH v3 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-17 9:46 ` [PATCH v3 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-17 11:31 ` Liviu Dudau
2019-04-17 16:47 ` Guenter Roeck
2019-04-17 16:54 ` Guenter Roeck
2019-04-17 17:13 ` Mauro Carvalho Chehab
2019-04-17 17:22 ` Mauro Carvalho Chehab
2019-04-17 17:43 ` Guenter Roeck
2019-04-17 17:47 ` Guenter Roeck
2019-04-18 9:44 ` Mauro Carvalho Chehab
2019-04-18 13:36 ` Guenter Roeck
2019-04-17 9:47 ` [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8657404c1bc52e957402b30f271ef5f857bf1cf0.1554923967.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mchehab@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).