Fix 1600X model, and don't report negative temperatures
[groeck-k10temp] / README
1 Kernel driver k10temp
2 =====================
3
4 Supported chips:
5 * AMD Family 10h processors:
6   Socket F: Quad-Core/Six-Core/Embedded Opteron (but see below)
7   Socket AM2+: Quad-Core Opteron, Phenom (II) X3/X4, Athlon X2 (but see below)
8   Socket AM3: Quad-Core Opteron, Athlon/Phenom II X2/X3/X4, Sempron II
9   Socket S1G3: Athlon II, Sempron, Turion II
10 * AMD Family 11h processors:
11   Socket S1G2: Athlon (X2), Sempron (X2), Turion X2 (Ultra)
12 * AMD Family 12h processors: "Llano" (E2/A4/A6/A8-Series)
13 * AMD Family 14h processors: "Brazos" (C/E/G/Z-Series)
14 * AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity", "Kaveri", "Carrizo"
15 * AMD Family 16h processors: "Kabini", "Mullins"
16 * AMD Family 17h processors: "Ryzen", "Threadripper"
17
18   Prefix: 'k10temp'
19   Addresses scanned: PCI space
20   Datasheets:
21   BIOS and Kernel Developer's Guide (BKDG) For AMD Family 10h Processors:
22     http://support.amd.com/us/Processor_TechDocs/31116.pdf
23   BIOS and Kernel Developer's Guide (BKDG) for AMD Family 11h Processors:
24     http://support.amd.com/us/Processor_TechDocs/41256.pdf
25   BIOS and Kernel Developer's Guide (BKDG) for AMD Family 12h Processors:
26     http://support.amd.com/us/Processor_TechDocs/41131.pdf
27   BIOS and Kernel Developer's Guide (BKDG) for AMD Family 14h Models 00h-0Fh Processors:
28     http://support.amd.com/us/Processor_TechDocs/43170.pdf
29   Revision Guide for AMD Family 10h Processors:
30     http://support.amd.com/us/Processor_TechDocs/41322.pdf
31   Revision Guide for AMD Family 11h Processors:
32     http://support.amd.com/us/Processor_TechDocs/41788.pdf
33   Revision Guide for AMD Family 12h Processors:
34     http://support.amd.com/us/Processor_TechDocs/44739.pdf
35   Revision Guide for AMD Family 14h Models 00h-0Fh Processors:
36     http://support.amd.com/us/Processor_TechDocs/47534.pdf
37   AMD Family 11h Processor Power and Thermal Data Sheet for Notebooks:
38     http://support.amd.com/us/Processor_TechDocs/43373.pdf
39   AMD Family 10h Server and Workstation Processor Power and Thermal Data Sheet:
40     http://support.amd.com/us/Processor_TechDocs/43374.pdf
41   AMD Family 10h Desktop Processor Power and Thermal Data Sheet:
42     http://support.amd.com/us/Processor_TechDocs/43375.pdf
43
44 Author: Clemens Ladisch <clemens@ladisch.de>
45
46 Description
47 -----------
48
49 This driver permits reading of the internal temperature sensor of AMD
50 Family 10h/11h/12h/14h/15h/16h/17h processors.
51
52 All these processors have a sensor, but on those for Socket F or AM2+,
53 the sensor may return inconsistent values (erratum 319).  The driver
54 will refuse to load on these revisions unless you specify the "force=1"
55 module parameter.
56
57 Due to technical reasons, the driver can detect only the mainboard's
58 socket type, not the processor's actual capabilities.  Therefore, if you
59 are using an AM3 processor on an AM2+ mainboard, you can safely use the
60 "force=1" parameter.
61
62 There is one temperature measurement value, available as temp1_input in
63 sysfs. It is measured in degrees Celsius with a resolution of 1/8th degree.
64 Please note that it is defined as a relative value; to quote the AMD manual:
65
66   Tctl is the processor temperature control value, used by the platform to
67   control cooling systems. Tctl is a non-physical temperature on an
68   arbitrary scale measured in degrees. It does _not_ represent an actual
69   physical temperature like die or case temperature. Instead, it specifies
70   the processor temperature relative to the point at which the system must
71   supply the maximum cooling for the processor's specified maximum case
72   temperature and maximum thermal power dissipation.
73
74 The maximum value for Tctl is available in the file temp1_max.
75
76 If the BIOS has enabled hardware temperature control, the threshold at
77 which the processor will throttle itself to avoid damage is available in
78 temp1_crit and temp1_crit_hyst.