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