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