include/efi.h

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