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