2 * coretemp.c - Linux kernel module for hardware monitoring
4 * Copyright (C) 2007 Rudolf Marek <r.marek@assembler.cz>
6 * Inspired from many hwmon drivers
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/slab.h>
28 #include <linux/jiffies.h>
29 #include <linux/hwmon.h>
30 #include <linux/sysfs.h>
31 #include <linux/hwmon-sysfs.h>
32 #include <linux/err.h>
33 #include <linux/mutex.h>
34 #include <linux/list.h>
35 #include <linux/platform_device.h>
36 #include <linux/cpu.h>
37 #include <linux/pci.h>
38 #include <linux/smp.h>
39 #include <linux/moduleparam.h>
41 #include <asm/processor.h>
43 #define DRVNAME "coretemp"
46 * force_tjmax only matters when TjMax can't be read from the CPU itself.
47 * When set, it replaces the driver's suboptimal heuristic.
49 static int force_tjmax
;
50 module_param_named(tjmax
, force_tjmax
, int, 0444);
51 MODULE_PARM_DESC(tjmax
, "TjMax value in degrees Celsius");
53 #define BASE_SYSFS_ATTR_NO 2 /* Sysfs Base attr no for coretemp */
54 #define NUM_REAL_CORES 16 /* Number of Real cores per cpu */
55 #define CORETEMP_NAME_LENGTH 17 /* String Length of attrs */
56 #define MAX_CORE_ATTRS 4 /* Maximum no of basic attrs */
57 #define TOTAL_ATTRS (MAX_CORE_ATTRS + 1)
58 #define MAX_CORE_DATA (NUM_REAL_CORES + BASE_SYSFS_ATTR_NO)
61 #define TO_PHYS_ID(cpu) cpu_data(cpu).phys_proc_id
62 #define TO_CORE_ID(cpu) cpu_data(cpu).cpu_core_id
63 #define TO_ATTR_NO(cpu) (TO_CORE_ID(cpu) + BASE_SYSFS_ATTR_NO)
64 #define for_each_sibling(i, cpu) for_each_cpu(i, cpu_sibling_mask(cpu))
66 #define TO_PHYS_ID(cpu) (cpu)
67 #define TO_CORE_ID(cpu) (cpu)
68 #define TO_ATTR_NO(cpu) (cpu)
69 #define for_each_sibling(i, cpu) for (i = 0; false; )
73 * Per-Core Temperature Data
74 * @last_updated: The time when the current temperature value was updated
75 * earlier (in jiffies).
76 * @cpu_core_id: The CPU Core from which temperature values should be read
77 * This value is passed as "id" field to rdmsr/wrmsr functions.
78 * @status_reg: One of IA32_THERM_STATUS or IA32_PACKAGE_THERM_STATUS,
79 * from where the temperature values should be read.
80 * @attr_size: Total number of pre-core attrs displayed in the sysfs.
81 * @is_pkg_data: If this is 1, the temp_data holds pkgtemp data.
82 * Otherwise, temp_data holds coretemp data.
83 * @valid: If this is 1, the current temperature is valid.
89 unsigned long last_updated
;
96 struct sensor_device_attribute sd_attrs
[TOTAL_ATTRS
];
97 char attr_name
[TOTAL_ATTRS
][CORETEMP_NAME_LENGTH
];
98 struct mutex update_lock
;
101 /* Platform Data per Physical CPU */
102 struct platform_data
{
103 struct device
*hwmon_dev
;
105 struct temp_data
*core_data
[MAX_CORE_DATA
];
106 struct device_attribute name_attr
;
110 struct list_head list
;
111 struct platform_device
*pdev
;
115 static LIST_HEAD(pdev_list
);
116 static DEFINE_MUTEX(pdev_list_mutex
);
118 static ssize_t
show_name(struct device
*dev
,
119 struct device_attribute
*devattr
, char *buf
)
121 return sprintf(buf
, "%s\n", DRVNAME
);
124 static ssize_t
show_label(struct device
*dev
,
125 struct device_attribute
*devattr
, char *buf
)
127 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
128 struct platform_data
*pdata
= dev_get_drvdata(dev
);
129 struct temp_data
*tdata
= pdata
->core_data
[attr
->index
];
131 if (tdata
->is_pkg_data
)
132 return sprintf(buf
, "Physical id %u\n", pdata
->phys_proc_id
);
134 return sprintf(buf
, "Core %u\n", tdata
->cpu_core_id
);
137 static ssize_t
show_crit_alarm(struct device
*dev
,
138 struct device_attribute
*devattr
, char *buf
)
141 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
142 struct platform_data
*pdata
= dev_get_drvdata(dev
);
143 struct temp_data
*tdata
= pdata
->core_data
[attr
->index
];
145 rdmsr_on_cpu(tdata
->cpu
, tdata
->status_reg
, &eax
, &edx
);
147 return sprintf(buf
, "%d\n", (eax
>> 5) & 1);
150 static ssize_t
show_tjmax(struct device
*dev
,
151 struct device_attribute
*devattr
, char *buf
)
153 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
154 struct platform_data
*pdata
= dev_get_drvdata(dev
);
156 return sprintf(buf
, "%d\n", pdata
->core_data
[attr
->index
]->tjmax
);
159 static ssize_t
show_ttarget(struct device
*dev
,
160 struct device_attribute
*devattr
, char *buf
)
162 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
163 struct platform_data
*pdata
= dev_get_drvdata(dev
);
165 return sprintf(buf
, "%d\n", pdata
->core_data
[attr
->index
]->ttarget
);
168 static ssize_t
show_temp(struct device
*dev
,
169 struct device_attribute
*devattr
, char *buf
)
172 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(devattr
);
173 struct platform_data
*pdata
= dev_get_drvdata(dev
);
174 struct temp_data
*tdata
= pdata
->core_data
[attr
->index
];
176 mutex_lock(&tdata
->update_lock
);
178 /* Check whether the time interval has elapsed */
179 if (!tdata
->valid
|| time_after(jiffies
, tdata
->last_updated
+ HZ
)) {
180 rdmsr_on_cpu(tdata
->cpu
, tdata
->status_reg
, &eax
, &edx
);
182 /* Check whether the data is valid */
183 if (eax
& 0x80000000) {
184 tdata
->temp
= tdata
->tjmax
-
185 ((eax
>> 16) & 0x7f) * 1000;
188 tdata
->last_updated
= jiffies
;
191 mutex_unlock(&tdata
->update_lock
);
192 return tdata
->valid
? sprintf(buf
, "%d\n", tdata
->temp
) : -EAGAIN
;
195 static int adjust_tjmax(struct cpuinfo_x86
*c
, u32 id
, struct device
*dev
)
197 /* The 100C is default for both mobile and non mobile CPUs */
200 int tjmax_ee
= 85000;
204 struct pci_dev
*host_bridge
;
206 /* Early chips have no MSR for TjMax */
208 if (c
->x86_model
== 0xf && c
->x86_mask
< 4)
213 if (c
->x86_model
== 0x1c) {
216 host_bridge
= pci_get_bus_and_slot(0, PCI_DEVFN(0, 0));
218 if (host_bridge
&& host_bridge
->vendor
== PCI_VENDOR_ID_INTEL
219 && (host_bridge
->device
== 0xa000 /* NM10 based nettop */
220 || host_bridge
->device
== 0xa010)) /* NM10 based netbook */
225 pci_dev_put(host_bridge
);
228 if (c
->x86_model
> 0xe && usemsr_ee
) {
232 * Now we can detect the mobile CPU using Intel provided table
233 * http://softwarecommunity.intel.com/Wiki/Mobility/720.htm
234 * For Core2 cores, check MSR 0x17, bit 28 1 = Mobile CPU
236 err
= rdmsr_safe_on_cpu(id
, 0x17, &eax
, &edx
);
239 "Unable to access MSR 0x17, assuming desktop"
242 } else if (c
->x86_model
< 0x17 && !(eax
& 0x10000000)) {
244 * Trust bit 28 up to Penryn, I could not find any
245 * documentation on that; if you happen to know
246 * someone at Intel please ask
250 /* Platform ID bits 52:50 (EDX starts at bit 32) */
251 platform_id
= (edx
>> 18) & 0x7;
254 * Mobile Penryn CPU seems to be platform ID 7 or 5
257 if (c
->x86_model
== 0x17 &&
258 (platform_id
== 5 || platform_id
== 7)) {
260 * If MSR EE bit is set, set it to 90 degrees C,
261 * otherwise 105 degrees C
270 err
= rdmsr_safe_on_cpu(id
, 0xee, &eax
, &edx
);
273 "Unable to access MSR 0xEE, for Tjmax, left"
275 } else if (eax
& 0x40000000) {
278 } else if (tjmax
== 100000) {
280 * If we don't use msr EE it means we are desktop CPU
281 * (with exeception of Atom)
283 dev_warn(dev
, "Using relative temperature scale!\n");
289 static int get_tjmax(struct cpuinfo_x86
*c
, u32 id
, struct device
*dev
)
296 * A new feature of current Intel(R) processors, the
297 * IA32_TEMPERATURE_TARGET contains the TjMax value
299 err
= rdmsr_safe_on_cpu(id
, MSR_IA32_TEMPERATURE_TARGET
, &eax
, &edx
);
301 if (c
->x86_model
> 0xe && c
->x86_model
!= 0x1c)
302 dev_warn(dev
, "Unable to read TjMax from CPU %u\n", id
);
304 val
= (eax
>> 16) & 0xff;
306 * If the TjMax is not plausible, an assumption
310 dev_dbg(dev
, "TjMax is %d degrees C\n", val
);
316 dev_notice(dev
, "TjMax forced to %d degrees C by user\n",
318 return force_tjmax
* 1000;
322 * An assumption is made for early CPUs and unreadable MSR.
323 * NOTE: the calculated value may not be correct.
325 return adjust_tjmax(c
, id
, dev
);
328 static int create_name_attr(struct platform_data
*pdata
, struct device
*dev
)
330 sysfs_attr_init(&pdata
->name_attr
.attr
);
331 pdata
->name_attr
.attr
.name
= "name";
332 pdata
->name_attr
.attr
.mode
= S_IRUGO
;
333 pdata
->name_attr
.show
= show_name
;
334 return device_create_file(dev
, &pdata
->name_attr
);
337 static int create_core_attrs(struct temp_data
*tdata
, struct device
*dev
,
341 static ssize_t (*const rd_ptr
[TOTAL_ATTRS
]) (struct device
*dev
,
342 struct device_attribute
*devattr
, char *buf
) = {
343 show_label
, show_crit_alarm
, show_temp
, show_tjmax
,
345 static const char *const names
[TOTAL_ATTRS
] = {
346 "temp%d_label", "temp%d_crit_alarm",
347 "temp%d_input", "temp%d_crit",
350 for (i
= 0; i
< tdata
->attr_size
; i
++) {
351 snprintf(tdata
->attr_name
[i
], CORETEMP_NAME_LENGTH
, names
[i
],
353 sysfs_attr_init(&tdata
->sd_attrs
[i
].dev_attr
.attr
);
354 tdata
->sd_attrs
[i
].dev_attr
.attr
.name
= tdata
->attr_name
[i
];
355 tdata
->sd_attrs
[i
].dev_attr
.attr
.mode
= S_IRUGO
;
356 tdata
->sd_attrs
[i
].dev_attr
.show
= rd_ptr
[i
];
357 tdata
->sd_attrs
[i
].index
= attr_no
;
358 err
= device_create_file(dev
, &tdata
->sd_attrs
[i
].dev_attr
);
366 device_remove_file(dev
, &tdata
->sd_attrs
[i
].dev_attr
);
371 static int __cpuinit
chk_ucode_version(unsigned int cpu
)
373 struct cpuinfo_x86
*c
= &cpu_data(cpu
);
376 * Check if we have problem with errata AE18 of Core processors:
377 * Readings might stop update when processor visited too deep sleep,
378 * fixed for stepping D0 (6EC).
380 if (c
->x86_model
== 0xe && c
->x86_mask
< 0xc && c
->microcode
< 0x39) {
381 pr_err("Errata AE18 not fixed, update BIOS or "
382 "microcode of the CPU!\n");
388 static struct platform_device
*coretemp_get_pdev(unsigned int cpu
)
390 u16 phys_proc_id
= TO_PHYS_ID(cpu
);
391 struct pdev_entry
*p
;
393 mutex_lock(&pdev_list_mutex
);
395 list_for_each_entry(p
, &pdev_list
, list
)
396 if (p
->phys_proc_id
== phys_proc_id
) {
397 mutex_unlock(&pdev_list_mutex
);
401 mutex_unlock(&pdev_list_mutex
);
405 static struct temp_data
*init_temp_data(unsigned int cpu
, int pkg_flag
)
407 struct temp_data
*tdata
;
409 tdata
= kzalloc(sizeof(struct temp_data
), GFP_KERNEL
);
413 tdata
->status_reg
= pkg_flag
? MSR_IA32_PACKAGE_THERM_STATUS
:
414 MSR_IA32_THERM_STATUS
;
415 tdata
->is_pkg_data
= pkg_flag
;
417 tdata
->cpu_core_id
= TO_CORE_ID(cpu
);
418 tdata
->attr_size
= MAX_CORE_ATTRS
;
419 mutex_init(&tdata
->update_lock
);
423 static int create_core_data(struct platform_device
*pdev
,
424 unsigned int cpu
, int pkg_flag
)
426 struct temp_data
*tdata
;
427 struct platform_data
*pdata
= platform_get_drvdata(pdev
);
428 struct cpuinfo_x86
*c
= &cpu_data(cpu
);
433 * Find attr number for sysfs:
434 * We map the attr number to core id of the CPU
435 * The attr number is always core id + 2
436 * The Pkgtemp will always show up as temp1_*, if available
438 attr_no
= pkg_flag
? 1 : TO_ATTR_NO(cpu
);
440 if (attr_no
> MAX_CORE_DATA
- 1)
444 * Provide a single set of attributes for all HT siblings of a core
445 * to avoid duplicate sensors (the processor ID and core ID of all
446 * HT siblings of a core are the same).
447 * Skip if a HT sibling of this core is already registered.
448 * This is not an error.
450 if (pdata
->core_data
[attr_no
] != NULL
)
453 tdata
= init_temp_data(cpu
, pkg_flag
);
457 /* Test if we can access the status register */
458 err
= rdmsr_safe_on_cpu(cpu
, tdata
->status_reg
, &eax
, &edx
);
462 /* We can access status register. Get Critical Temperature */
463 tdata
->tjmax
= get_tjmax(c
, cpu
, &pdev
->dev
);
466 * Read the still undocumented bits 8:15 of IA32_TEMPERATURE_TARGET.
467 * The target temperature is available on older CPUs but not in this
468 * register. Atoms don't have the register at all.
470 if (c
->x86_model
> 0xe && c
->x86_model
!= 0x1c) {
471 err
= rdmsr_safe_on_cpu(cpu
, MSR_IA32_TEMPERATURE_TARGET
,
475 = tdata
->tjmax
- ((eax
>> 8) & 0xff) * 1000;
480 pdata
->core_data
[attr_no
] = tdata
;
482 /* Create sysfs interfaces */
483 err
= create_core_attrs(tdata
, &pdev
->dev
, attr_no
);
489 pdata
->core_data
[attr_no
] = NULL
;
494 static void coretemp_add_core(unsigned int cpu
, int pkg_flag
)
496 struct platform_device
*pdev
= coretemp_get_pdev(cpu
);
502 err
= create_core_data(pdev
, cpu
, pkg_flag
);
504 dev_err(&pdev
->dev
, "Adding Core %u failed\n", cpu
);
507 static void coretemp_remove_core(struct platform_data
*pdata
,
508 struct device
*dev
, int indx
)
511 struct temp_data
*tdata
= pdata
->core_data
[indx
];
513 /* Remove the sysfs attributes */
514 for (i
= 0; i
< tdata
->attr_size
; i
++)
515 device_remove_file(dev
, &tdata
->sd_attrs
[i
].dev_attr
);
517 kfree(pdata
->core_data
[indx
]);
518 pdata
->core_data
[indx
] = NULL
;
521 static int __devinit
coretemp_probe(struct platform_device
*pdev
)
523 struct platform_data
*pdata
;
526 /* Initialize the per-package data structures */
527 pdata
= kzalloc(sizeof(struct platform_data
), GFP_KERNEL
);
531 err
= create_name_attr(pdata
, &pdev
->dev
);
535 pdata
->phys_proc_id
= pdev
->id
;
536 platform_set_drvdata(pdev
, pdata
);
538 pdata
->hwmon_dev
= hwmon_device_register(&pdev
->dev
);
539 if (IS_ERR(pdata
->hwmon_dev
)) {
540 err
= PTR_ERR(pdata
->hwmon_dev
);
541 dev_err(&pdev
->dev
, "Class registration failed (%d)\n", err
);
547 device_remove_file(&pdev
->dev
, &pdata
->name_attr
);
548 platform_set_drvdata(pdev
, NULL
);
554 static int __devexit
coretemp_remove(struct platform_device
*pdev
)
556 struct platform_data
*pdata
= platform_get_drvdata(pdev
);
559 for (i
= MAX_CORE_DATA
- 1; i
>= 0; --i
)
560 if (pdata
->core_data
[i
])
561 coretemp_remove_core(pdata
, &pdev
->dev
, i
);
563 device_remove_file(&pdev
->dev
, &pdata
->name_attr
);
564 hwmon_device_unregister(pdata
->hwmon_dev
);
565 platform_set_drvdata(pdev
, NULL
);
570 static struct platform_driver coretemp_driver
= {
572 .owner
= THIS_MODULE
,
575 .probe
= coretemp_probe
,
576 .remove
= __devexit_p(coretemp_remove
),
579 static int __cpuinit
coretemp_device_add(unsigned int cpu
)
582 struct platform_device
*pdev
;
583 struct pdev_entry
*pdev_entry
;
585 mutex_lock(&pdev_list_mutex
);
587 pdev
= platform_device_alloc(DRVNAME
, TO_PHYS_ID(cpu
));
590 pr_err("Device allocation failed\n");
594 pdev_entry
= kzalloc(sizeof(struct pdev_entry
), GFP_KERNEL
);
597 goto exit_device_put
;
600 err
= platform_device_add(pdev
);
602 pr_err("Device addition failed (%d)\n", err
);
603 goto exit_device_free
;
606 pdev_entry
->pdev
= pdev
;
607 pdev_entry
->phys_proc_id
= pdev
->id
;
609 list_add_tail(&pdev_entry
->list
, &pdev_list
);
610 mutex_unlock(&pdev_list_mutex
);
617 platform_device_put(pdev
);
619 mutex_unlock(&pdev_list_mutex
);
623 static void coretemp_device_remove(unsigned int cpu
)
625 struct pdev_entry
*p
, *n
;
626 u16 phys_proc_id
= TO_PHYS_ID(cpu
);
628 mutex_lock(&pdev_list_mutex
);
629 list_for_each_entry_safe(p
, n
, &pdev_list
, list
) {
630 if (p
->phys_proc_id
!= phys_proc_id
)
632 platform_device_unregister(p
->pdev
);
636 mutex_unlock(&pdev_list_mutex
);
639 static bool is_any_core_online(struct platform_data
*pdata
)
643 /* Find online cores, except pkgtemp data */
644 for (i
= MAX_CORE_DATA
- 1; i
>= 0; --i
) {
645 if (pdata
->core_data
[i
] &&
646 !pdata
->core_data
[i
]->is_pkg_data
) {
653 static void __cpuinit
get_core_online(unsigned int cpu
)
655 struct cpuinfo_x86
*c
= &cpu_data(cpu
);
656 struct platform_device
*pdev
= coretemp_get_pdev(cpu
);
660 * CPUID.06H.EAX[0] indicates whether the CPU has thermal
661 * sensors. We check this bit only, all the early CPUs
662 * without thermal sensors will be filtered out.
664 if (!cpu_has(c
, X86_FEATURE_DTS
))
668 /* Check the microcode version of the CPU */
669 if (chk_ucode_version(cpu
))
673 * Alright, we have DTS support.
674 * We are bringing the _first_ core in this pkg
675 * online. So, initialize per-pkg data structures and
676 * then bring this core online.
678 err
= coretemp_device_add(cpu
);
682 * Check whether pkgtemp support is available.
683 * If so, add interfaces for pkgtemp.
685 if (cpu_has(c
, X86_FEATURE_PTS
))
686 coretemp_add_core(cpu
, 1);
689 * Physical CPU device already exists.
690 * So, just add interfaces for this core.
692 coretemp_add_core(cpu
, 0);
695 static void __cpuinit
put_core_offline(unsigned int cpu
)
698 struct platform_data
*pdata
;
699 struct platform_device
*pdev
= coretemp_get_pdev(cpu
);
701 /* If the physical CPU device does not exist, just return */
705 pdata
= platform_get_drvdata(pdev
);
707 indx
= TO_ATTR_NO(cpu
);
709 if (pdata
->core_data
[indx
] && pdata
->core_data
[indx
]->cpu
== cpu
)
710 coretemp_remove_core(pdata
, &pdev
->dev
, indx
);
713 * If a HT sibling of a core is taken offline, but another HT sibling
714 * of the same core is still online, register the alternate sibling.
715 * This ensures that exactly one set of attributes is provided as long
716 * as at least one HT sibling of a core is online.
718 for_each_sibling(i
, cpu
) {
722 * Display temperature sensor data for one HT sibling
723 * per core only, so abort the loop after one such
724 * sibling has been found.
730 * If all cores in this pkg are offline, remove the device.
731 * coretemp_device_remove calls unregister_platform_device,
732 * which in turn calls coretemp_remove. This removes the
733 * pkgtemp entry and does other clean ups.
735 if (!is_any_core_online(pdata
))
736 coretemp_device_remove(cpu
);
739 static int __cpuinit
coretemp_cpu_callback(struct notifier_block
*nfb
,
740 unsigned long action
, void *hcpu
)
742 unsigned int cpu
= (unsigned long) hcpu
;
746 case CPU_DOWN_FAILED
:
747 get_core_online(cpu
);
749 case CPU_DOWN_PREPARE
:
750 put_core_offline(cpu
);
756 static struct notifier_block coretemp_cpu_notifier __refdata
= {
757 .notifier_call
= coretemp_cpu_callback
,
760 static int __init
coretemp_init(void)
762 int i
, err
= -ENODEV
;
764 /* quick check if we run Intel */
765 if (cpu_data(0).x86_vendor
!= X86_VENDOR_INTEL
)
768 err
= platform_driver_register(&coretemp_driver
);
772 for_each_online_cpu(i
)
775 #ifndef CONFIG_HOTPLUG_CPU
776 if (list_empty(&pdev_list
)) {
778 goto exit_driver_unreg
;
782 register_hotcpu_notifier(&coretemp_cpu_notifier
);
785 #ifndef CONFIG_HOTPLUG_CPU
787 platform_driver_unregister(&coretemp_driver
);
793 static void __exit
coretemp_exit(void)
795 struct pdev_entry
*p
, *n
;
797 unregister_hotcpu_notifier(&coretemp_cpu_notifier
);
798 mutex_lock(&pdev_list_mutex
);
799 list_for_each_entry_safe(p
, n
, &pdev_list
, list
) {
800 platform_device_unregister(p
->pdev
);
804 mutex_unlock(&pdev_list_mutex
);
805 platform_driver_unregister(&coretemp_driver
);
808 MODULE_AUTHOR("Rudolf Marek <r.marek@assembler.cz>");
809 MODULE_DESCRIPTION("Intel Core temperature monitor");
810 MODULE_LICENSE("GPL");
812 module_init(coretemp_init
)
813 module_exit(coretemp_exit
)