Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: hwmon: Document PECI drivers

Add documentation for peci-cputemp driver that provides DTS thermal
readings for CPU packages and CPU cores, and peci-dimmtemp driver that
provides Temperature Sensor on DIMM readings.

Co-developed-by: Iwona Winiarska <iwona.winiarska@intel.com>
Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Acked-by: Guenter Roeck <linux@roeck-us.net>
Acked-by: Joel Stanley <joel@jms.id.au>
Signed-off-by: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>
Signed-off-by: Iwona Winiarska <iwona.winiarska@intel.com>
Link: https://lore.kernel.org/r/20220208153639.255278-13-iwona.winiarska@intel.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Jae Hyun Yoo and committed by
Greg Kroah-Hartman
bdcfb955 73bc1b88

+151
+2
Documentation/hwmon/index.rst
··· 161 161 pcf8591 162 162 pim4328 163 163 pm6764tr 164 + peci-cputemp 165 + peci-dimmtemp 164 166 pmbus 165 167 powr1220 166 168 pxe1610
+90
Documentation/hwmon/peci-cputemp.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0-only 2 + 3 + Kernel driver peci-cputemp 4 + ========================== 5 + 6 + Supported 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 + 31 + Author: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com> 32 + 33 + Description 34 + ----------- 35 + 36 + This driver implements a generic PECI hwmon feature which provides Digital 37 + Thermal Sensor (DTS) thermal readings of the CPU package and CPU cores that are 38 + accessible via the processor PECI interface. 39 + 40 + All temperature values are given in millidegree Celsius and will be measurable 41 + only when the target CPU is powered on. 42 + 43 + Sysfs interface 44 + ------------------- 45 + 46 + ======================= ======================================================= 47 + temp1_label "Die" 48 + temp1_input Provides current die temperature of the CPU package. 49 + temp1_max Provides thermal control temperature of the CPU package 50 + which is also known as Tcontrol. 51 + temp1_crit Provides shutdown temperature of the CPU package which 52 + is also known as the maximum processor junction 53 + temperature, Tjmax or Tprochot. 54 + temp1_crit_hyst Provides the hysteresis value from Tcontrol to Tjmax of 55 + the CPU package. 56 + 57 + temp2_label "DTS" 58 + temp2_input Provides current temperature of the CPU package scaled 59 + to match DTS thermal profile. 60 + temp2_max Provides thermal control temperature of the CPU package 61 + which is also known as Tcontrol. 62 + temp2_crit Provides shutdown temperature of the CPU package which 63 + is also known as the maximum processor junction 64 + temperature, Tjmax or Tprochot. 65 + temp2_crit_hyst Provides the hysteresis value from Tcontrol to Tjmax of 66 + the CPU package. 67 + 68 + temp3_label "Tcontrol" 69 + temp3_input Provides current Tcontrol temperature of the CPU 70 + package which is also known as Fan Temperature target. 71 + Indicates the relative value from thermal monitor trip 72 + temperature at which fans should be engaged. 73 + temp3_crit Provides Tcontrol critical value of the CPU package 74 + which is same to Tjmax. 75 + 76 + temp4_label "Tthrottle" 77 + temp4_input Provides current Tthrottle temperature of the CPU 78 + package. Used for throttling temperature. If this value 79 + is allowed and lower than Tjmax - the throttle will 80 + occur and reported at lower than Tjmax. 81 + 82 + temp5_label "Tjmax" 83 + temp5_input Provides the maximum junction temperature, Tjmax of the 84 + CPU package. 85 + 86 + temp[6-N]_label Provides string "Core X", where X is resolved core 87 + number. 88 + temp[6-N]_input Provides current temperature of each core. 89 + 90 + ======================= =======================================================
+57
Documentation/hwmon/peci-dimmtemp.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + Kernel driver peci-dimmtemp 4 + =========================== 5 + 6 + Supported 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 + 31 + Author: Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com> 32 + 33 + Description 34 + ----------- 35 + 36 + This driver implements a generic PECI hwmon feature which provides 37 + Temperature sensor on DIMM readings that are accessible via the processor PECI interface. 38 + 39 + All temperature values are given in millidegree Celsius and will be measurable 40 + only when the target CPU is powered on. 41 + 42 + Sysfs interface 43 + ------------------- 44 + 45 + ======================= ======================================================= 46 + 47 + temp[N]_label Provides string "DIMM CI", where C is DIMM channel and 48 + I is DIMM index of the populated DIMM. 49 + temp[N]_input Provides current temperature of the populated DIMM. 50 + temp[N]_max Provides thermal control temperature of the DIMM. 51 + temp[N]_crit Provides shutdown temperature of the DIMM. 52 + 53 + ======================= ======================================================= 54 + 55 + Note: 56 + DIMM temperature attributes will appear when the client CPU's BIOS 57 + completes memory training and testing.
+2
MAINTAINERS
··· 15108 15108 M: Iwona Winiarska <iwona.winiarska@intel.com> 15109 15109 L: linux-hwmon@vger.kernel.org 15110 15110 S: Supported 15111 + F: Documentation/hwmon/peci-cputemp.rst 15112 + F: Documentation/hwmon/peci-dimmtemp.rst 15111 15113 F: drivers/hwmon/peci/ 15112 15114 15113 15115 PECI SUBSYSTEM