xref: /openbmc/linux/Documentation/hwmon/peci-cputemp.rst (revision 4f2c0a4acffbec01079c28f839422e64ddeff004)
1*bdcfb955SJae Hyun Yoo.. SPDX-License-Identifier: GPL-2.0-only
2*bdcfb955SJae Hyun Yoo
3*bdcfb955SJae Hyun YooKernel driver peci-cputemp
4*bdcfb955SJae Hyun Yoo==========================
5*bdcfb955SJae Hyun Yoo
6*bdcfb955SJae Hyun YooSupported chips:
7*bdcfb955SJae Hyun Yoo	One of Intel server CPUs listed below which is connected to a PECI bus.
8*bdcfb955SJae Hyun Yoo		* Intel Xeon E5/E7 v3 server processors
9*bdcfb955SJae Hyun Yoo			Intel Xeon E5-14xx v3 family
10*bdcfb955SJae Hyun Yoo			Intel Xeon E5-24xx v3 family
11*bdcfb955SJae Hyun Yoo			Intel Xeon E5-16xx v3 family
12*bdcfb955SJae Hyun Yoo			Intel Xeon E5-26xx v3 family
13*bdcfb955SJae Hyun Yoo			Intel Xeon E5-46xx v3 family
14*bdcfb955SJae Hyun Yoo			Intel Xeon E7-48xx v3 family
15*bdcfb955SJae Hyun Yoo			Intel Xeon E7-88xx v3 family
16*bdcfb955SJae Hyun Yoo		* Intel Xeon E5/E7 v4 server processors
17*bdcfb955SJae Hyun Yoo			Intel Xeon E5-16xx v4 family
18*bdcfb955SJae Hyun Yoo			Intel Xeon E5-26xx v4 family
19*bdcfb955SJae Hyun Yoo			Intel Xeon E5-46xx v4 family
20*bdcfb955SJae Hyun Yoo			Intel Xeon E7-48xx v4 family
21*bdcfb955SJae Hyun Yoo			Intel Xeon E7-88xx v4 family
22*bdcfb955SJae Hyun Yoo		* Intel Xeon Scalable server processors
23*bdcfb955SJae Hyun Yoo			Intel Xeon D family
24*bdcfb955SJae Hyun Yoo			Intel Xeon Bronze family
25*bdcfb955SJae Hyun Yoo			Intel Xeon Silver family
26*bdcfb955SJae Hyun Yoo			Intel Xeon Gold family
27*bdcfb955SJae Hyun Yoo			Intel Xeon Platinum family
28*bdcfb955SJae Hyun Yoo
29*bdcfb955SJae Hyun Yoo	Datasheet: Available from http://www.intel.com/design/literature.htm
30*bdcfb955SJae Hyun Yoo
31*bdcfb955SJae Hyun YooAuthor: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
32*bdcfb955SJae Hyun Yoo
33*bdcfb955SJae Hyun YooDescription
34*bdcfb955SJae Hyun Yoo-----------
35*bdcfb955SJae Hyun Yoo
36*bdcfb955SJae Hyun YooThis driver implements a generic PECI hwmon feature which provides Digital
37*bdcfb955SJae Hyun YooThermal Sensor (DTS) thermal readings of the CPU package and CPU cores that are
38*bdcfb955SJae Hyun Yooaccessible via the processor PECI interface.
39*bdcfb955SJae Hyun Yoo
40*bdcfb955SJae Hyun YooAll temperature values are given in millidegree Celsius and will be measurable
41*bdcfb955SJae Hyun Yooonly when the target CPU is powered on.
42*bdcfb955SJae Hyun Yoo
43*bdcfb955SJae Hyun YooSysfs interface
44*bdcfb955SJae Hyun Yoo-------------------
45*bdcfb955SJae Hyun Yoo
46*bdcfb955SJae Hyun Yoo======================= =======================================================
47*bdcfb955SJae Hyun Yootemp1_label		"Die"
48*bdcfb955SJae Hyun Yootemp1_input		Provides current die temperature of the CPU package.
49*bdcfb955SJae Hyun Yootemp1_max		Provides thermal control temperature of the CPU package
50*bdcfb955SJae Hyun Yoo			which is also known as Tcontrol.
51*bdcfb955SJae Hyun Yootemp1_crit		Provides shutdown temperature of the CPU package which
52*bdcfb955SJae Hyun Yoo			is also known as the maximum processor junction
53*bdcfb955SJae Hyun Yoo			temperature, Tjmax or Tprochot.
54*bdcfb955SJae Hyun Yootemp1_crit_hyst		Provides the hysteresis value from Tcontrol to Tjmax of
55*bdcfb955SJae Hyun Yoo			the CPU package.
56*bdcfb955SJae Hyun Yoo
57*bdcfb955SJae Hyun Yootemp2_label		"DTS"
58*bdcfb955SJae Hyun Yootemp2_input		Provides current temperature of the CPU package scaled
59*bdcfb955SJae Hyun Yoo			to match DTS thermal profile.
60*bdcfb955SJae Hyun Yootemp2_max		Provides thermal control temperature of the CPU package
61*bdcfb955SJae Hyun Yoo			which is also known as Tcontrol.
62*bdcfb955SJae Hyun Yootemp2_crit		Provides shutdown temperature of the CPU package which
63*bdcfb955SJae Hyun Yoo			is also known as the maximum processor junction
64*bdcfb955SJae Hyun Yoo			temperature, Tjmax or Tprochot.
65*bdcfb955SJae Hyun Yootemp2_crit_hyst		Provides the hysteresis value from Tcontrol to Tjmax of
66*bdcfb955SJae Hyun Yoo			the CPU package.
67*bdcfb955SJae Hyun Yoo
68*bdcfb955SJae Hyun Yootemp3_label		"Tcontrol"
69*bdcfb955SJae Hyun Yootemp3_input		Provides current Tcontrol temperature of the CPU
70*bdcfb955SJae Hyun Yoo			package which is also known as Fan Temperature target.
71*bdcfb955SJae Hyun Yoo			Indicates the relative value from thermal monitor trip
72*bdcfb955SJae Hyun Yoo			temperature at which fans should be engaged.
73*bdcfb955SJae Hyun Yootemp3_crit		Provides Tcontrol critical value of the CPU package
74*bdcfb955SJae Hyun Yoo			which is same to Tjmax.
75*bdcfb955SJae Hyun Yoo
76*bdcfb955SJae Hyun Yootemp4_label		"Tthrottle"
77*bdcfb955SJae Hyun Yootemp4_input		Provides current Tthrottle temperature of the CPU
78*bdcfb955SJae Hyun Yoo			package. Used for throttling temperature. If this value
79*bdcfb955SJae Hyun Yoo			is allowed and lower than Tjmax - the throttle will
80*bdcfb955SJae Hyun Yoo			occur and reported at lower than Tjmax.
81*bdcfb955SJae Hyun Yoo
82*bdcfb955SJae Hyun Yootemp5_label		"Tjmax"
83*bdcfb955SJae Hyun Yootemp5_input		Provides the maximum junction temperature, Tjmax of the
84*bdcfb955SJae Hyun Yoo			CPU package.
85*bdcfb955SJae Hyun Yoo
86*bdcfb955SJae Hyun Yootemp[6-N]_label		Provides string "Core X", where X is resolved core
87*bdcfb955SJae Hyun Yoo			number.
88*bdcfb955SJae Hyun Yootemp[6-N]_input		Provides current temperature of each core.
89*bdcfb955SJae Hyun Yoo
90*bdcfb955SJae Hyun Yoo======================= =======================================================
91