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