include/efi.h

   1 /*
   2  * Extensible Firmware Interface
   3  * Based on 'Extensible Firmware Interface Specification' version 0.9,
   4  * April 30, 1999
   5  *
   6  * Copyright (C) 1999 VA Linux Systems
   7  * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
   8  * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
   9  *      David Mosberger-Tang <davidm@hpl.hp.com>
  10  *      Stephane Eranian <eranian@hpl.hp.com>
  11  *
  12  * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
  13  */
  14
  15 #ifndef _EFI_H
  16 #define _EFI_H
  17
  18 #include <linux/linkage.h>
  19 #include <linux/string.h>
  20 #include <linux/types.h>
  21
  22 /*
  23  * EFI on x86_64 uses the Microsoft ABI which is not the default for GCC.
  24  *
  25  * There are two scenarios for EFI on x86_64: building a 64-bit EFI stub
  26  * codes (CONFIG_EFI_STUB_64BIT) and building a 64-bit U-Boot (CONFIG_X86_64).
  27  * Either needs to be properly built with the '-m64' compiler flag, and hence
  28  * it is enough to only check the compiler provided define __x86_64__ here.
  29  */
  30 #ifdef __x86_64__
  31 #define EFIAPI __attribute__((ms_abi))
  32 #define efi_va_list __builtin_ms_va_list
  33 #define efi_va_start __builtin_ms_va_start
  34 #define efi_va_arg __builtin_va_arg
  35 #define efi_va_end __builtin_ms_va_end
  36 #else
  37 #define EFIAPI asmlinkage
  38 #define efi_va_list va_list
  39 #define efi_va_start va_start
  40 #define efi_va_arg va_arg
  41 #define efi_va_end va_end
  42 #endif /* __x86_64__ */
  43
  44 struct efi_device_path;
  45
  46 typedef struct {
  47         u8 b[16];
  48 } efi_guid_t;
  49
  50 #define EFI_BITS_PER_LONG       (sizeof(long) * 8)
  51
  52 /* Bit mask for EFI status code with error */
  53 #define EFI_ERROR_MASK (1UL << (EFI_BITS_PER_LONG - 1))
  54 /* Status codes returned by EFI protocols */
  55 #define EFI_SUCCESS                     0
  56 #define EFI_LOAD_ERROR                  (EFI_ERROR_MASK | 1)
  57 #define EFI_INVALID_PARAMETER           (EFI_ERROR_MASK | 2)
  58 #define EFI_UNSUPPORTED                 (EFI_ERROR_MASK | 3)
  59 #define EFI_BAD_BUFFER_SIZE             (EFI_ERROR_MASK | 4)
  60 #define EFI_BUFFER_TOO_SMALL            (EFI_ERROR_MASK | 5)
  61 #define EFI_NOT_READY                   (EFI_ERROR_MASK | 6)
  62 #define EFI_DEVICE_ERROR                (EFI_ERROR_MASK | 7)
  63 #define EFI_WRITE_PROTECTED             (EFI_ERROR_MASK | 8)
  64 #define EFI_OUT_OF_RESOURCES            (EFI_ERROR_MASK | 9)
  65 #define EFI_VOLUME_CORRUPTED            (EFI_ERROR_MASK | 10)
  66 #define EFI_VOLUME_FULL                 (EFI_ERROR_MASK | 11)
  67 #define EFI_NO_MEDIA                    (EFI_ERROR_MASK | 12)
  68 #define EFI_MEDIA_CHANGED               (EFI_ERROR_MASK | 13)
  69 #define EFI_NOT_FOUND                   (EFI_ERROR_MASK | 14)
  70 #define EFI_ACCESS_DENIED               (EFI_ERROR_MASK | 15)
  71 #define EFI_NO_RESPONSE                 (EFI_ERROR_MASK | 16)
  72 #define EFI_NO_MAPPING                  (EFI_ERROR_MASK | 17)
  73 #define EFI_TIMEOUT                     (EFI_ERROR_MASK | 18)
  74 #define EFI_NOT_STARTED                 (EFI_ERROR_MASK | 19)
  75 #define EFI_ALREADY_STARTED             (EFI_ERROR_MASK | 20)
  76 #define EFI_ABORTED                     (EFI_ERROR_MASK | 21)
  77 #define EFI_ICMP_ERROR                  (EFI_ERROR_MASK | 22)
  78 #define EFI_TFTP_ERROR                  (EFI_ERROR_MASK | 23)
  79 #define EFI_PROTOCOL_ERROR              (EFI_ERROR_MASK | 24)
  80 #define EFI_INCOMPATIBLE_VERSION        (EFI_ERROR_MASK | 25)
  81 #define EFI_SECURITY_VIOLATION          (EFI_ERROR_MASK | 26)
  82 #define EFI_CRC_ERROR                   (EFI_ERROR_MASK | 27)
  83 #define EFI_END_OF_MEDIA                (EFI_ERROR_MASK | 28)
  84 #define EFI_END_OF_FILE                 (EFI_ERROR_MASK | 31)
  85 #define EFI_INVALID_LANGUAGE            (EFI_ERROR_MASK | 32)
  86 #define EFI_COMPROMISED_DATA            (EFI_ERROR_MASK | 33)
  87 #define EFI_IP_ADDRESS_CONFLICT         (EFI_ERROR_MASK | 34)
  88 #define EFI_HTTP_ERROR                  (EFI_ERROR_MASK | 35)
  89
  90 #define EFI_WARN_DELETE_FAILURE 2
  91
  92 typedef unsigned long efi_status_t;
  93 typedef u64 efi_physical_addr_t;
  94 typedef u64 efi_virtual_addr_t;
  95 typedef void *efi_handle_t;
  96
  97 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
  98         {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
  99                 ((a) >> 24) & 0xff, \
 100                 (b) & 0xff, ((b) >> 8) & 0xff, \
 101                 (c) & 0xff, ((c) >> 8) & 0xff, \
 102                 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } }
 103
 104 /* Generic EFI table header */
 105 struct efi_table_hdr {
 106         u64 signature;
 107         u32 revision;
 108         u32 headersize;
 109         u32 crc32;
 110         u32 reserved;
 111 };
 112
 113 /* Enumeration of memory types introduced in UEFI */
 114 enum efi_mem_type {
 115         EFI_RESERVED_MEMORY_TYPE,
 116         /*
 117          * The code portions of a loaded application.
 118          * (Note that UEFI OS loaders are UEFI applications.)
 119          */
 120         EFI_LOADER_CODE,
 121         /*
 122          * The data portions of a loaded application and
 123          * the default data allocation type used by an application
 124          * to allocate pool memory.
 125          */
 126         EFI_LOADER_DATA,
 127         /* The code portions of a loaded Boot Services Driver */
 128         EFI_BOOT_SERVICES_CODE,
 129         /*
 130          * The data portions of a loaded Boot Services Driver and
 131          * the default data allocation type used by a Boot Services
 132          * Driver to allocate pool memory.
 133          */
 134         EFI_BOOT_SERVICES_DATA,
 135         /* The code portions of a loaded Runtime Services Driver */
 136         EFI_RUNTIME_SERVICES_CODE,
 137         /*
 138          * The data portions of a loaded Runtime Services Driver and
 139          * the default data allocation type used by a Runtime Services
 140          * Driver to allocate pool memory.
 141          */
 142         EFI_RUNTIME_SERVICES_DATA,
 143         /* Free (unallocated) memory */
 144         EFI_CONVENTIONAL_MEMORY,
 145         /* Memory in which errors have been detected */
 146         EFI_UNUSABLE_MEMORY,
 147         /* Memory that holds the ACPI tables */
 148         EFI_ACPI_RECLAIM_MEMORY,
 149         /* Address space reserved for use by the firmware */
 150         EFI_ACPI_MEMORY_NVS,
 151         /*
 152          * Used by system firmware to request that a memory-mapped IO region
 153          * be mapped by the OS to a virtual address so it can be accessed by
 154          * EFI runtime services.
 155          */
 156         EFI_MMAP_IO,
 157         /*
 158          * System memory-mapped IO region that is used to translate
 159          * memory cycles to IO cycles by the processor.
 160          */
 161         EFI_MMAP_IO_PORT,
 162         /*
 163          * Address space reserved by the firmware for code that is
 164          * part of the processor.
 165          */
 166         EFI_PAL_CODE,
 167
 168         EFI_MAX_MEMORY_TYPE,
 169         EFI_TABLE_END,  /* For efi_build_mem_table() */
 170 };
 171
 172 /* Attribute values */
 173 #define EFI_MEMORY_UC           ((u64)0x0000000000000001ULL)    /* uncached */
 174 #define EFI_MEMORY_WC           ((u64)0x0000000000000002ULL)    /* write-coalescing */
 175 #define EFI_MEMORY_WT           ((u64)0x0000000000000004ULL)    /* write-through */
 176 #define EFI_MEMORY_WB           ((u64)0x0000000000000008ULL)    /* write-back */
 177 #define EFI_MEMORY_UCE          ((u64)0x0000000000000010ULL)    /* uncached, exported */
 178 #define EFI_MEMORY_WP           ((u64)0x0000000000001000ULL)    /* write-protect */
 179 #define EFI_MEMORY_RP           ((u64)0x0000000000002000ULL)    /* read-protect */
 180 #define EFI_MEMORY_XP           ((u64)0x0000000000004000ULL)    /* execute-protect */
 181 #define EFI_MEMORY_RUNTIME      ((u64)0x8000000000000000ULL)    /* range requires runtime mapping */
 182 #define EFI_MEM_DESC_VERSION    1
 183
 184 #define EFI_PAGE_SHIFT          12
 185 #define EFI_PAGE_SIZE           (1UL << EFI_PAGE_SHIFT)
 186 #define EFI_PAGE_MASK           (EFI_PAGE_SIZE - 1)
 187
 188 struct efi_mem_desc {
 189         u32 type;
 190         u32 reserved;
 191         efi_physical_addr_t physical_start;
 192         efi_virtual_addr_t virtual_start;
 193         u64 num_pages;
 194         u64 attribute;
 195 };
 196
 197 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
 198
 199 /* Allocation types for calls to boottime->allocate_pages*/
 200 #define EFI_ALLOCATE_ANY_PAGES          0
 201 #define EFI_ALLOCATE_MAX_ADDRESS        1
 202 #define EFI_ALLOCATE_ADDRESS            2
 203 #define EFI_MAX_ALLOCATE_TYPE           3
 204
 205 /* Types and defines for Time Services */
 206 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
 207 #define EFI_TIME_IN_DAYLIGHT     0x2
 208 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 209
 210 struct efi_time {
 211         u16 year;
 212         u8 month;
 213         u8 day;
 214         u8 hour;
 215         u8 minute;
 216         u8 second;
 217         u8 pad1;
 218         u32 nanosecond;
 219         s16 timezone;
 220         u8 daylight;
 221         u8 pad2;
 222 };
 223
 224 struct efi_time_cap {
 225         u32 resolution;
 226         u32 accuracy;
 227         u8 sets_to_zero;
 228 };
 229
 230 enum efi_locate_search_type {
 231         ALL_HANDLES,
 232         BY_REGISTER_NOTIFY,
 233         BY_PROTOCOL
 234 };
 235
 236 struct efi_open_protocol_info_entry {
 237         efi_handle_t agent_handle;
 238         efi_handle_t controller_handle;
 239         u32 attributes;
 240         u32 open_count;
 241 };
 242
 243 enum efi_entry_t {
 244         EFIET_END,      /* Signals this is the last (empty) entry */
 245         EFIET_MEMORY_MAP,
 246         EFIET_GOP_MODE,
 247
 248         /* Number of entries */
 249         EFIET_MEMORY_COUNT,
 250 };
 251
 252 #define EFI_TABLE_VERSION       1
 253
 254 /**
 255  * struct efi_info_hdr - Header for the EFI info table
 256  *
 257  * @version:    EFI_TABLE_VERSION
 258  * @hdr_size:   Size of this struct in bytes
 259  * @total_size: Total size of this header plus following data
 260  * @spare:      Spare space for expansion
 261  */
 262 struct efi_info_hdr {
 263         u32 version;
 264         u32 hdr_size;
 265         u32 total_size;
 266         u32 spare[5];
 267 };
 268
 269 /**
 270  * struct efi_entry_hdr - Header for a table entry
 271  *
 272  * @type:       enum eft_entry_t
 273  * @size        size of entry bytes excluding header and padding
 274  * @addr:       address of this entry (0 if it follows the header )
 275  * @link:       size of entry including header and padding
 276  * @spare1:     Spare space for expansion
 277  * @spare2:     Spare space for expansion
 278  */
 279 struct efi_entry_hdr {
 280         u32 type;
 281         u32 size;
 282         u64 addr;
 283         u32 link;
 284         u32 spare1;
 285         u64 spare2;
 286 };
 287
 288 /**
 289  * struct efi_entry_memmap - a memory map table passed to U-Boot
 290  *
 291  * @version:    EFI's memory map table version
 292  * @desc_size:  EFI's size of each memory descriptor
 293  * @spare:      Spare space for expansion
 294  * @desc:       An array of descriptors, each @desc_size bytes apart
 295  */
 296 struct efi_entry_memmap {
 297         u32 version;
 298         u32 desc_size;
 299         u64 spare;
 300         struct efi_mem_desc desc[];
 301 };
 302
 303 /**
 304  * struct efi_entry_gopmode - a GOP mode table passed to U-Boot
 305  *
 306  * @fb_base:    EFI's framebuffer base address
 307  * @fb_size:    EFI's framebuffer size
 308  * @info_size:  GOP mode info structure size
 309  * @info:       Start address of the GOP mode info structure
 310  */
 311 struct efi_entry_gopmode {
 312         efi_physical_addr_t fb_base;
 313         /*
 314          * Not like the ones in 'struct efi_gop_mode' which are 'unsigned
 315          * long', @fb_size and @info_size have to be 'u64' here. As the EFI
 316          * stub codes may have different bit size from the U-Boot payload,
 317          * using 'long' will cause mismatch between the producer (stub) and
 318          * the consumer (payload).
 319          */
 320         u64 fb_size;
 321         u64 info_size;
 322         /*
 323          * We cannot directly use 'struct efi_gop_mode_info info[]' here as
 324          * it causes compiler to complain: array type has incomplete element
 325          * type 'struct efi_gop_mode_info'.
 326          */
 327         struct /* efi_gop_mode_info */ {
 328                 u32 version;
 329                 u32 width;
 330                 u32 height;
 331                 u32 pixel_format;
 332                 u32 pixel_bitmask[4];
 333                 u32 pixels_per_scanline;
 334         } info[];
 335 };
 336
 337 static inline struct efi_mem_desc *efi_get_next_mem_desc(
 338                 struct efi_entry_memmap *map, struct efi_mem_desc *desc)
 339 {
 340         return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
 341 }
 342
 343 struct efi_priv {
 344         efi_handle_t parent_image;
 345         struct efi_device_path *device_path;
 346         struct efi_system_table *sys_table;
 347         struct efi_boot_services *boot;
 348         struct efi_runtime_services *run;
 349         bool use_pool_for_malloc;
 350         unsigned long ram_base;
 351         unsigned int image_data_type;
 352         struct efi_info_hdr *info;
 353         unsigned int info_size;
 354         void *next_hdr;
 355 };
 356
 357 /* Base address of the EFI image */
 358 extern char image_base[];
 359
 360 /* Start and end of U-Boot image (for payload) */
 361 extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
 362
 363 /*
 364  * Variable Attributes
 365  */
 366 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
 367 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
 368 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
 369 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
 370 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
 371 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
 372 #define EFI_VARIABLE_APPEND_WRITE       0x0000000000000040
 373
 374 #define EFI_VARIABLE_MASK       (EFI_VARIABLE_NON_VOLATILE | \
 375                                 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
 376                                 EFI_VARIABLE_RUNTIME_ACCESS | \
 377                                 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
 378                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
 379                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
 380                                 EFI_VARIABLE_APPEND_WRITE)
 381
 382 /**
 383  * efi_get_sys_table() - Get access to the main EFI system table
 384  *
 385  * @return pointer to EFI system table
 386  */
 387
 388 struct efi_system_table *efi_get_sys_table(void);
 389
 390 /**
 391  * efi_get_ram_base() - Find the base of RAM
 392  *
 393  * This is used when U-Boot is built as an EFI application.
 394  *
 395  * @return the base of RAM as known to U-Boot
 396  */
 397 unsigned long efi_get_ram_base(void);
 398
 399 /**
 400  * efi_init() - Set up ready for use of EFI boot services
 401  *
 402  * @priv:       Pointer to our private EFI structure to fill in
 403  * @banner:     Banner to display when starting
 404  * @image:      The image handle passed to efi_main()
 405  * @sys_table:  The EFI system table pointer passed to efi_main()
 406  */
 407 int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image,
 408              struct efi_system_table *sys_table);
 409
 410 /**
 411  * efi_malloc() - Allocate some memory from EFI
 412  *
 413  * @priv:       Pointer to private EFI structure
 414  * @size:       Number of bytes to allocate
 415  * @retp:       Return EFI status result
 416  * @return pointer to memory allocated, or NULL on error
 417  */
 418 void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp);
 419
 420 /**
 421  * efi_free() - Free memory allocated from EFI
 422  *
 423  * @priv:       Pointer to private EFI structure
 424  * @ptr:        Pointer to memory to free
 425  */
 426 void efi_free(struct efi_priv *priv, void *ptr);
 427
 428 /**
 429  * efi_puts() - Write out a string to the EFI console
 430  *
 431  * @priv:       Pointer to private EFI structure
 432  * @str:        String to write (note this is a ASCII, not unicode)
 433  */
 434 void efi_puts(struct efi_priv *priv, const char *str);
 435
 436 /**
 437  * efi_putc() - Write out a character to the EFI console
 438  *
 439  * @priv:       Pointer to private EFI structure
 440  * @ch:         Character to write (note this is not unicode)
 441  */
 442 void efi_putc(struct efi_priv *priv, const char ch);
 443
 444 /**
 445  * efi_info_get() - get an entry from an EFI table
 446  *
 447  * @type:       Entry type to search for
 448  * @datap:      Returns pointer to entry data
 449  * @sizep:      Returns pointer to entry size
 450  * @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
 451  * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
 452  */
 453 int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);
 454
 455 /**
 456  * efi_build_mem_table() - make a sorted copy of the memory table
 457  *
 458  * @map:        Pointer to EFI memory map table
 459  * @size:       Size of table in bytes
 460  * @skip_bs:    True to skip boot-time memory and merge it with conventional
 461  *              memory. This will significantly reduce the number of table
 462  *              entries.
 463  * @return pointer to the new table. It should be freed with free() by the
 464  *         caller
 465  */
 466 void *efi_build_mem_table(struct efi_entry_memmap *map, int size, bool skip_bs);
 467
 468 #endif /* _LINUX_EFI_H */