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