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