Documentation/microcode: Document some aspects for more clarity
[linux-2.6-block.git] / arch / x86 / kernel / cpu / microcode / intel.c
1 /*
2  * Intel CPU Microcode Update Driver for Linux
3  *
4  * Copyright (C) 2000-2006 Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
5  *               2006 Shaohua Li <shaohua.li@intel.com>
6  *
7  * Intel CPU microcode early update for Linux
8  *
9  * Copyright (C) 2012 Fenghua Yu <fenghua.yu@intel.com>
10  *                    H Peter Anvin" <hpa@zytor.com>
11  *
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.
16  */
17
18 /*
19  * This needs to be before all headers so that pr_debug in printk.h doesn't turn
20  * printk calls into no_printk().
21  *
22  *#define DEBUG
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/slab.h>
33 #include <linux/cpu.h>
34 #include <linux/mm.h>
35
36 #include <asm/microcode_intel.h>
37 #include <asm/processor.h>
38 #include <asm/tlbflush.h>
39 #include <asm/setup.h>
40 #include <asm/msr.h>
41
42 /*
43  * Temporary microcode blobs pointers storage. We note here during early load
44  * the pointers to microcode blobs we've got from whatever storage (detached
45  * initrd, builtin). Later on, we put those into final storage
46  * mc_saved_data.mc_saved.
47  *
48  * Important: those are offsets from the beginning of initrd or absolute
49  * addresses within the kernel image when built-in.
50  */
51 static unsigned long mc_tmp_ptrs[MAX_UCODE_COUNT];
52
53 static struct mc_saved_data {
54         unsigned int num_saved;
55         struct microcode_intel **mc_saved;
56 } mc_saved_data;
57
58 /* Microcode blobs within the initrd. 0 if builtin. */
59 static struct ucode_blobs {
60         unsigned long start;
61         bool valid;
62 } blobs;
63
64 /* Go through saved patches and find the one suitable for the current CPU. */
65 static enum ucode_state
66 find_microcode_patch(struct microcode_intel **saved,
67                      unsigned int num_saved, struct ucode_cpu_info *uci)
68 {
69         struct microcode_intel *ucode_ptr, *new_mc = NULL;
70         struct microcode_header_intel *mc_hdr;
71         int new_rev, ret, i;
72
73         new_rev = uci->cpu_sig.rev;
74
75         for (i = 0; i < num_saved; i++) {
76                 ucode_ptr = saved[i];
77                 mc_hdr    = (struct microcode_header_intel *)ucode_ptr;
78
79                 ret = has_newer_microcode(ucode_ptr,
80                                           uci->cpu_sig.sig,
81                                           uci->cpu_sig.pf,
82                                           new_rev);
83                 if (!ret)
84                         continue;
85
86                 new_rev = mc_hdr->rev;
87                 new_mc  = ucode_ptr;
88         }
89
90         if (!new_mc)
91                 return UCODE_NFOUND;
92
93         uci->mc = (struct microcode_intel *)new_mc;
94         return UCODE_OK;
95 }
96
97 static inline void
98 copy_ptrs(struct microcode_intel **mc_saved, unsigned long *mc_ptrs,
99           unsigned long off, int num_saved)
100 {
101         int i;
102
103         for (i = 0; i < num_saved; i++)
104                 mc_saved[i] = (struct microcode_intel *)(mc_ptrs[i] + off);
105 }
106
107 #ifdef CONFIG_X86_32
108 static void
109 microcode_phys(struct microcode_intel **mc_saved_tmp, struct mc_saved_data *mcs)
110 {
111         int i;
112         struct microcode_intel ***mc_saved;
113
114         mc_saved = (struct microcode_intel ***)__pa_nodebug(&mcs->mc_saved);
115
116         for (i = 0; i < mcs->num_saved; i++) {
117                 struct microcode_intel *p;
118
119                 p = *(struct microcode_intel **)__pa_nodebug(mcs->mc_saved + i);
120                 mc_saved_tmp[i] = (struct microcode_intel *)__pa_nodebug(p);
121         }
122 }
123 #endif
124
125 static enum ucode_state
126 load_microcode(struct mc_saved_data *mcs, unsigned long *mc_ptrs,
127                unsigned long offset, struct ucode_cpu_info *uci)
128 {
129         struct microcode_intel *mc_saved_tmp[MAX_UCODE_COUNT];
130         unsigned int count = mcs->num_saved;
131
132         if (!mcs->mc_saved) {
133                 copy_ptrs(mc_saved_tmp, mc_ptrs, offset, count);
134
135                 return find_microcode_patch(mc_saved_tmp, count, uci);
136         } else {
137 #ifdef CONFIG_X86_32
138                 microcode_phys(mc_saved_tmp, mcs);
139                 return find_microcode_patch(mc_saved_tmp, count, uci);
140 #else
141                 return find_microcode_patch(mcs->mc_saved, count, uci);
142 #endif
143         }
144 }
145
146 /*
147  * Given CPU signature and a microcode patch, this function finds if the
148  * microcode patch has matching family and model with the CPU.
149  */
150 static enum ucode_state
151 matching_model_microcode(struct microcode_header_intel *mc_header,
152                         unsigned long sig)
153 {
154         unsigned int fam, model;
155         unsigned int fam_ucode, model_ucode;
156         struct extended_sigtable *ext_header;
157         unsigned long total_size = get_totalsize(mc_header);
158         unsigned long data_size = get_datasize(mc_header);
159         int ext_sigcount, i;
160         struct extended_signature *ext_sig;
161
162         fam   = x86_family(sig);
163         model = x86_model(sig);
164
165         fam_ucode   = x86_family(mc_header->sig);
166         model_ucode = x86_model(mc_header->sig);
167
168         if (fam == fam_ucode && model == model_ucode)
169                 return UCODE_OK;
170
171         /* Look for ext. headers: */
172         if (total_size <= data_size + MC_HEADER_SIZE)
173                 return UCODE_NFOUND;
174
175         ext_header   = (void *) mc_header + data_size + MC_HEADER_SIZE;
176         ext_sig      = (void *)ext_header + EXT_HEADER_SIZE;
177         ext_sigcount = ext_header->count;
178
179         for (i = 0; i < ext_sigcount; i++) {
180                 fam_ucode   = x86_family(ext_sig->sig);
181                 model_ucode = x86_model(ext_sig->sig);
182
183                 if (fam == fam_ucode && model == model_ucode)
184                         return UCODE_OK;
185
186                 ext_sig++;
187         }
188         return UCODE_NFOUND;
189 }
190
191 static int
192 save_microcode(struct mc_saved_data *mcs,
193                struct microcode_intel **mc_saved_src,
194                unsigned int num_saved)
195 {
196         int i, j;
197         struct microcode_intel **saved_ptr;
198         int ret;
199
200         if (!num_saved)
201                 return -EINVAL;
202
203         /*
204          * Copy new microcode data.
205          */
206         saved_ptr = kcalloc(num_saved, sizeof(struct microcode_intel *), GFP_KERNEL);
207         if (!saved_ptr)
208                 return -ENOMEM;
209
210         for (i = 0; i < num_saved; i++) {
211                 struct microcode_header_intel *mc_hdr;
212                 struct microcode_intel *mc;
213                 unsigned long size;
214
215                 if (!mc_saved_src[i]) {
216                         ret = -EINVAL;
217                         goto err;
218                 }
219
220                 mc     = mc_saved_src[i];
221                 mc_hdr = &mc->hdr;
222                 size   = get_totalsize(mc_hdr);
223
224                 saved_ptr[i] = kmemdup(mc, size, GFP_KERNEL);
225                 if (!saved_ptr[i]) {
226                         ret = -ENOMEM;
227                         goto err;
228                 }
229         }
230
231         /*
232          * Point to newly saved microcode.
233          */
234         mcs->mc_saved  = saved_ptr;
235         mcs->num_saved = num_saved;
236
237         return 0;
238
239 err:
240         for (j = 0; j <= i; j++)
241                 kfree(saved_ptr[j]);
242         kfree(saved_ptr);
243
244         return ret;
245 }
246
247 /*
248  * A microcode patch in ucode_ptr is saved into mc_saved
249  * - if it has matching signature and newer revision compared to an existing
250  *   patch mc_saved.
251  * - or if it is a newly discovered microcode patch.
252  *
253  * The microcode patch should have matching model with CPU.
254  *
255  * Returns: The updated number @num_saved of saved microcode patches.
256  */
257 static unsigned int _save_mc(struct microcode_intel **mc_saved,
258                              u8 *ucode_ptr, unsigned int num_saved)
259 {
260         struct microcode_header_intel *mc_hdr, *mc_saved_hdr;
261         unsigned int sig, pf;
262         int found = 0, i;
263
264         mc_hdr = (struct microcode_header_intel *)ucode_ptr;
265
266         for (i = 0; i < num_saved; i++) {
267                 mc_saved_hdr = (struct microcode_header_intel *)mc_saved[i];
268                 sig          = mc_saved_hdr->sig;
269                 pf           = mc_saved_hdr->pf;
270
271                 if (!find_matching_signature(ucode_ptr, sig, pf))
272                         continue;
273
274                 found = 1;
275
276                 if (mc_hdr->rev <= mc_saved_hdr->rev)
277                         continue;
278
279                 /*
280                  * Found an older ucode saved earlier. Replace it with
281                  * this newer one.
282                  */
283                 mc_saved[i] = (struct microcode_intel *)ucode_ptr;
284                 break;
285         }
286
287         /* Newly detected microcode, save it to memory. */
288         if (i >= num_saved && !found)
289                 mc_saved[num_saved++] = (struct microcode_intel *)ucode_ptr;
290
291         return num_saved;
292 }
293
294 /*
295  * Get microcode matching with BSP's model. Only CPUs with the same model as
296  * BSP can stay in the platform.
297  */
298 static enum ucode_state __init
299 get_matching_model_microcode(unsigned long start, void *data, size_t size,
300                              struct mc_saved_data *mcs, unsigned long *mc_ptrs,
301                              struct ucode_cpu_info *uci)
302 {
303         struct microcode_intel *mc_saved_tmp[MAX_UCODE_COUNT];
304         struct microcode_header_intel *mc_header;
305         unsigned int num_saved = mcs->num_saved;
306         enum ucode_state state = UCODE_OK;
307         unsigned int leftover = size;
308         u8 *ucode_ptr = data;
309         unsigned int mc_size;
310         int i;
311
312         while (leftover && num_saved < ARRAY_SIZE(mc_saved_tmp)) {
313
314                 if (leftover < sizeof(mc_header))
315                         break;
316
317                 mc_header = (struct microcode_header_intel *)ucode_ptr;
318
319                 mc_size = get_totalsize(mc_header);
320                 if (!mc_size || mc_size > leftover ||
321                         microcode_sanity_check(ucode_ptr, 0) < 0)
322                         break;
323
324                 leftover -= mc_size;
325
326                 /*
327                  * Since APs with same family and model as the BSP may boot in
328                  * the platform, we need to find and save microcode patches
329                  * with the same family and model as the BSP.
330                  */
331                 if (matching_model_microcode(mc_header, uci->cpu_sig.sig) != UCODE_OK) {
332                         ucode_ptr += mc_size;
333                         continue;
334                 }
335
336                 num_saved = _save_mc(mc_saved_tmp, ucode_ptr, num_saved);
337
338                 ucode_ptr += mc_size;
339         }
340
341         if (leftover) {
342                 state = UCODE_ERROR;
343                 return state;
344         }
345
346         if (!num_saved) {
347                 state = UCODE_NFOUND;
348                 return state;
349         }
350
351         for (i = 0; i < num_saved; i++)
352                 mc_ptrs[i] = (unsigned long)mc_saved_tmp[i] - start;
353
354         mcs->num_saved = num_saved;
355
356         return state;
357 }
358
359 static int collect_cpu_info_early(struct ucode_cpu_info *uci)
360 {
361         unsigned int val[2];
362         unsigned int family, model;
363         struct cpu_signature csig;
364         unsigned int eax, ebx, ecx, edx;
365
366         csig.sig = 0;
367         csig.pf = 0;
368         csig.rev = 0;
369
370         memset(uci, 0, sizeof(*uci));
371
372         eax = 0x00000001;
373         ecx = 0;
374         native_cpuid(&eax, &ebx, &ecx, &edx);
375         csig.sig = eax;
376
377         family = x86_family(csig.sig);
378         model  = x86_model(csig.sig);
379
380         if ((model >= 5) || (family > 6)) {
381                 /* get processor flags from MSR 0x17 */
382                 native_rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
383                 csig.pf = 1 << ((val[1] >> 18) & 7);
384         }
385         native_wrmsrl(MSR_IA32_UCODE_REV, 0);
386
387         /* As documented in the SDM: Do a CPUID 1 here */
388         sync_core();
389
390         /* get the current revision from MSR 0x8B */
391         native_rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
392
393         csig.rev = val[1];
394
395         uci->cpu_sig = csig;
396         uci->valid = 1;
397
398         return 0;
399 }
400
401 static void show_saved_mc(void)
402 {
403 #ifdef DEBUG
404         int i, j;
405         unsigned int sig, pf, rev, total_size, data_size, date;
406         struct ucode_cpu_info uci;
407
408         if (!mc_saved_data.num_saved) {
409                 pr_debug("no microcode data saved.\n");
410                 return;
411         }
412         pr_debug("Total microcode saved: %d\n", mc_saved_data.num_saved);
413
414         collect_cpu_info_early(&uci);
415
416         sig = uci.cpu_sig.sig;
417         pf = uci.cpu_sig.pf;
418         rev = uci.cpu_sig.rev;
419         pr_debug("CPU: sig=0x%x, pf=0x%x, rev=0x%x\n", sig, pf, rev);
420
421         for (i = 0; i < mc_saved_data.num_saved; i++) {
422                 struct microcode_header_intel *mc_saved_header;
423                 struct extended_sigtable *ext_header;
424                 int ext_sigcount;
425                 struct extended_signature *ext_sig;
426
427                 mc_saved_header = (struct microcode_header_intel *)
428                                   mc_saved_data.mc_saved[i];
429                 sig = mc_saved_header->sig;
430                 pf = mc_saved_header->pf;
431                 rev = mc_saved_header->rev;
432                 total_size = get_totalsize(mc_saved_header);
433                 data_size = get_datasize(mc_saved_header);
434                 date = mc_saved_header->date;
435
436                 pr_debug("mc_saved[%d]: sig=0x%x, pf=0x%x, rev=0x%x, total size=0x%x, date = %04x-%02x-%02x\n",
437                          i, sig, pf, rev, total_size,
438                          date & 0xffff,
439                          date >> 24,
440                          (date >> 16) & 0xff);
441
442                 /* Look for ext. headers: */
443                 if (total_size <= data_size + MC_HEADER_SIZE)
444                         continue;
445
446                 ext_header = (void *) mc_saved_header + data_size + MC_HEADER_SIZE;
447                 ext_sigcount = ext_header->count;
448                 ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
449
450                 for (j = 0; j < ext_sigcount; j++) {
451                         sig = ext_sig->sig;
452                         pf = ext_sig->pf;
453
454                         pr_debug("\tExtended[%d]: sig=0x%x, pf=0x%x\n",
455                                  j, sig, pf);
456
457                         ext_sig++;
458                 }
459
460         }
461 #endif
462 }
463
464 /*
465  * Save this mc into mc_saved_data. So it will be loaded early when a CPU is
466  * hot added or resumes.
467  *
468  * Please make sure this mc should be a valid microcode patch before calling
469  * this function.
470  */
471 static void save_mc_for_early(u8 *mc)
472 {
473 #ifdef CONFIG_HOTPLUG_CPU
474         /* Synchronization during CPU hotplug. */
475         static DEFINE_MUTEX(x86_cpu_microcode_mutex);
476
477         struct microcode_intel *mc_saved_tmp[MAX_UCODE_COUNT];
478         unsigned int mc_saved_count_init;
479         unsigned int num_saved;
480         struct microcode_intel **mc_saved;
481         int ret, i;
482
483         mutex_lock(&x86_cpu_microcode_mutex);
484
485         mc_saved_count_init = mc_saved_data.num_saved;
486         num_saved = mc_saved_data.num_saved;
487         mc_saved = mc_saved_data.mc_saved;
488
489         if (mc_saved && num_saved)
490                 memcpy(mc_saved_tmp, mc_saved,
491                        num_saved * sizeof(struct microcode_intel *));
492         /*
493          * Save the microcode patch mc in mc_save_tmp structure if it's a newer
494          * version.
495          */
496         num_saved = _save_mc(mc_saved_tmp, mc, num_saved);
497
498         /*
499          * Save the mc_save_tmp in global mc_saved_data.
500          */
501         ret = save_microcode(&mc_saved_data, mc_saved_tmp, num_saved);
502         if (ret) {
503                 pr_err("Cannot save microcode patch.\n");
504                 goto out;
505         }
506
507         show_saved_mc();
508
509         /*
510          * Free old saved microcode data.
511          */
512         if (mc_saved) {
513                 for (i = 0; i < mc_saved_count_init; i++)
514                         kfree(mc_saved[i]);
515                 kfree(mc_saved);
516         }
517
518 out:
519         mutex_unlock(&x86_cpu_microcode_mutex);
520 #endif
521 }
522
523 static bool __init load_builtin_intel_microcode(struct cpio_data *cp)
524 {
525 #ifdef CONFIG_X86_64
526         unsigned int eax = 0x00000001, ebx, ecx = 0, edx;
527         char name[30];
528
529         native_cpuid(&eax, &ebx, &ecx, &edx);
530
531         sprintf(name, "intel-ucode/%02x-%02x-%02x",
532                       x86_family(eax), x86_model(eax), x86_stepping(eax));
533
534         return get_builtin_firmware(cp, name);
535 #else
536         return false;
537 #endif
538 }
539
540 /*
541  * Print ucode update info.
542  */
543 static void
544 print_ucode_info(struct ucode_cpu_info *uci, unsigned int date)
545 {
546         pr_info_once("microcode updated early to revision 0x%x, date = %04x-%02x-%02x\n",
547                      uci->cpu_sig.rev,
548                      date & 0xffff,
549                      date >> 24,
550                      (date >> 16) & 0xff);
551 }
552
553 #ifdef CONFIG_X86_32
554
555 static int delay_ucode_info;
556 static int current_mc_date;
557
558 /*
559  * Print early updated ucode info after printk works. This is delayed info dump.
560  */
561 void show_ucode_info_early(void)
562 {
563         struct ucode_cpu_info uci;
564
565         if (delay_ucode_info) {
566                 collect_cpu_info_early(&uci);
567                 print_ucode_info(&uci, current_mc_date);
568                 delay_ucode_info = 0;
569         }
570 }
571
572 /*
573  * At this point, we can not call printk() yet. Keep microcode patch number in
574  * mc_saved_data.mc_saved and delay printing microcode info in
575  * show_ucode_info_early() until printk() works.
576  */
577 static void print_ucode(struct ucode_cpu_info *uci)
578 {
579         struct microcode_intel *mc;
580         int *delay_ucode_info_p;
581         int *current_mc_date_p;
582
583         mc = uci->mc;
584         if (!mc)
585                 return;
586
587         delay_ucode_info_p = (int *)__pa_nodebug(&delay_ucode_info);
588         current_mc_date_p = (int *)__pa_nodebug(&current_mc_date);
589
590         *delay_ucode_info_p = 1;
591         *current_mc_date_p = mc->hdr.date;
592 }
593 #else
594
595 /*
596  * Flush global tlb. We only do this in x86_64 where paging has been enabled
597  * already and PGE should be enabled as well.
598  */
599 static inline void flush_tlb_early(void)
600 {
601         __native_flush_tlb_global_irq_disabled();
602 }
603
604 static inline void print_ucode(struct ucode_cpu_info *uci)
605 {
606         struct microcode_intel *mc;
607
608         mc = uci->mc;
609         if (!mc)
610                 return;
611
612         print_ucode_info(uci, mc->hdr.date);
613 }
614 #endif
615
616 static int apply_microcode_early(struct ucode_cpu_info *uci, bool early)
617 {
618         struct microcode_intel *mc;
619         unsigned int val[2];
620
621         mc = uci->mc;
622         if (!mc)
623                 return 0;
624
625         /* write microcode via MSR 0x79 */
626         native_wrmsrl(MSR_IA32_UCODE_WRITE, (unsigned long)mc->bits);
627         native_wrmsrl(MSR_IA32_UCODE_REV, 0);
628
629         /* As documented in the SDM: Do a CPUID 1 here */
630         sync_core();
631
632         /* get the current revision from MSR 0x8B */
633         native_rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
634         if (val[1] != mc->hdr.rev)
635                 return -1;
636
637 #ifdef CONFIG_X86_64
638         /* Flush global tlb. This is precaution. */
639         flush_tlb_early();
640 #endif
641         uci->cpu_sig.rev = val[1];
642
643         if (early)
644                 print_ucode(uci);
645         else
646                 print_ucode_info(uci, mc->hdr.date);
647
648         return 0;
649 }
650
651 /*
652  * This function converts microcode patch offsets previously stored in
653  * mc_tmp_ptrs to pointers and stores the pointers in mc_saved_data.
654  */
655 int __init save_microcode_in_initrd_intel(void)
656 {
657         struct microcode_intel *mc_saved[MAX_UCODE_COUNT];
658         unsigned int count = mc_saved_data.num_saved;
659         unsigned long offset = 0;
660         int ret;
661
662         if (!count)
663                 return 0;
664
665         /*
666          * We have found a valid initrd but it might've been relocated in the
667          * meantime so get its updated address.
668          */
669         if (IS_ENABLED(CONFIG_BLK_DEV_INITRD) && blobs.valid)
670                 offset = initrd_start;
671
672         copy_ptrs(mc_saved, mc_tmp_ptrs, offset, count);
673
674         ret = save_microcode(&mc_saved_data, mc_saved, count);
675         if (ret)
676                 pr_err("Cannot save microcode patches from initrd.\n");
677         else
678                 show_saved_mc();
679
680         return ret;
681 }
682
683 static __init enum ucode_state
684 __scan_microcode_initrd(struct cpio_data *cd, struct ucode_blobs *blbp)
685 {
686 #ifdef CONFIG_BLK_DEV_INITRD
687         static __initdata char ucode_name[] = "kernel/x86/microcode/GenuineIntel.bin";
688         char *p = IS_ENABLED(CONFIG_X86_32) ? (char *)__pa_nodebug(ucode_name)
689                                                     : ucode_name;
690 # ifdef CONFIG_X86_32
691         unsigned long start = 0, size;
692         struct boot_params *params;
693
694         params = (struct boot_params *)__pa_nodebug(&boot_params);
695         size   = params->hdr.ramdisk_size;
696
697         /*
698          * Set start only if we have an initrd image. We cannot use initrd_start
699          * because it is not set that early yet.
700          */
701         start = (size ? params->hdr.ramdisk_image : 0);
702
703 # else /* CONFIG_X86_64 */
704         unsigned long start = 0, size;
705
706         size  = (u64)boot_params.ext_ramdisk_size << 32;
707         size |= boot_params.hdr.ramdisk_size;
708
709         if (size) {
710                 start  = (u64)boot_params.ext_ramdisk_image << 32;
711                 start |= boot_params.hdr.ramdisk_image;
712
713                 start += PAGE_OFFSET;
714         }
715 # endif
716
717         *cd = find_cpio_data(p, (void *)start, size, NULL);
718         if (cd->data) {
719                 blbp->start = start;
720                 blbp->valid = true;
721
722                 return UCODE_OK;
723         } else
724 #endif /* CONFIG_BLK_DEV_INITRD */
725                 return UCODE_ERROR;
726 }
727
728 static __init enum ucode_state
729 scan_microcode(struct mc_saved_data *mcs, unsigned long *mc_ptrs,
730                struct ucode_cpu_info *uci, struct ucode_blobs *blbp)
731 {
732         struct cpio_data cd = { NULL, 0, "" };
733         enum ucode_state ret;
734
735         /* try built-in microcode first */
736         if (load_builtin_intel_microcode(&cd))
737                 /*
738                  * Invalidate blobs as we might've gotten an initrd too,
739                  * supplied by the boot loader, by mistake or simply forgotten
740                  * there. That's fine, we ignore it since we've found builtin
741                  * microcode already.
742                  */
743                 blbp->valid = false;
744         else {
745                 ret = __scan_microcode_initrd(&cd, blbp);
746                 if (ret != UCODE_OK)
747                         return ret;
748         }
749
750         return get_matching_model_microcode(blbp->start, cd.data, cd.size,
751                                             mcs, mc_ptrs, uci);
752 }
753
754 static void __init
755 _load_ucode_intel_bsp(struct mc_saved_data *mcs, unsigned long *mc_ptrs,
756                       struct ucode_blobs *blbp)
757 {
758         struct ucode_cpu_info uci;
759         enum ucode_state ret;
760
761         collect_cpu_info_early(&uci);
762
763         ret = scan_microcode(mcs, mc_ptrs, &uci, blbp);
764         if (ret != UCODE_OK)
765                 return;
766
767         ret = load_microcode(mcs, mc_ptrs, blbp->start, &uci);
768         if (ret != UCODE_OK)
769                 return;
770
771         apply_microcode_early(&uci, true);
772 }
773
774 void __init load_ucode_intel_bsp(void)
775 {
776         struct ucode_blobs *blobs_p;
777         struct mc_saved_data *mcs;
778         unsigned long *ptrs;
779
780 #ifdef CONFIG_X86_32
781         mcs     = (struct mc_saved_data *)__pa_nodebug(&mc_saved_data);
782         ptrs    = (unsigned long *)__pa_nodebug(&mc_tmp_ptrs);
783         blobs_p = (struct ucode_blobs *)__pa_nodebug(&blobs);
784 #else
785         mcs     = &mc_saved_data;
786         ptrs    = mc_tmp_ptrs;
787         blobs_p = &blobs;
788 #endif
789
790         _load_ucode_intel_bsp(mcs, ptrs, blobs_p);
791 }
792
793 void load_ucode_intel_ap(void)
794 {
795         struct ucode_blobs *blobs_p;
796         struct mc_saved_data *mcs;
797         struct ucode_cpu_info uci;
798         enum ucode_state ret;
799         unsigned long *ptrs;
800
801 #ifdef CONFIG_X86_32
802         mcs     = (struct mc_saved_data *)__pa_nodebug(&mc_saved_data);
803         ptrs    = (unsigned long *)__pa_nodebug(mc_tmp_ptrs);
804         blobs_p = (struct ucode_blobs *)__pa_nodebug(&blobs);
805 #else
806         mcs     = &mc_saved_data;
807         ptrs    = mc_tmp_ptrs;
808         blobs_p = &blobs;
809 #endif
810
811         /*
812          * If there is no valid ucode previously saved in memory, no need to
813          * update ucode on this AP.
814          */
815         if (!mcs->num_saved)
816                 return;
817
818         collect_cpu_info_early(&uci);
819         ret = load_microcode(mcs, ptrs, blobs_p->start, &uci);
820         if (ret != UCODE_OK)
821                 return;
822
823         apply_microcode_early(&uci, true);
824 }
825
826 void reload_ucode_intel(void)
827 {
828         struct ucode_cpu_info uci;
829         enum ucode_state ret;
830
831         if (!mc_saved_data.num_saved)
832                 return;
833
834         collect_cpu_info_early(&uci);
835
836         ret = find_microcode_patch(mc_saved_data.mc_saved,
837                                    mc_saved_data.num_saved, &uci);
838         if (ret != UCODE_OK)
839                 return;
840
841         apply_microcode_early(&uci, false);
842 }
843
844 static int collect_cpu_info(int cpu_num, struct cpu_signature *csig)
845 {
846         struct cpuinfo_x86 *c = &cpu_data(cpu_num);
847         unsigned int val[2];
848
849         memset(csig, 0, sizeof(*csig));
850
851         csig->sig = cpuid_eax(0x00000001);
852
853         if ((c->x86_model >= 5) || (c->x86 > 6)) {
854                 /* get processor flags from MSR 0x17 */
855                 rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
856                 csig->pf = 1 << ((val[1] >> 18) & 7);
857         }
858
859         csig->rev = c->microcode;
860         pr_info("CPU%d sig=0x%x, pf=0x%x, revision=0x%x\n",
861                 cpu_num, csig->sig, csig->pf, csig->rev);
862
863         return 0;
864 }
865
866 /*
867  * return 0 - no update found
868  * return 1 - found update
869  */
870 static int get_matching_mc(struct microcode_intel *mc, int cpu)
871 {
872         struct cpu_signature cpu_sig;
873         unsigned int csig, cpf, crev;
874
875         collect_cpu_info(cpu, &cpu_sig);
876
877         csig = cpu_sig.sig;
878         cpf = cpu_sig.pf;
879         crev = cpu_sig.rev;
880
881         return has_newer_microcode(mc, csig, cpf, crev);
882 }
883
884 static int apply_microcode_intel(int cpu)
885 {
886         struct microcode_intel *mc;
887         struct ucode_cpu_info *uci;
888         struct cpuinfo_x86 *c;
889         unsigned int val[2];
890
891         /* We should bind the task to the CPU */
892         if (WARN_ON(raw_smp_processor_id() != cpu))
893                 return -1;
894
895         uci = ucode_cpu_info + cpu;
896         mc = uci->mc;
897         if (!mc)
898                 return 0;
899
900         /*
901          * Microcode on this CPU could be updated earlier. Only apply the
902          * microcode patch in mc when it is newer than the one on this
903          * CPU.
904          */
905         if (!get_matching_mc(mc, cpu))
906                 return 0;
907
908         /* write microcode via MSR 0x79 */
909         wrmsrl(MSR_IA32_UCODE_WRITE, (unsigned long)mc->bits);
910         wrmsrl(MSR_IA32_UCODE_REV, 0);
911
912         /* As documented in the SDM: Do a CPUID 1 here */
913         sync_core();
914
915         /* get the current revision from MSR 0x8B */
916         rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
917
918         if (val[1] != mc->hdr.rev) {
919                 pr_err("CPU%d update to revision 0x%x failed\n",
920                        cpu, mc->hdr.rev);
921                 return -1;
922         }
923
924         pr_info("CPU%d updated to revision 0x%x, date = %04x-%02x-%02x\n",
925                 cpu, val[1],
926                 mc->hdr.date & 0xffff,
927                 mc->hdr.date >> 24,
928                 (mc->hdr.date >> 16) & 0xff);
929
930         c = &cpu_data(cpu);
931
932         uci->cpu_sig.rev = val[1];
933         c->microcode = val[1];
934
935         return 0;
936 }
937
938 static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size,
939                                 int (*get_ucode_data)(void *, const void *, size_t))
940 {
941         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
942         u8 *ucode_ptr = data, *new_mc = NULL, *mc = NULL;
943         int new_rev = uci->cpu_sig.rev;
944         unsigned int leftover = size;
945         enum ucode_state state = UCODE_OK;
946         unsigned int curr_mc_size = 0;
947         unsigned int csig, cpf;
948
949         while (leftover) {
950                 struct microcode_header_intel mc_header;
951                 unsigned int mc_size;
952
953                 if (leftover < sizeof(mc_header)) {
954                         pr_err("error! Truncated header in microcode data file\n");
955                         break;
956                 }
957
958                 if (get_ucode_data(&mc_header, ucode_ptr, sizeof(mc_header)))
959                         break;
960
961                 mc_size = get_totalsize(&mc_header);
962                 if (!mc_size || mc_size > leftover) {
963                         pr_err("error! Bad data in microcode data file\n");
964                         break;
965                 }
966
967                 /* For performance reasons, reuse mc area when possible */
968                 if (!mc || mc_size > curr_mc_size) {
969                         vfree(mc);
970                         mc = vmalloc(mc_size);
971                         if (!mc)
972                                 break;
973                         curr_mc_size = mc_size;
974                 }
975
976                 if (get_ucode_data(mc, ucode_ptr, mc_size) ||
977                     microcode_sanity_check(mc, 1) < 0) {
978                         break;
979                 }
980
981                 csig = uci->cpu_sig.sig;
982                 cpf = uci->cpu_sig.pf;
983                 if (has_newer_microcode(mc, csig, cpf, new_rev)) {
984                         vfree(new_mc);
985                         new_rev = mc_header.rev;
986                         new_mc  = mc;
987                         mc = NULL;      /* trigger new vmalloc */
988                 }
989
990                 ucode_ptr += mc_size;
991                 leftover  -= mc_size;
992         }
993
994         vfree(mc);
995
996         if (leftover) {
997                 vfree(new_mc);
998                 state = UCODE_ERROR;
999                 goto out;
1000         }
1001
1002         if (!new_mc) {
1003                 state = UCODE_NFOUND;
1004                 goto out;
1005         }
1006
1007         vfree(uci->mc);
1008         uci->mc = (struct microcode_intel *)new_mc;
1009
1010         /*
1011          * If early loading microcode is supported, save this mc into
1012          * permanent memory. So it will be loaded early when a CPU is hot added
1013          * or resumes.
1014          */
1015         save_mc_for_early(new_mc);
1016
1017         pr_debug("CPU%d found a matching microcode update with version 0x%x (current=0x%x)\n",
1018                  cpu, new_rev, uci->cpu_sig.rev);
1019 out:
1020         return state;
1021 }
1022
1023 static int get_ucode_fw(void *to, const void *from, size_t n)
1024 {
1025         memcpy(to, from, n);
1026         return 0;
1027 }
1028
1029 static enum ucode_state request_microcode_fw(int cpu, struct device *device,
1030                                              bool refresh_fw)
1031 {
1032         char name[30];
1033         struct cpuinfo_x86 *c = &cpu_data(cpu);
1034         const struct firmware *firmware;
1035         enum ucode_state ret;
1036
1037         sprintf(name, "intel-ucode/%02x-%02x-%02x",
1038                 c->x86, c->x86_model, c->x86_mask);
1039
1040         if (request_firmware_direct(&firmware, name, device)) {
1041                 pr_debug("data file %s load failed\n", name);
1042                 return UCODE_NFOUND;
1043         }
1044
1045         ret = generic_load_microcode(cpu, (void *)firmware->data,
1046                                      firmware->size, &get_ucode_fw);
1047
1048         release_firmware(firmware);
1049
1050         return ret;
1051 }
1052
1053 static int get_ucode_user(void *to, const void *from, size_t n)
1054 {
1055         return copy_from_user(to, from, n);
1056 }
1057
1058 static enum ucode_state
1059 request_microcode_user(int cpu, const void __user *buf, size_t size)
1060 {
1061         return generic_load_microcode(cpu, (void *)buf, size, &get_ucode_user);
1062 }
1063
1064 static void microcode_fini_cpu(int cpu)
1065 {
1066         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
1067
1068         vfree(uci->mc);
1069         uci->mc = NULL;
1070 }
1071
1072 static struct microcode_ops microcode_intel_ops = {
1073         .request_microcode_user           = request_microcode_user,
1074         .request_microcode_fw             = request_microcode_fw,
1075         .collect_cpu_info                 = collect_cpu_info,
1076         .apply_microcode                  = apply_microcode_intel,
1077         .microcode_fini_cpu               = microcode_fini_cpu,
1078 };
1079
1080 struct microcode_ops * __init init_intel_microcode(void)
1081 {
1082         struct cpuinfo_x86 *c = &boot_cpu_data;
1083
1084         if (c->x86_vendor != X86_VENDOR_INTEL || c->x86 < 6 ||
1085             cpu_has(c, X86_FEATURE_IA64)) {
1086                 pr_err("Intel CPU family 0x%x not supported\n", c->x86);
1087                 return NULL;
1088         }
1089
1090         return &microcode_intel_ops;
1091 }
1092