1 /* SPDX-License-Identifier: GPL-2.0 */
6 * Extensible Firmware Interface
7 * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
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>
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>
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)))
45 #define EFI_IS_ERROR(x) ((x) & (1UL << (BITS_PER_LONG-1)))
47 typedef unsigned long efi_status_t
;
48 typedef u8 efi_bool_t
;
49 typedef u16 efi_char16_t
; /* UNICODE character */
50 typedef u64 efi_physical_addr_t
;
51 typedef void *efi_handle_t
;
54 * The UEFI spec and EDK2 reference implementation both define EFI_GUID as
55 * struct { u32 a; u16; b; u16 c; u8 d[8]; }; and so the implied alignment
56 * is 32 bits not 8 bits like our guid_t. In some cases (i.e., on 32-bit ARM),
57 * this means that firmware services invoked by the kernel may assume that
58 * efi_guid_t* arguments are 32-bit aligned, and use memory accessors that
59 * do not tolerate misalignment. So let's set the minimum alignment to 32 bits.
61 * Note that the UEFI spec as well as some comments in the EDK2 code base
62 * suggest that EFI_GUID should be 64-bit aligned, but this appears to be
63 * a mistake, given that no code seems to exist that actually enforces that
66 typedef guid_t efi_guid_t
__aligned(__alignof__(u32
));
68 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
69 GUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)
72 * Generic EFI table header
83 * Memory map descriptor:
87 #define EFI_RESERVED_TYPE 0
88 #define EFI_LOADER_CODE 1
89 #define EFI_LOADER_DATA 2
90 #define EFI_BOOT_SERVICES_CODE 3
91 #define EFI_BOOT_SERVICES_DATA 4
92 #define EFI_RUNTIME_SERVICES_CODE 5
93 #define EFI_RUNTIME_SERVICES_DATA 6
94 #define EFI_CONVENTIONAL_MEMORY 7
95 #define EFI_UNUSABLE_MEMORY 8
96 #define EFI_ACPI_RECLAIM_MEMORY 9
97 #define EFI_ACPI_MEMORY_NVS 10
98 #define EFI_MEMORY_MAPPED_IO 11
99 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
100 #define EFI_PAL_CODE 13
101 #define EFI_PERSISTENT_MEMORY 14
102 #define EFI_MAX_MEMORY_TYPE 15
104 /* Attribute values: */
105 #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
106 #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
107 #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
108 #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
109 #define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
110 #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
111 #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
112 #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
113 #define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
114 #define EFI_MEMORY_MORE_RELIABLE \
115 ((u64)0x0000000000010000ULL) /* higher reliability */
116 #define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
117 #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
118 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
120 #define EFI_PAGE_SHIFT 12
121 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
122 #define EFI_PAGES_MAX (U64_MAX >> EFI_PAGE_SHIFT)
138 } efi_capsule_header_t
;
140 struct efi_boot_memmap
{
141 efi_memory_desc_t
**map
;
142 unsigned long *map_size
;
143 unsigned long *desc_size
;
145 unsigned long *key_ptr
;
146 unsigned long *buff_size
;
152 #define EFI_CAPSULE_PERSIST_ACROSS_RESET 0x00010000
153 #define EFI_CAPSULE_POPULATE_SYSTEM_TABLE 0x00020000
154 #define EFI_CAPSULE_INITIATE_RESET 0x00040000
156 struct capsule_info
{
157 efi_capsule_header_t header
;
158 efi_capsule_header_t
*capsule
;
165 size_t page_bytes_remain
;
168 int __efi_capsule_setup_info(struct capsule_info
*cap_info
);
171 * Allocation types for calls to boottime->allocate_pages.
173 #define EFI_ALLOCATE_ANY_PAGES 0
174 #define EFI_ALLOCATE_MAX_ADDRESS 1
175 #define EFI_ALLOCATE_ADDRESS 2
176 #define EFI_MAX_ALLOCATE_TYPE 3
178 typedef int (*efi_freemem_callback_t
) (u64 start
, u64 end
, void *arg
);
181 * Types and defines for Time Services
183 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
184 #define EFI_TIME_IN_DAYLIGHT 0x2
185 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
222 u32 install_protocol_interface
;
223 u32 reinstall_protocol_interface
;
224 u32 uninstall_protocol_interface
;
227 u32 register_protocol_notify
;
229 u32 locate_device_path
;
230 u32 install_configuration_table
;
235 u32 exit_boot_services
;
236 u32 get_next_monotonic_count
;
238 u32 set_watchdog_timer
;
239 u32 connect_controller
;
240 u32 disconnect_controller
;
243 u32 open_protocol_information
;
244 u32 protocols_per_handle
;
245 u32 locate_handle_buffer
;
247 u32 install_multiple_protocol_interfaces
;
248 u32 uninstall_multiple_protocol_interfaces
;
253 } __packed efi_boot_services_32_t
;
270 u64 install_protocol_interface
;
271 u64 reinstall_protocol_interface
;
272 u64 uninstall_protocol_interface
;
275 u64 register_protocol_notify
;
277 u64 locate_device_path
;
278 u64 install_configuration_table
;
283 u64 exit_boot_services
;
284 u64 get_next_monotonic_count
;
286 u64 set_watchdog_timer
;
287 u64 connect_controller
;
288 u64 disconnect_controller
;
291 u64 open_protocol_information
;
292 u64 protocols_per_handle
;
293 u64 locate_handle_buffer
;
295 u64 install_multiple_protocol_interfaces
;
296 u64 uninstall_multiple_protocol_interfaces
;
301 } __packed efi_boot_services_64_t
;
304 * EFI Boot Services table
310 efi_status_t (*allocate_pages
)(int, int, unsigned long,
311 efi_physical_addr_t
*);
312 efi_status_t (*free_pages
)(efi_physical_addr_t
, unsigned long);
313 efi_status_t (*get_memory_map
)(unsigned long *, void *, unsigned long *,
314 unsigned long *, u32
*);
315 efi_status_t (*allocate_pool
)(int, unsigned long, void **);
316 efi_status_t (*free_pool
)(void *);
319 void *wait_for_event
;
323 void *install_protocol_interface
;
324 void *reinstall_protocol_interface
;
325 void *uninstall_protocol_interface
;
326 efi_status_t (*handle_protocol
)(efi_handle_t
, efi_guid_t
*, void **);
328 void *register_protocol_notify
;
329 efi_status_t (*locate_handle
)(int, efi_guid_t
*, void *,
330 unsigned long *, efi_handle_t
*);
331 void *locate_device_path
;
332 efi_status_t (*install_configuration_table
)(efi_guid_t
*, void *);
337 efi_status_t (*exit_boot_services
)(efi_handle_t
, unsigned long);
338 void *get_next_monotonic_count
;
340 void *set_watchdog_timer
;
341 void *connect_controller
;
342 void *disconnect_controller
;
344 void *close_protocol
;
345 void *open_protocol_information
;
346 void *protocols_per_handle
;
347 void *locate_handle_buffer
;
348 efi_status_t (*locate_protocol
)(efi_guid_t
*, void *, void **);
349 void *install_multiple_protocol_interfaces
;
350 void *uninstall_multiple_protocol_interfaces
;
351 void *calculate_crc32
;
354 void *create_event_ex
;
355 } efi_boot_services_t
;
362 EfiPciIoWidthFifoUint8
,
363 EfiPciIoWidthFifoUint16
,
364 EfiPciIoWidthFifoUint32
,
365 EfiPciIoWidthFifoUint64
,
366 EfiPciIoWidthFillUint8
,
367 EfiPciIoWidthFillUint16
,
368 EfiPciIoWidthFillUint32
,
369 EfiPciIoWidthFillUint64
,
371 } EFI_PCI_IO_PROTOCOL_WIDTH
;
374 EfiPciIoAttributeOperationGet
,
375 EfiPciIoAttributeOperationSet
,
376 EfiPciIoAttributeOperationEnable
,
377 EfiPciIoAttributeOperationDisable
,
378 EfiPciIoAttributeOperationSupported
,
379 EfiPciIoAttributeOperationMaximum
380 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION
;
385 } efi_pci_io_protocol_access_32_t
;
390 } efi_pci_io_protocol_access_64_t
;
395 } efi_pci_io_protocol_access_t
;
400 efi_pci_io_protocol_access_32_t mem
;
401 efi_pci_io_protocol_access_32_t io
;
402 efi_pci_io_protocol_access_32_t pci
;
411 u32 get_bar_attributes
;
412 u32 set_bar_attributes
;
415 } efi_pci_io_protocol_32_t
;
420 efi_pci_io_protocol_access_64_t mem
;
421 efi_pci_io_protocol_access_64_t io
;
422 efi_pci_io_protocol_access_64_t pci
;
431 u64 get_bar_attributes
;
432 u64 set_bar_attributes
;
435 } efi_pci_io_protocol_64_t
;
440 efi_pci_io_protocol_access_t mem
;
441 efi_pci_io_protocol_access_t io
;
442 efi_pci_io_protocol_access_t pci
;
446 void *allocate_buffer
;
451 void *get_bar_attributes
;
452 void *set_bar_attributes
;
455 } efi_pci_io_protocol_t
;
457 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
458 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
459 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
460 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
461 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
462 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
463 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
464 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
465 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
466 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
467 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
468 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
469 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
470 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
471 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
472 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
473 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
474 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
475 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
483 } apple_properties_protocol_32_t
;
491 } apple_properties_protocol_64_t
;
496 u32 hash_log_extend_event
;
498 u32 get_active_pcr_banks
;
499 u32 set_active_pcr_banks
;
500 u32 get_result_of_set_active_pcr_banks
;
501 } efi_tcg2_protocol_32_t
;
506 u64 hash_log_extend_event
;
508 u64 get_active_pcr_banks
;
509 u64 set_active_pcr_banks
;
510 u64 get_result_of_set_active_pcr_banks
;
511 } efi_tcg2_protocol_64_t
;
513 typedef u32 efi_tcg2_event_log_format
;
516 void *get_capability
;
517 efi_status_t (*get_event_log
)(efi_handle_t
, efi_tcg2_event_log_format
,
518 efi_physical_addr_t
*, efi_physical_addr_t
*, efi_bool_t
*);
519 void *hash_log_extend_event
;
520 void *submit_command
;
521 void *get_active_pcr_banks
;
522 void *set_active_pcr_banks
;
523 void *get_result_of_set_active_pcr_banks
;
524 } efi_tcg2_protocol_t
;
527 * Types and defines for EFI ResetSystem
529 #define EFI_RESET_COLD 0
530 #define EFI_RESET_WARM 1
531 #define EFI_RESET_SHUTDOWN 2
534 * EFI Runtime Services table
536 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
537 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
545 u32 set_virtual_address_map
;
548 u32 get_next_variable
;
550 u32 get_next_high_mono_count
;
553 u32 query_capsule_caps
;
554 u32 query_variable_info
;
555 } efi_runtime_services_32_t
;
563 u64 set_virtual_address_map
;
566 u64 get_next_variable
;
568 u64 get_next_high_mono_count
;
571 u64 query_capsule_caps
;
572 u64 query_variable_info
;
573 } efi_runtime_services_64_t
;
575 typedef efi_status_t
efi_get_time_t (efi_time_t
*tm
, efi_time_cap_t
*tc
);
576 typedef efi_status_t
efi_set_time_t (efi_time_t
*tm
);
577 typedef efi_status_t
efi_get_wakeup_time_t (efi_bool_t
*enabled
, efi_bool_t
*pending
,
579 typedef efi_status_t
efi_set_wakeup_time_t (efi_bool_t enabled
, efi_time_t
*tm
);
580 typedef efi_status_t
efi_get_variable_t (efi_char16_t
*name
, efi_guid_t
*vendor
, u32
*attr
,
581 unsigned long *data_size
, void *data
);
582 typedef efi_status_t
efi_get_next_variable_t (unsigned long *name_size
, efi_char16_t
*name
,
584 typedef efi_status_t
efi_set_variable_t (efi_char16_t
*name
, efi_guid_t
*vendor
,
585 u32 attr
, unsigned long data_size
,
587 typedef efi_status_t
efi_get_next_high_mono_count_t (u32
*count
);
588 typedef void efi_reset_system_t (int reset_type
, efi_status_t status
,
589 unsigned long data_size
, efi_char16_t
*data
);
590 typedef efi_status_t
efi_set_virtual_address_map_t (unsigned long memory_map_size
,
591 unsigned long descriptor_size
,
592 u32 descriptor_version
,
593 efi_memory_desc_t
*virtual_map
);
594 typedef efi_status_t
efi_query_variable_info_t(u32 attr
,
596 u64
*remaining_space
,
597 u64
*max_variable_size
);
598 typedef efi_status_t
efi_update_capsule_t(efi_capsule_header_t
**capsules
,
600 unsigned long sg_list
);
601 typedef efi_status_t
efi_query_capsule_caps_t(efi_capsule_header_t
**capsules
,
605 typedef efi_status_t
efi_query_variable_store_t(u32 attributes
,
611 efi_get_time_t
*get_time
;
612 efi_set_time_t
*set_time
;
613 efi_get_wakeup_time_t
*get_wakeup_time
;
614 efi_set_wakeup_time_t
*set_wakeup_time
;
615 efi_set_virtual_address_map_t
*set_virtual_address_map
;
616 void *convert_pointer
;
617 efi_get_variable_t
*get_variable
;
618 efi_get_next_variable_t
*get_next_variable
;
619 efi_set_variable_t
*set_variable
;
620 efi_get_next_high_mono_count_t
*get_next_high_mono_count
;
621 efi_reset_system_t
*reset_system
;
622 efi_update_capsule_t
*update_capsule
;
623 efi_query_capsule_caps_t
*query_capsule_caps
;
624 efi_query_variable_info_t
*query_variable_info
;
625 } efi_runtime_services_t
;
627 void efi_native_runtime_setup(void);
630 * EFI Configuration Table and GUID definitions
632 * These are all defined in a single line to make them easier to
633 * grep for and to see them at a glance - while still having a
634 * similar structure to the definitions in the spec.
636 * Here's how they are structured:
638 * GUID: 12345678-1234-1234-1234-123456789012
640 * #define EFI_SOME_PROTOCOL_GUID \
641 * {0x12345678,0x1234,0x1234,\
642 * {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
644 * #define SOME_PROTOCOL_GUID EFI_GUID(0x12345678, 0x1234, 0x1234, 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
645 * ^ tabs ^extra space
647 * Note that the 'extra space' separates the values at the same place
648 * where the UEFI SPEC breaks the line.
650 #define NULL_GUID EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
651 #define MPS_TABLE_GUID EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
652 #define ACPI_TABLE_GUID EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
653 #define ACPI_20_TABLE_GUID EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
654 #define SMBIOS_TABLE_GUID EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
655 #define SMBIOS3_TABLE_GUID EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
656 #define SAL_SYSTEM_TABLE_GUID EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
657 #define HCDP_TABLE_GUID EFI_GUID(0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
658 #define UGA_IO_PROTOCOL_GUID EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
659 #define EFI_GLOBAL_VARIABLE_GUID EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
660 #define UV_SYSTEM_TABLE_GUID EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
661 #define LINUX_EFI_CRASH_GUID EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
662 #define LOADED_IMAGE_PROTOCOL_GUID EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
663 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
664 #define EFI_UGA_PROTOCOL_GUID EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
665 #define EFI_PCI_IO_PROTOCOL_GUID EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
666 #define EFI_FILE_INFO_ID EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
667 #define EFI_SYSTEM_RESOURCE_TABLE_GUID EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
668 #define EFI_FILE_SYSTEM_GUID EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
669 #define DEVICE_TREE_GUID EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
670 #define EFI_PROPERTIES_TABLE_GUID EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
671 #define EFI_RNG_PROTOCOL_GUID EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
672 #define EFI_RNG_ALGORITHM_RAW EFI_GUID(0xe43176d7, 0xb6e8, 0x4827, 0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
673 #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
674 #define EFI_CONSOLE_OUT_DEVICE_GUID EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
675 #define APPLE_PROPERTIES_PROTOCOL_GUID EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb, 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
676 #define EFI_TCG2_PROTOCOL_GUID EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
678 #define EFI_IMAGE_SECURITY_DATABASE_GUID EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
679 #define EFI_SHIM_LOCK_GUID EFI_GUID(0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
681 #define EFI_CERT_SHA256_GUID EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
682 #define EFI_CERT_X509_GUID EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
683 #define EFI_CERT_X509_SHA256_GUID EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
686 * This GUID is used to pass to the kernel proper the struct screen_info
687 * structure that was populated by the stub based on the GOP protocol instance
688 * associated with ConOut
690 #define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, 0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
691 #define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
692 #define LINUX_EFI_RANDOM_SEED_TABLE_GUID EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2, 0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
693 #define LINUX_EFI_TPM_EVENT_LOG_GUID EFI_GUID(0xb7799cb0, 0xeca2, 0x4943, 0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
694 #define LINUX_EFI_TPM_FINAL_LOG_GUID EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
695 #define LINUX_EFI_MEMRESERVE_TABLE_GUID EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5, 0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
700 } efi_config_table_64_t
;
705 } efi_config_table_32_t
;
710 } efi_config_table_t
;
716 } efi_config_table_type_t
;
718 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
720 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
721 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
722 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
723 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
724 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
725 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
729 u64 fw_vendor
; /* physical addr of CHAR16 vendor string */
743 } efi_system_table_64_t
;
747 u32 fw_vendor
; /* physical addr of CHAR16 vendor string */
759 } efi_system_table_32_t
;
763 unsigned long fw_vendor
; /* physical addr of CHAR16 vendor string */
765 unsigned long con_in_handle
;
766 unsigned long con_in
;
767 unsigned long con_out_handle
;
768 unsigned long con_out
;
769 unsigned long stderr_handle
;
770 unsigned long stderr
;
771 efi_runtime_services_t
*runtime
;
772 efi_boot_services_t
*boottime
;
773 unsigned long nr_tables
;
774 unsigned long tables
;
775 } efi_system_table_t
;
778 * Architecture independent structure for describing a memory map for the
779 * benefit of efi_memmap_init_early(), saving us the need to pass four
782 struct efi_memory_map_data
{
783 phys_addr_t phys_map
;
785 unsigned long desc_version
;
786 unsigned long desc_size
;
789 struct efi_memory_map
{
790 phys_addr_t phys_map
;
794 unsigned long desc_version
;
795 unsigned long desc_size
;
799 struct efi_mem_range
{
804 struct efi_fdt_params
{
819 u32 load_options_size
;
822 __aligned_u64 image_size
;
823 unsigned int image_code_type
;
824 unsigned int image_data_type
;
825 unsigned long unload
;
826 } efi_loaded_image_32_t
;
835 u32 load_options_size
;
838 __aligned_u64 image_size
;
839 unsigned int image_code_type
;
840 unsigned int image_data_type
;
841 unsigned long unload
;
842 } efi_loaded_image_64_t
;
847 efi_system_table_t
*system_table
;
851 u32 load_options_size
;
854 __aligned_u64 image_size
;
855 unsigned int image_code_type
;
856 unsigned int image_data_type
;
857 unsigned long unload
;
858 } efi_loaded_image_t
;
865 efi_time_t create_time
;
866 efi_time_t last_access_time
;
867 efi_time_t modification_time
;
868 __aligned_u64 attribute
;
869 efi_char16_t filename
[1];
884 } efi_file_handle_32_t
;
898 } efi_file_handle_64_t
;
900 typedef struct _efi_file_handle
{
902 efi_status_t (*open
)(struct _efi_file_handle
*,
903 struct _efi_file_handle
**,
904 efi_char16_t
*, u64
, u64
);
905 efi_status_t (*close
)(struct _efi_file_handle
*);
907 efi_status_t (*read
)(struct _efi_file_handle
*, unsigned long *,
912 efi_status_t (*get_info
)(struct _efi_file_handle
*, efi_guid_t
*,
913 unsigned long *, void *);
921 } efi_file_io_interface_32_t
;
926 } efi_file_io_interface_64_t
;
928 typedef struct _efi_file_io_interface
{
930 int (*open_volume
)(struct _efi_file_io_interface
*,
931 efi_file_handle_t
**);
932 } efi_file_io_interface_t
;
934 #define EFI_FILE_MODE_READ 0x0000000000000001
935 #define EFI_FILE_MODE_WRITE 0x0000000000000002
936 #define EFI_FILE_MODE_CREATE 0x8000000000000000
941 u64 memory_protection_attribute
;
942 } efi_properties_table_t
;
944 #define EFI_PROPERTIES_TABLE_VERSION 0x00010000
945 #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
947 #define EFI_INVALID_TABLE_ADDR (~0UL)
954 efi_memory_desc_t entry
[0];
955 } efi_memory_attributes_table_t
;
958 efi_guid_t signature_owner
;
960 } efi_signature_data_t
;
963 efi_guid_t signature_type
;
964 u32 signature_list_size
;
965 u32 signature_header_size
;
967 u8 signature_header
[];
968 /* efi_signature_data_t signatures[][] */
969 } efi_signature_list_t
;
971 typedef u8 efi_sha256_hash_t
[32];
974 efi_sha256_hash_t to_be_signed_hash
;
975 efi_time_t time_of_revocation
;
976 } efi_cert_x509_sha256_t
;
979 * All runtime access to EFI goes through this structure:
982 efi_system_table_t
*systab
; /* EFI system table */
983 unsigned int runtime_version
; /* Runtime services version */
984 unsigned long mps
; /* MPS table */
985 unsigned long acpi
; /* ACPI table (IA64 ext 0.71) */
986 unsigned long acpi20
; /* ACPI table (ACPI 2.0) */
987 unsigned long smbios
; /* SMBIOS table (32 bit entry point) */
988 unsigned long smbios3
; /* SMBIOS table (64 bit entry point) */
989 unsigned long sal_systab
; /* SAL system table */
990 unsigned long boot_info
; /* boot info table */
991 unsigned long hcdp
; /* HCDP table */
992 unsigned long uga
; /* UGA table */
993 unsigned long uv_systab
; /* UV system table */
994 unsigned long fw_vendor
; /* fw_vendor */
995 unsigned long runtime
; /* runtime table */
996 unsigned long config_table
; /* config tables */
997 unsigned long esrt
; /* ESRT table */
998 unsigned long properties_table
; /* properties table */
999 unsigned long mem_attr_table
; /* memory attributes table */
1000 unsigned long rng_seed
; /* UEFI firmware random seed */
1001 unsigned long tpm_log
; /* TPM2 Event Log table */
1002 unsigned long tpm_final_log
; /* TPM2 Final Events Log table */
1003 unsigned long mem_reserve
; /* Linux EFI memreserve table */
1004 efi_get_time_t
*get_time
;
1005 efi_set_time_t
*set_time
;
1006 efi_get_wakeup_time_t
*get_wakeup_time
;
1007 efi_set_wakeup_time_t
*set_wakeup_time
;
1008 efi_get_variable_t
*get_variable
;
1009 efi_get_next_variable_t
*get_next_variable
;
1010 efi_set_variable_t
*set_variable
;
1011 efi_set_variable_t
*set_variable_nonblocking
;
1012 efi_query_variable_info_t
*query_variable_info
;
1013 efi_query_variable_info_t
*query_variable_info_nonblocking
;
1014 efi_update_capsule_t
*update_capsule
;
1015 efi_query_capsule_caps_t
*query_capsule_caps
;
1016 efi_get_next_high_mono_count_t
*get_next_high_mono_count
;
1017 efi_reset_system_t
*reset_system
;
1018 efi_set_virtual_address_map_t
*set_virtual_address_map
;
1019 struct efi_memory_map memmap
;
1020 unsigned long flags
;
1023 extern struct mm_struct efi_mm
;
1026 efi_guidcmp (efi_guid_t left
, efi_guid_t right
)
1028 return memcmp(&left
, &right
, sizeof (efi_guid_t
));
1031 static inline char *
1032 efi_guid_to_str(efi_guid_t
*guid
, char *out
)
1034 sprintf(out
, "%pUl", guid
->b
);
1038 extern void efi_init (void);
1039 extern void *efi_get_pal_addr (void);
1040 extern void efi_map_pal_code (void);
1041 extern void efi_memmap_walk (efi_freemem_callback_t callback
, void *arg
);
1042 extern void efi_gettimeofday (struct timespec64
*ts
);
1043 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
1045 extern efi_status_t
efi_query_variable_store(u32 attributes
,
1048 extern void efi_find_mirror(void);
1051 static inline efi_status_t
efi_query_variable_store(u32 attributes
,
1058 extern void __iomem
*efi_lookup_mapped_addr(u64 phys_addr
);
1060 extern phys_addr_t __init
efi_memmap_alloc(unsigned int num_entries
);
1061 extern int __init
efi_memmap_init_early(struct efi_memory_map_data
*data
);
1062 extern int __init
efi_memmap_init_late(phys_addr_t addr
, unsigned long size
);
1063 extern void __init
efi_memmap_unmap(void);
1064 extern int __init
efi_memmap_install(phys_addr_t addr
, unsigned int nr_map
);
1065 extern int __init
efi_memmap_split_count(efi_memory_desc_t
*md
,
1066 struct range
*range
);
1067 extern void __init
efi_memmap_insert(struct efi_memory_map
*old_memmap
,
1068 void *buf
, struct efi_mem_range
*mem
);
1070 extern int efi_config_init(efi_config_table_type_t
*arch_tables
);
1071 #ifdef CONFIG_EFI_ESRT
1072 extern void __init
efi_esrt_init(void);
1074 static inline void efi_esrt_init(void) { }
1076 extern int efi_config_parse_tables(void *config_tables
, int count
, int sz
,
1077 efi_config_table_type_t
*arch_tables
);
1078 extern u64
efi_get_iobase (void);
1079 extern int efi_mem_type(unsigned long phys_addr
);
1080 extern u64
efi_mem_attributes (unsigned long phys_addr
);
1081 extern u64
efi_mem_attribute (unsigned long phys_addr
, unsigned long size
);
1082 extern int __init
efi_uart_console_only (void);
1083 extern u64
efi_mem_desc_end(efi_memory_desc_t
*md
);
1084 extern int efi_mem_desc_lookup(u64 phys_addr
, efi_memory_desc_t
*out_md
);
1085 extern void efi_mem_reserve(phys_addr_t addr
, u64 size
);
1086 extern int efi_mem_reserve_persistent(phys_addr_t addr
, u64 size
);
1087 extern void efi_initialize_iomem_resources(struct resource
*code_resource
,
1088 struct resource
*data_resource
, struct resource
*bss_resource
);
1089 extern int efi_get_fdt_params(struct efi_fdt_params
*params
);
1090 extern struct kobject
*efi_kobj
;
1092 extern int efi_reboot_quirk_mode
;
1093 extern bool efi_poweroff_required(void);
1095 #ifdef CONFIG_EFI_FAKE_MEMMAP
1096 extern void __init
efi_fake_memmap(void);
1098 static inline void efi_fake_memmap(void) { }
1102 * efi_memattr_perm_setter - arch specific callback function passed into
1103 * efi_memattr_apply_permissions() that updates the
1104 * mapping permissions described by the second
1105 * argument in the page tables referred to by the
1108 typedef int (*efi_memattr_perm_setter
)(struct mm_struct
*, efi_memory_desc_t
*);
1110 extern int efi_memattr_init(void);
1111 extern int efi_memattr_apply_permissions(struct mm_struct
*mm
,
1112 efi_memattr_perm_setter fn
);
1115 * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor
1116 * @map: the start of efi memmap
1117 * @desc_size: the size of space for each EFI memmap descriptor
1118 * @n: the index of efi memmap descriptor
1120 * EFI boot service provides the GetMemoryMap() function to get a copy of the
1121 * current memory map which is an array of memory descriptors, each of
1122 * which describes a contiguous block of memory. It also gets the size of the
1123 * map, and the size of each descriptor, etc.
1125 * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
1126 * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
1127 * since efi_memory_memdesc_t may be extended in the future. Thus the OS
1128 * MUST use the returned size of the descriptor to find the start of each
1129 * efi_memory_memdesc_t in the memory map array. This should only be used
1130 * during bootup since for_each_efi_memory_desc_xxx() is available after the
1131 * kernel initializes the EFI subsystem to set up struct efi_memory_map.
1133 #define efi_early_memdesc_ptr(map, desc_size, n) \
1134 (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
1136 /* Iterate through an efi_memory_map */
1137 #define for_each_efi_memory_desc_in_map(m, md) \
1138 for ((md) = (m)->map; \
1139 (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end; \
1140 (md) = (void *)(md) + (m)->desc_size)
1143 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
1144 * @md: the efi_memory_desc_t * iterator
1146 * Once the loop finishes @md must not be accessed.
1148 #define for_each_efi_memory_desc(md) \
1149 for_each_efi_memory_desc_in_map(&efi.memmap, md)
1152 * Format an EFI memory descriptor's type and attributes to a user-provided
1153 * character buffer, as per snprintf(), and return the buffer.
1155 char * __init
efi_md_typeattr_format(char *buf
, size_t size
,
1156 const efi_memory_desc_t
*md
);
1159 typedef void (*efi_element_handler_t
)(const char *source
,
1160 const void *element_data
,
1161 size_t element_size
);
1162 extern int __init
parse_efi_signature_list(
1164 const void *data
, size_t size
,
1165 efi_element_handler_t (*get_handler_for_guid
)(const efi_guid_t
*));
1168 * efi_range_is_wc - check the WC bit on an address range
1169 * @start: starting kvirt address
1170 * @len: length of range
1172 * Consult the EFI memory map and make sure it's ok to set this range WC.
1173 * Returns true or false.
1175 static inline int efi_range_is_wc(unsigned long start
, unsigned long len
)
1179 for (i
= 0; i
< len
; i
+= (1UL << EFI_PAGE_SHIFT
)) {
1180 unsigned long paddr
= __pa(start
+ i
);
1181 if (!(efi_mem_attributes(paddr
) & EFI_MEMORY_WC
))
1184 /* The range checked out */
1188 #ifdef CONFIG_EFI_PCDP
1189 extern int __init
efi_setup_pcdp_console(char *);
1193 * We play games with efi_enabled so that the compiler will, if
1194 * possible, remove EFI-related code altogether.
1196 #define EFI_BOOT 0 /* Were we booted from EFI? */
1197 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
1198 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
1199 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
1200 #define EFI_64BIT 5 /* Is the firmware 64-bit? */
1201 #define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
1202 #define EFI_ARCH_1 7 /* First arch-specific bit */
1203 #define EFI_DBG 8 /* Print additional debug info at runtime */
1204 #define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
1205 #define EFI_MEM_ATTR 10 /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
1209 * Test whether the above EFI_* bits are enabled.
1211 static inline bool efi_enabled(int feature
)
1213 return test_bit(feature
, &efi
.flags
) != 0;
1215 extern void efi_reboot(enum reboot_mode reboot_mode
, const char *__unused
);
1217 extern bool efi_is_table_address(unsigned long phys_addr
);
1219 static inline bool efi_enabled(int feature
)
1224 efi_reboot(enum reboot_mode reboot_mode
, const char *__unused
) {}
1227 efi_capsule_pending(int *reset_type
)
1232 static inline bool efi_is_table_address(unsigned long phys_addr
)
1238 extern int efi_status_to_err(efi_status_t status
);
1239 extern const char *efi_status_to_str(efi_status_t status
);
1242 * Variable Attributes
1244 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
1245 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1246 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
1247 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1248 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1249 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1250 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
1252 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
1253 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1254 EFI_VARIABLE_RUNTIME_ACCESS | \
1255 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1256 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1257 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1258 EFI_VARIABLE_APPEND_WRITE)
1260 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1261 * not including trailing NUL
1263 #define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN
1266 * The type of search to perform when calling boottime->locate_handle
1268 #define EFI_LOCATE_ALL_HANDLES 0
1269 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1270 #define EFI_LOCATE_BY_PROTOCOL 2
1273 * EFI Device Path information
1275 #define EFI_DEV_HW 0x01
1276 #define EFI_DEV_PCI 1
1277 #define EFI_DEV_PCCARD 2
1278 #define EFI_DEV_MEM_MAPPED 3
1279 #define EFI_DEV_VENDOR 4
1280 #define EFI_DEV_CONTROLLER 5
1281 #define EFI_DEV_ACPI 0x02
1282 #define EFI_DEV_BASIC_ACPI 1
1283 #define EFI_DEV_EXPANDED_ACPI 2
1284 #define EFI_DEV_MSG 0x03
1285 #define EFI_DEV_MSG_ATAPI 1
1286 #define EFI_DEV_MSG_SCSI 2
1287 #define EFI_DEV_MSG_FC 3
1288 #define EFI_DEV_MSG_1394 4
1289 #define EFI_DEV_MSG_USB 5
1290 #define EFI_DEV_MSG_USB_CLASS 15
1291 #define EFI_DEV_MSG_I20 6
1292 #define EFI_DEV_MSG_MAC 11
1293 #define EFI_DEV_MSG_IPV4 12
1294 #define EFI_DEV_MSG_IPV6 13
1295 #define EFI_DEV_MSG_INFINIBAND 9
1296 #define EFI_DEV_MSG_UART 14
1297 #define EFI_DEV_MSG_VENDOR 10
1298 #define EFI_DEV_MEDIA 0x04
1299 #define EFI_DEV_MEDIA_HARD_DRIVE 1
1300 #define EFI_DEV_MEDIA_CDROM 2
1301 #define EFI_DEV_MEDIA_VENDOR 3
1302 #define EFI_DEV_MEDIA_FILE 4
1303 #define EFI_DEV_MEDIA_PROTOCOL 5
1304 #define EFI_DEV_BIOS_BOOT 0x05
1305 #define EFI_DEV_END_PATH 0x7F
1306 #define EFI_DEV_END_PATH2 0xFF
1307 #define EFI_DEV_END_INSTANCE 0x01
1308 #define EFI_DEV_END_ENTIRE 0xFF
1310 struct efi_generic_dev_path
{
1314 } __attribute ((packed
));
1316 struct efi_dev_path
{
1317 u8 type
; /* can be replaced with unnamed */
1318 u8 sub_type
; /* struct efi_generic_dev_path; */
1319 u16 length
; /* once we've moved to -std=c11 */
1330 } __attribute ((packed
));
1332 #if IS_ENABLED(CONFIG_EFI_DEV_PATH_PARSER)
1333 struct device
*efi_get_device_by_path(struct efi_dev_path
**node
, size_t *len
);
1336 static inline void memrange_efi_to_native(u64
*addr
, u64
*npages
)
1338 *npages
= PFN_UP(*addr
+ (*npages
<<EFI_PAGE_SHIFT
)) - PFN_DOWN(*addr
);
1343 * EFI Variable support.
1345 * Different firmware drivers can expose their EFI-like variables using
1349 struct efivar_operations
{
1350 efi_get_variable_t
*get_variable
;
1351 efi_get_next_variable_t
*get_next_variable
;
1352 efi_set_variable_t
*set_variable
;
1353 efi_set_variable_t
*set_variable_nonblocking
;
1354 efi_query_variable_store_t
*query_variable_store
;
1359 struct kobject
*kobject
;
1360 const struct efivar_operations
*ops
;
1364 * The maximum size of VariableName + Data = 1024
1365 * Therefore, it's reasonable to save that much
1366 * space in each part of the structure,
1367 * and we use a page for reading/writing.
1370 #define EFI_VAR_NAME_LEN 1024
1372 struct efi_variable
{
1373 efi_char16_t VariableName
[EFI_VAR_NAME_LEN
/sizeof(efi_char16_t
)];
1374 efi_guid_t VendorGuid
;
1375 unsigned long DataSize
;
1377 efi_status_t Status
;
1379 } __attribute__((packed
));
1381 struct efivar_entry
{
1382 struct efi_variable var
;
1383 struct list_head list
;
1384 struct kobject kobj
;
1393 } efi_simple_text_output_protocol_32_t
;
1399 } efi_simple_text_output_protocol_64_t
;
1401 struct efi_simple_text_output_protocol
{
1403 efi_status_t (*output_string
)(void *, void *);
1407 #define PIXEL_RGB_RESERVED_8BIT_PER_COLOR 0
1408 #define PIXEL_BGR_RESERVED_8BIT_PER_COLOR 1
1409 #define PIXEL_BIT_MASK 2
1410 #define PIXEL_BLT_ONLY 3
1411 #define PIXEL_FORMAT_MAX 4
1413 struct efi_pixel_bitmask
{
1420 struct efi_graphics_output_mode_info
{
1422 u32 horizontal_resolution
;
1423 u32 vertical_resolution
;
1425 struct efi_pixel_bitmask pixel_information
;
1426 u32 pixels_per_scan_line
;
1429 struct efi_graphics_output_protocol_mode_32
{
1434 u64 frame_buffer_base
;
1435 u32 frame_buffer_size
;
1438 struct efi_graphics_output_protocol_mode_64
{
1443 u64 frame_buffer_base
;
1444 u64 frame_buffer_size
;
1447 struct efi_graphics_output_protocol_mode
{
1451 unsigned long size_of_info
;
1452 u64 frame_buffer_base
;
1453 unsigned long frame_buffer_size
;
1456 struct efi_graphics_output_protocol_32
{
1463 struct efi_graphics_output_protocol_64
{
1470 struct efi_graphics_output_protocol
{
1471 unsigned long query_mode
;
1472 unsigned long set_mode
;
1474 struct efi_graphics_output_protocol_mode
*mode
;
1477 typedef efi_status_t (*efi_graphics_output_protocol_query_mode
)(
1478 struct efi_graphics_output_protocol
*, u32
, unsigned long *,
1479 struct efi_graphics_output_mode_info
**);
1481 extern struct list_head efivar_sysfs_list
;
1484 efivar_unregister(struct efivar_entry
*var
)
1486 kobject_put(&var
->kobj
);
1489 int efivars_register(struct efivars
*efivars
,
1490 const struct efivar_operations
*ops
,
1491 struct kobject
*kobject
);
1492 int efivars_unregister(struct efivars
*efivars
);
1493 struct kobject
*efivars_kobject(void);
1495 int efivar_init(int (*func
)(efi_char16_t
*, efi_guid_t
, unsigned long, void *),
1496 void *data
, bool duplicates
, struct list_head
*head
);
1498 int efivar_entry_add(struct efivar_entry
*entry
, struct list_head
*head
);
1499 int efivar_entry_remove(struct efivar_entry
*entry
);
1501 int __efivar_entry_delete(struct efivar_entry
*entry
);
1502 int efivar_entry_delete(struct efivar_entry
*entry
);
1504 int efivar_entry_size(struct efivar_entry
*entry
, unsigned long *size
);
1505 int __efivar_entry_get(struct efivar_entry
*entry
, u32
*attributes
,
1506 unsigned long *size
, void *data
);
1507 int efivar_entry_get(struct efivar_entry
*entry
, u32
*attributes
,
1508 unsigned long *size
, void *data
);
1509 int efivar_entry_set(struct efivar_entry
*entry
, u32 attributes
,
1510 unsigned long size
, void *data
, struct list_head
*head
);
1511 int efivar_entry_set_get_size(struct efivar_entry
*entry
, u32 attributes
,
1512 unsigned long *size
, void *data
, bool *set
);
1513 int efivar_entry_set_safe(efi_char16_t
*name
, efi_guid_t vendor
, u32 attributes
,
1514 bool block
, unsigned long size
, void *data
);
1516 int efivar_entry_iter_begin(void);
1517 void efivar_entry_iter_end(void);
1519 int __efivar_entry_iter(int (*func
)(struct efivar_entry
*, void *),
1520 struct list_head
*head
, void *data
,
1521 struct efivar_entry
**prev
);
1522 int efivar_entry_iter(int (*func
)(struct efivar_entry
*, void *),
1523 struct list_head
*head
, void *data
);
1525 struct efivar_entry
*efivar_entry_find(efi_char16_t
*name
, efi_guid_t guid
,
1526 struct list_head
*head
, bool remove
);
1528 bool efivar_validate(efi_guid_t vendor
, efi_char16_t
*var_name
, u8
*data
,
1529 unsigned long data_size
);
1530 bool efivar_variable_is_removable(efi_guid_t vendor
, const char *name
,
1533 extern struct work_struct efivar_work
;
1534 void efivar_run_worker(void);
1536 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1537 int efivars_sysfs_init(void);
1539 #define EFIVARS_DATA_SIZE_MAX 1024
1541 #endif /* CONFIG_EFI_VARS */
1542 extern bool efi_capsule_pending(int *reset_type
);
1544 extern int efi_capsule_supported(efi_guid_t guid
, u32 flags
,
1545 size_t size
, int *reset
);
1547 extern int efi_capsule_update(efi_capsule_header_t
*capsule
,
1548 phys_addr_t
*pages
);
1550 #ifdef CONFIG_EFI_RUNTIME_MAP
1551 int efi_runtime_map_init(struct kobject
*);
1552 int efi_get_runtime_map_size(void);
1553 int efi_get_runtime_map_desc_size(void);
1554 int efi_runtime_map_copy(void *buf
, size_t bufsz
);
1556 static inline int efi_runtime_map_init(struct kobject
*kobj
)
1561 static inline int efi_get_runtime_map_size(void)
1566 static inline int efi_get_runtime_map_desc_size(void)
1571 static inline int efi_runtime_map_copy(void *buf
, size_t bufsz
)
1578 /* prototypes shared between arch specific and generic stub code */
1580 void efi_printk(efi_system_table_t
*sys_table_arg
, char *str
);
1582 void efi_free(efi_system_table_t
*sys_table_arg
, unsigned long size
,
1583 unsigned long addr
);
1585 char *efi_convert_cmdline(efi_system_table_t
*sys_table_arg
,
1586 efi_loaded_image_t
*image
, int *cmd_line_len
);
1588 efi_status_t
efi_get_memory_map(efi_system_table_t
*sys_table_arg
,
1589 struct efi_boot_memmap
*map
);
1591 efi_status_t
efi_low_alloc(efi_system_table_t
*sys_table_arg
,
1592 unsigned long size
, unsigned long align
,
1593 unsigned long *addr
);
1595 efi_status_t
efi_high_alloc(efi_system_table_t
*sys_table_arg
,
1596 unsigned long size
, unsigned long align
,
1597 unsigned long *addr
, unsigned long max
);
1599 efi_status_t
efi_relocate_kernel(efi_system_table_t
*sys_table_arg
,
1600 unsigned long *image_addr
,
1601 unsigned long image_size
,
1602 unsigned long alloc_size
,
1603 unsigned long preferred_addr
,
1604 unsigned long alignment
);
1606 efi_status_t
handle_cmdline_files(efi_system_table_t
*sys_table_arg
,
1607 efi_loaded_image_t
*image
,
1608 char *cmd_line
, char *option_string
,
1609 unsigned long max_addr
,
1610 unsigned long *load_addr
,
1611 unsigned long *load_size
);
1613 efi_status_t
efi_parse_options(char const *cmdline
);
1615 efi_status_t
efi_setup_gop(efi_system_table_t
*sys_table_arg
,
1616 struct screen_info
*si
, efi_guid_t
*proto
,
1617 unsigned long size
);
1620 extern bool efi_runtime_disabled(void);
1622 static inline bool efi_runtime_disabled(void) { return true; }
1625 extern void efi_call_virt_check_flags(unsigned long flags
, const char *call
);
1626 extern unsigned long efi_call_virt_save_flags(void);
1628 enum efi_secureboot_mode
{
1629 efi_secureboot_mode_unset
,
1630 efi_secureboot_mode_unknown
,
1631 efi_secureboot_mode_disabled
,
1632 efi_secureboot_mode_enabled
,
1634 enum efi_secureboot_mode
efi_get_secureboot(efi_system_table_t
*sys_table
);
1636 #ifdef CONFIG_RESET_ATTACK_MITIGATION
1637 void efi_enable_reset_attack_mitigation(efi_system_table_t
*sys_table_arg
);
1640 efi_enable_reset_attack_mitigation(efi_system_table_t
*sys_table_arg
) { }
1643 void efi_retrieve_tpm2_eventlog(efi_system_table_t
*sys_table
);
1646 * Arch code can implement the following three template macros, avoiding
1647 * reptition for the void/non-void return cases of {__,}efi_call_virt():
1649 * * arch_efi_call_virt_setup()
1651 * Sets up the environment for the call (e.g. switching page tables,
1652 * allowing kernel-mode use of floating point, if required).
1654 * * arch_efi_call_virt()
1656 * Performs the call. The last expression in the macro must be the call
1657 * itself, allowing the logic to be shared by the void and non-void
1660 * * arch_efi_call_virt_teardown()
1662 * Restores the usual kernel environment once the call has returned.
1665 #define efi_call_virt_pointer(p, f, args...) \
1668 unsigned long __flags; \
1670 arch_efi_call_virt_setup(); \
1672 __flags = efi_call_virt_save_flags(); \
1673 __s = arch_efi_call_virt(p, f, args); \
1674 efi_call_virt_check_flags(__flags, __stringify(f)); \
1676 arch_efi_call_virt_teardown(); \
1681 #define __efi_call_virt_pointer(p, f, args...) \
1683 unsigned long __flags; \
1685 arch_efi_call_virt_setup(); \
1687 __flags = efi_call_virt_save_flags(); \
1688 arch_efi_call_virt(p, f, args); \
1689 efi_call_virt_check_flags(__flags, __stringify(f)); \
1691 arch_efi_call_virt_teardown(); \
1694 typedef efi_status_t (*efi_exit_boot_map_processing
)(
1695 efi_system_table_t
*sys_table_arg
,
1696 struct efi_boot_memmap
*map
,
1699 efi_status_t
efi_exit_boot_services(efi_system_table_t
*sys_table
,
1701 struct efi_boot_memmap
*map
,
1703 efi_exit_boot_map_processing priv_func
);
1705 #define EFI_RANDOM_SEED_SIZE 64U
1707 struct linux_efi_random_seed
{
1712 struct linux_efi_tpm_eventlog
{
1714 u32 final_events_preboot_size
;
1719 extern int efi_tpm_eventlog_init(void);
1721 struct efi_tcg2_final_events_table
{
1726 extern int efi_tpm_final_log_size
;
1729 * efi_runtime_service() function identifiers.
1730 * "NONE" is used by efi_recover_from_page_fault() to check if the page
1731 * fault happened while executing an efi runtime service.
1737 EFI_GET_WAKEUP_TIME
,
1738 EFI_SET_WAKEUP_TIME
,
1740 EFI_GET_NEXT_VARIABLE
,
1742 EFI_QUERY_VARIABLE_INFO
,
1743 EFI_GET_NEXT_HIGH_MONO_COUNT
,
1746 EFI_QUERY_CAPSULE_CAPS
,
1750 * efi_runtime_work: Details of EFI Runtime Service work
1751 * @arg<1-5>: EFI Runtime Service function arguments
1752 * @status: Status of executing EFI Runtime Service
1753 * @efi_rts_id: EFI Runtime Service function identifier
1754 * @efi_rts_comp: Struct used for handling completions
1756 struct efi_runtime_work
{
1762 efi_status_t status
;
1763 struct work_struct work
;
1764 enum efi_rts_ids efi_rts_id
;
1765 struct completion efi_rts_comp
;
1768 extern struct efi_runtime_work efi_rts_work
;
1770 /* Workqueue to queue EFI Runtime Services */
1771 extern struct workqueue_struct
*efi_rts_wq
;
1773 struct linux_efi_memreserve
{
1774 int size
; // allocated size of the array
1775 atomic_t count
; // number of entries used
1776 phys_addr_t next
; // pa of next struct instance
1783 #define EFI_MEMRESERVE_SIZE(count) (sizeof(struct linux_efi_memreserve) + \
1784 (count) * sizeof(((struct linux_efi_memreserve *)0)->entry[0]))
1786 #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1787 / sizeof(((struct linux_efi_memreserve *)0)->entry[0]))
1789 #endif /* _LINUX_EFI_H */