xref: /openbmc/linux/include/linux/efi.h (revision 6a87e0f0ce1ae8d70566935215430e718ea776ff)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_EFI_H
3 #define _LINUX_EFI_H
4 
5 /*
6  * Extensible Firmware Interface
7  * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
8  *
9  * Copyright (C) 1999 VA Linux Systems
10  * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
11  * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
12  *	David Mosberger-Tang <davidm@hpl.hp.com>
13  *	Stephane Eranian <eranian@hpl.hp.com>
14  */
15 #include <linux/init.h>
16 #include <linux/string.h>
17 #include <linux/time.h>
18 #include <linux/types.h>
19 #include <linux/proc_fs.h>
20 #include <linux/rtc.h>
21 #include <linux/ioport.h>
22 #include <linux/pfn.h>
23 #include <linux/pstore.h>
24 #include <linux/range.h>
25 #include <linux/reboot.h>
26 #include <linux/uuid.h>
27 #include <linux/screen_info.h>
28 
29 #include <asm/page.h>
30 
31 #define EFI_SUCCESS		0
32 #define EFI_LOAD_ERROR		( 1 | (1UL << (BITS_PER_LONG-1)))
33 #define EFI_INVALID_PARAMETER	( 2 | (1UL << (BITS_PER_LONG-1)))
34 #define EFI_UNSUPPORTED		( 3 | (1UL << (BITS_PER_LONG-1)))
35 #define EFI_BAD_BUFFER_SIZE	( 4 | (1UL << (BITS_PER_LONG-1)))
36 #define EFI_BUFFER_TOO_SMALL	( 5 | (1UL << (BITS_PER_LONG-1)))
37 #define EFI_NOT_READY		( 6 | (1UL << (BITS_PER_LONG-1)))
38 #define EFI_DEVICE_ERROR	( 7 | (1UL << (BITS_PER_LONG-1)))
39 #define EFI_WRITE_PROTECTED	( 8 | (1UL << (BITS_PER_LONG-1)))
40 #define EFI_OUT_OF_RESOURCES	( 9 | (1UL << (BITS_PER_LONG-1)))
41 #define EFI_NOT_FOUND		(14 | (1UL << (BITS_PER_LONG-1)))
42 #define EFI_TIMEOUT		(18 | (1UL << (BITS_PER_LONG-1)))
43 #define EFI_ABORTED		(21 | (1UL << (BITS_PER_LONG-1)))
44 #define EFI_SECURITY_VIOLATION	(26 | (1UL << (BITS_PER_LONG-1)))
45 
46 typedef unsigned long efi_status_t;
47 typedef u8 efi_bool_t;
48 typedef u16 efi_char16_t;		/* UNICODE character */
49 typedef u64 efi_physical_addr_t;
50 typedef void *efi_handle_t;
51 
52 #if defined(CONFIG_X86_64)
53 #define __efiapi __attribute__((ms_abi))
54 #elif defined(CONFIG_X86_32)
55 #define __efiapi __attribute__((regparm(0)))
56 #else
57 #define __efiapi
58 #endif
59 
60 /*
61  * The UEFI spec and EDK2 reference implementation both define EFI_GUID as
62  * struct { u32 a; u16; b; u16 c; u8 d[8]; }; and so the implied alignment
63  * is 32 bits not 8 bits like our guid_t. In some cases (i.e., on 32-bit ARM),
64  * this means that firmware services invoked by the kernel may assume that
65  * efi_guid_t* arguments are 32-bit aligned, and use memory accessors that
66  * do not tolerate misalignment. So let's set the minimum alignment to 32 bits.
67  *
68  * Note that the UEFI spec as well as some comments in the EDK2 code base
69  * suggest that EFI_GUID should be 64-bit aligned, but this appears to be
70  * a mistake, given that no code seems to exist that actually enforces that
71  * or relies on it.
72  */
73 typedef guid_t efi_guid_t __aligned(__alignof__(u32));
74 
75 #define EFI_GUID(a, b, c, d...) (efi_guid_t){ {					\
76 	(a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff,	\
77 	(b) & 0xff, ((b) >> 8) & 0xff,						\
78 	(c) & 0xff, ((c) >> 8) & 0xff, d } }
79 
80 /*
81  * Generic EFI table header
82  */
83 typedef	struct {
84 	u64 signature;
85 	u32 revision;
86 	u32 headersize;
87 	u32 crc32;
88 	u32 reserved;
89 } efi_table_hdr_t;
90 
91 /*
92  * Memory map descriptor:
93  */
94 
95 /* Memory types: */
96 #define EFI_RESERVED_TYPE		 0
97 #define EFI_LOADER_CODE			 1
98 #define EFI_LOADER_DATA			 2
99 #define EFI_BOOT_SERVICES_CODE		 3
100 #define EFI_BOOT_SERVICES_DATA		 4
101 #define EFI_RUNTIME_SERVICES_CODE	 5
102 #define EFI_RUNTIME_SERVICES_DATA	 6
103 #define EFI_CONVENTIONAL_MEMORY		 7
104 #define EFI_UNUSABLE_MEMORY		 8
105 #define EFI_ACPI_RECLAIM_MEMORY		 9
106 #define EFI_ACPI_MEMORY_NVS		10
107 #define EFI_MEMORY_MAPPED_IO		11
108 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE	12
109 #define EFI_PAL_CODE			13
110 #define EFI_PERSISTENT_MEMORY		14
111 #define EFI_UNACCEPTED_MEMORY		15
112 #define EFI_MAX_MEMORY_TYPE		16
113 
114 /* Attribute values: */
115 #define EFI_MEMORY_UC		((u64)0x0000000000000001ULL)	/* uncached */
116 #define EFI_MEMORY_WC		((u64)0x0000000000000002ULL)	/* write-coalescing */
117 #define EFI_MEMORY_WT		((u64)0x0000000000000004ULL)	/* write-through */
118 #define EFI_MEMORY_WB		((u64)0x0000000000000008ULL)	/* write-back */
119 #define EFI_MEMORY_UCE		((u64)0x0000000000000010ULL)	/* uncached, exported */
120 #define EFI_MEMORY_WP		((u64)0x0000000000001000ULL)	/* write-protect */
121 #define EFI_MEMORY_RP		((u64)0x0000000000002000ULL)	/* read-protect */
122 #define EFI_MEMORY_XP		((u64)0x0000000000004000ULL)	/* execute-protect */
123 #define EFI_MEMORY_NV		((u64)0x0000000000008000ULL)	/* non-volatile */
124 #define EFI_MEMORY_MORE_RELIABLE \
125 				((u64)0x0000000000010000ULL)	/* higher reliability */
126 #define EFI_MEMORY_RO		((u64)0x0000000000020000ULL)	/* read-only */
127 #define EFI_MEMORY_SP		((u64)0x0000000000040000ULL)	/* soft reserved */
128 #define EFI_MEMORY_CPU_CRYPTO	((u64)0x0000000000080000ULL)	/* supports encryption */
129 #define EFI_MEMORY_RUNTIME	((u64)0x8000000000000000ULL)	/* range requires runtime mapping */
130 #define EFI_MEMORY_DESCRIPTOR_VERSION	1
131 
132 #define EFI_PAGE_SHIFT		12
133 #define EFI_PAGE_SIZE		(1UL << EFI_PAGE_SHIFT)
134 #define EFI_PAGES_MAX		(U64_MAX >> EFI_PAGE_SHIFT)
135 
136 typedef struct {
137 	u32 type;
138 	u32 pad;
139 	u64 phys_addr;
140 	u64 virt_addr;
141 	u64 num_pages;
142 	u64 attribute;
143 } efi_memory_desc_t;
144 
145 typedef struct {
146 	efi_guid_t guid;
147 	u32 headersize;
148 	u32 flags;
149 	u32 imagesize;
150 } efi_capsule_header_t;
151 
152 /* EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER */
153 struct efi_manage_capsule_header {
154 	u32 ver;
155 	u16 emb_drv_cnt;
156 	u16 payload_cnt;
157 	/*
158 	 * Variable-size array of the size given by the sum of
159 	 * emb_drv_cnt and payload_cnt.
160 	 */
161 	u64 offset_list[];
162 } __packed;
163 
164 /* EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER */
165 struct efi_manage_capsule_image_header {
166 	u32 ver;
167 	efi_guid_t image_type_id;
168 	u8 image_index;
169 	u8 reserved_bytes[3];
170 	u32 image_size;
171 	u32 vendor_code_size;
172 	/* hw_ins was introduced in version 2 */
173 	u64 hw_ins;
174 	/* capsule_support was introduced in version 3 */
175 	u64 capsule_support;
176 } __packed;
177 
178 /* WIN_CERTIFICATE */
179 struct win_cert {
180 	u32 len;
181 	u16 rev;
182 	u16 cert_type;
183 };
184 
185 /* WIN_CERTIFICATE_UEFI_GUID */
186 struct win_cert_uefi_guid {
187 	struct win_cert	hdr;
188 	efi_guid_t cert_type;
189 	u8 cert_data[];
190 };
191 
192 /* EFI_FIRMWARE_IMAGE_AUTHENTICATION */
193 struct efi_image_auth {
194 	u64 mon_count;
195 	struct win_cert_uefi_guid auth_info;
196 };
197 
198 /*
199  * EFI capsule flags
200  */
201 #define EFI_CAPSULE_PERSIST_ACROSS_RESET	0x00010000
202 #define EFI_CAPSULE_POPULATE_SYSTEM_TABLE	0x00020000
203 #define EFI_CAPSULE_INITIATE_RESET		0x00040000
204 
205 struct capsule_info {
206 	efi_capsule_header_t	header;
207 	efi_capsule_header_t	*capsule;
208 	int			reset_type;
209 	long			index;
210 	size_t			count;
211 	size_t			total_size;
212 	struct page		**pages;
213 	phys_addr_t		*phys;
214 	size_t			page_bytes_remain;
215 };
216 
217 int efi_capsule_setup_info(struct capsule_info *cap_info, void *kbuff,
218                            size_t hdr_bytes);
219 int __efi_capsule_setup_info(struct capsule_info *cap_info);
220 
221 /*
222  * Types and defines for Time Services
223  */
224 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
225 #define EFI_TIME_IN_DAYLIGHT     0x2
226 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
227 
228 typedef struct {
229 	u16 year;
230 	u8 month;
231 	u8 day;
232 	u8 hour;
233 	u8 minute;
234 	u8 second;
235 	u8 pad1;
236 	u32 nanosecond;
237 	s16 timezone;
238 	u8 daylight;
239 	u8 pad2;
240 } efi_time_t;
241 
242 typedef struct {
243 	u32 resolution;
244 	u32 accuracy;
245 	u8 sets_to_zero;
246 } efi_time_cap_t;
247 
248 typedef union efi_boot_services efi_boot_services_t;
249 
250 /*
251  * Types and defines for EFI ResetSystem
252  */
253 #define EFI_RESET_COLD 0
254 #define EFI_RESET_WARM 1
255 #define EFI_RESET_SHUTDOWN 2
256 
257 /*
258  * EFI Runtime Services table
259  */
260 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
261 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
262 
263 typedef struct {
264 	efi_table_hdr_t hdr;
265 	u32 get_time;
266 	u32 set_time;
267 	u32 get_wakeup_time;
268 	u32 set_wakeup_time;
269 	u32 set_virtual_address_map;
270 	u32 convert_pointer;
271 	u32 get_variable;
272 	u32 get_next_variable;
273 	u32 set_variable;
274 	u32 get_next_high_mono_count;
275 	u32 reset_system;
276 	u32 update_capsule;
277 	u32 query_capsule_caps;
278 	u32 query_variable_info;
279 } efi_runtime_services_32_t;
280 
281 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
282 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
283 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
284 					    efi_time_t *tm);
285 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
286 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
287 					 unsigned long *data_size, void *data);
288 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
289 					      efi_guid_t *vendor);
290 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
291 					 u32 attr, unsigned long data_size,
292 					 void *data);
293 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
294 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
295 				 unsigned long data_size, efi_char16_t *data);
296 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
297 						unsigned long descriptor_size,
298 						u32 descriptor_version,
299 						efi_memory_desc_t *virtual_map);
300 typedef efi_status_t efi_query_variable_info_t(u32 attr,
301 					       u64 *storage_space,
302 					       u64 *remaining_space,
303 					       u64 *max_variable_size);
304 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
305 					  unsigned long count,
306 					  unsigned long sg_list);
307 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
308 					      unsigned long count,
309 					      u64 *max_size,
310 					      int *reset_type);
311 typedef efi_status_t efi_query_variable_store_t(u32 attributes,
312 						unsigned long size,
313 						bool nonblocking);
314 
315 typedef union {
316 	struct {
317 		efi_table_hdr_t				hdr;
318 		efi_get_time_t __efiapi			*get_time;
319 		efi_set_time_t __efiapi			*set_time;
320 		efi_get_wakeup_time_t __efiapi		*get_wakeup_time;
321 		efi_set_wakeup_time_t __efiapi		*set_wakeup_time;
322 		efi_set_virtual_address_map_t __efiapi	*set_virtual_address_map;
323 		void					*convert_pointer;
324 		efi_get_variable_t __efiapi		*get_variable;
325 		efi_get_next_variable_t __efiapi	*get_next_variable;
326 		efi_set_variable_t __efiapi		*set_variable;
327 		efi_get_next_high_mono_count_t __efiapi	*get_next_high_mono_count;
328 		efi_reset_system_t __efiapi		*reset_system;
329 		efi_update_capsule_t __efiapi		*update_capsule;
330 		efi_query_capsule_caps_t __efiapi	*query_capsule_caps;
331 		efi_query_variable_info_t __efiapi	*query_variable_info;
332 	};
333 	efi_runtime_services_32_t mixed_mode;
334 } efi_runtime_services_t;
335 
336 void efi_native_runtime_setup(void);
337 
338 /*
339  * EFI Configuration Table and GUID definitions
340  *
341  * These are all defined in a single line to make them easier to
342  * grep for and to see them at a glance - while still having a
343  * similar structure to the definitions in the spec.
344  *
345  * Here's how they are structured:
346  *
347  * GUID: 12345678-1234-1234-1234-123456789012
348  * Spec:
349  *      #define EFI_SOME_PROTOCOL_GUID \
350  *        {0x12345678,0x1234,0x1234,\
351  *          {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
352  * Here:
353  *	#define SOME_PROTOCOL_GUID		EFI_GUID(0x12345678, 0x1234, 0x1234,  0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
354  *					^ tabs					    ^extra space
355  *
356  * Note that the 'extra space' separates the values at the same place
357  * where the UEFI SPEC breaks the line.
358  */
359 #define NULL_GUID				EFI_GUID(0x00000000, 0x0000, 0x0000,  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
360 #define MPS_TABLE_GUID				EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
361 #define ACPI_TABLE_GUID				EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
362 #define ACPI_20_TABLE_GUID			EFI_GUID(0x8868e871, 0xe4f1, 0x11d3,  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
363 #define SMBIOS_TABLE_GUID			EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
364 #define SMBIOS3_TABLE_GUID			EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c,  0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
365 #define SAL_SYSTEM_TABLE_GUID			EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
366 #define HCDP_TABLE_GUID				EFI_GUID(0xf951938d, 0x620b, 0x42ef,  0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
367 #define UGA_IO_PROTOCOL_GUID			EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b,  0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
368 #define EFI_GLOBAL_VARIABLE_GUID		EFI_GUID(0x8be4df61, 0x93ca, 0x11d2,  0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
369 #define UV_SYSTEM_TABLE_GUID			EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd,  0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
370 #define LINUX_EFI_CRASH_GUID			EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc,  0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
371 #define LOADED_IMAGE_PROTOCOL_GUID		EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
372 #define LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID	EFI_GUID(0xbc62157e, 0x3e33, 0x4fec,  0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
373 #define EFI_DEVICE_PATH_PROTOCOL_GUID		EFI_GUID(0x09576e91, 0x6d3f, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
374 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID	EFI_GUID(0x8b843e20, 0x8132, 0x4852,  0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
375 #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID	EFI_GUID(0x05c99a21, 0xc70f, 0x4ad2,  0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e)
376 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID	EFI_GUID(0x9042a9de, 0x23dc, 0x4a38,  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
377 #define EFI_UGA_PROTOCOL_GUID			EFI_GUID(0x982c298b, 0xf4fa, 0x41cb,  0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
378 #define EFI_PCI_IO_PROTOCOL_GUID		EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5,  0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
379 #define EFI_FILE_INFO_ID			EFI_GUID(0x09576e92, 0x6d3f, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
380 #define EFI_SYSTEM_RESOURCE_TABLE_GUID		EFI_GUID(0xb122a263, 0x3661, 0x4f68,  0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
381 #define EFI_FILE_SYSTEM_GUID			EFI_GUID(0x964e5b22, 0x6459, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
382 #define DEVICE_TREE_GUID			EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5,  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
383 #define EFI_PROPERTIES_TABLE_GUID		EFI_GUID(0x880aaca3, 0x4adc, 0x4a04,  0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
384 #define EFI_RNG_PROTOCOL_GUID			EFI_GUID(0x3152bca5, 0xeade, 0x433d,  0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
385 #define EFI_RNG_ALGORITHM_RAW			EFI_GUID(0xe43176d7, 0xb6e8, 0x4827,  0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
386 #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID	EFI_GUID(0xdcfa911d, 0x26eb, 0x469f,  0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
387 #define EFI_CONSOLE_OUT_DEVICE_GUID		EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4,  0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
388 #define APPLE_PROPERTIES_PROTOCOL_GUID		EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb,  0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
389 #define EFI_TCG2_PROTOCOL_GUID			EFI_GUID(0x607f766c, 0x7455, 0x42be,  0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
390 #define EFI_LOAD_FILE_PROTOCOL_GUID		EFI_GUID(0x56ec3091, 0x954c, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
391 #define EFI_LOAD_FILE2_PROTOCOL_GUID		EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e,  0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
392 #define EFI_RT_PROPERTIES_TABLE_GUID		EFI_GUID(0xeb66918a, 0x7eef, 0x402a,  0x84, 0x2e, 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
393 #define EFI_DXE_SERVICES_TABLE_GUID		EFI_GUID(0x05ad34ba, 0x6f02, 0x4214,  0x95, 0x2e, 0x4d, 0xa0, 0x39, 0x8e, 0x2b, 0xb9)
394 #define EFI_SMBIOS_PROTOCOL_GUID		EFI_GUID(0x03583ff6, 0xcb36, 0x4940,  0x94, 0x7e, 0xb9, 0xb3, 0x9f, 0x4a, 0xfa, 0xf7)
395 #define EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID	EFI_GUID(0xf4560cf6, 0x40ec, 0x4b4a,  0xa1, 0x92, 0xbf, 0x1d, 0x57, 0xd0, 0xb1, 0x89)
396 
397 #define EFI_IMAGE_SECURITY_DATABASE_GUID	EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596,  0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
398 #define EFI_SHIM_LOCK_GUID			EFI_GUID(0x605dab50, 0xe046, 0x4300,  0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
399 
400 #define EFI_CERT_SHA256_GUID			EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
401 #define EFI_CERT_X509_GUID			EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
402 #define EFI_CERT_X509_SHA256_GUID		EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
403 #define EFI_CC_BLOB_GUID			EFI_GUID(0x067b1f5f, 0xcf26, 0x44c5, 0x85, 0x54, 0x93, 0xd7, 0x77, 0x91, 0x2d, 0x42)
404 
405 /*
406  * This GUID is used to pass to the kernel proper the struct screen_info
407  * structure that was populated by the stub based on the GOP protocol instance
408  * associated with ConOut
409  */
410 #define LINUX_EFI_SCREEN_INFO_TABLE_GUID	EFI_GUID(0xe03fc20a, 0x85dc, 0x406e,  0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
411 #define LINUX_EFI_ARM_CPU_STATE_TABLE_GUID	EFI_GUID(0xef79e4aa, 0x3c3d, 0x4989,  0xb9, 0x02, 0x07, 0xa9, 0x43, 0xe5, 0x50, 0xd2)
412 #define LINUX_EFI_LOADER_ENTRY_GUID		EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf,  0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
413 #define LINUX_EFI_RANDOM_SEED_TABLE_GUID	EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2,  0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
414 #define LINUX_EFI_TPM_EVENT_LOG_GUID		EFI_GUID(0xb7799cb0, 0xeca2, 0x4943,  0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
415 #define LINUX_EFI_TPM_FINAL_LOG_GUID		EFI_GUID(0x1e2ed096, 0x30e2, 0x4254,  0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
416 #define LINUX_EFI_MEMRESERVE_TABLE_GUID		EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5,  0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
417 #define LINUX_EFI_INITRD_MEDIA_GUID		EFI_GUID(0x5568e427, 0x68fc, 0x4f3d,  0xac, 0x74, 0xca, 0x55, 0x52, 0x31, 0xcc, 0x68)
418 #define LINUX_EFI_MOK_VARIABLE_TABLE_GUID	EFI_GUID(0xc451ed2b, 0x9694, 0x45d3,  0xba, 0xba, 0xed, 0x9f, 0x89, 0x88, 0xa3, 0x89)
419 #define LINUX_EFI_COCO_SECRET_AREA_GUID		EFI_GUID(0xadf956ad, 0xe98c, 0x484c,  0xae, 0x11, 0xb5, 0x1c, 0x7d, 0x33, 0x64, 0x47)
420 #define LINUX_EFI_BOOT_MEMMAP_GUID		EFI_GUID(0x800f683f, 0xd08b, 0x423a,  0xa2, 0x93, 0x96, 0x5c, 0x3c, 0x6f, 0xe2, 0xb4)
421 #define LINUX_EFI_UNACCEPTED_MEM_TABLE_GUID	EFI_GUID(0xd5d1de3c, 0x105c, 0x44f9,  0x9e, 0xa9, 0xbc, 0xef, 0x98, 0x12, 0x00, 0x31)
422 
423 #define RISCV_EFI_BOOT_PROTOCOL_GUID		EFI_GUID(0xccd15fec, 0x6f73, 0x4eec,  0x83, 0x95, 0x3e, 0x69, 0xe4, 0xb9, 0x40, 0xbf)
424 
425 /*
426  * This GUID may be installed onto the kernel image's handle as a NULL protocol
427  * to signal to the stub that the placement of the image should be respected,
428  * and moving the image in physical memory is undesirable. To ensure
429  * compatibility with 64k pages kernels with virtually mapped stacks, and to
430  * avoid defeating physical randomization, this protocol should only be
431  * installed if the image was placed at a randomized 128k aligned address in
432  * memory.
433  */
434 #define LINUX_EFI_LOADED_IMAGE_FIXED_GUID	EFI_GUID(0xf5a37b6d, 0x3344, 0x42a5,  0xb6, 0xbb, 0x97, 0x86, 0x48, 0xc1, 0x89, 0x0a)
435 
436 /* OEM GUIDs */
437 #define DELLEMC_EFI_RCI2_TABLE_GUID		EFI_GUID(0x2d9f28a2, 0xa886, 0x456a,  0x97, 0xa8, 0xf1, 0x1e, 0xf2, 0x4f, 0xf4, 0x55)
438 #define AMD_SEV_MEM_ENCRYPT_GUID		EFI_GUID(0x0cf29b71, 0x9e51, 0x433a,  0xa3, 0xb7, 0x81, 0xf3, 0xab, 0x16, 0xb8, 0x75)
439 
440 /* OVMF protocol GUIDs */
441 #define OVMF_SEV_MEMORY_ACCEPTANCE_PROTOCOL_GUID	EFI_GUID(0xc5a010fe, 0x38a7, 0x4531,  0x8a, 0x4a, 0x05, 0x00, 0xd2, 0xfd, 0x16, 0x49)
442 
443 typedef struct {
444 	efi_guid_t guid;
445 	u64 table;
446 } efi_config_table_64_t;
447 
448 typedef struct {
449 	efi_guid_t guid;
450 	u32 table;
451 } efi_config_table_32_t;
452 
453 typedef union {
454 	struct {
455 		efi_guid_t guid;
456 		void *table;
457 	};
458 	efi_config_table_32_t mixed_mode;
459 } efi_config_table_t;
460 
461 typedef struct {
462 	efi_guid_t guid;
463 	unsigned long *ptr;
464 	const char name[16];
465 } efi_config_table_type_t;
466 
467 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
468 #define EFI_DXE_SERVICES_TABLE_SIGNATURE ((u64)0x565245535f455844ULL)
469 
470 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
471 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
472 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
473 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
474 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
475 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
476 
477 typedef struct {
478 	efi_table_hdr_t hdr;
479 	u64 fw_vendor;	/* physical addr of CHAR16 vendor string */
480 	u32 fw_revision;
481 	u32 __pad1;
482 	u64 con_in_handle;
483 	u64 con_in;
484 	u64 con_out_handle;
485 	u64 con_out;
486 	u64 stderr_handle;
487 	u64 stderr;
488 	u64 runtime;
489 	u64 boottime;
490 	u32 nr_tables;
491 	u32 __pad2;
492 	u64 tables;
493 } efi_system_table_64_t;
494 
495 typedef struct {
496 	efi_table_hdr_t hdr;
497 	u32 fw_vendor;	/* physical addr of CHAR16 vendor string */
498 	u32 fw_revision;
499 	u32 con_in_handle;
500 	u32 con_in;
501 	u32 con_out_handle;
502 	u32 con_out;
503 	u32 stderr_handle;
504 	u32 stderr;
505 	u32 runtime;
506 	u32 boottime;
507 	u32 nr_tables;
508 	u32 tables;
509 } efi_system_table_32_t;
510 
511 typedef union efi_simple_text_input_protocol efi_simple_text_input_protocol_t;
512 typedef union efi_simple_text_output_protocol efi_simple_text_output_protocol_t;
513 
514 typedef union {
515 	struct {
516 		efi_table_hdr_t hdr;
517 		unsigned long fw_vendor;	/* physical addr of CHAR16 vendor string */
518 		u32 fw_revision;
519 		unsigned long con_in_handle;
520 		efi_simple_text_input_protocol_t *con_in;
521 		unsigned long con_out_handle;
522 		efi_simple_text_output_protocol_t *con_out;
523 		unsigned long stderr_handle;
524 		unsigned long stderr;
525 		efi_runtime_services_t *runtime;
526 		efi_boot_services_t *boottime;
527 		unsigned long nr_tables;
528 		unsigned long tables;
529 	};
530 	efi_system_table_32_t mixed_mode;
531 } efi_system_table_t;
532 
533 struct efi_boot_memmap {
534 	unsigned long		map_size;
535 	unsigned long		desc_size;
536 	u32			desc_ver;
537 	unsigned long		map_key;
538 	unsigned long		buff_size;
539 	efi_memory_desc_t	map[];
540 };
541 
542 struct efi_unaccepted_memory {
543 	u32 version;
544 	u32 unit_size;
545 	u64 phys_base;
546 	u64 size;
547 	unsigned long bitmap[];
548 };
549 
550 /*
551  * Architecture independent structure for describing a memory map for the
552  * benefit of efi_memmap_init_early(), and for passing context between
553  * efi_memmap_alloc() and efi_memmap_install().
554  */
555 struct efi_memory_map_data {
556 	phys_addr_t phys_map;
557 	unsigned long size;
558 	unsigned long desc_version;
559 	unsigned long desc_size;
560 	unsigned long flags;
561 };
562 
563 struct efi_memory_map {
564 	phys_addr_t phys_map;
565 	void *map;
566 	void *map_end;
567 	int nr_map;
568 	unsigned long desc_version;
569 	unsigned long desc_size;
570 #define EFI_MEMMAP_LATE (1UL << 0)
571 #define EFI_MEMMAP_MEMBLOCK (1UL << 1)
572 #define EFI_MEMMAP_SLAB (1UL << 2)
573 	unsigned long flags;
574 };
575 
576 struct efi_mem_range {
577 	struct range range;
578 	u64 attribute;
579 };
580 
581 typedef struct {
582 	u32 version;
583 	u32 length;
584 	u64 memory_protection_attribute;
585 } efi_properties_table_t;
586 
587 #define EFI_PROPERTIES_TABLE_VERSION	0x00010000
588 #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA	0x1
589 
590 typedef struct {
591 	u16 version;
592 	u16 length;
593 	u32 runtime_services_supported;
594 } efi_rt_properties_table_t;
595 
596 #define EFI_RT_PROPERTIES_TABLE_VERSION	0x1
597 
598 #define EFI_INVALID_TABLE_ADDR		(~0UL)
599 
600 // BIT0 implies that Runtime code includes the forward control flow guard
601 // instruction, such as X86 CET-IBT or ARM BTI.
602 #define EFI_MEMORY_ATTRIBUTES_FLAGS_RT_FORWARD_CONTROL_FLOW_GUARD	0x1
603 
604 typedef struct {
605 	u32 version;
606 	u32 num_entries;
607 	u32 desc_size;
608 	u32 flags;
609 	efi_memory_desc_t entry[0];
610 } efi_memory_attributes_table_t;
611 
612 typedef struct {
613 	efi_guid_t signature_owner;
614 	u8 signature_data[];
615 } efi_signature_data_t;
616 
617 typedef struct {
618 	efi_guid_t signature_type;
619 	u32 signature_list_size;
620 	u32 signature_header_size;
621 	u32 signature_size;
622 	u8 signature_header[];
623 	/* efi_signature_data_t signatures[][] */
624 } efi_signature_list_t;
625 
626 typedef u8 efi_sha256_hash_t[32];
627 
628 typedef struct {
629 	efi_sha256_hash_t to_be_signed_hash;
630 	efi_time_t time_of_revocation;
631 } efi_cert_x509_sha256_t;
632 
633 extern unsigned long __ro_after_init efi_rng_seed;		/* RNG Seed table */
634 
635 /*
636  * All runtime access to EFI goes through this structure:
637  */
638 extern struct efi {
639 	const efi_runtime_services_t	*runtime;		/* EFI runtime services table */
640 	unsigned int			runtime_version;	/* Runtime services version */
641 	unsigned int			runtime_supported_mask;
642 
643 	unsigned long			acpi;			/* ACPI table  (IA64 ext 0.71) */
644 	unsigned long			acpi20;			/* ACPI table  (ACPI 2.0) */
645 	unsigned long			smbios;			/* SMBIOS table (32 bit entry point) */
646 	unsigned long			smbios3;		/* SMBIOS table (64 bit entry point) */
647 	unsigned long			esrt;			/* ESRT table */
648 	unsigned long			tpm_log;		/* TPM2 Event Log table */
649 	unsigned long			tpm_final_log;		/* TPM2 Final Events Log table */
650 	unsigned long			mokvar_table;		/* MOK variable config table */
651 	unsigned long			coco_secret;		/* Confidential computing secret table */
652 	unsigned long			unaccepted;		/* Unaccepted memory table */
653 
654 	efi_get_time_t			*get_time;
655 	efi_set_time_t			*set_time;
656 	efi_get_wakeup_time_t		*get_wakeup_time;
657 	efi_set_wakeup_time_t		*set_wakeup_time;
658 	efi_get_variable_t		*get_variable;
659 	efi_get_next_variable_t		*get_next_variable;
660 	efi_set_variable_t		*set_variable;
661 	efi_set_variable_t		*set_variable_nonblocking;
662 	efi_query_variable_info_t	*query_variable_info;
663 	efi_query_variable_info_t	*query_variable_info_nonblocking;
664 	efi_update_capsule_t		*update_capsule;
665 	efi_query_capsule_caps_t	*query_capsule_caps;
666 	efi_get_next_high_mono_count_t	*get_next_high_mono_count;
667 	efi_reset_system_t		*reset_system;
668 
669 	struct efi_memory_map		memmap;
670 	unsigned long			flags;
671 } efi;
672 
673 #define EFI_RT_SUPPORTED_GET_TIME				0x0001
674 #define EFI_RT_SUPPORTED_SET_TIME				0x0002
675 #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME			0x0004
676 #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME			0x0008
677 #define EFI_RT_SUPPORTED_GET_VARIABLE				0x0010
678 #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME			0x0020
679 #define EFI_RT_SUPPORTED_SET_VARIABLE				0x0040
680 #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP		0x0080
681 #define EFI_RT_SUPPORTED_CONVERT_POINTER			0x0100
682 #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT		0x0200
683 #define EFI_RT_SUPPORTED_RESET_SYSTEM				0x0400
684 #define EFI_RT_SUPPORTED_UPDATE_CAPSULE				0x0800
685 #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES		0x1000
686 #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO			0x2000
687 
688 #define EFI_RT_SUPPORTED_ALL					0x3fff
689 
690 #define EFI_RT_SUPPORTED_TIME_SERVICES				0x0003
691 #define EFI_RT_SUPPORTED_WAKEUP_SERVICES			0x000c
692 #define EFI_RT_SUPPORTED_VARIABLE_SERVICES			0x0070
693 
694 extern struct mm_struct efi_mm;
695 
696 static inline int
697 efi_guidcmp (efi_guid_t left, efi_guid_t right)
698 {
699 	return memcmp(&left, &right, sizeof (efi_guid_t));
700 }
701 
702 static inline char *
703 efi_guid_to_str(efi_guid_t *guid, char *out)
704 {
705 	sprintf(out, "%pUl", guid->b);
706         return out;
707 }
708 
709 extern void efi_init (void);
710 extern void efi_earlycon_reprobe(void);
711 #ifdef CONFIG_EFI
712 extern void efi_enter_virtual_mode (void);	/* switch EFI to virtual mode, if possible */
713 #else
714 static inline void efi_enter_virtual_mode (void) {}
715 #endif
716 #ifdef CONFIG_X86
717 extern efi_status_t efi_query_variable_store(u32 attributes,
718 					     unsigned long size,
719 					     bool nonblocking);
720 #else
721 
722 static inline efi_status_t efi_query_variable_store(u32 attributes,
723 						    unsigned long size,
724 						    bool nonblocking)
725 {
726 	return EFI_SUCCESS;
727 }
728 #endif
729 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
730 
731 extern int __init __efi_memmap_init(struct efi_memory_map_data *data);
732 extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
733 extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
734 extern void __init efi_memmap_unmap(void);
735 
736 #ifdef CONFIG_EFI_ESRT
737 extern void __init efi_esrt_init(void);
738 #else
739 static inline void efi_esrt_init(void) { }
740 #endif
741 extern int efi_config_parse_tables(const efi_config_table_t *config_tables,
742 				   int count,
743 				   const efi_config_table_type_t *arch_tables);
744 extern int efi_systab_check_header(const efi_table_hdr_t *systab_hdr);
745 extern void efi_systab_report_header(const efi_table_hdr_t *systab_hdr,
746 				     unsigned long fw_vendor);
747 extern u64 efi_get_iobase (void);
748 extern int efi_mem_type(unsigned long phys_addr);
749 extern u64 efi_mem_attributes (unsigned long phys_addr);
750 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
751 extern int __init efi_uart_console_only (void);
752 extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
753 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
754 extern int __efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
755 extern void efi_mem_reserve(phys_addr_t addr, u64 size);
756 extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size);
757 extern void efi_initialize_iomem_resources(struct resource *code_resource,
758 		struct resource *data_resource, struct resource *bss_resource);
759 extern u64 efi_get_fdt_params(struct efi_memory_map_data *data);
760 extern struct kobject *efi_kobj;
761 
762 extern int efi_reboot_quirk_mode;
763 extern bool efi_poweroff_required(void);
764 
765 extern unsigned long efi_mem_attr_table;
766 
767 /*
768  * efi_memattr_perm_setter - arch specific callback function passed into
769  *                           efi_memattr_apply_permissions() that updates the
770  *                           mapping permissions described by the second
771  *                           argument in the page tables referred to by the
772  *                           first argument.
773  */
774 typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *, bool);
775 
776 extern int efi_memattr_init(void);
777 extern int efi_memattr_apply_permissions(struct mm_struct *mm,
778 					 efi_memattr_perm_setter fn);
779 
780 /*
781  * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor
782  * @map: the start of efi memmap
783  * @desc_size: the size of space for each EFI memmap descriptor
784  * @n: the index of efi memmap descriptor
785  *
786  * EFI boot service provides the GetMemoryMap() function to get a copy of the
787  * current memory map which is an array of memory descriptors, each of
788  * which describes a contiguous block of memory. It also gets the size of the
789  * map, and the size of each descriptor, etc.
790  *
791  * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
792  * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
793  * since efi_memory_memdesc_t may be extended in the future. Thus the OS
794  * MUST use the returned size of the descriptor to find the start of each
795  * efi_memory_memdesc_t in the memory map array. This should only be used
796  * during bootup since for_each_efi_memory_desc_xxx() is available after the
797  * kernel initializes the EFI subsystem to set up struct efi_memory_map.
798  */
799 #define efi_early_memdesc_ptr(map, desc_size, n)			\
800 	(efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
801 
802 /* Iterate through an efi_memory_map */
803 #define for_each_efi_memory_desc_in_map(m, md)				   \
804 	for ((md) = (m)->map;						   \
805 	     (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end;	   \
806 	     (md) = (void *)(md) + (m)->desc_size)
807 
808 /**
809  * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
810  * @md: the efi_memory_desc_t * iterator
811  *
812  * Once the loop finishes @md must not be accessed.
813  */
814 #define for_each_efi_memory_desc(md) \
815 	for_each_efi_memory_desc_in_map(&efi.memmap, md)
816 
817 /*
818  * Format an EFI memory descriptor's type and attributes to a user-provided
819  * character buffer, as per snprintf(), and return the buffer.
820  */
821 char * __init efi_md_typeattr_format(char *buf, size_t size,
822 				     const efi_memory_desc_t *md);
823 
824 
825 typedef void (*efi_element_handler_t)(const char *source,
826 				      const void *element_data,
827 				      size_t element_size);
828 extern int __init parse_efi_signature_list(
829 	const char *source,
830 	const void *data, size_t size,
831 	efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *));
832 
833 /**
834  * efi_range_is_wc - check the WC bit on an address range
835  * @start: starting kvirt address
836  * @len: length of range
837  *
838  * Consult the EFI memory map and make sure it's ok to set this range WC.
839  * Returns true or false.
840  */
841 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
842 {
843 	unsigned long i;
844 
845 	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
846 		unsigned long paddr = __pa(start + i);
847 		if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
848 			return 0;
849 	}
850 	/* The range checked out */
851 	return 1;
852 }
853 
854 #ifdef CONFIG_EFI_PCDP
855 extern int __init efi_setup_pcdp_console(char *);
856 #endif
857 
858 /*
859  * We play games with efi_enabled so that the compiler will, if
860  * possible, remove EFI-related code altogether.
861  */
862 #define EFI_BOOT		0	/* Were we booted from EFI? */
863 #define EFI_CONFIG_TABLES	2	/* Can we use EFI config tables? */
864 #define EFI_RUNTIME_SERVICES	3	/* Can we use runtime services? */
865 #define EFI_MEMMAP		4	/* Can we use EFI memory map? */
866 #define EFI_64BIT		5	/* Is the firmware 64-bit? */
867 #define EFI_PARAVIRT		6	/* Access is via a paravirt interface */
868 #define EFI_ARCH_1		7	/* First arch-specific bit */
869 #define EFI_DBG			8	/* Print additional debug info at runtime */
870 #define EFI_NX_PE_DATA		9	/* Can runtime data regions be mapped non-executable? */
871 #define EFI_MEM_ATTR		10	/* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
872 #define EFI_MEM_NO_SOFT_RESERVE	11	/* Is the kernel configured to ignore soft reservations? */
873 #define EFI_PRESERVE_BS_REGIONS	12	/* Are EFI boot-services memory segments available? */
874 
875 #ifdef CONFIG_EFI
876 /*
877  * Test whether the above EFI_* bits are enabled.
878  */
879 static inline bool efi_enabled(int feature)
880 {
881 	return test_bit(feature, &efi.flags) != 0;
882 }
883 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
884 
885 bool __pure __efi_soft_reserve_enabled(void);
886 
887 static inline bool __pure efi_soft_reserve_enabled(void)
888 {
889 	return IS_ENABLED(CONFIG_EFI_SOFT_RESERVE)
890 		&& __efi_soft_reserve_enabled();
891 }
892 
893 static inline bool efi_rt_services_supported(unsigned int mask)
894 {
895 	return (efi.runtime_supported_mask & mask) == mask;
896 }
897 extern void efi_find_mirror(void);
898 #else
899 static inline bool efi_enabled(int feature)
900 {
901 	return false;
902 }
903 static inline void
904 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
905 
906 static inline bool efi_soft_reserve_enabled(void)
907 {
908 	return false;
909 }
910 
911 static inline bool efi_rt_services_supported(unsigned int mask)
912 {
913 	return false;
914 }
915 
916 static inline void efi_find_mirror(void) {}
917 #endif
918 
919 extern int efi_status_to_err(efi_status_t status);
920 
921 /*
922  * Variable Attributes
923  */
924 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
925 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
926 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
927 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
928 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
929 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
930 #define EFI_VARIABLE_APPEND_WRITE	0x0000000000000040
931 
932 #define EFI_VARIABLE_MASK	(EFI_VARIABLE_NON_VOLATILE | \
933 				EFI_VARIABLE_BOOTSERVICE_ACCESS | \
934 				EFI_VARIABLE_RUNTIME_ACCESS | \
935 				EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
936 				EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
937 				EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
938 				EFI_VARIABLE_APPEND_WRITE)
939 /*
940  * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
941  * not including trailing NUL
942  */
943 #define EFI_VARIABLE_GUID_LEN	UUID_STRING_LEN
944 
945 /*
946  * EFI Device Path information
947  */
948 #define EFI_DEV_HW			0x01
949 #define  EFI_DEV_PCI				 1
950 #define  EFI_DEV_PCCARD				 2
951 #define  EFI_DEV_MEM_MAPPED			 3
952 #define  EFI_DEV_VENDOR				 4
953 #define  EFI_DEV_CONTROLLER			 5
954 #define EFI_DEV_ACPI			0x02
955 #define   EFI_DEV_BASIC_ACPI			 1
956 #define   EFI_DEV_EXPANDED_ACPI			 2
957 #define EFI_DEV_MSG			0x03
958 #define   EFI_DEV_MSG_ATAPI			 1
959 #define   EFI_DEV_MSG_SCSI			 2
960 #define   EFI_DEV_MSG_FC			 3
961 #define   EFI_DEV_MSG_1394			 4
962 #define   EFI_DEV_MSG_USB			 5
963 #define   EFI_DEV_MSG_USB_CLASS			15
964 #define   EFI_DEV_MSG_I20			 6
965 #define   EFI_DEV_MSG_MAC			11
966 #define   EFI_DEV_MSG_IPV4			12
967 #define   EFI_DEV_MSG_IPV6			13
968 #define   EFI_DEV_MSG_INFINIBAND		 9
969 #define   EFI_DEV_MSG_UART			14
970 #define   EFI_DEV_MSG_VENDOR			10
971 #define EFI_DEV_MEDIA			0x04
972 #define   EFI_DEV_MEDIA_HARD_DRIVE		 1
973 #define   EFI_DEV_MEDIA_CDROM			 2
974 #define   EFI_DEV_MEDIA_VENDOR			 3
975 #define   EFI_DEV_MEDIA_FILE			 4
976 #define   EFI_DEV_MEDIA_PROTOCOL		 5
977 #define   EFI_DEV_MEDIA_REL_OFFSET		 8
978 #define EFI_DEV_BIOS_BOOT		0x05
979 #define EFI_DEV_END_PATH		0x7F
980 #define EFI_DEV_END_PATH2		0xFF
981 #define   EFI_DEV_END_INSTANCE			0x01
982 #define   EFI_DEV_END_ENTIRE			0xFF
983 
984 struct efi_generic_dev_path {
985 	u8				type;
986 	u8				sub_type;
987 	u16				length;
988 } __packed;
989 
990 struct efi_acpi_dev_path {
991 	struct efi_generic_dev_path	header;
992 	u32				hid;
993 	u32				uid;
994 } __packed;
995 
996 struct efi_pci_dev_path {
997 	struct efi_generic_dev_path	header;
998 	u8				fn;
999 	u8				dev;
1000 } __packed;
1001 
1002 struct efi_vendor_dev_path {
1003 	struct efi_generic_dev_path	header;
1004 	efi_guid_t			vendorguid;
1005 	u8				vendordata[];
1006 } __packed;
1007 
1008 struct efi_rel_offset_dev_path {
1009 	struct efi_generic_dev_path	header;
1010 	u32				reserved;
1011 	u64				starting_offset;
1012 	u64				ending_offset;
1013 } __packed;
1014 
1015 struct efi_mem_mapped_dev_path {
1016 	struct efi_generic_dev_path	header;
1017 	u32				memory_type;
1018 	u64				starting_addr;
1019 	u64				ending_addr;
1020 } __packed;
1021 
1022 struct efi_file_path_dev_path {
1023 	struct efi_generic_dev_path	header;
1024 	efi_char16_t			filename[];
1025 } __packed;
1026 
1027 struct efi_dev_path {
1028 	union {
1029 		struct efi_generic_dev_path	header;
1030 		struct efi_acpi_dev_path	acpi;
1031 		struct efi_pci_dev_path		pci;
1032 		struct efi_vendor_dev_path	vendor;
1033 		struct efi_rel_offset_dev_path	rel_offset;
1034 	};
1035 } __packed;
1036 
1037 struct device *efi_get_device_by_path(const struct efi_dev_path **node,
1038 				      size_t *len);
1039 
1040 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1041 {
1042 	*npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1043 	*addr &= PAGE_MASK;
1044 }
1045 
1046 /*
1047  * EFI Variable support.
1048  *
1049  * Different firmware drivers can expose their EFI-like variables using
1050  * the following.
1051  */
1052 
1053 struct efivar_operations {
1054 	efi_get_variable_t *get_variable;
1055 	efi_get_next_variable_t *get_next_variable;
1056 	efi_set_variable_t *set_variable;
1057 	efi_set_variable_t *set_variable_nonblocking;
1058 	efi_query_variable_store_t *query_variable_store;
1059 	efi_query_variable_info_t *query_variable_info;
1060 };
1061 
1062 struct efivars {
1063 	struct kset *kset;
1064 	const struct efivar_operations *ops;
1065 };
1066 
1067 #ifdef CONFIG_X86
1068 u64 __attribute_const__ efivar_reserved_space(void);
1069 #else
1070 static inline u64 efivar_reserved_space(void) { return 0; }
1071 #endif
1072 
1073 /*
1074  * The maximum size of VariableName + Data = 1024
1075  * Therefore, it's reasonable to save that much
1076  * space in each part of the structure,
1077  * and we use a page for reading/writing.
1078  */
1079 
1080 #define EFI_VAR_NAME_LEN	1024
1081 
1082 int efivars_register(struct efivars *efivars,
1083 		     const struct efivar_operations *ops);
1084 int efivars_unregister(struct efivars *efivars);
1085 
1086 #ifdef CONFIG_EFI
1087 bool efivar_is_available(void);
1088 #else
1089 static inline bool efivar_is_available(void) { return false; }
1090 #endif
1091 
1092 bool efivar_supports_writes(void);
1093 
1094 int efivar_lock(void);
1095 int efivar_trylock(void);
1096 void efivar_unlock(void);
1097 
1098 efi_status_t efivar_get_variable(efi_char16_t *name, efi_guid_t *vendor,
1099 				 u32 *attr, unsigned long *size, void *data);
1100 
1101 efi_status_t efivar_get_next_variable(unsigned long *name_size,
1102 				      efi_char16_t *name, efi_guid_t *vendor);
1103 
1104 efi_status_t efivar_set_variable_locked(efi_char16_t *name, efi_guid_t *vendor,
1105 					u32 attr, unsigned long data_size,
1106 					void *data, bool nonblocking);
1107 
1108 efi_status_t efivar_set_variable(efi_char16_t *name, efi_guid_t *vendor,
1109 				 u32 attr, unsigned long data_size, void *data);
1110 
1111 efi_status_t efivar_query_variable_info(u32 attr, u64 *storage_space,
1112 					u64 *remaining_space,
1113 					u64 *max_variable_size);
1114 
1115 #if IS_ENABLED(CONFIG_EFI_CAPSULE_LOADER)
1116 extern bool efi_capsule_pending(int *reset_type);
1117 
1118 extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1119 				 size_t size, int *reset);
1120 
1121 extern int efi_capsule_update(efi_capsule_header_t *capsule,
1122 			      phys_addr_t *pages);
1123 #else
1124 static inline bool efi_capsule_pending(int *reset_type) { return false; }
1125 #endif
1126 
1127 #ifdef CONFIG_EFI
1128 extern bool efi_runtime_disabled(void);
1129 #else
1130 static inline bool efi_runtime_disabled(void) { return true; }
1131 #endif
1132 
1133 extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1134 extern unsigned long efi_call_virt_save_flags(void);
1135 
1136 enum efi_secureboot_mode {
1137 	efi_secureboot_mode_unset,
1138 	efi_secureboot_mode_unknown,
1139 	efi_secureboot_mode_disabled,
1140 	efi_secureboot_mode_enabled,
1141 };
1142 
1143 static inline
1144 enum efi_secureboot_mode efi_get_secureboot_mode(efi_get_variable_t *get_var)
1145 {
1146 	u8 secboot, setupmode = 0;
1147 	efi_status_t status;
1148 	unsigned long size;
1149 
1150 	size = sizeof(secboot);
1151 	status = get_var(L"SecureBoot", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size,
1152 			 &secboot);
1153 	if (status == EFI_NOT_FOUND)
1154 		return efi_secureboot_mode_disabled;
1155 	if (status != EFI_SUCCESS)
1156 		return efi_secureboot_mode_unknown;
1157 
1158 	size = sizeof(setupmode);
1159 	get_var(L"SetupMode", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size, &setupmode);
1160 	if (secboot == 0 || setupmode == 1)
1161 		return efi_secureboot_mode_disabled;
1162 	return efi_secureboot_mode_enabled;
1163 }
1164 
1165 #ifdef CONFIG_EFI_EMBEDDED_FIRMWARE
1166 void efi_check_for_embedded_firmwares(void);
1167 #else
1168 static inline void efi_check_for_embedded_firmwares(void) { }
1169 #endif
1170 
1171 #define arch_efi_call_virt(p, f, args...)	((p)->f(args))
1172 
1173 /*
1174  * Arch code can implement the following three template macros, avoiding
1175  * reptition for the void/non-void return cases of {__,}efi_call_virt():
1176  *
1177  *  * arch_efi_call_virt_setup()
1178  *
1179  *    Sets up the environment for the call (e.g. switching page tables,
1180  *    allowing kernel-mode use of floating point, if required).
1181  *
1182  *  * arch_efi_call_virt()
1183  *
1184  *    Performs the call. The last expression in the macro must be the call
1185  *    itself, allowing the logic to be shared by the void and non-void
1186  *    cases.
1187  *
1188  *  * arch_efi_call_virt_teardown()
1189  *
1190  *    Restores the usual kernel environment once the call has returned.
1191  */
1192 
1193 #define efi_call_virt_pointer(p, f, args...)				\
1194 ({									\
1195 	efi_status_t __s;						\
1196 	unsigned long __flags;						\
1197 									\
1198 	arch_efi_call_virt_setup();					\
1199 									\
1200 	__flags = efi_call_virt_save_flags();				\
1201 	__s = arch_efi_call_virt(p, f, args);				\
1202 	efi_call_virt_check_flags(__flags, __stringify(f));		\
1203 									\
1204 	arch_efi_call_virt_teardown();					\
1205 									\
1206 	__s;								\
1207 })
1208 
1209 #define __efi_call_virt_pointer(p, f, args...)				\
1210 ({									\
1211 	unsigned long __flags;						\
1212 									\
1213 	arch_efi_call_virt_setup();					\
1214 									\
1215 	__flags = efi_call_virt_save_flags();				\
1216 	arch_efi_call_virt(p, f, args);					\
1217 	efi_call_virt_check_flags(__flags, __stringify(f));		\
1218 									\
1219 	arch_efi_call_virt_teardown();					\
1220 })
1221 
1222 #define EFI_RANDOM_SEED_SIZE		32U // BLAKE2S_HASH_SIZE
1223 
1224 struct linux_efi_random_seed {
1225 	u32	size;
1226 	u8	bits[];
1227 };
1228 
1229 struct linux_efi_tpm_eventlog {
1230 	u32	size;
1231 	u32	final_events_preboot_size;
1232 	u8	version;
1233 	u8	log[];
1234 };
1235 
1236 extern int efi_tpm_eventlog_init(void);
1237 
1238 struct efi_tcg2_final_events_table {
1239 	u64 version;
1240 	u64 nr_events;
1241 	u8 events[];
1242 };
1243 extern int efi_tpm_final_log_size;
1244 
1245 extern unsigned long rci2_table_phys;
1246 
1247 /*
1248  * efi_runtime_service() function identifiers.
1249  * "NONE" is used by efi_recover_from_page_fault() to check if the page
1250  * fault happened while executing an efi runtime service.
1251  */
1252 enum efi_rts_ids {
1253 	EFI_NONE,
1254 	EFI_GET_TIME,
1255 	EFI_SET_TIME,
1256 	EFI_GET_WAKEUP_TIME,
1257 	EFI_SET_WAKEUP_TIME,
1258 	EFI_GET_VARIABLE,
1259 	EFI_GET_NEXT_VARIABLE,
1260 	EFI_SET_VARIABLE,
1261 	EFI_QUERY_VARIABLE_INFO,
1262 	EFI_GET_NEXT_HIGH_MONO_COUNT,
1263 	EFI_RESET_SYSTEM,
1264 	EFI_UPDATE_CAPSULE,
1265 	EFI_QUERY_CAPSULE_CAPS,
1266 };
1267 
1268 /*
1269  * efi_runtime_work:	Details of EFI Runtime Service work
1270  * @arg<1-5>:		EFI Runtime Service function arguments
1271  * @status:		Status of executing EFI Runtime Service
1272  * @efi_rts_id:		EFI Runtime Service function identifier
1273  * @efi_rts_comp:	Struct used for handling completions
1274  */
1275 struct efi_runtime_work {
1276 	void *arg1;
1277 	void *arg2;
1278 	void *arg3;
1279 	void *arg4;
1280 	void *arg5;
1281 	efi_status_t status;
1282 	struct work_struct work;
1283 	enum efi_rts_ids efi_rts_id;
1284 	struct completion efi_rts_comp;
1285 };
1286 
1287 extern struct efi_runtime_work efi_rts_work;
1288 
1289 /* Workqueue to queue EFI Runtime Services */
1290 extern struct workqueue_struct *efi_rts_wq;
1291 
1292 struct linux_efi_memreserve {
1293 	int		size;			// allocated size of the array
1294 	atomic_t	count;			// number of entries used
1295 	phys_addr_t	next;			// pa of next struct instance
1296 	struct {
1297 		phys_addr_t	base;
1298 		phys_addr_t	size;
1299 	} entry[];
1300 };
1301 
1302 #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1303 	/ sizeof_field(struct linux_efi_memreserve, entry[0]))
1304 
1305 void __init efi_arch_mem_reserve(phys_addr_t addr, u64 size);
1306 
1307 char *efi_systab_show_arch(char *str);
1308 
1309 /*
1310  * The LINUX_EFI_MOK_VARIABLE_TABLE_GUID config table can be provided
1311  * to the kernel by an EFI boot loader. The table contains a packed
1312  * sequence of these entries, one for each named MOK variable.
1313  * The sequence is terminated by an entry with a completely NULL
1314  * name and 0 data size.
1315  */
1316 struct efi_mokvar_table_entry {
1317 	char name[256];
1318 	u64 data_size;
1319 	u8 data[];
1320 } __attribute((packed));
1321 
1322 #ifdef CONFIG_LOAD_UEFI_KEYS
1323 extern void __init efi_mokvar_table_init(void);
1324 extern struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1325 			struct efi_mokvar_table_entry **mokvar_entry);
1326 extern struct efi_mokvar_table_entry *efi_mokvar_entry_find(const char *name);
1327 #else
1328 static inline void efi_mokvar_table_init(void) { }
1329 static inline struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1330 			struct efi_mokvar_table_entry **mokvar_entry)
1331 {
1332 	return NULL;
1333 }
1334 static inline struct efi_mokvar_table_entry *efi_mokvar_entry_find(
1335 			const char *name)
1336 {
1337 	return NULL;
1338 }
1339 #endif
1340 
1341 extern void efifb_setup_from_dmi(struct screen_info *si, const char *opt);
1342 
1343 struct linux_efi_coco_secret_area {
1344 	u64	base_pa;
1345 	u64	size;
1346 };
1347 
1348 struct linux_efi_initrd {
1349 	unsigned long	base;
1350 	unsigned long	size;
1351 };
1352 
1353 /* Header of a populated EFI secret area */
1354 #define EFI_SECRET_TABLE_HEADER_GUID	EFI_GUID(0x1e74f542, 0x71dd, 0x4d66,  0x96, 0x3e, 0xef, 0x42, 0x87, 0xff, 0x17, 0x3b)
1355 
1356 bool xen_efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table);
1357 
1358 static inline
1359 bool efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table)
1360 {
1361 	if (!IS_ENABLED(CONFIG_XEN_EFI))
1362 		return true;
1363 	return xen_efi_config_table_is_usable(guid, table);
1364 }
1365 
1366 umode_t efi_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n);
1367 
1368 #endif /* _LINUX_EFI_H */
1369