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