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