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 int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
 106
 107 /*
 108  * Types and defines for Time Services
 109  */
 110 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
 111 #define EFI_TIME_IN_DAYLIGHT     0x2
 112 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 113
 114 typedef struct {
 115         u16 year;
 116         u8 month;
 117         u8 day;
 118         u8 hour;
 119         u8 minute;
 120         u8 second;
 121         u8 pad1;
 122         u32 nanosecond;
 123         s16 timezone;
 124         u8 daylight;
 125         u8 pad2;
 126 } efi_time_t;
 127
 128 typedef struct {
 129         u32 resolution;
 130         u32 accuracy;
 131         u8 sets_to_zero;
 132 } efi_time_cap_t;
 133
 134 /*
 135  * Types and defines for EFI ResetSystem
 136  */
 137 #define EFI_RESET_COLD 0
 138 #define EFI_RESET_WARM 1
 139 #define EFI_RESET_SHUTDOWN 2
 140
 141 /*
 142  * EFI Runtime Services table
 143  */
 144 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 145 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
 146
 147 typedef struct {
 148         efi_table_hdr_t hdr;
 149         unsigned long get_time;
 150         unsigned long set_time;
 151         unsigned long get_wakeup_time;
 152         unsigned long set_wakeup_time;
 153         unsigned long set_virtual_address_map;
 154         unsigned long convert_pointer;
 155         unsigned long get_variable;
 156         unsigned long get_next_variable;
 157         unsigned long set_variable;
 158         unsigned long get_next_high_mono_count;
 159         unsigned long reset_system;
 160 } efi_runtime_services_t;
 161
 162 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 163 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 164 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 165                                             efi_time_t *tm);
 166 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 167 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 168                                          unsigned long *data_size, void *data);
 169 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 170                                               efi_guid_t *vendor);
 171 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 172                                          unsigned long attr, unsigned long data_size,
 173                                          void *data);
 174 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 175 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 176                                  unsigned long data_size, efi_char16_t *data);
 177 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 178                                                 unsigned long descriptor_size,
 179                                                 u32 descriptor_version,
 180                                                 efi_memory_desc_t *virtual_map);
 181
 182 /*
 183  *  EFI Configuration Table and GUID definitions
 184  */
 185 #define NULL_GUID \
 186     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
 187
 188 #define MPS_TABLE_GUID    \
 189     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 190
 191 #define ACPI_TABLE_GUID    \
 192     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 193
 194 #define ACPI_20_TABLE_GUID    \
 195     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
 196
 197 #define SMBIOS_TABLE_GUID    \
 198     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 199
 200 #define SAL_SYSTEM_TABLE_GUID    \
 201     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 202
 203 #define HCDP_TABLE_GUID \
 204     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
 205
 206 #define UGA_IO_PROTOCOL_GUID \
 207     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
 208
 209 #define EFI_GLOBAL_VARIABLE_GUID \
 210     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
 211
 212 #define UV_SYSTEM_TABLE_GUID \
 213     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
 214
 215 #define LINUX_EFI_CRASH_GUID \
 216     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
 217
 218 typedef struct {
 219         efi_guid_t guid;
 220         unsigned long table;
 221 } efi_config_table_t;
 222
 223 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 224
 225 typedef struct {
 226         efi_table_hdr_t hdr;
 227         unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
 228         u32 fw_revision;
 229         unsigned long con_in_handle;
 230         unsigned long con_in;
 231         unsigned long con_out_handle;
 232         unsigned long con_out;
 233         unsigned long stderr_handle;
 234         unsigned long stderr;
 235         efi_runtime_services_t *runtime;
 236         unsigned long boottime;
 237         unsigned long nr_tables;
 238         unsigned long tables;
 239 } efi_system_table_t;
 240
 241 struct efi_memory_map {
 242         void *phys_map;
 243         void *map;
 244         void *map_end;
 245         int nr_map;
 246         unsigned long desc_version;
 247         unsigned long desc_size;
 248 };
 249
 250 #define EFI_INVALID_TABLE_ADDR          (~0UL)
 251
 252 /*
 253  * All runtime access to EFI goes through this structure:
 254  */
 255 extern struct efi {
 256         efi_system_table_t *systab;     /* EFI system table */
 257         unsigned long mps;              /* MPS table */
 258         unsigned long acpi;             /* ACPI table  (IA64 ext 0.71) */
 259         unsigned long acpi20;           /* ACPI table  (ACPI 2.0) */
 260         unsigned long smbios;           /* SM BIOS table */
 261         unsigned long sal_systab;       /* SAL system table */
 262         unsigned long boot_info;        /* boot info table */
 263         unsigned long hcdp;             /* HCDP table */
 264         unsigned long uga;              /* UGA table */
 265         unsigned long uv_systab;        /* UV system table */
 266         efi_get_time_t *get_time;
 267         efi_set_time_t *set_time;
 268         efi_get_wakeup_time_t *get_wakeup_time;
 269         efi_set_wakeup_time_t *set_wakeup_time;
 270         efi_get_variable_t *get_variable;
 271         efi_get_next_variable_t *get_next_variable;
 272         efi_set_variable_t *set_variable;
 273         efi_get_next_high_mono_count_t *get_next_high_mono_count;
 274         efi_reset_system_t *reset_system;
 275         efi_set_virtual_address_map_t *set_virtual_address_map;
 276 } efi;
 277
 278 static inline int
 279 efi_guidcmp (efi_guid_t left, efi_guid_t right)
 280 {
 281         return memcmp(&left, &right, sizeof (efi_guid_t));
 282 }
 283
 284 static inline char *
 285 efi_guid_unparse(efi_guid_t *guid, char *out)
 286 {
 287         sprintf(out, "%pUl", guid->b);
 288         return out;
 289 }
 290
 291 extern void efi_init (void);
 292 extern void *efi_get_pal_addr (void);
 293 extern void efi_map_pal_code (void);
 294 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
 295 extern void efi_gettimeofday (struct timespec *ts);
 296 extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
 297 extern u64 efi_get_iobase (void);
 298 extern u32 efi_mem_type (unsigned long phys_addr);
 299 extern u64 efi_mem_attributes (unsigned long phys_addr);
 300 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 301 extern int __init efi_uart_console_only (void);
 302 extern void efi_initialize_iomem_resources(struct resource *code_resource,
 303                 struct resource *data_resource, struct resource *bss_resource);
 304 extern unsigned long efi_get_time(void);
 305 extern int efi_set_rtc_mmss(unsigned long nowtime);
 306 extern void efi_reserve_boot_services(void);
 307 extern struct efi_memory_map memmap;
 308
 309 /**
 310  * efi_range_is_wc - check the WC bit on an address range
 311  * @start: starting kvirt address
 312  * @len: length of range
 313  *
 314  * Consult the EFI memory map and make sure it's ok to set this range WC.
 315  * Returns true or false.
 316  */
 317 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 318 {
 319         unsigned long i;
 320
 321         for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 322                 unsigned long paddr = __pa(start + i);
 323                 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 324                         return 0;
 325         }
 326         /* The range checked out */
 327         return 1;
 328 }
 329
 330 #ifdef CONFIG_EFI_PCDP
 331 extern int __init efi_setup_pcdp_console(char *);
 332 #endif
 333
 334 /*
 335  * We play games with efi_enabled so that the compiler will, if possible, remove
 336  * EFI-related code altogether.
 337  */
 338 #ifdef CONFIG_EFI
 339 # ifdef CONFIG_X86
 340    extern int efi_enabled;
 341 # else
 342 #  define efi_enabled 1
 343 # endif
 344 #else
 345 # define efi_enabled 0
 346 #endif
 347
 348 /*
 349  * Variable Attributes
 350  */
 351 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
 352 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
 353 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
 354
 355 /*
 356  * EFI Device Path information
 357  */
 358 #define EFI_DEV_HW                      0x01
 359 #define  EFI_DEV_PCI                             1
 360 #define  EFI_DEV_PCCARD                          2
 361 #define  EFI_DEV_MEM_MAPPED                      3
 362 #define  EFI_DEV_VENDOR                          4
 363 #define  EFI_DEV_CONTROLLER                      5
 364 #define EFI_DEV_ACPI                    0x02
 365 #define   EFI_DEV_BASIC_ACPI                     1
 366 #define   EFI_DEV_EXPANDED_ACPI                  2
 367 #define EFI_DEV_MSG                     0x03
 368 #define   EFI_DEV_MSG_ATAPI                      1
 369 #define   EFI_DEV_MSG_SCSI                       2
 370 #define   EFI_DEV_MSG_FC                         3
 371 #define   EFI_DEV_MSG_1394                       4
 372 #define   EFI_DEV_MSG_USB                        5
 373 #define   EFI_DEV_MSG_USB_CLASS                 15
 374 #define   EFI_DEV_MSG_I20                        6
 375 #define   EFI_DEV_MSG_MAC                       11
 376 #define   EFI_DEV_MSG_IPV4                      12
 377 #define   EFI_DEV_MSG_IPV6                      13
 378 #define   EFI_DEV_MSG_INFINIBAND                 9
 379 #define   EFI_DEV_MSG_UART                      14
 380 #define   EFI_DEV_MSG_VENDOR                    10
 381 #define EFI_DEV_MEDIA                   0x04
 382 #define   EFI_DEV_MEDIA_HARD_DRIVE               1
 383 #define   EFI_DEV_MEDIA_CDROM                    2
 384 #define   EFI_DEV_MEDIA_VENDOR                   3
 385 #define   EFI_DEV_MEDIA_FILE                     4
 386 #define   EFI_DEV_MEDIA_PROTOCOL                 5
 387 #define EFI_DEV_BIOS_BOOT               0x05
 388 #define EFI_DEV_END_PATH                0x7F
 389 #define EFI_DEV_END_PATH2               0xFF
 390 #define   EFI_DEV_END_INSTANCE                  0x01
 391 #define   EFI_DEV_END_ENTIRE                    0xFF
 392
 393 struct efi_generic_dev_path {
 394         u8 type;
 395         u8 sub_type;
 396         u16 length;
 397 } __attribute ((packed));
 398
 399 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
 400 {
 401         *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
 402         *addr &= PAGE_MASK;
 403 }
 404
 405 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
 406 /*
 407  * EFI Variable support.
 408  *
 409  * Different firmware drivers can expose their EFI-like variables using
 410  * the following.
 411  */
 412
 413 struct efivar_operations {
 414         efi_get_variable_t *get_variable;
 415         efi_get_next_variable_t *get_next_variable;
 416         efi_set_variable_t *set_variable;
 417 };
 418
 419 struct efivars {
 420         /*
 421          * ->lock protects two things:
 422          * 1) ->list - adds, removals, reads, writes
 423          * 2) ops.[gs]et_variable() calls.
 424          * It must not be held when creating sysfs entries or calling kmalloc.
 425          * ops.get_next_variable() is only called from register_efivars(),
 426          * which is protected by the BKL, so that path is safe.
 427          */
 428         spinlock_t lock;
 429         struct list_head list;
 430         struct kset *kset;
 431         struct bin_attribute *new_var, *del_var;
 432         const struct efivar_operations *ops;
 433         struct efivar_entry *walk_entry;
 434         struct pstore_info efi_pstore_info;
 435 };
 436
 437 int register_efivars(struct efivars *efivars,
 438                      const struct efivar_operations *ops,
 439                      struct kobject *parent_kobj);
 440 void unregister_efivars(struct efivars *efivars);
 441
 442 #endif /* CONFIG_EFI_VARS */
 443
 444 #endif /* _LINUX_EFI_H */