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