1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * k10temp.c - AMD Family 10h/11h/12h/14h/15h/16h/17h
4 * processor hardware monitoring
6 * Copyright (c) 2009 Clemens Ladisch <clemens@ladisch.de>
7 * Copyright (c) 2020 Guenter Roeck <linux@roeck-us.net>
9 * Implementation notes:
10 * - CCD register address information as well as the calculation to
11 * convert raw register values is from https://github.com/ocerman/zenpower.
12 * The information is not confirmed from chip datasheets, but experiments
13 * suggest that it provides reasonable temperature values.
16 #include <linux/bitops.h>
17 #include <linux/err.h>
18 #include <linux/hwmon.h>
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/pci.h>
22 #include <linux/pci_ids.h>
23 #include <asm/amd_nb.h>
24 #include <asm/processor.h>
26 MODULE_DESCRIPTION("AMD Family 10h+ CPU core temperature monitor");
27 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
28 MODULE_LICENSE("GPL");
31 module_param(force, bool, 0444);
32 MODULE_PARM_DESC(force, "force loading on processors with erratum 319");
34 /* Provide lock for writing to NB_SMU_IND_ADDR */
35 static DEFINE_MUTEX(nb_smu_ind_mutex);
37 #ifndef PCI_DEVICE_ID_AMD_15H_M70H_NB_F3
38 #define PCI_DEVICE_ID_AMD_15H_M70H_NB_F3 0x15b3
41 /* CPUID function 0x80000001, ebx */
42 #define CPUID_PKGTYPE_MASK GENMASK(31, 28)
43 #define CPUID_PKGTYPE_F 0x00000000
44 #define CPUID_PKGTYPE_AM2R2_AM3 0x10000000
46 /* DRAM controller (PCI function 2) */
47 #define REG_DCT0_CONFIG_HIGH 0x094
48 #define DDR3_MODE BIT(8)
50 /* miscellaneous (PCI function 3) */
51 #define REG_HARDWARE_THERMAL_CONTROL 0x64
52 #define HTC_ENABLE BIT(0)
54 #define REG_REPORTED_TEMPERATURE 0xa4
56 #define REG_NORTHBRIDGE_CAPABILITIES 0xe8
57 #define NB_CAP_HTC BIT(10)
60 * For F15h M60h and M70h, REG_HARDWARE_THERMAL_CONTROL
61 * and REG_REPORTED_TEMPERATURE have been moved to
62 * D0F0xBC_xD820_0C64 [Hardware Temperature Control]
63 * D0F0xBC_xD820_0CA4 [Reported Temperature Control]
65 #define F15H_M60H_HARDWARE_TEMP_CTRL_OFFSET 0xd8200c64
66 #define F15H_M60H_REPORTED_TEMP_CTRL_OFFSET 0xd8200ca4
68 /* Common for Zen CPU families (Family 17h and 18h and 19h and 1Ah) */
69 #define ZEN_REPORTED_TEMP_CTRL_BASE 0x00059800
71 #define ZEN_CCD_TEMP(offset, x) (ZEN_REPORTED_TEMP_CTRL_BASE + \
73 #define ZEN_CCD_TEMP_VALID BIT(11)
74 #define ZEN_CCD_TEMP_MASK GENMASK(10, 0)
76 #define ZEN_CUR_TEMP_SHIFT 21
77 #define ZEN_CUR_TEMP_RANGE_SEL_MASK BIT(19)
78 #define ZEN_CUR_TEMP_TJ_SEL_MASK GENMASK(17, 16)
81 * AMD's Industrial processor 3255 supports temperature from -40 deg to 105 deg Celsius.
82 * Use the model name to identify 3255 CPUs and set a flag to display negative temperature.
83 * Do not round off to zero for negative Tctl or Tdie values if the flag is set
85 #define AMD_I3255_STR "3255"
89 void (*read_htcreg)(struct pci_dev *pdev, u32 *regval);
90 void (*read_tempreg)(struct pci_dev *pdev, u32 *regval);
101 #define TCCD_BIT(x) ((x) + 2)
103 #define HAVE_TEMP(d, channel) ((d)->show_temp & BIT(channel))
111 static const struct tctl_offset tctl_offset_table[] = {
112 { 0x17, "AMD Ryzen 5 1600X", 20000 },
113 { 0x17, "AMD Ryzen 7 1700X", 20000 },
114 { 0x17, "AMD Ryzen 7 1800X", 20000 },
115 { 0x17, "AMD Ryzen 7 2700X", 10000 },
116 { 0x17, "AMD Ryzen Threadripper 19", 27000 }, /* 19{00,20,50}X */
117 { 0x17, "AMD Ryzen Threadripper 29", 27000 }, /* 29{20,50,70,90}[W]X */
120 static void read_htcreg_pci(struct pci_dev *pdev, u32 *regval)
122 pci_read_config_dword(pdev, REG_HARDWARE_THERMAL_CONTROL, regval);
125 static void read_tempreg_pci(struct pci_dev *pdev, u32 *regval)
127 pci_read_config_dword(pdev, REG_REPORTED_TEMPERATURE, regval);
130 static void amd_nb_index_read(struct pci_dev *pdev, unsigned int devfn,
131 unsigned int base, int offset, u32 *val)
133 mutex_lock(&nb_smu_ind_mutex);
134 pci_bus_write_config_dword(pdev->bus, devfn,
136 pci_bus_read_config_dword(pdev->bus, devfn,
138 mutex_unlock(&nb_smu_ind_mutex);
141 static void read_htcreg_nb_f15(struct pci_dev *pdev, u32 *regval)
143 amd_nb_index_read(pdev, PCI_DEVFN(0, 0), 0xb8,
144 F15H_M60H_HARDWARE_TEMP_CTRL_OFFSET, regval);
147 static void read_tempreg_nb_f15(struct pci_dev *pdev, u32 *regval)
149 amd_nb_index_read(pdev, PCI_DEVFN(0, 0), 0xb8,
150 F15H_M60H_REPORTED_TEMP_CTRL_OFFSET, regval);
153 static void read_tempreg_nb_zen(struct pci_dev *pdev, u32 *regval)
155 if (amd_smn_read(amd_pci_dev_to_node_id(pdev),
156 ZEN_REPORTED_TEMP_CTRL_BASE, regval))
160 static int read_ccd_temp_reg(struct k10temp_data *data, int ccd, u32 *regval)
162 u16 node_id = amd_pci_dev_to_node_id(data->pdev);
164 return amd_smn_read(node_id, ZEN_CCD_TEMP(data->ccd_offset, ccd), regval);
167 static long get_raw_temp(struct k10temp_data *data)
172 data->read_tempreg(data->pdev, ®val);
173 temp = (regval >> ZEN_CUR_TEMP_SHIFT) * 125;
174 if ((regval & data->temp_adjust_mask) ||
175 (regval & ZEN_CUR_TEMP_TJ_SEL_MASK) == ZEN_CUR_TEMP_TJ_SEL_MASK)
180 static const char *k10temp_temp_label[] = {
197 static int k10temp_read_labels(struct device *dev,
198 enum hwmon_sensor_types type,
199 u32 attr, int channel, const char **str)
203 *str = k10temp_temp_label[channel];
211 static int k10temp_read_temp(struct device *dev, u32 attr, int channel,
214 struct k10temp_data *data = dev_get_drvdata(dev);
215 int ret = -EOPNOTSUPP;
219 case hwmon_temp_input:
222 *val = get_raw_temp(data);
223 if (*val < 0 && !data->disp_negative)
227 *val = get_raw_temp(data) - data->temp_offset;
228 if (*val < 0 && !data->disp_negative)
231 case 2 ... 13: /* Tccd{1-12} */
232 ret = read_ccd_temp_reg(data, channel - 2, ®val);
237 *val = (regval & ZEN_CCD_TEMP_MASK) * 125 - 49000;
246 case hwmon_temp_crit:
247 data->read_htcreg(data->pdev, ®val);
248 *val = ((regval >> 16) & 0x7f) * 500 + 52000;
250 case hwmon_temp_crit_hyst:
251 data->read_htcreg(data->pdev, ®val);
252 *val = (((regval >> 16) & 0x7f)
253 - ((regval >> 24) & 0xf)) * 500 + 52000;
261 static int k10temp_read(struct device *dev, enum hwmon_sensor_types type,
262 u32 attr, int channel, long *val)
266 return k10temp_read_temp(dev, attr, channel, val);
272 static umode_t k10temp_is_visible(const void *drvdata,
273 enum hwmon_sensor_types type,
274 u32 attr, int channel)
276 const struct k10temp_data *data = drvdata;
277 struct pci_dev *pdev = data->pdev;
283 case hwmon_temp_input:
284 if (!HAVE_TEMP(data, channel))
288 if (channel || data->is_zen)
291 case hwmon_temp_crit:
292 case hwmon_temp_crit_hyst:
293 if (channel || !data->read_htcreg)
296 pci_read_config_dword(pdev,
297 REG_NORTHBRIDGE_CAPABILITIES,
299 if (!(reg & NB_CAP_HTC))
302 data->read_htcreg(data->pdev, ®);
303 if (!(reg & HTC_ENABLE))
306 case hwmon_temp_label:
307 /* Show temperature labels only on Zen CPUs */
308 if (!data->is_zen || !HAVE_TEMP(data, channel))
321 static bool has_erratum_319(struct pci_dev *pdev)
323 u32 pkg_type, reg_dram_cfg;
325 if (boot_cpu_data.x86 != 0x10)
329 * Erratum 319: The thermal sensor of Socket F/AM2+ processors
332 pkg_type = cpuid_ebx(0x80000001) & CPUID_PKGTYPE_MASK;
333 if (pkg_type == CPUID_PKGTYPE_F)
335 if (pkg_type != CPUID_PKGTYPE_AM2R2_AM3)
338 /* DDR3 memory implies socket AM3, which is good */
339 pci_bus_read_config_dword(pdev->bus,
340 PCI_DEVFN(PCI_SLOT(pdev->devfn), 2),
341 REG_DCT0_CONFIG_HIGH, ®_dram_cfg);
342 if (reg_dram_cfg & DDR3_MODE)
346 * Unfortunately it is possible to run a socket AM3 CPU with DDR2
347 * memory. We blacklist all the cores which do exist in socket AM2+
348 * format. It still isn't perfect, as RB-C2 cores exist in both AM2+
349 * and AM3 formats, but that's the best we can do.
351 return boot_cpu_data.x86_model < 4 ||
352 (boot_cpu_data.x86_model == 4 && boot_cpu_data.x86_stepping <= 2);
355 static const struct hwmon_channel_info * const k10temp_info[] = {
356 HWMON_CHANNEL_INFO(temp,
357 HWMON_T_INPUT | HWMON_T_MAX |
358 HWMON_T_CRIT | HWMON_T_CRIT_HYST |
360 HWMON_T_INPUT | HWMON_T_LABEL,
361 HWMON_T_INPUT | HWMON_T_LABEL,
362 HWMON_T_INPUT | HWMON_T_LABEL,
363 HWMON_T_INPUT | HWMON_T_LABEL,
364 HWMON_T_INPUT | HWMON_T_LABEL,
365 HWMON_T_INPUT | HWMON_T_LABEL,
366 HWMON_T_INPUT | HWMON_T_LABEL,
367 HWMON_T_INPUT | HWMON_T_LABEL,
368 HWMON_T_INPUT | HWMON_T_LABEL,
369 HWMON_T_INPUT | HWMON_T_LABEL,
370 HWMON_T_INPUT | HWMON_T_LABEL,
371 HWMON_T_INPUT | HWMON_T_LABEL,
372 HWMON_T_INPUT | HWMON_T_LABEL),
376 static const struct hwmon_ops k10temp_hwmon_ops = {
377 .is_visible = k10temp_is_visible,
378 .read = k10temp_read,
379 .read_string = k10temp_read_labels,
382 static const struct hwmon_chip_info k10temp_chip_info = {
383 .ops = &k10temp_hwmon_ops,
384 .info = k10temp_info,
387 static void k10temp_get_ccd_support(struct k10temp_data *data, int limit)
392 for (i = 0; i < limit; i++) {
394 * Ignore inaccessible CCDs.
396 * Some systems will return a register value of 0, and the TEMP_VALID
397 * bit check below will naturally fail.
399 * Other systems will return a PCI_ERROR_RESPONSE (0xFFFFFFFF) for
400 * the register value. And this will incorrectly pass the TEMP_VALID
403 if (read_ccd_temp_reg(data, i, ®val))
406 if (regval & ZEN_CCD_TEMP_VALID)
407 data->show_temp |= BIT(TCCD_BIT(i));
411 static int k10temp_probe(struct pci_dev *pdev, const struct pci_device_id *id)
413 int unreliable = has_erratum_319(pdev);
414 struct device *dev = &pdev->dev;
415 struct k10temp_data *data;
416 struct device *hwmon_dev;
422 "unreliable CPU thermal sensor; monitoring disabled\n");
426 "unreliable CPU thermal sensor; check erratum 319\n");
429 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
434 data->show_temp |= BIT(TCTL_BIT); /* Always show Tctl */
436 if (boot_cpu_data.x86 == 0x17 &&
437 strstr(boot_cpu_data.x86_model_id, AMD_I3255_STR)) {
438 data->disp_negative = true;
441 data->is_zen = cpu_feature_enabled(X86_FEATURE_ZEN);
443 data->temp_adjust_mask = ZEN_CUR_TEMP_RANGE_SEL_MASK;
444 data->read_tempreg = read_tempreg_nb_zen;
445 } else if (boot_cpu_data.x86 == 0x15 &&
446 ((boot_cpu_data.x86_model & 0xf0) == 0x60 ||
447 (boot_cpu_data.x86_model & 0xf0) == 0x70)) {
448 data->read_htcreg = read_htcreg_nb_f15;
449 data->read_tempreg = read_tempreg_nb_f15;
451 data->read_htcreg = read_htcreg_pci;
452 data->read_tempreg = read_tempreg_pci;
455 if (boot_cpu_data.x86 == 0x17 || boot_cpu_data.x86 == 0x18) {
456 switch (boot_cpu_data.x86_model) {
459 case 0x11: /* Zen APU */
460 case 0x18: /* Zen+ APU */
461 data->ccd_offset = 0x154;
462 k10temp_get_ccd_support(data, 4);
464 case 0x31: /* Zen2 Threadripper */
465 case 0x60: /* Renoir */
466 case 0x68: /* Lucienne */
467 case 0x71: /* Zen2 */
468 data->ccd_offset = 0x154;
469 k10temp_get_ccd_support(data, 8);
472 data->ccd_offset = 0x300;
473 k10temp_get_ccd_support(data, 8);
476 } else if (boot_cpu_data.x86 == 0x19) {
477 switch (boot_cpu_data.x86_model) {
478 case 0x0 ... 0x1: /* Zen3 SP3/TR */
479 case 0x8: /* Zen3 TR Chagall */
480 case 0x21: /* Zen3 Ryzen Desktop */
481 case 0x50 ... 0x5f: /* Green Sardine */
482 data->ccd_offset = 0x154;
483 k10temp_get_ccd_support(data, 8);
485 case 0x40 ... 0x4f: /* Yellow Carp */
486 data->ccd_offset = 0x300;
487 k10temp_get_ccd_support(data, 8);
491 data->ccd_offset = 0x308;
492 k10temp_get_ccd_support(data, 8);
496 data->ccd_offset = 0x300;
497 k10temp_get_ccd_support(data, 12);
502 for (i = 0; i < ARRAY_SIZE(tctl_offset_table); i++) {
503 const struct tctl_offset *entry = &tctl_offset_table[i];
505 if (boot_cpu_data.x86 == entry->model &&
506 strstr(boot_cpu_data.x86_model_id, entry->id)) {
507 data->show_temp |= BIT(TDIE_BIT); /* show Tdie */
508 data->temp_offset = entry->offset;
513 hwmon_dev = devm_hwmon_device_register_with_info(dev, "k10temp", data,
516 return PTR_ERR_OR_ZERO(hwmon_dev);
519 static const struct pci_device_id k10temp_id_table[] = {
520 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_10H_NB_MISC) },
521 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_11H_NB_MISC) },
522 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_CNB17H_F3) },
523 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_NB_F3) },
524 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_M10H_F3) },
525 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_M30H_NB_F3) },
526 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_M60H_NB_F3) },
527 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_M70H_NB_F3) },
528 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_16H_NB_F3) },
529 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_16H_M30H_NB_F3) },
530 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_17H_DF_F3) },
531 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_17H_M10H_DF_F3) },
532 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_17H_M30H_DF_F3) },
533 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_17H_M60H_DF_F3) },
534 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_17H_M70H_DF_F3) },
535 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_17H_MA0H_DF_F3) },
536 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_19H_DF_F3) },
537 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_19H_M10H_DF_F3) },
538 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_19H_M40H_DF_F3) },
539 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_19H_M50H_DF_F3) },
540 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_19H_M60H_DF_F3) },
541 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_19H_M70H_DF_F3) },
542 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_19H_M78H_DF_F3) },
543 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_1AH_M00H_DF_F3) },
544 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_1AH_M20H_DF_F3) },
545 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_1AH_M60H_DF_F3) },
546 { PCI_VDEVICE(HYGON, PCI_DEVICE_ID_AMD_17H_DF_F3) },
549 MODULE_DEVICE_TABLE(pci, k10temp_id_table);
551 static struct pci_driver k10temp_driver = {
553 .id_table = k10temp_id_table,
554 .probe = k10temp_probe,
557 module_pci_driver(k10temp_driver);