Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * AMD CPU Microcode Update Driver for Linux
4 *
5 * This driver allows to upgrade microcode on F10h AMD
6 * CPUs and later.
7 *
8 * Copyright (C) 2008-2011 Advanced Micro Devices Inc.
9 * 2013-2018 Borislav Petkov <bp@alien8.de>
10 *
11 * Author: Peter Oruba <peter.oruba@amd.com>
12 *
13 * Based on work by:
14 * Tigran Aivazian <aivazian.tigran@gmail.com>
15 *
16 * early loader:
17 * Copyright (C) 2013 Advanced Micro Devices, Inc.
18 *
19 * Author: Jacob Shin <jacob.shin@amd.com>
20 * Fixes: Borislav Petkov <bp@suse.de>
21 */
22#define pr_fmt(fmt) "microcode: " fmt
23
24#include <linux/earlycpio.h>
25#include <linux/firmware.h>
26#include <linux/uaccess.h>
27#include <linux/vmalloc.h>
28#include <linux/initrd.h>
29#include <linux/kernel.h>
30#include <linux/pci.h>
31
32#include <asm/microcode.h>
33#include <asm/processor.h>
34#include <asm/setup.h>
35#include <asm/cpu.h>
36#include <asm/msr.h>
37
38#include "internal.h"
39
40struct ucode_patch {
41 struct list_head plist;
42 void *data;
43 unsigned int size;
44 u32 patch_id;
45 u16 equiv_cpu;
46};
47
48static LIST_HEAD(microcode_cache);
49
50#define UCODE_MAGIC 0x00414d44
51#define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
52#define UCODE_UCODE_TYPE 0x00000001
53
54#define SECTION_HDR_SIZE 8
55#define CONTAINER_HDR_SZ 12
56
57struct equiv_cpu_entry {
58 u32 installed_cpu;
59 u32 fixed_errata_mask;
60 u32 fixed_errata_compare;
61 u16 equiv_cpu;
62 u16 res;
63} __packed;
64
65struct microcode_header_amd {
66 u32 data_code;
67 u32 patch_id;
68 u16 mc_patch_data_id;
69 u8 mc_patch_data_len;
70 u8 init_flag;
71 u32 mc_patch_data_checksum;
72 u32 nb_dev_id;
73 u32 sb_dev_id;
74 u16 processor_rev_id;
75 u8 nb_rev_id;
76 u8 sb_rev_id;
77 u8 bios_api_rev;
78 u8 reserved1[3];
79 u32 match_reg[8];
80} __packed;
81
82struct microcode_amd {
83 struct microcode_header_amd hdr;
84 unsigned int mpb[];
85};
86
87#define PATCH_MAX_SIZE (3 * PAGE_SIZE)
88
89static struct equiv_cpu_table {
90 unsigned int num_entries;
91 struct equiv_cpu_entry *entry;
92} equiv_table;
93
94/*
95 * This points to the current valid container of microcode patches which we will
96 * save from the initrd/builtin before jettisoning its contents. @mc is the
97 * microcode patch we found to match.
98 */
99struct cont_desc {
100 struct microcode_amd *mc;
101 u32 cpuid_1_eax;
102 u32 psize;
103 u8 *data;
104 size_t size;
105};
106
107/*
108 * Microcode patch container file is prepended to the initrd in cpio
109 * format. See Documentation/arch/x86/microcode.rst
110 */
111static const char
112ucode_path[] __maybe_unused = "kernel/x86/microcode/AuthenticAMD.bin";
113
114static u16 find_equiv_id(struct equiv_cpu_table *et, u32 sig)
115{
116 unsigned int i;
117
118 if (!et || !et->num_entries)
119 return 0;
120
121 for (i = 0; i < et->num_entries; i++) {
122 struct equiv_cpu_entry *e = &et->entry[i];
123
124 if (sig == e->installed_cpu)
125 return e->equiv_cpu;
126 }
127 return 0;
128}
129
130/*
131 * Check whether there is a valid microcode container file at the beginning
132 * of @buf of size @buf_size.
133 */
134static bool verify_container(const u8 *buf, size_t buf_size)
135{
136 u32 cont_magic;
137
138 if (buf_size <= CONTAINER_HDR_SZ) {
139 pr_debug("Truncated microcode container header.\n");
140 return false;
141 }
142
143 cont_magic = *(const u32 *)buf;
144 if (cont_magic != UCODE_MAGIC) {
145 pr_debug("Invalid magic value (0x%08x).\n", cont_magic);
146 return false;
147 }
148
149 return true;
150}
151
152/*
153 * Check whether there is a valid, non-truncated CPU equivalence table at the
154 * beginning of @buf of size @buf_size.
155 */
156static bool verify_equivalence_table(const u8 *buf, size_t buf_size)
157{
158 const u32 *hdr = (const u32 *)buf;
159 u32 cont_type, equiv_tbl_len;
160
161 if (!verify_container(buf, buf_size))
162 return false;
163
164 cont_type = hdr[1];
165 if (cont_type != UCODE_EQUIV_CPU_TABLE_TYPE) {
166 pr_debug("Wrong microcode container equivalence table type: %u.\n",
167 cont_type);
168 return false;
169 }
170
171 buf_size -= CONTAINER_HDR_SZ;
172
173 equiv_tbl_len = hdr[2];
174 if (equiv_tbl_len < sizeof(struct equiv_cpu_entry) ||
175 buf_size < equiv_tbl_len) {
176 pr_debug("Truncated equivalence table.\n");
177 return false;
178 }
179
180 return true;
181}
182
183/*
184 * Check whether there is a valid, non-truncated microcode patch section at the
185 * beginning of @buf of size @buf_size.
186 *
187 * On success, @sh_psize returns the patch size according to the section header,
188 * to the caller.
189 */
190static bool
191__verify_patch_section(const u8 *buf, size_t buf_size, u32 *sh_psize)
192{
193 u32 p_type, p_size;
194 const u32 *hdr;
195
196 if (buf_size < SECTION_HDR_SIZE) {
197 pr_debug("Truncated patch section.\n");
198 return false;
199 }
200
201 hdr = (const u32 *)buf;
202 p_type = hdr[0];
203 p_size = hdr[1];
204
205 if (p_type != UCODE_UCODE_TYPE) {
206 pr_debug("Invalid type field (0x%x) in container file section header.\n",
207 p_type);
208 return false;
209 }
210
211 if (p_size < sizeof(struct microcode_header_amd)) {
212 pr_debug("Patch of size %u too short.\n", p_size);
213 return false;
214 }
215
216 *sh_psize = p_size;
217
218 return true;
219}
220
221/*
222 * Check whether the passed remaining file @buf_size is large enough to contain
223 * a patch of the indicated @sh_psize (and also whether this size does not
224 * exceed the per-family maximum). @sh_psize is the size read from the section
225 * header.
226 */
227static unsigned int __verify_patch_size(u8 family, u32 sh_psize, size_t buf_size)
228{
229 u32 max_size;
230
231 if (family >= 0x15)
232 return min_t(u32, sh_psize, buf_size);
233
234#define F1XH_MPB_MAX_SIZE 2048
235#define F14H_MPB_MAX_SIZE 1824
236
237 switch (family) {
238 case 0x10 ... 0x12:
239 max_size = F1XH_MPB_MAX_SIZE;
240 break;
241 case 0x14:
242 max_size = F14H_MPB_MAX_SIZE;
243 break;
244 default:
245 WARN(1, "%s: WTF family: 0x%x\n", __func__, family);
246 return 0;
247 }
248
249 if (sh_psize > min_t(u32, buf_size, max_size))
250 return 0;
251
252 return sh_psize;
253}
254
255/*
256 * Verify the patch in @buf.
257 *
258 * Returns:
259 * negative: on error
260 * positive: patch is not for this family, skip it
261 * 0: success
262 */
263static int
264verify_patch(u8 family, const u8 *buf, size_t buf_size, u32 *patch_size)
265{
266 struct microcode_header_amd *mc_hdr;
267 unsigned int ret;
268 u32 sh_psize;
269 u16 proc_id;
270 u8 patch_fam;
271
272 if (!__verify_patch_section(buf, buf_size, &sh_psize))
273 return -1;
274
275 /*
276 * The section header length is not included in this indicated size
277 * but is present in the leftover file length so we need to subtract
278 * it before passing this value to the function below.
279 */
280 buf_size -= SECTION_HDR_SIZE;
281
282 /*
283 * Check if the remaining buffer is big enough to contain a patch of
284 * size sh_psize, as the section claims.
285 */
286 if (buf_size < sh_psize) {
287 pr_debug("Patch of size %u truncated.\n", sh_psize);
288 return -1;
289 }
290
291 ret = __verify_patch_size(family, sh_psize, buf_size);
292 if (!ret) {
293 pr_debug("Per-family patch size mismatch.\n");
294 return -1;
295 }
296
297 *patch_size = sh_psize;
298
299 mc_hdr = (struct microcode_header_amd *)(buf + SECTION_HDR_SIZE);
300 if (mc_hdr->nb_dev_id || mc_hdr->sb_dev_id) {
301 pr_err("Patch-ID 0x%08x: chipset-specific code unsupported.\n", mc_hdr->patch_id);
302 return -1;
303 }
304
305 proc_id = mc_hdr->processor_rev_id;
306 patch_fam = 0xf + (proc_id >> 12);
307 if (patch_fam != family)
308 return 1;
309
310 return 0;
311}
312
313/*
314 * This scans the ucode blob for the proper container as we can have multiple
315 * containers glued together. Returns the equivalence ID from the equivalence
316 * table or 0 if none found.
317 * Returns the amount of bytes consumed while scanning. @desc contains all the
318 * data we're going to use in later stages of the application.
319 */
320static size_t parse_container(u8 *ucode, size_t size, struct cont_desc *desc)
321{
322 struct equiv_cpu_table table;
323 size_t orig_size = size;
324 u32 *hdr = (u32 *)ucode;
325 u16 eq_id;
326 u8 *buf;
327
328 if (!verify_equivalence_table(ucode, size))
329 return 0;
330
331 buf = ucode;
332
333 table.entry = (struct equiv_cpu_entry *)(buf + CONTAINER_HDR_SZ);
334 table.num_entries = hdr[2] / sizeof(struct equiv_cpu_entry);
335
336 /*
337 * Find the equivalence ID of our CPU in this table. Even if this table
338 * doesn't contain a patch for the CPU, scan through the whole container
339 * so that it can be skipped in case there are other containers appended.
340 */
341 eq_id = find_equiv_id(&table, desc->cpuid_1_eax);
342
343 buf += hdr[2] + CONTAINER_HDR_SZ;
344 size -= hdr[2] + CONTAINER_HDR_SZ;
345
346 /*
347 * Scan through the rest of the container to find where it ends. We do
348 * some basic sanity-checking too.
349 */
350 while (size > 0) {
351 struct microcode_amd *mc;
352 u32 patch_size;
353 int ret;
354
355 ret = verify_patch(x86_family(desc->cpuid_1_eax), buf, size, &patch_size);
356 if (ret < 0) {
357 /*
358 * Patch verification failed, skip to the next container, if
359 * there is one. Before exit, check whether that container has
360 * found a patch already. If so, use it.
361 */
362 goto out;
363 } else if (ret > 0) {
364 goto skip;
365 }
366
367 mc = (struct microcode_amd *)(buf + SECTION_HDR_SIZE);
368 if (eq_id == mc->hdr.processor_rev_id) {
369 desc->psize = patch_size;
370 desc->mc = mc;
371 }
372
373skip:
374 /* Skip patch section header too: */
375 buf += patch_size + SECTION_HDR_SIZE;
376 size -= patch_size + SECTION_HDR_SIZE;
377 }
378
379out:
380 /*
381 * If we have found a patch (desc->mc), it means we're looking at the
382 * container which has a patch for this CPU so return 0 to mean, @ucode
383 * already points to the proper container. Otherwise, we return the size
384 * we scanned so that we can advance to the next container in the
385 * buffer.
386 */
387 if (desc->mc) {
388 desc->data = ucode;
389 desc->size = orig_size - size;
390
391 return 0;
392 }
393
394 return orig_size - size;
395}
396
397/*
398 * Scan the ucode blob for the proper container as we can have multiple
399 * containers glued together.
400 */
401static void scan_containers(u8 *ucode, size_t size, struct cont_desc *desc)
402{
403 while (size) {
404 size_t s = parse_container(ucode, size, desc);
405 if (!s)
406 return;
407
408 /* catch wraparound */
409 if (size >= s) {
410 ucode += s;
411 size -= s;
412 } else {
413 return;
414 }
415 }
416}
417
418static int __apply_microcode_amd(struct microcode_amd *mc)
419{
420 u32 rev, dummy;
421
422 native_wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc->hdr.data_code);
423
424 /* verify patch application was successful */
425 native_rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
426 if (rev != mc->hdr.patch_id)
427 return -1;
428
429 return 0;
430}
431
432/*
433 * Early load occurs before we can vmalloc(). So we look for the microcode
434 * patch container file in initrd, traverse equivalent cpu table, look for a
435 * matching microcode patch, and update, all in initrd memory in place.
436 * When vmalloc() is available for use later -- on 64-bit during first AP load,
437 * and on 32-bit during save_microcode_in_initrd_amd() -- we can call
438 * load_microcode_amd() to save equivalent cpu table and microcode patches in
439 * kernel heap memory.
440 *
441 * Returns true if container found (sets @desc), false otherwise.
442 */
443static bool early_apply_microcode(u32 cpuid_1_eax, u32 old_rev, void *ucode, size_t size)
444{
445 struct cont_desc desc = { 0 };
446 struct microcode_amd *mc;
447 bool ret = false;
448
449 desc.cpuid_1_eax = cpuid_1_eax;
450
451 scan_containers(ucode, size, &desc);
452
453 mc = desc.mc;
454 if (!mc)
455 return ret;
456
457 /*
458 * Allow application of the same revision to pick up SMT-specific
459 * changes even if the revision of the other SMT thread is already
460 * up-to-date.
461 */
462 if (old_rev > mc->hdr.patch_id)
463 return ret;
464
465 return !__apply_microcode_amd(mc);
466}
467
468static bool get_builtin_microcode(struct cpio_data *cp, unsigned int family)
469{
470 char fw_name[36] = "amd-ucode/microcode_amd.bin";
471 struct firmware fw;
472
473 if (IS_ENABLED(CONFIG_X86_32))
474 return false;
475
476 if (family >= 0x15)
477 snprintf(fw_name, sizeof(fw_name),
478 "amd-ucode/microcode_amd_fam%02hhxh.bin", family);
479
480 if (firmware_request_builtin(&fw, fw_name)) {
481 cp->size = fw.size;
482 cp->data = (void *)fw.data;
483 return true;
484 }
485
486 return false;
487}
488
489static void __init find_blobs_in_containers(unsigned int cpuid_1_eax, struct cpio_data *ret)
490{
491 struct cpio_data cp;
492
493 if (!get_builtin_microcode(&cp, x86_family(cpuid_1_eax)))
494 cp = find_microcode_in_initrd(ucode_path);
495
496 *ret = cp;
497}
498
499void __init load_ucode_amd_bsp(struct early_load_data *ed, unsigned int cpuid_1_eax)
500{
501 struct cpio_data cp = { };
502 u32 dummy;
503
504 native_rdmsr(MSR_AMD64_PATCH_LEVEL, ed->old_rev, dummy);
505
506 /* Needed in load_microcode_amd() */
507 ucode_cpu_info[0].cpu_sig.sig = cpuid_1_eax;
508
509 find_blobs_in_containers(cpuid_1_eax, &cp);
510 if (!(cp.data && cp.size))
511 return;
512
513 if (early_apply_microcode(cpuid_1_eax, ed->old_rev, cp.data, cp.size))
514 native_rdmsr(MSR_AMD64_PATCH_LEVEL, ed->new_rev, dummy);
515}
516
517static enum ucode_state load_microcode_amd(u8 family, const u8 *data, size_t size);
518
519static int __init save_microcode_in_initrd(void)
520{
521 unsigned int cpuid_1_eax = native_cpuid_eax(1);
522 struct cpuinfo_x86 *c = &boot_cpu_data;
523 struct cont_desc desc = { 0 };
524 enum ucode_state ret;
525 struct cpio_data cp;
526
527 if (dis_ucode_ldr || c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10)
528 return 0;
529
530 find_blobs_in_containers(cpuid_1_eax, &cp);
531 if (!(cp.data && cp.size))
532 return -EINVAL;
533
534 desc.cpuid_1_eax = cpuid_1_eax;
535
536 scan_containers(cp.data, cp.size, &desc);
537 if (!desc.mc)
538 return -EINVAL;
539
540 ret = load_microcode_amd(x86_family(cpuid_1_eax), desc.data, desc.size);
541 if (ret > UCODE_UPDATED)
542 return -EINVAL;
543
544 return 0;
545}
546early_initcall(save_microcode_in_initrd);
547
548/*
549 * a small, trivial cache of per-family ucode patches
550 */
551static struct ucode_patch *cache_find_patch(u16 equiv_cpu)
552{
553 struct ucode_patch *p;
554
555 list_for_each_entry(p, µcode_cache, plist)
556 if (p->equiv_cpu == equiv_cpu)
557 return p;
558 return NULL;
559}
560
561static void update_cache(struct ucode_patch *new_patch)
562{
563 struct ucode_patch *p;
564
565 list_for_each_entry(p, µcode_cache, plist) {
566 if (p->equiv_cpu == new_patch->equiv_cpu) {
567 if (p->patch_id >= new_patch->patch_id) {
568 /* we already have the latest patch */
569 kfree(new_patch->data);
570 kfree(new_patch);
571 return;
572 }
573
574 list_replace(&p->plist, &new_patch->plist);
575 kfree(p->data);
576 kfree(p);
577 return;
578 }
579 }
580 /* no patch found, add it */
581 list_add_tail(&new_patch->plist, µcode_cache);
582}
583
584static void free_cache(void)
585{
586 struct ucode_patch *p, *tmp;
587
588 list_for_each_entry_safe(p, tmp, µcode_cache, plist) {
589 __list_del(p->plist.prev, p->plist.next);
590 kfree(p->data);
591 kfree(p);
592 }
593}
594
595static struct ucode_patch *find_patch(unsigned int cpu)
596{
597 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
598 u16 equiv_id;
599
600 equiv_id = find_equiv_id(&equiv_table, uci->cpu_sig.sig);
601 if (!equiv_id)
602 return NULL;
603
604 return cache_find_patch(equiv_id);
605}
606
607void reload_ucode_amd(unsigned int cpu)
608{
609 u32 rev, dummy __always_unused;
610 struct microcode_amd *mc;
611 struct ucode_patch *p;
612
613 p = find_patch(cpu);
614 if (!p)
615 return;
616
617 mc = p->data;
618
619 rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
620
621 if (rev < mc->hdr.patch_id) {
622 if (!__apply_microcode_amd(mc))
623 pr_info_once("reload revision: 0x%08x\n", mc->hdr.patch_id);
624 }
625}
626
627static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
628{
629 struct cpuinfo_x86 *c = &cpu_data(cpu);
630 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
631 struct ucode_patch *p;
632
633 csig->sig = cpuid_eax(0x00000001);
634 csig->rev = c->microcode;
635
636 /*
637 * a patch could have been loaded early, set uci->mc so that
638 * mc_bp_resume() can call apply_microcode()
639 */
640 p = find_patch(cpu);
641 if (p && (p->patch_id == csig->rev))
642 uci->mc = p->data;
643
644 return 0;
645}
646
647static enum ucode_state apply_microcode_amd(int cpu)
648{
649 struct cpuinfo_x86 *c = &cpu_data(cpu);
650 struct microcode_amd *mc_amd;
651 struct ucode_cpu_info *uci;
652 struct ucode_patch *p;
653 enum ucode_state ret;
654 u32 rev, dummy __always_unused;
655
656 BUG_ON(raw_smp_processor_id() != cpu);
657
658 uci = ucode_cpu_info + cpu;
659
660 p = find_patch(cpu);
661 if (!p)
662 return UCODE_NFOUND;
663
664 mc_amd = p->data;
665 uci->mc = p->data;
666
667 rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
668
669 /* need to apply patch? */
670 if (rev > mc_amd->hdr.patch_id) {
671 ret = UCODE_OK;
672 goto out;
673 }
674
675 if (__apply_microcode_amd(mc_amd)) {
676 pr_err("CPU%d: update failed for patch_level=0x%08x\n",
677 cpu, mc_amd->hdr.patch_id);
678 return UCODE_ERROR;
679 }
680
681 rev = mc_amd->hdr.patch_id;
682 ret = UCODE_UPDATED;
683
684out:
685 uci->cpu_sig.rev = rev;
686 c->microcode = rev;
687
688 /* Update boot_cpu_data's revision too, if we're on the BSP: */
689 if (c->cpu_index == boot_cpu_data.cpu_index)
690 boot_cpu_data.microcode = rev;
691
692 return ret;
693}
694
695void load_ucode_amd_ap(unsigned int cpuid_1_eax)
696{
697 unsigned int cpu = smp_processor_id();
698
699 ucode_cpu_info[cpu].cpu_sig.sig = cpuid_1_eax;
700 apply_microcode_amd(cpu);
701}
702
703static size_t install_equiv_cpu_table(const u8 *buf, size_t buf_size)
704{
705 u32 equiv_tbl_len;
706 const u32 *hdr;
707
708 if (!verify_equivalence_table(buf, buf_size))
709 return 0;
710
711 hdr = (const u32 *)buf;
712 equiv_tbl_len = hdr[2];
713
714 equiv_table.entry = vmalloc(equiv_tbl_len);
715 if (!equiv_table.entry) {
716 pr_err("failed to allocate equivalent CPU table\n");
717 return 0;
718 }
719
720 memcpy(equiv_table.entry, buf + CONTAINER_HDR_SZ, equiv_tbl_len);
721 equiv_table.num_entries = equiv_tbl_len / sizeof(struct equiv_cpu_entry);
722
723 /* add header length */
724 return equiv_tbl_len + CONTAINER_HDR_SZ;
725}
726
727static void free_equiv_cpu_table(void)
728{
729 vfree(equiv_table.entry);
730 memset(&equiv_table, 0, sizeof(equiv_table));
731}
732
733static void cleanup(void)
734{
735 free_equiv_cpu_table();
736 free_cache();
737}
738
739/*
740 * Return a non-negative value even if some of the checks failed so that
741 * we can skip over the next patch. If we return a negative value, we
742 * signal a grave error like a memory allocation has failed and the
743 * driver cannot continue functioning normally. In such cases, we tear
744 * down everything we've used up so far and exit.
745 */
746static int verify_and_add_patch(u8 family, u8 *fw, unsigned int leftover,
747 unsigned int *patch_size)
748{
749 struct microcode_header_amd *mc_hdr;
750 struct ucode_patch *patch;
751 u16 proc_id;
752 int ret;
753
754 ret = verify_patch(family, fw, leftover, patch_size);
755 if (ret)
756 return ret;
757
758 patch = kzalloc(sizeof(*patch), GFP_KERNEL);
759 if (!patch) {
760 pr_err("Patch allocation failure.\n");
761 return -EINVAL;
762 }
763
764 patch->data = kmemdup(fw + SECTION_HDR_SIZE, *patch_size, GFP_KERNEL);
765 if (!patch->data) {
766 pr_err("Patch data allocation failure.\n");
767 kfree(patch);
768 return -EINVAL;
769 }
770 patch->size = *patch_size;
771
772 mc_hdr = (struct microcode_header_amd *)(fw + SECTION_HDR_SIZE);
773 proc_id = mc_hdr->processor_rev_id;
774
775 INIT_LIST_HEAD(&patch->plist);
776 patch->patch_id = mc_hdr->patch_id;
777 patch->equiv_cpu = proc_id;
778
779 pr_debug("%s: Added patch_id: 0x%08x, proc_id: 0x%04x\n",
780 __func__, patch->patch_id, proc_id);
781
782 /* ... and add to cache. */
783 update_cache(patch);
784
785 return 0;
786}
787
788/* Scan the blob in @data and add microcode patches to the cache. */
789static enum ucode_state __load_microcode_amd(u8 family, const u8 *data,
790 size_t size)
791{
792 u8 *fw = (u8 *)data;
793 size_t offset;
794
795 offset = install_equiv_cpu_table(data, size);
796 if (!offset)
797 return UCODE_ERROR;
798
799 fw += offset;
800 size -= offset;
801
802 if (*(u32 *)fw != UCODE_UCODE_TYPE) {
803 pr_err("invalid type field in container file section header\n");
804 free_equiv_cpu_table();
805 return UCODE_ERROR;
806 }
807
808 while (size > 0) {
809 unsigned int crnt_size = 0;
810 int ret;
811
812 ret = verify_and_add_patch(family, fw, size, &crnt_size);
813 if (ret < 0)
814 return UCODE_ERROR;
815
816 fw += crnt_size + SECTION_HDR_SIZE;
817 size -= (crnt_size + SECTION_HDR_SIZE);
818 }
819
820 return UCODE_OK;
821}
822
823static enum ucode_state load_microcode_amd(u8 family, const u8 *data, size_t size)
824{
825 struct cpuinfo_x86 *c;
826 unsigned int nid, cpu;
827 struct ucode_patch *p;
828 enum ucode_state ret;
829
830 /* free old equiv table */
831 free_equiv_cpu_table();
832
833 ret = __load_microcode_amd(family, data, size);
834 if (ret != UCODE_OK) {
835 cleanup();
836 return ret;
837 }
838
839 for_each_node(nid) {
840 cpu = cpumask_first(cpumask_of_node(nid));
841 c = &cpu_data(cpu);
842
843 p = find_patch(cpu);
844 if (!p)
845 continue;
846
847 if (c->microcode >= p->patch_id)
848 continue;
849
850 ret = UCODE_NEW;
851 }
852
853 return ret;
854}
855
856/*
857 * AMD microcode firmware naming convention, up to family 15h they are in
858 * the legacy file:
859 *
860 * amd-ucode/microcode_amd.bin
861 *
862 * This legacy file is always smaller than 2K in size.
863 *
864 * Beginning with family 15h, they are in family-specific firmware files:
865 *
866 * amd-ucode/microcode_amd_fam15h.bin
867 * amd-ucode/microcode_amd_fam16h.bin
868 * ...
869 *
870 * These might be larger than 2K.
871 */
872static enum ucode_state request_microcode_amd(int cpu, struct device *device)
873{
874 char fw_name[36] = "amd-ucode/microcode_amd.bin";
875 struct cpuinfo_x86 *c = &cpu_data(cpu);
876 enum ucode_state ret = UCODE_NFOUND;
877 const struct firmware *fw;
878
879 if (force_minrev)
880 return UCODE_NFOUND;
881
882 if (c->x86 >= 0x15)
883 snprintf(fw_name, sizeof(fw_name), "amd-ucode/microcode_amd_fam%.2xh.bin", c->x86);
884
885 if (request_firmware_direct(&fw, (const char *)fw_name, device)) {
886 pr_debug("failed to load file %s\n", fw_name);
887 goto out;
888 }
889
890 ret = UCODE_ERROR;
891 if (!verify_container(fw->data, fw->size))
892 goto fw_release;
893
894 ret = load_microcode_amd(c->x86, fw->data, fw->size);
895
896 fw_release:
897 release_firmware(fw);
898
899 out:
900 return ret;
901}
902
903static void microcode_fini_cpu_amd(int cpu)
904{
905 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
906
907 uci->mc = NULL;
908}
909
910static struct microcode_ops microcode_amd_ops = {
911 .request_microcode_fw = request_microcode_amd,
912 .collect_cpu_info = collect_cpu_info_amd,
913 .apply_microcode = apply_microcode_amd,
914 .microcode_fini_cpu = microcode_fini_cpu_amd,
915 .nmi_safe = true,
916};
917
918struct microcode_ops * __init init_amd_microcode(void)
919{
920 struct cpuinfo_x86 *c = &boot_cpu_data;
921
922 if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
923 pr_warn("AMD CPU family 0x%x not supported\n", c->x86);
924 return NULL;
925 }
926 return µcode_amd_ops;
927}
928
929void __exit exit_amd_microcode(void)
930{
931 cleanup();
932}
1/*
2 * AMD CPU Microcode Update Driver for Linux
3 *
4 * This driver allows to upgrade microcode on F10h AMD
5 * CPUs and later.
6 *
7 * Copyright (C) 2008-2011 Advanced Micro Devices Inc.
8 * 2013-2016 Borislav Petkov <bp@alien8.de>
9 *
10 * Author: Peter Oruba <peter.oruba@amd.com>
11 *
12 * Based on work by:
13 * Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
14 *
15 * early loader:
16 * Copyright (C) 2013 Advanced Micro Devices, Inc.
17 *
18 * Author: Jacob Shin <jacob.shin@amd.com>
19 * Fixes: Borislav Petkov <bp@suse.de>
20 *
21 * Licensed under the terms of the GNU General Public
22 * License version 2. See file COPYING for details.
23 */
24#define pr_fmt(fmt) "microcode: " fmt
25
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>
33
34#include <asm/microcode_amd.h>
35#include <asm/microcode.h>
36#include <asm/processor.h>
37#include <asm/setup.h>
38#include <asm/cpu.h>
39#include <asm/msr.h>
40
41static struct equiv_cpu_entry *equiv_cpu_table;
42
43/*
44 * This points to the current valid container of microcode patches which we will
45 * save from the initrd/builtin before jettisoning its contents.
46 */
47struct container {
48 u8 *data;
49 size_t size;
50} cont;
51
52static u32 ucode_new_rev;
53static u8 amd_ucode_patch[PATCH_MAX_SIZE];
54static u16 this_equiv_id;
55
56/*
57 * Microcode patch container file is prepended to the initrd in cpio
58 * format. See Documentation/x86/early-microcode.txt
59 */
60static const char
61ucode_path[] __maybe_unused = "kernel/x86/microcode/AuthenticAMD.bin";
62
63static size_t compute_container_size(u8 *data, u32 total_size)
64{
65 size_t size = 0;
66 u32 *header = (u32 *)data;
67
68 if (header[0] != UCODE_MAGIC ||
69 header[1] != UCODE_EQUIV_CPU_TABLE_TYPE || /* type */
70 header[2] == 0) /* size */
71 return size;
72
73 size = header[2] + CONTAINER_HDR_SZ;
74 total_size -= size;
75 data += size;
76
77 while (total_size) {
78 u16 patch_size;
79
80 header = (u32 *)data;
81
82 if (header[0] != UCODE_UCODE_TYPE)
83 break;
84
85 /*
86 * Sanity-check patch size.
87 */
88 patch_size = header[1];
89 if (patch_size > PATCH_MAX_SIZE)
90 break;
91
92 size += patch_size + SECTION_HDR_SIZE;
93 data += patch_size + SECTION_HDR_SIZE;
94 total_size -= patch_size + SECTION_HDR_SIZE;
95 }
96
97 return size;
98}
99
100static inline u16 find_equiv_id(struct equiv_cpu_entry *equiv_cpu_table,
101 unsigned int sig)
102{
103 int i = 0;
104
105 if (!equiv_cpu_table)
106 return 0;
107
108 while (equiv_cpu_table[i].installed_cpu != 0) {
109 if (sig == equiv_cpu_table[i].installed_cpu)
110 return equiv_cpu_table[i].equiv_cpu;
111
112 i++;
113 }
114 return 0;
115}
116
117/*
118 * This scans the ucode blob for the proper container as we can have multiple
119 * containers glued together. Returns the equivalence ID from the equivalence
120 * table or 0 if none found.
121 */
122static u16
123find_proper_container(u8 *ucode, size_t size, struct container *ret_cont)
124{
125 struct container ret = { NULL, 0 };
126 u32 eax, ebx, ecx, edx;
127 struct equiv_cpu_entry *eq;
128 int offset, left;
129 u16 eq_id = 0;
130 u32 *header;
131 u8 *data;
132
133 data = ucode;
134 left = size;
135 header = (u32 *)data;
136
137
138 /* find equiv cpu table */
139 if (header[0] != UCODE_MAGIC ||
140 header[1] != UCODE_EQUIV_CPU_TABLE_TYPE || /* type */
141 header[2] == 0) /* size */
142 return eq_id;
143
144 eax = 0x00000001;
145 ecx = 0;
146 native_cpuid(&eax, &ebx, &ecx, &edx);
147
148 while (left > 0) {
149 eq = (struct equiv_cpu_entry *)(data + CONTAINER_HDR_SZ);
150
151 ret.data = data;
152
153 /* Advance past the container header */
154 offset = header[2] + CONTAINER_HDR_SZ;
155 data += offset;
156 left -= offset;
157
158 eq_id = find_equiv_id(eq, eax);
159 if (eq_id) {
160 ret.size = compute_container_size(ret.data, left + offset);
161
162 /*
163 * truncate how much we need to iterate over in the
164 * ucode update loop below
165 */
166 left = ret.size - offset;
167
168 *ret_cont = ret;
169 return eq_id;
170 }
171
172 /*
173 * support multiple container files appended together. if this
174 * one does not have a matching equivalent cpu entry, we fast
175 * forward to the next container file.
176 */
177 while (left > 0) {
178 header = (u32 *)data;
179
180 if (header[0] == UCODE_MAGIC &&
181 header[1] == UCODE_EQUIV_CPU_TABLE_TYPE)
182 break;
183
184 offset = header[1] + SECTION_HDR_SIZE;
185 data += offset;
186 left -= offset;
187 }
188
189 /* mark where the next microcode container file starts */
190 offset = data - (u8 *)ucode;
191 ucode = data;
192 }
193
194 return eq_id;
195}
196
197static int __apply_microcode_amd(struct microcode_amd *mc_amd)
198{
199 u32 rev, dummy;
200
201 native_wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc_amd->hdr.data_code);
202
203 /* verify patch application was successful */
204 native_rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
205 if (rev != mc_amd->hdr.patch_id)
206 return -1;
207
208 return 0;
209}
210
211/*
212 * Early load occurs before we can vmalloc(). So we look for the microcode
213 * patch container file in initrd, traverse equivalent cpu table, look for a
214 * matching microcode patch, and update, all in initrd memory in place.
215 * When vmalloc() is available for use later -- on 64-bit during first AP load,
216 * and on 32-bit during save_microcode_in_initrd_amd() -- we can call
217 * load_microcode_amd() to save equivalent cpu table and microcode patches in
218 * kernel heap memory.
219 *
220 * Returns true if container found (sets @ret_cont), false otherwise.
221 */
222static bool apply_microcode_early_amd(void *ucode, size_t size, bool save_patch,
223 struct container *ret_cont)
224{
225 u8 (*patch)[PATCH_MAX_SIZE];
226 u32 rev, *header, *new_rev;
227 struct container ret;
228 int offset, left;
229 u16 eq_id = 0;
230 u8 *data;
231
232#ifdef CONFIG_X86_32
233 new_rev = (u32 *)__pa_nodebug(&ucode_new_rev);
234 patch = (u8 (*)[PATCH_MAX_SIZE])__pa_nodebug(&amd_ucode_patch);
235#else
236 new_rev = &ucode_new_rev;
237 patch = &amd_ucode_patch;
238#endif
239
240 if (check_current_patch_level(&rev, true))
241 return false;
242
243 eq_id = find_proper_container(ucode, size, &ret);
244 if (!eq_id)
245 return false;
246
247 this_equiv_id = eq_id;
248 header = (u32 *)ret.data;
249
250 /* We're pointing to an equiv table, skip over it. */
251 data = ret.data + header[2] + CONTAINER_HDR_SZ;
252 left = ret.size - (header[2] + CONTAINER_HDR_SZ);
253
254 while (left > 0) {
255 struct microcode_amd *mc;
256
257 header = (u32 *)data;
258 if (header[0] != UCODE_UCODE_TYPE || /* type */
259 header[1] == 0) /* size */
260 break;
261
262 mc = (struct microcode_amd *)(data + SECTION_HDR_SIZE);
263
264 if (eq_id == mc->hdr.processor_rev_id && rev < mc->hdr.patch_id) {
265
266 if (!__apply_microcode_amd(mc)) {
267 rev = mc->hdr.patch_id;
268 *new_rev = rev;
269
270 if (save_patch)
271 memcpy(patch, mc, min_t(u32, header[1], PATCH_MAX_SIZE));
272 }
273 }
274
275 offset = header[1] + SECTION_HDR_SIZE;
276 data += offset;
277 left -= offset;
278 }
279
280 if (ret_cont)
281 *ret_cont = ret;
282
283 return true;
284}
285
286static bool get_builtin_microcode(struct cpio_data *cp, unsigned int family)
287{
288#ifdef CONFIG_X86_64
289 char fw_name[36] = "amd-ucode/microcode_amd.bin";
290
291 if (family >= 0x15)
292 snprintf(fw_name, sizeof(fw_name),
293 "amd-ucode/microcode_amd_fam%.2xh.bin", family);
294
295 return get_builtin_firmware(cp, fw_name);
296#else
297 return false;
298#endif
299}
300
301void __init load_ucode_amd_bsp(unsigned int family)
302{
303 struct ucode_cpu_info *uci;
304 u32 eax, ebx, ecx, edx;
305 struct cpio_data cp;
306 const char *path;
307 bool use_pa;
308
309 if (IS_ENABLED(CONFIG_X86_32)) {
310 uci = (struct ucode_cpu_info *)__pa_nodebug(ucode_cpu_info);
311 path = (const char *)__pa_nodebug(ucode_path);
312 use_pa = true;
313 } else {
314 uci = ucode_cpu_info;
315 path = ucode_path;
316 use_pa = false;
317 }
318
319 if (!get_builtin_microcode(&cp, family))
320 cp = find_microcode_in_initrd(path, use_pa);
321
322 if (!(cp.data && cp.size))
323 return;
324
325 /* Get BSP's CPUID.EAX(1), needed in load_microcode_amd() */
326 eax = 1;
327 ecx = 0;
328 native_cpuid(&eax, &ebx, &ecx, &edx);
329 uci->cpu_sig.sig = eax;
330
331 apply_microcode_early_amd(cp.data, cp.size, true, NULL);
332}
333
334#ifdef CONFIG_X86_32
335/*
336 * On 32-bit, since AP's early load occurs before paging is turned on, we
337 * cannot traverse cpu_equiv_table and microcode_cache in kernel heap memory.
338 * So during cold boot, AP will apply_ucode_in_initrd() just like the BSP.
339 * In save_microcode_in_initrd_amd() BSP's patch is copied to amd_ucode_patch,
340 * which is used upon resume from suspend.
341 */
342void load_ucode_amd_ap(unsigned int family)
343{
344 struct microcode_amd *mc;
345 struct cpio_data cp;
346
347 mc = (struct microcode_amd *)__pa_nodebug(amd_ucode_patch);
348 if (mc->hdr.patch_id && mc->hdr.processor_rev_id) {
349 __apply_microcode_amd(mc);
350 return;
351 }
352
353 if (!get_builtin_microcode(&cp, family))
354 cp = find_microcode_in_initrd((const char *)__pa_nodebug(ucode_path), true);
355
356 if (!(cp.data && cp.size))
357 return;
358
359 /*
360 * This would set amd_ucode_patch above so that the following APs can
361 * use it directly instead of going down this path again.
362 */
363 apply_microcode_early_amd(cp.data, cp.size, true, NULL);
364}
365#else
366void load_ucode_amd_ap(unsigned int family)
367{
368 struct equiv_cpu_entry *eq;
369 struct microcode_amd *mc;
370 u32 rev, eax;
371 u16 eq_id;
372
373 /* 64-bit runs with paging enabled, thus early==false. */
374 if (check_current_patch_level(&rev, false))
375 return;
376
377 /* First AP hasn't cached it yet, go through the blob. */
378 if (!cont.data) {
379 struct cpio_data cp = { NULL, 0, "" };
380
381 if (cont.size == -1)
382 return;
383
384reget:
385 if (!get_builtin_microcode(&cp, family)) {
386#ifdef CONFIG_BLK_DEV_INITRD
387 if (!initrd_gone)
388 cp = find_cpio_data(ucode_path, (void *)initrd_start,
389 initrd_end - initrd_start, NULL);
390#endif
391 if (!(cp.data && cp.size)) {
392 /*
393 * Mark it so that other APs do not scan again
394 * for no real reason and slow down boot
395 * needlessly.
396 */
397 cont.size = -1;
398 return;
399 }
400 }
401
402 if (!apply_microcode_early_amd(cp.data, cp.size, false, &cont)) {
403 cont.size = -1;
404 return;
405 }
406 }
407
408 eax = cpuid_eax(0x00000001);
409 eq = (struct equiv_cpu_entry *)(cont.data + CONTAINER_HDR_SZ);
410
411 eq_id = find_equiv_id(eq, eax);
412 if (!eq_id)
413 return;
414
415 if (eq_id == this_equiv_id) {
416 mc = (struct microcode_amd *)amd_ucode_patch;
417
418 if (mc && rev < mc->hdr.patch_id) {
419 if (!__apply_microcode_amd(mc))
420 ucode_new_rev = mc->hdr.patch_id;
421 }
422
423 } else {
424
425 /*
426 * AP has a different equivalence ID than BSP, looks like
427 * mixed-steppings silicon so go through the ucode blob anew.
428 */
429 goto reget;
430 }
431}
432#endif /* CONFIG_X86_32 */
433
434static enum ucode_state
435load_microcode_amd(int cpu, u8 family, const u8 *data, size_t size);
436
437int __init save_microcode_in_initrd_amd(unsigned int fam)
438{
439 enum ucode_state ret;
440 int retval = 0;
441 u16 eq_id;
442
443 if (!cont.data) {
444 if (IS_ENABLED(CONFIG_X86_32) && (cont.size != -1)) {
445 struct cpio_data cp = { NULL, 0, "" };
446
447#ifdef CONFIG_BLK_DEV_INITRD
448 cp = find_cpio_data(ucode_path, (void *)initrd_start,
449 initrd_end - initrd_start, NULL);
450#endif
451
452 if (!(cp.data && cp.size)) {
453 cont.size = -1;
454 return -EINVAL;
455 }
456
457 eq_id = find_proper_container(cp.data, cp.size, &cont);
458 if (!eq_id) {
459 cont.size = -1;
460 return -EINVAL;
461 }
462
463 } else
464 return -EINVAL;
465 }
466
467 ret = load_microcode_amd(smp_processor_id(), fam, cont.data, cont.size);
468 if (ret != UCODE_OK)
469 retval = -EINVAL;
470
471 /*
472 * This will be freed any msec now, stash patches for the current
473 * family and switch to patch cache for cpu hotplug, etc later.
474 */
475 cont.data = NULL;
476 cont.size = 0;
477
478 return retval;
479}
480
481void reload_ucode_amd(void)
482{
483 struct microcode_amd *mc;
484 u32 rev;
485
486 /*
487 * early==false because this is a syscore ->resume path and by
488 * that time paging is long enabled.
489 */
490 if (check_current_patch_level(&rev, false))
491 return;
492
493 mc = (struct microcode_amd *)amd_ucode_patch;
494 if (!mc)
495 return;
496
497 if (rev < mc->hdr.patch_id) {
498 if (!__apply_microcode_amd(mc)) {
499 ucode_new_rev = mc->hdr.patch_id;
500 pr_info("reload patch_level=0x%08x\n", ucode_new_rev);
501 }
502 }
503}
504static u16 __find_equiv_id(unsigned int cpu)
505{
506 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
507 return find_equiv_id(equiv_cpu_table, uci->cpu_sig.sig);
508}
509
510static u32 find_cpu_family_by_equiv_cpu(u16 equiv_cpu)
511{
512 int i = 0;
513
514 BUG_ON(!equiv_cpu_table);
515
516 while (equiv_cpu_table[i].equiv_cpu != 0) {
517 if (equiv_cpu == equiv_cpu_table[i].equiv_cpu)
518 return equiv_cpu_table[i].installed_cpu;
519 i++;
520 }
521 return 0;
522}
523
524/*
525 * a small, trivial cache of per-family ucode patches
526 */
527static struct ucode_patch *cache_find_patch(u16 equiv_cpu)
528{
529 struct ucode_patch *p;
530
531 list_for_each_entry(p, µcode_cache, plist)
532 if (p->equiv_cpu == equiv_cpu)
533 return p;
534 return NULL;
535}
536
537static void update_cache(struct ucode_patch *new_patch)
538{
539 struct ucode_patch *p;
540
541 list_for_each_entry(p, µcode_cache, plist) {
542 if (p->equiv_cpu == new_patch->equiv_cpu) {
543 if (p->patch_id >= new_patch->patch_id)
544 /* we already have the latest patch */
545 return;
546
547 list_replace(&p->plist, &new_patch->plist);
548 kfree(p->data);
549 kfree(p);
550 return;
551 }
552 }
553 /* no patch found, add it */
554 list_add_tail(&new_patch->plist, µcode_cache);
555}
556
557static void free_cache(void)
558{
559 struct ucode_patch *p, *tmp;
560
561 list_for_each_entry_safe(p, tmp, µcode_cache, plist) {
562 __list_del(p->plist.prev, p->plist.next);
563 kfree(p->data);
564 kfree(p);
565 }
566}
567
568static struct ucode_patch *find_patch(unsigned int cpu)
569{
570 u16 equiv_id;
571
572 equiv_id = __find_equiv_id(cpu);
573 if (!equiv_id)
574 return NULL;
575
576 return cache_find_patch(equiv_id);
577}
578
579static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
580{
581 struct cpuinfo_x86 *c = &cpu_data(cpu);
582 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
583 struct ucode_patch *p;
584
585 csig->sig = cpuid_eax(0x00000001);
586 csig->rev = c->microcode;
587
588 /*
589 * a patch could have been loaded early, set uci->mc so that
590 * mc_bp_resume() can call apply_microcode()
591 */
592 p = find_patch(cpu);
593 if (p && (p->patch_id == csig->rev))
594 uci->mc = p->data;
595
596 pr_info("CPU%d: patch_level=0x%08x\n", cpu, csig->rev);
597
598 return 0;
599}
600
601static unsigned int verify_patch_size(u8 family, u32 patch_size,
602 unsigned int size)
603{
604 u32 max_size;
605
606#define F1XH_MPB_MAX_SIZE 2048
607#define F14H_MPB_MAX_SIZE 1824
608#define F15H_MPB_MAX_SIZE 4096
609#define F16H_MPB_MAX_SIZE 3458
610
611 switch (family) {
612 case 0x14:
613 max_size = F14H_MPB_MAX_SIZE;
614 break;
615 case 0x15:
616 max_size = F15H_MPB_MAX_SIZE;
617 break;
618 case 0x16:
619 max_size = F16H_MPB_MAX_SIZE;
620 break;
621 default:
622 max_size = F1XH_MPB_MAX_SIZE;
623 break;
624 }
625
626 if (patch_size > min_t(u32, size, max_size)) {
627 pr_err("patch size mismatch\n");
628 return 0;
629 }
630
631 return patch_size;
632}
633
634/*
635 * Those patch levels cannot be updated to newer ones and thus should be final.
636 */
637static u32 final_levels[] = {
638 0x01000098,
639 0x0100009f,
640 0x010000af,
641 0, /* T-101 terminator */
642};
643
644/*
645 * Check the current patch level on this CPU.
646 *
647 * @rev: Use it to return the patch level. It is set to 0 in the case of
648 * error.
649 *
650 * Returns:
651 * - true: if update should stop
652 * - false: otherwise
653 */
654bool check_current_patch_level(u32 *rev, bool early)
655{
656 u32 lvl, dummy, i;
657 bool ret = false;
658 u32 *levels;
659
660 native_rdmsr(MSR_AMD64_PATCH_LEVEL, lvl, dummy);
661
662 if (IS_ENABLED(CONFIG_X86_32) && early)
663 levels = (u32 *)__pa_nodebug(&final_levels);
664 else
665 levels = final_levels;
666
667 for (i = 0; levels[i]; i++) {
668 if (lvl == levels[i]) {
669 lvl = 0;
670 ret = true;
671 break;
672 }
673 }
674
675 if (rev)
676 *rev = lvl;
677
678 return ret;
679}
680
681static int apply_microcode_amd(int cpu)
682{
683 struct cpuinfo_x86 *c = &cpu_data(cpu);
684 struct microcode_amd *mc_amd;
685 struct ucode_cpu_info *uci;
686 struct ucode_patch *p;
687 u32 rev;
688
689 BUG_ON(raw_smp_processor_id() != cpu);
690
691 uci = ucode_cpu_info + cpu;
692
693 p = find_patch(cpu);
694 if (!p)
695 return 0;
696
697 mc_amd = p->data;
698 uci->mc = p->data;
699
700 if (check_current_patch_level(&rev, false))
701 return -1;
702
703 /* need to apply patch? */
704 if (rev >= mc_amd->hdr.patch_id) {
705 c->microcode = rev;
706 uci->cpu_sig.rev = rev;
707 return 0;
708 }
709
710 if (__apply_microcode_amd(mc_amd)) {
711 pr_err("CPU%d: update failed for patch_level=0x%08x\n",
712 cpu, mc_amd->hdr.patch_id);
713 return -1;
714 }
715 pr_info("CPU%d: new patch_level=0x%08x\n", cpu,
716 mc_amd->hdr.patch_id);
717
718 uci->cpu_sig.rev = mc_amd->hdr.patch_id;
719 c->microcode = mc_amd->hdr.patch_id;
720
721 return 0;
722}
723
724static int install_equiv_cpu_table(const u8 *buf)
725{
726 unsigned int *ibuf = (unsigned int *)buf;
727 unsigned int type = ibuf[1];
728 unsigned int size = ibuf[2];
729
730 if (type != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
731 pr_err("empty section/"
732 "invalid type field in container file section header\n");
733 return -EINVAL;
734 }
735
736 equiv_cpu_table = vmalloc(size);
737 if (!equiv_cpu_table) {
738 pr_err("failed to allocate equivalent CPU table\n");
739 return -ENOMEM;
740 }
741
742 memcpy(equiv_cpu_table, buf + CONTAINER_HDR_SZ, size);
743
744 /* add header length */
745 return size + CONTAINER_HDR_SZ;
746}
747
748static void free_equiv_cpu_table(void)
749{
750 vfree(equiv_cpu_table);
751 equiv_cpu_table = NULL;
752}
753
754static void cleanup(void)
755{
756 free_equiv_cpu_table();
757 free_cache();
758}
759
760/*
761 * We return the current size even if some of the checks failed so that
762 * we can skip over the next patch. If we return a negative value, we
763 * signal a grave error like a memory allocation has failed and the
764 * driver cannot continue functioning normally. In such cases, we tear
765 * down everything we've used up so far and exit.
766 */
767static int verify_and_add_patch(u8 family, u8 *fw, unsigned int leftover)
768{
769 struct microcode_header_amd *mc_hdr;
770 struct ucode_patch *patch;
771 unsigned int patch_size, crnt_size, ret;
772 u32 proc_fam;
773 u16 proc_id;
774
775 patch_size = *(u32 *)(fw + 4);
776 crnt_size = patch_size + SECTION_HDR_SIZE;
777 mc_hdr = (struct microcode_header_amd *)(fw + SECTION_HDR_SIZE);
778 proc_id = mc_hdr->processor_rev_id;
779
780 proc_fam = find_cpu_family_by_equiv_cpu(proc_id);
781 if (!proc_fam) {
782 pr_err("No patch family for equiv ID: 0x%04x\n", proc_id);
783 return crnt_size;
784 }
785
786 /* check if patch is for the current family */
787 proc_fam = ((proc_fam >> 8) & 0xf) + ((proc_fam >> 20) & 0xff);
788 if (proc_fam != family)
789 return crnt_size;
790
791 if (mc_hdr->nb_dev_id || mc_hdr->sb_dev_id) {
792 pr_err("Patch-ID 0x%08x: chipset-specific code unsupported.\n",
793 mc_hdr->patch_id);
794 return crnt_size;
795 }
796
797 ret = verify_patch_size(family, patch_size, leftover);
798 if (!ret) {
799 pr_err("Patch-ID 0x%08x: size mismatch.\n", mc_hdr->patch_id);
800 return crnt_size;
801 }
802
803 patch = kzalloc(sizeof(*patch), GFP_KERNEL);
804 if (!patch) {
805 pr_err("Patch allocation failure.\n");
806 return -EINVAL;
807 }
808
809 patch->data = kmemdup(fw + SECTION_HDR_SIZE, patch_size, GFP_KERNEL);
810 if (!patch->data) {
811 pr_err("Patch data allocation failure.\n");
812 kfree(patch);
813 return -EINVAL;
814 }
815
816 INIT_LIST_HEAD(&patch->plist);
817 patch->patch_id = mc_hdr->patch_id;
818 patch->equiv_cpu = proc_id;
819
820 pr_debug("%s: Added patch_id: 0x%08x, proc_id: 0x%04x\n",
821 __func__, patch->patch_id, proc_id);
822
823 /* ... and add to cache. */
824 update_cache(patch);
825
826 return crnt_size;
827}
828
829static enum ucode_state __load_microcode_amd(u8 family, const u8 *data,
830 size_t size)
831{
832 enum ucode_state ret = UCODE_ERROR;
833 unsigned int leftover;
834 u8 *fw = (u8 *)data;
835 int crnt_size = 0;
836 int offset;
837
838 offset = install_equiv_cpu_table(data);
839 if (offset < 0) {
840 pr_err("failed to create equivalent cpu table\n");
841 return ret;
842 }
843 fw += offset;
844 leftover = size - offset;
845
846 if (*(u32 *)fw != UCODE_UCODE_TYPE) {
847 pr_err("invalid type field in container file section header\n");
848 free_equiv_cpu_table();
849 return ret;
850 }
851
852 while (leftover) {
853 crnt_size = verify_and_add_patch(family, fw, leftover);
854 if (crnt_size < 0)
855 return ret;
856
857 fw += crnt_size;
858 leftover -= crnt_size;
859 }
860
861 return UCODE_OK;
862}
863
864static enum ucode_state
865load_microcode_amd(int cpu, u8 family, const u8 *data, size_t size)
866{
867 enum ucode_state ret;
868
869 /* free old equiv table */
870 free_equiv_cpu_table();
871
872 ret = __load_microcode_amd(family, data, size);
873
874 if (ret != UCODE_OK)
875 cleanup();
876
877#ifdef CONFIG_X86_32
878 /* save BSP's matching patch for early load */
879 if (cpu_data(cpu).cpu_index == boot_cpu_data.cpu_index) {
880 struct ucode_patch *p = find_patch(cpu);
881 if (p) {
882 memset(amd_ucode_patch, 0, PATCH_MAX_SIZE);
883 memcpy(amd_ucode_patch, p->data, min_t(u32, ksize(p->data),
884 PATCH_MAX_SIZE));
885 }
886 }
887#endif
888 return ret;
889}
890
891/*
892 * AMD microcode firmware naming convention, up to family 15h they are in
893 * the legacy file:
894 *
895 * amd-ucode/microcode_amd.bin
896 *
897 * This legacy file is always smaller than 2K in size.
898 *
899 * Beginning with family 15h, they are in family-specific firmware files:
900 *
901 * amd-ucode/microcode_amd_fam15h.bin
902 * amd-ucode/microcode_amd_fam16h.bin
903 * ...
904 *
905 * These might be larger than 2K.
906 */
907static enum ucode_state request_microcode_amd(int cpu, struct device *device,
908 bool refresh_fw)
909{
910 char fw_name[36] = "amd-ucode/microcode_amd.bin";
911 struct cpuinfo_x86 *c = &cpu_data(cpu);
912 enum ucode_state ret = UCODE_NFOUND;
913 const struct firmware *fw;
914
915 /* reload ucode container only on the boot cpu */
916 if (!refresh_fw || c->cpu_index != boot_cpu_data.cpu_index)
917 return UCODE_OK;
918
919 if (c->x86 >= 0x15)
920 snprintf(fw_name, sizeof(fw_name), "amd-ucode/microcode_amd_fam%.2xh.bin", c->x86);
921
922 if (request_firmware_direct(&fw, (const char *)fw_name, device)) {
923 pr_debug("failed to load file %s\n", fw_name);
924 goto out;
925 }
926
927 ret = UCODE_ERROR;
928 if (*(u32 *)fw->data != UCODE_MAGIC) {
929 pr_err("invalid magic value (0x%08x)\n", *(u32 *)fw->data);
930 goto fw_release;
931 }
932
933 ret = load_microcode_amd(cpu, c->x86, fw->data, fw->size);
934
935 fw_release:
936 release_firmware(fw);
937
938 out:
939 return ret;
940}
941
942static enum ucode_state
943request_microcode_user(int cpu, const void __user *buf, size_t size)
944{
945 return UCODE_ERROR;
946}
947
948static void microcode_fini_cpu_amd(int cpu)
949{
950 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
951
952 uci->mc = NULL;
953}
954
955static struct microcode_ops microcode_amd_ops = {
956 .request_microcode_user = request_microcode_user,
957 .request_microcode_fw = request_microcode_amd,
958 .collect_cpu_info = collect_cpu_info_amd,
959 .apply_microcode = apply_microcode_amd,
960 .microcode_fini_cpu = microcode_fini_cpu_amd,
961};
962
963struct microcode_ops * __init init_amd_microcode(void)
964{
965 struct cpuinfo_x86 *c = &boot_cpu_data;
966
967 if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
968 pr_warn("AMD CPU family 0x%x not supported\n", c->x86);
969 return NULL;
970 }
971
972 if (ucode_new_rev)
973 pr_info_once("microcode updated early to new patch_level=0x%08x\n",
974 ucode_new_rev);
975
976 return µcode_amd_ops;
977}
978
979void __exit exit_amd_microcode(void)
980{
981 cleanup();
982}