2 * Intel CPU Microcode Update Driver for Linux
4 * Copyright (C) 2000-2006 Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
5 * 2006 Shaohua Li <shaohua.li@intel.com>
7 * This driver allows to upgrade microcode on Intel processors
8 * belonging to IA-32 family - PentiumPro, Pentium II,
9 * Pentium III, Xeon, Pentium 4, etc.
11 * Reference: Section 8.11 of Volume 3a, IA-32 Intel? Architecture
12 * Software Developer's Manual
13 * Order Number 253668 or free download from:
15 * http://developer.intel.com/design/pentium4/manuals/253668.htm
17 * For more information, go to http://www.urbanmyth.org/microcode
19 * This program is free software; you can redistribute it and/or
20 * modify it under the terms of the GNU General Public License
21 * as published by the Free Software Foundation; either version
22 * 2 of the License, or (at your option) any later version.
24 * 1.0 16 Feb 2000, Tigran Aivazian <tigran@sco.com>
26 * 1.01 18 Feb 2000, Tigran Aivazian <tigran@sco.com>
27 * Added read() support + cleanups.
28 * 1.02 21 Feb 2000, Tigran Aivazian <tigran@sco.com>
29 * Added 'device trimming' support. open(O_WRONLY) zeroes
30 * and frees the saved copy of applied microcode.
31 * 1.03 29 Feb 2000, Tigran Aivazian <tigran@sco.com>
32 * Made to use devfs (/dev/cpu/microcode) + cleanups.
33 * 1.04 06 Jun 2000, Simon Trimmer <simon@veritas.com>
34 * Added misc device support (now uses both devfs and misc).
35 * Added MICROCODE_IOCFREE ioctl to clear memory.
36 * 1.05 09 Jun 2000, Simon Trimmer <simon@veritas.com>
37 * Messages for error cases (non Intel & no suitable microcode).
38 * 1.06 03 Aug 2000, Tigran Aivazian <tigran@veritas.com>
39 * Removed ->release(). Removed exclusive open and status bitmap.
40 * Added microcode_rwsem to serialize read()/write()/ioctl().
41 * Removed global kernel lock usage.
42 * 1.07 07 Sep 2000, Tigran Aivazian <tigran@veritas.com>
43 * Write 0 to 0x8B msr and then cpuid before reading revision,
44 * so that it works even if there were no update done by the
45 * BIOS. Otherwise, reading from 0x8B gives junk (which happened
46 * to be 0 on my machine which is why it worked even when I
47 * disabled update by the BIOS)
48 * Thanks to Eric W. Biederman <ebiederman@lnxi.com> for the fix.
49 * 1.08 11 Dec 2000, Richard Schaal <richard.schaal@intel.com> and
50 * Tigran Aivazian <tigran@veritas.com>
51 * Intel Pentium 4 processor support and bugfixes.
52 * 1.09 30 Oct 2001, Tigran Aivazian <tigran@veritas.com>
53 * Bugfix for HT (Hyper-Threading) enabled processors
54 * whereby processor resources are shared by all logical processors
55 * in a single CPU package.
56 * 1.10 28 Feb 2002 Asit K Mallick <asit.k.mallick@intel.com> and
57 * Tigran Aivazian <tigran@veritas.com>,
58 * Serialize updates as required on HT processors due to
59 * speculative nature of implementation.
60 * 1.11 22 Mar 2002 Tigran Aivazian <tigran@veritas.com>
61 * Fix the panic when writing zero-length microcode chunk.
62 * 1.12 29 Sep 2003 Nitin Kamble <nitin.a.kamble@intel.com>,
63 * Jun Nakajima <jun.nakajima@intel.com>
64 * Support for the microcode updates in the new format.
65 * 1.13 10 Oct 2003 Tigran Aivazian <tigran@veritas.com>
66 * Removed ->read() method and obsoleted MICROCODE_IOCFREE ioctl
67 * because we no longer hold a copy of applied microcode
69 * 1.14 25 Jun 2004 Tigran Aivazian <tigran@veritas.com>
70 * Fix sigmatch() macro to handle old CPUs with pf == 0.
71 * Thanks to Stuart Swales for pointing out this bug.
73 #include <linux/platform_device.h>
74 #include <linux/miscdevice.h>
75 #include <linux/capability.h>
76 #include <linux/smp_lock.h>
77 #include <linux/kernel.h>
78 #include <linux/module.h>
79 #include <linux/mutex.h>
80 #include <linux/cpu.h>
84 #include <asm/microcode.h>
85 #include <asm/processor.h>
87 MODULE_DESCRIPTION("Microcode Update Driver");
88 MODULE_AUTHOR("Tigran Aivazian <tigran@aivazian.fsnet.co.uk>");
89 MODULE_LICENSE("GPL");
91 #define MICROCODE_VERSION "2.00"
93 static struct microcode_ops
*microcode_ops
;
98 * All non cpu-hotplug-callback call sites use:
100 * - microcode_mutex to synchronize with each other;
101 * - get/put_online_cpus() to synchronize with
102 * the cpu-hotplug-callback call sites.
104 * We guarantee that only a single cpu is being
105 * updated at any particular moment of time.
107 static DEFINE_MUTEX(microcode_mutex
);
109 struct ucode_cpu_info ucode_cpu_info
[NR_CPUS
];
110 EXPORT_SYMBOL_GPL(ucode_cpu_info
);
113 * Operations that are run on a target cpu:
116 struct cpu_info_ctx
{
117 struct cpu_signature
*cpu_sig
;
121 static void collect_cpu_info_local(void *arg
)
123 struct cpu_info_ctx
*ctx
= arg
;
125 ctx
->err
= microcode_ops
->collect_cpu_info(smp_processor_id(),
129 static int collect_cpu_info_on_target(int cpu
, struct cpu_signature
*cpu_sig
)
131 struct cpu_info_ctx ctx
= { .cpu_sig
= cpu_sig
, .err
= 0 };
134 ret
= smp_call_function_single(cpu
, collect_cpu_info_local
, &ctx
, 1);
141 static int collect_cpu_info(int cpu
)
143 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
146 memset(uci
, 0, sizeof(*uci
));
148 ret
= collect_cpu_info_on_target(cpu
, &uci
->cpu_sig
);
155 struct apply_microcode_ctx
{
159 static void apply_microcode_local(void *arg
)
161 struct apply_microcode_ctx
*ctx
= arg
;
163 ctx
->err
= microcode_ops
->apply_microcode(smp_processor_id());
166 static int apply_microcode_on_target(int cpu
)
168 struct apply_microcode_ctx ctx
= { .err
= 0 };
171 ret
= smp_call_function_single(cpu
, apply_microcode_local
, &ctx
, 1);
178 #ifdef CONFIG_MICROCODE_OLD_INTERFACE
179 static int do_microcode_update(const void __user
*buf
, size_t size
)
184 for_each_online_cpu(cpu
) {
185 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
186 enum ucode_state ustate
;
191 ustate
= microcode_ops
->request_microcode_user(cpu
, buf
, size
);
192 if (ustate
== UCODE_ERROR
) {
195 } else if (ustate
== UCODE_OK
)
196 apply_microcode_on_target(cpu
);
202 static int microcode_open(struct inode
*unused1
, struct file
*unused2
)
205 return capable(CAP_SYS_RAWIO
) ? 0 : -EPERM
;
208 static ssize_t
microcode_write(struct file
*file
, const char __user
*buf
,
209 size_t len
, loff_t
*ppos
)
211 ssize_t ret
= -EINVAL
;
213 if ((len
>> PAGE_SHIFT
) > num_physpages
) {
214 pr_err("microcode: too much data (max %ld pages)\n", num_physpages
);
219 mutex_lock(µcode_mutex
);
221 if (do_microcode_update(buf
, len
) == 0)
224 mutex_unlock(µcode_mutex
);
230 static const struct file_operations microcode_fops
= {
231 .owner
= THIS_MODULE
,
232 .write
= microcode_write
,
233 .open
= microcode_open
,
236 static struct miscdevice microcode_dev
= {
237 .minor
= MICROCODE_MINOR
,
239 .devnode
= "cpu/microcode",
240 .fops
= µcode_fops
,
243 static int __init
microcode_dev_init(void)
247 error
= misc_register(µcode_dev
);
249 pr_err("microcode: can't misc_register on minor=%d\n", MICROCODE_MINOR
);
256 static void microcode_dev_exit(void)
258 misc_deregister(µcode_dev
);
261 MODULE_ALIAS_MISCDEV(MICROCODE_MINOR
);
263 #define microcode_dev_init() 0
264 #define microcode_dev_exit() do { } while (0)
267 /* fake device for request_firmware */
268 static struct platform_device
*microcode_pdev
;
270 static int reload_for_cpu(int cpu
)
272 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
275 mutex_lock(µcode_mutex
);
277 enum ucode_state ustate
;
279 ustate
= microcode_ops
->request_microcode_fw(cpu
, µcode_pdev
->dev
);
280 if (ustate
== UCODE_OK
)
281 apply_microcode_on_target(cpu
);
283 if (ustate
== UCODE_ERROR
)
286 mutex_unlock(µcode_mutex
);
291 static ssize_t
reload_store(struct sys_device
*dev
,
292 struct sysdev_attribute
*attr
,
293 const char *buf
, size_t size
)
300 val
= simple_strtoul(buf
, &end
, 0);
307 ret
= reload_for_cpu(cpu
);
317 static ssize_t
version_show(struct sys_device
*dev
,
318 struct sysdev_attribute
*attr
, char *buf
)
320 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ dev
->id
;
322 return sprintf(buf
, "0x%x\n", uci
->cpu_sig
.rev
);
325 static ssize_t
pf_show(struct sys_device
*dev
,
326 struct sysdev_attribute
*attr
, char *buf
)
328 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ dev
->id
;
330 return sprintf(buf
, "0x%x\n", uci
->cpu_sig
.pf
);
333 static SYSDEV_ATTR(reload
, 0200, NULL
, reload_store
);
334 static SYSDEV_ATTR(version
, 0400, version_show
, NULL
);
335 static SYSDEV_ATTR(processor_flags
, 0400, pf_show
, NULL
);
337 static struct attribute
*mc_default_attrs
[] = {
340 &attr_processor_flags
.attr
,
344 static struct attribute_group mc_attr_group
= {
345 .attrs
= mc_default_attrs
,
349 static void microcode_fini_cpu(int cpu
)
351 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
353 microcode_ops
->microcode_fini_cpu(cpu
);
357 static enum ucode_state
microcode_resume_cpu(int cpu
)
359 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
364 pr_debug("microcode: CPU%d updated upon resume\n", cpu
);
365 apply_microcode_on_target(cpu
);
370 static enum ucode_state
microcode_init_cpu(int cpu
)
372 enum ucode_state ustate
;
374 if (collect_cpu_info(cpu
))
377 /* --dimm. Trigger a delayed update? */
378 if (system_state
!= SYSTEM_RUNNING
)
381 ustate
= microcode_ops
->request_microcode_fw(cpu
, µcode_pdev
->dev
);
383 if (ustate
== UCODE_OK
) {
384 pr_debug("microcode: CPU%d updated upon init\n", cpu
);
385 apply_microcode_on_target(cpu
);
391 static enum ucode_state
microcode_update_cpu(int cpu
)
393 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
394 enum ucode_state ustate
;
397 ustate
= microcode_resume_cpu(cpu
);
399 ustate
= microcode_init_cpu(cpu
);
404 static int mc_sysdev_add(struct sys_device
*sys_dev
)
406 int err
, cpu
= sys_dev
->id
;
408 if (!cpu_online(cpu
))
411 pr_debug("microcode: CPU%d added\n", cpu
);
413 err
= sysfs_create_group(&sys_dev
->kobj
, &mc_attr_group
);
417 if (microcode_init_cpu(cpu
) == UCODE_ERROR
)
423 static int mc_sysdev_remove(struct sys_device
*sys_dev
)
425 int cpu
= sys_dev
->id
;
427 if (!cpu_online(cpu
))
430 pr_debug("microcode: CPU%d removed\n", cpu
);
431 microcode_fini_cpu(cpu
);
432 sysfs_remove_group(&sys_dev
->kobj
, &mc_attr_group
);
436 static int mc_sysdev_resume(struct sys_device
*dev
)
439 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
441 if (!cpu_online(cpu
))
445 * All non-bootup cpus are still disabled,
446 * so only CPU 0 will apply ucode here.
448 * Moreover, there can be no concurrent
449 * updates from any other places at this point.
453 if (uci
->valid
&& uci
->mc
)
454 microcode_ops
->apply_microcode(cpu
);
459 static struct sysdev_driver mc_sysdev_driver
= {
460 .add
= mc_sysdev_add
,
461 .remove
= mc_sysdev_remove
,
462 .resume
= mc_sysdev_resume
,
466 mc_cpu_callback(struct notifier_block
*nb
, unsigned long action
, void *hcpu
)
468 unsigned int cpu
= (unsigned long)hcpu
;
469 struct sys_device
*sys_dev
;
471 sys_dev
= get_cpu_sysdev(cpu
);
474 case CPU_ONLINE_FROZEN
:
475 microcode_update_cpu(cpu
);
476 case CPU_DOWN_FAILED
:
477 case CPU_DOWN_FAILED_FROZEN
:
478 pr_debug("microcode: CPU%d added\n", cpu
);
479 if (sysfs_create_group(&sys_dev
->kobj
, &mc_attr_group
))
480 pr_err("microcode: Failed to create group for CPU%d\n", cpu
);
482 case CPU_DOWN_PREPARE
:
483 case CPU_DOWN_PREPARE_FROZEN
:
484 /* Suspend is in progress, only remove the interface */
485 sysfs_remove_group(&sys_dev
->kobj
, &mc_attr_group
);
486 pr_debug("microcode: CPU%d removed\n", cpu
);
489 case CPU_UP_CANCELED_FROZEN
:
490 /* The CPU refused to come up during a system resume */
491 microcode_fini_cpu(cpu
);
497 static struct notifier_block __refdata mc_cpu_notifier
= {
498 .notifier_call
= mc_cpu_callback
,
501 static int __init
microcode_init(void)
503 struct cpuinfo_x86
*c
= &cpu_data(0);
506 if (c
->x86_vendor
== X86_VENDOR_INTEL
)
507 microcode_ops
= init_intel_microcode();
508 else if (c
->x86_vendor
== X86_VENDOR_AMD
)
509 microcode_ops
= init_amd_microcode();
511 if (!microcode_ops
) {
512 pr_err("microcode: no support for this CPU vendor\n");
516 microcode_pdev
= platform_device_register_simple("microcode", -1,
518 if (IS_ERR(microcode_pdev
)) {
519 microcode_dev_exit();
520 return PTR_ERR(microcode_pdev
);
524 mutex_lock(µcode_mutex
);
526 error
= sysdev_driver_register(&cpu_sysdev_class
, &mc_sysdev_driver
);
528 mutex_unlock(µcode_mutex
);
532 platform_device_unregister(microcode_pdev
);
536 error
= microcode_dev_init();
540 register_hotcpu_notifier(&mc_cpu_notifier
);
542 pr_info("Microcode Update Driver: v" MICROCODE_VERSION
543 " <tigran@aivazian.fsnet.co.uk>,"
548 module_init(microcode_init
);
550 static void __exit
microcode_exit(void)
552 microcode_dev_exit();
554 unregister_hotcpu_notifier(&mc_cpu_notifier
);
557 mutex_lock(µcode_mutex
);
559 sysdev_driver_unregister(&cpu_sysdev_class
, &mc_sysdev_driver
);
561 mutex_unlock(µcode_mutex
);
564 platform_device_unregister(microcode_pdev
);
566 microcode_ops
= NULL
;
568 pr_info("Microcode Update Driver: v" MICROCODE_VERSION
" removed.\n");
570 module_exit(microcode_exit
);