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