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
  22 #include <asm/page.h>
  23 #include <asm/system.h>
  24
  25 #define EFI_SUCCESS             0
  26 #define EFI_LOAD_ERROR          ( 1 | (1UL << (BITS_PER_LONG-1)))
  27 #define EFI_INVALID_PARAMETER   ( 2 | (1UL << (BITS_PER_LONG-1)))
  28 #define EFI_UNSUPPORTED         ( 3 | (1UL << (BITS_PER_LONG-1)))
  29 #define EFI_BAD_BUFFER_SIZE     ( 4 | (1UL << (BITS_PER_LONG-1)))
  30 #define EFI_BUFFER_TOO_SMALL    ( 5 | (1UL << (BITS_PER_LONG-1)))
  31 #define EFI_NOT_FOUND           (14 | (1UL << (BITS_PER_LONG-1)))
  32
  33 typedef unsigned long efi_status_t;
  34 typedef u8 efi_bool_t;
  35 typedef u16 efi_char16_t;               /* UNICODE character */
  36
  37
  38 typedef struct {
  39         u8 b[16];
  40 } efi_guid_t;
  41
  42 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
  43 ((efi_guid_t) \
  44 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
  45   (b) & 0xff, ((b) >> 8) & 0xff, \
  46   (c) & 0xff, ((c) >> 8) & 0xff, \
  47   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
  48
  49 /*
  50  * Generic EFI table header
  51  */
  52 typedef struct {
  53         u64 signature;
  54         u32 revision;
  55         u32 headersize;
  56         u32 crc32;
  57         u32 reserved;
  58 } efi_table_hdr_t;
  59
  60 /*
  61  * Memory map descriptor:
  62  */
  63
  64 /* Memory types: */
  65 #define EFI_RESERVED_TYPE                0
  66 #define EFI_LOADER_CODE                  1
  67 #define EFI_LOADER_DATA                  2
  68 #define EFI_BOOT_SERVICES_CODE           3
  69 #define EFI_BOOT_SERVICES_DATA           4
  70 #define EFI_RUNTIME_SERVICES_CODE        5
  71 #define EFI_RUNTIME_SERVICES_DATA        6
  72 #define EFI_CONVENTIONAL_MEMORY          7
  73 #define EFI_UNUSABLE_MEMORY              8
  74 #define EFI_ACPI_RECLAIM_MEMORY          9
  75 #define EFI_ACPI_MEMORY_NVS             10
  76 #define EFI_MEMORY_MAPPED_IO            11
  77 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
  78 #define EFI_PAL_CODE                    13
  79 #define EFI_MAX_MEMORY_TYPE             14
  80
  81 /* Attribute values: */
  82 #define EFI_MEMORY_UC           ((u64)0x0000000000000001ULL)    /* uncached */
  83 #define EFI_MEMORY_WC           ((u64)0x0000000000000002ULL)    /* write-coalescing */
  84 #define EFI_MEMORY_WT           ((u64)0x0000000000000004ULL)    /* write-through */
  85 #define EFI_MEMORY_WB           ((u64)0x0000000000000008ULL)    /* write-back */
  86 #define EFI_MEMORY_WP           ((u64)0x0000000000001000ULL)    /* write-protect */
  87 #define EFI_MEMORY_RP           ((u64)0x0000000000002000ULL)    /* read-protect */
  88 #define EFI_MEMORY_XP           ((u64)0x0000000000004000ULL)    /* execute-protect */
  89 #define EFI_MEMORY_RUNTIME      ((u64)0x8000000000000000ULL)    /* range requires runtime mapping */
  90 #define EFI_MEMORY_DESCRIPTOR_VERSION   1
  91
  92 #define EFI_PAGE_SHIFT          12
  93
  94 typedef struct {
  95         u32 type;
  96         u32 pad;
  97         u64 phys_addr;
  98         u64 virt_addr;
  99         u64 num_pages;
 100         u64 attribute;
 101 } efi_memory_desc_t;
 102
 103 typedef int (*efi_freemem_callback_t) (unsigned long start, unsigned long end, void *arg);
 104
 105 /*
 106  * Types and defines for Time Services
 107  */
 108 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
 109 #define EFI_TIME_IN_DAYLIGHT     0x2
 110 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 111
 112 typedef struct {
 113         u16 year;
 114         u8 month;
 115         u8 day;
 116         u8 hour;
 117         u8 minute;
 118         u8 second;
 119         u8 pad1;
 120         u32 nanosecond;
 121         s16 timezone;
 122         u8 daylight;
 123         u8 pad2;
 124 } efi_time_t;
 125
 126 typedef struct {
 127         u32 resolution;
 128         u32 accuracy;
 129         u8 sets_to_zero;
 130 } efi_time_cap_t;
 131
 132 /*
 133  * Types and defines for EFI ResetSystem
 134  */
 135 #define EFI_RESET_COLD 0
 136 #define EFI_RESET_WARM 1
 137 #define EFI_RESET_SHUTDOWN 2
 138
 139 /*
 140  * EFI Runtime Services table
 141  */
 142 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 143 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
 144
 145 typedef struct {
 146         efi_table_hdr_t hdr;
 147         unsigned long get_time;
 148         unsigned long set_time;
 149         unsigned long get_wakeup_time;
 150         unsigned long set_wakeup_time;
 151         unsigned long set_virtual_address_map;
 152         unsigned long convert_pointer;
 153         unsigned long get_variable;
 154         unsigned long get_next_variable;
 155         unsigned long set_variable;
 156         unsigned long get_next_high_mono_count;
 157         unsigned long reset_system;
 158 } efi_runtime_services_t;
 159
 160 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 161 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 162 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 163                                             efi_time_t *tm);
 164 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 165 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 166                                          unsigned long *data_size, void *data);
 167 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 168                                               efi_guid_t *vendor);
 169 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 170                                          unsigned long attr, unsigned long data_size,
 171                                          void *data);
 172 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 173 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 174                                  unsigned long data_size, efi_char16_t *data);
 175 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 176                                                 unsigned long descriptor_size,
 177                                                 u32 descriptor_version,
 178                                                 efi_memory_desc_t *virtual_map);
 179
 180 /*
 181  *  EFI Configuration Table and GUID definitions
 182  */
 183 #define NULL_GUID \
 184     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
 185
 186 #define MPS_TABLE_GUID    \
 187     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 188
 189 #define ACPI_TABLE_GUID    \
 190     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 191
 192 #define ACPI_20_TABLE_GUID    \
 193     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
 194
 195 #define SMBIOS_TABLE_GUID    \
 196     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 197
 198 #define SAL_SYSTEM_TABLE_GUID    \
 199     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
 200
 201 #define HCDP_TABLE_GUID \
 202     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
 203
 204 #define UGA_IO_PROTOCOL_GUID \
 205     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
 206
 207 #define EFI_GLOBAL_VARIABLE_GUID \
 208     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
 209
 210 typedef struct {
 211         efi_guid_t guid;
 212         unsigned long table;
 213 } efi_config_table_t;
 214
 215 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 216 #define EFI_SYSTEM_TABLE_REVISION  ((1 << 16) | 00)
 217
 218 typedef struct {
 219         efi_table_hdr_t hdr;
 220         unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
 221         u32 fw_revision;
 222         unsigned long con_in_handle;
 223         unsigned long con_in;
 224         unsigned long con_out_handle;
 225         unsigned long con_out;
 226         unsigned long stderr_handle;
 227         unsigned long stderr;
 228         efi_runtime_services_t *runtime;
 229         unsigned long boottime;
 230         unsigned long nr_tables;
 231         unsigned long tables;
 232 } efi_system_table_t;
 233
 234 struct efi_memory_map {
 235         void *phys_map;
 236         void *map;
 237         void *map_end;
 238         int nr_map;
 239         unsigned long desc_version;
 240         unsigned long desc_size;
 241 };
 242
 243 /*
 244  * All runtime access to EFI goes through this structure:
 245  */
 246 extern struct efi {
 247         efi_system_table_t *systab;     /* EFI system table */
 248         void *mps;                      /* MPS table */
 249         void *acpi;                     /* ACPI table  (IA64 ext 0.71) */
 250         void *acpi20;                   /* ACPI table  (ACPI 2.0) */
 251         void *smbios;                   /* SM BIOS table */
 252         void *sal_systab;               /* SAL system table */
 253         void *boot_info;                /* boot info table */
 254         void *hcdp;                     /* HCDP table */
 255         void *uga;                      /* UGA table */
 256         efi_get_time_t *get_time;
 257         efi_set_time_t *set_time;
 258         efi_get_wakeup_time_t *get_wakeup_time;
 259         efi_set_wakeup_time_t *set_wakeup_time;
 260         efi_get_variable_t *get_variable;
 261         efi_get_next_variable_t *get_next_variable;
 262         efi_set_variable_t *set_variable;
 263         efi_get_next_high_mono_count_t *get_next_high_mono_count;
 264         efi_reset_system_t *reset_system;
 265         efi_set_virtual_address_map_t *set_virtual_address_map;
 266 } efi;
 267
 268 static inline int
 269 efi_guidcmp (efi_guid_t left, efi_guid_t right)
 270 {
 271         return memcmp(&left, &right, sizeof (efi_guid_t));
 272 }
 273
 274 static inline char *
 275 efi_guid_unparse(efi_guid_t *guid, char *out)
 276 {
 277         sprintf(out, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
 278                 guid->b[3], guid->b[2], guid->b[1], guid->b[0],
 279                 guid->b[5], guid->b[4], guid->b[7], guid->b[6],
 280                 guid->b[8], guid->b[9], guid->b[10], guid->b[11],
 281                 guid->b[12], guid->b[13], guid->b[14], guid->b[15]);
 282         return out;
 283 }
 284
 285 extern void efi_init (void);
 286 extern void *efi_get_pal_addr (void);
 287 extern void efi_map_pal_code (void);
 288 extern void efi_map_memmap(void);
 289 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
 290 extern void efi_gettimeofday (struct timespec *ts);
 291 extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
 292 extern u64 efi_get_iobase (void);
 293 extern u32 efi_mem_type (unsigned long phys_addr);
 294 extern u64 efi_mem_attributes (unsigned long phys_addr);
 295 extern int __init efi_uart_console_only (void);
 296 extern void efi_initialize_iomem_resources(struct resource *code_resource,
 297                                         struct resource *data_resource);
 298 extern unsigned long __init efi_get_time(void);
 299 extern int __init efi_set_rtc_mmss(unsigned long nowtime);
 300 extern struct efi_memory_map memmap;
 301
 302 /**
 303  * efi_range_is_wc - check the WC bit on an address range
 304  * @start: starting kvirt address
 305  * @len: length of range
 306  *
 307  * Consult the EFI memory map and make sure it's ok to set this range WC.
 308  * Returns true or false.
 309  */
 310 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 311 {
 312         unsigned long i;
 313
 314         for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 315                 unsigned long paddr = __pa(start + i);
 316                 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 317                         return 0;
 318         }
 319         /* The range checked out */
 320         return 1;
 321 }
 322
 323 #ifdef CONFIG_EFI_PCDP
 324 extern int __init efi_setup_pcdp_console(char *);
 325 #endif
 326
 327 /*
 328  * We play games with efi_enabled so that the compiler will, if possible, remove
 329  * EFI-related code altogether.
 330  */
 331 #ifdef CONFIG_EFI
 332 # ifdef CONFIG_X86
 333    extern int efi_enabled;
 334 # else
 335 #  define efi_enabled 1
 336 # endif
 337 #else
 338 # define efi_enabled 0
 339 #endif
 340
 341 /*
 342  * Variable Attributes
 343  */
 344 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
 345 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
 346 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
 347
 348 /*
 349  * EFI Device Path information
 350  */
 351 #define EFI_DEV_HW                      0x01
 352 #define  EFI_DEV_PCI                             1
 353 #define  EFI_DEV_PCCARD                          2
 354 #define  EFI_DEV_MEM_MAPPED                      3
 355 #define  EFI_DEV_VENDOR                          4
 356 #define  EFI_DEV_CONTROLLER                      5
 357 #define EFI_DEV_ACPI                    0x02
 358 #define   EFI_DEV_BASIC_ACPI                     1
 359 #define   EFI_DEV_EXPANDED_ACPI                  2
 360 #define EFI_DEV_MSG                     0x03
 361 #define   EFI_DEV_MSG_ATAPI                      1
 362 #define   EFI_DEV_MSG_SCSI                       2
 363 #define   EFI_DEV_MSG_FC                         3
 364 #define   EFI_DEV_MSG_1394                       4
 365 #define   EFI_DEV_MSG_USB                        5
 366 #define   EFI_DEV_MSG_USB_CLASS                 15
 367 #define   EFI_DEV_MSG_I20                        6
 368 #define   EFI_DEV_MSG_MAC                       11
 369 #define   EFI_DEV_MSG_IPV4                      12
 370 #define   EFI_DEV_MSG_IPV6                      13
 371 #define   EFI_DEV_MSG_INFINIBAND                 9
 372 #define   EFI_DEV_MSG_UART                      14
 373 #define   EFI_DEV_MSG_VENDOR                    10
 374 #define EFI_DEV_MEDIA                   0x04
 375 #define   EFI_DEV_MEDIA_HARD_DRIVE               1
 376 #define   EFI_DEV_MEDIA_CDROM                    2
 377 #define   EFI_DEV_MEDIA_VENDOR                   3
 378 #define   EFI_DEV_MEDIA_FILE                     4
 379 #define   EFI_DEV_MEDIA_PROTOCOL                 5
 380 #define EFI_DEV_BIOS_BOOT               0x05
 381 #define EFI_DEV_END_PATH                0x7F
 382 #define EFI_DEV_END_PATH2               0xFF
 383 #define   EFI_DEV_END_INSTANCE                  0x01
 384 #define   EFI_DEV_END_ENTIRE                    0xFF
 385
 386 struct efi_generic_dev_path {
 387         u8 type;
 388         u8 sub_type;
 389         u16 length;
 390 } __attribute ((packed));
 391
 392 #endif /* _LINUX_EFI_H */