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