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.
9 * Author: Peter Oruba <peter.oruba@amd.com>
12 * Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
15 * Copyright (C) 2013 Advanced Micro Devices, Inc.
17 * Author: Jacob Shin <jacob.shin@amd.com>
18 * Fixes: Borislav Petkov <bp@suse.de>
20 * Licensed under the terms of the GNU General Public
21 * License version 2. See file COPYING for details.
23 #define pr_fmt(fmt) "microcode: " fmt
25 #include <linux/earlycpio.h>
26 #include <linux/firmware.h>
27 #include <linux/uaccess.h>
28 #include <linux/vmalloc.h>
29 #include <linux/initrd.h>
30 #include <linux/kernel.h>
31 #include <linux/pci.h>
33 #include <asm/microcode_amd.h>
34 #include <asm/microcode.h>
35 #include <asm/processor.h>
36 #include <asm/setup.h>
40 static struct equiv_cpu_entry
*equiv_cpu_table
;
43 struct list_head plist
;
49 static LIST_HEAD(pcache
);
52 * This points to the current valid container of microcode patches which we will
53 * save from the initrd before jettisoning its contents.
56 static size_t container_size
;
58 static u32 ucode_new_rev
;
59 u8 amd_ucode_patch
[PATCH_MAX_SIZE
];
60 static u16 this_equiv_id
;
62 static struct cpio_data ucode_cpio
;
65 * Microcode patch container file is prepended to the initrd in cpio format.
66 * See Documentation/x86/early-microcode.txt
68 static __initdata
char ucode_path
[] = "kernel/x86/microcode/AuthenticAMD.bin";
70 static struct cpio_data __init
find_ucode_in_initrd(void)
78 struct boot_params
*p
;
81 * On 32-bit, early load occurs before paging is turned on so we need
82 * to use physical addresses.
84 p
= (struct boot_params
*)__pa_nodebug(&boot_params
);
85 path
= (char *)__pa_nodebug(ucode_path
);
86 start
= (void *)p
->hdr
.ramdisk_image
;
87 size
= p
->hdr
.ramdisk_size
;
90 start
= (void *)(boot_params
.hdr
.ramdisk_image
+ PAGE_OFFSET
);
91 size
= boot_params
.hdr
.ramdisk_size
;
94 return find_cpio_data(path
, start
, size
, &offset
);
97 static size_t compute_container_size(u8
*data
, u32 total_size
)
100 u32
*header
= (u32
*)data
;
102 if (header
[0] != UCODE_MAGIC
||
103 header
[1] != UCODE_EQUIV_CPU_TABLE_TYPE
|| /* type */
104 header
[2] == 0) /* size */
107 size
= header
[2] + CONTAINER_HDR_SZ
;
114 header
= (u32
*)data
;
116 if (header
[0] != UCODE_UCODE_TYPE
)
120 * Sanity-check patch size.
122 patch_size
= header
[1];
123 if (patch_size
> PATCH_MAX_SIZE
)
126 size
+= patch_size
+ SECTION_HDR_SIZE
;
127 data
+= patch_size
+ SECTION_HDR_SIZE
;
128 total_size
-= patch_size
+ SECTION_HDR_SIZE
;
135 * Early load occurs before we can vmalloc(). So we look for the microcode
136 * patch container file in initrd, traverse equivalent cpu table, look for a
137 * matching microcode patch, and update, all in initrd memory in place.
138 * When vmalloc() is available for use later -- on 64-bit during first AP load,
139 * and on 32-bit during save_microcode_in_initrd_amd() -- we can call
140 * load_microcode_amd() to save equivalent cpu table and microcode patches in
141 * kernel heap memory.
143 static void apply_ucode_in_initrd(void *ucode
, size_t size
, bool save_patch
)
145 struct equiv_cpu_entry
*eq
;
149 u8 (*patch
)[PATCH_MAX_SIZE
];
152 u32 rev
, eax
, ebx
, ecx
, edx
;
156 new_rev
= (u32
*)__pa_nodebug(&ucode_new_rev
);
157 cont_sz
= (size_t *)__pa_nodebug(&container_size
);
158 cont
= (u8
**)__pa_nodebug(&container
);
159 patch
= (u8 (*)[PATCH_MAX_SIZE
])__pa_nodebug(&amd_ucode_patch
);
161 new_rev
= &ucode_new_rev
;
162 cont_sz
= &container_size
;
164 patch
= &amd_ucode_patch
;
169 header
= (u32
*)data
;
171 /* find equiv cpu table */
172 if (header
[0] != UCODE_MAGIC
||
173 header
[1] != UCODE_EQUIV_CPU_TABLE_TYPE
|| /* type */
174 header
[2] == 0) /* size */
179 native_cpuid(&eax
, &ebx
, &ecx
, &edx
);
182 eq
= (struct equiv_cpu_entry
*)(data
+ CONTAINER_HDR_SZ
);
186 /* Advance past the container header */
187 offset
= header
[2] + CONTAINER_HDR_SZ
;
191 eq_id
= find_equiv_id(eq
, eax
);
193 this_equiv_id
= eq_id
;
194 *cont_sz
= compute_container_size(*cont
, left
+ offset
);
197 * truncate how much we need to iterate over in the
198 * ucode update loop below
200 left
= *cont_sz
- offset
;
205 * support multiple container files appended together. if this
206 * one does not have a matching equivalent cpu entry, we fast
207 * forward to the next container file.
210 header
= (u32
*)data
;
211 if (header
[0] == UCODE_MAGIC
&&
212 header
[1] == UCODE_EQUIV_CPU_TABLE_TYPE
)
215 offset
= header
[1] + SECTION_HDR_SIZE
;
220 /* mark where the next microcode container file starts */
221 offset
= data
- (u8
*)ucode
;
231 if (check_current_patch_level(&rev
, true))
235 struct microcode_amd
*mc
;
237 header
= (u32
*)data
;
238 if (header
[0] != UCODE_UCODE_TYPE
|| /* type */
239 header
[1] == 0) /* size */
242 mc
= (struct microcode_amd
*)(data
+ SECTION_HDR_SIZE
);
244 if (eq_id
== mc
->hdr
.processor_rev_id
&& rev
< mc
->hdr
.patch_id
) {
246 if (!__apply_microcode_amd(mc
)) {
247 rev
= mc
->hdr
.patch_id
;
252 min_t(u32
, header
[1], PATCH_MAX_SIZE
));
256 offset
= header
[1] + SECTION_HDR_SIZE
;
262 static bool __init
load_builtin_amd_microcode(struct cpio_data
*cp
,
266 char fw_name
[36] = "amd-ucode/microcode_amd.bin";
269 snprintf(fw_name
, sizeof(fw_name
),
270 "amd-ucode/microcode_amd_fam%.2xh.bin", family
);
272 return get_builtin_firmware(cp
, fw_name
);
278 void __init
load_ucode_amd_bsp(unsigned int family
)
285 data
= (void **)__pa_nodebug(&ucode_cpio
.data
);
286 size
= (size_t *)__pa_nodebug(&ucode_cpio
.size
);
288 data
= &ucode_cpio
.data
;
289 size
= &ucode_cpio
.size
;
292 cp
= find_ucode_in_initrd();
294 if (!load_builtin_amd_microcode(&cp
, family
))
301 apply_ucode_in_initrd(cp
.data
, cp
.size
, true);
306 * On 32-bit, since AP's early load occurs before paging is turned on, we
307 * cannot traverse cpu_equiv_table and pcache in kernel heap memory. So during
308 * cold boot, AP will apply_ucode_in_initrd() just like the BSP. During
309 * save_microcode_in_initrd_amd() BSP's patch is copied to amd_ucode_patch,
310 * which is used upon resume from suspend.
312 void load_ucode_amd_ap(void)
314 struct microcode_amd
*mc
;
318 mc
= (struct microcode_amd
*)__pa_nodebug(amd_ucode_patch
);
319 if (mc
->hdr
.patch_id
&& mc
->hdr
.processor_rev_id
) {
320 __apply_microcode_amd(mc
);
324 ucode
= (void *)__pa_nodebug(&container
);
325 usize
= (size_t *)__pa_nodebug(&container_size
);
327 if (!*ucode
|| !*usize
)
330 apply_ucode_in_initrd(*ucode
, *usize
, false);
333 static void __init
collect_cpu_sig_on_bsp(void *arg
)
335 unsigned int cpu
= smp_processor_id();
336 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
338 uci
->cpu_sig
.sig
= cpuid_eax(0x00000001);
341 static void __init
get_bsp_sig(void)
343 unsigned int bsp
= boot_cpu_data
.cpu_index
;
344 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ bsp
;
346 if (!uci
->cpu_sig
.sig
)
347 smp_call_function_single(bsp
, collect_cpu_sig_on_bsp
, NULL
, 1);
350 void load_ucode_amd_ap(void)
352 unsigned int cpu
= smp_processor_id();
353 struct equiv_cpu_entry
*eq
;
354 struct microcode_amd
*mc
;
358 /* Exit if called on the BSP. */
366 * 64-bit runs with paging enabled, thus early==false.
368 if (check_current_patch_level(&rev
, false))
371 eax
= cpuid_eax(0x00000001);
372 eq
= (struct equiv_cpu_entry
*)(container
+ CONTAINER_HDR_SZ
);
374 eq_id
= find_equiv_id(eq
, eax
);
378 if (eq_id
== this_equiv_id
) {
379 mc
= (struct microcode_amd
*)amd_ucode_patch
;
381 if (mc
&& rev
< mc
->hdr
.patch_id
) {
382 if (!__apply_microcode_amd(mc
))
383 ucode_new_rev
= mc
->hdr
.patch_id
;
387 if (!ucode_cpio
.data
)
391 * AP has a different equivalence ID than BSP, looks like
392 * mixed-steppings silicon so go through the ucode blob anew.
394 apply_ucode_in_initrd(ucode_cpio
.data
, ucode_cpio
.size
, false);
399 int __init
save_microcode_in_initrd_amd(void)
403 enum ucode_state ret
;
412 cont
= (unsigned long)container
;
413 cont_va
= __va(container
);
416 * We need the physical address of the container for both bitness since
417 * boot_params.hdr.ramdisk_image is a physical address.
419 cont
= __pa(container
);
424 * Take into account the fact that the ramdisk might get relocated and
425 * therefore we need to recompute the container's position in virtual
428 if (relocated_ramdisk
)
429 container
= (u8
*)(__va(relocated_ramdisk
) +
430 (cont
- boot_params
.hdr
.ramdisk_image
));
435 pr_info("microcode: updated early to new patch_level=0x%08x\n",
438 eax
= cpuid_eax(0x00000001);
439 eax
= ((eax
>> 8) & 0xf) + ((eax
>> 20) & 0xff);
441 ret
= load_microcode_amd(smp_processor_id(), eax
, container
, container_size
);
446 * This will be freed any msec now, stash patches for the current
447 * family and switch to patch cache for cpu hotplug, etc later.
455 void reload_ucode_amd(void)
457 struct microcode_amd
*mc
;
461 * early==false because this is a syscore ->resume path and by
462 * that time paging is long enabled.
464 if (check_current_patch_level(&rev
, false))
467 mc
= (struct microcode_amd
*)amd_ucode_patch
;
469 if (mc
&& rev
< mc
->hdr
.patch_id
) {
470 if (!__apply_microcode_amd(mc
)) {
471 ucode_new_rev
= mc
->hdr
.patch_id
;
472 pr_info("microcode: reload patch_level=0x%08x\n",
477 static u16
__find_equiv_id(unsigned int cpu
)
479 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
480 return find_equiv_id(equiv_cpu_table
, uci
->cpu_sig
.sig
);
483 static u32
find_cpu_family_by_equiv_cpu(u16 equiv_cpu
)
487 BUG_ON(!equiv_cpu_table
);
489 while (equiv_cpu_table
[i
].equiv_cpu
!= 0) {
490 if (equiv_cpu
== equiv_cpu_table
[i
].equiv_cpu
)
491 return equiv_cpu_table
[i
].installed_cpu
;
498 * a small, trivial cache of per-family ucode patches
500 static struct ucode_patch
*cache_find_patch(u16 equiv_cpu
)
502 struct ucode_patch
*p
;
504 list_for_each_entry(p
, &pcache
, plist
)
505 if (p
->equiv_cpu
== equiv_cpu
)
510 static void update_cache(struct ucode_patch
*new_patch
)
512 struct ucode_patch
*p
;
514 list_for_each_entry(p
, &pcache
, plist
) {
515 if (p
->equiv_cpu
== new_patch
->equiv_cpu
) {
516 if (p
->patch_id
>= new_patch
->patch_id
)
517 /* we already have the latest patch */
520 list_replace(&p
->plist
, &new_patch
->plist
);
526 /* no patch found, add it */
527 list_add_tail(&new_patch
->plist
, &pcache
);
530 static void free_cache(void)
532 struct ucode_patch
*p
, *tmp
;
534 list_for_each_entry_safe(p
, tmp
, &pcache
, plist
) {
535 __list_del(p
->plist
.prev
, p
->plist
.next
);
541 static struct ucode_patch
*find_patch(unsigned int cpu
)
545 equiv_id
= __find_equiv_id(cpu
);
549 return cache_find_patch(equiv_id
);
552 static int collect_cpu_info_amd(int cpu
, struct cpu_signature
*csig
)
554 struct cpuinfo_x86
*c
= &cpu_data(cpu
);
555 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
556 struct ucode_patch
*p
;
558 csig
->sig
= cpuid_eax(0x00000001);
559 csig
->rev
= c
->microcode
;
562 * a patch could have been loaded early, set uci->mc so that
563 * mc_bp_resume() can call apply_microcode()
566 if (p
&& (p
->patch_id
== csig
->rev
))
569 pr_info("CPU%d: patch_level=0x%08x\n", cpu
, csig
->rev
);
574 static unsigned int verify_patch_size(u8 family
, u32 patch_size
,
579 #define F1XH_MPB_MAX_SIZE 2048
580 #define F14H_MPB_MAX_SIZE 1824
581 #define F15H_MPB_MAX_SIZE 4096
582 #define F16H_MPB_MAX_SIZE 3458
586 max_size
= F14H_MPB_MAX_SIZE
;
589 max_size
= F15H_MPB_MAX_SIZE
;
592 max_size
= F16H_MPB_MAX_SIZE
;
595 max_size
= F1XH_MPB_MAX_SIZE
;
599 if (patch_size
> min_t(u32
, size
, max_size
)) {
600 pr_err("patch size mismatch\n");
608 * Those patch levels cannot be updated to newer ones and thus should be final.
610 static u32 final_levels
[] = {
614 0, /* T-101 terminator */
618 * Check the current patch level on this CPU.
620 * @rev: Use it to return the patch level. It is set to 0 in the case of
624 * - true: if update should stop
627 bool check_current_patch_level(u32
*rev
, bool early
)
633 native_rdmsr(MSR_AMD64_PATCH_LEVEL
, lvl
, dummy
);
635 if (IS_ENABLED(CONFIG_X86_32
) && early
)
636 levels
= (u32
*)__pa_nodebug(&final_levels
);
638 levels
= final_levels
;
640 for (i
= 0; levels
[i
]; i
++) {
641 if (lvl
== levels
[i
]) {
654 int __apply_microcode_amd(struct microcode_amd
*mc_amd
)
658 native_wrmsrl(MSR_AMD64_PATCH_LOADER
, (u64
)(long)&mc_amd
->hdr
.data_code
);
660 /* verify patch application was successful */
661 native_rdmsr(MSR_AMD64_PATCH_LEVEL
, rev
, dummy
);
662 if (rev
!= mc_amd
->hdr
.patch_id
)
668 int apply_microcode_amd(int cpu
)
670 struct cpuinfo_x86
*c
= &cpu_data(cpu
);
671 struct microcode_amd
*mc_amd
;
672 struct ucode_cpu_info
*uci
;
673 struct ucode_patch
*p
;
676 BUG_ON(raw_smp_processor_id() != cpu
);
678 uci
= ucode_cpu_info
+ cpu
;
687 if (check_current_patch_level(&rev
, false))
690 /* need to apply patch? */
691 if (rev
>= mc_amd
->hdr
.patch_id
) {
693 uci
->cpu_sig
.rev
= rev
;
697 if (__apply_microcode_amd(mc_amd
)) {
698 pr_err("CPU%d: update failed for patch_level=0x%08x\n",
699 cpu
, mc_amd
->hdr
.patch_id
);
702 pr_info("CPU%d: new patch_level=0x%08x\n", cpu
,
703 mc_amd
->hdr
.patch_id
);
705 uci
->cpu_sig
.rev
= mc_amd
->hdr
.patch_id
;
706 c
->microcode
= mc_amd
->hdr
.patch_id
;
711 static int install_equiv_cpu_table(const u8
*buf
)
713 unsigned int *ibuf
= (unsigned int *)buf
;
714 unsigned int type
= ibuf
[1];
715 unsigned int size
= ibuf
[2];
717 if (type
!= UCODE_EQUIV_CPU_TABLE_TYPE
|| !size
) {
718 pr_err("empty section/"
719 "invalid type field in container file section header\n");
723 equiv_cpu_table
= vmalloc(size
);
724 if (!equiv_cpu_table
) {
725 pr_err("failed to allocate equivalent CPU table\n");
729 memcpy(equiv_cpu_table
, buf
+ CONTAINER_HDR_SZ
, size
);
731 /* add header length */
732 return size
+ CONTAINER_HDR_SZ
;
735 static void free_equiv_cpu_table(void)
737 vfree(equiv_cpu_table
);
738 equiv_cpu_table
= NULL
;
741 static void cleanup(void)
743 free_equiv_cpu_table();
748 * We return the current size even if some of the checks failed so that
749 * we can skip over the next patch. If we return a negative value, we
750 * signal a grave error like a memory allocation has failed and the
751 * driver cannot continue functioning normally. In such cases, we tear
752 * down everything we've used up so far and exit.
754 static int verify_and_add_patch(u8 family
, u8
*fw
, unsigned int leftover
)
756 struct microcode_header_amd
*mc_hdr
;
757 struct ucode_patch
*patch
;
758 unsigned int patch_size
, crnt_size
, ret
;
762 patch_size
= *(u32
*)(fw
+ 4);
763 crnt_size
= patch_size
+ SECTION_HDR_SIZE
;
764 mc_hdr
= (struct microcode_header_amd
*)(fw
+ SECTION_HDR_SIZE
);
765 proc_id
= mc_hdr
->processor_rev_id
;
767 proc_fam
= find_cpu_family_by_equiv_cpu(proc_id
);
769 pr_err("No patch family for equiv ID: 0x%04x\n", proc_id
);
773 /* check if patch is for the current family */
774 proc_fam
= ((proc_fam
>> 8) & 0xf) + ((proc_fam
>> 20) & 0xff);
775 if (proc_fam
!= family
)
778 if (mc_hdr
->nb_dev_id
|| mc_hdr
->sb_dev_id
) {
779 pr_err("Patch-ID 0x%08x: chipset-specific code unsupported.\n",
784 ret
= verify_patch_size(family
, patch_size
, leftover
);
786 pr_err("Patch-ID 0x%08x: size mismatch.\n", mc_hdr
->patch_id
);
790 patch
= kzalloc(sizeof(*patch
), GFP_KERNEL
);
792 pr_err("Patch allocation failure.\n");
796 patch
->data
= kzalloc(patch_size
, GFP_KERNEL
);
798 pr_err("Patch data allocation failure.\n");
803 /* All looks ok, copy patch... */
804 memcpy(patch
->data
, fw
+ SECTION_HDR_SIZE
, patch_size
);
805 INIT_LIST_HEAD(&patch
->plist
);
806 patch
->patch_id
= mc_hdr
->patch_id
;
807 patch
->equiv_cpu
= proc_id
;
809 pr_debug("%s: Added patch_id: 0x%08x, proc_id: 0x%04x\n",
810 __func__
, patch
->patch_id
, proc_id
);
812 /* ... and add to cache. */
818 static enum ucode_state
__load_microcode_amd(u8 family
, const u8
*data
,
821 enum ucode_state ret
= UCODE_ERROR
;
822 unsigned int leftover
;
827 offset
= install_equiv_cpu_table(data
);
829 pr_err("failed to create equivalent cpu table\n");
833 leftover
= size
- offset
;
835 if (*(u32
*)fw
!= UCODE_UCODE_TYPE
) {
836 pr_err("invalid type field in container file section header\n");
837 free_equiv_cpu_table();
842 crnt_size
= verify_and_add_patch(family
, fw
, leftover
);
847 leftover
-= crnt_size
;
853 enum ucode_state
load_microcode_amd(int cpu
, u8 family
, const u8
*data
, size_t size
)
855 enum ucode_state ret
;
857 /* free old equiv table */
858 free_equiv_cpu_table();
860 ret
= __load_microcode_amd(family
, data
, size
);
866 /* save BSP's matching patch for early load */
867 if (cpu_data(cpu
).cpu_index
== boot_cpu_data
.cpu_index
) {
868 struct ucode_patch
*p
= find_patch(cpu
);
870 memset(amd_ucode_patch
, 0, PATCH_MAX_SIZE
);
871 memcpy(amd_ucode_patch
, p
->data
, min_t(u32
, ksize(p
->data
),
880 * AMD microcode firmware naming convention, up to family 15h they are in
883 * amd-ucode/microcode_amd.bin
885 * This legacy file is always smaller than 2K in size.
887 * Beginning with family 15h, they are in family-specific firmware files:
889 * amd-ucode/microcode_amd_fam15h.bin
890 * amd-ucode/microcode_amd_fam16h.bin
893 * These might be larger than 2K.
895 static enum ucode_state
request_microcode_amd(int cpu
, struct device
*device
,
898 char fw_name
[36] = "amd-ucode/microcode_amd.bin";
899 struct cpuinfo_x86
*c
= &cpu_data(cpu
);
900 enum ucode_state ret
= UCODE_NFOUND
;
901 const struct firmware
*fw
;
903 /* reload ucode container only on the boot cpu */
904 if (!refresh_fw
|| c
->cpu_index
!= boot_cpu_data
.cpu_index
)
908 snprintf(fw_name
, sizeof(fw_name
), "amd-ucode/microcode_amd_fam%.2xh.bin", c
->x86
);
910 if (request_firmware_direct(&fw
, (const char *)fw_name
, device
)) {
911 pr_debug("failed to load file %s\n", fw_name
);
916 if (*(u32
*)fw
->data
!= UCODE_MAGIC
) {
917 pr_err("invalid magic value (0x%08x)\n", *(u32
*)fw
->data
);
921 ret
= load_microcode_amd(cpu
, c
->x86
, fw
->data
, fw
->size
);
924 release_firmware(fw
);
930 static enum ucode_state
931 request_microcode_user(int cpu
, const void __user
*buf
, size_t size
)
936 static void microcode_fini_cpu_amd(int cpu
)
938 struct ucode_cpu_info
*uci
= ucode_cpu_info
+ cpu
;
943 static struct microcode_ops microcode_amd_ops
= {
944 .request_microcode_user
= request_microcode_user
,
945 .request_microcode_fw
= request_microcode_amd
,
946 .collect_cpu_info
= collect_cpu_info_amd
,
947 .apply_microcode
= apply_microcode_amd
,
948 .microcode_fini_cpu
= microcode_fini_cpu_amd
,
951 struct microcode_ops
* __init
init_amd_microcode(void)
953 struct cpuinfo_x86
*c
= &boot_cpu_data
;
955 if (c
->x86_vendor
!= X86_VENDOR_AMD
|| c
->x86
< 0x10) {
956 pr_warning("AMD CPU family 0x%x not supported\n", c
->x86
);
960 return µcode_amd_ops
;
963 void __exit
exit_amd_microcode(void)