include/linux/efi.h

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