2 * Intel CPU Microcode Update Driver for Linux
4 * Copyright (C) 2000-2006 Tigran Aivazian <aivazian.tigran@gmail.com>
5 * 2006 Shaohua Li <shaohua.li@intel.com>
7 * Intel CPU microcode early update for Linux
9 * Copyright (C) 2012 Fenghua Yu <fenghua.yu@intel.com>
10 * H Peter Anvin" <hpa@zytor.com>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version
15 * 2 of the License, or (at your option) any later version.
19 * This needs to be before all headers so that pr_debug in printk.h doesn't turn
20 * printk calls into no_printk().
24 #define pr_fmt(fmt) "microcode: " fmt
26 #include <linux/earlycpio.h>
27 #include <linux/firmware.h>
28 #include <linux/uaccess.h>
29 #include <linux/vmalloc.h>
30 #include <linux/initrd.h>
31 #include <linux/kernel.h>
32 #include <linux/slab.h>
33 #include <linux/cpu.h>
36 #include <asm/microcode_intel.h>
37 #include <asm/intel-family.h>
38 #include <asm/processor.h>
39 #include <asm/tlbflush.h>
40 #include <asm/setup.h>
43 static const char ucode_path[] = "kernel/x86/microcode/GenuineIntel.bin";
45 /* Current microcode patch used in early patching on the APs. */
46 static struct microcode_intel *intel_ucode_patch;
48 static inline bool cpu_signatures_match(unsigned int s1, unsigned int p1,
49 unsigned int s2, unsigned int p2)
54 /* Processor flags are either both 0 ... */
58 /* ... or they intersect. */
63 * Returns 1 if update has been found, 0 otherwise.
65 static int find_matching_signature(void *mc, unsigned int csig, int cpf)
67 struct microcode_header_intel *mc_hdr = mc;
68 struct extended_sigtable *ext_hdr;
69 struct extended_signature *ext_sig;
72 if (cpu_signatures_match(csig, cpf, mc_hdr->sig, mc_hdr->pf))
75 /* Look for ext. headers: */
76 if (get_totalsize(mc_hdr) <= get_datasize(mc_hdr) + MC_HEADER_SIZE)
79 ext_hdr = mc + get_datasize(mc_hdr) + MC_HEADER_SIZE;
80 ext_sig = (void *)ext_hdr + EXT_HEADER_SIZE;
82 for (i = 0; i < ext_hdr->count; i++) {
83 if (cpu_signatures_match(csig, cpf, ext_sig->sig, ext_sig->pf))
91 * Returns 1 if update has been found, 0 otherwise.
93 static int has_newer_microcode(void *mc, unsigned int csig, int cpf, int new_rev)
95 struct microcode_header_intel *mc_hdr = mc;
97 if (mc_hdr->rev <= new_rev)
100 return find_matching_signature(mc, csig, cpf);
104 * Given CPU signature and a microcode patch, this function finds if the
105 * microcode patch has matching family and model with the CPU.
107 * %true - if there's a match
110 static bool microcode_matches(struct microcode_header_intel *mc_header,
113 unsigned long total_size = get_totalsize(mc_header);
114 unsigned long data_size = get_datasize(mc_header);
115 struct extended_sigtable *ext_header;
116 unsigned int fam_ucode, model_ucode;
117 struct extended_signature *ext_sig;
118 unsigned int fam, model;
121 fam = x86_family(sig);
122 model = x86_model(sig);
124 fam_ucode = x86_family(mc_header->sig);
125 model_ucode = x86_model(mc_header->sig);
127 if (fam == fam_ucode && model == model_ucode)
130 /* Look for ext. headers: */
131 if (total_size <= data_size + MC_HEADER_SIZE)
134 ext_header = (void *) mc_header + data_size + MC_HEADER_SIZE;
135 ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
136 ext_sigcount = ext_header->count;
138 for (i = 0; i < ext_sigcount; i++) {
139 fam_ucode = x86_family(ext_sig->sig);
140 model_ucode = x86_model(ext_sig->sig);
142 if (fam == fam_ucode && model == model_ucode)
150 static struct ucode_patch *memdup_patch(void *data, unsigned int size)
152 struct ucode_patch *p;
154 p = kzalloc(sizeof(struct ucode_patch), GFP_KERNEL);
158 p->data = kmemdup(data, size, GFP_KERNEL);
167 static void save_microcode_patch(void *data, unsigned int size)
169 struct microcode_header_intel *mc_hdr, *mc_saved_hdr;
170 struct ucode_patch *iter, *tmp, *p = NULL;
171 bool prev_found = false;
172 unsigned int sig, pf;
174 mc_hdr = (struct microcode_header_intel *)data;
176 list_for_each_entry_safe(iter, tmp, µcode_cache, plist) {
177 mc_saved_hdr = (struct microcode_header_intel *)iter->data;
178 sig = mc_saved_hdr->sig;
179 pf = mc_saved_hdr->pf;
181 if (find_matching_signature(data, sig, pf)) {
184 if (mc_hdr->rev <= mc_saved_hdr->rev)
187 p = memdup_patch(data, size);
189 pr_err("Error allocating buffer %p\n", data);
191 list_replace(&iter->plist, &p->plist);
196 * There weren't any previous patches found in the list cache; save the
200 p = memdup_patch(data, size);
202 pr_err("Error allocating buffer for %p\n", data);
204 list_add_tail(&p->plist, µcode_cache);
211 * Save for early loading. On 32-bit, that needs to be a physical
212 * address as the APs are running from physical addresses, before
213 * paging has been enabled.
215 if (IS_ENABLED(CONFIG_X86_32))
216 intel_ucode_patch = (struct microcode_intel *)__pa_nodebug(p->data);
218 intel_ucode_patch = p->data;
221 static int microcode_sanity_check(void *mc, int print_err)
223 unsigned long total_size, data_size, ext_table_size;
224 struct microcode_header_intel *mc_header = mc;
225 struct extended_sigtable *ext_header = NULL;
226 u32 sum, orig_sum, ext_sigcount = 0, i;
227 struct extended_signature *ext_sig;
229 total_size = get_totalsize(mc_header);
230 data_size = get_datasize(mc_header);
232 if (data_size + MC_HEADER_SIZE > total_size) {
234 pr_err("Error: bad microcode data file size.\n");
238 if (mc_header->ldrver != 1 || mc_header->hdrver != 1) {
240 pr_err("Error: invalid/unknown microcode update format.\n");
244 ext_table_size = total_size - (MC_HEADER_SIZE + data_size);
245 if (ext_table_size) {
246 u32 ext_table_sum = 0;
249 if ((ext_table_size < EXT_HEADER_SIZE)
250 || ((ext_table_size - EXT_HEADER_SIZE) % EXT_SIGNATURE_SIZE)) {
252 pr_err("Error: truncated extended signature table.\n");
256 ext_header = mc + MC_HEADER_SIZE + data_size;
257 if (ext_table_size != exttable_size(ext_header)) {
259 pr_err("Error: extended signature table size mismatch.\n");
263 ext_sigcount = ext_header->count;
266 * Check extended table checksum: the sum of all dwords that
267 * comprise a valid table must be 0.
269 ext_tablep = (u32 *)ext_header;
271 i = ext_table_size / sizeof(u32);
273 ext_table_sum += ext_tablep[i];
277 pr_warn("Bad extended signature table checksum, aborting.\n");
283 * Calculate the checksum of update data and header. The checksum of
284 * valid update data and header including the extended signature table
288 i = (MC_HEADER_SIZE + data_size) / sizeof(u32);
290 orig_sum += ((u32 *)mc)[i];
294 pr_err("Bad microcode data checksum, aborting.\n");
302 * Check extended signature checksum: 0 => valid.
304 for (i = 0; i < ext_sigcount; i++) {
305 ext_sig = (void *)ext_header + EXT_HEADER_SIZE +
306 EXT_SIGNATURE_SIZE * i;
308 sum = (mc_header->sig + mc_header->pf + mc_header->cksum) -
309 (ext_sig->sig + ext_sig->pf + ext_sig->cksum);
312 pr_err("Bad extended signature checksum, aborting.\n");
320 * Get microcode matching with BSP's model. Only CPUs with the same model as
321 * BSP can stay in the platform.
323 static struct microcode_intel *
324 scan_microcode(void *data, size_t size, struct ucode_cpu_info *uci, bool save)
326 struct microcode_header_intel *mc_header;
327 struct microcode_intel *patch = NULL;
328 unsigned int mc_size;
331 if (size < sizeof(struct microcode_header_intel))
334 mc_header = (struct microcode_header_intel *)data;
336 mc_size = get_totalsize(mc_header);
339 microcode_sanity_check(data, 0) < 0)
344 if (!microcode_matches(mc_header, uci->cpu_sig.sig)) {
350 save_microcode_patch(data, mc_size);
356 if (!has_newer_microcode(data,
363 struct microcode_header_intel *phdr = &patch->hdr;
365 if (!has_newer_microcode(data,
372 /* We have a newer patch, save it. */
385 static int collect_cpu_info_early(struct ucode_cpu_info *uci)
388 unsigned int family, model;
389 struct cpu_signature csig = { 0 };
390 unsigned int eax, ebx, ecx, edx;
392 memset(uci, 0, sizeof(*uci));
396 native_cpuid(&eax, &ebx, &ecx, &edx);
399 family = x86_family(eax);
400 model = x86_model(eax);
402 if ((model >= 5) || (family > 6)) {
403 /* get processor flags from MSR 0x17 */
404 native_rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
405 csig.pf = 1 << ((val[1] >> 18) & 7);
408 csig.rev = intel_get_microcode_revision();
416 static void show_saved_mc(void)
420 unsigned int sig, pf, rev, total_size, data_size, date;
421 struct ucode_cpu_info uci;
422 struct ucode_patch *p;
424 if (list_empty(µcode_cache)) {
425 pr_debug("no microcode data saved.\n");
429 collect_cpu_info_early(&uci);
431 sig = uci.cpu_sig.sig;
433 rev = uci.cpu_sig.rev;
434 pr_debug("CPU: sig=0x%x, pf=0x%x, rev=0x%x\n", sig, pf, rev);
436 list_for_each_entry(p, µcode_cache, plist) {
437 struct microcode_header_intel *mc_saved_header;
438 struct extended_sigtable *ext_header;
439 struct extended_signature *ext_sig;
442 mc_saved_header = (struct microcode_header_intel *)p->data;
444 sig = mc_saved_header->sig;
445 pf = mc_saved_header->pf;
446 rev = mc_saved_header->rev;
447 date = mc_saved_header->date;
449 total_size = get_totalsize(mc_saved_header);
450 data_size = get_datasize(mc_saved_header);
452 pr_debug("mc_saved[%d]: sig=0x%x, pf=0x%x, rev=0x%x, total size=0x%x, date = %04x-%02x-%02x\n",
453 i++, sig, pf, rev, total_size,
456 (date >> 16) & 0xff);
458 /* Look for ext. headers: */
459 if (total_size <= data_size + MC_HEADER_SIZE)
462 ext_header = (void *)mc_saved_header + data_size + MC_HEADER_SIZE;
463 ext_sigcount = ext_header->count;
464 ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
466 for (j = 0; j < ext_sigcount; j++) {
470 pr_debug("\tExtended[%d]: sig=0x%x, pf=0x%x\n",
480 * Save this microcode patch. It will be loaded early when a CPU is
481 * hot-added or resumes.
483 static void save_mc_for_early(u8 *mc, unsigned int size)
485 #ifdef CONFIG_HOTPLUG_CPU
486 /* Synchronization during CPU hotplug. */
487 static DEFINE_MUTEX(x86_cpu_microcode_mutex);
489 mutex_lock(&x86_cpu_microcode_mutex);
491 save_microcode_patch(mc, size);
494 mutex_unlock(&x86_cpu_microcode_mutex);
498 static bool load_builtin_intel_microcode(struct cpio_data *cp)
500 unsigned int eax = 1, ebx, ecx = 0, edx;
503 if (IS_ENABLED(CONFIG_X86_32))
506 native_cpuid(&eax, &ebx, &ecx, &edx);
508 sprintf(name, "intel-ucode/%02x-%02x-%02x",
509 x86_family(eax), x86_model(eax), x86_stepping(eax));
511 return get_builtin_firmware(cp, name);
515 * Print ucode update info.
518 print_ucode_info(struct ucode_cpu_info *uci, unsigned int date)
520 pr_info_once("microcode updated early to revision 0x%x, date = %04x-%02x-%02x\n",
524 (date >> 16) & 0xff);
529 static int delay_ucode_info;
530 static int current_mc_date;
533 * Print early updated ucode info after printk works. This is delayed info dump.
535 void show_ucode_info_early(void)
537 struct ucode_cpu_info uci;
539 if (delay_ucode_info) {
540 collect_cpu_info_early(&uci);
541 print_ucode_info(&uci, current_mc_date);
542 delay_ucode_info = 0;
547 * At this point, we can not call printk() yet. Delay printing microcode info in
548 * show_ucode_info_early() until printk() works.
550 static void print_ucode(struct ucode_cpu_info *uci)
552 struct microcode_intel *mc;
553 int *delay_ucode_info_p;
554 int *current_mc_date_p;
560 delay_ucode_info_p = (int *)__pa_nodebug(&delay_ucode_info);
561 current_mc_date_p = (int *)__pa_nodebug(¤t_mc_date);
563 *delay_ucode_info_p = 1;
564 *current_mc_date_p = mc->hdr.date;
569 * Flush global tlb. We only do this in x86_64 where paging has been enabled
570 * already and PGE should be enabled as well.
572 static inline void flush_tlb_early(void)
574 __native_flush_tlb_global_irq_disabled();
577 static inline void print_ucode(struct ucode_cpu_info *uci)
579 struct microcode_intel *mc;
585 print_ucode_info(uci, mc->hdr.date);
589 static int apply_microcode_early(struct ucode_cpu_info *uci, bool early)
591 struct microcode_intel *mc;
598 /* write microcode via MSR 0x79 */
599 native_wrmsrl(MSR_IA32_UCODE_WRITE, (unsigned long)mc->bits);
601 rev = intel_get_microcode_revision();
602 if (rev != mc->hdr.rev)
606 /* Flush global tlb. This is precaution. */
609 uci->cpu_sig.rev = rev;
614 print_ucode_info(uci, mc->hdr.date);
619 int __init save_microcode_in_initrd_intel(void)
621 struct ucode_cpu_info uci;
625 * initrd is going away, clear patch ptr. We will scan the microcode one
626 * last time before jettisoning and save a patch, if found. Then we will
627 * update that pointer too, with a stable patch address to use when
628 * resuming the cores.
630 intel_ucode_patch = NULL;
632 if (!load_builtin_intel_microcode(&cp))
633 cp = find_microcode_in_initrd(ucode_path, false);
635 if (!(cp.data && cp.size))
638 collect_cpu_info_early(&uci);
640 scan_microcode(cp.data, cp.size, &uci, true);
648 * @res_patch, output: a pointer to the patch we found.
650 static struct microcode_intel *__load_ucode_intel(struct ucode_cpu_info *uci)
652 static const char *path;
656 if (IS_ENABLED(CONFIG_X86_32)) {
657 path = (const char *)__pa_nodebug(ucode_path);
664 /* try built-in microcode first */
665 if (!load_builtin_intel_microcode(&cp))
666 cp = find_microcode_in_initrd(path, use_pa);
668 if (!(cp.data && cp.size))
671 collect_cpu_info_early(uci);
673 return scan_microcode(cp.data, cp.size, uci, false);
676 void __init load_ucode_intel_bsp(void)
678 struct microcode_intel *patch;
679 struct ucode_cpu_info uci;
681 patch = __load_ucode_intel(&uci);
687 apply_microcode_early(&uci, true);
690 void load_ucode_intel_ap(void)
692 struct microcode_intel *patch, **iup;
693 struct ucode_cpu_info uci;
695 if (IS_ENABLED(CONFIG_X86_32))
696 iup = (struct microcode_intel **) __pa_nodebug(&intel_ucode_patch);
698 iup = &intel_ucode_patch;
702 patch = __load_ucode_intel(&uci);
711 if (apply_microcode_early(&uci, true)) {
712 /* Mixed-silicon system? Try to refetch the proper patch: */
719 static struct microcode_intel *find_patch(struct ucode_cpu_info *uci)
721 struct microcode_header_intel *phdr;
722 struct ucode_patch *iter, *tmp;
724 list_for_each_entry_safe(iter, tmp, µcode_cache, plist) {
726 phdr = (struct microcode_header_intel *)iter->data;
728 if (phdr->rev <= uci->cpu_sig.rev)
731 if (!find_matching_signature(phdr,
741 void reload_ucode_intel(void)
743 struct microcode_intel *p;
744 struct ucode_cpu_info uci;
746 collect_cpu_info_early(&uci);
748 p = find_patch(&uci);
754 apply_microcode_early(&uci, false);
757 static int collect_cpu_info(int cpu_num, struct cpu_signature *csig)
759 static struct cpu_signature prev;
760 struct cpuinfo_x86 *c = &cpu_data(cpu_num);
763 memset(csig, 0, sizeof(*csig));
765 csig->sig = cpuid_eax(0x00000001);
767 if ((c->x86_model >= 5) || (c->x86 > 6)) {
768 /* get processor flags from MSR 0x17 */
769 rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
770 csig->pf = 1 << ((val[1] >> 18) & 7);
773 csig->rev = c->microcode;
775 /* No extra locking on prev, races are harmless. */
776 if (csig->sig != prev.sig || csig->pf != prev.pf || csig->rev != prev.rev) {
777 pr_info("sig=0x%x, pf=0x%x, revision=0x%x\n",
778 csig->sig, csig->pf, csig->rev);
785 static int apply_microcode_intel(int cpu)
787 struct microcode_intel *mc;
788 struct ucode_cpu_info *uci;
789 struct cpuinfo_x86 *c;
793 /* We should bind the task to the CPU */
794 if (WARN_ON(raw_smp_processor_id() != cpu))
797 uci = ucode_cpu_info + cpu;
800 /* Look for a newer patch in our cache: */
801 mc = find_patch(uci);
806 /* write microcode via MSR 0x79 */
807 wrmsrl(MSR_IA32_UCODE_WRITE, (unsigned long)mc->bits);
809 rev = intel_get_microcode_revision();
811 if (rev != mc->hdr.rev) {
812 pr_err("CPU%d update to revision 0x%x failed\n",
817 if (rev != prev_rev) {
818 pr_info("updated to revision 0x%x, date = %04x-%02x-%02x\n",
820 mc->hdr.date & 0xffff,
822 (mc->hdr.date >> 16) & 0xff);
828 uci->cpu_sig.rev = rev;
834 static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size,
835 int (*get_ucode_data)(void *, const void *, size_t))
837 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
838 u8 *ucode_ptr = data, *new_mc = NULL, *mc = NULL;
839 int new_rev = uci->cpu_sig.rev;
840 unsigned int leftover = size;
841 unsigned int curr_mc_size = 0, new_mc_size = 0;
842 unsigned int csig, cpf;
845 struct microcode_header_intel mc_header;
846 unsigned int mc_size;
848 if (leftover < sizeof(mc_header)) {
849 pr_err("error! Truncated header in microcode data file\n");
853 if (get_ucode_data(&mc_header, ucode_ptr, sizeof(mc_header)))
856 mc_size = get_totalsize(&mc_header);
857 if (!mc_size || mc_size > leftover) {
858 pr_err("error! Bad data in microcode data file\n");
862 /* For performance reasons, reuse mc area when possible */
863 if (!mc || mc_size > curr_mc_size) {
865 mc = vmalloc(mc_size);
868 curr_mc_size = mc_size;
871 if (get_ucode_data(mc, ucode_ptr, mc_size) ||
872 microcode_sanity_check(mc, 1) < 0) {
876 csig = uci->cpu_sig.sig;
877 cpf = uci->cpu_sig.pf;
878 if (has_newer_microcode(mc, csig, cpf, new_rev)) {
880 new_rev = mc_header.rev;
882 new_mc_size = mc_size;
883 mc = NULL; /* trigger new vmalloc */
886 ucode_ptr += mc_size;
901 uci->mc = (struct microcode_intel *)new_mc;
904 * If early loading microcode is supported, save this mc into
905 * permanent memory. So it will be loaded early when a CPU is hot added
908 save_mc_for_early(new_mc, new_mc_size);
910 pr_debug("CPU%d found a matching microcode update with version 0x%x (current=0x%x)\n",
911 cpu, new_rev, uci->cpu_sig.rev);
916 static int get_ucode_fw(void *to, const void *from, size_t n)
922 static bool is_blacklisted(unsigned int cpu)
924 struct cpuinfo_x86 *c = &cpu_data(cpu);
926 if (c->x86 == 6 && c->x86_model == INTEL_FAM6_BROADWELL_X) {
927 pr_err_once("late loading on model 79 is disabled.\n");
934 static enum ucode_state request_microcode_fw(int cpu, struct device *device,
938 struct cpuinfo_x86 *c = &cpu_data(cpu);
939 const struct firmware *firmware;
940 enum ucode_state ret;
942 if (is_blacklisted(cpu))
945 sprintf(name, "intel-ucode/%02x-%02x-%02x",
946 c->x86, c->x86_model, c->x86_mask);
948 if (request_firmware_direct(&firmware, name, device)) {
949 pr_debug("data file %s load failed\n", name);
953 ret = generic_load_microcode(cpu, (void *)firmware->data,
954 firmware->size, &get_ucode_fw);
956 release_firmware(firmware);
961 static int get_ucode_user(void *to, const void *from, size_t n)
963 return copy_from_user(to, from, n);
966 static enum ucode_state
967 request_microcode_user(int cpu, const void __user *buf, size_t size)
969 if (is_blacklisted(cpu))
972 return generic_load_microcode(cpu, (void *)buf, size, &get_ucode_user);
975 static struct microcode_ops microcode_intel_ops = {
976 .request_microcode_user = request_microcode_user,
977 .request_microcode_fw = request_microcode_fw,
978 .collect_cpu_info = collect_cpu_info,
979 .apply_microcode = apply_microcode_intel,
982 struct microcode_ops * __init init_intel_microcode(void)
984 struct cpuinfo_x86 *c = &boot_cpu_data;
986 if (c->x86_vendor != X86_VENDOR_INTEL || c->x86 < 6 ||
987 cpu_has(c, X86_FEATURE_IA64)) {
988 pr_err("Intel CPU family 0x%x not supported\n", c->x86);
992 return µcode_intel_ops;