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