2 * AMD CPU Microcode Update Driver for Linux
4 * This driver allows to upgrade microcode on F10h AMD
7 * Copyright (C) 2008-2011 Advanced Micro Devices Inc.
8 * 2013-2016 Borislav Petkov <bp@alien8.de>
10 * Author: Peter Oruba <peter.oruba@amd.com>
13 * Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
16 * Copyright (C) 2013 Advanced Micro Devices, Inc.
18 * Author: Jacob Shin <jacob.shin@amd.com>
19 * Fixes: Borislav Petkov <bp@suse.de>
21 * Licensed under the terms of the GNU General Public
22 * License version 2. See file COPYING for details.
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/pci.h>
34 #include <asm/microcode_amd.h>
35 #include <asm/microcode.h>
36 #include <asm/processor.h>
37 #include <asm/setup.h>
41 static struct equiv_cpu_entry *equiv_cpu_table;
44 * This points to the current valid container of microcode patches which we will
45 * save from the initrd/builtin before jettisoning its contents. @mc is the
46 * microcode patch we found to match.
49 struct microcode_amd *mc;
56 static u32 ucode_new_rev;
57 static u8 amd_ucode_patch[PATCH_MAX_SIZE];
60 * Microcode patch container file is prepended to the initrd in cpio
61 * format. See Documentation/x86/early-microcode.txt
64 ucode_path[] __maybe_unused = "kernel/x86/microcode/AuthenticAMD.bin";
66 static u16 find_equiv_id(struct equiv_cpu_entry *equiv_table, u32 sig)
68 for (; equiv_table && equiv_table->installed_cpu; equiv_table++) {
69 if (sig == equiv_table->installed_cpu)
70 return equiv_table->equiv_cpu;
77 * This scans the ucode blob for the proper container as we can have multiple
78 * containers glued together. Returns the equivalence ID from the equivalence
79 * table or 0 if none found.
80 * Returns the amount of bytes consumed while scanning. @desc contains all the
81 * data we're going to use in later stages of the application.
83 static ssize_t parse_container(u8 *ucode, ssize_t size, struct cont_desc *desc)
85 struct equiv_cpu_entry *eq;
86 ssize_t orig_size = size;
87 u32 *hdr = (u32 *)ucode;
91 /* Am I looking at an equivalence table header? */
92 if (hdr[0] != UCODE_MAGIC ||
93 hdr[1] != UCODE_EQUIV_CPU_TABLE_TYPE ||
95 return CONTAINER_HDR_SZ;
99 eq = (struct equiv_cpu_entry *)(buf + CONTAINER_HDR_SZ);
101 /* Find the equivalence ID of our CPU in this table: */
102 eq_id = find_equiv_id(eq, desc->cpuid_1_eax);
104 buf += hdr[2] + CONTAINER_HDR_SZ;
105 size -= hdr[2] + CONTAINER_HDR_SZ;
108 * Scan through the rest of the container to find where it ends. We do
109 * some basic sanity-checking too.
112 struct microcode_amd *mc;
117 if (hdr[0] != UCODE_UCODE_TYPE)
120 /* Sanity-check patch size. */
122 if (patch_size > PATCH_MAX_SIZE)
125 /* Skip patch section header: */
126 buf += SECTION_HDR_SIZE;
127 size -= SECTION_HDR_SIZE;
129 mc = (struct microcode_amd *)buf;
130 if (eq_id == mc->hdr.processor_rev_id) {
131 desc->psize = patch_size;
140 * If we have found a patch (desc->mc), it means we're looking at the
141 * container which has a patch for this CPU so return 0 to mean, @ucode
142 * already points to the proper container. Otherwise, we return the size
143 * we scanned so that we can advance to the next container in the
148 desc->size = orig_size - size;
153 return orig_size - size;
157 * Scan the ucode blob for the proper container as we can have multiple
158 * containers glued together.
160 static void scan_containers(u8 *ucode, size_t size, struct cont_desc *desc)
165 ssize_t s = parse_container(ucode, rem, desc);
174 static int __apply_microcode_amd(struct microcode_amd *mc)
178 native_wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc->hdr.data_code);
180 /* verify patch application was successful */
181 native_rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
182 if (rev != mc->hdr.patch_id)
189 * Early load occurs before we can vmalloc(). So we look for the microcode
190 * patch container file in initrd, traverse equivalent cpu table, look for a
191 * matching microcode patch, and update, all in initrd memory in place.
192 * When vmalloc() is available for use later -- on 64-bit during first AP load,
193 * and on 32-bit during save_microcode_in_initrd_amd() -- we can call
194 * load_microcode_amd() to save equivalent cpu table and microcode patches in
195 * kernel heap memory.
197 * Returns true if container found (sets @desc), false otherwise.
200 apply_microcode_early_amd(u32 cpuid_1_eax, void *ucode, size_t size, bool save_patch)
202 struct cont_desc desc = { 0 };
203 u8 (*patch)[PATCH_MAX_SIZE];
204 struct microcode_amd *mc;
205 u32 rev, dummy, *new_rev;
209 new_rev = (u32 *)__pa_nodebug(&ucode_new_rev);
210 patch = (u8 (*)[PATCH_MAX_SIZE])__pa_nodebug(&amd_ucode_patch);
212 new_rev = &ucode_new_rev;
213 patch = &amd_ucode_patch;
216 desc.cpuid_1_eax = cpuid_1_eax;
218 scan_containers(ucode, size, &desc);
224 native_rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
225 if (rev >= mc->hdr.patch_id)
228 if (!__apply_microcode_amd(mc)) {
229 *new_rev = mc->hdr.patch_id;
233 memcpy(patch, mc, min_t(u32, desc.psize, PATCH_MAX_SIZE));
239 static bool get_builtin_microcode(struct cpio_data *cp, unsigned int family)
242 char fw_name[36] = "amd-ucode/microcode_amd.bin";
245 snprintf(fw_name, sizeof(fw_name),
246 "amd-ucode/microcode_amd_fam%.2xh.bin", family);
248 return get_builtin_firmware(cp, fw_name);
254 void __load_ucode_amd(unsigned int cpuid_1_eax, struct cpio_data *ret)
256 struct ucode_cpu_info *uci;
261 if (IS_ENABLED(CONFIG_X86_32)) {
262 uci = (struct ucode_cpu_info *)__pa_nodebug(ucode_cpu_info);
263 path = (const char *)__pa_nodebug(ucode_path);
266 uci = ucode_cpu_info;
271 if (!get_builtin_microcode(&cp, x86_family(cpuid_1_eax)))
272 cp = find_microcode_in_initrd(path, use_pa);
274 /* Needed in load_microcode_amd() */
275 uci->cpu_sig.sig = cpuid_1_eax;
280 void __init load_ucode_amd_bsp(unsigned int cpuid_1_eax)
282 struct cpio_data cp = { };
284 __load_ucode_amd(cpuid_1_eax, &cp);
285 if (!(cp.data && cp.size))
288 apply_microcode_early_amd(cpuid_1_eax, cp.data, cp.size, true);
291 void load_ucode_amd_ap(unsigned int cpuid_1_eax)
293 struct microcode_amd *mc;
295 u32 *new_rev, rev, dummy;
297 if (IS_ENABLED(CONFIG_X86_32)) {
298 mc = (struct microcode_amd *)__pa_nodebug(amd_ucode_patch);
299 new_rev = (u32 *)__pa_nodebug(&ucode_new_rev);
301 mc = (struct microcode_amd *)amd_ucode_patch;
302 new_rev = &ucode_new_rev;
305 native_rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
307 /* Check whether we have saved a new patch already: */
308 if (*new_rev && rev < mc->hdr.patch_id) {
309 if (!__apply_microcode_amd(mc)) {
310 *new_rev = mc->hdr.patch_id;
315 __load_ucode_amd(cpuid_1_eax, &cp);
316 if (!(cp.data && cp.size))
319 apply_microcode_early_amd(cpuid_1_eax, cp.data, cp.size, false);
322 static enum ucode_state
323 load_microcode_amd(int cpu, u8 family, const u8 *data, size_t size);
325 int __init save_microcode_in_initrd_amd(unsigned int cpuid_1_eax)
327 struct cont_desc desc = { 0 };
328 enum ucode_state ret;
331 cp = find_microcode_in_initrd(ucode_path, false);
332 if (!(cp.data && cp.size))
335 desc.cpuid_1_eax = cpuid_1_eax;
337 scan_containers(cp.data, cp.size, &desc);
341 ret = load_microcode_amd(smp_processor_id(), x86_family(cpuid_1_eax),
342 desc.data, desc.size);
349 void reload_ucode_amd(void)
351 struct microcode_amd *mc;
354 mc = (struct microcode_amd *)amd_ucode_patch;
356 rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
358 if (rev < mc->hdr.patch_id) {
359 if (!__apply_microcode_amd(mc)) {
360 ucode_new_rev = mc->hdr.patch_id;
361 pr_info("reload patch_level=0x%08x\n", ucode_new_rev);
365 static u16 __find_equiv_id(unsigned int cpu)
367 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
368 return find_equiv_id(equiv_cpu_table, uci->cpu_sig.sig);
371 static u32 find_cpu_family_by_equiv_cpu(u16 equiv_cpu)
375 BUG_ON(!equiv_cpu_table);
377 while (equiv_cpu_table[i].equiv_cpu != 0) {
378 if (equiv_cpu == equiv_cpu_table[i].equiv_cpu)
379 return equiv_cpu_table[i].installed_cpu;
386 * a small, trivial cache of per-family ucode patches
388 static struct ucode_patch *cache_find_patch(u16 equiv_cpu)
390 struct ucode_patch *p;
392 list_for_each_entry(p, µcode_cache, plist)
393 if (p->equiv_cpu == equiv_cpu)
398 static void update_cache(struct ucode_patch *new_patch)
400 struct ucode_patch *p;
402 list_for_each_entry(p, µcode_cache, plist) {
403 if (p->equiv_cpu == new_patch->equiv_cpu) {
404 if (p->patch_id >= new_patch->patch_id)
405 /* we already have the latest patch */
408 list_replace(&p->plist, &new_patch->plist);
414 /* no patch found, add it */
415 list_add_tail(&new_patch->plist, µcode_cache);
418 static void free_cache(void)
420 struct ucode_patch *p, *tmp;
422 list_for_each_entry_safe(p, tmp, µcode_cache, plist) {
423 __list_del(p->plist.prev, p->plist.next);
429 static struct ucode_patch *find_patch(unsigned int cpu)
433 equiv_id = __find_equiv_id(cpu);
437 return cache_find_patch(equiv_id);
440 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
442 struct cpuinfo_x86 *c = &cpu_data(cpu);
443 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
444 struct ucode_patch *p;
446 csig->sig = cpuid_eax(0x00000001);
447 csig->rev = c->microcode;
450 * a patch could have been loaded early, set uci->mc so that
451 * mc_bp_resume() can call apply_microcode()
454 if (p && (p->patch_id == csig->rev))
457 pr_info("CPU%d: patch_level=0x%08x\n", cpu, csig->rev);
462 static unsigned int verify_patch_size(u8 family, u32 patch_size,
467 #define F1XH_MPB_MAX_SIZE 2048
468 #define F14H_MPB_MAX_SIZE 1824
469 #define F15H_MPB_MAX_SIZE 4096
470 #define F16H_MPB_MAX_SIZE 3458
474 max_size = F14H_MPB_MAX_SIZE;
477 max_size = F15H_MPB_MAX_SIZE;
480 max_size = F16H_MPB_MAX_SIZE;
483 max_size = F1XH_MPB_MAX_SIZE;
487 if (patch_size > min_t(u32, size, max_size)) {
488 pr_err("patch size mismatch\n");
495 static int apply_microcode_amd(int cpu)
497 struct cpuinfo_x86 *c = &cpu_data(cpu);
498 struct microcode_amd *mc_amd;
499 struct ucode_cpu_info *uci;
500 struct ucode_patch *p;
503 BUG_ON(raw_smp_processor_id() != cpu);
505 uci = ucode_cpu_info + cpu;
514 rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
516 /* need to apply patch? */
517 if (rev >= mc_amd->hdr.patch_id) {
519 uci->cpu_sig.rev = rev;
523 if (__apply_microcode_amd(mc_amd)) {
524 pr_err("CPU%d: update failed for patch_level=0x%08x\n",
525 cpu, mc_amd->hdr.patch_id);
528 pr_info("CPU%d: new patch_level=0x%08x\n", cpu,
529 mc_amd->hdr.patch_id);
531 uci->cpu_sig.rev = mc_amd->hdr.patch_id;
532 c->microcode = mc_amd->hdr.patch_id;
537 static int install_equiv_cpu_table(const u8 *buf)
539 unsigned int *ibuf = (unsigned int *)buf;
540 unsigned int type = ibuf[1];
541 unsigned int size = ibuf[2];
543 if (type != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
544 pr_err("empty section/"
545 "invalid type field in container file section header\n");
549 equiv_cpu_table = vmalloc(size);
550 if (!equiv_cpu_table) {
551 pr_err("failed to allocate equivalent CPU table\n");
555 memcpy(equiv_cpu_table, buf + CONTAINER_HDR_SZ, size);
557 /* add header length */
558 return size + CONTAINER_HDR_SZ;
561 static void free_equiv_cpu_table(void)
563 vfree(equiv_cpu_table);
564 equiv_cpu_table = NULL;
567 static void cleanup(void)
569 free_equiv_cpu_table();
574 * We return the current size even if some of the checks failed so that
575 * we can skip over the next patch. If we return a negative value, we
576 * signal a grave error like a memory allocation has failed and the
577 * driver cannot continue functioning normally. In such cases, we tear
578 * down everything we've used up so far and exit.
580 static int verify_and_add_patch(u8 family, u8 *fw, unsigned int leftover)
582 struct microcode_header_amd *mc_hdr;
583 struct ucode_patch *patch;
584 unsigned int patch_size, crnt_size, ret;
588 patch_size = *(u32 *)(fw + 4);
589 crnt_size = patch_size + SECTION_HDR_SIZE;
590 mc_hdr = (struct microcode_header_amd *)(fw + SECTION_HDR_SIZE);
591 proc_id = mc_hdr->processor_rev_id;
593 proc_fam = find_cpu_family_by_equiv_cpu(proc_id);
595 pr_err("No patch family for equiv ID: 0x%04x\n", proc_id);
599 /* check if patch is for the current family */
600 proc_fam = ((proc_fam >> 8) & 0xf) + ((proc_fam >> 20) & 0xff);
601 if (proc_fam != family)
604 if (mc_hdr->nb_dev_id || mc_hdr->sb_dev_id) {
605 pr_err("Patch-ID 0x%08x: chipset-specific code unsupported.\n",
610 ret = verify_patch_size(family, patch_size, leftover);
612 pr_err("Patch-ID 0x%08x: size mismatch.\n", mc_hdr->patch_id);
616 patch = kzalloc(sizeof(*patch), GFP_KERNEL);
618 pr_err("Patch allocation failure.\n");
622 patch->data = kmemdup(fw + SECTION_HDR_SIZE, patch_size, GFP_KERNEL);
624 pr_err("Patch data allocation failure.\n");
629 INIT_LIST_HEAD(&patch->plist);
630 patch->patch_id = mc_hdr->patch_id;
631 patch->equiv_cpu = proc_id;
633 pr_debug("%s: Added patch_id: 0x%08x, proc_id: 0x%04x\n",
634 __func__, patch->patch_id, proc_id);
636 /* ... and add to cache. */
642 static enum ucode_state __load_microcode_amd(u8 family, const u8 *data,
645 enum ucode_state ret = UCODE_ERROR;
646 unsigned int leftover;
651 offset = install_equiv_cpu_table(data);
653 pr_err("failed to create equivalent cpu table\n");
657 leftover = size - offset;
659 if (*(u32 *)fw != UCODE_UCODE_TYPE) {
660 pr_err("invalid type field in container file section header\n");
661 free_equiv_cpu_table();
666 crnt_size = verify_and_add_patch(family, fw, leftover);
671 leftover -= crnt_size;
677 static enum ucode_state
678 load_microcode_amd(int cpu, u8 family, const u8 *data, size_t size)
680 enum ucode_state ret;
682 /* free old equiv table */
683 free_equiv_cpu_table();
685 ret = __load_microcode_amd(family, data, size);
691 /* save BSP's matching patch for early load */
692 if (cpu_data(cpu).cpu_index == boot_cpu_data.cpu_index) {
693 struct ucode_patch *p = find_patch(cpu);
695 memset(amd_ucode_patch, 0, PATCH_MAX_SIZE);
696 memcpy(amd_ucode_patch, p->data, min_t(u32, ksize(p->data),
705 * AMD microcode firmware naming convention, up to family 15h they are in
708 * amd-ucode/microcode_amd.bin
710 * This legacy file is always smaller than 2K in size.
712 * Beginning with family 15h, they are in family-specific firmware files:
714 * amd-ucode/microcode_amd_fam15h.bin
715 * amd-ucode/microcode_amd_fam16h.bin
718 * These might be larger than 2K.
720 static enum ucode_state request_microcode_amd(int cpu, struct device *device,
723 char fw_name[36] = "amd-ucode/microcode_amd.bin";
724 struct cpuinfo_x86 *c = &cpu_data(cpu);
725 enum ucode_state ret = UCODE_NFOUND;
726 const struct firmware *fw;
728 /* reload ucode container only on the boot cpu */
729 if (!refresh_fw || c->cpu_index != boot_cpu_data.cpu_index)
733 snprintf(fw_name, sizeof(fw_name), "amd-ucode/microcode_amd_fam%.2xh.bin", c->x86);
735 if (request_firmware_direct(&fw, (const char *)fw_name, device)) {
736 pr_debug("failed to load file %s\n", fw_name);
741 if (*(u32 *)fw->data != UCODE_MAGIC) {
742 pr_err("invalid magic value (0x%08x)\n", *(u32 *)fw->data);
746 ret = load_microcode_amd(cpu, c->x86, fw->data, fw->size);
749 release_firmware(fw);
755 static enum ucode_state
756 request_microcode_user(int cpu, const void __user *buf, size_t size)
761 static void microcode_fini_cpu_amd(int cpu)
763 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
768 static struct microcode_ops microcode_amd_ops = {
769 .request_microcode_user = request_microcode_user,
770 .request_microcode_fw = request_microcode_amd,
771 .collect_cpu_info = collect_cpu_info_amd,
772 .apply_microcode = apply_microcode_amd,
773 .microcode_fini_cpu = microcode_fini_cpu_amd,
776 struct microcode_ops * __init init_amd_microcode(void)
778 struct cpuinfo_x86 *c = &boot_cpu_data;
780 if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
781 pr_warn("AMD CPU family 0x%x not supported\n", c->x86);
786 pr_info_once("microcode updated early to new patch_level=0x%08x\n",
789 return µcode_amd_ops;
792 void __exit exit_amd_microcode(void)