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 * 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/processor.h>
38 #include <asm/tlbflush.h>
39 #include <asm/setup.h>
42 static const char ucode_path[] = "kernel/x86/microcode/GenuineIntel.bin";
44 /* Current microcode patch used in early patching */
45 struct microcode_intel *intel_ucode_patch;
47 static inline bool cpu_signatures_match(unsigned int s1, unsigned int p1,
48 unsigned int s2, unsigned int p2)
53 /* Processor flags are either both 0 ... */
57 /* ... or they intersect. */
62 * Returns 1 if update has been found, 0 otherwise.
64 static int find_matching_signature(void *mc, unsigned int csig, int cpf)
66 struct microcode_header_intel *mc_hdr = mc;
67 struct extended_sigtable *ext_hdr;
68 struct extended_signature *ext_sig;
71 if (cpu_signatures_match(csig, cpf, mc_hdr->sig, mc_hdr->pf))
74 /* Look for ext. headers: */
75 if (get_totalsize(mc_hdr) <= get_datasize(mc_hdr) + MC_HEADER_SIZE)
78 ext_hdr = mc + get_datasize(mc_hdr) + MC_HEADER_SIZE;
79 ext_sig = (void *)ext_hdr + EXT_HEADER_SIZE;
81 for (i = 0; i < ext_hdr->count; i++) {
82 if (cpu_signatures_match(csig, cpf, ext_sig->sig, ext_sig->pf))
90 * Returns 1 if update has been found, 0 otherwise.
92 static int has_newer_microcode(void *mc, unsigned int csig, int cpf, int new_rev)
94 struct microcode_header_intel *mc_hdr = mc;
96 if (mc_hdr->rev <= new_rev)
99 return find_matching_signature(mc, csig, cpf);
103 * Given CPU signature and a microcode patch, this function finds if the
104 * microcode patch has matching family and model with the CPU.
106 * %true - if there's a match
109 static bool microcode_matches(struct microcode_header_intel *mc_header,
112 unsigned long total_size = get_totalsize(mc_header);
113 unsigned long data_size = get_datasize(mc_header);
114 struct extended_sigtable *ext_header;
115 unsigned int fam_ucode, model_ucode;
116 struct extended_signature *ext_sig;
117 unsigned int fam, model;
120 fam = x86_family(sig);
121 model = x86_model(sig);
123 fam_ucode = x86_family(mc_header->sig);
124 model_ucode = x86_model(mc_header->sig);
126 if (fam == fam_ucode && model == model_ucode)
129 /* Look for ext. headers: */
130 if (total_size <= data_size + MC_HEADER_SIZE)
133 ext_header = (void *) mc_header + data_size + MC_HEADER_SIZE;
134 ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
135 ext_sigcount = ext_header->count;
137 for (i = 0; i < ext_sigcount; i++) {
138 fam_ucode = x86_family(ext_sig->sig);
139 model_ucode = x86_model(ext_sig->sig);
141 if (fam == fam_ucode && model == model_ucode)
149 static struct ucode_patch *__alloc_microcode_buf(void *data, unsigned int size)
151 struct ucode_patch *p;
153 p = kzalloc(size, GFP_KERNEL);
155 return ERR_PTR(-ENOMEM);
157 p->data = kmemdup(data, size, GFP_KERNEL);
160 return ERR_PTR(-ENOMEM);
166 static void save_microcode_patch(void *data, unsigned int size)
168 struct microcode_header_intel *mc_hdr, *mc_saved_hdr;
169 struct ucode_patch *iter, *tmp, *p;
170 bool prev_found = false;
171 unsigned int sig, pf;
173 mc_hdr = (struct microcode_header_intel *)data;
175 list_for_each_entry_safe(iter, tmp, µcode_cache, plist) {
176 mc_saved_hdr = (struct microcode_header_intel *)iter->data;
177 sig = mc_saved_hdr->sig;
178 pf = mc_saved_hdr->pf;
180 if (find_matching_signature(data, sig, pf)) {
183 if (mc_hdr->rev <= mc_saved_hdr->rev)
186 p = __alloc_microcode_buf(data, size);
188 pr_err("Error allocating buffer %p\n", data);
190 list_replace(&iter->plist, &p->plist);
195 * There weren't any previous patches found in the list cache; save the
199 p = __alloc_microcode_buf(data, size);
201 pr_err("Error allocating buffer for %p\n", data);
203 list_add_tail(&p->plist, µcode_cache);
207 static int microcode_sanity_check(void *mc, int print_err)
209 unsigned long total_size, data_size, ext_table_size;
210 struct microcode_header_intel *mc_header = mc;
211 struct extended_sigtable *ext_header = NULL;
212 u32 sum, orig_sum, ext_sigcount = 0, i;
213 struct extended_signature *ext_sig;
215 total_size = get_totalsize(mc_header);
216 data_size = get_datasize(mc_header);
218 if (data_size + MC_HEADER_SIZE > total_size) {
220 pr_err("Error: bad microcode data file size.\n");
224 if (mc_header->ldrver != 1 || mc_header->hdrver != 1) {
226 pr_err("Error: invalid/unknown microcode update format.\n");
230 ext_table_size = total_size - (MC_HEADER_SIZE + data_size);
231 if (ext_table_size) {
232 u32 ext_table_sum = 0;
235 if ((ext_table_size < EXT_HEADER_SIZE)
236 || ((ext_table_size - EXT_HEADER_SIZE) % EXT_SIGNATURE_SIZE)) {
238 pr_err("Error: truncated extended signature table.\n");
242 ext_header = mc + MC_HEADER_SIZE + data_size;
243 if (ext_table_size != exttable_size(ext_header)) {
245 pr_err("Error: extended signature table size mismatch.\n");
249 ext_sigcount = ext_header->count;
252 * Check extended table checksum: the sum of all dwords that
253 * comprise a valid table must be 0.
255 ext_tablep = (u32 *)ext_header;
257 i = ext_table_size / sizeof(u32);
259 ext_table_sum += ext_tablep[i];
263 pr_warn("Bad extended signature table checksum, aborting.\n");
269 * Calculate the checksum of update data and header. The checksum of
270 * valid update data and header including the extended signature table
274 i = (MC_HEADER_SIZE + data_size) / sizeof(u32);
276 orig_sum += ((u32 *)mc)[i];
280 pr_err("Bad microcode data checksum, aborting.\n");
288 * Check extended signature checksum: 0 => valid.
290 for (i = 0; i < ext_sigcount; i++) {
291 ext_sig = (void *)ext_header + EXT_HEADER_SIZE +
292 EXT_SIGNATURE_SIZE * i;
294 sum = (mc_header->sig + mc_header->pf + mc_header->cksum) -
295 (ext_sig->sig + ext_sig->pf + ext_sig->cksum);
298 pr_err("Bad extended signature checksum, aborting.\n");
306 * Get microcode matching with BSP's model. Only CPUs with the same model as
307 * BSP can stay in the platform.
309 static struct microcode_intel *
310 scan_microcode(void *data, size_t size, struct ucode_cpu_info *uci, bool save)
312 struct microcode_header_intel *mc_header;
313 struct microcode_intel *patch = NULL;
314 unsigned int mc_size;
317 if (size < sizeof(struct microcode_header_intel))
320 mc_header = (struct microcode_header_intel *)data;
322 mc_size = get_totalsize(mc_header);
325 microcode_sanity_check(data, 0) < 0)
330 if (!microcode_matches(mc_header, uci->cpu_sig.sig)) {
336 save_microcode_patch(data, mc_size);
342 if (!has_newer_microcode(data,
349 struct microcode_header_intel *phdr = &patch->hdr;
351 if (!has_newer_microcode(data,
358 /* We have a newer patch, save it. */
371 static int collect_cpu_info_early(struct ucode_cpu_info *uci)
374 unsigned int family, model;
375 struct cpu_signature csig = { 0 };
376 unsigned int eax, ebx, ecx, edx;
378 memset(uci, 0, sizeof(*uci));
382 native_cpuid(&eax, &ebx, &ecx, &edx);
385 family = x86_family(eax);
386 model = x86_model(eax);
388 if ((model >= 5) || (family > 6)) {
389 /* get processor flags from MSR 0x17 */
390 native_rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
391 csig.pf = 1 << ((val[1] >> 18) & 7);
393 native_wrmsrl(MSR_IA32_UCODE_REV, 0);
395 /* As documented in the SDM: Do a CPUID 1 here */
398 /* get the current revision from MSR 0x8B */
399 native_rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
409 static void show_saved_mc(void)
413 unsigned int sig, pf, rev, total_size, data_size, date;
414 struct ucode_cpu_info uci;
415 struct ucode_patch *p;
417 if (list_empty(µcode_cache)) {
418 pr_debug("no microcode data saved.\n");
422 collect_cpu_info_early(&uci);
424 sig = uci.cpu_sig.sig;
426 rev = uci.cpu_sig.rev;
427 pr_debug("CPU: sig=0x%x, pf=0x%x, rev=0x%x\n", sig, pf, rev);
429 list_for_each_entry(p, µcode_cache, plist) {
430 struct microcode_header_intel *mc_saved_header;
431 struct extended_sigtable *ext_header;
432 struct extended_signature *ext_sig;
435 mc_saved_header = (struct microcode_header_intel *)p->data;
437 sig = mc_saved_header->sig;
438 pf = mc_saved_header->pf;
439 rev = mc_saved_header->rev;
440 date = mc_saved_header->date;
442 total_size = get_totalsize(mc_saved_header);
443 data_size = get_datasize(mc_saved_header);
445 pr_debug("mc_saved[%d]: sig=0x%x, pf=0x%x, rev=0x%x, total size=0x%x, date = %04x-%02x-%02x\n",
446 i++, sig, pf, rev, total_size,
449 (date >> 16) & 0xff);
451 /* Look for ext. headers: */
452 if (total_size <= data_size + MC_HEADER_SIZE)
455 ext_header = (void *)mc_saved_header + data_size + MC_HEADER_SIZE;
456 ext_sigcount = ext_header->count;
457 ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
459 for (j = 0; j < ext_sigcount; j++) {
463 pr_debug("\tExtended[%d]: sig=0x%x, pf=0x%x\n",
473 * Save this microcode patch. It will be loaded early when a CPU is
474 * hot-added or resumes.
476 static void save_mc_for_early(u8 *mc, unsigned int size)
478 #ifdef CONFIG_HOTPLUG_CPU
479 /* Synchronization during CPU hotplug. */
480 static DEFINE_MUTEX(x86_cpu_microcode_mutex);
482 mutex_lock(&x86_cpu_microcode_mutex);
484 save_microcode_patch(mc, size);
487 mutex_unlock(&x86_cpu_microcode_mutex);
491 static bool load_builtin_intel_microcode(struct cpio_data *cp)
493 unsigned int eax = 1, ebx, ecx = 0, edx;
496 if (IS_ENABLED(CONFIG_X86_32))
499 native_cpuid(&eax, &ebx, &ecx, &edx);
501 sprintf(name, "intel-ucode/%02x-%02x-%02x",
502 x86_family(eax), x86_model(eax), x86_stepping(eax));
504 return get_builtin_firmware(cp, name);
508 * Print ucode update info.
511 print_ucode_info(struct ucode_cpu_info *uci, unsigned int date)
513 pr_info_once("microcode updated early to revision 0x%x, date = %04x-%02x-%02x\n",
517 (date >> 16) & 0xff);
522 static int delay_ucode_info;
523 static int current_mc_date;
526 * Print early updated ucode info after printk works. This is delayed info dump.
528 void show_ucode_info_early(void)
530 struct ucode_cpu_info uci;
532 if (delay_ucode_info) {
533 collect_cpu_info_early(&uci);
534 print_ucode_info(&uci, current_mc_date);
535 delay_ucode_info = 0;
540 * At this point, we can not call printk() yet. Delay printing microcode info in
541 * show_ucode_info_early() until printk() works.
543 static void print_ucode(struct ucode_cpu_info *uci)
545 struct microcode_intel *mc;
546 int *delay_ucode_info_p;
547 int *current_mc_date_p;
553 delay_ucode_info_p = (int *)__pa_nodebug(&delay_ucode_info);
554 current_mc_date_p = (int *)__pa_nodebug(¤t_mc_date);
556 *delay_ucode_info_p = 1;
557 *current_mc_date_p = mc->hdr.date;
562 * Flush global tlb. We only do this in x86_64 where paging has been enabled
563 * already and PGE should be enabled as well.
565 static inline void flush_tlb_early(void)
567 __native_flush_tlb_global_irq_disabled();
570 static inline void print_ucode(struct ucode_cpu_info *uci)
572 struct microcode_intel *mc;
578 print_ucode_info(uci, mc->hdr.date);
582 static int apply_microcode_early(struct ucode_cpu_info *uci, bool early)
584 struct microcode_intel *mc;
591 /* write microcode via MSR 0x79 */
592 native_wrmsrl(MSR_IA32_UCODE_WRITE, (unsigned long)mc->bits);
593 native_wrmsrl(MSR_IA32_UCODE_REV, 0);
595 /* As documented in the SDM: Do a CPUID 1 here */
598 /* get the current revision from MSR 0x8B */
599 native_rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
600 if (val[1] != mc->hdr.rev)
604 /* Flush global tlb. This is precaution. */
607 uci->cpu_sig.rev = val[1];
612 print_ucode_info(uci, mc->hdr.date);
617 int __init save_microcode_in_initrd_intel(void)
619 struct ucode_cpu_info uci;
623 * AP loading didn't find any microcode patch, no need to save anything.
625 if (!intel_ucode_patch || IS_ERR(intel_ucode_patch))
628 if (!load_builtin_intel_microcode(&cp))
629 cp = find_microcode_in_initrd(ucode_path, false);
631 if (!(cp.data && cp.size))
634 collect_cpu_info_early(&uci);
636 scan_microcode(cp.data, cp.size, &uci, true);
645 * @res_patch, output: a pointer to the patch we found.
647 static struct microcode_intel *__load_ucode_intel(struct ucode_cpu_info *uci)
649 static const char *path;
653 if (IS_ENABLED(CONFIG_X86_32)) {
654 path = (const char *)__pa_nodebug(ucode_path);
661 /* try built-in microcode first */
662 if (!load_builtin_intel_microcode(&cp))
663 cp = find_microcode_in_initrd(path, use_pa);
665 if (!(cp.data && cp.size))
668 collect_cpu_info_early(uci);
670 return scan_microcode(cp.data, cp.size, uci, false);
673 void __init load_ucode_intel_bsp(void)
675 struct microcode_intel *patch;
676 struct ucode_cpu_info uci;
678 patch = __load_ucode_intel(&uci);
684 apply_microcode_early(&uci, true);
687 void load_ucode_intel_ap(void)
689 struct microcode_intel *patch, **iup;
690 struct ucode_cpu_info uci;
692 if (IS_ENABLED(CONFIG_X86_32))
693 iup = (struct microcode_intel **) __pa_nodebug(&intel_ucode_patch);
695 iup = &intel_ucode_patch;
699 patch = __load_ucode_intel(&uci);
708 if (apply_microcode_early(&uci, true)) {
709 /* Mixed-silicon system? Try to refetch the proper patch: */
716 static struct microcode_intel *find_patch(struct ucode_cpu_info *uci)
718 struct microcode_header_intel *phdr;
719 struct ucode_patch *iter, *tmp;
721 list_for_each_entry_safe(iter, tmp, µcode_cache, plist) {
723 phdr = (struct microcode_header_intel *)iter->data;
725 if (phdr->rev <= uci->cpu_sig.rev)
728 if (!find_matching_signature(phdr,
738 void reload_ucode_intel(void)
740 struct microcode_intel *p;
741 struct ucode_cpu_info uci;
743 collect_cpu_info_early(&uci);
745 p = find_patch(&uci);
751 apply_microcode_early(&uci, false);
754 static int collect_cpu_info(int cpu_num, struct cpu_signature *csig)
756 static struct cpu_signature prev;
757 struct cpuinfo_x86 *c = &cpu_data(cpu_num);
760 memset(csig, 0, sizeof(*csig));
762 csig->sig = cpuid_eax(0x00000001);
764 if ((c->x86_model >= 5) || (c->x86 > 6)) {
765 /* get processor flags from MSR 0x17 */
766 rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
767 csig->pf = 1 << ((val[1] >> 18) & 7);
770 csig->rev = c->microcode;
772 /* No extra locking on prev, races are harmless. */
773 if (csig->sig != prev.sig || csig->pf != prev.pf || csig->rev != prev.rev) {
774 pr_info("sig=0x%x, pf=0x%x, revision=0x%x\n",
775 csig->sig, csig->pf, csig->rev);
782 static int apply_microcode_intel(int cpu)
784 struct microcode_intel *mc;
785 struct ucode_cpu_info *uci;
786 struct cpuinfo_x86 *c;
790 /* We should bind the task to the CPU */
791 if (WARN_ON(raw_smp_processor_id() != cpu))
794 uci = ucode_cpu_info + cpu;
797 /* Look for a newer patch in our cache: */
798 mc = find_patch(uci);
803 /* write microcode via MSR 0x79 */
804 wrmsrl(MSR_IA32_UCODE_WRITE, (unsigned long)mc->bits);
805 wrmsrl(MSR_IA32_UCODE_REV, 0);
807 /* As documented in the SDM: Do a CPUID 1 here */
810 /* get the current revision from MSR 0x8B */
811 rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
813 if (val[1] != mc->hdr.rev) {
814 pr_err("CPU%d update to revision 0x%x failed\n",
819 if (val[1] != prev_rev) {
820 pr_info("updated to revision 0x%x, date = %04x-%02x-%02x\n",
822 mc->hdr.date & 0xffff,
824 (mc->hdr.date >> 16) & 0xff);
830 uci->cpu_sig.rev = val[1];
831 c->microcode = val[1];
836 static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size,
837 int (*get_ucode_data)(void *, const void *, size_t))
839 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
840 u8 *ucode_ptr = data, *new_mc = NULL, *mc = NULL;
841 int new_rev = uci->cpu_sig.rev;
842 unsigned int leftover = size;
843 unsigned int curr_mc_size = 0;
844 unsigned int csig, cpf;
847 struct microcode_header_intel mc_header;
848 unsigned int mc_size;
850 if (leftover < sizeof(mc_header)) {
851 pr_err("error! Truncated header in microcode data file\n");
855 if (get_ucode_data(&mc_header, ucode_ptr, sizeof(mc_header)))
858 mc_size = get_totalsize(&mc_header);
859 if (!mc_size || mc_size > leftover) {
860 pr_err("error! Bad data in microcode data file\n");
864 /* For performance reasons, reuse mc area when possible */
865 if (!mc || mc_size > curr_mc_size) {
867 mc = vmalloc(mc_size);
870 curr_mc_size = mc_size;
873 if (get_ucode_data(mc, ucode_ptr, mc_size) ||
874 microcode_sanity_check(mc, 1) < 0) {
878 csig = uci->cpu_sig.sig;
879 cpf = uci->cpu_sig.pf;
880 if (has_newer_microcode(mc, csig, cpf, new_rev)) {
882 new_rev = mc_header.rev;
884 mc = NULL; /* trigger new vmalloc */
887 ucode_ptr += mc_size;
902 uci->mc = (struct microcode_intel *)new_mc;
905 * If early loading microcode is supported, save this mc into
906 * permanent memory. So it will be loaded early when a CPU is hot added
909 save_mc_for_early(new_mc, curr_mc_size);
911 pr_debug("CPU%d found a matching microcode update with version 0x%x (current=0x%x)\n",
912 cpu, new_rev, uci->cpu_sig.rev);
917 static int get_ucode_fw(void *to, const void *from, size_t n)
923 static enum ucode_state request_microcode_fw(int cpu, struct device *device,
927 struct cpuinfo_x86 *c = &cpu_data(cpu);
928 const struct firmware *firmware;
929 enum ucode_state ret;
931 sprintf(name, "intel-ucode/%02x-%02x-%02x",
932 c->x86, c->x86_model, c->x86_mask);
934 if (request_firmware_direct(&firmware, name, device)) {
935 pr_debug("data file %s load failed\n", name);
939 ret = generic_load_microcode(cpu, (void *)firmware->data,
940 firmware->size, &get_ucode_fw);
942 release_firmware(firmware);
947 static int get_ucode_user(void *to, const void *from, size_t n)
949 return copy_from_user(to, from, n);
952 static enum ucode_state
953 request_microcode_user(int cpu, const void __user *buf, size_t size)
955 return generic_load_microcode(cpu, (void *)buf, size, &get_ucode_user);
958 static struct microcode_ops microcode_intel_ops = {
959 .request_microcode_user = request_microcode_user,
960 .request_microcode_fw = request_microcode_fw,
961 .collect_cpu_info = collect_cpu_info,
962 .apply_microcode = apply_microcode_intel,
965 struct microcode_ops * __init init_intel_microcode(void)
967 struct cpuinfo_x86 *c = &boot_cpu_data;
969 if (c->x86_vendor != X86_VENDOR_INTEL || c->x86 < 6 ||
970 cpu_has(c, X86_FEATURE_IA64)) {
971 pr_err("Intel CPU family 0x%x not supported\n", c->x86);
975 return µcode_intel_ops;