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