xref: /linux-6.15/include/linux/efi.h (revision 97f0b134)
1 #ifndef _LINUX_EFI_H
2 #define _LINUX_EFI_H
3 
4 /*
5  * Extensible Firmware Interface
6  * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
7  *
8  * Copyright (C) 1999 VA Linux Systems
9  * Copyright (C) 1999 Walt Drummond <[email protected]>
10  * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
11  *	David Mosberger-Tang <[email protected]>
12  *	Stephane Eranian <[email protected]>
13  */
14 #include <linux/init.h>
15 #include <linux/string.h>
16 #include <linux/time.h>
17 #include <linux/types.h>
18 #include <linux/proc_fs.h>
19 #include <linux/rtc.h>
20 #include <linux/ioport.h>
21 #include <linux/pfn.h>
22 #include <linux/pstore.h>
23 #include <linux/reboot.h>
24 
25 #include <asm/page.h>
26 
27 #define EFI_SUCCESS		0
28 #define EFI_LOAD_ERROR          ( 1 | (1UL << (BITS_PER_LONG-1)))
29 #define EFI_INVALID_PARAMETER	( 2 | (1UL << (BITS_PER_LONG-1)))
30 #define EFI_UNSUPPORTED		( 3 | (1UL << (BITS_PER_LONG-1)))
31 #define EFI_BAD_BUFFER_SIZE     ( 4 | (1UL << (BITS_PER_LONG-1)))
32 #define EFI_BUFFER_TOO_SMALL	( 5 | (1UL << (BITS_PER_LONG-1)))
33 #define EFI_NOT_READY		( 6 | (1UL << (BITS_PER_LONG-1)))
34 #define EFI_DEVICE_ERROR	( 7 | (1UL << (BITS_PER_LONG-1)))
35 #define EFI_WRITE_PROTECTED	( 8 | (1UL << (BITS_PER_LONG-1)))
36 #define EFI_OUT_OF_RESOURCES	( 9 | (1UL << (BITS_PER_LONG-1)))
37 #define EFI_NOT_FOUND		(14 | (1UL << (BITS_PER_LONG-1)))
38 #define EFI_SECURITY_VIOLATION	(26 | (1UL << (BITS_PER_LONG-1)))
39 
40 typedef unsigned long efi_status_t;
41 typedef u8 efi_bool_t;
42 typedef u16 efi_char16_t;		/* UNICODE character */
43 typedef u64 efi_physical_addr_t;
44 typedef void *efi_handle_t;
45 
46 
47 typedef struct {
48 	u8 b[16];
49 } efi_guid_t;
50 
51 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
52 ((efi_guid_t) \
53 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
54   (b) & 0xff, ((b) >> 8) & 0xff, \
55   (c) & 0xff, ((c) >> 8) & 0xff, \
56   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
57 
58 /*
59  * Generic EFI table header
60  */
61 typedef	struct {
62 	u64 signature;
63 	u32 revision;
64 	u32 headersize;
65 	u32 crc32;
66 	u32 reserved;
67 } efi_table_hdr_t;
68 
69 /*
70  * Memory map descriptor:
71  */
72 
73 /* Memory types: */
74 #define EFI_RESERVED_TYPE		 0
75 #define EFI_LOADER_CODE			 1
76 #define EFI_LOADER_DATA			 2
77 #define EFI_BOOT_SERVICES_CODE		 3
78 #define EFI_BOOT_SERVICES_DATA		 4
79 #define EFI_RUNTIME_SERVICES_CODE	 5
80 #define EFI_RUNTIME_SERVICES_DATA	 6
81 #define EFI_CONVENTIONAL_MEMORY		 7
82 #define EFI_UNUSABLE_MEMORY		 8
83 #define EFI_ACPI_RECLAIM_MEMORY		 9
84 #define EFI_ACPI_MEMORY_NVS		10
85 #define EFI_MEMORY_MAPPED_IO		11
86 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE	12
87 #define EFI_PAL_CODE			13
88 #define EFI_MAX_MEMORY_TYPE		14
89 
90 /* Attribute values: */
91 #define EFI_MEMORY_UC		((u64)0x0000000000000001ULL)	/* uncached */
92 #define EFI_MEMORY_WC		((u64)0x0000000000000002ULL)	/* write-coalescing */
93 #define EFI_MEMORY_WT		((u64)0x0000000000000004ULL)	/* write-through */
94 #define EFI_MEMORY_WB		((u64)0x0000000000000008ULL)	/* write-back */
95 #define EFI_MEMORY_UCE		((u64)0x0000000000000010ULL)	/* uncached, exported */
96 #define EFI_MEMORY_WP		((u64)0x0000000000001000ULL)	/* write-protect */
97 #define EFI_MEMORY_RP		((u64)0x0000000000002000ULL)	/* read-protect */
98 #define EFI_MEMORY_XP		((u64)0x0000000000004000ULL)	/* execute-protect */
99 #define EFI_MEMORY_RUNTIME	((u64)0x8000000000000000ULL)	/* range requires runtime mapping */
100 #define EFI_MEMORY_DESCRIPTOR_VERSION	1
101 
102 #define EFI_PAGE_SHIFT		12
103 #define EFI_PAGE_SIZE		(1UL << EFI_PAGE_SHIFT)
104 
105 typedef struct {
106 	u32 type;
107 	u32 pad;
108 	u64 phys_addr;
109 	u64 virt_addr;
110 	u64 num_pages;
111 	u64 attribute;
112 } efi_memory_desc_t;
113 
114 typedef struct {
115 	efi_guid_t guid;
116 	u32 headersize;
117 	u32 flags;
118 	u32 imagesize;
119 } efi_capsule_header_t;
120 
121 /*
122  * Allocation types for calls to boottime->allocate_pages.
123  */
124 #define EFI_ALLOCATE_ANY_PAGES		0
125 #define EFI_ALLOCATE_MAX_ADDRESS	1
126 #define EFI_ALLOCATE_ADDRESS		2
127 #define EFI_MAX_ALLOCATE_TYPE		3
128 
129 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
130 
131 /*
132  * Types and defines for Time Services
133  */
134 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
135 #define EFI_TIME_IN_DAYLIGHT     0x2
136 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
137 
138 typedef struct {
139 	u16 year;
140 	u8 month;
141 	u8 day;
142 	u8 hour;
143 	u8 minute;
144 	u8 second;
145 	u8 pad1;
146 	u32 nanosecond;
147 	s16 timezone;
148 	u8 daylight;
149 	u8 pad2;
150 } efi_time_t;
151 
152 typedef struct {
153 	u32 resolution;
154 	u32 accuracy;
155 	u8 sets_to_zero;
156 } efi_time_cap_t;
157 
158 typedef struct {
159 	efi_table_hdr_t hdr;
160 	u32 raise_tpl;
161 	u32 restore_tpl;
162 	u32 allocate_pages;
163 	u32 free_pages;
164 	u32 get_memory_map;
165 	u32 allocate_pool;
166 	u32 free_pool;
167 	u32 create_event;
168 	u32 set_timer;
169 	u32 wait_for_event;
170 	u32 signal_event;
171 	u32 close_event;
172 	u32 check_event;
173 	u32 install_protocol_interface;
174 	u32 reinstall_protocol_interface;
175 	u32 uninstall_protocol_interface;
176 	u32 handle_protocol;
177 	u32 __reserved;
178 	u32 register_protocol_notify;
179 	u32 locate_handle;
180 	u32 locate_device_path;
181 	u32 install_configuration_table;
182 	u32 load_image;
183 	u32 start_image;
184 	u32 exit;
185 	u32 unload_image;
186 	u32 exit_boot_services;
187 	u32 get_next_monotonic_count;
188 	u32 stall;
189 	u32 set_watchdog_timer;
190 	u32 connect_controller;
191 	u32 disconnect_controller;
192 	u32 open_protocol;
193 	u32 close_protocol;
194 	u32 open_protocol_information;
195 	u32 protocols_per_handle;
196 	u32 locate_handle_buffer;
197 	u32 locate_protocol;
198 	u32 install_multiple_protocol_interfaces;
199 	u32 uninstall_multiple_protocol_interfaces;
200 	u32 calculate_crc32;
201 	u32 copy_mem;
202 	u32 set_mem;
203 	u32 create_event_ex;
204 } __packed efi_boot_services_32_t;
205 
206 typedef struct {
207 	efi_table_hdr_t hdr;
208 	u64 raise_tpl;
209 	u64 restore_tpl;
210 	u64 allocate_pages;
211 	u64 free_pages;
212 	u64 get_memory_map;
213 	u64 allocate_pool;
214 	u64 free_pool;
215 	u64 create_event;
216 	u64 set_timer;
217 	u64 wait_for_event;
218 	u64 signal_event;
219 	u64 close_event;
220 	u64 check_event;
221 	u64 install_protocol_interface;
222 	u64 reinstall_protocol_interface;
223 	u64 uninstall_protocol_interface;
224 	u64 handle_protocol;
225 	u64 __reserved;
226 	u64 register_protocol_notify;
227 	u64 locate_handle;
228 	u64 locate_device_path;
229 	u64 install_configuration_table;
230 	u64 load_image;
231 	u64 start_image;
232 	u64 exit;
233 	u64 unload_image;
234 	u64 exit_boot_services;
235 	u64 get_next_monotonic_count;
236 	u64 stall;
237 	u64 set_watchdog_timer;
238 	u64 connect_controller;
239 	u64 disconnect_controller;
240 	u64 open_protocol;
241 	u64 close_protocol;
242 	u64 open_protocol_information;
243 	u64 protocols_per_handle;
244 	u64 locate_handle_buffer;
245 	u64 locate_protocol;
246 	u64 install_multiple_protocol_interfaces;
247 	u64 uninstall_multiple_protocol_interfaces;
248 	u64 calculate_crc32;
249 	u64 copy_mem;
250 	u64 set_mem;
251 	u64 create_event_ex;
252 } __packed efi_boot_services_64_t;
253 
254 /*
255  * EFI Boot Services table
256  */
257 typedef struct {
258 	efi_table_hdr_t hdr;
259 	void *raise_tpl;
260 	void *restore_tpl;
261 	efi_status_t (*allocate_pages)(int, int, unsigned long,
262 				       efi_physical_addr_t *);
263 	efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
264 	efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
265 				       unsigned long *, u32 *);
266 	efi_status_t (*allocate_pool)(int, unsigned long, void **);
267 	efi_status_t (*free_pool)(void *);
268 	void *create_event;
269 	void *set_timer;
270 	void *wait_for_event;
271 	void *signal_event;
272 	void *close_event;
273 	void *check_event;
274 	void *install_protocol_interface;
275 	void *reinstall_protocol_interface;
276 	void *uninstall_protocol_interface;
277 	efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
278 	void *__reserved;
279 	void *register_protocol_notify;
280 	void *locate_handle;
281 	void *locate_device_path;
282 	void *install_configuration_table;
283 	void *load_image;
284 	void *start_image;
285 	void *exit;
286 	void *unload_image;
287 	efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
288 	void *get_next_monotonic_count;
289 	void *stall;
290 	void *set_watchdog_timer;
291 	void *connect_controller;
292 	void *disconnect_controller;
293 	void *open_protocol;
294 	void *close_protocol;
295 	void *open_protocol_information;
296 	void *protocols_per_handle;
297 	void *locate_handle_buffer;
298 	void *locate_protocol;
299 	void *install_multiple_protocol_interfaces;
300 	void *uninstall_multiple_protocol_interfaces;
301 	void *calculate_crc32;
302 	void *copy_mem;
303 	void *set_mem;
304 	void *create_event_ex;
305 } efi_boot_services_t;
306 
307 typedef enum {
308 	EfiPciIoWidthUint8,
309 	EfiPciIoWidthUint16,
310 	EfiPciIoWidthUint32,
311 	EfiPciIoWidthUint64,
312 	EfiPciIoWidthFifoUint8,
313 	EfiPciIoWidthFifoUint16,
314 	EfiPciIoWidthFifoUint32,
315 	EfiPciIoWidthFifoUint64,
316 	EfiPciIoWidthFillUint8,
317 	EfiPciIoWidthFillUint16,
318 	EfiPciIoWidthFillUint32,
319 	EfiPciIoWidthFillUint64,
320 	EfiPciIoWidthMaximum
321 } EFI_PCI_IO_PROTOCOL_WIDTH;
322 
323 typedef enum {
324 	EfiPciIoAttributeOperationGet,
325 	EfiPciIoAttributeOperationSet,
326 	EfiPciIoAttributeOperationEnable,
327 	EfiPciIoAttributeOperationDisable,
328 	EfiPciIoAttributeOperationSupported,
329     EfiPciIoAttributeOperationMaximum
330 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
331 
332 typedef struct {
333 	u32 read;
334 	u32 write;
335 } efi_pci_io_protocol_access_32_t;
336 
337 typedef struct {
338 	u64 read;
339 	u64 write;
340 } efi_pci_io_protocol_access_64_t;
341 
342 typedef struct {
343 	void *read;
344 	void *write;
345 } efi_pci_io_protocol_access_t;
346 
347 typedef struct {
348 	u32 poll_mem;
349 	u32 poll_io;
350 	efi_pci_io_protocol_access_32_t mem;
351 	efi_pci_io_protocol_access_32_t io;
352 	efi_pci_io_protocol_access_32_t pci;
353 	u32 copy_mem;
354 	u32 map;
355 	u32 unmap;
356 	u32 allocate_buffer;
357 	u32 free_buffer;
358 	u32 flush;
359 	u32 get_location;
360 	u32 attributes;
361 	u32 get_bar_attributes;
362 	u32 set_bar_attributes;
363 	uint64_t romsize;
364 	void *romimage;
365 } efi_pci_io_protocol_32;
366 
367 typedef struct {
368 	u64 poll_mem;
369 	u64 poll_io;
370 	efi_pci_io_protocol_access_64_t mem;
371 	efi_pci_io_protocol_access_64_t io;
372 	efi_pci_io_protocol_access_64_t pci;
373 	u64 copy_mem;
374 	u64 map;
375 	u64 unmap;
376 	u64 allocate_buffer;
377 	u64 free_buffer;
378 	u64 flush;
379 	u64 get_location;
380 	u64 attributes;
381 	u64 get_bar_attributes;
382 	u64 set_bar_attributes;
383 	uint64_t romsize;
384 	void *romimage;
385 } efi_pci_io_protocol_64;
386 
387 typedef struct {
388 	void *poll_mem;
389 	void *poll_io;
390 	efi_pci_io_protocol_access_t mem;
391 	efi_pci_io_protocol_access_t io;
392 	efi_pci_io_protocol_access_t pci;
393 	void *copy_mem;
394 	void *map;
395 	void *unmap;
396 	void *allocate_buffer;
397 	void *free_buffer;
398 	void *flush;
399 	void *get_location;
400 	void *attributes;
401 	void *get_bar_attributes;
402 	void *set_bar_attributes;
403 	uint64_t romsize;
404 	void *romimage;
405 } efi_pci_io_protocol;
406 
407 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
408 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
409 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
410 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
411 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
412 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
413 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
414 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
415 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
416 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
417 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
418 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
419 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
420 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
421 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
422 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
423 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
424 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
425 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
426 
427 /*
428  * Types and defines for EFI ResetSystem
429  */
430 #define EFI_RESET_COLD 0
431 #define EFI_RESET_WARM 1
432 #define EFI_RESET_SHUTDOWN 2
433 
434 /*
435  * EFI Runtime Services table
436  */
437 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
438 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
439 
440 typedef struct {
441 	efi_table_hdr_t hdr;
442 	u32 get_time;
443 	u32 set_time;
444 	u32 get_wakeup_time;
445 	u32 set_wakeup_time;
446 	u32 set_virtual_address_map;
447 	u32 convert_pointer;
448 	u32 get_variable;
449 	u32 get_next_variable;
450 	u32 set_variable;
451 	u32 get_next_high_mono_count;
452 	u32 reset_system;
453 	u32 update_capsule;
454 	u32 query_capsule_caps;
455 	u32 query_variable_info;
456 } efi_runtime_services_32_t;
457 
458 typedef struct {
459 	efi_table_hdr_t hdr;
460 	u64 get_time;
461 	u64 set_time;
462 	u64 get_wakeup_time;
463 	u64 set_wakeup_time;
464 	u64 set_virtual_address_map;
465 	u64 convert_pointer;
466 	u64 get_variable;
467 	u64 get_next_variable;
468 	u64 set_variable;
469 	u64 get_next_high_mono_count;
470 	u64 reset_system;
471 	u64 update_capsule;
472 	u64 query_capsule_caps;
473 	u64 query_variable_info;
474 } efi_runtime_services_64_t;
475 
476 typedef struct {
477 	efi_table_hdr_t hdr;
478 	void *get_time;
479 	void *set_time;
480 	void *get_wakeup_time;
481 	void *set_wakeup_time;
482 	void *set_virtual_address_map;
483 	void *convert_pointer;
484 	void *get_variable;
485 	void *get_next_variable;
486 	void *set_variable;
487 	void *get_next_high_mono_count;
488 	void *reset_system;
489 	void *update_capsule;
490 	void *query_capsule_caps;
491 	void *query_variable_info;
492 } efi_runtime_services_t;
493 
494 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
495 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
496 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
497 					    efi_time_t *tm);
498 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
499 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
500 					 unsigned long *data_size, void *data);
501 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
502 					      efi_guid_t *vendor);
503 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
504 					 u32 attr, unsigned long data_size,
505 					 void *data);
506 typedef efi_status_t
507 efi_set_variable_nonblocking_t(efi_char16_t *name, efi_guid_t *vendor,
508 			       u32 attr, unsigned long data_size, void *data);
509 
510 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
511 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
512 				 unsigned long data_size, efi_char16_t *data);
513 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
514 						unsigned long descriptor_size,
515 						u32 descriptor_version,
516 						efi_memory_desc_t *virtual_map);
517 typedef efi_status_t efi_query_variable_info_t(u32 attr,
518 					       u64 *storage_space,
519 					       u64 *remaining_space,
520 					       u64 *max_variable_size);
521 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
522 					  unsigned long count,
523 					  unsigned long sg_list);
524 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
525 					      unsigned long count,
526 					      u64 *max_size,
527 					      int *reset_type);
528 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
529 
530 void efi_native_runtime_setup(void);
531 
532 /*
533  *  EFI Configuration Table and GUID definitions
534  */
535 #define NULL_GUID \
536     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
537 
538 #define MPS_TABLE_GUID    \
539     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
540 
541 #define ACPI_TABLE_GUID    \
542     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
543 
544 #define ACPI_20_TABLE_GUID    \
545     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
546 
547 #define SMBIOS_TABLE_GUID    \
548     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
549 
550 #define SMBIOS3_TABLE_GUID    \
551     EFI_GUID(  0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94 )
552 
553 #define SAL_SYSTEM_TABLE_GUID    \
554     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
555 
556 #define HCDP_TABLE_GUID	\
557     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
558 
559 #define UGA_IO_PROTOCOL_GUID \
560     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
561 
562 #define EFI_GLOBAL_VARIABLE_GUID \
563     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
564 
565 #define UV_SYSTEM_TABLE_GUID \
566     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
567 
568 #define LINUX_EFI_CRASH_GUID \
569     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
570 
571 #define LOADED_IMAGE_PROTOCOL_GUID \
572     EFI_GUID(  0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
573 
574 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
575     EFI_GUID(  0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
576 
577 #define EFI_UGA_PROTOCOL_GUID \
578     EFI_GUID(  0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
579 
580 #define EFI_PCI_IO_PROTOCOL_GUID \
581     EFI_GUID(  0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
582 
583 #define EFI_FILE_INFO_ID \
584     EFI_GUID(  0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
585 
586 #define EFI_SYSTEM_RESOURCE_TABLE_GUID \
587     EFI_GUID(  0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 )
588 
589 #define EFI_FILE_SYSTEM_GUID \
590     EFI_GUID(  0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
591 
592 #define DEVICE_TREE_GUID \
593     EFI_GUID(  0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
594 
595 typedef struct {
596 	efi_guid_t guid;
597 	u64 table;
598 } efi_config_table_64_t;
599 
600 typedef struct {
601 	efi_guid_t guid;
602 	u32 table;
603 } efi_config_table_32_t;
604 
605 typedef struct {
606 	efi_guid_t guid;
607 	unsigned long table;
608 } efi_config_table_t;
609 
610 typedef struct {
611 	efi_guid_t guid;
612 	const char *name;
613 	unsigned long *ptr;
614 } efi_config_table_type_t;
615 
616 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
617 
618 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
619 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
620 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
621 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
622 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
623 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
624 
625 typedef struct {
626 	efi_table_hdr_t hdr;
627 	u64 fw_vendor;	/* physical addr of CHAR16 vendor string */
628 	u32 fw_revision;
629 	u32 __pad1;
630 	u64 con_in_handle;
631 	u64 con_in;
632 	u64 con_out_handle;
633 	u64 con_out;
634 	u64 stderr_handle;
635 	u64 stderr;
636 	u64 runtime;
637 	u64 boottime;
638 	u32 nr_tables;
639 	u32 __pad2;
640 	u64 tables;
641 } efi_system_table_64_t;
642 
643 typedef struct {
644 	efi_table_hdr_t hdr;
645 	u32 fw_vendor;	/* physical addr of CHAR16 vendor string */
646 	u32 fw_revision;
647 	u32 con_in_handle;
648 	u32 con_in;
649 	u32 con_out_handle;
650 	u32 con_out;
651 	u32 stderr_handle;
652 	u32 stderr;
653 	u32 runtime;
654 	u32 boottime;
655 	u32 nr_tables;
656 	u32 tables;
657 } efi_system_table_32_t;
658 
659 typedef struct {
660 	efi_table_hdr_t hdr;
661 	unsigned long fw_vendor;	/* physical addr of CHAR16 vendor string */
662 	u32 fw_revision;
663 	unsigned long con_in_handle;
664 	unsigned long con_in;
665 	unsigned long con_out_handle;
666 	unsigned long con_out;
667 	unsigned long stderr_handle;
668 	unsigned long stderr;
669 	efi_runtime_services_t *runtime;
670 	efi_boot_services_t *boottime;
671 	unsigned long nr_tables;
672 	unsigned long tables;
673 } efi_system_table_t;
674 
675 struct efi_memory_map {
676 	void *phys_map;
677 	void *map;
678 	void *map_end;
679 	int nr_map;
680 	unsigned long desc_version;
681 	unsigned long desc_size;
682 };
683 
684 struct efi_fdt_params {
685 	u64 system_table;
686 	u64 mmap;
687 	u32 mmap_size;
688 	u32 desc_size;
689 	u32 desc_ver;
690 };
691 
692 typedef struct {
693 	u32 revision;
694 	u32 parent_handle;
695 	u32 system_table;
696 	u32 device_handle;
697 	u32 file_path;
698 	u32 reserved;
699 	u32 load_options_size;
700 	u32 load_options;
701 	u32 image_base;
702 	__aligned_u64 image_size;
703 	unsigned int image_code_type;
704 	unsigned int image_data_type;
705 	unsigned long unload;
706 } efi_loaded_image_32_t;
707 
708 typedef struct {
709 	u32 revision;
710 	u64 parent_handle;
711 	u64 system_table;
712 	u64 device_handle;
713 	u64 file_path;
714 	u64 reserved;
715 	u32 load_options_size;
716 	u64 load_options;
717 	u64 image_base;
718 	__aligned_u64 image_size;
719 	unsigned int image_code_type;
720 	unsigned int image_data_type;
721 	unsigned long unload;
722 } efi_loaded_image_64_t;
723 
724 typedef struct {
725 	u32 revision;
726 	void *parent_handle;
727 	efi_system_table_t *system_table;
728 	void *device_handle;
729 	void *file_path;
730 	void *reserved;
731 	u32 load_options_size;
732 	void *load_options;
733 	void *image_base;
734 	__aligned_u64 image_size;
735 	unsigned int image_code_type;
736 	unsigned int image_data_type;
737 	unsigned long unload;
738 } efi_loaded_image_t;
739 
740 
741 typedef struct {
742 	u64 size;
743 	u64 file_size;
744 	u64 phys_size;
745 	efi_time_t create_time;
746 	efi_time_t last_access_time;
747 	efi_time_t modification_time;
748 	__aligned_u64 attribute;
749 	efi_char16_t filename[1];
750 } efi_file_info_t;
751 
752 typedef struct {
753 	u64 revision;
754 	u32 open;
755 	u32 close;
756 	u32 delete;
757 	u32 read;
758 	u32 write;
759 	u32 get_position;
760 	u32 set_position;
761 	u32 get_info;
762 	u32 set_info;
763 	u32 flush;
764 } efi_file_handle_32_t;
765 
766 typedef struct {
767 	u64 revision;
768 	u64 open;
769 	u64 close;
770 	u64 delete;
771 	u64 read;
772 	u64 write;
773 	u64 get_position;
774 	u64 set_position;
775 	u64 get_info;
776 	u64 set_info;
777 	u64 flush;
778 } efi_file_handle_64_t;
779 
780 typedef struct _efi_file_handle {
781 	u64 revision;
782 	efi_status_t (*open)(struct _efi_file_handle *,
783 			     struct _efi_file_handle **,
784 			     efi_char16_t *, u64, u64);
785 	efi_status_t (*close)(struct _efi_file_handle *);
786 	void *delete;
787 	efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
788 			     void *);
789 	void *write;
790 	void *get_position;
791 	void *set_position;
792 	efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
793 			unsigned long *, void *);
794 	void *set_info;
795 	void *flush;
796 } efi_file_handle_t;
797 
798 typedef struct _efi_file_io_interface {
799 	u64 revision;
800 	int (*open_volume)(struct _efi_file_io_interface *,
801 			   efi_file_handle_t **);
802 } efi_file_io_interface_t;
803 
804 #define EFI_FILE_MODE_READ	0x0000000000000001
805 #define EFI_FILE_MODE_WRITE	0x0000000000000002
806 #define EFI_FILE_MODE_CREATE	0x8000000000000000
807 
808 #define EFI_INVALID_TABLE_ADDR		(~0UL)
809 
810 /*
811  * All runtime access to EFI goes through this structure:
812  */
813 extern struct efi {
814 	efi_system_table_t *systab;	/* EFI system table */
815 	unsigned int runtime_version;	/* Runtime services version */
816 	unsigned long mps;		/* MPS table */
817 	unsigned long acpi;		/* ACPI table  (IA64 ext 0.71) */
818 	unsigned long acpi20;		/* ACPI table  (ACPI 2.0) */
819 	unsigned long smbios;		/* SMBIOS table (32 bit entry point) */
820 	unsigned long smbios3;		/* SMBIOS table (64 bit entry point) */
821 	unsigned long sal_systab;	/* SAL system table */
822 	unsigned long boot_info;	/* boot info table */
823 	unsigned long hcdp;		/* HCDP table */
824 	unsigned long uga;		/* UGA table */
825 	unsigned long uv_systab;	/* UV system table */
826 	unsigned long fw_vendor;	/* fw_vendor */
827 	unsigned long runtime;		/* runtime table */
828 	unsigned long config_table;	/* config tables */
829 	unsigned long esrt;		/* ESRT table */
830 	efi_get_time_t *get_time;
831 	efi_set_time_t *set_time;
832 	efi_get_wakeup_time_t *get_wakeup_time;
833 	efi_set_wakeup_time_t *set_wakeup_time;
834 	efi_get_variable_t *get_variable;
835 	efi_get_next_variable_t *get_next_variable;
836 	efi_set_variable_t *set_variable;
837 	efi_set_variable_nonblocking_t *set_variable_nonblocking;
838 	efi_query_variable_info_t *query_variable_info;
839 	efi_update_capsule_t *update_capsule;
840 	efi_query_capsule_caps_t *query_capsule_caps;
841 	efi_get_next_high_mono_count_t *get_next_high_mono_count;
842 	efi_reset_system_t *reset_system;
843 	efi_set_virtual_address_map_t *set_virtual_address_map;
844 	struct efi_memory_map *memmap;
845 	unsigned long flags;
846 } efi;
847 
848 static inline int
849 efi_guidcmp (efi_guid_t left, efi_guid_t right)
850 {
851 	return memcmp(&left, &right, sizeof (efi_guid_t));
852 }
853 
854 static inline char *
855 efi_guid_to_str(efi_guid_t *guid, char *out)
856 {
857 	sprintf(out, "%pUl", guid->b);
858         return out;
859 }
860 
861 extern void efi_init (void);
862 extern void *efi_get_pal_addr (void);
863 extern void efi_map_pal_code (void);
864 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
865 extern void efi_gettimeofday (struct timespec *ts);
866 extern void efi_enter_virtual_mode (void);	/* switch EFI to virtual mode, if possible */
867 #ifdef CONFIG_X86
868 extern void efi_late_init(void);
869 extern void efi_free_boot_services(void);
870 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
871 #else
872 static inline void efi_late_init(void) {}
873 static inline void efi_free_boot_services(void) {}
874 
875 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
876 {
877 	return EFI_SUCCESS;
878 }
879 #endif
880 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
881 extern int efi_config_init(efi_config_table_type_t *arch_tables);
882 #ifdef CONFIG_EFI_ESRT
883 extern void __init efi_esrt_init(void);
884 #else
885 static inline void efi_esrt_init(void) { }
886 #endif
887 extern int efi_config_parse_tables(void *config_tables, int count, int sz,
888 				   efi_config_table_type_t *arch_tables);
889 extern u64 efi_get_iobase (void);
890 extern u32 efi_mem_type (unsigned long phys_addr);
891 extern u64 efi_mem_attributes (unsigned long phys_addr);
892 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
893 extern int __init efi_uart_console_only (void);
894 extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
895 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
896 extern void efi_initialize_iomem_resources(struct resource *code_resource,
897 		struct resource *data_resource, struct resource *bss_resource);
898 extern void efi_get_time(struct timespec *now);
899 extern void efi_reserve_boot_services(void);
900 extern int efi_get_fdt_params(struct efi_fdt_params *params, int verbose);
901 extern struct efi_memory_map memmap;
902 extern struct kobject *efi_kobj;
903 
904 extern int efi_reboot_quirk_mode;
905 extern bool efi_poweroff_required(void);
906 
907 /* Iterate through an efi_memory_map */
908 #define for_each_efi_memory_desc(m, md)					   \
909 	for ((md) = (m)->map;						   \
910 	     (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
911 	     (md) = (void *)(md) + (m)->desc_size)
912 
913 /*
914  * Format an EFI memory descriptor's type and attributes to a user-provided
915  * character buffer, as per snprintf(), and return the buffer.
916  */
917 char * __init efi_md_typeattr_format(char *buf, size_t size,
918 				     const efi_memory_desc_t *md);
919 
920 /**
921  * efi_range_is_wc - check the WC bit on an address range
922  * @start: starting kvirt address
923  * @len: length of range
924  *
925  * Consult the EFI memory map and make sure it's ok to set this range WC.
926  * Returns true or false.
927  */
928 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
929 {
930 	unsigned long i;
931 
932 	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
933 		unsigned long paddr = __pa(start + i);
934 		if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
935 			return 0;
936 	}
937 	/* The range checked out */
938 	return 1;
939 }
940 
941 #ifdef CONFIG_EFI_PCDP
942 extern int __init efi_setup_pcdp_console(char *);
943 #endif
944 
945 /*
946  * We play games with efi_enabled so that the compiler will, if
947  * possible, remove EFI-related code altogether.
948  */
949 #define EFI_BOOT		0	/* Were we booted from EFI? */
950 #define EFI_SYSTEM_TABLES	1	/* Can we use EFI system tables? */
951 #define EFI_CONFIG_TABLES	2	/* Can we use EFI config tables? */
952 #define EFI_RUNTIME_SERVICES	3	/* Can we use runtime services? */
953 #define EFI_MEMMAP		4	/* Can we use EFI memory map? */
954 #define EFI_64BIT		5	/* Is the firmware 64-bit? */
955 #define EFI_PARAVIRT		6	/* Access is via a paravirt interface */
956 #define EFI_ARCH_1		7	/* First arch-specific bit */
957 #define EFI_DBG			8	/* Print additional debug info at runtime */
958 
959 #ifdef CONFIG_EFI
960 /*
961  * Test whether the above EFI_* bits are enabled.
962  */
963 static inline bool efi_enabled(int feature)
964 {
965 	return test_bit(feature, &efi.flags) != 0;
966 }
967 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
968 #else
969 static inline bool efi_enabled(int feature)
970 {
971 	return false;
972 }
973 static inline void
974 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
975 #endif
976 
977 /*
978  * Variable Attributes
979  */
980 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
981 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
982 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
983 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
984 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
985 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
986 #define EFI_VARIABLE_APPEND_WRITE	0x0000000000000040
987 
988 #define EFI_VARIABLE_MASK 	(EFI_VARIABLE_NON_VOLATILE | \
989 				EFI_VARIABLE_BOOTSERVICE_ACCESS | \
990 				EFI_VARIABLE_RUNTIME_ACCESS | \
991 				EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
992 				EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
993 				EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
994 				EFI_VARIABLE_APPEND_WRITE)
995 /*
996  * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
997  * not including trailing NUL
998  */
999 #define EFI_VARIABLE_GUID_LEN 36
1000 
1001 /*
1002  * The type of search to perform when calling boottime->locate_handle
1003  */
1004 #define EFI_LOCATE_ALL_HANDLES			0
1005 #define EFI_LOCATE_BY_REGISTER_NOTIFY		1
1006 #define EFI_LOCATE_BY_PROTOCOL			2
1007 
1008 /*
1009  * EFI Device Path information
1010  */
1011 #define EFI_DEV_HW			0x01
1012 #define  EFI_DEV_PCI				 1
1013 #define  EFI_DEV_PCCARD				 2
1014 #define  EFI_DEV_MEM_MAPPED			 3
1015 #define  EFI_DEV_VENDOR				 4
1016 #define  EFI_DEV_CONTROLLER			 5
1017 #define EFI_DEV_ACPI			0x02
1018 #define   EFI_DEV_BASIC_ACPI			 1
1019 #define   EFI_DEV_EXPANDED_ACPI			 2
1020 #define EFI_DEV_MSG			0x03
1021 #define   EFI_DEV_MSG_ATAPI			 1
1022 #define   EFI_DEV_MSG_SCSI			 2
1023 #define   EFI_DEV_MSG_FC			 3
1024 #define   EFI_DEV_MSG_1394			 4
1025 #define   EFI_DEV_MSG_USB			 5
1026 #define   EFI_DEV_MSG_USB_CLASS			15
1027 #define   EFI_DEV_MSG_I20			 6
1028 #define   EFI_DEV_MSG_MAC			11
1029 #define   EFI_DEV_MSG_IPV4			12
1030 #define   EFI_DEV_MSG_IPV6			13
1031 #define   EFI_DEV_MSG_INFINIBAND		 9
1032 #define   EFI_DEV_MSG_UART			14
1033 #define   EFI_DEV_MSG_VENDOR			10
1034 #define EFI_DEV_MEDIA			0x04
1035 #define   EFI_DEV_MEDIA_HARD_DRIVE		 1
1036 #define   EFI_DEV_MEDIA_CDROM			 2
1037 #define   EFI_DEV_MEDIA_VENDOR			 3
1038 #define   EFI_DEV_MEDIA_FILE			 4
1039 #define   EFI_DEV_MEDIA_PROTOCOL		 5
1040 #define EFI_DEV_BIOS_BOOT		0x05
1041 #define EFI_DEV_END_PATH		0x7F
1042 #define EFI_DEV_END_PATH2		0xFF
1043 #define   EFI_DEV_END_INSTANCE			0x01
1044 #define   EFI_DEV_END_ENTIRE			0xFF
1045 
1046 struct efi_generic_dev_path {
1047 	u8 type;
1048 	u8 sub_type;
1049 	u16 length;
1050 } __attribute ((packed));
1051 
1052 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1053 {
1054 	*npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1055 	*addr &= PAGE_MASK;
1056 }
1057 
1058 /*
1059  * EFI Variable support.
1060  *
1061  * Different firmware drivers can expose their EFI-like variables using
1062  * the following.
1063  */
1064 
1065 struct efivar_operations {
1066 	efi_get_variable_t *get_variable;
1067 	efi_get_next_variable_t *get_next_variable;
1068 	efi_set_variable_t *set_variable;
1069 	efi_set_variable_nonblocking_t *set_variable_nonblocking;
1070 	efi_query_variable_store_t *query_variable_store;
1071 };
1072 
1073 struct efivars {
1074 	/*
1075 	 * ->lock protects two things:
1076 	 * 1) efivarfs_list and efivars_sysfs_list
1077 	 * 2) ->ops calls
1078 	 */
1079 	spinlock_t lock;
1080 	struct kset *kset;
1081 	struct kobject *kobject;
1082 	const struct efivar_operations *ops;
1083 };
1084 
1085 /*
1086  * The maximum size of VariableName + Data = 1024
1087  * Therefore, it's reasonable to save that much
1088  * space in each part of the structure,
1089  * and we use a page for reading/writing.
1090  */
1091 
1092 #define EFI_VAR_NAME_LEN	1024
1093 
1094 struct efi_variable {
1095 	efi_char16_t  VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1096 	efi_guid_t    VendorGuid;
1097 	unsigned long DataSize;
1098 	__u8          Data[1024];
1099 	efi_status_t  Status;
1100 	__u32         Attributes;
1101 } __attribute__((packed));
1102 
1103 struct efivar_entry {
1104 	struct efi_variable var;
1105 	struct list_head list;
1106 	struct kobject kobj;
1107 	bool scanning;
1108 	bool deleting;
1109 };
1110 
1111 struct efi_simple_text_output_protocol_32 {
1112 	u32 reset;
1113 	u32 output_string;
1114 	u32 test_string;
1115 };
1116 
1117 struct efi_simple_text_output_protocol_64 {
1118 	u64 reset;
1119 	u64 output_string;
1120 	u64 test_string;
1121 };
1122 
1123 struct efi_simple_text_output_protocol {
1124 	void *reset;
1125 	efi_status_t (*output_string)(void *, void *);
1126 	void *test_string;
1127 };
1128 
1129 extern struct list_head efivar_sysfs_list;
1130 
1131 static inline void
1132 efivar_unregister(struct efivar_entry *var)
1133 {
1134 	kobject_put(&var->kobj);
1135 }
1136 
1137 int efivars_register(struct efivars *efivars,
1138 		     const struct efivar_operations *ops,
1139 		     struct kobject *kobject);
1140 int efivars_unregister(struct efivars *efivars);
1141 struct kobject *efivars_kobject(void);
1142 
1143 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1144 		void *data, bool atomic, bool duplicates,
1145 		struct list_head *head);
1146 
1147 void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1148 void efivar_entry_remove(struct efivar_entry *entry);
1149 
1150 int __efivar_entry_delete(struct efivar_entry *entry);
1151 int efivar_entry_delete(struct efivar_entry *entry);
1152 
1153 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1154 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1155 		       unsigned long *size, void *data);
1156 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1157 		     unsigned long *size, void *data);
1158 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1159 		     unsigned long size, void *data, struct list_head *head);
1160 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1161 			      unsigned long *size, void *data, bool *set);
1162 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1163 			  bool block, unsigned long size, void *data);
1164 
1165 void efivar_entry_iter_begin(void);
1166 void efivar_entry_iter_end(void);
1167 
1168 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1169 			struct list_head *head, void *data,
1170 			struct efivar_entry **prev);
1171 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1172 		      struct list_head *head, void *data);
1173 
1174 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1175 				       struct list_head *head, bool remove);
1176 
1177 bool efivar_validate(efi_char16_t *var_name, u8 *data, unsigned long len);
1178 
1179 extern struct work_struct efivar_work;
1180 void efivar_run_worker(void);
1181 
1182 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1183 int efivars_sysfs_init(void);
1184 
1185 #define EFIVARS_DATA_SIZE_MAX 1024
1186 
1187 #endif /* CONFIG_EFI_VARS */
1188 
1189 #ifdef CONFIG_EFI_RUNTIME_MAP
1190 int efi_runtime_map_init(struct kobject *);
1191 void efi_runtime_map_setup(void *, int, u32);
1192 int efi_get_runtime_map_size(void);
1193 int efi_get_runtime_map_desc_size(void);
1194 int efi_runtime_map_copy(void *buf, size_t bufsz);
1195 #else
1196 static inline int efi_runtime_map_init(struct kobject *kobj)
1197 {
1198 	return 0;
1199 }
1200 
1201 static inline void
1202 efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
1203 
1204 static inline int efi_get_runtime_map_size(void)
1205 {
1206 	return 0;
1207 }
1208 
1209 static inline int efi_get_runtime_map_desc_size(void)
1210 {
1211 	return 0;
1212 }
1213 
1214 static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1215 {
1216 	return 0;
1217 }
1218 
1219 #endif
1220 
1221 /* prototypes shared between arch specific and generic stub code */
1222 
1223 #define pr_efi(sys_table, msg)     efi_printk(sys_table, "EFI stub: "msg)
1224 #define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1225 
1226 void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1227 
1228 void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1229 	      unsigned long addr);
1230 
1231 char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1232 			  efi_loaded_image_t *image, int *cmd_line_len);
1233 
1234 efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1235 				efi_memory_desc_t **map,
1236 				unsigned long *map_size,
1237 				unsigned long *desc_size,
1238 				u32 *desc_ver,
1239 				unsigned long *key_ptr);
1240 
1241 efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1242 			   unsigned long size, unsigned long align,
1243 			   unsigned long *addr);
1244 
1245 efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1246 			    unsigned long size, unsigned long align,
1247 			    unsigned long *addr, unsigned long max);
1248 
1249 efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1250 				 unsigned long *image_addr,
1251 				 unsigned long image_size,
1252 				 unsigned long alloc_size,
1253 				 unsigned long preferred_addr,
1254 				 unsigned long alignment);
1255 
1256 efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1257 				  efi_loaded_image_t *image,
1258 				  char *cmd_line, char *option_string,
1259 				  unsigned long max_addr,
1260 				  unsigned long *load_addr,
1261 				  unsigned long *load_size);
1262 
1263 efi_status_t efi_parse_options(char *cmdline);
1264 
1265 bool efi_runtime_disabled(void);
1266 #endif /* _LINUX_EFI_H */
1267