xref: /linux/Documentation/hwmon/peci-cputemp.rst (revision 7fdffdda630ee61ae0e09ef8f1ace52bbf70e2b0)
1.. SPDX-License-Identifier: GPL-2.0-only
2
3Kernel driver peci-cputemp
4==========================
5
6Supported chips:
7	One of Intel server CPUs listed below which is connected to a PECI bus.
8		* Intel Xeon E5/E7 v3 server processors
9			Intel Xeon E5-14xx v3 family
10			Intel Xeon E5-24xx v3 family
11			Intel Xeon E5-16xx v3 family
12			Intel Xeon E5-26xx v3 family
13			Intel Xeon E5-46xx v3 family
14			Intel Xeon E7-48xx v3 family
15			Intel Xeon E7-88xx v3 family
16		* Intel Xeon E5/E7 v4 server processors
17			Intel Xeon E5-16xx v4 family
18			Intel Xeon E5-26xx v4 family
19			Intel Xeon E5-46xx v4 family
20			Intel Xeon E7-48xx v4 family
21			Intel Xeon E7-88xx v4 family
22		* Intel Xeon Scalable server processors
23			Intel Xeon D family
24			Intel Xeon Bronze family
25			Intel Xeon Silver family
26			Intel Xeon Gold family
27			Intel Xeon Platinum family
28
29	Datasheet: Available from http://www.intel.com/design/literature.htm
30
31Author: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
32
33Description
34-----------
35
36This driver implements a generic PECI hwmon feature which provides Digital
37Thermal Sensor (DTS) thermal readings of the CPU package and CPU cores that are
38accessible via the processor PECI interface.
39
40All temperature values are given in millidegree Celsius and will be measurable
41only when the target CPU is powered on.
42
43Sysfs interface
44-------------------
45
46======================= =======================================================
47temp1_label		"Die"
48temp1_input		Provides current die temperature of the CPU package.
49temp1_max		Provides thermal control temperature of the CPU package
50			which is also known as Tcontrol.
51temp1_crit		Provides shutdown temperature of the CPU package which
52			is also known as the maximum processor junction
53			temperature, Tjmax or Tprochot.
54temp1_crit_hyst		Provides the hysteresis temperature of the CPU
55			package. Returns Tcontrol, the temperature at which
56			the critical condition clears.
57
58temp2_label		"DTS"
59temp2_input		Provides current temperature of the CPU package scaled
60			to match DTS thermal profile.
61temp2_max		Provides thermal control temperature of the CPU package
62			which is also known as Tcontrol.
63temp2_crit		Provides shutdown temperature of the CPU package which
64			is also known as the maximum processor junction
65			temperature, Tjmax or Tprochot.
66temp2_crit_hyst		Provides the hysteresis temperature of the CPU
67			package. Returns Tcontrol, the temperature at which
68			the critical condition clears.
69
70temp3_label		"Tcontrol"
71temp3_input		Provides current Tcontrol temperature of the CPU
72			package which is also known as Fan Temperature target.
73			Indicates the relative value from thermal monitor trip
74			temperature at which fans should be engaged.
75temp3_crit		Provides Tcontrol critical value of the CPU package
76			which is same to Tjmax.
77
78temp4_label		"Tthrottle"
79temp4_input		Provides current Tthrottle temperature of the CPU
80			package. Used for throttling temperature. If this value
81			is allowed and lower than Tjmax - the throttle will
82			occur and reported at lower than Tjmax.
83
84temp5_label		"Tjmax"
85temp5_input		Provides the maximum junction temperature, Tjmax of the
86			CPU package.
87
88temp[6-N]_label		Provides string "Core X", where X is resolved core
89			number.
90temp[6-N]_input		Provides current temperature of each core.
91
92======================= =======================================================
93