include/linux/efi.h

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