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