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
  24 #include <asm/page.h>
  25
  26 #define EFI_SUCCESS             0
  27 #define EFI_LOAD_ERROR          ( 1 | (1UL << (BITS_PER_LONG-1)))
  28 #define EFI_INVALID_PARAMETER   ( 2 | (1UL << (BITS_PER_LONG-1)))
  29 #define EFI_UNSUPPORTED         ( 3 | (1UL << (BITS_PER_LONG-1)))
  30 #define EFI_BAD_BUFFER_SIZE     ( 4 | (1UL << (BITS_PER_LONG-1)))
  31 #define EFI_BUFFER_TOO_SMALL    ( 5 | (1UL << (BITS_PER_LONG-1)))
  32 #define EFI_NOT_FOUND           (14 | (1UL << (BITS_PER_LONG-1)))
  33
  34 typedef unsigned long efi_status_t;
  35 typedef u8 efi_bool_t;
  36 typedef u16 efi_char16_t;               /* UNICODE character */
  37
  38
  39 typedef struct {
  40         u8 b[16];
  41 } efi_guid_t;
  42
  43 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
  44 ((efi_guid_t) \
  45 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
  46   (b) & 0xff, ((b) >> 8) & 0xff, \
  47   (c) & 0xff, ((c) >> 8) & 0xff, \
  48   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
  49
  50 /*
  51  * Generic EFI table header
  52  */
  53 typedef struct {
  54         u64 signature;
  55         u32 revision;
  56         u32 headersize;
  57         u32 crc32;
  58         u32 reserved;
  59 } efi_table_hdr_t;
  60
  61 /*
  62  * Memory map descriptor:
  63  */
  64
  65 /* Memory types: */
  66 #define EFI_RESERVED_TYPE                0
  67 #define EFI_LOADER_CODE                  1
  68 #define EFI_LOADER_DATA                  2
  69 #define EFI_BOOT_SERVICES_CODE           3
  70 #define EFI_BOOT_SERVICES_DATA           4
  71 #define EFI_RUNTIME_SERVICES_CODE        5
  72 #define EFI_RUNTIME_SERVICES_DATA        6
  73 #define EFI_CONVENTIONAL_MEMORY          7
  74 #define EFI_UNUSABLE_MEMORY              8
  75 #define EFI_ACPI_RECLAIM_MEMORY          9
  76 #define EFI_ACPI_MEMORY_NVS             10
  77 #define EFI_MEMORY_MAPPED_IO            11
  78 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
  79 #define EFI_PAL_CODE                    13
  80 #define EFI_MAX_MEMORY_TYPE             14
  81
  82 /* Attribute values: */
  83 #define EFI_MEMORY_UC           ((u64)0x0000000000000001ULL)    /* uncached */
  84 #define EFI_MEMORY_WC           ((u64)0x0000000000000002ULL)    /* write-coalescing */
  85 #define EFI_MEMORY_WT           ((u64)0x0000000000000004ULL)    /* write-through */
  86 #define EFI_MEMORY_WB           ((u64)0x0000000000000008ULL)    /* write-back */
  87 #define EFI_MEMORY_WP           ((u64)0x0000000000001000ULL)    /* write-protect */
  88 #define EFI_MEMORY_RP           ((u64)0x0000000000002000ULL)    /* read-protect */
  89 #define EFI_MEMORY_XP           ((u64)0x0000000000004000ULL)    /* execute-protect */
  90 #define EFI_MEMORY_RUNTIME      ((u64)0x8000000000000000ULL)    /* range requires runtime mapping */
  91 #define EFI_MEMORY_DESCRIPTOR_VERSION   1
  92
  93 #define EFI_PAGE_SHIFT          12
  94
  95 typedef struct {
  96         u32 type;
  97         u32 pad;
  98         u64 phys_addr;
  99         u64 virt_addr;
 100         u64 num_pages;
 101         u64 attribute;
 102 } efi_memory_desc_t;
 103
 104 typedef struct {
 105         efi_guid_t guid;
 106         u32 headersize;
 107         u32 flags;
 108         u32 imagesize;
 109 } efi_capsule_header_t;
 110
 111 /*
 112  * Allocation types for calls to boottime->allocate_pages.
 113  */
 114 #define EFI_ALLOCATE_ANY_PAGES          0
 115 #define EFI_ALLOCATE_MAX_ADDRESS        1
 116 #define EFI_ALLOCATE_ADDRESS            2
 117 #define EFI_MAX_ALLOCATE_TYPE           3
 118
 119 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
 120
 121 /*
 122  * Types and defines for Time Services
 123  */
 124 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
 125 #define EFI_TIME_IN_DAYLIGHT     0x2
 126 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 127
 128 typedef struct {
 129         u16 year;
 130         u8 month;
 131         u8 day;
 132         u8 hour;
 133         u8 minute;
 134         u8 second;
 135         u8 pad1;
 136         u32 nanosecond;
 137         s16 timezone;
 138         u8 daylight;
 139         u8 pad2;
 140 } efi_time_t;
 141
 142 typedef struct {
 143         u32 resolution;
 144         u32 accuracy;
 145         u8 sets_to_zero;
 146 } efi_time_cap_t;
 147
 148 /*
 149  * EFI Boot Services table
 150  */
 151 typedef struct {
 152         efi_table_hdr_t hdr;
 153         void *raise_tpl;
 154         void *restore_tpl;
 155         void *allocate_pages;
 156         void *free_pages;
 157         void *get_memory_map;
 158         void *allocate_pool;
 159         void *free_pool;
 160         void *create_event;
 161         void *set_timer;
 162         void *wait_for_event;
 163         void *signal_event;
 164         void *close_event;
 165         void *check_event;
 166         void *install_protocol_interface;
 167         void *reinstall_protocol_interface;
 168         void *uninstall_protocol_interface;
 169         void *handle_protocol;
 170         void *__reserved;
 171         void *register_protocol_notify;
 172         void *locate_handle;
 173         void *locate_device_path;
 174         void *install_configuration_table;
 175         void *load_image;
 176         void *start_image;
 177         void *exit;
 178         void *unload_image;
 179         void *exit_boot_services;
 180         void *get_next_monotonic_count;
 181         void *stall;
 182         void *set_watchdog_timer;
 183         void *connect_controller;
 184         void *disconnect_controller;
 185         void *open_protocol;
 186         void *close_protocol;
 187         void *open_protocol_information;
 188         void *protocols_per_handle;
 189         void *locate_handle_buffer;
 190         void *locate_protocol;
 191         void *install_multiple_protocol_interfaces;
 192         void *uninstall_multiple_protocol_interfaces;
 193         void *calculate_crc32;
 194         void *copy_mem;
 195         void *set_mem;
 196         void *create_event_ex;
 197 } efi_boot_services_t;
 198
 199 typedef enum {
 200         EfiPciIoWidthUint8,
 201         EfiPciIoWidthUint16,
 202         EfiPciIoWidthUint32,
 203         EfiPciIoWidthUint64,
 204         EfiPciIoWidthFifoUint8,
 205         EfiPciIoWidthFifoUint16,
 206         EfiPciIoWidthFifoUint32,
 207         EfiPciIoWidthFifoUint64,
 208         EfiPciIoWidthFillUint8,
 209         EfiPciIoWidthFillUint16,
 210         EfiPciIoWidthFillUint32,
 211         EfiPciIoWidthFillUint64,
 212         EfiPciIoWidthMaximum
 213 } EFI_PCI_IO_PROTOCOL_WIDTH;
 214
 215 typedef enum {
 216         EfiPciIoAttributeOperationGet,
 217         EfiPciIoAttributeOperationSet,
 218         EfiPciIoAttributeOperationEnable,
 219         EfiPciIoAttributeOperationDisable,
 220         EfiPciIoAttributeOperationSupported,
 221     EfiPciIoAttributeOperationMaximum
 222 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
 223
 224
 225 typedef struct {
 226         void *read;
 227         void *write;
 228 } efi_pci_io_protocol_access_t;
 229
 230 typedef struct {
 231         void *poll_mem;
 232         void *poll_io;
 233         efi_pci_io_protocol_access_t mem;
 234         efi_pci_io_protocol_access_t io;
 235         efi_pci_io_protocol_access_t pci;
 236         void *copy_mem;
 237         void *map;
 238         void *unmap;
 239         void *allocate_buffer;
 240         void *free_buffer;
 241         void *flush;
 242         void *get_location;
 243         void *attributes;
 244         void *get_bar_attributes;
 245         void *set_bar_attributes;
 246         uint64_t romsize;
 247         void *romimage;
 248 } efi_pci_io_protocol;
 249
 250 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
 251 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
 252 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
 253 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
 254 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
 255 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
 256 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
 257 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
 258 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
 259 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
 260 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
 261 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
 262 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
 263 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
 264 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
 265 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
 266 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
 267 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
 268 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
 269
 270 /*
 271  * Types and defines for EFI ResetSystem
 272  */
 273 #define EFI_RESET_COLD 0
 274 #define EFI_RESET_WARM 1
 275 #define EFI_RESET_SHUTDOWN 2
 276
 277 /*
 278  * EFI Runtime Services table
 279  */
 280 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 281 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
 282
 283 typedef struct {
 284         efi_table_hdr_t hdr;
 285         unsigned long get_time;
 286         unsigned long set_time;
 287         unsigned long get_wakeup_time;
 288         unsigned long set_wakeup_time;
 289         unsigned long set_virtual_address_map;
 290         unsigned long convert_pointer;
 291         unsigned long get_variable;
 292         unsigned long get_next_variable;
 293         unsigned long set_variable;
 294         unsigned long get_next_high_mono_count;
 295         unsigned long reset_system;
 296         unsigned long update_capsule;
 297         unsigned long query_capsule_caps;
 298         unsigned long query_variable_info;
 299 } efi_runtime_services_t;
 300
 301 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 302 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 303 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 304                                             efi_time_t *tm);
 305 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 306 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 307                                          unsigned long *data_size, void *data);
 308 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 309                                               efi_guid_t *vendor);
 310 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 311                                          u32 attr, unsigned long data_size,
 312                                          void *data);
 313 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 314 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 315                                  unsigned long data_size, efi_char16_t *data);
 316 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 317                                                 unsigned long descriptor_size,
 318                                                 u32 descriptor_version,
 319                                                 efi_memory_desc_t *virtual_map);
 320 typedef efi_status_t efi_query_variable_info_t(u32 attr,
 321                                                u64 *storage_space,
 322                                                u64 *remaining_space,
 323                                                u64 *max_variable_size);
 324 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
 325                                           unsigned long count,
 326                                           unsigned long sg_list);
 327 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
 328                                               unsigned long count,
 329                                               u64 *max_size,
 330                                               int *reset_type);
 331
 332 /*
 333  *  EFI Configuration Table and GUID definitions
 334  */
 335 #define NULL_GUID \
 336     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
 337
 338 #define MPS_TABLE_GUID    \
 339     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 340
 341 #define ACPI_TABLE_GUID    \
 342     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 343
 344 #define ACPI_20_TABLE_GUID    \
 345     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
 346
 347 #define SMBIOS_TABLE_GUID    \
 348     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 349
 350 #define SAL_SYSTEM_TABLE_GUID    \
 351     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 352
 353 #define HCDP_TABLE_GUID \
 354     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
 355
 356 #define UGA_IO_PROTOCOL_GUID \
 357     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
 358
 359 #define EFI_GLOBAL_VARIABLE_GUID \
 360     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
 361
 362 #define UV_SYSTEM_TABLE_GUID \
 363     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
 364
 365 #define LINUX_EFI_CRASH_GUID \
 366     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
 367
 368 #define LOADED_IMAGE_PROTOCOL_GUID \
 369     EFI_GUID(  0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 370
 371 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
 372     EFI_GUID(  0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
 373
 374 #define EFI_UGA_PROTOCOL_GUID \
 375     EFI_GUID(  0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
 376
 377 #define EFI_PCI_IO_PROTOCOL_GUID \
 378     EFI_GUID(  0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
 379
 380 #define EFI_FILE_INFO_ID \
 381     EFI_GUID(  0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 382
 383 #define EFI_FILE_SYSTEM_GUID \
 384     EFI_GUID(  0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 385
 386 typedef struct {
 387         efi_guid_t guid;
 388         u64 table;
 389 } efi_config_table_64_t;
 390
 391 typedef struct {
 392         efi_guid_t guid;
 393         u32 table;
 394 } efi_config_table_32_t;
 395
 396 typedef struct {
 397         efi_guid_t guid;
 398         unsigned long table;
 399 } efi_config_table_t;
 400
 401 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 402
 403 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
 404 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
 405 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
 406 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
 407 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
 408 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
 409
 410 typedef struct {
 411         efi_table_hdr_t hdr;
 412         u64 fw_vendor;  /* physical addr of CHAR16 vendor string */
 413         u32 fw_revision;
 414         u32 __pad1;
 415         u64 con_in_handle;
 416         u64 con_in;
 417         u64 con_out_handle;
 418         u64 con_out;
 419         u64 stderr_handle;
 420         u64 stderr;
 421         u64 runtime;
 422         u64 boottime;
 423         u32 nr_tables;
 424         u32 __pad2;
 425         u64 tables;
 426 } efi_system_table_64_t;
 427
 428 typedef struct {
 429         efi_table_hdr_t hdr;
 430         u32 fw_vendor;  /* physical addr of CHAR16 vendor string */
 431         u32 fw_revision;
 432         u32 con_in_handle;
 433         u32 con_in;
 434         u32 con_out_handle;
 435         u32 con_out;
 436         u32 stderr_handle;
 437         u32 stderr;
 438         u32 runtime;
 439         u32 boottime;
 440         u32 nr_tables;
 441         u32 tables;
 442 } efi_system_table_32_t;
 443
 444 typedef struct {
 445         efi_table_hdr_t hdr;
 446         unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
 447         u32 fw_revision;
 448         unsigned long con_in_handle;
 449         unsigned long con_in;
 450         unsigned long con_out_handle;
 451         unsigned long con_out;
 452         unsigned long stderr_handle;
 453         unsigned long stderr;
 454         efi_runtime_services_t *runtime;
 455         efi_boot_services_t *boottime;
 456         unsigned long nr_tables;
 457         unsigned long tables;
 458 } efi_system_table_t;
 459
 460 struct efi_memory_map {
 461         void *phys_map;
 462         void *map;
 463         void *map_end;
 464         int nr_map;
 465         unsigned long desc_version;
 466         unsigned long desc_size;
 467 };
 468
 469 typedef struct {
 470         u32 revision;
 471         void *parent_handle;
 472         efi_system_table_t *system_table;
 473         void *device_handle;
 474         void *file_path;
 475         void *reserved;
 476         u32 load_options_size;
 477         void *load_options;
 478         void *image_base;
 479         __aligned_u64 image_size;
 480         unsigned int image_code_type;
 481         unsigned int image_data_type;
 482         unsigned long unload;
 483 } efi_loaded_image_t;
 484
 485 typedef struct {
 486         u64 revision;
 487         void *open_volume;
 488 } efi_file_io_interface_t;
 489
 490 typedef struct {
 491         u64 size;
 492         u64 file_size;
 493         u64 phys_size;
 494         efi_time_t create_time;
 495         efi_time_t last_access_time;
 496         efi_time_t modification_time;
 497         __aligned_u64 attribute;
 498         efi_char16_t filename[1];
 499 } efi_file_info_t;
 500
 501 typedef struct {
 502         u64 revision;
 503         void *open;
 504         void *close;
 505         void *delete;
 506         void *read;
 507         void *write;
 508         void *get_position;
 509         void *set_position;
 510         void *get_info;
 511         void *set_info;
 512         void *flush;
 513 } efi_file_handle_t;
 514
 515 #define EFI_FILE_MODE_READ      0x0000000000000001
 516 #define EFI_FILE_MODE_WRITE     0x0000000000000002
 517 #define EFI_FILE_MODE_CREATE    0x8000000000000000
 518
 519 #define EFI_INVALID_TABLE_ADDR          (~0UL)
 520
 521 /*
 522  * All runtime access to EFI goes through this structure:
 523  */
 524 extern struct efi {
 525         efi_system_table_t *systab;     /* EFI system table */
 526         unsigned int runtime_version;   /* Runtime services version */
 527         unsigned long mps;              /* MPS table */
 528         unsigned long acpi;             /* ACPI table  (IA64 ext 0.71) */
 529         unsigned long acpi20;           /* ACPI table  (ACPI 2.0) */
 530         unsigned long smbios;           /* SM BIOS table */
 531         unsigned long sal_systab;       /* SAL system table */
 532         unsigned long boot_info;        /* boot info table */
 533         unsigned long hcdp;             /* HCDP table */
 534         unsigned long uga;              /* UGA table */
 535         unsigned long uv_systab;        /* UV system table */
 536         efi_get_time_t *get_time;
 537         efi_set_time_t *set_time;
 538         efi_get_wakeup_time_t *get_wakeup_time;
 539         efi_set_wakeup_time_t *set_wakeup_time;
 540         efi_get_variable_t *get_variable;
 541         efi_get_next_variable_t *get_next_variable;
 542         efi_set_variable_t *set_variable;
 543         efi_query_variable_info_t *query_variable_info;
 544         efi_update_capsule_t *update_capsule;
 545         efi_query_capsule_caps_t *query_capsule_caps;
 546         efi_get_next_high_mono_count_t *get_next_high_mono_count;
 547         efi_reset_system_t *reset_system;
 548         efi_set_virtual_address_map_t *set_virtual_address_map;
 549 } efi;
 550
 551 static inline int
 552 efi_guidcmp (efi_guid_t left, efi_guid_t right)
 553 {
 554         return memcmp(&left, &right, sizeof (efi_guid_t));
 555 }
 556
 557 static inline char *
 558 efi_guid_unparse(efi_guid_t *guid, char *out)
 559 {
 560         sprintf(out, "%pUl", guid->b);
 561         return out;
 562 }
 563
 564 extern void efi_init (void);
 565 extern void *efi_get_pal_addr (void);
 566 extern void efi_map_pal_code (void);
 567 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
 568 extern void efi_gettimeofday (struct timespec *ts);
 569 extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
 570 #ifdef CONFIG_X86
 571 extern void efi_late_init(void);
 572 extern void efi_free_boot_services(void);
 573 #else
 574 static inline void efi_late_init(void) {}
 575 static inline void efi_free_boot_services(void) {}
 576 #endif
 577 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
 578 extern u64 efi_get_iobase (void);
 579 extern u32 efi_mem_type (unsigned long phys_addr);
 580 extern u64 efi_mem_attributes (unsigned long phys_addr);
 581 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 582 extern int __init efi_uart_console_only (void);
 583 extern void efi_initialize_iomem_resources(struct resource *code_resource,
 584                 struct resource *data_resource, struct resource *bss_resource);
 585 extern unsigned long efi_get_time(void);
 586 extern int efi_set_rtc_mmss(unsigned long nowtime);
 587 extern void efi_reserve_boot_services(void);
 588 extern struct efi_memory_map memmap;
 589
 590 /**
 591  * efi_range_is_wc - check the WC bit on an address range
 592  * @start: starting kvirt address
 593  * @len: length of range
 594  *
 595  * Consult the EFI memory map and make sure it's ok to set this range WC.
 596  * Returns true or false.
 597  */
 598 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 599 {
 600         unsigned long i;
 601
 602         for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 603                 unsigned long paddr = __pa(start + i);
 604                 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 605                         return 0;
 606         }
 607         /* The range checked out */
 608         return 1;
 609 }
 610
 611 #ifdef CONFIG_EFI_PCDP
 612 extern int __init efi_setup_pcdp_console(char *);
 613 #endif
 614
 615 /*
 616  * We play games with efi_enabled so that the compiler will, if possible, remove
 617  * EFI-related code altogether.
 618  */
 619 #ifdef CONFIG_EFI
 620 # ifdef CONFIG_X86
 621    extern int efi_enabled;
 622    extern bool efi_64bit;
 623 # else
 624 #  define efi_enabled 1
 625 # endif
 626 #else
 627 # define efi_enabled 0
 628 #endif
 629
 630 /*
 631  * Variable Attributes
 632  */
 633 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
 634 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
 635 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
 636 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
 637 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
 638 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
 639 #define EFI_VARIABLE_APPEND_WRITE       0x0000000000000040
 640
 641 #define EFI_VARIABLE_MASK       (EFI_VARIABLE_NON_VOLATILE | \
 642                                 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
 643                                 EFI_VARIABLE_RUNTIME_ACCESS | \
 644                                 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
 645                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
 646                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
 647                                 EFI_VARIABLE_APPEND_WRITE)
 648 /*
 649  * The type of search to perform when calling boottime->locate_handle
 650  */
 651 #define EFI_LOCATE_ALL_HANDLES                  0
 652 #define EFI_LOCATE_BY_REGISTER_NOTIFY           1
 653 #define EFI_LOCATE_BY_PROTOCOL                  2
 654
 655 /*
 656  * EFI Device Path information
 657  */
 658 #define EFI_DEV_HW                      0x01
 659 #define  EFI_DEV_PCI                             1
 660 #define  EFI_DEV_PCCARD                          2
 661 #define  EFI_DEV_MEM_MAPPED                      3
 662 #define  EFI_DEV_VENDOR                          4
 663 #define  EFI_DEV_CONTROLLER                      5
 664 #define EFI_DEV_ACPI                    0x02
 665 #define   EFI_DEV_BASIC_ACPI                     1
 666 #define   EFI_DEV_EXPANDED_ACPI                  2
 667 #define EFI_DEV_MSG                     0x03
 668 #define   EFI_DEV_MSG_ATAPI                      1
 669 #define   EFI_DEV_MSG_SCSI                       2
 670 #define   EFI_DEV_MSG_FC                         3
 671 #define   EFI_DEV_MSG_1394                       4
 672 #define   EFI_DEV_MSG_USB                        5
 673 #define   EFI_DEV_MSG_USB_CLASS                 15
 674 #define   EFI_DEV_MSG_I20                        6
 675 #define   EFI_DEV_MSG_MAC                       11
 676 #define   EFI_DEV_MSG_IPV4                      12
 677 #define   EFI_DEV_MSG_IPV6                      13
 678 #define   EFI_DEV_MSG_INFINIBAND                 9
 679 #define   EFI_DEV_MSG_UART                      14
 680 #define   EFI_DEV_MSG_VENDOR                    10
 681 #define EFI_DEV_MEDIA                   0x04
 682 #define   EFI_DEV_MEDIA_HARD_DRIVE               1
 683 #define   EFI_DEV_MEDIA_CDROM                    2
 684 #define   EFI_DEV_MEDIA_VENDOR                   3
 685 #define   EFI_DEV_MEDIA_FILE                     4
 686 #define   EFI_DEV_MEDIA_PROTOCOL                 5
 687 #define EFI_DEV_BIOS_BOOT               0x05
 688 #define EFI_DEV_END_PATH                0x7F
 689 #define EFI_DEV_END_PATH2               0xFF
 690 #define   EFI_DEV_END_INSTANCE                  0x01
 691 #define   EFI_DEV_END_ENTIRE                    0xFF
 692
 693 struct efi_generic_dev_path {
 694         u8 type;
 695         u8 sub_type;
 696         u16 length;
 697 } __attribute ((packed));
 698
 699 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
 700 {
 701         *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
 702         *addr &= PAGE_MASK;
 703 }
 704
 705 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
 706 /*
 707  * EFI Variable support.
 708  *
 709  * Different firmware drivers can expose their EFI-like variables using
 710  * the following.
 711  */
 712
 713 struct efivar_operations {
 714         efi_get_variable_t *get_variable;
 715         efi_get_next_variable_t *get_next_variable;
 716         efi_set_variable_t *set_variable;
 717 };
 718
 719 struct efivars {
 720         /*
 721          * ->lock protects two things:
 722          * 1) ->list - adds, removals, reads, writes
 723          * 2) ops.[gs]et_variable() calls.
 724          * It must not be held when creating sysfs entries or calling kmalloc.
 725          * ops.get_next_variable() is only called from register_efivars(),
 726          * which is protected by the BKL, so that path is safe.
 727          */
 728         spinlock_t lock;
 729         struct list_head list;
 730         struct kset *kset;
 731         struct bin_attribute *new_var, *del_var;
 732         const struct efivar_operations *ops;
 733         struct efivar_entry *walk_entry;
 734         struct pstore_info efi_pstore_info;
 735 };
 736
 737 int register_efivars(struct efivars *efivars,
 738                      const struct efivar_operations *ops,
 739                      struct kobject *parent_kobj);
 740 void unregister_efivars(struct efivars *efivars);
 741
 742 #endif /* CONFIG_EFI_VARS */
 743
 744 #endif /* _LINUX_EFI_H */