USB: cp210x: call generic open last in open
[zen-stable.git] / arch / x86 / kernel / microcode_core.c
blobfda91c307104aff283f083a1ea0797b5f7971f91
1 /*
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/Assets/PDF/manual/253668.pdf
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>
25 * Initial release.
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
68 * in kernel memory.
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.
74 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
76 #include <linux/platform_device.h>
77 #include <linux/miscdevice.h>
78 #include <linux/capability.h>
79 #include <linux/kernel.h>
80 #include <linux/module.h>
81 #include <linux/mutex.h>
82 #include <linux/cpu.h>
83 #include <linux/fs.h>
84 #include <linux/mm.h>
85 #include <linux/syscore_ops.h>
87 #include <asm/microcode.h>
88 #include <asm/processor.h>
90 MODULE_DESCRIPTION("Microcode Update Driver");
91 MODULE_AUTHOR("Tigran Aivazian <tigran@aivazian.fsnet.co.uk>");
92 MODULE_LICENSE("GPL");
94 #define MICROCODE_VERSION "2.00"
96 static struct microcode_ops *microcode_ops;
99 * Synchronization.
101 * All non cpu-hotplug-callback call sites use:
103 * - microcode_mutex to synchronize with each other;
104 * - get/put_online_cpus() to synchronize with
105 * the cpu-hotplug-callback call sites.
107 * We guarantee that only a single cpu is being
108 * updated at any particular moment of time.
110 static DEFINE_MUTEX(microcode_mutex);
112 struct ucode_cpu_info ucode_cpu_info[NR_CPUS];
113 EXPORT_SYMBOL_GPL(ucode_cpu_info);
116 * Operations that are run on a target cpu:
119 struct cpu_info_ctx {
120 struct cpu_signature *cpu_sig;
121 int err;
124 static void collect_cpu_info_local(void *arg)
126 struct cpu_info_ctx *ctx = arg;
128 ctx->err = microcode_ops->collect_cpu_info(smp_processor_id(),
129 ctx->cpu_sig);
132 static int collect_cpu_info_on_target(int cpu, struct cpu_signature *cpu_sig)
134 struct cpu_info_ctx ctx = { .cpu_sig = cpu_sig, .err = 0 };
135 int ret;
137 ret = smp_call_function_single(cpu, collect_cpu_info_local, &ctx, 1);
138 if (!ret)
139 ret = ctx.err;
141 return ret;
144 static int collect_cpu_info(int cpu)
146 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
147 int ret;
149 memset(uci, 0, sizeof(*uci));
151 ret = collect_cpu_info_on_target(cpu, &uci->cpu_sig);
152 if (!ret)
153 uci->valid = 1;
155 return ret;
158 struct apply_microcode_ctx {
159 int err;
162 static void apply_microcode_local(void *arg)
164 struct apply_microcode_ctx *ctx = arg;
166 ctx->err = microcode_ops->apply_microcode(smp_processor_id());
169 static int apply_microcode_on_target(int cpu)
171 struct apply_microcode_ctx ctx = { .err = 0 };
172 int ret;
174 ret = smp_call_function_single(cpu, apply_microcode_local, &ctx, 1);
175 if (!ret)
176 ret = ctx.err;
178 return ret;
181 #ifdef CONFIG_MICROCODE_OLD_INTERFACE
182 static int do_microcode_update(const void __user *buf, size_t size)
184 int error = 0;
185 int cpu;
187 for_each_online_cpu(cpu) {
188 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
189 enum ucode_state ustate;
191 if (!uci->valid)
192 continue;
194 ustate = microcode_ops->request_microcode_user(cpu, buf, size);
195 if (ustate == UCODE_ERROR) {
196 error = -1;
197 break;
198 } else if (ustate == UCODE_OK)
199 apply_microcode_on_target(cpu);
202 return error;
205 static int microcode_open(struct inode *inode, struct file *file)
207 return capable(CAP_SYS_RAWIO) ? nonseekable_open(inode, file) : -EPERM;
210 static ssize_t microcode_write(struct file *file, const char __user *buf,
211 size_t len, loff_t *ppos)
213 ssize_t ret = -EINVAL;
215 if ((len >> PAGE_SHIFT) > totalram_pages) {
216 pr_err("too much data (max %ld pages)\n", totalram_pages);
217 return ret;
220 get_online_cpus();
221 mutex_lock(&microcode_mutex);
223 if (do_microcode_update(buf, len) == 0)
224 ret = (ssize_t)len;
226 mutex_unlock(&microcode_mutex);
227 put_online_cpus();
229 return ret;
232 static const struct file_operations microcode_fops = {
233 .owner = THIS_MODULE,
234 .write = microcode_write,
235 .open = microcode_open,
236 .llseek = no_llseek,
239 static struct miscdevice microcode_dev = {
240 .minor = MICROCODE_MINOR,
241 .name = "microcode",
242 .nodename = "cpu/microcode",
243 .fops = &microcode_fops,
246 static int __init microcode_dev_init(void)
248 int error;
250 error = misc_register(&microcode_dev);
251 if (error) {
252 pr_err("can't misc_register on minor=%d\n", MICROCODE_MINOR);
253 return error;
256 return 0;
259 static void __exit microcode_dev_exit(void)
261 misc_deregister(&microcode_dev);
264 MODULE_ALIAS_MISCDEV(MICROCODE_MINOR);
265 MODULE_ALIAS("devname:cpu/microcode");
266 #else
267 #define microcode_dev_init() 0
268 #define microcode_dev_exit() do { } while (0)
269 #endif
271 /* fake device for request_firmware */
272 static struct platform_device *microcode_pdev;
274 static int reload_for_cpu(int cpu)
276 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
277 int err = 0;
279 mutex_lock(&microcode_mutex);
280 if (uci->valid) {
281 enum ucode_state ustate;
283 ustate = microcode_ops->request_microcode_fw(cpu, &microcode_pdev->dev);
284 if (ustate == UCODE_OK)
285 apply_microcode_on_target(cpu);
286 else
287 if (ustate == UCODE_ERROR)
288 err = -EINVAL;
290 mutex_unlock(&microcode_mutex);
292 return err;
295 static ssize_t reload_store(struct device *dev,
296 struct device_attribute *attr,
297 const char *buf, size_t size)
299 unsigned long val;
300 int cpu = dev->id;
301 int ret = 0;
302 char *end;
304 val = simple_strtoul(buf, &end, 0);
305 if (end == buf)
306 return -EINVAL;
308 if (val == 1) {
309 get_online_cpus();
310 if (cpu_online(cpu))
311 ret = reload_for_cpu(cpu);
312 put_online_cpus();
315 if (!ret)
316 ret = size;
318 return ret;
321 static ssize_t version_show(struct device *dev,
322 struct device_attribute *attr, char *buf)
324 struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
326 return sprintf(buf, "0x%x\n", uci->cpu_sig.rev);
329 static ssize_t pf_show(struct device *dev,
330 struct device_attribute *attr, char *buf)
332 struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
334 return sprintf(buf, "0x%x\n", uci->cpu_sig.pf);
337 static DEVICE_ATTR(reload, 0200, NULL, reload_store);
338 static DEVICE_ATTR(version, 0400, version_show, NULL);
339 static DEVICE_ATTR(processor_flags, 0400, pf_show, NULL);
341 static struct attribute *mc_default_attrs[] = {
342 &dev_attr_reload.attr,
343 &dev_attr_version.attr,
344 &dev_attr_processor_flags.attr,
345 NULL
348 static struct attribute_group mc_attr_group = {
349 .attrs = mc_default_attrs,
350 .name = "microcode",
353 static void microcode_fini_cpu(int cpu)
355 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
357 microcode_ops->microcode_fini_cpu(cpu);
358 uci->valid = 0;
361 static enum ucode_state microcode_resume_cpu(int cpu)
363 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
365 if (!uci->mc)
366 return UCODE_NFOUND;
368 pr_debug("CPU%d updated upon resume\n", cpu);
369 apply_microcode_on_target(cpu);
371 return UCODE_OK;
374 static enum ucode_state microcode_init_cpu(int cpu)
376 enum ucode_state ustate;
378 if (collect_cpu_info(cpu))
379 return UCODE_ERROR;
381 /* --dimm. Trigger a delayed update? */
382 if (system_state != SYSTEM_RUNNING)
383 return UCODE_NFOUND;
385 ustate = microcode_ops->request_microcode_fw(cpu, &microcode_pdev->dev);
387 if (ustate == UCODE_OK) {
388 pr_debug("CPU%d updated upon init\n", cpu);
389 apply_microcode_on_target(cpu);
392 return ustate;
395 static enum ucode_state microcode_update_cpu(int cpu)
397 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
398 enum ucode_state ustate;
400 if (uci->valid)
401 ustate = microcode_resume_cpu(cpu);
402 else
403 ustate = microcode_init_cpu(cpu);
405 return ustate;
408 static int mc_device_add(struct device *dev, struct subsys_interface *sif)
410 int err, cpu = dev->id;
412 if (!cpu_online(cpu))
413 return 0;
415 pr_debug("CPU%d added\n", cpu);
417 err = sysfs_create_group(&dev->kobj, &mc_attr_group);
418 if (err)
419 return err;
421 if (microcode_init_cpu(cpu) == UCODE_ERROR) {
422 sysfs_remove_group(&dev->kobj, &mc_attr_group);
423 return -EINVAL;
426 return err;
429 static int mc_device_remove(struct device *dev, struct subsys_interface *sif)
431 int cpu = dev->id;
433 if (!cpu_online(cpu))
434 return 0;
436 pr_debug("CPU%d removed\n", cpu);
437 microcode_fini_cpu(cpu);
438 sysfs_remove_group(&dev->kobj, &mc_attr_group);
439 return 0;
442 static struct subsys_interface mc_cpu_interface = {
443 .name = "microcode",
444 .subsys = &cpu_subsys,
445 .add_dev = mc_device_add,
446 .remove_dev = mc_device_remove,
450 * mc_bp_resume - Update boot CPU microcode during resume.
452 static void mc_bp_resume(void)
454 int cpu = smp_processor_id();
455 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
457 if (uci->valid && uci->mc)
458 microcode_ops->apply_microcode(cpu);
461 static struct syscore_ops mc_syscore_ops = {
462 .resume = mc_bp_resume,
465 static __cpuinit int
466 mc_cpu_callback(struct notifier_block *nb, unsigned long action, void *hcpu)
468 unsigned int cpu = (unsigned long)hcpu;
469 struct device *dev;
471 dev = get_cpu_device(cpu);
472 switch (action) {
473 case CPU_ONLINE:
474 case CPU_ONLINE_FROZEN:
475 microcode_update_cpu(cpu);
476 case CPU_DOWN_FAILED:
477 case CPU_DOWN_FAILED_FROZEN:
478 pr_debug("CPU%d added\n", cpu);
479 if (sysfs_create_group(&dev->kobj, &mc_attr_group))
480 pr_err("Failed to create group for CPU%d\n", cpu);
481 break;
482 case CPU_DOWN_PREPARE:
483 case CPU_DOWN_PREPARE_FROZEN:
484 /* Suspend is in progress, only remove the interface */
485 sysfs_remove_group(&dev->kobj, &mc_attr_group);
486 pr_debug("CPU%d removed\n", cpu);
487 break;
490 * When a CPU goes offline, don't free up or invalidate the copy of
491 * the microcode in kernel memory, so that we can reuse it when the
492 * CPU comes back online without unnecessarily requesting the userspace
493 * for it again.
495 case CPU_UP_CANCELED_FROZEN:
496 /* The CPU refused to come up during a system resume */
497 microcode_fini_cpu(cpu);
498 break;
500 return NOTIFY_OK;
503 static struct notifier_block __refdata mc_cpu_notifier = {
504 .notifier_call = mc_cpu_callback,
507 static int __init microcode_init(void)
509 struct cpuinfo_x86 *c = &cpu_data(0);
510 int error;
512 if (c->x86_vendor == X86_VENDOR_INTEL)
513 microcode_ops = init_intel_microcode();
514 else if (c->x86_vendor == X86_VENDOR_AMD)
515 microcode_ops = init_amd_microcode();
517 if (!microcode_ops) {
518 pr_err("no support for this CPU vendor\n");
519 return -ENODEV;
522 microcode_pdev = platform_device_register_simple("microcode", -1,
523 NULL, 0);
524 if (IS_ERR(microcode_pdev))
525 return PTR_ERR(microcode_pdev);
527 get_online_cpus();
528 mutex_lock(&microcode_mutex);
530 error = subsys_interface_register(&mc_cpu_interface);
532 mutex_unlock(&microcode_mutex);
533 put_online_cpus();
535 if (error)
536 goto out_pdev;
538 error = microcode_dev_init();
539 if (error)
540 goto out_driver;
542 register_syscore_ops(&mc_syscore_ops);
543 register_hotcpu_notifier(&mc_cpu_notifier);
545 pr_info("Microcode Update Driver: v" MICROCODE_VERSION
546 " <tigran@aivazian.fsnet.co.uk>, Peter Oruba\n");
548 return 0;
550 out_driver:
551 get_online_cpus();
552 mutex_lock(&microcode_mutex);
554 subsys_interface_unregister(&mc_cpu_interface);
556 mutex_unlock(&microcode_mutex);
557 put_online_cpus();
559 out_pdev:
560 platform_device_unregister(microcode_pdev);
561 return error;
564 module_init(microcode_init);
566 static void __exit microcode_exit(void)
568 struct cpuinfo_x86 *c = &cpu_data(0);
570 microcode_dev_exit();
572 unregister_hotcpu_notifier(&mc_cpu_notifier);
573 unregister_syscore_ops(&mc_syscore_ops);
575 get_online_cpus();
576 mutex_lock(&microcode_mutex);
578 subsys_interface_unregister(&mc_cpu_interface);
580 mutex_unlock(&microcode_mutex);
581 put_online_cpus();
583 platform_device_unregister(microcode_pdev);
585 microcode_ops = NULL;
587 if (c->x86_vendor == X86_VENDOR_AMD)
588 exit_amd_microcode();
590 pr_info("Microcode Update Driver: v" MICROCODE_VERSION " removed.\n");
592 module_exit(microcode_exit);