1Kernel driver k10temp
2=====================
3
4Supported 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",
25  "Carrizo", "Stoney Ridge", "Bristol Ridge"
26
27* AMD Family 16h processors: "Kabini", "Mullins"
28
29* AMD Family 17h processors: "Zen", "Zen 2"
30
31* AMD Family 18h processors: "Hygon Dhyana"
32
33* AMD Family 19h processors: "Zen 3"
34
35  Prefix: 'k10temp'
36
37  Addresses scanned: PCI space
38
39  Datasheets:
40
41  BIOS and Kernel Developer's Guide (BKDG) For AMD Family 10h Processors:
42
43    http://support.amd.com/us/Processor_TechDocs/31116.pdf
44
45  BIOS and Kernel Developer's Guide (BKDG) for AMD Family 11h Processors:
46
47    http://support.amd.com/us/Processor_TechDocs/41256.pdf
48
49  BIOS and Kernel Developer's Guide (BKDG) for AMD Family 12h Processors:
50
51    http://support.amd.com/us/Processor_TechDocs/41131.pdf
52
53  BIOS and Kernel Developer's Guide (BKDG) for AMD Family 14h Models 00h-0Fh Processors:
54
55    http://support.amd.com/us/Processor_TechDocs/43170.pdf
56
57  Revision Guide for AMD Family 10h Processors:
58
59    http://support.amd.com/us/Processor_TechDocs/41322.pdf
60
61  Revision Guide for AMD Family 11h Processors:
62
63    http://support.amd.com/us/Processor_TechDocs/41788.pdf
64
65  Revision Guide for AMD Family 12h Processors:
66
67    http://support.amd.com/us/Processor_TechDocs/44739.pdf
68
69  Revision Guide for AMD Family 14h Models 00h-0Fh Processors:
70
71    http://support.amd.com/us/Processor_TechDocs/47534.pdf
72
73  AMD Family 11h Processor Power and Thermal Data Sheet for Notebooks:
74
75    http://support.amd.com/us/Processor_TechDocs/43373.pdf
76
77  AMD Family 10h Server and Workstation Processor Power and Thermal Data Sheet:
78
79    http://support.amd.com/us/Processor_TechDocs/43374.pdf
80
81  AMD Family 10h Desktop Processor Power and Thermal Data Sheet:
82
83    http://support.amd.com/us/Processor_TechDocs/43375.pdf
84
85Author: Clemens Ladisch <clemens@ladisch.de>
86
87Description
88-----------
89
90This driver permits reading of the internal temperature sensor of AMD
91Family 10h/11h/12h/14h/15h/16h processors.
92
93All these processors have a sensor, but on those for Socket F or AM2+,
94the sensor may return inconsistent values (erratum 319).  The driver
95will refuse to load on these revisions unless you specify the "force=1"
96module parameter.
97
98Due to technical reasons, the driver can detect only the mainboard's
99socket type, not the processor's actual capabilities.  Therefore, if you
100are using an AM3 processor on an AM2+ mainboard, you can safely use the
101"force=1" parameter.
102
103For CPUs older than Family 17h, there is one temperature measurement value,
104available as temp1_input in sysfs. It is measured in degrees Celsius with a
105resolution of 1/8th degree.  Please note that it is defined as a relative
106value; to quote the AMD manual::
107
108  Tctl is the processor temperature control value, used by the platform to
109  control cooling systems. Tctl is a non-physical temperature on an
110  arbitrary scale measured in degrees. It does _not_ represent an actual
111  physical temperature like die or case temperature. Instead, it specifies
112  the processor temperature relative to the point at which the system must
113  supply the maximum cooling for the processor's specified maximum case
114  temperature and maximum thermal power dissipation.
115
116The maximum value for Tctl is available in the file temp1_max.
117
118If the BIOS has enabled hardware temperature control, the threshold at
119which the processor will throttle itself to avoid damage is available in
120temp1_crit and temp1_crit_hyst.
121
122On some AMD CPUs, there is a difference between the die temperature (Tdie) and
123the reported temperature (Tctl). Tdie is the real measured temperature, and
124Tctl is used for fan control. While Tctl is always available as temp1_input,
125the driver exports Tdie temperature as temp2_input for those CPUs which support
126it.
127
128Models from 17h family report relative temperature, the driver aims to
129compensate and report the real temperature.
130
131On Family 17h and Family 18h CPUs, additional temperature sensors may report
132Core Complex Die (CCD) temperatures. Up to 8 such temperatures are reported
133as temp{3..10}_input, labeled Tccd{1..8}. Actual support depends on the CPU
134variant.
135
136Various Family 17h and 18h CPUs report voltage and current telemetry
137information. The following attributes may be reported.
138
139Attribute	Label	Description
140===============	=======	================
141in0_input	Vcore	Core voltage
142in1_input	Vsoc	SoC voltage
143curr1_input	Icore	Core current
144curr2_input	Isoc	SoC current
145===============	=======	================
146
147Current values are raw (unscaled) as reported by the CPU. Core current is
148reported as multiples of 1A / LSB. SoC is reported as multiples of 0.25A
149/ LSB. The real current is board specific. Reported currents should be seen
150as rough guidance, and should be scaled using sensors3.conf as appropriate
151for a given board.
152