xref: /openbmc/linux/arch/x86/include/asm/microcode.h (revision fe055896c040df571e4ff56fb196d6845130057b)
11965aae3SH. Peter Anvin #ifndef _ASM_X86_MICROCODE_H
21965aae3SH. Peter Anvin #define _ASM_X86_MICROCODE_H
3bb898558SAl Viro 
4760d765bSBorislav Petkov #include <linux/earlycpio.h>
5760d765bSBorislav Petkov 
6e1b43e3fSBorislav Petkov #define native_rdmsr(msr, val1, val2)			\
7e1b43e3fSBorislav Petkov do {							\
8e1b43e3fSBorislav Petkov 	u64 __val = native_read_msr((msr));		\
9e1b43e3fSBorislav Petkov 	(void)((val1) = (u32)__val);			\
10e1b43e3fSBorislav Petkov 	(void)((val2) = (u32)(__val >> 32));		\
11e1b43e3fSBorislav Petkov } while (0)
12e1b43e3fSBorislav Petkov 
13e1b43e3fSBorislav Petkov #define native_wrmsr(msr, low, high)			\
14e1b43e3fSBorislav Petkov 	native_write_msr(msr, low, high)
15e1b43e3fSBorislav Petkov 
16e1b43e3fSBorislav Petkov #define native_wrmsrl(msr, val)				\
17e1b43e3fSBorislav Petkov 	native_write_msr((msr),				\
18e1b43e3fSBorislav Petkov 			 (u32)((u64)(val)),		\
19e1b43e3fSBorislav Petkov 			 (u32)((u64)(val) >> 32))
20e1b43e3fSBorislav Petkov 
21bb898558SAl Viro struct cpu_signature {
22bb898558SAl Viro 	unsigned int sig;
23bb898558SAl Viro 	unsigned int pf;
24bb898558SAl Viro 	unsigned int rev;
25bb898558SAl Viro };
26bb898558SAl Viro 
27bb898558SAl Viro struct device;
28bb898558SAl Viro 
29871b72ddSDmitry Adamushko enum ucode_state { UCODE_ERROR, UCODE_OK, UCODE_NFOUND };
3065cef131SBorislav Petkov extern bool dis_ucode_ldr;
31871b72ddSDmitry Adamushko 
32bb898558SAl Viro struct microcode_ops {
33871b72ddSDmitry Adamushko 	enum ucode_state (*request_microcode_user) (int cpu,
34871b72ddSDmitry Adamushko 				const void __user *buf, size_t size);
35bb898558SAl Viro 
3648e30685SBorislav Petkov 	enum ucode_state (*request_microcode_fw) (int cpu, struct device *,
3748e30685SBorislav Petkov 						  bool refresh_fw);
38bb898558SAl Viro 
39bb898558SAl Viro 	void (*microcode_fini_cpu) (int cpu);
40871b72ddSDmitry Adamushko 
41871b72ddSDmitry Adamushko 	/*
42871b72ddSDmitry Adamushko 	 * The generic 'microcode_core' part guarantees that
43871b72ddSDmitry Adamushko 	 * the callbacks below run on a target cpu when they
44871b72ddSDmitry Adamushko 	 * are being called.
45871b72ddSDmitry Adamushko 	 * See also the "Synchronization" section in microcode_core.c.
46871b72ddSDmitry Adamushko 	 */
47871b72ddSDmitry Adamushko 	int (*apply_microcode) (int cpu);
48871b72ddSDmitry Adamushko 	int (*collect_cpu_info) (int cpu, struct cpu_signature *csig);
49bb898558SAl Viro };
50bb898558SAl Viro 
51bb898558SAl Viro struct ucode_cpu_info {
52bb898558SAl Viro 	struct cpu_signature	cpu_sig;
53bb898558SAl Viro 	int			valid;
54bb898558SAl Viro 	void			*mc;
55bb898558SAl Viro };
56bb898558SAl Viro extern struct ucode_cpu_info ucode_cpu_info[];
57bb898558SAl Viro 
589a2bc335SBorislav Petkov #ifdef CONFIG_MICROCODE
599a2bc335SBorislav Petkov int __init microcode_init(void);
609a2bc335SBorislav Petkov #else
619a2bc335SBorislav Petkov static inline int __init microcode_init(void)	{ return 0; };
629a2bc335SBorislav Petkov #endif
639a2bc335SBorislav Petkov 
64bb898558SAl Viro #ifdef CONFIG_MICROCODE_INTEL
65bb898558SAl Viro extern struct microcode_ops * __init init_intel_microcode(void);
66bb898558SAl Viro #else
67bb898558SAl Viro static inline struct microcode_ops * __init init_intel_microcode(void)
68bb898558SAl Viro {
69bb898558SAl Viro 	return NULL;
70bb898558SAl Viro }
71bb898558SAl Viro #endif /* CONFIG_MICROCODE_INTEL */
72bb898558SAl Viro 
73bb898558SAl Viro #ifdef CONFIG_MICROCODE_AMD
74bb898558SAl Viro extern struct microcode_ops * __init init_amd_microcode(void);
75f72c1a57SBorislav Petkov extern void __exit exit_amd_microcode(void);
76bb898558SAl Viro #else
77bb898558SAl Viro static inline struct microcode_ops * __init init_amd_microcode(void)
78bb898558SAl Viro {
79bb898558SAl Viro 	return NULL;
80bb898558SAl Viro }
81f72c1a57SBorislav Petkov static inline void __exit exit_amd_microcode(void) {}
82bb898558SAl Viro #endif
83bb898558SAl Viro 
84a8ebf6d1SFenghua Yu #define MAX_UCODE_COUNT 128
8558ce8d6dSBorislav Petkov 
8658ce8d6dSBorislav Petkov #define QCHAR(a, b, c, d) ((a) + ((b) << 8) + ((c) << 16) + ((d) << 24))
8758ce8d6dSBorislav Petkov #define CPUID_INTEL1 QCHAR('G', 'e', 'n', 'u')
8858ce8d6dSBorislav Petkov #define CPUID_INTEL2 QCHAR('i', 'n', 'e', 'I')
8958ce8d6dSBorislav Petkov #define CPUID_INTEL3 QCHAR('n', 't', 'e', 'l')
9058ce8d6dSBorislav Petkov #define CPUID_AMD1 QCHAR('A', 'u', 't', 'h')
9158ce8d6dSBorislav Petkov #define CPUID_AMD2 QCHAR('e', 'n', 't', 'i')
9258ce8d6dSBorislav Petkov #define CPUID_AMD3 QCHAR('c', 'A', 'M', 'D')
9358ce8d6dSBorislav Petkov 
9458ce8d6dSBorislav Petkov #define CPUID_IS(a, b, c, ebx, ecx, edx)	\
9558ce8d6dSBorislav Petkov 		(!((ebx ^ (a))|(edx ^ (b))|(ecx ^ (c))))
9658ce8d6dSBorislav Petkov 
9758ce8d6dSBorislav Petkov /*
9858ce8d6dSBorislav Petkov  * In early loading microcode phase on BSP, boot_cpu_data is not set up yet.
9958ce8d6dSBorislav Petkov  * x86_vendor() gets vendor id for BSP.
10058ce8d6dSBorislav Petkov  *
10158ce8d6dSBorislav Petkov  * In 32 bit AP case, accessing boot_cpu_data needs linear address. To simplify
10258ce8d6dSBorislav Petkov  * coding, we still use x86_vendor() to get vendor id for AP.
10358ce8d6dSBorislav Petkov  *
10458ce8d6dSBorislav Petkov  * x86_vendor() gets vendor information directly from CPUID.
10558ce8d6dSBorislav Petkov  */
10658ce8d6dSBorislav Petkov static inline int x86_vendor(void)
10758ce8d6dSBorislav Petkov {
10858ce8d6dSBorislav Petkov 	u32 eax = 0x00000000;
10958ce8d6dSBorislav Petkov 	u32 ebx, ecx = 0, edx;
11058ce8d6dSBorislav Petkov 
11158ce8d6dSBorislav Petkov 	native_cpuid(&eax, &ebx, &ecx, &edx);
11258ce8d6dSBorislav Petkov 
11358ce8d6dSBorislav Petkov 	if (CPUID_IS(CPUID_INTEL1, CPUID_INTEL2, CPUID_INTEL3, ebx, ecx, edx))
11458ce8d6dSBorislav Petkov 		return X86_VENDOR_INTEL;
11558ce8d6dSBorislav Petkov 
11658ce8d6dSBorislav Petkov 	if (CPUID_IS(CPUID_AMD1, CPUID_AMD2, CPUID_AMD3, ebx, ecx, edx))
11758ce8d6dSBorislav Petkov 		return X86_VENDOR_AMD;
11858ce8d6dSBorislav Petkov 
11958ce8d6dSBorislav Petkov 	return X86_VENDOR_UNKNOWN;
12058ce8d6dSBorislav Petkov }
12158ce8d6dSBorislav Petkov 
12258ce8d6dSBorislav Petkov static inline unsigned int __x86_family(unsigned int sig)
12358ce8d6dSBorislav Petkov {
12458ce8d6dSBorislav Petkov 	unsigned int x86;
12558ce8d6dSBorislav Petkov 
12658ce8d6dSBorislav Petkov 	x86 = (sig >> 8) & 0xf;
12758ce8d6dSBorislav Petkov 
12858ce8d6dSBorislav Petkov 	if (x86 == 0xf)
12958ce8d6dSBorislav Petkov 		x86 += (sig >> 20) & 0xff;
13058ce8d6dSBorislav Petkov 
13158ce8d6dSBorislav Petkov 	return x86;
13258ce8d6dSBorislav Petkov }
13358ce8d6dSBorislav Petkov 
13458ce8d6dSBorislav Petkov static inline unsigned int x86_family(void)
13558ce8d6dSBorislav Petkov {
13658ce8d6dSBorislav Petkov 	u32 eax = 0x00000001;
13758ce8d6dSBorislav Petkov 	u32 ebx, ecx = 0, edx;
13858ce8d6dSBorislav Petkov 
13958ce8d6dSBorislav Petkov 	native_cpuid(&eax, &ebx, &ecx, &edx);
14058ce8d6dSBorislav Petkov 
14158ce8d6dSBorislav Petkov 	return __x86_family(eax);
14258ce8d6dSBorislav Petkov }
14358ce8d6dSBorislav Petkov 
14458ce8d6dSBorislav Petkov static inline unsigned int x86_model(unsigned int sig)
14558ce8d6dSBorislav Petkov {
14658ce8d6dSBorislav Petkov 	unsigned int x86, model;
14758ce8d6dSBorislav Petkov 
14858ce8d6dSBorislav Petkov 	x86 = __x86_family(sig);
14958ce8d6dSBorislav Petkov 
15058ce8d6dSBorislav Petkov 	model = (sig >> 4) & 0xf;
15158ce8d6dSBorislav Petkov 
15258ce8d6dSBorislav Petkov 	if (x86 == 0x6 || x86 == 0xf)
15358ce8d6dSBorislav Petkov 		model += ((sig >> 16) & 0xf) << 4;
15458ce8d6dSBorislav Petkov 
15558ce8d6dSBorislav Petkov 	return model;
15658ce8d6dSBorislav Petkov }
15758ce8d6dSBorislav Petkov 
158*fe055896SBorislav Petkov #ifdef CONFIG_MICROCODE
159a8ebf6d1SFenghua Yu extern void __init load_ucode_bsp(void);
160148f9bb8SPaul Gortmaker extern void load_ucode_ap(void);
161a8ebf6d1SFenghua Yu extern int __init save_microcode_in_initrd(void);
162fbae4ba8SBorislav Petkov void reload_early_microcode(void);
163760d765bSBorislav Petkov extern bool get_builtin_firmware(struct cpio_data *cd, const char *name);
164a8ebf6d1SFenghua Yu #else
165a8ebf6d1SFenghua Yu static inline void __init load_ucode_bsp(void)			{ }
166148f9bb8SPaul Gortmaker static inline void load_ucode_ap(void)				{ }
167*fe055896SBorislav Petkov static inline int __init save_microcode_in_initrd(void)		{ return 0; }
168fbae4ba8SBorislav Petkov static inline void reload_early_microcode(void)			{ }
169*fe055896SBorislav Petkov static inline bool
170*fe055896SBorislav Petkov get_builtin_firmware(struct cpio_data *cd, const char *name)	{ return false; }
171a8ebf6d1SFenghua Yu #endif
1721965aae3SH. Peter Anvin #endif /* _ASM_X86_MICROCODE_H */
173