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