include/linux/efi.h

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