Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * CPU Microcode Update Driver for Linux
4 *
5 * Copyright (C) 2000-2006 Tigran Aivazian <aivazian.tigran@gmail.com>
6 * 2006 Shaohua Li <shaohua.li@intel.com>
7 * 2013-2016 Borislav Petkov <bp@alien8.de>
8 *
9 * X86 CPU microcode early update for Linux:
10 *
11 * Copyright (C) 2012 Fenghua Yu <fenghua.yu@intel.com>
12 * H Peter Anvin" <hpa@zytor.com>
13 * (C) 2015 Borislav Petkov <bp@alien8.de>
14 *
15 * This driver allows to upgrade microcode on x86 processors.
16 */
17
18#define pr_fmt(fmt) "microcode: " fmt
19
20#include <linux/platform_device.h>
21#include <linux/stop_machine.h>
22#include <linux/syscore_ops.h>
23#include <linux/miscdevice.h>
24#include <linux/capability.h>
25#include <linux/firmware.h>
26#include <linux/kernel.h>
27#include <linux/delay.h>
28#include <linux/mutex.h>
29#include <linux/cpu.h>
30#include <linux/nmi.h>
31#include <linux/fs.h>
32#include <linux/mm.h>
33
34#include <asm/microcode_intel.h>
35#include <asm/cpu_device_id.h>
36#include <asm/microcode_amd.h>
37#include <asm/perf_event.h>
38#include <asm/microcode.h>
39#include <asm/processor.h>
40#include <asm/cmdline.h>
41#include <asm/setup.h>
42
43#define DRIVER_VERSION "2.2"
44
45static struct microcode_ops *microcode_ops;
46static bool dis_ucode_ldr = true;
47
48bool initrd_gone;
49
50LIST_HEAD(microcode_cache);
51
52/*
53 * Synchronization.
54 *
55 * All non cpu-hotplug-callback call sites use:
56 *
57 * - microcode_mutex to synchronize with each other;
58 * - get/put_online_cpus() to synchronize with
59 * the cpu-hotplug-callback call sites.
60 *
61 * We guarantee that only a single cpu is being
62 * updated at any particular moment of time.
63 */
64static DEFINE_MUTEX(microcode_mutex);
65
66/*
67 * Serialize late loading so that CPUs get updated one-by-one.
68 */
69static DEFINE_RAW_SPINLOCK(update_lock);
70
71struct ucode_cpu_info ucode_cpu_info[NR_CPUS];
72
73struct cpu_info_ctx {
74 struct cpu_signature *cpu_sig;
75 int err;
76};
77
78/*
79 * Those patch levels cannot be updated to newer ones and thus should be final.
80 */
81static u32 final_levels[] = {
82 0x01000098,
83 0x0100009f,
84 0x010000af,
85 0, /* T-101 terminator */
86};
87
88/*
89 * Check the current patch level on this CPU.
90 *
91 * Returns:
92 * - true: if update should stop
93 * - false: otherwise
94 */
95static bool amd_check_current_patch_level(void)
96{
97 u32 lvl, dummy, i;
98 u32 *levels;
99
100 native_rdmsr(MSR_AMD64_PATCH_LEVEL, lvl, dummy);
101
102 if (IS_ENABLED(CONFIG_X86_32))
103 levels = (u32 *)__pa_nodebug(&final_levels);
104 else
105 levels = final_levels;
106
107 for (i = 0; levels[i]; i++) {
108 if (lvl == levels[i])
109 return true;
110 }
111 return false;
112}
113
114static bool __init check_loader_disabled_bsp(void)
115{
116 static const char *__dis_opt_str = "dis_ucode_ldr";
117
118#ifdef CONFIG_X86_32
119 const char *cmdline = (const char *)__pa_nodebug(boot_command_line);
120 const char *option = (const char *)__pa_nodebug(__dis_opt_str);
121 bool *res = (bool *)__pa_nodebug(&dis_ucode_ldr);
122
123#else /* CONFIG_X86_64 */
124 const char *cmdline = boot_command_line;
125 const char *option = __dis_opt_str;
126 bool *res = &dis_ucode_ldr;
127#endif
128
129 /*
130 * CPUID(1).ECX[31]: reserved for hypervisor use. This is still not
131 * completely accurate as xen pv guests don't see that CPUID bit set but
132 * that's good enough as they don't land on the BSP path anyway.
133 */
134 if (native_cpuid_ecx(1) & BIT(31))
135 return *res;
136
137 if (x86_cpuid_vendor() == X86_VENDOR_AMD) {
138 if (amd_check_current_patch_level())
139 return *res;
140 }
141
142 if (cmdline_find_option_bool(cmdline, option) <= 0)
143 *res = false;
144
145 return *res;
146}
147
148extern struct builtin_fw __start_builtin_fw[];
149extern struct builtin_fw __end_builtin_fw[];
150
151bool get_builtin_firmware(struct cpio_data *cd, const char *name)
152{
153#ifdef CONFIG_FW_LOADER
154 struct builtin_fw *b_fw;
155
156 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
157 if (!strcmp(name, b_fw->name)) {
158 cd->size = b_fw->size;
159 cd->data = b_fw->data;
160 return true;
161 }
162 }
163#endif
164 return false;
165}
166
167void __init load_ucode_bsp(void)
168{
169 unsigned int cpuid_1_eax;
170 bool intel = true;
171
172 if (!have_cpuid_p())
173 return;
174
175 cpuid_1_eax = native_cpuid_eax(1);
176
177 switch (x86_cpuid_vendor()) {
178 case X86_VENDOR_INTEL:
179 if (x86_family(cpuid_1_eax) < 6)
180 return;
181 break;
182
183 case X86_VENDOR_AMD:
184 if (x86_family(cpuid_1_eax) < 0x10)
185 return;
186 intel = false;
187 break;
188
189 default:
190 return;
191 }
192
193 if (check_loader_disabled_bsp())
194 return;
195
196 if (intel)
197 load_ucode_intel_bsp();
198 else
199 load_ucode_amd_bsp(cpuid_1_eax);
200}
201
202static bool check_loader_disabled_ap(void)
203{
204#ifdef CONFIG_X86_32
205 return *((bool *)__pa_nodebug(&dis_ucode_ldr));
206#else
207 return dis_ucode_ldr;
208#endif
209}
210
211void load_ucode_ap(void)
212{
213 unsigned int cpuid_1_eax;
214
215 if (check_loader_disabled_ap())
216 return;
217
218 cpuid_1_eax = native_cpuid_eax(1);
219
220 switch (x86_cpuid_vendor()) {
221 case X86_VENDOR_INTEL:
222 if (x86_family(cpuid_1_eax) >= 6)
223 load_ucode_intel_ap();
224 break;
225 case X86_VENDOR_AMD:
226 if (x86_family(cpuid_1_eax) >= 0x10)
227 load_ucode_amd_ap(cpuid_1_eax);
228 break;
229 default:
230 break;
231 }
232}
233
234static int __init save_microcode_in_initrd(void)
235{
236 struct cpuinfo_x86 *c = &boot_cpu_data;
237 int ret = -EINVAL;
238
239 switch (c->x86_vendor) {
240 case X86_VENDOR_INTEL:
241 if (c->x86 >= 6)
242 ret = save_microcode_in_initrd_intel();
243 break;
244 case X86_VENDOR_AMD:
245 if (c->x86 >= 0x10)
246 ret = save_microcode_in_initrd_amd(cpuid_eax(1));
247 break;
248 default:
249 break;
250 }
251
252 initrd_gone = true;
253
254 return ret;
255}
256
257struct cpio_data find_microcode_in_initrd(const char *path, bool use_pa)
258{
259#ifdef CONFIG_BLK_DEV_INITRD
260 unsigned long start = 0;
261 size_t size;
262
263#ifdef CONFIG_X86_32
264 struct boot_params *params;
265
266 if (use_pa)
267 params = (struct boot_params *)__pa_nodebug(&boot_params);
268 else
269 params = &boot_params;
270
271 size = params->hdr.ramdisk_size;
272
273 /*
274 * Set start only if we have an initrd image. We cannot use initrd_start
275 * because it is not set that early yet.
276 */
277 if (size)
278 start = params->hdr.ramdisk_image;
279
280# else /* CONFIG_X86_64 */
281 size = (unsigned long)boot_params.ext_ramdisk_size << 32;
282 size |= boot_params.hdr.ramdisk_size;
283
284 if (size) {
285 start = (unsigned long)boot_params.ext_ramdisk_image << 32;
286 start |= boot_params.hdr.ramdisk_image;
287
288 start += PAGE_OFFSET;
289 }
290# endif
291
292 /*
293 * Fixup the start address: after reserve_initrd() runs, initrd_start
294 * has the virtual address of the beginning of the initrd. It also
295 * possibly relocates the ramdisk. In either case, initrd_start contains
296 * the updated address so use that instead.
297 *
298 * initrd_gone is for the hotplug case where we've thrown out initrd
299 * already.
300 */
301 if (!use_pa) {
302 if (initrd_gone)
303 return (struct cpio_data){ NULL, 0, "" };
304 if (initrd_start)
305 start = initrd_start;
306 } else {
307 /*
308 * The picture with physical addresses is a bit different: we
309 * need to get the *physical* address to which the ramdisk was
310 * relocated, i.e., relocated_ramdisk (not initrd_start) and
311 * since we're running from physical addresses, we need to access
312 * relocated_ramdisk through its *physical* address too.
313 */
314 u64 *rr = (u64 *)__pa_nodebug(&relocated_ramdisk);
315 if (*rr)
316 start = *rr;
317 }
318
319 return find_cpio_data(path, (void *)start, size, NULL);
320#else /* !CONFIG_BLK_DEV_INITRD */
321 return (struct cpio_data){ NULL, 0, "" };
322#endif
323}
324
325void reload_early_microcode(void)
326{
327 int vendor, family;
328
329 vendor = x86_cpuid_vendor();
330 family = x86_cpuid_family();
331
332 switch (vendor) {
333 case X86_VENDOR_INTEL:
334 if (family >= 6)
335 reload_ucode_intel();
336 break;
337 case X86_VENDOR_AMD:
338 if (family >= 0x10)
339 reload_ucode_amd();
340 break;
341 default:
342 break;
343 }
344}
345
346static void collect_cpu_info_local(void *arg)
347{
348 struct cpu_info_ctx *ctx = arg;
349
350 ctx->err = microcode_ops->collect_cpu_info(smp_processor_id(),
351 ctx->cpu_sig);
352}
353
354static int collect_cpu_info_on_target(int cpu, struct cpu_signature *cpu_sig)
355{
356 struct cpu_info_ctx ctx = { .cpu_sig = cpu_sig, .err = 0 };
357 int ret;
358
359 ret = smp_call_function_single(cpu, collect_cpu_info_local, &ctx, 1);
360 if (!ret)
361 ret = ctx.err;
362
363 return ret;
364}
365
366static int collect_cpu_info(int cpu)
367{
368 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
369 int ret;
370
371 memset(uci, 0, sizeof(*uci));
372
373 ret = collect_cpu_info_on_target(cpu, &uci->cpu_sig);
374 if (!ret)
375 uci->valid = 1;
376
377 return ret;
378}
379
380static void apply_microcode_local(void *arg)
381{
382 enum ucode_state *err = arg;
383
384 *err = microcode_ops->apply_microcode(smp_processor_id());
385}
386
387static int apply_microcode_on_target(int cpu)
388{
389 enum ucode_state err;
390 int ret;
391
392 ret = smp_call_function_single(cpu, apply_microcode_local, &err, 1);
393 if (!ret) {
394 if (err == UCODE_ERROR)
395 ret = 1;
396 }
397 return ret;
398}
399
400#ifdef CONFIG_MICROCODE_OLD_INTERFACE
401static int do_microcode_update(const void __user *buf, size_t size)
402{
403 int error = 0;
404 int cpu;
405
406 for_each_online_cpu(cpu) {
407 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
408 enum ucode_state ustate;
409
410 if (!uci->valid)
411 continue;
412
413 ustate = microcode_ops->request_microcode_user(cpu, buf, size);
414 if (ustate == UCODE_ERROR) {
415 error = -1;
416 break;
417 } else if (ustate == UCODE_NEW) {
418 apply_microcode_on_target(cpu);
419 }
420 }
421
422 return error;
423}
424
425static int microcode_open(struct inode *inode, struct file *file)
426{
427 return capable(CAP_SYS_RAWIO) ? stream_open(inode, file) : -EPERM;
428}
429
430static ssize_t microcode_write(struct file *file, const char __user *buf,
431 size_t len, loff_t *ppos)
432{
433 ssize_t ret = -EINVAL;
434 unsigned long nr_pages = totalram_pages();
435
436 if ((len >> PAGE_SHIFT) > nr_pages) {
437 pr_err("too much data (max %ld pages)\n", nr_pages);
438 return ret;
439 }
440
441 get_online_cpus();
442 mutex_lock(µcode_mutex);
443
444 if (do_microcode_update(buf, len) == 0)
445 ret = (ssize_t)len;
446
447 if (ret > 0)
448 perf_check_microcode();
449
450 mutex_unlock(µcode_mutex);
451 put_online_cpus();
452
453 return ret;
454}
455
456static const struct file_operations microcode_fops = {
457 .owner = THIS_MODULE,
458 .write = microcode_write,
459 .open = microcode_open,
460 .llseek = no_llseek,
461};
462
463static struct miscdevice microcode_dev = {
464 .minor = MICROCODE_MINOR,
465 .name = "microcode",
466 .nodename = "cpu/microcode",
467 .fops = µcode_fops,
468};
469
470static int __init microcode_dev_init(void)
471{
472 int error;
473
474 error = misc_register(µcode_dev);
475 if (error) {
476 pr_err("can't misc_register on minor=%d\n", MICROCODE_MINOR);
477 return error;
478 }
479
480 return 0;
481}
482
483static void __exit microcode_dev_exit(void)
484{
485 misc_deregister(µcode_dev);
486}
487#else
488#define microcode_dev_init() 0
489#define microcode_dev_exit() do { } while (0)
490#endif
491
492/* fake device for request_firmware */
493static struct platform_device *microcode_pdev;
494
495/*
496 * Late loading dance. Why the heavy-handed stomp_machine effort?
497 *
498 * - HT siblings must be idle and not execute other code while the other sibling
499 * is loading microcode in order to avoid any negative interactions caused by
500 * the loading.
501 *
502 * - In addition, microcode update on the cores must be serialized until this
503 * requirement can be relaxed in the future. Right now, this is conservative
504 * and good.
505 */
506#define SPINUNIT 100 /* 100 nsec */
507
508static int check_online_cpus(void)
509{
510 unsigned int cpu;
511
512 /*
513 * Make sure all CPUs are online. It's fine for SMT to be disabled if
514 * all the primary threads are still online.
515 */
516 for_each_present_cpu(cpu) {
517 if (topology_is_primary_thread(cpu) && !cpu_online(cpu)) {
518 pr_err("Not all CPUs online, aborting microcode update.\n");
519 return -EINVAL;
520 }
521 }
522
523 return 0;
524}
525
526static atomic_t late_cpus_in;
527static atomic_t late_cpus_out;
528
529static int __wait_for_cpus(atomic_t *t, long long timeout)
530{
531 int all_cpus = num_online_cpus();
532
533 atomic_inc(t);
534
535 while (atomic_read(t) < all_cpus) {
536 if (timeout < SPINUNIT) {
537 pr_err("Timeout while waiting for CPUs rendezvous, remaining: %d\n",
538 all_cpus - atomic_read(t));
539 return 1;
540 }
541
542 ndelay(SPINUNIT);
543 timeout -= SPINUNIT;
544
545 touch_nmi_watchdog();
546 }
547 return 0;
548}
549
550/*
551 * Returns:
552 * < 0 - on error
553 * 0 - no update done
554 * 1 - microcode was updated
555 */
556static int __reload_late(void *info)
557{
558 int cpu = smp_processor_id();
559 enum ucode_state err;
560 int ret = 0;
561
562 /*
563 * Wait for all CPUs to arrive. A load will not be attempted unless all
564 * CPUs show up.
565 * */
566 if (__wait_for_cpus(&late_cpus_in, NSEC_PER_SEC))
567 return -1;
568
569 raw_spin_lock(&update_lock);
570 apply_microcode_local(&err);
571 raw_spin_unlock(&update_lock);
572
573 /* siblings return UCODE_OK because their engine got updated already */
574 if (err > UCODE_NFOUND) {
575 pr_warn("Error reloading microcode on CPU %d\n", cpu);
576 ret = -1;
577 } else if (err == UCODE_UPDATED || err == UCODE_OK) {
578 ret = 1;
579 }
580
581 /*
582 * Increase the wait timeout to a safe value here since we're
583 * serializing the microcode update and that could take a while on a
584 * large number of CPUs. And that is fine as the *actual* timeout will
585 * be determined by the last CPU finished updating and thus cut short.
586 */
587 if (__wait_for_cpus(&late_cpus_out, NSEC_PER_SEC * num_online_cpus()))
588 panic("Timeout during microcode update!\n");
589
590 return ret;
591}
592
593/*
594 * Reload microcode late on all CPUs. Wait for a sec until they
595 * all gather together.
596 */
597static int microcode_reload_late(void)
598{
599 int ret;
600
601 atomic_set(&late_cpus_in, 0);
602 atomic_set(&late_cpus_out, 0);
603
604 ret = stop_machine_cpuslocked(__reload_late, NULL, cpu_online_mask);
605 if (ret > 0)
606 microcode_check();
607
608 pr_info("Reload completed, microcode revision: 0x%x\n", boot_cpu_data.microcode);
609
610 return ret;
611}
612
613static ssize_t reload_store(struct device *dev,
614 struct device_attribute *attr,
615 const char *buf, size_t size)
616{
617 enum ucode_state tmp_ret = UCODE_OK;
618 int bsp = boot_cpu_data.cpu_index;
619 unsigned long val;
620 ssize_t ret = 0;
621
622 ret = kstrtoul(buf, 0, &val);
623 if (ret)
624 return ret;
625
626 if (val != 1)
627 return size;
628
629 tmp_ret = microcode_ops->request_microcode_fw(bsp, µcode_pdev->dev, true);
630 if (tmp_ret != UCODE_NEW)
631 return size;
632
633 get_online_cpus();
634
635 ret = check_online_cpus();
636 if (ret)
637 goto put;
638
639 mutex_lock(µcode_mutex);
640 ret = microcode_reload_late();
641 mutex_unlock(µcode_mutex);
642
643put:
644 put_online_cpus();
645
646 if (ret >= 0)
647 ret = size;
648
649 return ret;
650}
651
652static ssize_t version_show(struct device *dev,
653 struct device_attribute *attr, char *buf)
654{
655 struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
656
657 return sprintf(buf, "0x%x\n", uci->cpu_sig.rev);
658}
659
660static ssize_t pf_show(struct device *dev,
661 struct device_attribute *attr, char *buf)
662{
663 struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
664
665 return sprintf(buf, "0x%x\n", uci->cpu_sig.pf);
666}
667
668static DEVICE_ATTR_WO(reload);
669static DEVICE_ATTR(version, 0444, version_show, NULL);
670static DEVICE_ATTR(processor_flags, 0444, pf_show, NULL);
671
672static struct attribute *mc_default_attrs[] = {
673 &dev_attr_version.attr,
674 &dev_attr_processor_flags.attr,
675 NULL
676};
677
678static const struct attribute_group mc_attr_group = {
679 .attrs = mc_default_attrs,
680 .name = "microcode",
681};
682
683static void microcode_fini_cpu(int cpu)
684{
685 if (microcode_ops->microcode_fini_cpu)
686 microcode_ops->microcode_fini_cpu(cpu);
687}
688
689static enum ucode_state microcode_resume_cpu(int cpu)
690{
691 if (apply_microcode_on_target(cpu))
692 return UCODE_ERROR;
693
694 pr_debug("CPU%d updated upon resume\n", cpu);
695
696 return UCODE_OK;
697}
698
699static enum ucode_state microcode_init_cpu(int cpu, bool refresh_fw)
700{
701 enum ucode_state ustate;
702 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
703
704 if (uci->valid)
705 return UCODE_OK;
706
707 if (collect_cpu_info(cpu))
708 return UCODE_ERROR;
709
710 /* --dimm. Trigger a delayed update? */
711 if (system_state != SYSTEM_RUNNING)
712 return UCODE_NFOUND;
713
714 ustate = microcode_ops->request_microcode_fw(cpu, µcode_pdev->dev, refresh_fw);
715 if (ustate == UCODE_NEW) {
716 pr_debug("CPU%d updated upon init\n", cpu);
717 apply_microcode_on_target(cpu);
718 }
719
720 return ustate;
721}
722
723static enum ucode_state microcode_update_cpu(int cpu)
724{
725 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
726
727 /* Refresh CPU microcode revision after resume. */
728 collect_cpu_info(cpu);
729
730 if (uci->valid)
731 return microcode_resume_cpu(cpu);
732
733 return microcode_init_cpu(cpu, false);
734}
735
736static int mc_device_add(struct device *dev, struct subsys_interface *sif)
737{
738 int err, cpu = dev->id;
739
740 if (!cpu_online(cpu))
741 return 0;
742
743 pr_debug("CPU%d added\n", cpu);
744
745 err = sysfs_create_group(&dev->kobj, &mc_attr_group);
746 if (err)
747 return err;
748
749 if (microcode_init_cpu(cpu, true) == UCODE_ERROR)
750 return -EINVAL;
751
752 return err;
753}
754
755static void mc_device_remove(struct device *dev, struct subsys_interface *sif)
756{
757 int cpu = dev->id;
758
759 if (!cpu_online(cpu))
760 return;
761
762 pr_debug("CPU%d removed\n", cpu);
763 microcode_fini_cpu(cpu);
764 sysfs_remove_group(&dev->kobj, &mc_attr_group);
765}
766
767static struct subsys_interface mc_cpu_interface = {
768 .name = "microcode",
769 .subsys = &cpu_subsys,
770 .add_dev = mc_device_add,
771 .remove_dev = mc_device_remove,
772};
773
774/**
775 * mc_bp_resume - Update boot CPU microcode during resume.
776 */
777static void mc_bp_resume(void)
778{
779 int cpu = smp_processor_id();
780 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
781
782 if (uci->valid && uci->mc)
783 microcode_ops->apply_microcode(cpu);
784 else if (!uci->mc)
785 reload_early_microcode();
786}
787
788static struct syscore_ops mc_syscore_ops = {
789 .resume = mc_bp_resume,
790};
791
792static int mc_cpu_starting(unsigned int cpu)
793{
794 microcode_update_cpu(cpu);
795 pr_debug("CPU%d added\n", cpu);
796 return 0;
797}
798
799static int mc_cpu_online(unsigned int cpu)
800{
801 struct device *dev = get_cpu_device(cpu);
802
803 if (sysfs_create_group(&dev->kobj, &mc_attr_group))
804 pr_err("Failed to create group for CPU%d\n", cpu);
805 return 0;
806}
807
808static int mc_cpu_down_prep(unsigned int cpu)
809{
810 struct device *dev;
811
812 dev = get_cpu_device(cpu);
813 /* Suspend is in progress, only remove the interface */
814 sysfs_remove_group(&dev->kobj, &mc_attr_group);
815 pr_debug("CPU%d removed\n", cpu);
816
817 return 0;
818}
819
820static struct attribute *cpu_root_microcode_attrs[] = {
821 &dev_attr_reload.attr,
822 NULL
823};
824
825static const struct attribute_group cpu_root_microcode_group = {
826 .name = "microcode",
827 .attrs = cpu_root_microcode_attrs,
828};
829
830int __init microcode_init(void)
831{
832 struct cpuinfo_x86 *c = &boot_cpu_data;
833 int error;
834
835 if (dis_ucode_ldr)
836 return -EINVAL;
837
838 if (c->x86_vendor == X86_VENDOR_INTEL)
839 microcode_ops = init_intel_microcode();
840 else if (c->x86_vendor == X86_VENDOR_AMD)
841 microcode_ops = init_amd_microcode();
842 else
843 pr_err("no support for this CPU vendor\n");
844
845 if (!microcode_ops)
846 return -ENODEV;
847
848 microcode_pdev = platform_device_register_simple("microcode", -1,
849 NULL, 0);
850 if (IS_ERR(microcode_pdev))
851 return PTR_ERR(microcode_pdev);
852
853 get_online_cpus();
854 mutex_lock(µcode_mutex);
855
856 error = subsys_interface_register(&mc_cpu_interface);
857 if (!error)
858 perf_check_microcode();
859 mutex_unlock(µcode_mutex);
860 put_online_cpus();
861
862 if (error)
863 goto out_pdev;
864
865 error = sysfs_create_group(&cpu_subsys.dev_root->kobj,
866 &cpu_root_microcode_group);
867
868 if (error) {
869 pr_err("Error creating microcode group!\n");
870 goto out_driver;
871 }
872
873 error = microcode_dev_init();
874 if (error)
875 goto out_ucode_group;
876
877 register_syscore_ops(&mc_syscore_ops);
878 cpuhp_setup_state_nocalls(CPUHP_AP_MICROCODE_LOADER, "x86/microcode:starting",
879 mc_cpu_starting, NULL);
880 cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "x86/microcode:online",
881 mc_cpu_online, mc_cpu_down_prep);
882
883 pr_info("Microcode Update Driver: v%s.", DRIVER_VERSION);
884
885 return 0;
886
887 out_ucode_group:
888 sysfs_remove_group(&cpu_subsys.dev_root->kobj,
889 &cpu_root_microcode_group);
890
891 out_driver:
892 get_online_cpus();
893 mutex_lock(µcode_mutex);
894
895 subsys_interface_unregister(&mc_cpu_interface);
896
897 mutex_unlock(µcode_mutex);
898 put_online_cpus();
899
900 out_pdev:
901 platform_device_unregister(microcode_pdev);
902 return error;
903
904}
905fs_initcall(save_microcode_in_initrd);
906late_initcall(microcode_init);
1/*
2 * CPU Microcode Update Driver for Linux
3 *
4 * Copyright (C) 2000-2006 Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
5 * 2006 Shaohua Li <shaohua.li@intel.com>
6 * 2013-2016 Borislav Petkov <bp@alien8.de>
7 *
8 * X86 CPU microcode early update for Linux:
9 *
10 * Copyright (C) 2012 Fenghua Yu <fenghua.yu@intel.com>
11 * H Peter Anvin" <hpa@zytor.com>
12 * (C) 2015 Borislav Petkov <bp@alien8.de>
13 *
14 * This driver allows to upgrade microcode on x86 processors.
15 *
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License
18 * as published by the Free Software Foundation; either version
19 * 2 of the License, or (at your option) any later version.
20 */
21
22#define pr_fmt(fmt) "microcode: " fmt
23
24#include <linux/platform_device.h>
25#include <linux/syscore_ops.h>
26#include <linux/miscdevice.h>
27#include <linux/capability.h>
28#include <linux/firmware.h>
29#include <linux/kernel.h>
30#include <linux/mutex.h>
31#include <linux/cpu.h>
32#include <linux/fs.h>
33#include <linux/mm.h>
34
35#include <asm/microcode_intel.h>
36#include <asm/cpu_device_id.h>
37#include <asm/microcode_amd.h>
38#include <asm/perf_event.h>
39#include <asm/microcode.h>
40#include <asm/processor.h>
41#include <asm/cmdline.h>
42#include <asm/setup.h>
43
44#define DRIVER_VERSION "2.2"
45
46static struct microcode_ops *microcode_ops;
47static bool dis_ucode_ldr = true;
48
49bool initrd_gone;
50
51LIST_HEAD(microcode_cache);
52
53/*
54 * Synchronization.
55 *
56 * All non cpu-hotplug-callback call sites use:
57 *
58 * - microcode_mutex to synchronize with each other;
59 * - get/put_online_cpus() to synchronize with
60 * the cpu-hotplug-callback call sites.
61 *
62 * We guarantee that only a single cpu is being
63 * updated at any particular moment of time.
64 */
65static DEFINE_MUTEX(microcode_mutex);
66
67struct ucode_cpu_info ucode_cpu_info[NR_CPUS];
68
69/*
70 * Operations that are run on a target cpu:
71 */
72
73struct cpu_info_ctx {
74 struct cpu_signature *cpu_sig;
75 int err;
76};
77
78static bool __init check_loader_disabled_bsp(void)
79{
80 static const char *__dis_opt_str = "dis_ucode_ldr";
81 u32 a, b, c, d;
82
83#ifdef CONFIG_X86_32
84 const char *cmdline = (const char *)__pa_nodebug(boot_command_line);
85 const char *option = (const char *)__pa_nodebug(__dis_opt_str);
86 bool *res = (bool *)__pa_nodebug(&dis_ucode_ldr);
87
88#else /* CONFIG_X86_64 */
89 const char *cmdline = boot_command_line;
90 const char *option = __dis_opt_str;
91 bool *res = &dis_ucode_ldr;
92#endif
93
94 if (!have_cpuid_p())
95 return *res;
96
97 a = 1;
98 c = 0;
99 native_cpuid(&a, &b, &c, &d);
100
101 /*
102 * CPUID(1).ECX[31]: reserved for hypervisor use. This is still not
103 * completely accurate as xen pv guests don't see that CPUID bit set but
104 * that's good enough as they don't land on the BSP path anyway.
105 */
106 if (c & BIT(31))
107 return *res;
108
109 if (cmdline_find_option_bool(cmdline, option) <= 0)
110 *res = false;
111
112 return *res;
113}
114
115extern struct builtin_fw __start_builtin_fw[];
116extern struct builtin_fw __end_builtin_fw[];
117
118bool get_builtin_firmware(struct cpio_data *cd, const char *name)
119{
120#ifdef CONFIG_FW_LOADER
121 struct builtin_fw *b_fw;
122
123 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
124 if (!strcmp(name, b_fw->name)) {
125 cd->size = b_fw->size;
126 cd->data = b_fw->data;
127 return true;
128 }
129 }
130#endif
131 return false;
132}
133
134void __init load_ucode_bsp(void)
135{
136 int vendor;
137 unsigned int family;
138
139 if (check_loader_disabled_bsp())
140 return;
141
142 vendor = x86_cpuid_vendor();
143 family = x86_cpuid_family();
144
145 switch (vendor) {
146 case X86_VENDOR_INTEL:
147 if (family >= 6)
148 load_ucode_intel_bsp();
149 break;
150 case X86_VENDOR_AMD:
151 if (family >= 0x10)
152 load_ucode_amd_bsp(family);
153 break;
154 default:
155 break;
156 }
157}
158
159static bool check_loader_disabled_ap(void)
160{
161#ifdef CONFIG_X86_32
162 return *((bool *)__pa_nodebug(&dis_ucode_ldr));
163#else
164 return dis_ucode_ldr;
165#endif
166}
167
168void load_ucode_ap(void)
169{
170 int vendor, family;
171
172 if (check_loader_disabled_ap())
173 return;
174
175 vendor = x86_cpuid_vendor();
176 family = x86_cpuid_family();
177
178 switch (vendor) {
179 case X86_VENDOR_INTEL:
180 if (family >= 6)
181 load_ucode_intel_ap();
182 break;
183 case X86_VENDOR_AMD:
184 if (family >= 0x10)
185 load_ucode_amd_ap(family);
186 break;
187 default:
188 break;
189 }
190}
191
192static int __init save_microcode_in_initrd(void)
193{
194 struct cpuinfo_x86 *c = &boot_cpu_data;
195 int ret = -EINVAL;
196
197 switch (c->x86_vendor) {
198 case X86_VENDOR_INTEL:
199 if (c->x86 >= 6)
200 ret = save_microcode_in_initrd_intel();
201 break;
202 case X86_VENDOR_AMD:
203 if (c->x86 >= 0x10)
204 ret = save_microcode_in_initrd_amd(c->x86);
205 break;
206 default:
207 break;
208 }
209
210 initrd_gone = true;
211
212 return ret;
213}
214
215struct cpio_data find_microcode_in_initrd(const char *path, bool use_pa)
216{
217#ifdef CONFIG_BLK_DEV_INITRD
218 unsigned long start = 0;
219 size_t size;
220
221#ifdef CONFIG_X86_32
222 struct boot_params *params;
223
224 if (use_pa)
225 params = (struct boot_params *)__pa_nodebug(&boot_params);
226 else
227 params = &boot_params;
228
229 size = params->hdr.ramdisk_size;
230
231 /*
232 * Set start only if we have an initrd image. We cannot use initrd_start
233 * because it is not set that early yet.
234 */
235 if (size)
236 start = params->hdr.ramdisk_image;
237
238# else /* CONFIG_X86_64 */
239 size = (unsigned long)boot_params.ext_ramdisk_size << 32;
240 size |= boot_params.hdr.ramdisk_size;
241
242 if (size) {
243 start = (unsigned long)boot_params.ext_ramdisk_image << 32;
244 start |= boot_params.hdr.ramdisk_image;
245
246 start += PAGE_OFFSET;
247 }
248# endif
249
250 /*
251 * Fixup the start address: after reserve_initrd() runs, initrd_start
252 * has the virtual address of the beginning of the initrd. It also
253 * possibly relocates the ramdisk. In either case, initrd_start contains
254 * the updated address so use that instead.
255 *
256 * initrd_gone is for the hotplug case where we've thrown out initrd
257 * already.
258 */
259 if (!use_pa) {
260 if (initrd_gone)
261 return (struct cpio_data){ NULL, 0, "" };
262 if (initrd_start)
263 start = initrd_start;
264 }
265
266 return find_cpio_data(path, (void *)start, size, NULL);
267#else /* !CONFIG_BLK_DEV_INITRD */
268 return (struct cpio_data){ NULL, 0, "" };
269#endif
270}
271
272void reload_early_microcode(void)
273{
274 int vendor, family;
275
276 vendor = x86_cpuid_vendor();
277 family = x86_cpuid_family();
278
279 switch (vendor) {
280 case X86_VENDOR_INTEL:
281 if (family >= 6)
282 reload_ucode_intel();
283 break;
284 case X86_VENDOR_AMD:
285 if (family >= 0x10)
286 reload_ucode_amd();
287 break;
288 default:
289 break;
290 }
291}
292
293static void collect_cpu_info_local(void *arg)
294{
295 struct cpu_info_ctx *ctx = arg;
296
297 ctx->err = microcode_ops->collect_cpu_info(smp_processor_id(),
298 ctx->cpu_sig);
299}
300
301static int collect_cpu_info_on_target(int cpu, struct cpu_signature *cpu_sig)
302{
303 struct cpu_info_ctx ctx = { .cpu_sig = cpu_sig, .err = 0 };
304 int ret;
305
306 ret = smp_call_function_single(cpu, collect_cpu_info_local, &ctx, 1);
307 if (!ret)
308 ret = ctx.err;
309
310 return ret;
311}
312
313static int collect_cpu_info(int cpu)
314{
315 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
316 int ret;
317
318 memset(uci, 0, sizeof(*uci));
319
320 ret = collect_cpu_info_on_target(cpu, &uci->cpu_sig);
321 if (!ret)
322 uci->valid = 1;
323
324 return ret;
325}
326
327struct apply_microcode_ctx {
328 int err;
329};
330
331static void apply_microcode_local(void *arg)
332{
333 struct apply_microcode_ctx *ctx = arg;
334
335 ctx->err = microcode_ops->apply_microcode(smp_processor_id());
336}
337
338static int apply_microcode_on_target(int cpu)
339{
340 struct apply_microcode_ctx ctx = { .err = 0 };
341 int ret;
342
343 ret = smp_call_function_single(cpu, apply_microcode_local, &ctx, 1);
344 if (!ret)
345 ret = ctx.err;
346
347 return ret;
348}
349
350#ifdef CONFIG_MICROCODE_OLD_INTERFACE
351static int do_microcode_update(const void __user *buf, size_t size)
352{
353 int error = 0;
354 int cpu;
355
356 for_each_online_cpu(cpu) {
357 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
358 enum ucode_state ustate;
359
360 if (!uci->valid)
361 continue;
362
363 ustate = microcode_ops->request_microcode_user(cpu, buf, size);
364 if (ustate == UCODE_ERROR) {
365 error = -1;
366 break;
367 } else if (ustate == UCODE_OK)
368 apply_microcode_on_target(cpu);
369 }
370
371 return error;
372}
373
374static int microcode_open(struct inode *inode, struct file *file)
375{
376 return capable(CAP_SYS_RAWIO) ? nonseekable_open(inode, file) : -EPERM;
377}
378
379static ssize_t microcode_write(struct file *file, const char __user *buf,
380 size_t len, loff_t *ppos)
381{
382 ssize_t ret = -EINVAL;
383
384 if ((len >> PAGE_SHIFT) > totalram_pages) {
385 pr_err("too much data (max %ld pages)\n", totalram_pages);
386 return ret;
387 }
388
389 get_online_cpus();
390 mutex_lock(µcode_mutex);
391
392 if (do_microcode_update(buf, len) == 0)
393 ret = (ssize_t)len;
394
395 if (ret > 0)
396 perf_check_microcode();
397
398 mutex_unlock(µcode_mutex);
399 put_online_cpus();
400
401 return ret;
402}
403
404static const struct file_operations microcode_fops = {
405 .owner = THIS_MODULE,
406 .write = microcode_write,
407 .open = microcode_open,
408 .llseek = no_llseek,
409};
410
411static struct miscdevice microcode_dev = {
412 .minor = MICROCODE_MINOR,
413 .name = "microcode",
414 .nodename = "cpu/microcode",
415 .fops = µcode_fops,
416};
417
418static int __init microcode_dev_init(void)
419{
420 int error;
421
422 error = misc_register(µcode_dev);
423 if (error) {
424 pr_err("can't misc_register on minor=%d\n", MICROCODE_MINOR);
425 return error;
426 }
427
428 return 0;
429}
430
431static void __exit microcode_dev_exit(void)
432{
433 misc_deregister(µcode_dev);
434}
435#else
436#define microcode_dev_init() 0
437#define microcode_dev_exit() do { } while (0)
438#endif
439
440/* fake device for request_firmware */
441static struct platform_device *microcode_pdev;
442
443static int reload_for_cpu(int cpu)
444{
445 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
446 enum ucode_state ustate;
447 int err = 0;
448
449 if (!uci->valid)
450 return err;
451
452 ustate = microcode_ops->request_microcode_fw(cpu, µcode_pdev->dev, true);
453 if (ustate == UCODE_OK)
454 apply_microcode_on_target(cpu);
455 else
456 if (ustate == UCODE_ERROR)
457 err = -EINVAL;
458 return err;
459}
460
461static ssize_t reload_store(struct device *dev,
462 struct device_attribute *attr,
463 const char *buf, size_t size)
464{
465 unsigned long val;
466 int cpu;
467 ssize_t ret = 0, tmp_ret;
468
469 ret = kstrtoul(buf, 0, &val);
470 if (ret)
471 return ret;
472
473 if (val != 1)
474 return size;
475
476 get_online_cpus();
477 mutex_lock(µcode_mutex);
478 for_each_online_cpu(cpu) {
479 tmp_ret = reload_for_cpu(cpu);
480 if (tmp_ret != 0)
481 pr_warn("Error reloading microcode on CPU %d\n", cpu);
482
483 /* save retval of the first encountered reload error */
484 if (!ret)
485 ret = tmp_ret;
486 }
487 if (!ret)
488 perf_check_microcode();
489 mutex_unlock(µcode_mutex);
490 put_online_cpus();
491
492 if (!ret)
493 ret = size;
494
495 return ret;
496}
497
498static ssize_t version_show(struct device *dev,
499 struct device_attribute *attr, char *buf)
500{
501 struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
502
503 return sprintf(buf, "0x%x\n", uci->cpu_sig.rev);
504}
505
506static ssize_t pf_show(struct device *dev,
507 struct device_attribute *attr, char *buf)
508{
509 struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
510
511 return sprintf(buf, "0x%x\n", uci->cpu_sig.pf);
512}
513
514static DEVICE_ATTR(reload, 0200, NULL, reload_store);
515static DEVICE_ATTR(version, 0400, version_show, NULL);
516static DEVICE_ATTR(processor_flags, 0400, pf_show, NULL);
517
518static struct attribute *mc_default_attrs[] = {
519 &dev_attr_version.attr,
520 &dev_attr_processor_flags.attr,
521 NULL
522};
523
524static struct attribute_group mc_attr_group = {
525 .attrs = mc_default_attrs,
526 .name = "microcode",
527};
528
529static void microcode_fini_cpu(int cpu)
530{
531 if (microcode_ops->microcode_fini_cpu)
532 microcode_ops->microcode_fini_cpu(cpu);
533}
534
535static enum ucode_state microcode_resume_cpu(int cpu)
536{
537 if (apply_microcode_on_target(cpu))
538 return UCODE_ERROR;
539
540 pr_debug("CPU%d updated upon resume\n", cpu);
541
542 return UCODE_OK;
543}
544
545static enum ucode_state microcode_init_cpu(int cpu, bool refresh_fw)
546{
547 enum ucode_state ustate;
548 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
549
550 if (uci->valid)
551 return UCODE_OK;
552
553 if (collect_cpu_info(cpu))
554 return UCODE_ERROR;
555
556 /* --dimm. Trigger a delayed update? */
557 if (system_state != SYSTEM_RUNNING)
558 return UCODE_NFOUND;
559
560 ustate = microcode_ops->request_microcode_fw(cpu, µcode_pdev->dev,
561 refresh_fw);
562
563 if (ustate == UCODE_OK) {
564 pr_debug("CPU%d updated upon init\n", cpu);
565 apply_microcode_on_target(cpu);
566 }
567
568 return ustate;
569}
570
571static enum ucode_state microcode_update_cpu(int cpu)
572{
573 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
574
575 /* Refresh CPU microcode revision after resume. */
576 collect_cpu_info(cpu);
577
578 if (uci->valid)
579 return microcode_resume_cpu(cpu);
580
581 return microcode_init_cpu(cpu, false);
582}
583
584static int mc_device_add(struct device *dev, struct subsys_interface *sif)
585{
586 int err, cpu = dev->id;
587
588 if (!cpu_online(cpu))
589 return 0;
590
591 pr_debug("CPU%d added\n", cpu);
592
593 err = sysfs_create_group(&dev->kobj, &mc_attr_group);
594 if (err)
595 return err;
596
597 if (microcode_init_cpu(cpu, true) == UCODE_ERROR)
598 return -EINVAL;
599
600 return err;
601}
602
603static void mc_device_remove(struct device *dev, struct subsys_interface *sif)
604{
605 int cpu = dev->id;
606
607 if (!cpu_online(cpu))
608 return;
609
610 pr_debug("CPU%d removed\n", cpu);
611 microcode_fini_cpu(cpu);
612 sysfs_remove_group(&dev->kobj, &mc_attr_group);
613}
614
615static struct subsys_interface mc_cpu_interface = {
616 .name = "microcode",
617 .subsys = &cpu_subsys,
618 .add_dev = mc_device_add,
619 .remove_dev = mc_device_remove,
620};
621
622/**
623 * mc_bp_resume - Update boot CPU microcode during resume.
624 */
625static void mc_bp_resume(void)
626{
627 int cpu = smp_processor_id();
628 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
629
630 if (uci->valid && uci->mc)
631 microcode_ops->apply_microcode(cpu);
632 else if (!uci->mc)
633 reload_early_microcode();
634}
635
636static struct syscore_ops mc_syscore_ops = {
637 .resume = mc_bp_resume,
638};
639
640static int mc_cpu_online(unsigned int cpu)
641{
642 struct device *dev;
643
644 dev = get_cpu_device(cpu);
645 microcode_update_cpu(cpu);
646 pr_debug("CPU%d added\n", cpu);
647
648 if (sysfs_create_group(&dev->kobj, &mc_attr_group))
649 pr_err("Failed to create group for CPU%d\n", cpu);
650 return 0;
651}
652
653static int mc_cpu_down_prep(unsigned int cpu)
654{
655 struct device *dev;
656
657 dev = get_cpu_device(cpu);
658 /* Suspend is in progress, only remove the interface */
659 sysfs_remove_group(&dev->kobj, &mc_attr_group);
660 pr_debug("CPU%d removed\n", cpu);
661
662 return 0;
663}
664
665static struct attribute *cpu_root_microcode_attrs[] = {
666 &dev_attr_reload.attr,
667 NULL
668};
669
670static struct attribute_group cpu_root_microcode_group = {
671 .name = "microcode",
672 .attrs = cpu_root_microcode_attrs,
673};
674
675int __init microcode_init(void)
676{
677 struct cpuinfo_x86 *c = &boot_cpu_data;
678 int error;
679
680 if (dis_ucode_ldr)
681 return -EINVAL;
682
683 if (c->x86_vendor == X86_VENDOR_INTEL)
684 microcode_ops = init_intel_microcode();
685 else if (c->x86_vendor == X86_VENDOR_AMD)
686 microcode_ops = init_amd_microcode();
687 else
688 pr_err("no support for this CPU vendor\n");
689
690 if (!microcode_ops)
691 return -ENODEV;
692
693 microcode_pdev = platform_device_register_simple("microcode", -1,
694 NULL, 0);
695 if (IS_ERR(microcode_pdev))
696 return PTR_ERR(microcode_pdev);
697
698 get_online_cpus();
699 mutex_lock(µcode_mutex);
700
701 error = subsys_interface_register(&mc_cpu_interface);
702 if (!error)
703 perf_check_microcode();
704 mutex_unlock(µcode_mutex);
705 put_online_cpus();
706
707 if (error)
708 goto out_pdev;
709
710 error = sysfs_create_group(&cpu_subsys.dev_root->kobj,
711 &cpu_root_microcode_group);
712
713 if (error) {
714 pr_err("Error creating microcode group!\n");
715 goto out_driver;
716 }
717
718 error = microcode_dev_init();
719 if (error)
720 goto out_ucode_group;
721
722 register_syscore_ops(&mc_syscore_ops);
723 cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "x86/microcode:online",
724 mc_cpu_online, mc_cpu_down_prep);
725
726 pr_info("Microcode Update Driver: v%s.", DRIVER_VERSION);
727
728 return 0;
729
730 out_ucode_group:
731 sysfs_remove_group(&cpu_subsys.dev_root->kobj,
732 &cpu_root_microcode_group);
733
734 out_driver:
735 get_online_cpus();
736 mutex_lock(µcode_mutex);
737
738 subsys_interface_unregister(&mc_cpu_interface);
739
740 mutex_unlock(µcode_mutex);
741 put_online_cpus();
742
743 out_pdev:
744 platform_device_unregister(microcode_pdev);
745 return error;
746
747}
748fs_initcall(save_microcode_in_initrd);
749late_initcall(microcode_init);