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