Commit 270efaa4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Guenter Roeck

docs: hwmon: coretemp: convert to ReST format

Convert coretemp 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 ce09cfb6
...@@ -3,20 +3,29 @@ Kernel driver coretemp ...@@ -3,20 +3,29 @@ Kernel driver coretemp
Supported chips: Supported chips:
* All Intel Core family * All Intel Core family
Prefix: 'coretemp' Prefix: 'coretemp'
CPUID: family 0x6, models 0xe (Pentium M DC), 0xf (Core 2 DC 65nm),
0x16 (Core 2 SC 65nm), 0x17 (Penryn 45nm), CPUID: family 0x6, models
0x1a (Nehalem), 0x1c (Atom), 0x1e (Lynnfield),
0x26 (Tunnel Creek Atom), 0x27 (Medfield Atom), - 0xe (Pentium M DC), 0xf (Core 2 DC 65nm),
0x36 (Cedar Trail Atom) - 0x16 (Core 2 SC 65nm), 0x17 (Penryn 45nm),
Datasheet: Intel 64 and IA-32 Architectures Software Developer's Manual - 0x1a (Nehalem), 0x1c (Atom), 0x1e (Lynnfield),
- 0x26 (Tunnel Creek Atom), 0x27 (Medfield Atom),
- 0x36 (Cedar Trail Atom)
Datasheet:
Intel 64 and IA-32 Architectures Software Developer's Manual
Volume 3A: System Programming Guide Volume 3A: System Programming Guide
http://softwarecommunity.intel.com/Wiki/Mobility/720.htm http://softwarecommunity.intel.com/Wiki/Mobility/720.htm
Author: Rudolf Marek Author: Rudolf Marek
Description Description
----------- -----------
This driver permits reading the DTS (Digital Temperature Sensor) embedded This driver permits reading the DTS (Digital Temperature Sensor) embedded
inside Intel CPUs. This driver can read both the per-core and per-package inside Intel CPUs. This driver can read both the per-core and per-package
temperature using the appropriate sensors. The per-package sensor is new; temperature using the appropriate sensors. The per-package sensor is new;
...@@ -35,14 +44,17 @@ may be raised, if the temperature grows enough (more than TjMax) to trigger ...@@ -35,14 +44,17 @@ may be raised, if the temperature grows enough (more than TjMax) to trigger
the Out-Of-Spec bit. Following table summarizes the exported sysfs files: the Out-Of-Spec bit. Following table summarizes the exported sysfs files:
All Sysfs entries are named with their core_id (represented here by 'X'). All Sysfs entries are named with their core_id (represented here by 'X').
tempX_input - Core temperature (in millidegrees Celsius).
tempX_max - All cooling devices should be turned on (on Core2). ================= ========================================================
tempX_crit - Maximum junction temperature (in millidegrees Celsius). tempX_input Core temperature (in millidegrees Celsius).
tempX_crit_alarm - Set when Out-of-spec bit is set, never clears. tempX_max All cooling devices should be turned on (on Core2).
tempX_crit Maximum junction temperature (in millidegrees Celsius).
tempX_crit_alarm Set when Out-of-spec bit is set, never clears.
Correct CPU operation is no longer guaranteed. Correct CPU operation is no longer guaranteed.
tempX_label - Contains string "Core X", where X is processor tempX_label Contains string "Core X", where X is processor
number. For Package temp, this will be "Physical id Y", number. For Package temp, this will be "Physical id Y",
where Y is the package number. where Y is the package number.
================= ========================================================
On CPU models which support it, TjMax is read from a model-specific register. On CPU models which support it, TjMax is read from a model-specific register.
On other models, it is set to an arbitrary value based on weak heuristics. On other models, it is set to an arbitrary value based on weak heuristics.
...@@ -52,6 +64,7 @@ as a module parameter (tjmax). ...@@ -52,6 +64,7 @@ as a module parameter (tjmax).
Appendix A. Known TjMax lists (TBD): Appendix A. Known TjMax lists (TBD):
Some information comes from ark.intel.com Some information comes from ark.intel.com
=============== =============================================== ================
Process Processor TjMax(C) Process Processor TjMax(C)
22nm Core i5/i7 Processors 22nm Core i5/i7 Processors
...@@ -179,3 +192,4 @@ Process Processor TjMax(C) ...@@ -179,3 +192,4 @@ Process Processor TjMax(C)
65nm Celeron Processors 65nm Celeron Processors
T1700/1600 100 T1700/1600 100
560/550/540/530 100 560/550/540/530 100
=============== =============================================== ================
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment