xref: /openbmc/linux/include/linux/efi.h (revision 4df933252827af69cb087e3df1294e4945a6f6c6)
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_ABORTED		(21 | (1UL << (BITS_PER_LONG-1)))
43 #define EFI_SECURITY_VIOLATION	(26 | (1UL << (BITS_PER_LONG-1)))
44 
45 typedef unsigned long efi_status_t;
46 typedef u8 efi_bool_t;
47 typedef u16 efi_char16_t;		/* UNICODE character */
48 typedef u64 efi_physical_addr_t;
49 typedef void *efi_handle_t;
50 
51 #if defined(CONFIG_X86_64)
52 #define __efiapi __attribute__((ms_abi))
53 #elif defined(CONFIG_X86_32)
54 #define __efiapi __attribute__((regparm(0)))
55 #else
56 #define __efiapi
57 #endif
58 
59 #define efi_get_handle_at(array, idx)					\
60 	(efi_is_native() ? (array)[idx] 				\
61 		: (efi_handle_t)(unsigned long)((u32 *)(array))[idx])
62 
63 #define efi_get_handle_num(size)					\
64 	((size) / (efi_is_native() ? sizeof(efi_handle_t) : sizeof(u32)))
65 
66 #define for_each_efi_handle(handle, array, size, i)			\
67 	for (i = 0;							\
68 	     i < efi_get_handle_num(size) &&				\
69 		((handle = efi_get_handle_at((array), i)) || true);	\
70 	     i++)
71 
72 /*
73  * The UEFI spec and EDK2 reference implementation both define EFI_GUID as
74  * struct { u32 a; u16; b; u16 c; u8 d[8]; }; and so the implied alignment
75  * is 32 bits not 8 bits like our guid_t. In some cases (i.e., on 32-bit ARM),
76  * this means that firmware services invoked by the kernel may assume that
77  * efi_guid_t* arguments are 32-bit aligned, and use memory accessors that
78  * do not tolerate misalignment. So let's set the minimum alignment to 32 bits.
79  *
80  * Note that the UEFI spec as well as some comments in the EDK2 code base
81  * suggest that EFI_GUID should be 64-bit aligned, but this appears to be
82  * a mistake, given that no code seems to exist that actually enforces that
83  * or relies on it.
84  */
85 typedef guid_t efi_guid_t __aligned(__alignof__(u32));
86 
87 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
88 	GUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)
89 
90 /*
91  * Generic EFI table header
92  */
93 typedef	struct {
94 	u64 signature;
95 	u32 revision;
96 	u32 headersize;
97 	u32 crc32;
98 	u32 reserved;
99 } efi_table_hdr_t;
100 
101 /*
102  * Memory map descriptor:
103  */
104 
105 /* Memory types: */
106 #define EFI_RESERVED_TYPE		 0
107 #define EFI_LOADER_CODE			 1
108 #define EFI_LOADER_DATA			 2
109 #define EFI_BOOT_SERVICES_CODE		 3
110 #define EFI_BOOT_SERVICES_DATA		 4
111 #define EFI_RUNTIME_SERVICES_CODE	 5
112 #define EFI_RUNTIME_SERVICES_DATA	 6
113 #define EFI_CONVENTIONAL_MEMORY		 7
114 #define EFI_UNUSABLE_MEMORY		 8
115 #define EFI_ACPI_RECLAIM_MEMORY		 9
116 #define EFI_ACPI_MEMORY_NVS		10
117 #define EFI_MEMORY_MAPPED_IO		11
118 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE	12
119 #define EFI_PAL_CODE			13
120 #define EFI_PERSISTENT_MEMORY		14
121 #define EFI_MAX_MEMORY_TYPE		15
122 
123 /* Attribute values: */
124 #define EFI_MEMORY_UC		((u64)0x0000000000000001ULL)	/* uncached */
125 #define EFI_MEMORY_WC		((u64)0x0000000000000002ULL)	/* write-coalescing */
126 #define EFI_MEMORY_WT		((u64)0x0000000000000004ULL)	/* write-through */
127 #define EFI_MEMORY_WB		((u64)0x0000000000000008ULL)	/* write-back */
128 #define EFI_MEMORY_UCE		((u64)0x0000000000000010ULL)	/* uncached, exported */
129 #define EFI_MEMORY_WP		((u64)0x0000000000001000ULL)	/* write-protect */
130 #define EFI_MEMORY_RP		((u64)0x0000000000002000ULL)	/* read-protect */
131 #define EFI_MEMORY_XP		((u64)0x0000000000004000ULL)	/* execute-protect */
132 #define EFI_MEMORY_NV		((u64)0x0000000000008000ULL)	/* non-volatile */
133 #define EFI_MEMORY_MORE_RELIABLE \
134 				((u64)0x0000000000010000ULL)	/* higher reliability */
135 #define EFI_MEMORY_RO		((u64)0x0000000000020000ULL)	/* read-only */
136 #define EFI_MEMORY_SP		((u64)0x0000000000040000ULL)	/* soft reserved */
137 #define EFI_MEMORY_RUNTIME	((u64)0x8000000000000000ULL)	/* range requires runtime mapping */
138 #define EFI_MEMORY_DESCRIPTOR_VERSION	1
139 
140 #define EFI_PAGE_SHIFT		12
141 #define EFI_PAGE_SIZE		(1UL << EFI_PAGE_SHIFT)
142 #define EFI_PAGES_MAX		(U64_MAX >> EFI_PAGE_SHIFT)
143 
144 typedef struct {
145 	u32 type;
146 	u32 pad;
147 	u64 phys_addr;
148 	u64 virt_addr;
149 	u64 num_pages;
150 	u64 attribute;
151 } efi_memory_desc_t;
152 
153 typedef struct {
154 	efi_guid_t guid;
155 	u32 headersize;
156 	u32 flags;
157 	u32 imagesize;
158 } efi_capsule_header_t;
159 
160 struct efi_boot_memmap {
161 	efi_memory_desc_t	**map;
162 	unsigned long		*map_size;
163 	unsigned long		*desc_size;
164 	u32			*desc_ver;
165 	unsigned long		*key_ptr;
166 	unsigned long		*buff_size;
167 };
168 
169 /*
170  * EFI capsule flags
171  */
172 #define EFI_CAPSULE_PERSIST_ACROSS_RESET	0x00010000
173 #define EFI_CAPSULE_POPULATE_SYSTEM_TABLE	0x00020000
174 #define EFI_CAPSULE_INITIATE_RESET		0x00040000
175 
176 struct capsule_info {
177 	efi_capsule_header_t	header;
178 	efi_capsule_header_t	*capsule;
179 	int			reset_type;
180 	long			index;
181 	size_t			count;
182 	size_t			total_size;
183 	struct page		**pages;
184 	phys_addr_t		*phys;
185 	size_t			page_bytes_remain;
186 };
187 
188 int __efi_capsule_setup_info(struct capsule_info *cap_info);
189 
190 /*
191  * Allocation types for calls to boottime->allocate_pages.
192  */
193 #define EFI_ALLOCATE_ANY_PAGES		0
194 #define EFI_ALLOCATE_MAX_ADDRESS	1
195 #define EFI_ALLOCATE_ADDRESS		2
196 #define EFI_MAX_ALLOCATE_TYPE		3
197 
198 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
199 
200 /*
201  * Types and defines for Time Services
202  */
203 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
204 #define EFI_TIME_IN_DAYLIGHT     0x2
205 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
206 
207 typedef struct {
208 	u16 year;
209 	u8 month;
210 	u8 day;
211 	u8 hour;
212 	u8 minute;
213 	u8 second;
214 	u8 pad1;
215 	u32 nanosecond;
216 	s16 timezone;
217 	u8 daylight;
218 	u8 pad2;
219 } efi_time_t;
220 
221 typedef struct {
222 	u32 resolution;
223 	u32 accuracy;
224 	u8 sets_to_zero;
225 } efi_time_cap_t;
226 
227 typedef struct {
228 	efi_table_hdr_t hdr;
229 	u32 raise_tpl;
230 	u32 restore_tpl;
231 	u32 allocate_pages;
232 	u32 free_pages;
233 	u32 get_memory_map;
234 	u32 allocate_pool;
235 	u32 free_pool;
236 	u32 create_event;
237 	u32 set_timer;
238 	u32 wait_for_event;
239 	u32 signal_event;
240 	u32 close_event;
241 	u32 check_event;
242 	u32 install_protocol_interface;
243 	u32 reinstall_protocol_interface;
244 	u32 uninstall_protocol_interface;
245 	u32 handle_protocol;
246 	u32 __reserved;
247 	u32 register_protocol_notify;
248 	u32 locate_handle;
249 	u32 locate_device_path;
250 	u32 install_configuration_table;
251 	u32 load_image;
252 	u32 start_image;
253 	u32 exit;
254 	u32 unload_image;
255 	u32 exit_boot_services;
256 	u32 get_next_monotonic_count;
257 	u32 stall;
258 	u32 set_watchdog_timer;
259 	u32 connect_controller;
260 	u32 disconnect_controller;
261 	u32 open_protocol;
262 	u32 close_protocol;
263 	u32 open_protocol_information;
264 	u32 protocols_per_handle;
265 	u32 locate_handle_buffer;
266 	u32 locate_protocol;
267 	u32 install_multiple_protocol_interfaces;
268 	u32 uninstall_multiple_protocol_interfaces;
269 	u32 calculate_crc32;
270 	u32 copy_mem;
271 	u32 set_mem;
272 	u32 create_event_ex;
273 } __packed efi_boot_services_32_t;
274 
275 /*
276  * EFI Boot Services table
277  */
278 typedef union {
279 	struct {
280 		efi_table_hdr_t hdr;
281 		void *raise_tpl;
282 		void *restore_tpl;
283 		efi_status_t (__efiapi *allocate_pages)(int, int, unsigned long,
284 							efi_physical_addr_t *);
285 		efi_status_t (__efiapi *free_pages)(efi_physical_addr_t,
286 						    unsigned long);
287 		efi_status_t (__efiapi *get_memory_map)(unsigned long *, void *,
288 							unsigned long *,
289 							unsigned long *, u32 *);
290 		efi_status_t (__efiapi *allocate_pool)(int, unsigned long,
291 						       void **);
292 		efi_status_t (__efiapi *free_pool)(void *);
293 		void *create_event;
294 		void *set_timer;
295 		void *wait_for_event;
296 		void *signal_event;
297 		void *close_event;
298 		void *check_event;
299 		void *install_protocol_interface;
300 		void *reinstall_protocol_interface;
301 		void *uninstall_protocol_interface;
302 		efi_status_t (__efiapi *handle_protocol)(efi_handle_t,
303 							 efi_guid_t *, void **);
304 		void *__reserved;
305 		void *register_protocol_notify;
306 		efi_status_t (__efiapi *locate_handle)(int, efi_guid_t *,
307 						       void *, unsigned long *,
308 						       efi_handle_t *);
309 		void *locate_device_path;
310 		efi_status_t (__efiapi *install_configuration_table)(efi_guid_t *,
311 								     void *);
312 		void *load_image;
313 		void *start_image;
314 		void *exit;
315 		void *unload_image;
316 		efi_status_t (__efiapi *exit_boot_services)(efi_handle_t,
317 							    unsigned long);
318 		void *get_next_monotonic_count;
319 		void *stall;
320 		void *set_watchdog_timer;
321 		void *connect_controller;
322 		efi_status_t (__efiapi *disconnect_controller)(efi_handle_t,
323 							       efi_handle_t,
324 							       efi_handle_t);
325 		void *open_protocol;
326 		void *close_protocol;
327 		void *open_protocol_information;
328 		void *protocols_per_handle;
329 		void *locate_handle_buffer;
330 		efi_status_t (__efiapi *locate_protocol)(efi_guid_t *, void *,
331 							 void **);
332 		void *install_multiple_protocol_interfaces;
333 		void *uninstall_multiple_protocol_interfaces;
334 		void *calculate_crc32;
335 		void *copy_mem;
336 		void *set_mem;
337 		void *create_event_ex;
338 	};
339 	efi_boot_services_32_t mixed_mode;
340 } efi_boot_services_t;
341 
342 typedef enum {
343 	EfiPciIoWidthUint8,
344 	EfiPciIoWidthUint16,
345 	EfiPciIoWidthUint32,
346 	EfiPciIoWidthUint64,
347 	EfiPciIoWidthFifoUint8,
348 	EfiPciIoWidthFifoUint16,
349 	EfiPciIoWidthFifoUint32,
350 	EfiPciIoWidthFifoUint64,
351 	EfiPciIoWidthFillUint8,
352 	EfiPciIoWidthFillUint16,
353 	EfiPciIoWidthFillUint32,
354 	EfiPciIoWidthFillUint64,
355 	EfiPciIoWidthMaximum
356 } EFI_PCI_IO_PROTOCOL_WIDTH;
357 
358 typedef enum {
359 	EfiPciIoAttributeOperationGet,
360 	EfiPciIoAttributeOperationSet,
361 	EfiPciIoAttributeOperationEnable,
362 	EfiPciIoAttributeOperationDisable,
363 	EfiPciIoAttributeOperationSupported,
364     EfiPciIoAttributeOperationMaximum
365 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
366 
367 typedef struct {
368 	u32 read;
369 	u32 write;
370 } efi_pci_io_protocol_access_32_t;
371 
372 typedef union efi_pci_io_protocol efi_pci_io_protocol_t;
373 
374 typedef
375 efi_status_t (__efiapi *efi_pci_io_protocol_cfg_t)(efi_pci_io_protocol_t *,
376 						   EFI_PCI_IO_PROTOCOL_WIDTH,
377 						   u32 offset,
378 						   unsigned long count,
379 						   void *buffer);
380 
381 typedef struct {
382 	void *read;
383 	void *write;
384 } efi_pci_io_protocol_access_t;
385 
386 typedef struct {
387 	efi_pci_io_protocol_cfg_t read;
388 	efi_pci_io_protocol_cfg_t write;
389 } efi_pci_io_protocol_config_access_t;
390 
391 union efi_pci_io_protocol {
392 	struct {
393 		void *poll_mem;
394 		void *poll_io;
395 		efi_pci_io_protocol_access_t mem;
396 		efi_pci_io_protocol_access_t io;
397 		efi_pci_io_protocol_config_access_t pci;
398 		void *copy_mem;
399 		void *map;
400 		void *unmap;
401 		void *allocate_buffer;
402 		void *free_buffer;
403 		void *flush;
404 		efi_status_t (__efiapi *get_location)(efi_pci_io_protocol_t *,
405 						      unsigned long *segment_nr,
406 						      unsigned long *bus_nr,
407 						      unsigned long *device_nr,
408 						      unsigned long *func_nr);
409 		void *attributes;
410 		void *get_bar_attributes;
411 		void *set_bar_attributes;
412 		uint64_t romsize;
413 		void *romimage;
414 	};
415 	struct {
416 		u32 poll_mem;
417 		u32 poll_io;
418 		efi_pci_io_protocol_access_32_t mem;
419 		efi_pci_io_protocol_access_32_t io;
420 		efi_pci_io_protocol_access_32_t pci;
421 		u32 copy_mem;
422 		u32 map;
423 		u32 unmap;
424 		u32 allocate_buffer;
425 		u32 free_buffer;
426 		u32 flush;
427 		u32 get_location;
428 		u32 attributes;
429 		u32 get_bar_attributes;
430 		u32 set_bar_attributes;
431 		u64 romsize;
432 		u32 romimage;
433 	} mixed_mode;
434 };
435 
436 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
437 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
438 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
439 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
440 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
441 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
442 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
443 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
444 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
445 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
446 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
447 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
448 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
449 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
450 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
451 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
452 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
453 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
454 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
455 
456 struct efi_dev_path;
457 
458 typedef union apple_properties_protocol apple_properties_protocol_t;
459 
460 union apple_properties_protocol {
461 	struct {
462 		unsigned long version;
463 		efi_status_t (__efiapi *get)(apple_properties_protocol_t *,
464 					     struct efi_dev_path *,
465 					     efi_char16_t *, void *, u32 *);
466 		efi_status_t (__efiapi *set)(apple_properties_protocol_t *,
467 					     struct efi_dev_path *,
468 					     efi_char16_t *, void *, u32);
469 		efi_status_t (__efiapi *del)(apple_properties_protocol_t *,
470 					     struct efi_dev_path *,
471 					     efi_char16_t *);
472 		efi_status_t (__efiapi *get_all)(apple_properties_protocol_t *,
473 						 void *buffer, u32 *);
474 	};
475 	struct {
476 		u32 version;
477 		u32 get;
478 		u32 set;
479 		u32 del;
480 		u32 get_all;
481 	} mixed_mode;
482 };
483 
484 typedef u32 efi_tcg2_event_log_format;
485 
486 typedef union efi_tcg2_protocol efi_tcg2_protocol_t;
487 
488 union efi_tcg2_protocol {
489 	struct {
490 		void *get_capability;
491 		efi_status_t (__efiapi *get_event_log)(efi_handle_t,
492 						       efi_tcg2_event_log_format,
493 						       efi_physical_addr_t *,
494 						       efi_physical_addr_t *,
495 						       efi_bool_t *);
496 		void *hash_log_extend_event;
497 		void *submit_command;
498 		void *get_active_pcr_banks;
499 		void *set_active_pcr_banks;
500 		void *get_result_of_set_active_pcr_banks;
501 	};
502 	struct {
503 		u32 get_capability;
504 		u32 get_event_log;
505 		u32 hash_log_extend_event;
506 		u32 submit_command;
507 		u32 get_active_pcr_banks;
508 		u32 set_active_pcr_banks;
509 		u32 get_result_of_set_active_pcr_banks;
510 	} mixed_mode;
511 };
512 
513 /*
514  * Types and defines for EFI ResetSystem
515  */
516 #define EFI_RESET_COLD 0
517 #define EFI_RESET_WARM 1
518 #define EFI_RESET_SHUTDOWN 2
519 
520 /*
521  * EFI Runtime Services table
522  */
523 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
524 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
525 
526 typedef struct {
527 	efi_table_hdr_t hdr;
528 	u32 get_time;
529 	u32 set_time;
530 	u32 get_wakeup_time;
531 	u32 set_wakeup_time;
532 	u32 set_virtual_address_map;
533 	u32 convert_pointer;
534 	u32 get_variable;
535 	u32 get_next_variable;
536 	u32 set_variable;
537 	u32 get_next_high_mono_count;
538 	u32 reset_system;
539 	u32 update_capsule;
540 	u32 query_capsule_caps;
541 	u32 query_variable_info;
542 } efi_runtime_services_32_t;
543 
544 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
545 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
546 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
547 					    efi_time_t *tm);
548 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
549 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
550 					 unsigned long *data_size, void *data);
551 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
552 					      efi_guid_t *vendor);
553 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
554 					 u32 attr, unsigned long data_size,
555 					 void *data);
556 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
557 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
558 				 unsigned long data_size, efi_char16_t *data);
559 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
560 						unsigned long descriptor_size,
561 						u32 descriptor_version,
562 						efi_memory_desc_t *virtual_map);
563 typedef efi_status_t efi_query_variable_info_t(u32 attr,
564 					       u64 *storage_space,
565 					       u64 *remaining_space,
566 					       u64 *max_variable_size);
567 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
568 					  unsigned long count,
569 					  unsigned long sg_list);
570 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
571 					      unsigned long count,
572 					      u64 *max_size,
573 					      int *reset_type);
574 typedef efi_status_t efi_query_variable_store_t(u32 attributes,
575 						unsigned long size,
576 						bool nonblocking);
577 
578 typedef union {
579 	struct {
580 		efi_table_hdr_t				hdr;
581 		efi_get_time_t __efiapi			*get_time;
582 		efi_set_time_t __efiapi			*set_time;
583 		efi_get_wakeup_time_t __efiapi		*get_wakeup_time;
584 		efi_set_wakeup_time_t __efiapi		*set_wakeup_time;
585 		efi_set_virtual_address_map_t __efiapi	*set_virtual_address_map;
586 		void					*convert_pointer;
587 		efi_get_variable_t __efiapi		*get_variable;
588 		efi_get_next_variable_t __efiapi	*get_next_variable;
589 		efi_set_variable_t __efiapi		*set_variable;
590 		efi_get_next_high_mono_count_t __efiapi	*get_next_high_mono_count;
591 		efi_reset_system_t __efiapi		*reset_system;
592 		efi_update_capsule_t __efiapi		*update_capsule;
593 		efi_query_capsule_caps_t __efiapi	*query_capsule_caps;
594 		efi_query_variable_info_t __efiapi	*query_variable_info;
595 	};
596 	efi_runtime_services_32_t mixed_mode;
597 } efi_runtime_services_t;
598 
599 void efi_native_runtime_setup(void);
600 
601 /*
602  * EFI Configuration Table and GUID definitions
603  *
604  * These are all defined in a single line to make them easier to
605  * grep for and to see them at a glance - while still having a
606  * similar structure to the definitions in the spec.
607  *
608  * Here's how they are structured:
609  *
610  * GUID: 12345678-1234-1234-1234-123456789012
611  * Spec:
612  *      #define EFI_SOME_PROTOCOL_GUID \
613  *        {0x12345678,0x1234,0x1234,\
614  *          {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
615  * Here:
616  *	#define SOME_PROTOCOL_GUID		EFI_GUID(0x12345678, 0x1234, 0x1234,  0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
617  *					^ tabs					    ^extra space
618  *
619  * Note that the 'extra space' separates the values at the same place
620  * where the UEFI SPEC breaks the line.
621  */
622 #define NULL_GUID				EFI_GUID(0x00000000, 0x0000, 0x0000,  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
623 #define MPS_TABLE_GUID				EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
624 #define ACPI_TABLE_GUID				EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
625 #define ACPI_20_TABLE_GUID			EFI_GUID(0x8868e871, 0xe4f1, 0x11d3,  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
626 #define SMBIOS_TABLE_GUID			EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
627 #define SMBIOS3_TABLE_GUID			EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c,  0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
628 #define SAL_SYSTEM_TABLE_GUID			EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
629 #define HCDP_TABLE_GUID				EFI_GUID(0xf951938d, 0x620b, 0x42ef,  0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
630 #define UGA_IO_PROTOCOL_GUID			EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b,  0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
631 #define EFI_GLOBAL_VARIABLE_GUID		EFI_GUID(0x8be4df61, 0x93ca, 0x11d2,  0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
632 #define UV_SYSTEM_TABLE_GUID			EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd,  0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
633 #define LINUX_EFI_CRASH_GUID			EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc,  0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
634 #define LOADED_IMAGE_PROTOCOL_GUID		EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
635 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID	EFI_GUID(0x9042a9de, 0x23dc, 0x4a38,  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
636 #define EFI_UGA_PROTOCOL_GUID			EFI_GUID(0x982c298b, 0xf4fa, 0x41cb,  0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
637 #define EFI_PCI_IO_PROTOCOL_GUID		EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5,  0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
638 #define EFI_FILE_INFO_ID			EFI_GUID(0x09576e92, 0x6d3f, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
639 #define EFI_SYSTEM_RESOURCE_TABLE_GUID		EFI_GUID(0xb122a263, 0x3661, 0x4f68,  0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
640 #define EFI_FILE_SYSTEM_GUID			EFI_GUID(0x964e5b22, 0x6459, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
641 #define DEVICE_TREE_GUID			EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5,  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
642 #define EFI_PROPERTIES_TABLE_GUID		EFI_GUID(0x880aaca3, 0x4adc, 0x4a04,  0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
643 #define EFI_RNG_PROTOCOL_GUID			EFI_GUID(0x3152bca5, 0xeade, 0x433d,  0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
644 #define EFI_RNG_ALGORITHM_RAW			EFI_GUID(0xe43176d7, 0xb6e8, 0x4827,  0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
645 #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID	EFI_GUID(0xdcfa911d, 0x26eb, 0x469f,  0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
646 #define EFI_CONSOLE_OUT_DEVICE_GUID		EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4,  0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
647 #define APPLE_PROPERTIES_PROTOCOL_GUID		EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb,  0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
648 #define EFI_TCG2_PROTOCOL_GUID			EFI_GUID(0x607f766c, 0x7455, 0x42be,  0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
649 
650 #define EFI_IMAGE_SECURITY_DATABASE_GUID	EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596,  0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
651 #define EFI_SHIM_LOCK_GUID			EFI_GUID(0x605dab50, 0xe046, 0x4300,  0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
652 
653 #define EFI_CERT_SHA256_GUID			EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
654 #define EFI_CERT_X509_GUID			EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
655 #define EFI_CERT_X509_SHA256_GUID		EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
656 
657 /*
658  * This GUID is used to pass to the kernel proper the struct screen_info
659  * structure that was populated by the stub based on the GOP protocol instance
660  * associated with ConOut
661  */
662 #define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID	EFI_GUID(0xe03fc20a, 0x85dc, 0x406e,  0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
663 #define LINUX_EFI_LOADER_ENTRY_GUID		EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf,  0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
664 #define LINUX_EFI_RANDOM_SEED_TABLE_GUID	EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2,  0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
665 #define LINUX_EFI_TPM_EVENT_LOG_GUID		EFI_GUID(0xb7799cb0, 0xeca2, 0x4943,  0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
666 #define LINUX_EFI_TPM_FINAL_LOG_GUID		EFI_GUID(0x1e2ed096, 0x30e2, 0x4254,  0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
667 #define LINUX_EFI_MEMRESERVE_TABLE_GUID		EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5,  0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
668 
669 /* OEM GUIDs */
670 #define DELLEMC_EFI_RCI2_TABLE_GUID		EFI_GUID(0x2d9f28a2, 0xa886, 0x456a,  0x97, 0xa8, 0xf1, 0x1e, 0xf2, 0x4f, 0xf4, 0x55)
671 
672 typedef struct {
673 	efi_guid_t guid;
674 	u64 table;
675 } efi_config_table_64_t;
676 
677 typedef struct {
678 	efi_guid_t guid;
679 	u32 table;
680 } efi_config_table_32_t;
681 
682 typedef union {
683 	struct {
684 		efi_guid_t guid;
685 		void *table;
686 	};
687 	efi_config_table_32_t mixed_mode;
688 } efi_config_table_t;
689 
690 typedef struct {
691 	efi_guid_t guid;
692 	const char *name;
693 	unsigned long *ptr;
694 } efi_config_table_type_t;
695 
696 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
697 
698 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
699 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
700 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
701 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
702 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
703 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
704 
705 typedef struct {
706 	efi_table_hdr_t hdr;
707 	u64 fw_vendor;	/* physical addr of CHAR16 vendor string */
708 	u32 fw_revision;
709 	u32 __pad1;
710 	u64 con_in_handle;
711 	u64 con_in;
712 	u64 con_out_handle;
713 	u64 con_out;
714 	u64 stderr_handle;
715 	u64 stderr;
716 	u64 runtime;
717 	u64 boottime;
718 	u32 nr_tables;
719 	u32 __pad2;
720 	u64 tables;
721 } efi_system_table_64_t;
722 
723 typedef struct {
724 	efi_table_hdr_t hdr;
725 	u32 fw_vendor;	/* physical addr of CHAR16 vendor string */
726 	u32 fw_revision;
727 	u32 con_in_handle;
728 	u32 con_in;
729 	u32 con_out_handle;
730 	u32 con_out;
731 	u32 stderr_handle;
732 	u32 stderr;
733 	u32 runtime;
734 	u32 boottime;
735 	u32 nr_tables;
736 	u32 tables;
737 } efi_system_table_32_t;
738 
739 typedef union efi_simple_text_output_protocol efi_simple_text_output_protocol_t;
740 
741 typedef union {
742 	struct {
743 		efi_table_hdr_t hdr;
744 		unsigned long fw_vendor;	/* physical addr of CHAR16 vendor string */
745 		u32 fw_revision;
746 		unsigned long con_in_handle;
747 		unsigned long con_in;
748 		unsigned long con_out_handle;
749 		efi_simple_text_output_protocol_t *con_out;
750 		unsigned long stderr_handle;
751 		unsigned long stderr;
752 		efi_runtime_services_t *runtime;
753 		efi_boot_services_t *boottime;
754 		unsigned long nr_tables;
755 		unsigned long tables;
756 	};
757 	efi_system_table_32_t mixed_mode;
758 } efi_system_table_t;
759 
760 /*
761  * Architecture independent structure for describing a memory map for the
762  * benefit of efi_memmap_init_early(), and for passing context between
763  * efi_memmap_alloc() and efi_memmap_install().
764  */
765 struct efi_memory_map_data {
766 	phys_addr_t phys_map;
767 	unsigned long size;
768 	unsigned long desc_version;
769 	unsigned long desc_size;
770 	unsigned long flags;
771 };
772 
773 struct efi_memory_map {
774 	phys_addr_t phys_map;
775 	void *map;
776 	void *map_end;
777 	int nr_map;
778 	unsigned long desc_version;
779 	unsigned long desc_size;
780 #define EFI_MEMMAP_LATE (1UL << 0)
781 #define EFI_MEMMAP_MEMBLOCK (1UL << 1)
782 #define EFI_MEMMAP_SLAB (1UL << 2)
783 	unsigned long flags;
784 };
785 
786 struct efi_mem_range {
787 	struct range range;
788 	u64 attribute;
789 };
790 
791 struct efi_fdt_params {
792 	u64 system_table;
793 	u64 mmap;
794 	u32 mmap_size;
795 	u32 desc_size;
796 	u32 desc_ver;
797 };
798 
799 typedef struct {
800 	u32 revision;
801 	efi_handle_t parent_handle;
802 	efi_system_table_t *system_table;
803 	efi_handle_t device_handle;
804 	void *file_path;
805 	void *reserved;
806 	u32 load_options_size;
807 	void *load_options;
808 	void *image_base;
809 	__aligned_u64 image_size;
810 	unsigned int image_code_type;
811 	unsigned int image_data_type;
812 	efi_status_t ( __efiapi *unload)(efi_handle_t image_handle);
813 } efi_loaded_image_t;
814 
815 typedef struct {
816 	u64 size;
817 	u64 file_size;
818 	u64 phys_size;
819 	efi_time_t create_time;
820 	efi_time_t last_access_time;
821 	efi_time_t modification_time;
822 	__aligned_u64 attribute;
823 	efi_char16_t filename[1];
824 } efi_file_info_t;
825 
826 typedef struct efi_file_handle efi_file_handle_t;
827 
828 struct efi_file_handle {
829 	u64 revision;
830 	efi_status_t (__efiapi *open)(efi_file_handle_t *,
831 				      efi_file_handle_t **,
832 				      efi_char16_t *, u64, u64);
833 	efi_status_t (__efiapi *close)(efi_file_handle_t *);
834 	void *delete;
835 	efi_status_t (__efiapi *read)(efi_file_handle_t *,
836 				      unsigned long *, void *);
837 	void *write;
838 	void *get_position;
839 	void *set_position;
840 	efi_status_t (__efiapi *get_info)(efi_file_handle_t *,
841 					  efi_guid_t *, unsigned long *,
842 					  void *);
843 	void *set_info;
844 	void *flush;
845 };
846 
847 typedef struct efi_file_io_interface efi_file_io_interface_t;
848 
849 struct efi_file_io_interface {
850 	u64 revision;
851 	int (__efiapi *open_volume)(efi_file_io_interface_t *,
852 				    efi_file_handle_t **);
853 };
854 
855 #define EFI_FILE_MODE_READ	0x0000000000000001
856 #define EFI_FILE_MODE_WRITE	0x0000000000000002
857 #define EFI_FILE_MODE_CREATE	0x8000000000000000
858 
859 typedef struct {
860 	u32 version;
861 	u32 length;
862 	u64 memory_protection_attribute;
863 } efi_properties_table_t;
864 
865 #define EFI_PROPERTIES_TABLE_VERSION	0x00010000
866 #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA	0x1
867 
868 #define EFI_INVALID_TABLE_ADDR		(~0UL)
869 
870 typedef struct {
871 	u32 version;
872 	u32 num_entries;
873 	u32 desc_size;
874 	u32 reserved;
875 	efi_memory_desc_t entry[0];
876 } efi_memory_attributes_table_t;
877 
878 typedef struct {
879 	efi_guid_t signature_owner;
880 	u8 signature_data[];
881 } efi_signature_data_t;
882 
883 typedef struct {
884 	efi_guid_t signature_type;
885 	u32 signature_list_size;
886 	u32 signature_header_size;
887 	u32 signature_size;
888 	u8 signature_header[];
889 	/* efi_signature_data_t signatures[][] */
890 } efi_signature_list_t;
891 
892 typedef u8 efi_sha256_hash_t[32];
893 
894 typedef struct {
895 	efi_sha256_hash_t to_be_signed_hash;
896 	efi_time_t time_of_revocation;
897 } efi_cert_x509_sha256_t;
898 
899 /*
900  * All runtime access to EFI goes through this structure:
901  */
902 extern struct efi {
903 	efi_system_table_t *systab;	/* EFI system table */
904 	unsigned int runtime_version;	/* Runtime services version */
905 	unsigned long mps;		/* MPS table */
906 	unsigned long acpi;		/* ACPI table  (IA64 ext 0.71) */
907 	unsigned long acpi20;		/* ACPI table  (ACPI 2.0) */
908 	unsigned long smbios;		/* SMBIOS table (32 bit entry point) */
909 	unsigned long smbios3;		/* SMBIOS table (64 bit entry point) */
910 	unsigned long boot_info;	/* boot info table */
911 	unsigned long hcdp;		/* HCDP table */
912 	unsigned long uga;		/* UGA table */
913 	unsigned long fw_vendor;	/* fw_vendor */
914 	unsigned long runtime;		/* runtime table */
915 	unsigned long config_table;	/* config tables */
916 	unsigned long esrt;		/* ESRT table */
917 	unsigned long properties_table;	/* properties table */
918 	unsigned long mem_attr_table;	/* memory attributes table */
919 	unsigned long rng_seed;		/* UEFI firmware random seed */
920 	unsigned long tpm_log;		/* TPM2 Event Log table */
921 	unsigned long tpm_final_log;	/* TPM2 Final Events Log table */
922 	unsigned long mem_reserve;	/* Linux EFI memreserve table */
923 	efi_get_time_t *get_time;
924 	efi_set_time_t *set_time;
925 	efi_get_wakeup_time_t *get_wakeup_time;
926 	efi_set_wakeup_time_t *set_wakeup_time;
927 	efi_get_variable_t *get_variable;
928 	efi_get_next_variable_t *get_next_variable;
929 	efi_set_variable_t *set_variable;
930 	efi_set_variable_t *set_variable_nonblocking;
931 	efi_query_variable_info_t *query_variable_info;
932 	efi_query_variable_info_t *query_variable_info_nonblocking;
933 	efi_update_capsule_t *update_capsule;
934 	efi_query_capsule_caps_t *query_capsule_caps;
935 	efi_get_next_high_mono_count_t *get_next_high_mono_count;
936 	efi_reset_system_t *reset_system;
937 	struct efi_memory_map memmap;
938 	unsigned long flags;
939 } efi;
940 
941 extern struct mm_struct efi_mm;
942 
943 static inline int
944 efi_guidcmp (efi_guid_t left, efi_guid_t right)
945 {
946 	return memcmp(&left, &right, sizeof (efi_guid_t));
947 }
948 
949 static inline char *
950 efi_guid_to_str(efi_guid_t *guid, char *out)
951 {
952 	sprintf(out, "%pUl", guid->b);
953         return out;
954 }
955 
956 extern void efi_init (void);
957 extern void *efi_get_pal_addr (void);
958 extern void efi_map_pal_code (void);
959 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
960 extern void efi_gettimeofday (struct timespec64 *ts);
961 extern void efi_enter_virtual_mode (void);	/* switch EFI to virtual mode, if possible */
962 #ifdef CONFIG_X86
963 extern efi_status_t efi_query_variable_store(u32 attributes,
964 					     unsigned long size,
965 					     bool nonblocking);
966 #else
967 
968 static inline efi_status_t efi_query_variable_store(u32 attributes,
969 						    unsigned long size,
970 						    bool nonblocking)
971 {
972 	return EFI_SUCCESS;
973 }
974 #endif
975 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
976 
977 extern int __init efi_memmap_alloc(unsigned int num_entries,
978 				   struct efi_memory_map_data *data);
979 extern void __efi_memmap_free(u64 phys, unsigned long size,
980 			      unsigned long flags);
981 extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
982 extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
983 extern void __init efi_memmap_unmap(void);
984 extern int __init efi_memmap_install(struct efi_memory_map_data *data);
985 extern int __init efi_memmap_split_count(efi_memory_desc_t *md,
986 					 struct range *range);
987 extern void __init efi_memmap_insert(struct efi_memory_map *old_memmap,
988 				     void *buf, struct efi_mem_range *mem);
989 
990 extern int efi_config_init(efi_config_table_type_t *arch_tables);
991 #ifdef CONFIG_EFI_ESRT
992 extern void __init efi_esrt_init(void);
993 #else
994 static inline void efi_esrt_init(void) { }
995 #endif
996 extern int efi_config_parse_tables(void *config_tables, int count, int sz,
997 				   efi_config_table_type_t *arch_tables);
998 extern u64 efi_get_iobase (void);
999 extern int efi_mem_type(unsigned long phys_addr);
1000 extern u64 efi_mem_attributes (unsigned long phys_addr);
1001 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
1002 extern int __init efi_uart_console_only (void);
1003 extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
1004 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
1005 extern void efi_mem_reserve(phys_addr_t addr, u64 size);
1006 extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size);
1007 extern void efi_initialize_iomem_resources(struct resource *code_resource,
1008 		struct resource *data_resource, struct resource *bss_resource);
1009 extern int efi_get_fdt_params(struct efi_fdt_params *params);
1010 extern struct kobject *efi_kobj;
1011 
1012 extern int efi_reboot_quirk_mode;
1013 extern bool efi_poweroff_required(void);
1014 
1015 #ifdef CONFIG_EFI_FAKE_MEMMAP
1016 extern void __init efi_fake_memmap(void);
1017 #else
1018 static inline void efi_fake_memmap(void) { }
1019 #endif
1020 
1021 /*
1022  * efi_memattr_perm_setter - arch specific callback function passed into
1023  *                           efi_memattr_apply_permissions() that updates the
1024  *                           mapping permissions described by the second
1025  *                           argument in the page tables referred to by the
1026  *                           first argument.
1027  */
1028 typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *);
1029 
1030 extern int efi_memattr_init(void);
1031 extern int efi_memattr_apply_permissions(struct mm_struct *mm,
1032 					 efi_memattr_perm_setter fn);
1033 
1034 /*
1035  * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor
1036  * @map: the start of efi memmap
1037  * @desc_size: the size of space for each EFI memmap descriptor
1038  * @n: the index of efi memmap descriptor
1039  *
1040  * EFI boot service provides the GetMemoryMap() function to get a copy of the
1041  * current memory map which is an array of memory descriptors, each of
1042  * which describes a contiguous block of memory. It also gets the size of the
1043  * map, and the size of each descriptor, etc.
1044  *
1045  * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
1046  * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
1047  * since efi_memory_memdesc_t may be extended in the future. Thus the OS
1048  * MUST use the returned size of the descriptor to find the start of each
1049  * efi_memory_memdesc_t in the memory map array. This should only be used
1050  * during bootup since for_each_efi_memory_desc_xxx() is available after the
1051  * kernel initializes the EFI subsystem to set up struct efi_memory_map.
1052  */
1053 #define efi_early_memdesc_ptr(map, desc_size, n)			\
1054 	(efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
1055 
1056 /* Iterate through an efi_memory_map */
1057 #define for_each_efi_memory_desc_in_map(m, md)				   \
1058 	for ((md) = (m)->map;						   \
1059 	     (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end;	   \
1060 	     (md) = (void *)(md) + (m)->desc_size)
1061 
1062 /**
1063  * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
1064  * @md: the efi_memory_desc_t * iterator
1065  *
1066  * Once the loop finishes @md must not be accessed.
1067  */
1068 #define for_each_efi_memory_desc(md) \
1069 	for_each_efi_memory_desc_in_map(&efi.memmap, md)
1070 
1071 /*
1072  * Format an EFI memory descriptor's type and attributes to a user-provided
1073  * character buffer, as per snprintf(), and return the buffer.
1074  */
1075 char * __init efi_md_typeattr_format(char *buf, size_t size,
1076 				     const efi_memory_desc_t *md);
1077 
1078 
1079 typedef void (*efi_element_handler_t)(const char *source,
1080 				      const void *element_data,
1081 				      size_t element_size);
1082 extern int __init parse_efi_signature_list(
1083 	const char *source,
1084 	const void *data, size_t size,
1085 	efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *));
1086 
1087 /**
1088  * efi_range_is_wc - check the WC bit on an address range
1089  * @start: starting kvirt address
1090  * @len: length of range
1091  *
1092  * Consult the EFI memory map and make sure it's ok to set this range WC.
1093  * Returns true or false.
1094  */
1095 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
1096 {
1097 	unsigned long i;
1098 
1099 	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
1100 		unsigned long paddr = __pa(start + i);
1101 		if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
1102 			return 0;
1103 	}
1104 	/* The range checked out */
1105 	return 1;
1106 }
1107 
1108 #ifdef CONFIG_EFI_PCDP
1109 extern int __init efi_setup_pcdp_console(char *);
1110 #endif
1111 
1112 /*
1113  * We play games with efi_enabled so that the compiler will, if
1114  * possible, remove EFI-related code altogether.
1115  */
1116 #define EFI_BOOT		0	/* Were we booted from EFI? */
1117 #define EFI_CONFIG_TABLES	2	/* Can we use EFI config tables? */
1118 #define EFI_RUNTIME_SERVICES	3	/* Can we use runtime services? */
1119 #define EFI_MEMMAP		4	/* Can we use EFI memory map? */
1120 #define EFI_64BIT		5	/* Is the firmware 64-bit? */
1121 #define EFI_PARAVIRT		6	/* Access is via a paravirt interface */
1122 #define EFI_ARCH_1		7	/* First arch-specific bit */
1123 #define EFI_DBG			8	/* Print additional debug info at runtime */
1124 #define EFI_NX_PE_DATA		9	/* Can runtime data regions be mapped non-executable? */
1125 #define EFI_MEM_ATTR		10	/* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
1126 #define EFI_MEM_NO_SOFT_RESERVE	11	/* Is the kernel configured to ignore soft reservations? */
1127 
1128 #ifdef CONFIG_EFI
1129 /*
1130  * Test whether the above EFI_* bits are enabled.
1131  */
1132 static inline bool efi_enabled(int feature)
1133 {
1134 	return test_bit(feature, &efi.flags) != 0;
1135 }
1136 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
1137 
1138 bool __pure __efi_soft_reserve_enabled(void);
1139 
1140 static inline bool __pure efi_soft_reserve_enabled(void)
1141 {
1142 	return IS_ENABLED(CONFIG_EFI_SOFT_RESERVE)
1143 		&& __efi_soft_reserve_enabled();
1144 }
1145 #else
1146 static inline bool efi_enabled(int feature)
1147 {
1148 	return false;
1149 }
1150 static inline void
1151 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
1152 
1153 static inline bool
1154 efi_capsule_pending(int *reset_type)
1155 {
1156 	return false;
1157 }
1158 
1159 static inline bool efi_soft_reserve_enabled(void)
1160 {
1161 	return false;
1162 }
1163 #endif
1164 
1165 extern int efi_status_to_err(efi_status_t status);
1166 
1167 /*
1168  * Variable Attributes
1169  */
1170 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
1171 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1172 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
1173 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1174 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1175 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1176 #define EFI_VARIABLE_APPEND_WRITE	0x0000000000000040
1177 
1178 #define EFI_VARIABLE_MASK 	(EFI_VARIABLE_NON_VOLATILE | \
1179 				EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1180 				EFI_VARIABLE_RUNTIME_ACCESS | \
1181 				EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1182 				EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1183 				EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1184 				EFI_VARIABLE_APPEND_WRITE)
1185 /*
1186  * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1187  * not including trailing NUL
1188  */
1189 #define EFI_VARIABLE_GUID_LEN	UUID_STRING_LEN
1190 
1191 /*
1192  * The type of search to perform when calling boottime->locate_handle
1193  */
1194 #define EFI_LOCATE_ALL_HANDLES			0
1195 #define EFI_LOCATE_BY_REGISTER_NOTIFY		1
1196 #define EFI_LOCATE_BY_PROTOCOL			2
1197 
1198 /*
1199  * EFI Device Path information
1200  */
1201 #define EFI_DEV_HW			0x01
1202 #define  EFI_DEV_PCI				 1
1203 #define  EFI_DEV_PCCARD				 2
1204 #define  EFI_DEV_MEM_MAPPED			 3
1205 #define  EFI_DEV_VENDOR				 4
1206 #define  EFI_DEV_CONTROLLER			 5
1207 #define EFI_DEV_ACPI			0x02
1208 #define   EFI_DEV_BASIC_ACPI			 1
1209 #define   EFI_DEV_EXPANDED_ACPI			 2
1210 #define EFI_DEV_MSG			0x03
1211 #define   EFI_DEV_MSG_ATAPI			 1
1212 #define   EFI_DEV_MSG_SCSI			 2
1213 #define   EFI_DEV_MSG_FC			 3
1214 #define   EFI_DEV_MSG_1394			 4
1215 #define   EFI_DEV_MSG_USB			 5
1216 #define   EFI_DEV_MSG_USB_CLASS			15
1217 #define   EFI_DEV_MSG_I20			 6
1218 #define   EFI_DEV_MSG_MAC			11
1219 #define   EFI_DEV_MSG_IPV4			12
1220 #define   EFI_DEV_MSG_IPV6			13
1221 #define   EFI_DEV_MSG_INFINIBAND		 9
1222 #define   EFI_DEV_MSG_UART			14
1223 #define   EFI_DEV_MSG_VENDOR			10
1224 #define EFI_DEV_MEDIA			0x04
1225 #define   EFI_DEV_MEDIA_HARD_DRIVE		 1
1226 #define   EFI_DEV_MEDIA_CDROM			 2
1227 #define   EFI_DEV_MEDIA_VENDOR			 3
1228 #define   EFI_DEV_MEDIA_FILE			 4
1229 #define   EFI_DEV_MEDIA_PROTOCOL		 5
1230 #define EFI_DEV_BIOS_BOOT		0x05
1231 #define EFI_DEV_END_PATH		0x7F
1232 #define EFI_DEV_END_PATH2		0xFF
1233 #define   EFI_DEV_END_INSTANCE			0x01
1234 #define   EFI_DEV_END_ENTIRE			0xFF
1235 
1236 struct efi_generic_dev_path {
1237 	u8 type;
1238 	u8 sub_type;
1239 	u16 length;
1240 } __attribute ((packed));
1241 
1242 struct efi_dev_path {
1243 	u8 type;	/* can be replaced with unnamed */
1244 	u8 sub_type;	/* struct efi_generic_dev_path; */
1245 	u16 length;	/* once we've moved to -std=c11 */
1246 	union {
1247 		struct {
1248 			u32 hid;
1249 			u32 uid;
1250 		} acpi;
1251 		struct {
1252 			u8 fn;
1253 			u8 dev;
1254 		} pci;
1255 	};
1256 } __attribute ((packed));
1257 
1258 #if IS_ENABLED(CONFIG_EFI_DEV_PATH_PARSER)
1259 struct device *efi_get_device_by_path(struct efi_dev_path **node, size_t *len);
1260 #endif
1261 
1262 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1263 {
1264 	*npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1265 	*addr &= PAGE_MASK;
1266 }
1267 
1268 /*
1269  * EFI Variable support.
1270  *
1271  * Different firmware drivers can expose their EFI-like variables using
1272  * the following.
1273  */
1274 
1275 struct efivar_operations {
1276 	efi_get_variable_t *get_variable;
1277 	efi_get_next_variable_t *get_next_variable;
1278 	efi_set_variable_t *set_variable;
1279 	efi_set_variable_t *set_variable_nonblocking;
1280 	efi_query_variable_store_t *query_variable_store;
1281 };
1282 
1283 struct efivars {
1284 	struct kset *kset;
1285 	struct kobject *kobject;
1286 	const struct efivar_operations *ops;
1287 };
1288 
1289 /*
1290  * The maximum size of VariableName + Data = 1024
1291  * Therefore, it's reasonable to save that much
1292  * space in each part of the structure,
1293  * and we use a page for reading/writing.
1294  */
1295 
1296 #define EFI_VAR_NAME_LEN	1024
1297 
1298 struct efi_variable {
1299 	efi_char16_t  VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1300 	efi_guid_t    VendorGuid;
1301 	unsigned long DataSize;
1302 	__u8          Data[1024];
1303 	efi_status_t  Status;
1304 	__u32         Attributes;
1305 } __attribute__((packed));
1306 
1307 struct efivar_entry {
1308 	struct efi_variable var;
1309 	struct list_head list;
1310 	struct kobject kobj;
1311 	bool scanning;
1312 	bool deleting;
1313 };
1314 
1315 union efi_simple_text_output_protocol {
1316 	struct {
1317 		void *reset;
1318 		efi_status_t (__efiapi *output_string)(efi_simple_text_output_protocol_t *,
1319 						       efi_char16_t *);
1320 		void *test_string;
1321 	};
1322 	struct {
1323 		u32 reset;
1324 		u32 output_string;
1325 		u32 test_string;
1326 	} mixed_mode;
1327 };
1328 
1329 #define PIXEL_RGB_RESERVED_8BIT_PER_COLOR		0
1330 #define PIXEL_BGR_RESERVED_8BIT_PER_COLOR		1
1331 #define PIXEL_BIT_MASK					2
1332 #define PIXEL_BLT_ONLY					3
1333 #define PIXEL_FORMAT_MAX				4
1334 
1335 typedef struct {
1336 	u32 red_mask;
1337 	u32 green_mask;
1338 	u32 blue_mask;
1339 	u32 reserved_mask;
1340 } efi_pixel_bitmask_t;
1341 
1342 typedef struct {
1343 	u32 version;
1344 	u32 horizontal_resolution;
1345 	u32 vertical_resolution;
1346 	int pixel_format;
1347 	efi_pixel_bitmask_t pixel_information;
1348 	u32 pixels_per_scan_line;
1349 } efi_graphics_output_mode_info_t;
1350 
1351 typedef union efi_graphics_output_protocol_mode efi_graphics_output_protocol_mode_t;
1352 
1353 union efi_graphics_output_protocol_mode {
1354 	struct {
1355 		u32 max_mode;
1356 		u32 mode;
1357 		efi_graphics_output_mode_info_t *info;
1358 		unsigned long size_of_info;
1359 		efi_physical_addr_t frame_buffer_base;
1360 		unsigned long frame_buffer_size;
1361 	};
1362 	struct {
1363 		u32 max_mode;
1364 		u32 mode;
1365 		u32 info;
1366 		u32 size_of_info;
1367 		u64 frame_buffer_base;
1368 		u32 frame_buffer_size;
1369 	} mixed_mode;
1370 };
1371 
1372 typedef union efi_graphics_output_protocol efi_graphics_output_protocol_t;
1373 
1374 union efi_graphics_output_protocol {
1375 	struct {
1376 		void *query_mode;
1377 		void *set_mode;
1378 		void *blt;
1379 		efi_graphics_output_protocol_mode_t *mode;
1380 	};
1381 	struct {
1382 		u32 query_mode;
1383 		u32 set_mode;
1384 		u32 blt;
1385 		u32 mode;
1386 	} mixed_mode;
1387 };
1388 
1389 extern struct list_head efivar_sysfs_list;
1390 
1391 static inline void
1392 efivar_unregister(struct efivar_entry *var)
1393 {
1394 	kobject_put(&var->kobj);
1395 }
1396 
1397 int efivars_register(struct efivars *efivars,
1398 		     const struct efivar_operations *ops,
1399 		     struct kobject *kobject);
1400 int efivars_unregister(struct efivars *efivars);
1401 struct kobject *efivars_kobject(void);
1402 
1403 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1404 		void *data, bool duplicates, struct list_head *head);
1405 
1406 int efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1407 int efivar_entry_remove(struct efivar_entry *entry);
1408 
1409 int __efivar_entry_delete(struct efivar_entry *entry);
1410 int efivar_entry_delete(struct efivar_entry *entry);
1411 
1412 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1413 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1414 		       unsigned long *size, void *data);
1415 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1416 		     unsigned long *size, void *data);
1417 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1418 		     unsigned long size, void *data, struct list_head *head);
1419 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1420 			      unsigned long *size, void *data, bool *set);
1421 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1422 			  bool block, unsigned long size, void *data);
1423 
1424 int efivar_entry_iter_begin(void);
1425 void efivar_entry_iter_end(void);
1426 
1427 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1428 			struct list_head *head, void *data,
1429 			struct efivar_entry **prev);
1430 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1431 		      struct list_head *head, void *data);
1432 
1433 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1434 				       struct list_head *head, bool remove);
1435 
1436 bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1437 		     unsigned long data_size);
1438 bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1439 				  size_t len);
1440 
1441 extern struct work_struct efivar_work;
1442 void efivar_run_worker(void);
1443 
1444 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1445 int efivars_sysfs_init(void);
1446 
1447 #define EFIVARS_DATA_SIZE_MAX 1024
1448 
1449 #endif /* CONFIG_EFI_VARS */
1450 extern bool efi_capsule_pending(int *reset_type);
1451 
1452 extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1453 				 size_t size, int *reset);
1454 
1455 extern int efi_capsule_update(efi_capsule_header_t *capsule,
1456 			      phys_addr_t *pages);
1457 
1458 #ifdef CONFIG_EFI_RUNTIME_MAP
1459 int efi_runtime_map_init(struct kobject *);
1460 int efi_get_runtime_map_size(void);
1461 int efi_get_runtime_map_desc_size(void);
1462 int efi_runtime_map_copy(void *buf, size_t bufsz);
1463 #else
1464 static inline int efi_runtime_map_init(struct kobject *kobj)
1465 {
1466 	return 0;
1467 }
1468 
1469 static inline int efi_get_runtime_map_size(void)
1470 {
1471 	return 0;
1472 }
1473 
1474 static inline int efi_get_runtime_map_desc_size(void)
1475 {
1476 	return 0;
1477 }
1478 
1479 static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1480 {
1481 	return 0;
1482 }
1483 
1484 #endif
1485 
1486 /* prototypes shared between arch specific and generic stub code */
1487 
1488 void efi_printk(char *str);
1489 
1490 void efi_free(unsigned long size, unsigned long addr);
1491 
1492 char *efi_convert_cmdline(efi_loaded_image_t *image, int *cmd_line_len);
1493 
1494 efi_status_t efi_get_memory_map(struct efi_boot_memmap *map);
1495 
1496 efi_status_t efi_low_alloc_above(unsigned long size, unsigned long align,
1497 				 unsigned long *addr, unsigned long min);
1498 
1499 static inline
1500 efi_status_t efi_low_alloc(unsigned long size, unsigned long align,
1501 			   unsigned long *addr)
1502 {
1503 	/*
1504 	 * Don't allocate at 0x0. It will confuse code that
1505 	 * checks pointers against NULL. Skip the first 8
1506 	 * bytes so we start at a nice even number.
1507 	 */
1508 	return efi_low_alloc_above(size, align, addr, 0x8);
1509 }
1510 
1511 efi_status_t efi_high_alloc(unsigned long size, unsigned long align,
1512 			    unsigned long *addr, unsigned long max);
1513 
1514 efi_status_t efi_relocate_kernel(unsigned long *image_addr,
1515 				 unsigned long image_size,
1516 				 unsigned long alloc_size,
1517 				 unsigned long preferred_addr,
1518 				 unsigned long alignment,
1519 				 unsigned long min_addr);
1520 
1521 efi_status_t handle_cmdline_files(efi_loaded_image_t *image,
1522 				  char *cmd_line, char *option_string,
1523 				  unsigned long max_addr,
1524 				  unsigned long *load_addr,
1525 				  unsigned long *load_size);
1526 
1527 efi_status_t efi_parse_options(char const *cmdline);
1528 
1529 efi_status_t efi_setup_gop(struct screen_info *si, efi_guid_t *proto,
1530 			   unsigned long size);
1531 
1532 #ifdef CONFIG_EFI
1533 extern bool efi_runtime_disabled(void);
1534 #else
1535 static inline bool efi_runtime_disabled(void) { return true; }
1536 #endif
1537 
1538 extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1539 extern unsigned long efi_call_virt_save_flags(void);
1540 
1541 enum efi_secureboot_mode {
1542 	efi_secureboot_mode_unset,
1543 	efi_secureboot_mode_unknown,
1544 	efi_secureboot_mode_disabled,
1545 	efi_secureboot_mode_enabled,
1546 };
1547 enum efi_secureboot_mode efi_get_secureboot(void);
1548 
1549 #ifdef CONFIG_RESET_ATTACK_MITIGATION
1550 void efi_enable_reset_attack_mitigation(void);
1551 #else
1552 static inline void
1553 efi_enable_reset_attack_mitigation(void) { }
1554 #endif
1555 
1556 efi_status_t efi_random_get_seed(void);
1557 
1558 void efi_retrieve_tpm2_eventlog(void);
1559 
1560 /*
1561  * Arch code can implement the following three template macros, avoiding
1562  * reptition for the void/non-void return cases of {__,}efi_call_virt():
1563  *
1564  *  * arch_efi_call_virt_setup()
1565  *
1566  *    Sets up the environment for the call (e.g. switching page tables,
1567  *    allowing kernel-mode use of floating point, if required).
1568  *
1569  *  * arch_efi_call_virt()
1570  *
1571  *    Performs the call. The last expression in the macro must be the call
1572  *    itself, allowing the logic to be shared by the void and non-void
1573  *    cases.
1574  *
1575  *  * arch_efi_call_virt_teardown()
1576  *
1577  *    Restores the usual kernel environment once the call has returned.
1578  */
1579 
1580 #define efi_call_virt_pointer(p, f, args...)				\
1581 ({									\
1582 	efi_status_t __s;						\
1583 	unsigned long __flags;						\
1584 									\
1585 	arch_efi_call_virt_setup();					\
1586 									\
1587 	__flags = efi_call_virt_save_flags();				\
1588 	__s = arch_efi_call_virt(p, f, args);				\
1589 	efi_call_virt_check_flags(__flags, __stringify(f));		\
1590 									\
1591 	arch_efi_call_virt_teardown();					\
1592 									\
1593 	__s;								\
1594 })
1595 
1596 #define __efi_call_virt_pointer(p, f, args...)				\
1597 ({									\
1598 	unsigned long __flags;						\
1599 									\
1600 	arch_efi_call_virt_setup();					\
1601 									\
1602 	__flags = efi_call_virt_save_flags();				\
1603 	arch_efi_call_virt(p, f, args);					\
1604 	efi_call_virt_check_flags(__flags, __stringify(f));		\
1605 									\
1606 	arch_efi_call_virt_teardown();					\
1607 })
1608 
1609 typedef efi_status_t (*efi_exit_boot_map_processing)(
1610 	struct efi_boot_memmap *map,
1611 	void *priv);
1612 
1613 efi_status_t efi_exit_boot_services(void *handle,
1614 				    struct efi_boot_memmap *map,
1615 				    void *priv,
1616 				    efi_exit_boot_map_processing priv_func);
1617 
1618 #define EFI_RANDOM_SEED_SIZE		64U
1619 
1620 struct linux_efi_random_seed {
1621 	u32	size;
1622 	u8	bits[];
1623 };
1624 
1625 struct linux_efi_tpm_eventlog {
1626 	u32	size;
1627 	u32	final_events_preboot_size;
1628 	u8	version;
1629 	u8	log[];
1630 };
1631 
1632 extern int efi_tpm_eventlog_init(void);
1633 
1634 struct efi_tcg2_final_events_table {
1635 	u64 version;
1636 	u64 nr_events;
1637 	u8 events[];
1638 };
1639 extern int efi_tpm_final_log_size;
1640 
1641 extern unsigned long rci2_table_phys;
1642 
1643 /*
1644  * efi_runtime_service() function identifiers.
1645  * "NONE" is used by efi_recover_from_page_fault() to check if the page
1646  * fault happened while executing an efi runtime service.
1647  */
1648 enum efi_rts_ids {
1649 	EFI_NONE,
1650 	EFI_GET_TIME,
1651 	EFI_SET_TIME,
1652 	EFI_GET_WAKEUP_TIME,
1653 	EFI_SET_WAKEUP_TIME,
1654 	EFI_GET_VARIABLE,
1655 	EFI_GET_NEXT_VARIABLE,
1656 	EFI_SET_VARIABLE,
1657 	EFI_QUERY_VARIABLE_INFO,
1658 	EFI_GET_NEXT_HIGH_MONO_COUNT,
1659 	EFI_RESET_SYSTEM,
1660 	EFI_UPDATE_CAPSULE,
1661 	EFI_QUERY_CAPSULE_CAPS,
1662 };
1663 
1664 /*
1665  * efi_runtime_work:	Details of EFI Runtime Service work
1666  * @arg<1-5>:		EFI Runtime Service function arguments
1667  * @status:		Status of executing EFI Runtime Service
1668  * @efi_rts_id:		EFI Runtime Service function identifier
1669  * @efi_rts_comp:	Struct used for handling completions
1670  */
1671 struct efi_runtime_work {
1672 	void *arg1;
1673 	void *arg2;
1674 	void *arg3;
1675 	void *arg4;
1676 	void *arg5;
1677 	efi_status_t status;
1678 	struct work_struct work;
1679 	enum efi_rts_ids efi_rts_id;
1680 	struct completion efi_rts_comp;
1681 };
1682 
1683 extern struct efi_runtime_work efi_rts_work;
1684 
1685 /* Workqueue to queue EFI Runtime Services */
1686 extern struct workqueue_struct *efi_rts_wq;
1687 
1688 struct linux_efi_memreserve {
1689 	int		size;			// allocated size of the array
1690 	atomic_t	count;			// number of entries used
1691 	phys_addr_t	next;			// pa of next struct instance
1692 	struct {
1693 		phys_addr_t	base;
1694 		phys_addr_t	size;
1695 	} entry[0];
1696 };
1697 
1698 #define EFI_MEMRESERVE_SIZE(count) (sizeof(struct linux_efi_memreserve) + \
1699 	(count) * sizeof(((struct linux_efi_memreserve *)0)->entry[0]))
1700 
1701 #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1702 	/ sizeof(((struct linux_efi_memreserve *)0)->entry[0]))
1703 
1704 void efi_pci_disable_bridge_busmaster(void);
1705 
1706 #endif /* _LINUX_EFI_H */
1707