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