x86/include/asm/microcode.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _ASM_X86_MICROCODE_H
   3 #define _ASM_X86_MICROCODE_H
   4
   5 #include <asm/cpu.h>
   6 #include <linux/earlycpio.h>
   7 #include <linux/initrd.h>
   8 #include <asm/microcode_amd.h>
   9
  10 struct ucode_patch {
  11         struct list_head plist;
  12         void *data;             /* Intel uses only this one */
  13         unsigned int size;
  14         u32 patch_id;
  15         u16 equiv_cpu;
  16 };
  17
  18 extern struct list_head microcode_cache;
  19
  20 struct cpu_signature {
  21         unsigned int sig;
  22         unsigned int pf;
  23         unsigned int rev;
  24 };
  25
  26 struct device;
  27
  28 enum ucode_state {
  29         UCODE_OK        = 0,
  30         UCODE_NEW,
  31         UCODE_UPDATED,
  32         UCODE_NFOUND,
  33         UCODE_ERROR,
  34 };
  35
  36 struct microcode_ops {
  37         enum ucode_state (*request_microcode_fw) (int cpu, struct device *,
  38                                                   bool refresh_fw);
  39
  40         void (*microcode_fini_cpu) (int cpu);
  41
  42         /*
  43          * The generic 'microcode_core' part guarantees that
  44          * the callbacks below run on a target cpu when they
  45          * are being called.
  46          * See also the "Synchronization" section in microcode_core.c.
  47          */
  48         enum ucode_state (*apply_microcode) (int cpu);
  49         int (*collect_cpu_info) (int cpu, struct cpu_signature *csig);
  50 };
  51
  52 struct ucode_cpu_info {
  53         struct cpu_signature    cpu_sig;
  54         int                     valid;
  55         void                    *mc;
  56 };
  57 extern struct ucode_cpu_info ucode_cpu_info[];
  58 struct cpio_data find_microcode_in_initrd(const char *path, bool use_pa);
  59
  60 #ifdef CONFIG_MICROCODE_INTEL
  61 extern struct microcode_ops * __init init_intel_microcode(void);
  62 #else
  63 static inline struct microcode_ops * __init init_intel_microcode(void)
  64 {
  65         return NULL;
  66 }
  67 #endif /* CONFIG_MICROCODE_INTEL */
  68
  69 #ifdef CONFIG_MICROCODE_AMD
  70 extern struct microcode_ops * __init init_amd_microcode(void);
  71 extern void __exit exit_amd_microcode(void);
  72 #else
  73 static inline struct microcode_ops * __init init_amd_microcode(void)
  74 {
  75         return NULL;
  76 }
  77 static inline void __exit exit_amd_microcode(void) {}
  78 #endif
  79
  80 #define MAX_UCODE_COUNT 128
  81
  82 #define QCHAR(a, b, c, d) ((a) + ((b) << 8) + ((c) << 16) + ((d) << 24))
  83 #define CPUID_INTEL1 QCHAR('G', 'e', 'n', 'u')
  84 #define CPUID_INTEL2 QCHAR('i', 'n', 'e', 'I')
  85 #define CPUID_INTEL3 QCHAR('n', 't', 'e', 'l')
  86 #define CPUID_AMD1 QCHAR('A', 'u', 't', 'h')
  87 #define CPUID_AMD2 QCHAR('e', 'n', 't', 'i')
  88 #define CPUID_AMD3 QCHAR('c', 'A', 'M', 'D')
  89
  90 #define CPUID_IS(a, b, c, ebx, ecx, edx)        \
  91                 (!((ebx ^ (a))|(edx ^ (b))|(ecx ^ (c))))
  92
  93 /*
  94  * In early loading microcode phase on BSP, boot_cpu_data is not set up yet.
  95  * x86_cpuid_vendor() gets vendor id for BSP.
  96  *
  97  * In 32 bit AP case, accessing boot_cpu_data needs linear address. To simplify
  98  * coding, we still use x86_cpuid_vendor() to get vendor id for AP.
  99  *
 100  * x86_cpuid_vendor() gets vendor information directly from CPUID.
 101  */
 102 static inline int x86_cpuid_vendor(void)
 103 {
 104         u32 eax = 0x00000000;
 105         u32 ebx, ecx = 0, edx;
 106
 107         native_cpuid(&eax, &ebx, &ecx, &edx);
 108
 109         if (CPUID_IS(CPUID_INTEL1, CPUID_INTEL2, CPUID_INTEL3, ebx, ecx, edx))
 110                 return X86_VENDOR_INTEL;
 111
 112         if (CPUID_IS(CPUID_AMD1, CPUID_AMD2, CPUID_AMD3, ebx, ecx, edx))
 113                 return X86_VENDOR_AMD;
 114
 115         return X86_VENDOR_UNKNOWN;
 116 }
 117
 118 static inline unsigned int x86_cpuid_family(void)
 119 {
 120         u32 eax = 0x00000001;
 121         u32 ebx, ecx = 0, edx;
 122
 123         native_cpuid(&eax, &ebx, &ecx, &edx);
 124
 125         return x86_family(eax);
 126 }
 127
 128 #ifdef CONFIG_MICROCODE
 129 extern void __init load_ucode_bsp(void);
 130 extern void load_ucode_ap(void);
 131 void reload_early_microcode(unsigned int cpu);
 132 extern bool initrd_gone;
 133 void microcode_bsp_resume(void);
 134 #else
 135 static inline void __init load_ucode_bsp(void)                  { }
 136 static inline void load_ucode_ap(void)                          { }
 137 static inline void reload_early_microcode(unsigned int cpu)     { }
 138 static inline void microcode_bsp_resume(void)                   { }
 139 #endif
 140
 141 #endif /* _ASM_X86_MICROCODE_H */