linux/include/linux/efi.h
<<
>>
Prefs
   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/mutex.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_ABORTED             (21 | (1UL << (BITS_PER_LONG-1)))
  39#define EFI_SECURITY_VIOLATION  (26 | (1UL << (BITS_PER_LONG-1)))
  40
  41typedef unsigned long efi_status_t;
  42typedef u8 efi_bool_t;
  43typedef u16 efi_char16_t;               /* UNICODE character */
  44typedef u64 efi_physical_addr_t;
  45typedef void *efi_handle_t;
  46
  47
  48typedef 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 */
  62typedef 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_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_NV           ((u64)0x0000000000008000ULL)    /* non-volatile */
 101#define EFI_MEMORY_MORE_RELIABLE \
 102                                ((u64)0x0000000000010000ULL)    /* higher reliability */
 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
 109typedef 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
 118typedef 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
 133typedef 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
 142typedef 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
 156typedef struct {
 157        u32 resolution;
 158        u32 accuracy;
 159        u8 sets_to_zero;
 160} efi_time_cap_t;
 161
 162typedef 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
 210typedef 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 */
 261typedef 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        void *locate_protocol;
 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
 311typedef 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
 327typedef enum {
 328        EfiPciIoAttributeOperationGet,
 329        EfiPciIoAttributeOperationSet,
 330        EfiPciIoAttributeOperationEnable,
 331        EfiPciIoAttributeOperationDisable,
 332        EfiPciIoAttributeOperationSupported,
 333    EfiPciIoAttributeOperationMaximum
 334} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
 335
 336typedef struct {
 337        u32 read;
 338        u32 write;
 339} efi_pci_io_protocol_access_32_t;
 340
 341typedef struct {
 342        u64 read;
 343        u64 write;
 344} efi_pci_io_protocol_access_64_t;
 345
 346typedef struct {
 347        void *read;
 348        void *write;
 349} efi_pci_io_protocol_access_t;
 350
 351typedef 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
 371typedef 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
 391typedef 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
 444typedef 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
 462typedef 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
 480typedef 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
 498typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 499typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 500typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 501                                            efi_time_t *tm);
 502typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 503typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 504                                         unsigned long *data_size, void *data);
 505typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 506                                              efi_guid_t *vendor);
 507typedef 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);
 510typedef efi_status_t
 511efi_set_variable_nonblocking_t(efi_char16_t *name, efi_guid_t *vendor,
 512                               u32 attr, unsigned long data_size, void *data);
 513
 514typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 515typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 516                                 unsigned long data_size, efi_char16_t *data);
 517typedef 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);
 521typedef efi_status_t efi_query_variable_info_t(u32 attr,
 522                                               u64 *storage_space,
 523                                               u64 *remaining_space,
 524                                               u64 *max_variable_size);
 525typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
 526                                          unsigned long count,
 527                                          unsigned long sg_list);
 528typedef 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);
 532typedef efi_status_t efi_query_variable_store_t(u32 attributes,
 533                                                unsigned long size,
 534                                                bool nonblocking);
 535
 536void efi_native_runtime_setup(void);
 537
 538/*
 539 *  EFI Configuration Table and GUID definitions
 540 */
 541#define NULL_GUID \
 542    EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
 543
 544#define MPS_TABLE_GUID    \
 545    EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 546
 547#define ACPI_TABLE_GUID    \
 548    EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 549
 550#define ACPI_20_TABLE_GUID    \
 551    EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
 552
 553#define SMBIOS_TABLE_GUID    \
 554    EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 555
 556#define SMBIOS3_TABLE_GUID    \
 557    EFI_GUID(  0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94 )
 558
 559#define SAL_SYSTEM_TABLE_GUID    \
 560    EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 561
 562#define HCDP_TABLE_GUID \
 563    EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
 564
 565#define UGA_IO_PROTOCOL_GUID \
 566    EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
 567
 568#define EFI_GLOBAL_VARIABLE_GUID \
 569    EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
 570
 571#define UV_SYSTEM_TABLE_GUID \
 572    EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
 573
 574#define LINUX_EFI_CRASH_GUID \
 575    EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
 576
 577#define LOADED_IMAGE_PROTOCOL_GUID \
 578    EFI_GUID(  0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 579
 580#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
 581    EFI_GUID(  0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
 582
 583#define EFI_UGA_PROTOCOL_GUID \
 584    EFI_GUID(  0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
 585
 586#define EFI_PCI_IO_PROTOCOL_GUID \
 587    EFI_GUID(  0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
 588
 589#define EFI_FILE_INFO_ID \
 590    EFI_GUID(  0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 591
 592#define EFI_SYSTEM_RESOURCE_TABLE_GUID \
 593    EFI_GUID(  0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 )
 594
 595#define EFI_FILE_SYSTEM_GUID \
 596    EFI_GUID(  0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 597
 598#define EFI_CERT_SHA256_GUID \
 599    EFI_GUID(  0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28 )
 600
 601#define EFI_CERT_X509_GUID \
 602    EFI_GUID(  0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72 )
 603
 604#define EFI_IMAGE_SECURITY_DATABASE_GUID \
 605    EFI_GUID(  0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f )
 606
 607#define EFI_SHIM_LOCK_GUID \
 608    EFI_GUID(  0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23 )
 609
 610typedef struct {
 611        efi_guid_t guid;
 612        u64 table;
 613} efi_config_table_64_t;
 614
 615typedef struct {
 616        efi_guid_t guid;
 617        u32 table;
 618} efi_config_table_32_t;
 619
 620typedef struct {
 621        efi_guid_t guid;
 622        unsigned long table;
 623} efi_config_table_t;
 624
 625typedef struct {
 626        efi_guid_t guid;
 627        const char *name;
 628        unsigned long *ptr;
 629} efi_config_table_type_t;
 630
 631#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 632
 633#define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
 634#define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
 635#define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
 636#define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
 637#define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
 638#define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
 639
 640typedef struct {
 641        efi_table_hdr_t hdr;
 642        u64 fw_vendor;  /* physical addr of CHAR16 vendor string */
 643        u32 fw_revision;
 644        u32 __pad1;
 645        u64 con_in_handle;
 646        u64 con_in;
 647        u64 con_out_handle;
 648        u64 con_out;
 649        u64 stderr_handle;
 650        u64 stderr;
 651        u64 runtime;
 652        u64 boottime;
 653        u32 nr_tables;
 654        u32 __pad2;
 655        u64 tables;
 656} efi_system_table_64_t;
 657
 658typedef struct {
 659        efi_table_hdr_t hdr;
 660        u32 fw_vendor;  /* physical addr of CHAR16 vendor string */
 661        u32 fw_revision;
 662        u32 con_in_handle;
 663        u32 con_in;
 664        u32 con_out_handle;
 665        u32 con_out;
 666        u32 stderr_handle;
 667        u32 stderr;
 668        u32 runtime;
 669        u32 boottime;
 670        u32 nr_tables;
 671        u32 tables;
 672} efi_system_table_32_t;
 673
 674typedef struct {
 675        efi_table_hdr_t hdr;
 676        unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
 677        u32 fw_revision;
 678        unsigned long con_in_handle;
 679        unsigned long con_in;
 680        unsigned long con_out_handle;
 681        unsigned long con_out;
 682        unsigned long stderr_handle;
 683        unsigned long stderr;
 684        efi_runtime_services_t *runtime;
 685        efi_boot_services_t *boottime;
 686        unsigned long nr_tables;
 687        unsigned long tables;
 688} efi_system_table_t;
 689
 690struct efi_memory_map {
 691        RH_KABI_REPLACE(void *phys_map, phys_addr_t phys_map)
 692        void *map;
 693        void *map_end;
 694        int nr_map;
 695        unsigned long desc_version;
 696        unsigned long desc_size;
 697};
 698
 699typedef struct {
 700        u32 revision;
 701        u32 parent_handle;
 702        u32 system_table;
 703        u32 device_handle;
 704        u32 file_path;
 705        u32 reserved;
 706        u32 load_options_size;
 707        u32 load_options;
 708        u32 image_base;
 709        __aligned_u64 image_size;
 710        unsigned int image_code_type;
 711        unsigned int image_data_type;
 712        unsigned long unload;
 713} efi_loaded_image_32_t;
 714
 715typedef struct {
 716        u32 revision;
 717        u64 parent_handle;
 718        u64 system_table;
 719        u64 device_handle;
 720        u64 file_path;
 721        u64 reserved;
 722        u32 load_options_size;
 723        u64 load_options;
 724        u64 image_base;
 725        __aligned_u64 image_size;
 726        unsigned int image_code_type;
 727        unsigned int image_data_type;
 728        unsigned long unload;
 729} efi_loaded_image_64_t;
 730
 731typedef struct {
 732        u32 revision;
 733        void *parent_handle;
 734        efi_system_table_t *system_table;
 735        void *device_handle;
 736        void *file_path;
 737        void *reserved;
 738        u32 load_options_size;
 739        void *load_options;
 740        void *image_base;
 741        __aligned_u64 image_size;
 742        unsigned int image_code_type;
 743        unsigned int image_data_type;
 744        unsigned long unload;
 745} efi_loaded_image_t;
 746
 747
 748typedef struct {
 749        u64 size;
 750        u64 file_size;
 751        u64 phys_size;
 752        efi_time_t create_time;
 753        efi_time_t last_access_time;
 754        efi_time_t modification_time;
 755        __aligned_u64 attribute;
 756        efi_char16_t filename[1];
 757} efi_file_info_t;
 758
 759typedef struct {
 760        u64 revision;
 761        u32 open;
 762        u32 close;
 763        u32 delete;
 764        u32 read;
 765        u32 write;
 766        u32 get_position;
 767        u32 set_position;
 768        u32 get_info;
 769        u32 set_info;
 770        u32 flush;
 771} efi_file_handle_32_t;
 772
 773typedef struct {
 774        u64 revision;
 775        u64 open;
 776        u64 close;
 777        u64 delete;
 778        u64 read;
 779        u64 write;
 780        u64 get_position;
 781        u64 set_position;
 782        u64 get_info;
 783        u64 set_info;
 784        u64 flush;
 785} efi_file_handle_64_t;
 786
 787typedef struct _efi_file_handle {
 788        u64 revision;
 789        efi_status_t (*open)(struct _efi_file_handle *,
 790                             struct _efi_file_handle **,
 791                             efi_char16_t *, u64, u64);
 792        efi_status_t (*close)(struct _efi_file_handle *);
 793        void *delete;
 794        efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
 795                             void *);
 796        void *write;
 797        void *get_position;
 798        void *set_position;
 799        efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
 800                        unsigned long *, void *);
 801        void *set_info;
 802        void *flush;
 803} efi_file_handle_t;
 804
 805typedef struct _efi_file_io_interface {
 806        u64 revision;
 807        int (*open_volume)(struct _efi_file_io_interface *,
 808                           efi_file_handle_t **);
 809} efi_file_io_interface_t;
 810
 811#define EFI_FILE_MODE_READ      0x0000000000000001
 812#define EFI_FILE_MODE_WRITE     0x0000000000000002
 813#define EFI_FILE_MODE_CREATE    0x8000000000000000
 814
 815#define EFI_INVALID_TABLE_ADDR          (~0UL)
 816
 817typedef struct  {
 818        efi_guid_t signature_owner;
 819        u8 signature_data[];
 820} efi_signature_data_t;
 821
 822typedef struct {
 823        efi_guid_t signature_type;
 824        u32 signature_list_size;
 825        u32 signature_header_size;
 826        u32 signature_size;
 827        u8 signature_header[];
 828        /* efi_signature_data_t signatures[][] */
 829} efi_signature_list_t;
 830
 831/*
 832 * All runtime access to EFI goes through this structure:
 833 */
 834extern struct efi {
 835        efi_system_table_t *systab;     /* EFI system table */
 836        unsigned int runtime_version;   /* Runtime services version */
 837        unsigned long mps;              /* MPS table */
 838        unsigned long acpi;             /* ACPI table  (IA64 ext 0.71) */
 839        unsigned long acpi20;           /* ACPI table  (ACPI 2.0) */
 840        unsigned long smbios;           /* SMBIOS table (32 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        efi_get_time_t *get_time;
 850        efi_set_time_t *set_time;
 851        efi_get_wakeup_time_t *get_wakeup_time;
 852        efi_set_wakeup_time_t *set_wakeup_time;
 853        efi_get_variable_t *get_variable;
 854        efi_get_next_variable_t *get_next_variable;
 855        efi_set_variable_t *set_variable;
 856        efi_query_variable_info_t *query_variable_info;
 857        efi_update_capsule_t *update_capsule;
 858        efi_query_capsule_caps_t *query_capsule_caps;
 859        efi_get_next_high_mono_count_t *get_next_high_mono_count;
 860        efi_reset_system_t *reset_system;
 861        efi_set_virtual_address_map_t *set_virtual_address_map;
 862        struct efi_memory_map *memmap;
 863        /* SMBIOS table (64 bit entry point) */
 864        RH_KABI_EXTEND(unsigned long smbios3)
 865        /* ESRT table */
 866        RH_KABI_EXTEND(unsigned long esrt)
 867        /* EFI facility flags */
 868        RH_KABI_EXTEND(unsigned long flags)
 869        /* Provide a non-blocking SetVariable() operation */
 870        RH_KABI_EXTEND(efi_set_variable_nonblocking_t *set_variable_nonblocking)
 871        /* Provide a non-blocking QueryVariableInfo() operation */
 872        RH_KABI_EXTEND(efi_query_variable_info_t *query_variable_info_nonblocking)
 873} efi;
 874
 875extern struct mm_struct efi_mm;
 876
 877static inline int
 878efi_guidcmp (efi_guid_t left, efi_guid_t right)
 879{
 880        return memcmp(&left, &right, sizeof (efi_guid_t));
 881}
 882
 883static inline char *
 884efi_guid_to_str(efi_guid_t *guid, char *out)
 885{
 886        sprintf(out, "%pUl", guid->b);
 887        return out;
 888}
 889
 890extern void efi_init (void);
 891extern void *efi_get_pal_addr (void);
 892extern void efi_map_pal_code (void);
 893extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
 894extern void efi_gettimeofday (struct timespec *ts);
 895extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
 896#ifdef CONFIG_X86
 897extern void efi_late_init(void);
 898extern void efi_free_boot_services(void);
 899extern efi_status_t efi_query_variable_store(u32 attributes,
 900                                             unsigned long size,
 901                                             bool nonblocking);
 902extern void efi_find_mirror(void);
 903#else
 904static inline void efi_late_init(void) {}
 905static inline void efi_free_boot_services(void) {}
 906
 907static inline efi_status_t efi_query_variable_store(u32 attributes,
 908                                                    unsigned long size,
 909                                                    bool nonblocking)
 910{
 911        return EFI_SUCCESS;
 912}
 913#endif
 914extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
 915extern int efi_config_init(efi_config_table_type_t *arch_tables);
 916#ifdef CONFIG_EFI_ESRT
 917extern void __init efi_esrt_init(void);
 918#else
 919static inline void efi_esrt_init(void) { }
 920#endif
 921extern u64 efi_get_iobase (void);
 922extern int efi_mem_type(unsigned long phys_addr);
 923extern u64 efi_mem_attributes (unsigned long phys_addr);
 924extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 925extern int __init efi_uart_console_only (void);
 926extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
 927extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
 928extern void efi_initialize_iomem_resources(struct resource *code_resource,
 929                struct resource *data_resource, struct resource *bss_resource);
 930extern void efi_get_time(struct timespec *now);
 931extern int efi_set_rtc_mmss(const struct timespec *now);
 932extern void efi_reserve_boot_services(void);
 933extern struct efi_memory_map memmap;
 934extern struct kobject *efi_kobj;
 935
 936struct key;
 937extern int __init parse_efi_signature_list(const void *data, size_t size,
 938                                           struct key *keyring);
 939
 940/*
 941 * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor
 942 * @map: the start of efi memmap
 943 * @desc_size: the size of space for each EFI memmap descriptor
 944 * @n: the index of efi memmap descriptor
 945 *
 946 * EFI boot service provides the GetMemoryMap() function to get a copy of the
 947 * current memory map which is an array of memory descriptors, each of
 948 * which describes a contiguous block of memory. It also gets the size of the
 949 * map, and the size of each descriptor, etc.
 950 *
 951 * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
 952 * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
 953 * since efi_memory_memdesc_t may be extended in the future. Thus the OS
 954 * MUST use the returned size of the descriptor to find the start of each
 955 * efi_memory_memdesc_t in the memory map array. This should only be used
 956 * during bootup since for_each_efi_memory_desc_xxx() is available after the
 957 * kernel initializes the EFI subsystem to set up struct efi_memory_map.
 958 */
 959#define efi_early_memdesc_ptr(map, desc_size, n)                        \
 960        (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
 961
 962/**
 963 * efi_range_is_wc - check the WC bit on an address range
 964 * @start: starting kvirt address
 965 * @len: length of range
 966 *
 967 * Consult the EFI memory map and make sure it's ok to set this range WC.
 968 * Returns true or false.
 969 */
 970static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 971{
 972        unsigned long i;
 973
 974        for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 975                unsigned long paddr = __pa(start + i);
 976                if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 977                        return 0;
 978        }
 979        /* The range checked out */
 980        return 1;
 981}
 982
 983#ifdef CONFIG_EFI_PCDP
 984extern int __init efi_setup_pcdp_console(char *);
 985#endif
 986
 987/*
 988 * We play games with efi_enabled so that the compiler will, if
 989 * possible, remove EFI-related code altogether.
 990 */
 991#define EFI_BOOT                0       /* Were we booted from EFI? */
 992#define EFI_SYSTEM_TABLES       1       /* Can we use EFI system tables? */
 993#define EFI_CONFIG_TABLES       2       /* Can we use EFI config tables? */
 994#define EFI_RUNTIME_SERVICES    3       /* Can we use runtime services? */
 995#define EFI_MEMMAP              4       /* Can we use EFI memory map? */
 996#define EFI_64BIT               5       /* Is the firmware 64-bit? */
 997#define EFI_SECURE_BOOT         6       /* Area we in Secure Boot mode? */
 998#define EFI_ARCH_1              7       /* First arch-specific bit */
 999
1000#ifdef CONFIG_EFI
1001# ifdef CONFIG_X86
1002
1003/*
1004 * Test whether the above EFI_* bits are enabled.
1005 */
1006static inline bool efi_enabled(int feature)
1007{
1008        return test_bit(feature, &efi.flags) != 0;
1009}
1010
1011extern bool efi_is_table_address(unsigned long phys_addr);
1012# else
1013static inline bool efi_enabled(int feature)
1014{
1015        return true;
1016}
1017# endif
1018#else
1019static inline bool efi_enabled(int feature)
1020{
1021        return false;
1022}
1023
1024static inline bool efi_is_table_address(unsigned long phys_addr)
1025{
1026        return false;
1027}
1028#endif
1029
1030/*
1031 * Variable Attributes
1032 */
1033#define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
1034#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1035#define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
1036#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1037#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1038#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1039#define EFI_VARIABLE_APPEND_WRITE       0x0000000000000040
1040
1041#define EFI_VARIABLE_MASK       (EFI_VARIABLE_NON_VOLATILE | \
1042                                EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1043                                EFI_VARIABLE_RUNTIME_ACCESS | \
1044                                EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1045                                EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1046                                EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1047                                EFI_VARIABLE_APPEND_WRITE)
1048/*
1049 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1050 * not including trailing NUL
1051 */
1052#define EFI_VARIABLE_GUID_LEN 36
1053
1054/*
1055 * The type of search to perform when calling boottime->locate_handle
1056 */
1057#define EFI_LOCATE_ALL_HANDLES                  0
1058#define EFI_LOCATE_BY_REGISTER_NOTIFY           1
1059#define EFI_LOCATE_BY_PROTOCOL                  2
1060
1061/*
1062 * EFI Device Path information
1063 */
1064#define EFI_DEV_HW                      0x01
1065#define  EFI_DEV_PCI                             1
1066#define  EFI_DEV_PCCARD                          2
1067#define  EFI_DEV_MEM_MAPPED                      3
1068#define  EFI_DEV_VENDOR                          4
1069#define  EFI_DEV_CONTROLLER                      5
1070#define EFI_DEV_ACPI                    0x02
1071#define   EFI_DEV_BASIC_ACPI                     1
1072#define   EFI_DEV_EXPANDED_ACPI                  2
1073#define EFI_DEV_MSG                     0x03
1074#define   EFI_DEV_MSG_ATAPI                      1
1075#define   EFI_DEV_MSG_SCSI                       2
1076#define   EFI_DEV_MSG_FC                         3
1077#define   EFI_DEV_MSG_1394                       4
1078#define   EFI_DEV_MSG_USB                        5
1079#define   EFI_DEV_MSG_USB_CLASS                 15
1080#define   EFI_DEV_MSG_I20                        6
1081#define   EFI_DEV_MSG_MAC                       11
1082#define   EFI_DEV_MSG_IPV4                      12
1083#define   EFI_DEV_MSG_IPV6                      13
1084#define   EFI_DEV_MSG_INFINIBAND                 9
1085#define   EFI_DEV_MSG_UART                      14
1086#define   EFI_DEV_MSG_VENDOR                    10
1087#define EFI_DEV_MEDIA                   0x04
1088#define   EFI_DEV_MEDIA_HARD_DRIVE               1
1089#define   EFI_DEV_MEDIA_CDROM                    2
1090#define   EFI_DEV_MEDIA_VENDOR                   3
1091#define   EFI_DEV_MEDIA_FILE                     4
1092#define   EFI_DEV_MEDIA_PROTOCOL                 5
1093#define EFI_DEV_BIOS_BOOT               0x05
1094#define EFI_DEV_END_PATH                0x7F
1095#define EFI_DEV_END_PATH2               0xFF
1096#define   EFI_DEV_END_INSTANCE                  0x01
1097#define   EFI_DEV_END_ENTIRE                    0xFF
1098
1099struct efi_generic_dev_path {
1100        u8 type;
1101        u8 sub_type;
1102        u16 length;
1103} __attribute ((packed));
1104
1105struct efi_dev_path {
1106        u8 type;        /* can be replaced with unnamed */
1107        u8 sub_type;    /* struct efi_generic_dev_path; */
1108        u16 length;     /* once we've moved to -std=c11 */
1109        union {
1110                struct {
1111                        u32 hid;
1112                        u32 uid;
1113                } acpi;
1114                struct {
1115                        u8 fn;
1116                        u8 dev;
1117                } pci;
1118        };
1119} __attribute ((packed));
1120
1121#if IS_ENABLED(CONFIG_EFI_DEV_PATH_PARSER)
1122struct device *efi_get_device_by_path(struct efi_dev_path **node, size_t *len);
1123#endif
1124
1125static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1126{
1127        *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1128        *addr &= PAGE_MASK;
1129}
1130
1131/*
1132 * EFI Variable support.
1133 *
1134 * Different firmware drivers can expose their EFI-like variables using
1135 * the following.
1136 */
1137
1138struct efivar_operations {
1139        efi_get_variable_t *get_variable;
1140        efi_get_next_variable_t *get_next_variable;
1141        efi_set_variable_t *set_variable;
1142        efi_set_variable_nonblocking_t *set_variable_nonblocking;
1143        efi_query_variable_store_t *query_variable_store;
1144};
1145
1146struct efivars {
1147        struct kset *kset;
1148        struct kobject *kobject;
1149        const struct efivar_operations *ops;
1150};
1151
1152/*
1153 * The maximum size of VariableName + Data = 1024
1154 * Therefore, it's reasonable to save that much
1155 * space in each part of the structure,
1156 * and we use a page for reading/writing.
1157 */
1158
1159#define EFI_VAR_NAME_LEN        1024
1160
1161struct efi_variable {
1162        efi_char16_t  VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1163        efi_guid_t    VendorGuid;
1164        unsigned long DataSize;
1165        __u8          Data[1024];
1166        efi_status_t  Status;
1167        __u32         Attributes;
1168} __attribute__((packed));
1169
1170struct efivar_entry {
1171        struct efi_variable var;
1172        struct list_head list;
1173        struct kobject kobj;
1174        bool scanning;
1175        bool deleting;
1176        struct mutex var_data_mutex;    /* Protect var.DataSize and var.Data */
1177};
1178
1179struct efi_simple_text_output_protocol_32 {
1180        u32 reset;
1181        u32 output_string;
1182        u32 test_string;
1183};
1184
1185struct efi_simple_text_output_protocol_64 {
1186        u64 reset;
1187        u64 output_string;
1188        u64 test_string;
1189};
1190
1191struct efi_simple_text_output_protocol {
1192        void *reset;
1193        efi_status_t (*output_string)(void *, void *);
1194        void *test_string;
1195};
1196
1197extern struct list_head efivar_sysfs_list;
1198
1199static inline void
1200efivar_unregister(struct efivar_entry *var)
1201{
1202        kobject_put(&var->kobj);
1203}
1204
1205int efivars_register(struct efivars *efivars,
1206                     const struct efivar_operations *ops,
1207                     struct kobject *kobject);
1208int efivars_unregister(struct efivars *efivars);
1209struct kobject *efivars_kobject(void);
1210
1211int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1212                void *data, bool duplicates, struct list_head *head);
1213
1214int efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1215int efivar_entry_remove(struct efivar_entry *entry);
1216
1217int __efivar_entry_delete(struct efivar_entry *entry);
1218int efivar_entry_delete(struct efivar_entry *entry);
1219
1220int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1221int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1222                       unsigned long *size, void *data);
1223int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1224                     unsigned long *size, void *data);
1225int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1226                     unsigned long size, void *data, struct list_head *head);
1227int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1228                              unsigned long *size, void *data, bool *set);
1229int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1230                          bool block, unsigned long size, void *data);
1231
1232int efivar_entry_iter_begin(void);
1233void efivar_entry_iter_end(void);
1234
1235int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1236                        struct list_head *head, void *data,
1237                        struct efivar_entry **prev);
1238int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1239                      struct list_head *head, void *data);
1240
1241struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1242                                       struct list_head *head, bool remove);
1243
1244bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1245                     unsigned long data_size);
1246bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1247                                  size_t len);
1248
1249extern struct work_struct efivar_work;
1250void efivar_run_worker(void);
1251
1252#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1253int efivars_sysfs_init(void);
1254
1255#define EFIVARS_DATA_SIZE_MAX 1024
1256
1257#endif /* CONFIG_EFI_VARS */
1258
1259#ifdef CONFIG_EFI_RUNTIME_MAP
1260int efi_runtime_map_init(struct kobject *);
1261void efi_runtime_map_setup(void *, int, u32);
1262int efi_get_runtime_map_size(void);
1263int efi_get_runtime_map_desc_size(void);
1264int efi_runtime_map_copy(void *buf, size_t bufsz);
1265#else
1266static inline int efi_runtime_map_init(struct kobject *kobj)
1267{
1268        return 0;
1269}
1270
1271static inline void
1272efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
1273
1274static inline int efi_get_runtime_map_size(void)
1275{
1276        return 0;
1277}
1278
1279static inline int efi_get_runtime_map_desc_size(void)
1280{
1281        return 0;
1282}
1283
1284static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1285{
1286        return 0;
1287}
1288
1289#endif
1290
1291bool efi_runtime_disabled(void);
1292extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1293
1294/*
1295 * Arch code can implement the following three template macros, avoiding
1296 * reptition for the void/non-void return cases of {__,}efi_call_virt():
1297 *
1298 *  * arch_efi_call_virt_setup()
1299 *
1300 *    Sets up the environment for the call (e.g. switching page tables,
1301 *    allowing kernel-mode use of floating point, if required).
1302 *
1303 *  * arch_efi_call_virt()
1304 *
1305 *    Performs the call. The last expression in the macro must be the call
1306 *    itself, allowing the logic to be shared by the void and non-void
1307 *    cases.
1308 *
1309 *  * arch_efi_call_virt_teardown()
1310 *
1311 *    Restores the usual kernel environment once the call has returned.
1312 */
1313
1314#define efi_call_virt_pointer(p, f, args...)                            \
1315({                                                                      \
1316        efi_status_t __s;                                               \
1317        unsigned long __flags;                                          \
1318        bool ibrs_on;                                                   \
1319                                                                        \
1320        ibrs_on = arch_efi_call_virt_setup();                           \
1321                                                                        \
1322        local_save_flags(__flags);                                      \
1323        __s = arch_efi_call_virt(p, f, args);                           \
1324        efi_call_virt_check_flags(__flags, __stringify(f));             \
1325                                                                        \
1326        arch_efi_call_virt_teardown(ibrs_on);                           \
1327                                                                        \
1328        __s;                                                            \
1329})
1330
1331#define __efi_call_virt_pointer(p, f, args...)                          \
1332({                                                                      \
1333        unsigned long __flags;                                          \
1334        bool ibrs_on;                                                   \
1335                                                                        \
1336        ibrs_on = arch_efi_call_virt_setup();                           \
1337                                                                        \
1338        local_save_flags(__flags);                                      \
1339        arch_efi_call_virt(p, f, args);                                 \
1340        efi_call_virt_check_flags(__flags, __stringify(f));             \
1341                                                                        \
1342        arch_efi_call_virt_teardown(ibrs_on);                           \
1343})
1344
1345/*
1346 * efi_runtime_service() function identifiers.
1347 * "NONE" is used by efi_recover_from_page_fault() to check if the page
1348 * fault happened while executing an efi runtime service.
1349 */
1350enum efi_rts_ids {
1351        NONE,
1352        GET_TIME,
1353        SET_TIME,
1354        GET_WAKEUP_TIME,
1355        SET_WAKEUP_TIME,
1356        GET_VARIABLE,
1357        GET_NEXT_VARIABLE,
1358        SET_VARIABLE,
1359        QUERY_VARIABLE_INFO,
1360        GET_NEXT_HIGH_MONO_COUNT,
1361        RESET_SYSTEM,
1362        UPDATE_CAPSULE,
1363        QUERY_CAPSULE_CAPS,
1364};
1365
1366/*
1367 * efi_runtime_work:    Details of EFI Runtime Service work
1368 * @arg<1-5>:           EFI Runtime Service function arguments
1369 * @status:             Status of executing EFI Runtime Service
1370 * @efi_rts_id:         EFI Runtime Service function identifier
1371 * @efi_rts_comp:       Struct used for handling completions
1372 */
1373struct efi_runtime_work {
1374        void *arg1;
1375        void *arg2;
1376        void *arg3;
1377        void *arg4;
1378        void *arg5;
1379        efi_status_t status;
1380        struct work_struct work;
1381        enum efi_rts_ids efi_rts_id;
1382        struct completion efi_rts_comp;
1383};
1384
1385extern struct efi_runtime_work efi_rts_work;
1386
1387/* Workqueue to queue EFI Runtime Services */
1388extern struct workqueue_struct *efi_rts_wq;
1389
1390#endif /* _LINUX_EFI_H */
1391