2 * pkgtemp.c - Linux kernel module for processor package hardware monitoring
4 * Copyright (C) 2010 Fenghua Yu <fenghua.yu@intel.com>
6 * Inspired from many hwmon drivers especially coretemp.
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 #include <linux/module.h>
24 #include <linux/delay.h>
25 #include <linux/init.h>
26 #include <linux/slab.h>
27 #include <linux/jiffies.h>
28 #include <linux/hwmon.h>
29 #include <linux/sysfs.h>
30 #include <linux/hwmon-sysfs.h>
31 #include <linux/err.h>
32 #include <linux/mutex.h>
33 #include <linux/list.h>
34 #include <linux/platform_device.h>
35 #include <linux/cpu.h>
37 #include <asm/processor.h>
39 #define DRVNAME "pkgtemp"
41 enum { SHOW_TEMP, SHOW_TJMAX, SHOW_TTARGET, SHOW_LABEL, SHOW_NAME };
44 * Functions declaration
47 static struct pkgtemp_data *pkgtemp_update_device(struct device *dev);
50 struct device *hwmon_dev;
51 struct mutex update_lock;
55 char valid; /* zero until following fields are valid */
56 unsigned long last_updated; /* in jiffies */
67 static ssize_t show_name(struct device *dev, struct device_attribute
71 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
72 struct pkgtemp_data *data = dev_get_drvdata(dev);
74 if (attr->index == SHOW_NAME)
75 ret = sprintf(buf, "%s\n", data->name);
77 ret = sprintf(buf, "physical id %d\n",
82 static ssize_t show_alarm(struct device *dev, struct device_attribute
85 struct pkgtemp_data *data = pkgtemp_update_device(dev);
86 /* read the Out-of-spec log, never clear */
87 return sprintf(buf, "%d\n", data->alarm);
90 static ssize_t show_temp(struct device *dev,
91 struct device_attribute *devattr, char *buf)
93 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
94 struct pkgtemp_data *data = pkgtemp_update_device(dev);
97 if (attr->index == SHOW_TEMP)
98 err = data->valid ? sprintf(buf, "%d\n", data->temp) : -EAGAIN;
99 else if (attr->index == SHOW_TJMAX)
100 err = sprintf(buf, "%d\n", data->tjmax);
102 err = sprintf(buf, "%d\n", data->ttarget);
106 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, SHOW_TEMP);
107 static SENSOR_DEVICE_ATTR(temp1_crit, S_IRUGO, show_temp, NULL, SHOW_TJMAX);
108 static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, SHOW_TTARGET);
109 static DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL);
110 static SENSOR_DEVICE_ATTR(temp1_label, S_IRUGO, show_name, NULL, SHOW_LABEL);
111 static SENSOR_DEVICE_ATTR(name, S_IRUGO, show_name, NULL, SHOW_NAME);
113 static struct attribute *pkgtemp_attributes[] = {
114 &sensor_dev_attr_name.dev_attr.attr,
115 &sensor_dev_attr_temp1_label.dev_attr.attr,
116 &dev_attr_temp1_crit_alarm.attr,
117 &sensor_dev_attr_temp1_input.dev_attr.attr,
118 &sensor_dev_attr_temp1_crit.dev_attr.attr,
122 static const struct attribute_group pkgtemp_group = {
123 .attrs = pkgtemp_attributes,
126 static struct pkgtemp_data *pkgtemp_update_device(struct device *dev)
128 struct pkgtemp_data *data = dev_get_drvdata(dev);
132 mutex_lock(&data->update_lock);
134 if (!data->valid || time_after(jiffies, data->last_updated + HZ)) {
139 err = rdmsr_on_cpu(cpu, MSR_IA32_PACKAGE_THERM_STATUS,
142 data->alarm = (eax >> 5) & 1;
143 data->temp = data->tjmax - (((eax >> 16)
147 dev_dbg(dev, "Temperature data invalid (0x%x)\n", eax);
149 data->last_updated = jiffies;
152 mutex_unlock(&data->update_lock);
156 static int get_tjmax(int cpu, struct device *dev)
158 int default_tjmax = 100000;
163 /* IA32_TEMPERATURE_TARGET contains the TjMax value */
164 err = rdmsr_safe_on_cpu(cpu, MSR_IA32_TEMPERATURE_TARGET, &eax, &edx);
166 val = (eax >> 16) & 0xff;
167 if ((val > 80) && (val < 120)) {
168 dev_info(dev, "TjMax is %d C.\n", val);
172 dev_warn(dev, "Unable to read TjMax from CPU.\n");
173 return default_tjmax;
176 static int __devinit pkgtemp_probe(struct platform_device *pdev)
178 struct pkgtemp_data *data;
182 struct cpuinfo_x86 *c = &cpu_data(pdev->id);
185 data = kzalloc(sizeof(struct pkgtemp_data), GFP_KERNEL);
188 dev_err(&pdev->dev, "Out of memory\n");
194 data->phys_proc_id = c->phys_proc_id;
196 data->name = "pkgtemp";
197 mutex_init(&data->update_lock);
199 /* test if we can access the THERM_STATUS MSR */
200 err = rdmsr_safe_on_cpu(data->id, MSR_IA32_PACKAGE_THERM_STATUS,
204 "Unable to access THERM_STATUS MSR, giving up\n");
208 data->tjmax = get_tjmax(data->id, &pdev->dev);
209 platform_set_drvdata(pdev, data);
211 err = rdmsr_safe_on_cpu(data->id, MSR_IA32_TEMPERATURE_TARGET,
214 dev_warn(&pdev->dev, "Unable to read"
215 " IA32_TEMPERATURE_TARGET MSR\n");
217 data->ttarget = data->tjmax - (((eax >> 8) & 0xff) * 1000);
218 err = device_create_file(&pdev->dev,
219 &sensor_dev_attr_temp1_max.dev_attr);
224 err = sysfs_create_group(&pdev->dev.kobj, &pkgtemp_group);
228 data->hwmon_dev = hwmon_device_register(&pdev->dev);
229 if (IS_ERR(data->hwmon_dev)) {
230 err = PTR_ERR(data->hwmon_dev);
231 dev_err(&pdev->dev, "Class registration failed (%d)\n",
239 sysfs_remove_group(&pdev->dev.kobj, &pkgtemp_group);
241 device_remove_file(&pdev->dev, &sensor_dev_attr_temp1_max.dev_attr);
248 static int __devexit pkgtemp_remove(struct platform_device *pdev)
250 struct pkgtemp_data *data = platform_get_drvdata(pdev);
252 hwmon_device_unregister(data->hwmon_dev);
253 sysfs_remove_group(&pdev->dev.kobj, &pkgtemp_group);
254 device_remove_file(&pdev->dev, &sensor_dev_attr_temp1_max.dev_attr);
255 platform_set_drvdata(pdev, NULL);
260 static struct platform_driver pkgtemp_driver = {
262 .owner = THIS_MODULE,
265 .probe = pkgtemp_probe,
266 .remove = __devexit_p(pkgtemp_remove),
270 struct list_head list;
271 struct platform_device *pdev;
278 static LIST_HEAD(pdev_list);
279 static DEFINE_MUTEX(pdev_list_mutex);
281 static int __cpuinit pkgtemp_device_add(unsigned int cpu)
284 struct platform_device *pdev;
285 struct pdev_entry *pdev_entry;
286 struct cpuinfo_x86 *c = &cpu_data(cpu);
288 if (!cpu_has(c, X86_FEATURE_PTS))
291 mutex_lock(&pdev_list_mutex);
294 /* Only keep the first entry in each package */
295 list_for_each_entry(pdev_entry, &pdev_list, list) {
296 if (c->phys_proc_id == pdev_entry->phys_proc_id) {
297 err = 0; /* Not an error */
303 pdev = platform_device_alloc(DRVNAME, cpu);
306 printk(KERN_ERR DRVNAME ": Device allocation failed\n");
310 pdev_entry = kzalloc(sizeof(struct pdev_entry), GFP_KERNEL);
313 goto exit_device_put;
316 err = platform_device_add(pdev);
318 printk(KERN_ERR DRVNAME ": Device addition failed (%d)\n",
320 goto exit_device_free;
324 pdev_entry->phys_proc_id = c->phys_proc_id;
326 pdev_entry->pdev = pdev;
327 pdev_entry->cpu = cpu;
328 list_add_tail(&pdev_entry->list, &pdev_list);
329 mutex_unlock(&pdev_list_mutex);
336 platform_device_put(pdev);
338 mutex_unlock(&pdev_list_mutex);
342 #ifdef CONFIG_HOTPLUG_CPU
343 static void pkgtemp_device_remove(unsigned int cpu)
345 struct pdev_entry *p;
349 mutex_lock(&pdev_list_mutex);
350 list_for_each_entry(p, &pdev_list, list) {
354 platform_device_unregister(p->pdev);
356 mutex_unlock(&pdev_list_mutex);
358 for_each_cpu(i, cpu_core_mask(cpu)) {
360 err = pkgtemp_device_add(i);
367 mutex_unlock(&pdev_list_mutex);
370 static int __cpuinit pkgtemp_cpu_callback(struct notifier_block *nfb,
371 unsigned long action, void *hcpu)
373 unsigned int cpu = (unsigned long) hcpu;
377 case CPU_DOWN_FAILED:
378 pkgtemp_device_add(cpu);
380 case CPU_DOWN_PREPARE:
381 pkgtemp_device_remove(cpu);
387 static struct notifier_block pkgtemp_cpu_notifier __refdata = {
388 .notifier_call = pkgtemp_cpu_callback,
390 #endif /* !CONFIG_HOTPLUG_CPU */
392 static int __init pkgtemp_init(void)
394 int i, err = -ENODEV;
395 struct pdev_entry *p, *n;
397 /* quick check if we run Intel */
398 if (cpu_data(0).x86_vendor != X86_VENDOR_INTEL)
401 err = platform_driver_register(&pkgtemp_driver);
405 for_each_online_cpu(i) {
406 err = pkgtemp_device_add(i);
408 goto exit_devices_unreg;
410 if (list_empty(&pdev_list)) {
412 goto exit_driver_unreg;
415 #ifdef CONFIG_HOTPLUG_CPU
416 register_hotcpu_notifier(&pkgtemp_cpu_notifier);
421 mutex_lock(&pdev_list_mutex);
422 list_for_each_entry_safe(p, n, &pdev_list, list) {
423 platform_device_unregister(p->pdev);
427 mutex_unlock(&pdev_list_mutex);
429 platform_driver_unregister(&pkgtemp_driver);
434 static void __exit pkgtemp_exit(void)
436 struct pdev_entry *p, *n;
437 #ifdef CONFIG_HOTPLUG_CPU
438 unregister_hotcpu_notifier(&pkgtemp_cpu_notifier);
440 mutex_lock(&pdev_list_mutex);
441 list_for_each_entry_safe(p, n, &pdev_list, list) {
442 platform_device_unregister(p->pdev);
446 mutex_unlock(&pdev_list_mutex);
447 platform_driver_unregister(&pkgtemp_driver);
450 MODULE_AUTHOR("Fenghua Yu <fenghua.yu@intel.com>");
451 MODULE_DESCRIPTION("Intel processor package temperature monitor");
452 MODULE_LICENSE("GPL");
454 module_init(pkgtemp_init)
455 module_exit(pkgtemp_exit)