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