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         u64 romsize;
 384         u32 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         u64 romsize;
 404         u64 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 /*
 448  * Types and defines for EFI ResetSystem
 449  */
 450 #define EFI_RESET_COLD 0
 451 #define EFI_RESET_WARM 1
 452 #define EFI_RESET_SHUTDOWN 2
 453
 454 /*
 455  * EFI Runtime Services table
 456  */
 457 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 458 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
 459
 460 typedef struct {
 461         efi_table_hdr_t hdr;
 462         u32 get_time;
 463         u32 set_time;
 464         u32 get_wakeup_time;
 465         u32 set_wakeup_time;
 466         u32 set_virtual_address_map;
 467         u32 convert_pointer;
 468         u32 get_variable;
 469         u32 get_next_variable;
 470         u32 set_variable;
 471         u32 get_next_high_mono_count;
 472         u32 reset_system;
 473         u32 update_capsule;
 474         u32 query_capsule_caps;
 475         u32 query_variable_info;
 476 } efi_runtime_services_32_t;
 477
 478 typedef struct {
 479         efi_table_hdr_t hdr;
 480         u64 get_time;
 481         u64 set_time;
 482         u64 get_wakeup_time;
 483         u64 set_wakeup_time;
 484         u64 set_virtual_address_map;
 485         u64 convert_pointer;
 486         u64 get_variable;
 487         u64 get_next_variable;
 488         u64 set_variable;
 489         u64 get_next_high_mono_count;
 490         u64 reset_system;
 491         u64 update_capsule;
 492         u64 query_capsule_caps;
 493         u64 query_variable_info;
 494 } efi_runtime_services_64_t;
 495
 496 typedef struct {
 497         efi_table_hdr_t hdr;
 498         void *get_time;
 499         void *set_time;
 500         void *get_wakeup_time;
 501         void *set_wakeup_time;
 502         void *set_virtual_address_map;
 503         void *convert_pointer;
 504         void *get_variable;
 505         void *get_next_variable;
 506         void *set_variable;
 507         void *get_next_high_mono_count;
 508         void *reset_system;
 509         void *update_capsule;
 510         void *query_capsule_caps;
 511         void *query_variable_info;
 512 } efi_runtime_services_t;
 513
 514 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 515 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 516 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 517                                             efi_time_t *tm);
 518 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 519 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 520                                          unsigned long *data_size, void *data);
 521 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 522                                               efi_guid_t *vendor);
 523 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 524                                          u32 attr, unsigned long data_size,
 525                                          void *data);
 526 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 527 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 528                                  unsigned long data_size, efi_char16_t *data);
 529 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 530                                                 unsigned long descriptor_size,
 531                                                 u32 descriptor_version,
 532                                                 efi_memory_desc_t *virtual_map);
 533 typedef efi_status_t efi_query_variable_info_t(u32 attr,
 534                                                u64 *storage_space,
 535                                                u64 *remaining_space,
 536                                                u64 *max_variable_size);
 537 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
 538                                           unsigned long count,
 539                                           unsigned long sg_list);
 540 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
 541                                               unsigned long count,
 542                                               u64 *max_size,
 543                                               int *reset_type);
 544 typedef efi_status_t efi_query_variable_store_t(u32 attributes,
 545                                                 unsigned long size,
 546                                                 bool nonblocking);
 547
 548 void efi_native_runtime_setup(void);
 549
 550 /*
 551  * EFI Configuration Table and GUID definitions
 552  *
 553  * These are all defined in a single line to make them easier to
 554  * grep for and to see them at a glance - while still having a
 555  * similar structure to the definitions in the spec.
 556  *
 557  * Here's how they are structured:
 558  *
 559  * GUID: 12345678-1234-1234-1234-123456789012
 560  * Spec:
 561  *      #define EFI_SOME_PROTOCOL_GUID \
 562  *        {0x12345678,0x1234,0x1234,\
 563  *          {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
 564  * Here:
 565  *      #define SOME_PROTOCOL_GUID              EFI_GUID(0x12345678, 0x1234, 0x1234,  0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
 566  *                                      ^ tabs                                      ^extra space
 567  *
 568  * Note that the 'extra space' separates the values at the same place
 569  * where the UEFI SPEC breaks the line.
 570  */
 571 #define NULL_GUID                               EFI_GUID(0x00000000, 0x0000, 0x0000,  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
 572 #define MPS_TABLE_GUID                          EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 573 #define ACPI_TABLE_GUID                         EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 574 #define ACPI_20_TABLE_GUID                      EFI_GUID(0x8868e871, 0xe4f1, 0x11d3,  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
 575 #define SMBIOS_TABLE_GUID                       EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 576 #define SMBIOS3_TABLE_GUID                      EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c,  0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
 577 #define SAL_SYSTEM_TABLE_GUID                   EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 578 #define HCDP_TABLE_GUID                         EFI_GUID(0xf951938d, 0x620b, 0x42ef,  0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
 579 #define UGA_IO_PROTOCOL_GUID                    EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b,  0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
 580 #define EFI_GLOBAL_VARIABLE_GUID                EFI_GUID(0x8be4df61, 0x93ca, 0x11d2,  0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
 581 #define UV_SYSTEM_TABLE_GUID                    EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd,  0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
 582 #define LINUX_EFI_CRASH_GUID                    EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc,  0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
 583 #define LOADED_IMAGE_PROTOCOL_GUID              EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 584 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID       EFI_GUID(0x9042a9de, 0x23dc, 0x4a38,  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
 585 #define EFI_UGA_PROTOCOL_GUID                   EFI_GUID(0x982c298b, 0xf4fa, 0x41cb,  0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
 586 #define EFI_PCI_IO_PROTOCOL_GUID                EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5,  0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
 587 #define EFI_FILE_INFO_ID                        EFI_GUID(0x09576e92, 0x6d3f, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 588 #define EFI_SYSTEM_RESOURCE_TABLE_GUID          EFI_GUID(0xb122a263, 0x3661, 0x4f68,  0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
 589 #define EFI_FILE_SYSTEM_GUID                    EFI_GUID(0x964e5b22, 0x6459, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 590 #define DEVICE_TREE_GUID                        EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5,  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
 591 #define EFI_PROPERTIES_TABLE_GUID               EFI_GUID(0x880aaca3, 0x4adc, 0x4a04,  0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
 592 #define EFI_RNG_PROTOCOL_GUID                   EFI_GUID(0x3152bca5, 0xeade, 0x433d,  0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
 593 #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID        EFI_GUID(0xdcfa911d, 0x26eb, 0x469f,  0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
 594 #define EFI_CONSOLE_OUT_DEVICE_GUID             EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4,  0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 595
 596 /*
 597  * This GUID is used to pass to the kernel proper the struct screen_info
 598  * structure that was populated by the stub based on the GOP protocol instance
 599  * associated with ConOut
 600  */
 601 #define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID    EFI_GUID(0xe03fc20a, 0x85dc, 0x406e,  0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
 602 #define LINUX_EFI_LOADER_ENTRY_GUID             EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf,  0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
 603
 604 typedef struct {
 605         efi_guid_t guid;
 606         u64 table;
 607 } efi_config_table_64_t;
 608
 609 typedef struct {
 610         efi_guid_t guid;
 611         u32 table;
 612 } efi_config_table_32_t;
 613
 614 typedef struct {
 615         efi_guid_t guid;
 616         unsigned long table;
 617 } efi_config_table_t;
 618
 619 typedef struct {
 620         efi_guid_t guid;
 621         const char *name;
 622         unsigned long *ptr;
 623 } efi_config_table_type_t;
 624
 625 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 626
 627 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
 628 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
 629 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
 630 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
 631 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
 632 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
 633
 634 typedef struct {
 635         efi_table_hdr_t hdr;
 636         u64 fw_vendor;  /* physical addr of CHAR16 vendor string */
 637         u32 fw_revision;
 638         u32 __pad1;
 639         u64 con_in_handle;
 640         u64 con_in;
 641         u64 con_out_handle;
 642         u64 con_out;
 643         u64 stderr_handle;
 644         u64 stderr;
 645         u64 runtime;
 646         u64 boottime;
 647         u32 nr_tables;
 648         u32 __pad2;
 649         u64 tables;
 650 } efi_system_table_64_t;
 651
 652 typedef struct {
 653         efi_table_hdr_t hdr;
 654         u32 fw_vendor;  /* physical addr of CHAR16 vendor string */
 655         u32 fw_revision;
 656         u32 con_in_handle;
 657         u32 con_in;
 658         u32 con_out_handle;
 659         u32 con_out;
 660         u32 stderr_handle;
 661         u32 stderr;
 662         u32 runtime;
 663         u32 boottime;
 664         u32 nr_tables;
 665         u32 tables;
 666 } efi_system_table_32_t;
 667
 668 typedef struct {
 669         efi_table_hdr_t hdr;
 670         unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
 671         u32 fw_revision;
 672         unsigned long con_in_handle;
 673         unsigned long con_in;
 674         unsigned long con_out_handle;
 675         unsigned long con_out;
 676         unsigned long stderr_handle;
 677         unsigned long stderr;
 678         efi_runtime_services_t *runtime;
 679         efi_boot_services_t *boottime;
 680         unsigned long nr_tables;
 681         unsigned long tables;
 682 } efi_system_table_t;
 683
 684 /*
 685  * Architecture independent structure for describing a memory map for the
 686  * benefit of efi_memmap_init_early(), saving us the need to pass four
 687  * parameters.
 688  */
 689 struct efi_memory_map_data {
 690         phys_addr_t phys_map;
 691         unsigned long size;
 692         unsigned long desc_version;
 693         unsigned long desc_size;
 694 };
 695
 696 struct efi_memory_map {
 697         phys_addr_t phys_map;
 698         void *map;
 699         void *map_end;
 700         int nr_map;
 701         unsigned long desc_version;
 702         unsigned long desc_size;
 703         bool late;
 704 };
 705
 706 struct efi_mem_range {
 707         struct range range;
 708         u64 attribute;
 709 };
 710
 711 struct efi_fdt_params {
 712         u64 system_table;
 713         u64 mmap;
 714         u32 mmap_size;
 715         u32 desc_size;
 716         u32 desc_ver;
 717 };
 718
 719 typedef struct {
 720         u32 revision;
 721         u32 parent_handle;
 722         u32 system_table;
 723         u32 device_handle;
 724         u32 file_path;
 725         u32 reserved;
 726         u32 load_options_size;
 727         u32 load_options;
 728         u32 image_base;
 729         __aligned_u64 image_size;
 730         unsigned int image_code_type;
 731         unsigned int image_data_type;
 732         unsigned long unload;
 733 } efi_loaded_image_32_t;
 734
 735 typedef struct {
 736         u32 revision;
 737         u64 parent_handle;
 738         u64 system_table;
 739         u64 device_handle;
 740         u64 file_path;
 741         u64 reserved;
 742         u32 load_options_size;
 743         u64 load_options;
 744         u64 image_base;
 745         __aligned_u64 image_size;
 746         unsigned int image_code_type;
 747         unsigned int image_data_type;
 748         unsigned long unload;
 749 } efi_loaded_image_64_t;
 750
 751 typedef struct {
 752         u32 revision;
 753         void *parent_handle;
 754         efi_system_table_t *system_table;
 755         void *device_handle;
 756         void *file_path;
 757         void *reserved;
 758         u32 load_options_size;
 759         void *load_options;
 760         void *image_base;
 761         __aligned_u64 image_size;
 762         unsigned int image_code_type;
 763         unsigned int image_data_type;
 764         unsigned long unload;
 765 } efi_loaded_image_t;
 766
 767
 768 typedef struct {
 769         u64 size;
 770         u64 file_size;
 771         u64 phys_size;
 772         efi_time_t create_time;
 773         efi_time_t last_access_time;
 774         efi_time_t modification_time;
 775         __aligned_u64 attribute;
 776         efi_char16_t filename[1];
 777 } efi_file_info_t;
 778
 779 typedef struct {
 780         u64 revision;
 781         u32 open;
 782         u32 close;
 783         u32 delete;
 784         u32 read;
 785         u32 write;
 786         u32 get_position;
 787         u32 set_position;
 788         u32 get_info;
 789         u32 set_info;
 790         u32 flush;
 791 } efi_file_handle_32_t;
 792
 793 typedef struct {
 794         u64 revision;
 795         u64 open;
 796         u64 close;
 797         u64 delete;
 798         u64 read;
 799         u64 write;
 800         u64 get_position;
 801         u64 set_position;
 802         u64 get_info;
 803         u64 set_info;
 804         u64 flush;
 805 } efi_file_handle_64_t;
 806
 807 typedef struct _efi_file_handle {
 808         u64 revision;
 809         efi_status_t (*open)(struct _efi_file_handle *,
 810                              struct _efi_file_handle **,
 811                              efi_char16_t *, u64, u64);
 812         efi_status_t (*close)(struct _efi_file_handle *);
 813         void *delete;
 814         efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
 815                              void *);
 816         void *write;
 817         void *get_position;
 818         void *set_position;
 819         efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
 820                         unsigned long *, void *);
 821         void *set_info;
 822         void *flush;
 823 } efi_file_handle_t;
 824
 825 typedef struct _efi_file_io_interface {
 826         u64 revision;
 827         int (*open_volume)(struct _efi_file_io_interface *,
 828                            efi_file_handle_t **);
 829 } efi_file_io_interface_t;
 830
 831 #define EFI_FILE_MODE_READ      0x0000000000000001
 832 #define EFI_FILE_MODE_WRITE     0x0000000000000002
 833 #define EFI_FILE_MODE_CREATE    0x8000000000000000
 834
 835 typedef struct {
 836         u32 version;
 837         u32 length;
 838         u64 memory_protection_attribute;
 839 } efi_properties_table_t;
 840
 841 #define EFI_PROPERTIES_TABLE_VERSION    0x00010000
 842 #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
 843
 844 #define EFI_INVALID_TABLE_ADDR          (~0UL)
 845
 846 typedef struct {
 847         u32 version;
 848         u32 num_entries;
 849         u32 desc_size;
 850         u32 reserved;
 851         efi_memory_desc_t entry[0];
 852 } efi_memory_attributes_table_t;
 853
 854 /*
 855  * All runtime access to EFI goes through this structure:
 856  */
 857 extern struct efi {
 858         efi_system_table_t *systab;     /* EFI system table */
 859         unsigned int runtime_version;   /* Runtime services version */
 860         unsigned long mps;              /* MPS table */
 861         unsigned long acpi;             /* ACPI table  (IA64 ext 0.71) */
 862         unsigned long acpi20;           /* ACPI table  (ACPI 2.0) */
 863         unsigned long smbios;           /* SMBIOS table (32 bit entry point) */
 864         unsigned long smbios3;          /* SMBIOS table (64 bit entry point) */
 865         unsigned long sal_systab;       /* SAL system table */
 866         unsigned long boot_info;        /* boot info table */
 867         unsigned long hcdp;             /* HCDP table */
 868         unsigned long uga;              /* UGA table */
 869         unsigned long uv_systab;        /* UV system table */
 870         unsigned long fw_vendor;        /* fw_vendor */
 871         unsigned long runtime;          /* runtime table */
 872         unsigned long config_table;     /* config tables */
 873         unsigned long esrt;             /* ESRT table */
 874         unsigned long properties_table; /* properties table */
 875         unsigned long mem_attr_table;   /* memory attributes table */
 876         efi_get_time_t *get_time;
 877         efi_set_time_t *set_time;
 878         efi_get_wakeup_time_t *get_wakeup_time;
 879         efi_set_wakeup_time_t *set_wakeup_time;
 880         efi_get_variable_t *get_variable;
 881         efi_get_next_variable_t *get_next_variable;
 882         efi_set_variable_t *set_variable;
 883         efi_set_variable_t *set_variable_nonblocking;
 884         efi_query_variable_info_t *query_variable_info;
 885         efi_query_variable_info_t *query_variable_info_nonblocking;
 886         efi_update_capsule_t *update_capsule;
 887         efi_query_capsule_caps_t *query_capsule_caps;
 888         efi_get_next_high_mono_count_t *get_next_high_mono_count;
 889         efi_reset_system_t *reset_system;
 890         efi_set_virtual_address_map_t *set_virtual_address_map;
 891         struct efi_memory_map memmap;
 892         unsigned long flags;
 893 } efi;
 894
 895 static inline int
 896 efi_guidcmp (efi_guid_t left, efi_guid_t right)
 897 {
 898         return memcmp(&left, &right, sizeof (efi_guid_t));
 899 }
 900
 901 static inline char *
 902 efi_guid_to_str(efi_guid_t *guid, char *out)
 903 {
 904         sprintf(out, "%pUl", guid->b);
 905         return out;
 906 }
 907
 908 extern void efi_init (void);
 909 extern void *efi_get_pal_addr (void);
 910 extern void efi_map_pal_code (void);
 911 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
 912 extern void efi_gettimeofday (struct timespec64 *ts);
 913 #ifdef CONFIG_EFI
 914 extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
 915 #else
 916 static inline void efi_enter_virtual_mode (void) {}
 917 #endif
 918 #ifdef CONFIG_X86
 919 extern void efi_late_init(void);
 920 extern void efi_free_boot_services(void);
 921 extern efi_status_t efi_query_variable_store(u32 attributes,
 922                                              unsigned long size,
 923                                              bool nonblocking);
 924 extern void efi_find_mirror(void);
 925 #else
 926 static inline void efi_late_init(void) {}
 927 static inline void efi_free_boot_services(void) {}
 928
 929 static inline efi_status_t efi_query_variable_store(u32 attributes,
 930                                                     unsigned long size,
 931                                                     bool nonblocking)
 932 {
 933         return EFI_SUCCESS;
 934 }
 935 #endif
 936 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
 937
 938 extern phys_addr_t __init efi_memmap_alloc(unsigned int num_entries);
 939 extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
 940 extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
 941 extern void __init efi_memmap_unmap(void);
 942 extern int __init efi_memmap_install(phys_addr_t addr, unsigned int nr_map);
 943 extern int __init efi_memmap_split_count(efi_memory_desc_t *md,
 944                                          struct range *range);
 945 extern void __init efi_memmap_insert(struct efi_memory_map *old_memmap,
 946                                      void *buf, struct efi_mem_range *mem);
 947
 948 extern int efi_config_init(efi_config_table_type_t *arch_tables);
 949 #ifdef CONFIG_EFI_ESRT
 950 extern void __init efi_esrt_init(void);
 951 #else
 952 static inline void efi_esrt_init(void) { }
 953 #endif
 954 extern int efi_config_parse_tables(void *config_tables, int count, int sz,
 955                                    efi_config_table_type_t *arch_tables);
 956 extern u64 efi_get_iobase (void);
 957 extern u32 efi_mem_type (unsigned long phys_addr);
 958 extern u64 efi_mem_attributes (unsigned long phys_addr);
 959 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 960 extern int __init efi_uart_console_only (void);
 961 extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
 962 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
 963 extern void efi_mem_reserve(phys_addr_t addr, u64 size);
 964 extern void efi_initialize_iomem_resources(struct resource *code_resource,
 965                 struct resource *data_resource, struct resource *bss_resource);
 966 extern void efi_reserve_boot_services(void);
 967 extern int efi_get_fdt_params(struct efi_fdt_params *params);
 968 extern struct kobject *efi_kobj;
 969
 970 extern int efi_reboot_quirk_mode;
 971 extern bool efi_poweroff_required(void);
 972
 973 #ifdef CONFIG_EFI_FAKE_MEMMAP
 974 extern void __init efi_fake_memmap(void);
 975 #else
 976 static inline void efi_fake_memmap(void) { }
 977 #endif
 978
 979 /*
 980  * efi_memattr_perm_setter - arch specific callback function passed into
 981  *                           efi_memattr_apply_permissions() that updates the
 982  *                           mapping permissions described by the second
 983  *                           argument in the page tables referred to by the
 984  *                           first argument.
 985  */
 986 typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *);
 987
 988 extern int efi_memattr_init(void);
 989 extern int efi_memattr_apply_permissions(struct mm_struct *mm,
 990                                          efi_memattr_perm_setter fn);
 991
 992 /* Iterate through an efi_memory_map */
 993 #define for_each_efi_memory_desc_in_map(m, md)                             \
 994         for ((md) = (m)->map;                                              \
 995              (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end;      \
 996              (md) = (void *)(md) + (m)->desc_size)
 997
 998 /**
 999  * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
1000  * @md: the efi_memory_desc_t * iterator
1001  *
1002  * Once the loop finishes @md must not be accessed.
1003  */
1004 #define for_each_efi_memory_desc(md) \
1005         for_each_efi_memory_desc_in_map(&efi.memmap, md)
1006
1007 /*
1008  * Format an EFI memory descriptor's type and attributes to a user-provided
1009  * character buffer, as per snprintf(), and return the buffer.
1010  */
1011 char * __init efi_md_typeattr_format(char *buf, size_t size,
1012                                      const efi_memory_desc_t *md);
1013
1014 /**
1015  * efi_range_is_wc - check the WC bit on an address range
1016  * @start: starting kvirt address
1017  * @len: length of range
1018  *
1019  * Consult the EFI memory map and make sure it's ok to set this range WC.
1020  * Returns true or false.
1021  */
1022 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
1023 {
1024         unsigned long i;
1025
1026         for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
1027                 unsigned long paddr = __pa(start + i);
1028                 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
1029                         return 0;
1030         }
1031         /* The range checked out */
1032         return 1;
1033 }
1034
1035 #ifdef CONFIG_EFI_PCDP
1036 extern int __init efi_setup_pcdp_console(char *);
1037 #endif
1038
1039 /*
1040  * We play games with efi_enabled so that the compiler will, if
1041  * possible, remove EFI-related code altogether.
1042  */
1043 #define EFI_BOOT                0       /* Were we booted from EFI? */
1044 #define EFI_CONFIG_TABLES       2       /* Can we use EFI config tables? */
1045 #define EFI_RUNTIME_SERVICES    3       /* Can we use runtime services? */
1046 #define EFI_MEMMAP              4       /* Can we use EFI memory map? */
1047 #define EFI_64BIT               5       /* Is the firmware 64-bit? */
1048 #define EFI_PARAVIRT            6       /* Access is via a paravirt interface */
1049 #define EFI_ARCH_1              7       /* First arch-specific bit */
1050 #define EFI_DBG                 8       /* Print additional debug info at runtime */
1051 #define EFI_NX_PE_DATA          9       /* Can runtime data regions be mapped non-executable? */
1052
1053 #ifdef CONFIG_EFI
1054 /*
1055  * Test whether the above EFI_* bits are enabled.
1056  */
1057 static inline bool efi_enabled(int feature)
1058 {
1059         return test_bit(feature, &efi.flags) != 0;
1060 }
1061 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
1062 #else
1063 static inline bool efi_enabled(int feature)
1064 {
1065         return false;
1066 }
1067 static inline void
1068 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
1069
1070 static inline bool
1071 efi_capsule_pending(int *reset_type)
1072 {
1073         return false;
1074 }
1075 #endif
1076
1077 extern int efi_status_to_err(efi_status_t status);
1078
1079 /*
1080  * Variable Attributes
1081  */
1082 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
1083 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1084 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
1085 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1086 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1087 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1088 #define EFI_VARIABLE_APPEND_WRITE       0x0000000000000040
1089
1090 #define EFI_VARIABLE_MASK       (EFI_VARIABLE_NON_VOLATILE | \
1091                                 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1092                                 EFI_VARIABLE_RUNTIME_ACCESS | \
1093                                 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1094                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1095                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1096                                 EFI_VARIABLE_APPEND_WRITE)
1097 /*
1098  * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1099  * not including trailing NUL
1100  */
1101 #define EFI_VARIABLE_GUID_LEN   UUID_STRING_LEN
1102
1103 /*
1104  * The type of search to perform when calling boottime->locate_handle
1105  */
1106 #define EFI_LOCATE_ALL_HANDLES                  0
1107 #define EFI_LOCATE_BY_REGISTER_NOTIFY           1
1108 #define EFI_LOCATE_BY_PROTOCOL                  2
1109
1110 /*
1111  * EFI Device Path information
1112  */
1113 #define EFI_DEV_HW                      0x01
1114 #define  EFI_DEV_PCI                             1
1115 #define  EFI_DEV_PCCARD                          2
1116 #define  EFI_DEV_MEM_MAPPED                      3
1117 #define  EFI_DEV_VENDOR                          4
1118 #define  EFI_DEV_CONTROLLER                      5
1119 #define EFI_DEV_ACPI                    0x02
1120 #define   EFI_DEV_BASIC_ACPI                     1
1121 #define   EFI_DEV_EXPANDED_ACPI                  2
1122 #define EFI_DEV_MSG                     0x03
1123 #define   EFI_DEV_MSG_ATAPI                      1
1124 #define   EFI_DEV_MSG_SCSI                       2
1125 #define   EFI_DEV_MSG_FC                         3
1126 #define   EFI_DEV_MSG_1394                       4
1127 #define   EFI_DEV_MSG_USB                        5
1128 #define   EFI_DEV_MSG_USB_CLASS                 15
1129 #define   EFI_DEV_MSG_I20                        6
1130 #define   EFI_DEV_MSG_MAC                       11
1131 #define   EFI_DEV_MSG_IPV4                      12
1132 #define   EFI_DEV_MSG_IPV6                      13
1133 #define   EFI_DEV_MSG_INFINIBAND                 9
1134 #define   EFI_DEV_MSG_UART                      14
1135 #define   EFI_DEV_MSG_VENDOR                    10
1136 #define EFI_DEV_MEDIA                   0x04
1137 #define   EFI_DEV_MEDIA_HARD_DRIVE               1
1138 #define   EFI_DEV_MEDIA_CDROM                    2
1139 #define   EFI_DEV_MEDIA_VENDOR                   3
1140 #define   EFI_DEV_MEDIA_FILE                     4
1141 #define   EFI_DEV_MEDIA_PROTOCOL                 5
1142 #define EFI_DEV_BIOS_BOOT               0x05
1143 #define EFI_DEV_END_PATH                0x7F
1144 #define EFI_DEV_END_PATH2               0xFF
1145 #define   EFI_DEV_END_INSTANCE                  0x01
1146 #define   EFI_DEV_END_ENTIRE                    0xFF
1147
1148 struct efi_generic_dev_path {
1149         u8 type;
1150         u8 sub_type;
1151         u16 length;
1152 } __attribute ((packed));
1153
1154 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1155 {
1156         *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1157         *addr &= PAGE_MASK;
1158 }
1159
1160 /*
1161  * EFI Variable support.
1162  *
1163  * Different firmware drivers can expose their EFI-like variables using
1164  * the following.
1165  */
1166
1167 struct efivar_operations {
1168         efi_get_variable_t *get_variable;
1169         efi_get_next_variable_t *get_next_variable;
1170         efi_set_variable_t *set_variable;
1171         efi_set_variable_t *set_variable_nonblocking;
1172         efi_query_variable_store_t *query_variable_store;
1173 };
1174
1175 struct efivars {
1176         struct kset *kset;
1177         struct kobject *kobject;
1178         const struct efivar_operations *ops;
1179 };
1180
1181 /*
1182  * The maximum size of VariableName + Data = 1024
1183  * Therefore, it's reasonable to save that much
1184  * space in each part of the structure,
1185  * and we use a page for reading/writing.
1186  */
1187
1188 #define EFI_VAR_NAME_LEN        1024
1189
1190 struct efi_variable {
1191         efi_char16_t  VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1192         efi_guid_t    VendorGuid;
1193         unsigned long DataSize;
1194         __u8          Data[1024];
1195         efi_status_t  Status;
1196         __u32         Attributes;
1197 } __attribute__((packed));
1198
1199 struct efivar_entry {
1200         struct efi_variable var;
1201         struct list_head list;
1202         struct kobject kobj;
1203         bool scanning;
1204         bool deleting;
1205 };
1206
1207 struct efi_simple_text_output_protocol_32 {
1208         u32 reset;
1209         u32 output_string;
1210         u32 test_string;
1211 };
1212
1213 struct efi_simple_text_output_protocol_64 {
1214         u64 reset;
1215         u64 output_string;
1216         u64 test_string;
1217 };
1218
1219 struct efi_simple_text_output_protocol {
1220         void *reset;
1221         efi_status_t (*output_string)(void *, void *);
1222         void *test_string;
1223 };
1224
1225 #define PIXEL_RGB_RESERVED_8BIT_PER_COLOR               0
1226 #define PIXEL_BGR_RESERVED_8BIT_PER_COLOR               1
1227 #define PIXEL_BIT_MASK                                  2
1228 #define PIXEL_BLT_ONLY                                  3
1229 #define PIXEL_FORMAT_MAX                                4
1230
1231 struct efi_pixel_bitmask {
1232         u32 red_mask;
1233         u32 green_mask;
1234         u32 blue_mask;
1235         u32 reserved_mask;
1236 };
1237
1238 struct efi_graphics_output_mode_info {
1239         u32 version;
1240         u32 horizontal_resolution;
1241         u32 vertical_resolution;
1242         int pixel_format;
1243         struct efi_pixel_bitmask pixel_information;
1244         u32 pixels_per_scan_line;
1245 } __packed;
1246
1247 struct efi_graphics_output_protocol_mode_32 {
1248         u32 max_mode;
1249         u32 mode;
1250         u32 info;
1251         u32 size_of_info;
1252         u64 frame_buffer_base;
1253         u32 frame_buffer_size;
1254 } __packed;
1255
1256 struct efi_graphics_output_protocol_mode_64 {
1257         u32 max_mode;
1258         u32 mode;
1259         u64 info;
1260         u64 size_of_info;
1261         u64 frame_buffer_base;
1262         u64 frame_buffer_size;
1263 } __packed;
1264
1265 struct efi_graphics_output_protocol_mode {
1266         u32 max_mode;
1267         u32 mode;
1268         unsigned long info;
1269         unsigned long size_of_info;
1270         u64 frame_buffer_base;
1271         unsigned long frame_buffer_size;
1272 } __packed;
1273
1274 struct efi_graphics_output_protocol_32 {
1275         u32 query_mode;
1276         u32 set_mode;
1277         u32 blt;
1278         u32 mode;
1279 };
1280
1281 struct efi_graphics_output_protocol_64 {
1282         u64 query_mode;
1283         u64 set_mode;
1284         u64 blt;
1285         u64 mode;
1286 };
1287
1288 struct efi_graphics_output_protocol {
1289         unsigned long query_mode;
1290         unsigned long set_mode;
1291         unsigned long blt;
1292         struct efi_graphics_output_protocol_mode *mode;
1293 };
1294
1295 typedef efi_status_t (*efi_graphics_output_protocol_query_mode)(
1296         struct efi_graphics_output_protocol *, u32, unsigned long *,
1297         struct efi_graphics_output_mode_info **);
1298
1299 extern struct list_head efivar_sysfs_list;
1300
1301 static inline void
1302 efivar_unregister(struct efivar_entry *var)
1303 {
1304         kobject_put(&var->kobj);
1305 }
1306
1307 int efivars_register(struct efivars *efivars,
1308                      const struct efivar_operations *ops,
1309                      struct kobject *kobject);
1310 int efivars_unregister(struct efivars *efivars);
1311 struct kobject *efivars_kobject(void);
1312
1313 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1314                 void *data, bool duplicates, struct list_head *head);
1315
1316 int efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1317 int efivar_entry_remove(struct efivar_entry *entry);
1318
1319 int __efivar_entry_delete(struct efivar_entry *entry);
1320 int efivar_entry_delete(struct efivar_entry *entry);
1321
1322 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1323 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1324                        unsigned long *size, void *data);
1325 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1326                      unsigned long *size, void *data);
1327 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1328                      unsigned long size, void *data, struct list_head *head);
1329 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1330                               unsigned long *size, void *data, bool *set);
1331 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1332                           bool block, unsigned long size, void *data);
1333
1334 int efivar_entry_iter_begin(void);
1335 void efivar_entry_iter_end(void);
1336
1337 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1338                         struct list_head *head, void *data,
1339                         struct efivar_entry **prev);
1340 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1341                       struct list_head *head, void *data);
1342
1343 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1344                                        struct list_head *head, bool remove);
1345
1346 bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1347                      unsigned long data_size);
1348 bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1349                                   size_t len);
1350
1351 extern struct work_struct efivar_work;
1352 void efivar_run_worker(void);
1353
1354 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1355 int efivars_sysfs_init(void);
1356
1357 #define EFIVARS_DATA_SIZE_MAX 1024
1358
1359 #endif /* CONFIG_EFI_VARS */
1360 extern bool efi_capsule_pending(int *reset_type);
1361
1362 extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1363                                  size_t size, int *reset);
1364
1365 extern int efi_capsule_update(efi_capsule_header_t *capsule,
1366                               struct page **pages);
1367
1368 #ifdef CONFIG_EFI_RUNTIME_MAP
1369 int efi_runtime_map_init(struct kobject *);
1370 int efi_get_runtime_map_size(void);
1371 int efi_get_runtime_map_desc_size(void);
1372 int efi_runtime_map_copy(void *buf, size_t bufsz);
1373 #else
1374 static inline int efi_runtime_map_init(struct kobject *kobj)
1375 {
1376         return 0;
1377 }
1378
1379 static inline int efi_get_runtime_map_size(void)
1380 {
1381         return 0;
1382 }
1383
1384 static inline int efi_get_runtime_map_desc_size(void)
1385 {
1386         return 0;
1387 }
1388
1389 static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1390 {
1391         return 0;
1392 }
1393
1394 #endif
1395
1396 /* prototypes shared between arch specific and generic stub code */
1397
1398 #define pr_efi(sys_table, msg)     efi_printk(sys_table, "EFI stub: "msg)
1399 #define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1400
1401 void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1402
1403 void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1404               unsigned long addr);
1405
1406 char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1407                           efi_loaded_image_t *image, int *cmd_line_len);
1408
1409 efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1410                                 struct efi_boot_memmap *map);
1411
1412 efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1413                            unsigned long size, unsigned long align,
1414                            unsigned long *addr);
1415
1416 efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1417                             unsigned long size, unsigned long align,
1418                             unsigned long *addr, unsigned long max);
1419
1420 efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1421                                  unsigned long *image_addr,
1422                                  unsigned long image_size,
1423                                  unsigned long alloc_size,
1424                                  unsigned long preferred_addr,
1425                                  unsigned long alignment);
1426
1427 efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1428                                   efi_loaded_image_t *image,
1429                                   char *cmd_line, char *option_string,
1430                                   unsigned long max_addr,
1431                                   unsigned long *load_addr,
1432                                   unsigned long *load_size);
1433
1434 efi_status_t efi_parse_options(char const *cmdline);
1435
1436 efi_status_t efi_setup_gop(efi_system_table_t *sys_table_arg,
1437                            struct screen_info *si, efi_guid_t *proto,
1438                            unsigned long size);
1439
1440 #ifdef CONFIG_EFI
1441 extern bool efi_runtime_disabled(void);
1442 #else
1443 static inline bool efi_runtime_disabled(void) { return true; }
1444 #endif
1445
1446 extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1447
1448 /*
1449  * Arch code can implement the following three template macros, avoiding
1450  * reptition for the void/non-void return cases of {__,}efi_call_virt():
1451  *
1452  *  * arch_efi_call_virt_setup()
1453  *
1454  *    Sets up the environment for the call (e.g. switching page tables,
1455  *    allowing kernel-mode use of floating point, if required).
1456  *
1457  *  * arch_efi_call_virt()
1458  *
1459  *    Performs the call. The last expression in the macro must be the call
1460  *    itself, allowing the logic to be shared by the void and non-void
1461  *    cases.
1462  *
1463  *  * arch_efi_call_virt_teardown()
1464  *
1465  *    Restores the usual kernel environment once the call has returned.
1466  */
1467
1468 #define efi_call_virt_pointer(p, f, args...)                            \
1469 ({                                                                      \
1470         efi_status_t __s;                                               \
1471         unsigned long __flags;                                          \
1472                                                                         \
1473         arch_efi_call_virt_setup();                                     \
1474                                                                         \
1475         local_save_flags(__flags);                                      \
1476         __s = arch_efi_call_virt(p, f, args);                           \
1477         efi_call_virt_check_flags(__flags, __stringify(f));             \
1478                                                                         \
1479         arch_efi_call_virt_teardown();                                  \
1480                                                                         \
1481         __s;                                                            \
1482 })
1483
1484 #define __efi_call_virt_pointer(p, f, args...)                          \
1485 ({                                                                      \
1486         unsigned long __flags;                                          \
1487                                                                         \
1488         arch_efi_call_virt_setup();                                     \
1489                                                                         \
1490         local_save_flags(__flags);                                      \
1491         arch_efi_call_virt(p, f, args);                                 \
1492         efi_call_virt_check_flags(__flags, __stringify(f));             \
1493                                                                         \
1494         arch_efi_call_virt_teardown();                                  \
1495 })
1496
1497 typedef efi_status_t (*efi_exit_boot_map_processing)(
1498         efi_system_table_t *sys_table_arg,
1499         struct efi_boot_memmap *map,
1500         void *priv);
1501
1502 efi_status_t efi_exit_boot_services(efi_system_table_t *sys_table,
1503                                     void *handle,
1504                                     struct efi_boot_memmap *map,
1505                                     void *priv,
1506                                     efi_exit_boot_map_processing priv_func);
1507 #endif /* _LINUX_EFI_H */