[mirror_ubuntu-artful-kernel.git] / arch / x86 / include / asm / efi.h

#ifndef _ASM_X86_EFI_H
#define _ASM_X86_EFI_H

#include <asm/fpu/api.h>
#include <asm/pgtable.h>
#include <asm/tlb.h>

/*
 * We map the EFI regions needed for runtime services non-contiguously,
 * with preserved alignment on virtual addresses starting from -4G down
 * for a total max space of 64G. This way, we provide for stable runtime
 * services addresses across kernels so that a kexec'd kernel can still
 * use them.
 *
 * This is the main reason why we're doing stable VA mappings for RT
 * services.
 *
 * This flag is used in conjuction with a chicken bit called
 * "efi=old_map" which can be used as a fallback to the old runtime
 * services mapping method in case there's some b0rkage with a
 * particular EFI implementation (haha, it is hard to hold up the
 * sarcasm here...).
 */
#define EFI_OLD_MEMMAP		EFI_ARCH_1

#define EFI32_LOADER_SIGNATURE	"EL32"
#define EFI64_LOADER_SIGNATURE	"EL64"

#define MAX_CMDLINE_ADDRESS	UINT_MAX

#ifdef CONFIG_X86_32


extern unsigned long asmlinkage efi_call_phys(void *, ...);

/*
 * Wrap all the virtual calls in a way that forces the parameters on the stack.
 */

/* Use this macro if your virtual returns a non-void value */
#define efi_call_virt(f, args...) \
({									\
	efi_status_t __s;						\
	kernel_fpu_begin();						\
	__s = ((efi_##f##_t __attribute__((regparm(0)))*)		\
		efi.systab->runtime->f)(args);				\
	kernel_fpu_end();						\
	__s;								\
})

/* Use this macro if your virtual call does not return any value */
#define __efi_call_virt(f, args...) \
({									\
	kernel_fpu_begin();						\
	((efi_##f##_t __attribute__((regparm(0)))*)			\
		efi.systab->runtime->f)(args);				\
	kernel_fpu_end();						\
})

#define efi_ioremap(addr, size, type, attr)	ioremap_cache(addr, size)

#else /* !CONFIG_X86_32 */

#define EFI_LOADER_SIGNATURE	"EL64"

extern u64 asmlinkage efi_call(void *fp, ...);

#define efi_call_phys(f, args...)		efi_call((f), args)

/*
 * Scratch space used for switching the pagetable in the EFI stub
 */
struct efi_scratch {
	u64	r15;
	u64	prev_cr3;
	pgd_t	*efi_pgt;
	bool	use_pgd;
	u64	phys_stack;
} __packed;

#define efi_call_virt(f, ...)						\
({									\
	efi_status_t __s;						\
									\
	efi_sync_low_kernel_mappings();					\
	preempt_disable();						\
	__kernel_fpu_begin();						\
									\
	if (efi_scratch.use_pgd) {					\
		efi_scratch.prev_cr3 = read_cr3();			\
		write_cr3((unsigned long)efi_scratch.efi_pgt);		\
		__flush_tlb_all();					\
	}								\
									\
	__s = efi_call((void *)efi.systab->runtime->f, __VA_ARGS__);	\
									\
	if (efi_scratch.use_pgd) {					\
		write_cr3(efi_scratch.prev_cr3);			\
		__flush_tlb_all();					\
	}								\
									\
	__kernel_fpu_end();						\
	preempt_enable();						\
	__s;								\
})

/*
 * All X86_64 virt calls return non-void values. Thus, use non-void call for
 * virt calls that would be void on X86_32.
 */
#define __efi_call_virt(f, args...) efi_call_virt(f, args)

extern void __iomem *__init efi_ioremap(unsigned long addr, unsigned long size,
					u32 type, u64 attribute);

#ifdef CONFIG_KASAN
/*
 * CONFIG_KASAN may redefine memset to __memset.  __memset function is present
 * only in kernel binary.  Since the EFI stub linked into a separate binary it
 * doesn't have __memset().  So we should use standard memset from
 * arch/x86/boot/compressed/string.c.  The same applies to memcpy and memmove.
 */
#undef memcpy
#undef memset
#undef memmove
#endif

#endif /* CONFIG_X86_32 */

extern struct efi_scratch efi_scratch;
extern void __init efi_set_executable(efi_memory_desc_t *md, bool executable);
extern int __init efi_memblock_x86_reserve_range(void);
extern pgd_t * __init efi_call_phys_prolog(void);
extern void __init efi_call_phys_epilog(pgd_t *save_pgd);
extern void __init efi_print_memmap(void);
extern void __init efi_unmap_memmap(void);
extern void __init efi_memory_uc(u64 addr, unsigned long size);
extern void __init efi_map_region(efi_memory_desc_t *md);
extern void __init efi_map_region_fixed(efi_memory_desc_t *md);
extern void efi_sync_low_kernel_mappings(void);
extern int __init efi_alloc_page_tables(void);
extern int __init efi_setup_page_tables(unsigned long pa_memmap, unsigned num_pages);
extern void __init efi_cleanup_page_tables(unsigned long pa_memmap, unsigned num_pages);
extern void __init old_map_region(efi_memory_desc_t *md);
extern void __init runtime_code_page_mkexec(void);
extern void __init efi_runtime_update_mappings(void);
extern void __init efi_dump_pagetable(void);
extern void __init efi_apply_memmap_quirks(void);
extern int __init efi_reuse_config(u64 tables, int nr_tables);
extern void efi_delete_dummy_variable(void);

struct efi_setup_data {
	u64 fw_vendor;
	u64 runtime;
	u64 tables;
	u64 smbios;
	u64 reserved[8];
};

extern u64 efi_setup;

#ifdef CONFIG_EFI

static inline bool efi_is_native(void)
{
	return IS_ENABLED(CONFIG_X86_64) == efi_enabled(EFI_64BIT);
}

static inline bool efi_runtime_supported(void)
{
	if (efi_is_native())
		return true;

	if (IS_ENABLED(CONFIG_EFI_MIXED) && !efi_enabled(EFI_OLD_MEMMAP))
		return true;

	return false;
}

extern struct console early_efi_console;
extern void parse_efi_setup(u64 phys_addr, u32 data_len);

extern void efifb_setup_from_dmi(struct screen_info *si, const char *opt);

#ifdef CONFIG_EFI_MIXED
extern void efi_thunk_runtime_setup(void);
extern efi_status_t efi_thunk_set_virtual_address_map(
	void *phys_set_virtual_address_map,
	unsigned long memory_map_size,
	unsigned long descriptor_size,
	u32 descriptor_version,
	efi_memory_desc_t *virtual_map);
#else
static inline void efi_thunk_runtime_setup(void) {}
static inline efi_status_t efi_thunk_set_virtual_address_map(
	void *phys_set_virtual_address_map,
	unsigned long memory_map_size,
	unsigned long descriptor_size,
	u32 descriptor_version,
	efi_memory_desc_t *virtual_map)
{
	return EFI_SUCCESS;
}
#endif /* CONFIG_EFI_MIXED */


/* arch specific definitions used by the stub code */

struct efi_config {
	u64 image_handle;
	u64 table;
	u64 allocate_pool;
	u64 allocate_pages;
	u64 get_memory_map;
	u64 free_pool;
	u64 free_pages;
	u64 locate_handle;
	u64 handle_protocol;
	u64 exit_boot_services;
	u64 text_output;
	efi_status_t (*call)(unsigned long, ...);
	bool is64;
} __packed;

__pure const struct efi_config *__efi_early(void);

#define efi_call_early(f, ...)						\
	__efi_early()->call(__efi_early()->f, __VA_ARGS__);

#define __efi_call_early(f, ...)					\
	__efi_early()->call((unsigned long)f, __VA_ARGS__);

#define efi_is_64bit()		__efi_early()->is64

extern bool efi_reboot_required(void);

#else
static inline void parse_efi_setup(u64 phys_addr, u32 data_len) {}
static inline bool efi_reboot_required(void)
{
	return false;
}
#endif /* CONFIG_EFI */

#endif /* _ASM_X86_EFI_H */
Commit	Line	Data
1965aae3 PA	1	#ifndef _ASM_X86_EFI_H
1965aae3 PA	2	#define _ASM_X86_EFI_H
5b83683f	3
df6b35f4	4	#include <asm/fpu/api.h>
744937b0	5	#include <asm/pgtable.h>
c9f2a9a6	6	#include <asm/tlb.h>
744937b0	7
d2f7cbe7 BP	8	/*
	9	* We map the EFI regions needed for runtime services non-contiguously,
	10	* with preserved alignment on virtual addresses starting from -4G down
	11	* for a total max space of 64G. This way, we provide for stable runtime
	12	* services addresses across kernels so that a kexec'd kernel can still
	13	* use them.
	14	*
	15	* This is the main reason why we're doing stable VA mappings for RT
	16	* services.
	17	*
	18	* This flag is used in conjuction with a chicken bit called
	19	* "efi=old_map" which can be used as a fallback to the old runtime
	20	* services mapping method in case there's some b0rkage with a
	21	* particular EFI implementation (haha, it is hard to hold up the
	22	* sarcasm here...).
	23	*/
	24	#define EFI_OLD_MEMMAP EFI_ARCH_1
	25
b8ff87a6 MF	26	#define EFI32_LOADER_SIGNATURE "EL32"
	27	#define EFI64_LOADER_SIGNATURE "EL64"
	28
48fcb2d0 AB	29	#define MAX_CMDLINE_ADDRESS UINT_MAX
48fcb2d0 AB	30
5b83683f	31	#ifdef CONFIG_X86_32
e429795c	32
f7d7d01b	33
e429795c HY	34	extern unsigned long asmlinkage efi_call_phys(void *, ...);
e429795c HY	35
e429795c HY	36	/*
	37	* Wrap all the virtual calls in a way that forces the parameters on the stack.
	38	*/
	39
982e239c	40	/* Use this macro if your virtual returns a non-void value */
e429795c	41	#define efi_call_virt(f, args...) \
b738c6ea RN	42	({ \
	43	efi_status_t __s; \
	44	kernel_fpu_begin(); \
	45	__s = ((efi_##f##_t __attribute__((regparm(0)))*) \
	46	efi.systab->runtime->f)(args); \
	47	kernel_fpu_end(); \
	48	__s; \
	49	})
e429795c	50
982e239c	51	/* Use this macro if your virtual call does not return any value */
b738c6ea RN	52	#define __efi_call_virt(f, args...) \
	53	({ \
	54	kernel_fpu_begin(); \
	55	((efi_##f##_t __attribute__((regparm(0)))*) \
	56	efi.systab->runtime->f)(args); \
	57	kernel_fpu_end(); \
	58	})
982e239c	59
3e8fa263	60	#define efi_ioremap(addr, size, type, attr) ioremap_cache(addr, size)
e1ad783b	61
5b83683f HY	62	#else /* !CONFIG_X86_32 */
5b83683f HY	63
62fa6e69 MF	64	#define EFI_LOADER_SIGNATURE "EL64"
	65
	66	extern u64 asmlinkage efi_call(void *fp, ...);
	67
	68	#define efi_call_phys(f, args...) efi_call((f), args)
	69
c9f2a9a6 MF	70	/*
	71	* Scratch space used for switching the pagetable in the EFI stub
	72	*/
	73	struct efi_scratch {
	74	u64 r15;
	75	u64 prev_cr3;
	76	pgd_t *efi_pgt;
	77	bool use_pgd;
	78	u64 phys_stack;
	79	} __packed;
	80
62fa6e69	81	#define efi_call_virt(f, ...) \
d2f7cbe7 BP	82	({ \
	83	efi_status_t __s; \
	84	\
	85	efi_sync_low_kernel_mappings(); \
	86	preempt_disable(); \
de05764e	87	__kernel_fpu_begin(); \
c9f2a9a6 MF	88	\
	89	if (efi_scratch.use_pgd) { \
	90	efi_scratch.prev_cr3 = read_cr3(); \
	91	write_cr3((unsigned long)efi_scratch.efi_pgt); \
	92	__flush_tlb_all(); \
	93	} \
	94	\
62fa6e69	95	__s = efi_call((void *)efi.systab->runtime->f, __VA_ARGS__); \
c9f2a9a6 MF	96	\
	97	if (efi_scratch.use_pgd) { \
	98	write_cr3(efi_scratch.prev_cr3); \
	99	__flush_tlb_all(); \
	100	} \
	101	\
de05764e	102	__kernel_fpu_end(); \
d2f7cbe7 BP	103	preempt_enable(); \
	104	__s; \
	105	})
	106
982e239c RN	107	/*
	108	* All X86_64 virt calls return non-void values. Thus, use non-void call for
	109	* virt calls that would be void on X86_32.
	110	*/
	111	#define __efi_call_virt(f, args...) efi_call_virt(f, args)
	112
4e78eb05 MK	113	extern void __iomem *__init efi_ioremap(unsigned long addr, unsigned long size,
4e78eb05 MK	114	u32 type, u64 attribute);
e1ad783b	115
a523841e	116	#ifdef CONFIG_KASAN
769a8089 AR	117	/*
	118	* CONFIG_KASAN may redefine memset to __memset. __memset function is present
	119	* only in kernel binary. Since the EFI stub linked into a separate binary it
	120	* doesn't have __memset(). So we should use standard memset from
	121	* arch/x86/boot/compressed/string.c. The same applies to memcpy and memmove.
	122	*/
	123	#undef memcpy
	124	#undef memset
	125	#undef memmove
a523841e	126	#endif
769a8089	127
5b83683f HY	128	#endif /* CONFIG_X86_32 */
5b83683f HY	129
d2f7cbe7	130	extern struct efi_scratch efi_scratch;
4e78eb05 MK	131	extern void __init efi_set_executable(efi_memory_desc_t *md, bool executable);
4e78eb05 MK	132	extern int __init efi_memblock_x86_reserve_range(void);
744937b0 IM	133	extern pgd_t * __init efi_call_phys_prolog(void);
744937b0 IM	134	extern void __init efi_call_phys_epilog(pgd_t *save_pgd);
0bbea1ce	135	extern void __init efi_print_memmap(void);
4e78eb05 MK	136	extern void __init efi_unmap_memmap(void);
4e78eb05 MK	137	extern void __init efi_memory_uc(u64 addr, unsigned long size);
d2f7cbe7	138	extern void __init efi_map_region(efi_memory_desc_t *md);
3b266496	139	extern void __init efi_map_region_fixed(efi_memory_desc_t *md);
d2f7cbe7	140	extern void efi_sync_low_kernel_mappings(void);
67a9108e	141	extern int __init efi_alloc_page_tables(void);
4e78eb05 MK	142	extern int __init efi_setup_page_tables(unsigned long pa_memmap, unsigned num_pages);
4e78eb05 MK	143	extern void __init efi_cleanup_page_tables(unsigned long pa_memmap, unsigned num_pages);
d2f7cbe7	144	extern void __init old_map_region(efi_memory_desc_t *md);
c55d016f	145	extern void __init runtime_code_page_mkexec(void);
6d0cc887	146	extern void __init efi_runtime_update_mappings(void);
11cc8512	147	extern void __init efi_dump_pagetable(void);
a5d90c92	148	extern void __init efi_apply_memmap_quirks(void);
eeb9db09 ST	149	extern int __init efi_reuse_config(u64 tables, int nr_tables);
eeb9db09 ST	150	extern void efi_delete_dummy_variable(void);
5b83683f	151
1fec0533 DY	152	struct efi_setup_data {
	153	u64 fw_vendor;
	154	u64 runtime;
	155	u64 tables;
	156	u64 smbios;
	157	u64 reserved[8];
	158	};
	159
	160	extern u64 efi_setup;
1fec0533	161
6b59e366 ST	162	#ifdef CONFIG_EFI
	163
	164	static inline bool efi_is_native(void)
	165	{
	166	return IS_ENABLED(CONFIG_X86_64) == efi_enabled(EFI_64BIT);
	167	}
	168
7d453eee MF	169	static inline bool efi_runtime_supported(void)
	170	{
	171	if (efi_is_native())
	172	return true;
	173
	174	if (IS_ENABLED(CONFIG_EFI_MIXED) && !efi_enabled(EFI_OLD_MEMMAP))
	175	return true;
	176
	177	return false;
	178	}
	179
72548e83	180	extern struct console early_efi_console;
5c12af0c	181	extern void parse_efi_setup(u64 phys_addr, u32 data_len);
4f9dbcfc	182
21289ec0 AB	183	extern void efifb_setup_from_dmi(struct screen_info si, const char opt);
21289ec0 AB	184
4f9dbcfc MF	185	#ifdef CONFIG_EFI_MIXED
	186	extern void efi_thunk_runtime_setup(void);
	187	extern efi_status_t efi_thunk_set_virtual_address_map(
	188	void *phys_set_virtual_address_map,
	189	unsigned long memory_map_size,
	190	unsigned long descriptor_size,
	191	u32 descriptor_version,
	192	efi_memory_desc_t *virtual_map);
	193	#else
	194	static inline void efi_thunk_runtime_setup(void) {}
	195	static inline efi_status_t efi_thunk_set_virtual_address_map(
	196	void *phys_set_virtual_address_map,
	197	unsigned long memory_map_size,
	198	unsigned long descriptor_size,
	199	u32 descriptor_version,
	200	efi_memory_desc_t *virtual_map)
	201	{
	202	return EFI_SUCCESS;
	203	}
	204	#endif /* CONFIG_EFI_MIXED */
f23cf8bd	205
243b6754 AB	206
	207	/* arch specific definitions used by the stub code */
	208
	209	struct efi_config {
	210	u64 image_handle;
	211	u64 table;
	212	u64 allocate_pool;
	213	u64 allocate_pages;
	214	u64 get_memory_map;
	215	u64 free_pool;
	216	u64 free_pages;
	217	u64 locate_handle;
	218	u64 handle_protocol;
	219	u64 exit_boot_services;
	220	u64 text_output;
	221	efi_status_t (*call)(unsigned long, ...);
	222	bool is64;
	223	} __packed;
	224
	225	__pure const struct efi_config *__efi_early(void);
	226
	227	#define efi_call_early(f, ...) \
	228	__efi_early()->call(__efi_early()->f, __VA_ARGS__);
	229
2c23b73c AB	230	#define __efi_call_early(f, ...) \
	231	__efi_early()->call((unsigned long)f, __VA_ARGS__);
	232
	233	#define efi_is_64bit() __efi_early()->is64
	234
44be28e9 MF	235	extern bool efi_reboot_required(void);
44be28e9 MF	236
6b59e366	237	#else
5c12af0c	238	static inline void parse_efi_setup(u64 phys_addr, u32 data_len) {}
44be28e9 MF	239	static inline bool efi_reboot_required(void)
	240	{
	241	return false;
	242	}
7f594232 RA	243	#endif /* CONFIG_EFI */
7f594232 RA	244
1965aae3	245	#endif /* _ASM_X86_EFI_H */