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 #include <asm/system.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_FOUND           (14 | (1UL << (BITS_PER_LONG-1)))
  34
  35 typedef unsigned long efi_status_t;
  36 typedef u8 efi_bool_t;
  37 typedef u16 efi_char16_t;               /* UNICODE character */
  38
  39
  40 typedef struct {
  41         u8 b[16];
  42 } efi_guid_t;
  43
  44 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
  45 ((efi_guid_t) \
  46 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
  47   (b) & 0xff, ((b) >> 8) & 0xff, \
  48   (c) & 0xff, ((c) >> 8) & 0xff, \
  49   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
  50
  51 /*
  52  * Generic EFI table header
  53  */
  54 typedef struct {
  55         u64 signature;
  56         u32 revision;
  57         u32 headersize;
  58         u32 crc32;
  59         u32 reserved;
  60 } efi_table_hdr_t;
  61
  62 /*
  63  * Memory map descriptor:
  64  */
  65
  66 /* Memory types: */
  67 #define EFI_RESERVED_TYPE                0
  68 #define EFI_LOADER_CODE                  1
  69 #define EFI_LOADER_DATA                  2
  70 #define EFI_BOOT_SERVICES_CODE           3
  71 #define EFI_BOOT_SERVICES_DATA           4
  72 #define EFI_RUNTIME_SERVICES_CODE        5
  73 #define EFI_RUNTIME_SERVICES_DATA        6
  74 #define EFI_CONVENTIONAL_MEMORY          7
  75 #define EFI_UNUSABLE_MEMORY              8
  76 #define EFI_ACPI_RECLAIM_MEMORY          9
  77 #define EFI_ACPI_MEMORY_NVS             10
  78 #define EFI_MEMORY_MAPPED_IO            11
  79 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
  80 #define EFI_PAL_CODE                    13
  81 #define EFI_MAX_MEMORY_TYPE             14
  82
  83 /* Attribute values: */
  84 #define EFI_MEMORY_UC           ((u64)0x0000000000000001ULL)    /* uncached */
  85 #define EFI_MEMORY_WC           ((u64)0x0000000000000002ULL)    /* write-coalescing */
  86 #define EFI_MEMORY_WT           ((u64)0x0000000000000004ULL)    /* write-through */
  87 #define EFI_MEMORY_WB           ((u64)0x0000000000000008ULL)    /* write-back */
  88 #define EFI_MEMORY_WP           ((u64)0x0000000000001000ULL)    /* write-protect */
  89 #define EFI_MEMORY_RP           ((u64)0x0000000000002000ULL)    /* read-protect */
  90 #define EFI_MEMORY_XP           ((u64)0x0000000000004000ULL)    /* execute-protect */
  91 #define EFI_MEMORY_RUNTIME      ((u64)0x8000000000000000ULL)    /* range requires runtime mapping */
  92 #define EFI_MEMORY_DESCRIPTOR_VERSION   1
  93
  94 #define EFI_PAGE_SHIFT          12
  95
  96 typedef struct {
  97         u32 type;
  98         u32 pad;
  99         u64 phys_addr;
 100         u64 virt_addr;
 101         u64 num_pages;
 102         u64 attribute;
 103 } efi_memory_desc_t;
 104
 105 typedef struct {
 106         efi_guid_t guid;
 107         u32 headersize;
 108         u32 flags;
 109         u32 imagesize;
 110 } efi_capsule_header_t;
 111
 112 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
 113
 114 /*
 115  * Types and defines for Time Services
 116  */
 117 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
 118 #define EFI_TIME_IN_DAYLIGHT     0x2
 119 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 120
 121 typedef struct {
 122         u16 year;
 123         u8 month;
 124         u8 day;
 125         u8 hour;
 126         u8 minute;
 127         u8 second;
 128         u8 pad1;
 129         u32 nanosecond;
 130         s16 timezone;
 131         u8 daylight;
 132         u8 pad2;
 133 } efi_time_t;
 134
 135 typedef struct {
 136         u32 resolution;
 137         u32 accuracy;
 138         u8 sets_to_zero;
 139 } efi_time_cap_t;
 140
 141 /*
 142  * EFI Boot Services table
 143  */
 144 typedef struct {
 145         efi_table_hdr_t hdr;
 146         void *raise_tpl;
 147         void *restore_tpl;
 148         void *allocate_pages;
 149         void *free_pages;
 150         void *get_memory_map;
 151         void *allocate_pool;
 152         void *free_pool;
 153         void *create_event;
 154         void *set_timer;
 155         void *wait_for_event;
 156         void *signal_event;
 157         void *close_event;
 158         void *check_event;
 159         void *install_protocol_interface;
 160         void *reinstall_protocol_interface;
 161         void *uninstall_protocol_interface;
 162         void *handle_protocol;
 163         void *__reserved;
 164         void *register_protocol_notify;
 165         void *locate_handle;
 166         void *locate_device_path;
 167         void *install_configuration_table;
 168         void *load_image;
 169         void *start_image;
 170         void *exit;
 171         void *unload_image;
 172         void *exit_boot_services;
 173         void *get_next_monotonic_count;
 174         void *stall;
 175         void *set_watchdog_timer;
 176         void *connect_controller;
 177         void *disconnect_controller;
 178         void *open_protocol;
 179         void *close_protocol;
 180         void *open_protocol_information;
 181         void *protocols_per_handle;
 182         void *locate_handle_buffer;
 183         void *locate_protocol;
 184         void *install_multiple_protocol_interfaces;
 185         void *uninstall_multiple_protocol_interfaces;
 186         void *calculate_crc32;
 187         void *copy_mem;
 188         void *set_mem;
 189         void *create_event_ex;
 190 } efi_boot_services_t;
 191
 192 /*
 193  * Types and defines for EFI ResetSystem
 194  */
 195 #define EFI_RESET_COLD 0
 196 #define EFI_RESET_WARM 1
 197 #define EFI_RESET_SHUTDOWN 2
 198
 199 /*
 200  * EFI Runtime Services table
 201  */
 202 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 203 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
 204
 205 typedef struct {
 206         efi_table_hdr_t hdr;
 207         unsigned long get_time;
 208         unsigned long set_time;
 209         unsigned long get_wakeup_time;
 210         unsigned long set_wakeup_time;
 211         unsigned long set_virtual_address_map;
 212         unsigned long convert_pointer;
 213         unsigned long get_variable;
 214         unsigned long get_next_variable;
 215         unsigned long set_variable;
 216         unsigned long get_next_high_mono_count;
 217         unsigned long reset_system;
 218         unsigned long update_capsule;
 219         unsigned long query_capsule_caps;
 220         unsigned long query_variable_info;
 221 } efi_runtime_services_t;
 222
 223 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 224 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 225 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 226                                             efi_time_t *tm);
 227 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 228 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 229                                          unsigned long *data_size, void *data);
 230 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 231                                               efi_guid_t *vendor);
 232 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 233                                          u32 attr, unsigned long data_size,
 234                                          void *data);
 235 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 236 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 237                                  unsigned long data_size, efi_char16_t *data);
 238 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 239                                                 unsigned long descriptor_size,
 240                                                 u32 descriptor_version,
 241                                                 efi_memory_desc_t *virtual_map);
 242 typedef efi_status_t efi_query_variable_info_t(u32 attr,
 243                                                u64 *storage_space,
 244                                                u64 *remaining_space,
 245                                                u64 *max_variable_size);
 246 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
 247                                           unsigned long count,
 248                                           unsigned long sg_list);
 249 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
 250                                               unsigned long count,
 251                                               u64 *max_size,
 252                                               int *reset_type);
 253
 254 /*
 255  *  EFI Configuration Table and GUID definitions
 256  */
 257 #define NULL_GUID \
 258     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
 259
 260 #define MPS_TABLE_GUID    \
 261     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 262
 263 #define ACPI_TABLE_GUID    \
 264     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 265
 266 #define ACPI_20_TABLE_GUID    \
 267     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
 268
 269 #define SMBIOS_TABLE_GUID    \
 270     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 271
 272 #define SAL_SYSTEM_TABLE_GUID    \
 273     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 274
 275 #define HCDP_TABLE_GUID \
 276     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
 277
 278 #define UGA_IO_PROTOCOL_GUID \
 279     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
 280
 281 #define EFI_GLOBAL_VARIABLE_GUID \
 282     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
 283
 284 #define UV_SYSTEM_TABLE_GUID \
 285     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
 286
 287 #define LINUX_EFI_CRASH_GUID \
 288     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
 289
 290 typedef struct {
 291         efi_guid_t guid;
 292         unsigned long table;
 293 } efi_config_table_t;
 294
 295 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 296
 297 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
 298 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
 299 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
 300 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
 301 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
 302 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
 303
 304 typedef struct {
 305         efi_table_hdr_t hdr;
 306         unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
 307         u32 fw_revision;
 308         unsigned long con_in_handle;
 309         unsigned long con_in;
 310         unsigned long con_out_handle;
 311         unsigned long con_out;
 312         unsigned long stderr_handle;
 313         unsigned long stderr;
 314         efi_runtime_services_t *runtime;
 315         efi_boot_services_t *boottime;
 316         unsigned long nr_tables;
 317         unsigned long tables;
 318 } efi_system_table_t;
 319
 320 struct efi_memory_map {
 321         void *phys_map;
 322         void *map;
 323         void *map_end;
 324         int nr_map;
 325         unsigned long desc_version;
 326         unsigned long desc_size;
 327 };
 328
 329 #define EFI_INVALID_TABLE_ADDR          (~0UL)
 330
 331 /*
 332  * All runtime access to EFI goes through this structure:
 333  */
 334 extern struct efi {
 335         efi_system_table_t *systab;     /* EFI system table */
 336         unsigned int runtime_version;   /* Runtime services version */
 337         unsigned long mps;              /* MPS table */
 338         unsigned long acpi;             /* ACPI table  (IA64 ext 0.71) */
 339         unsigned long acpi20;           /* ACPI table  (ACPI 2.0) */
 340         unsigned long smbios;           /* SM BIOS table */
 341         unsigned long sal_systab;       /* SAL system table */
 342         unsigned long boot_info;        /* boot info table */
 343         unsigned long hcdp;             /* HCDP table */
 344         unsigned long uga;              /* UGA table */
 345         unsigned long uv_systab;        /* UV system table */
 346         efi_get_time_t *get_time;
 347         efi_set_time_t *set_time;
 348         efi_get_wakeup_time_t *get_wakeup_time;
 349         efi_set_wakeup_time_t *set_wakeup_time;
 350         efi_get_variable_t *get_variable;
 351         efi_get_next_variable_t *get_next_variable;
 352         efi_set_variable_t *set_variable;
 353         efi_query_variable_info_t *query_variable_info;
 354         efi_update_capsule_t *update_capsule;
 355         efi_query_capsule_caps_t *query_capsule_caps;
 356         efi_get_next_high_mono_count_t *get_next_high_mono_count;
 357         efi_reset_system_t *reset_system;
 358         efi_set_virtual_address_map_t *set_virtual_address_map;
 359 } efi;
 360
 361 static inline int
 362 efi_guidcmp (efi_guid_t left, efi_guid_t right)
 363 {
 364         return memcmp(&left, &right, sizeof (efi_guid_t));
 365 }
 366
 367 static inline char *
 368 efi_guid_unparse(efi_guid_t *guid, char *out)
 369 {
 370         sprintf(out, "%pUl", guid->b);
 371         return out;
 372 }
 373
 374 extern void efi_init (void);
 375 extern void *efi_get_pal_addr (void);
 376 extern void efi_map_pal_code (void);
 377 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
 378 extern void efi_gettimeofday (struct timespec *ts);
 379 extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
 380 extern u64 efi_get_iobase (void);
 381 extern u32 efi_mem_type (unsigned long phys_addr);
 382 extern u64 efi_mem_attributes (unsigned long phys_addr);
 383 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 384 extern int __init efi_uart_console_only (void);
 385 extern void efi_initialize_iomem_resources(struct resource *code_resource,
 386                 struct resource *data_resource, struct resource *bss_resource);
 387 extern unsigned long efi_get_time(void);
 388 extern int efi_set_rtc_mmss(unsigned long nowtime);
 389 extern void efi_reserve_boot_services(void);
 390 extern struct efi_memory_map memmap;
 391
 392 /**
 393  * efi_range_is_wc - check the WC bit on an address range
 394  * @start: starting kvirt address
 395  * @len: length of range
 396  *
 397  * Consult the EFI memory map and make sure it's ok to set this range WC.
 398  * Returns true or false.
 399  */
 400 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 401 {
 402         unsigned long i;
 403
 404         for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 405                 unsigned long paddr = __pa(start + i);
 406                 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 407                         return 0;
 408         }
 409         /* The range checked out */
 410         return 1;
 411 }
 412
 413 #ifdef CONFIG_EFI_PCDP
 414 extern int __init efi_setup_pcdp_console(char *);
 415 #endif
 416
 417 /*
 418  * We play games with efi_enabled so that the compiler will, if possible, remove
 419  * EFI-related code altogether.
 420  */
 421 #ifdef CONFIG_EFI
 422 # ifdef CONFIG_X86
 423    extern int efi_enabled;
 424 # else
 425 #  define efi_enabled 1
 426 # endif
 427 #else
 428 # define efi_enabled 0
 429 #endif
 430
 431 /*
 432  * Variable Attributes
 433  */
 434 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
 435 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
 436 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
 437
 438 /*
 439  * EFI Device Path information
 440  */
 441 #define EFI_DEV_HW                      0x01
 442 #define  EFI_DEV_PCI                             1
 443 #define  EFI_DEV_PCCARD                          2
 444 #define  EFI_DEV_MEM_MAPPED                      3
 445 #define  EFI_DEV_VENDOR                          4
 446 #define  EFI_DEV_CONTROLLER                      5
 447 #define EFI_DEV_ACPI                    0x02
 448 #define   EFI_DEV_BASIC_ACPI                     1
 449 #define   EFI_DEV_EXPANDED_ACPI                  2
 450 #define EFI_DEV_MSG                     0x03
 451 #define   EFI_DEV_MSG_ATAPI                      1
 452 #define   EFI_DEV_MSG_SCSI                       2
 453 #define   EFI_DEV_MSG_FC                         3
 454 #define   EFI_DEV_MSG_1394                       4
 455 #define   EFI_DEV_MSG_USB                        5
 456 #define   EFI_DEV_MSG_USB_CLASS                 15
 457 #define   EFI_DEV_MSG_I20                        6
 458 #define   EFI_DEV_MSG_MAC                       11
 459 #define   EFI_DEV_MSG_IPV4                      12
 460 #define   EFI_DEV_MSG_IPV6                      13
 461 #define   EFI_DEV_MSG_INFINIBAND                 9
 462 #define   EFI_DEV_MSG_UART                      14
 463 #define   EFI_DEV_MSG_VENDOR                    10
 464 #define EFI_DEV_MEDIA                   0x04
 465 #define   EFI_DEV_MEDIA_HARD_DRIVE               1
 466 #define   EFI_DEV_MEDIA_CDROM                    2
 467 #define   EFI_DEV_MEDIA_VENDOR                   3
 468 #define   EFI_DEV_MEDIA_FILE                     4
 469 #define   EFI_DEV_MEDIA_PROTOCOL                 5
 470 #define EFI_DEV_BIOS_BOOT               0x05
 471 #define EFI_DEV_END_PATH                0x7F
 472 #define EFI_DEV_END_PATH2               0xFF
 473 #define   EFI_DEV_END_INSTANCE                  0x01
 474 #define   EFI_DEV_END_ENTIRE                    0xFF
 475
 476 struct efi_generic_dev_path {
 477         u8 type;
 478         u8 sub_type;
 479         u16 length;
 480 } __attribute ((packed));
 481
 482 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
 483 {
 484         *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
 485         *addr &= PAGE_MASK;
 486 }
 487
 488 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
 489 /*
 490  * EFI Variable support.
 491  *
 492  * Different firmware drivers can expose their EFI-like variables using
 493  * the following.
 494  */
 495
 496 struct efivar_operations {
 497         efi_get_variable_t *get_variable;
 498         efi_get_next_variable_t *get_next_variable;
 499         efi_set_variable_t *set_variable;
 500 };
 501
 502 struct efivars {
 503         /*
 504          * ->lock protects two things:
 505          * 1) ->list - adds, removals, reads, writes
 506          * 2) ops.[gs]et_variable() calls.
 507          * It must not be held when creating sysfs entries or calling kmalloc.
 508          * ops.get_next_variable() is only called from register_efivars(),
 509          * which is protected by the BKL, so that path is safe.
 510          */
 511         spinlock_t lock;
 512         struct list_head list;
 513         struct kset *kset;
 514         struct bin_attribute *new_var, *del_var;
 515         const struct efivar_operations *ops;
 516         struct efivar_entry *walk_entry;
 517         struct pstore_info efi_pstore_info;
 518 };
 519
 520 int register_efivars(struct efivars *efivars,
 521                      const struct efivar_operations *ops,
 522                      struct kobject *parent_kobj);
 523 void unregister_efivars(struct efivars *efivars);
 524
 525 #endif /* CONFIG_EFI_VARS */
 526
 527 #endif /* _LINUX_EFI_H */