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