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 /* Type INTN in UEFI specification */
  24 #define efi_intn_t ssize_t
  25 /* Type UINTN in UEFI specification*/
  26 #define efi_uintn_t size_t
  27
  28 /*
  29  * EFI on x86_64 uses the Microsoft ABI which is not the default for GCC.
  30  *
  31  * There are two scenarios for EFI on x86_64: building a 64-bit EFI stub
  32  * codes (CONFIG_EFI_STUB_64BIT) and building a 64-bit U-Boot (CONFIG_X86_64).
  33  * Either needs to be properly built with the '-m64' compiler flag, and hence
  34  * it is enough to only check the compiler provided define __x86_64__ here.
  35  */
  36 #ifdef __x86_64__
  37 #define EFIAPI __attribute__((ms_abi))
  38 #define efi_va_list __builtin_ms_va_list
  39 #define efi_va_start __builtin_ms_va_start
  40 #define efi_va_copy __builtin_ms_va_copy
  41 #define efi_va_arg __builtin_va_arg
  42 #define efi_va_end __builtin_ms_va_end
  43 #else
  44 #define EFIAPI asmlinkage
  45 #define efi_va_list va_list
  46 #define efi_va_start va_start
  47 #define efi_va_copy va_copy
  48 #define efi_va_arg va_arg
  49 #define efi_va_end va_end
  50 #endif /* __x86_64__ */
  51
  52 #define EFI32_LOADER_SIGNATURE  "EL32"
  53 #define EFI64_LOADER_SIGNATURE  "EL64"
  54
  55 /**
  56  * struct efi_device_path - device path protocol
  57  *
  58  * @type:       device path type
  59  * @sub_type:   device path sub-type
  60  * @length:     length of the device path node including the header
  61  */
  62 struct efi_device_path {
  63         u8 type;
  64         u8 sub_type;
  65         u16 length;
  66 } __packed;
  67
  68 /*
  69  * The EFI spec defines the EFI_GUID as
  70  * "128-bit buffer containing a unique identifier value. Unless otherwise specified,
  71  * aligned on a 64-bit boundary".
  72  * Page 163 of the UEFI specification v2.10 and
  73  * EDK2 reference implementation both define EFI_GUID as
  74  * struct { u32 a; u16; b; u16 c; u8 d[8]; }; which is 4-byte
  75  * aligned.
  76  */
  77 typedef struct efi_guid {
  78         u8 b[16];
  79 } efi_guid_t __attribute__((aligned(4)));
  80
  81 static inline int guidcmp(const void *g1, const void *g2)
  82 {
  83         return memcmp(g1, g2, sizeof(efi_guid_t));
  84 }
  85
  86 static inline void *guidcpy(void *dst, const void *src)
  87 {
  88         return memcpy(dst, src, sizeof(efi_guid_t));
  89 }
  90
  91 #define EFI_BITS_PER_LONG       (sizeof(long) * 8)
  92
  93 /* Bit mask for EFI status code with error */
  94 #define EFI_ERROR_MASK (1UL << (EFI_BITS_PER_LONG - 1))
  95 /* Status codes returned by EFI protocols */
  96 #define EFI_SUCCESS                     0
  97 #define EFI_LOAD_ERROR                  (EFI_ERROR_MASK | 1)
  98 #define EFI_INVALID_PARAMETER           (EFI_ERROR_MASK | 2)
  99 #define EFI_UNSUPPORTED                 (EFI_ERROR_MASK | 3)
 100 #define EFI_BAD_BUFFER_SIZE             (EFI_ERROR_MASK | 4)
 101 #define EFI_BUFFER_TOO_SMALL            (EFI_ERROR_MASK | 5)
 102 #define EFI_NOT_READY                   (EFI_ERROR_MASK | 6)
 103 #define EFI_DEVICE_ERROR                (EFI_ERROR_MASK | 7)
 104 #define EFI_WRITE_PROTECTED             (EFI_ERROR_MASK | 8)
 105 #define EFI_OUT_OF_RESOURCES            (EFI_ERROR_MASK | 9)
 106 #define EFI_VOLUME_CORRUPTED            (EFI_ERROR_MASK | 10)
 107 #define EFI_VOLUME_FULL                 (EFI_ERROR_MASK | 11)
 108 #define EFI_NO_MEDIA                    (EFI_ERROR_MASK | 12)
 109 #define EFI_MEDIA_CHANGED               (EFI_ERROR_MASK | 13)
 110 #define EFI_NOT_FOUND                   (EFI_ERROR_MASK | 14)
 111 #define EFI_ACCESS_DENIED               (EFI_ERROR_MASK | 15)
 112 #define EFI_NO_RESPONSE                 (EFI_ERROR_MASK | 16)
 113 #define EFI_NO_MAPPING                  (EFI_ERROR_MASK | 17)
 114 #define EFI_TIMEOUT                     (EFI_ERROR_MASK | 18)
 115 #define EFI_NOT_STARTED                 (EFI_ERROR_MASK | 19)
 116 #define EFI_ALREADY_STARTED             (EFI_ERROR_MASK | 20)
 117 #define EFI_ABORTED                     (EFI_ERROR_MASK | 21)
 118 #define EFI_ICMP_ERROR                  (EFI_ERROR_MASK | 22)
 119 #define EFI_TFTP_ERROR                  (EFI_ERROR_MASK | 23)
 120 #define EFI_PROTOCOL_ERROR              (EFI_ERROR_MASK | 24)
 121 #define EFI_INCOMPATIBLE_VERSION        (EFI_ERROR_MASK | 25)
 122 #define EFI_SECURITY_VIOLATION          (EFI_ERROR_MASK | 26)
 123 #define EFI_CRC_ERROR                   (EFI_ERROR_MASK | 27)
 124 #define EFI_END_OF_MEDIA                (EFI_ERROR_MASK | 28)
 125 #define EFI_END_OF_FILE                 (EFI_ERROR_MASK | 31)
 126 #define EFI_INVALID_LANGUAGE            (EFI_ERROR_MASK | 32)
 127 #define EFI_COMPROMISED_DATA            (EFI_ERROR_MASK | 33)
 128 #define EFI_IP_ADDRESS_CONFLICT         (EFI_ERROR_MASK | 34)
 129 #define EFI_HTTP_ERROR                  (EFI_ERROR_MASK | 35)
 130
 131 #define EFI_WARN_UNKNOWN_GLYPH          1
 132 #define EFI_WARN_DELETE_FAILURE         2
 133 #define EFI_WARN_WRITE_FAILURE          3
 134 #define EFI_WARN_BUFFER_TOO_SMALL       4
 135 #define EFI_WARN_STALE_DATA             5
 136 #define EFI_WARN_FILE_SYSTEM            6
 137 #define EFI_WARN_RESET_REQUIRED         7
 138
 139 typedef unsigned long efi_status_t;
 140 typedef u64 efi_physical_addr_t;
 141 typedef u64 efi_virtual_addr_t;
 142 typedef struct efi_object *efi_handle_t;
 143
 144 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
 145         {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
 146                 ((a) >> 24) & 0xff, \
 147                 (b) & 0xff, ((b) >> 8) & 0xff, \
 148                 (c) & 0xff, ((c) >> 8) & 0xff, \
 149                 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } }
 150
 151 /* Generic EFI table header */
 152 struct efi_table_hdr {
 153         u64 signature;
 154         u32 revision;
 155         u32 headersize;
 156         u32 crc32;
 157         u32 reserved;
 158 };
 159
 160 /* Allocation types for calls to boottime->allocate_pages*/
 161 /**
 162  * enum efi_allocate_type - address restriction for memory allocation
 163  */
 164 enum efi_allocate_type {
 165         /**
 166          * @EFI_ALLOCATE_ANY_PAGES:
 167          * Allocate any block of sufficient size. Ignore memory address.
 168          */
 169         EFI_ALLOCATE_ANY_PAGES,
 170         /**
 171          * @EFI_ALLOCATE_MAX_ADDRESS:
 172          * Allocate a memory block with an uppermost address less or equal
 173          * to the indicated address.
 174          */
 175         EFI_ALLOCATE_MAX_ADDRESS,
 176         /**
 177          * @EFI_ALLOCATE_ADDRESS:
 178          * Allocate a memory block starting at the indicated address.
 179          */
 180         EFI_ALLOCATE_ADDRESS,
 181         /**
 182          * @EFI_MAX_ALLOCATE_TYPE:
 183          * Value use for range checking.
 184          */
 185         EFI_MAX_ALLOCATE_TYPE,
 186 };
 187
 188 /* Enumeration of memory types introduced in UEFI */
 189 enum efi_memory_type {
 190         EFI_RESERVED_MEMORY_TYPE,
 191         /*
 192          * The code portions of a loaded application.
 193          * (Note that UEFI OS loaders are UEFI applications.)
 194          */
 195         EFI_LOADER_CODE,
 196         /*
 197          * The data portions of a loaded application and
 198          * the default data allocation type used by an application
 199          * to allocate pool memory.
 200          */
 201         EFI_LOADER_DATA,
 202         /* The code portions of a loaded Boot Services Driver */
 203         EFI_BOOT_SERVICES_CODE,
 204         /*
 205          * The data portions of a loaded Boot Services Driver and
 206          * the default data allocation type used by a Boot Services
 207          * Driver to allocate pool memory.
 208          */
 209         EFI_BOOT_SERVICES_DATA,
 210         /* The code portions of a loaded Runtime Services Driver */
 211         EFI_RUNTIME_SERVICES_CODE,
 212         /*
 213          * The data portions of a loaded Runtime Services Driver and
 214          * the default data allocation type used by a Runtime Services
 215          * Driver to allocate pool memory.
 216          */
 217         EFI_RUNTIME_SERVICES_DATA,
 218         /* Free (unallocated) memory */
 219         EFI_CONVENTIONAL_MEMORY,
 220         /* Memory in which errors have been detected */
 221         EFI_UNUSABLE_MEMORY,
 222         /* Memory that holds the ACPI tables */
 223         EFI_ACPI_RECLAIM_MEMORY,
 224         /* Address space reserved for use by the firmware */
 225         EFI_ACPI_MEMORY_NVS,
 226         /*
 227          * Used by system firmware to request that a memory-mapped IO region
 228          * be mapped by the OS to a virtual address so it can be accessed by
 229          * EFI runtime services.
 230          */
 231         EFI_MMAP_IO,
 232         /*
 233          * System memory-mapped IO region that is used to translate
 234          * memory cycles to IO cycles by the processor.
 235          */
 236         EFI_MMAP_IO_PORT,
 237         /*
 238          * Address space reserved by the firmware for code that is
 239          * part of the processor.
 240          */
 241         EFI_PAL_CODE,
 242         /*
 243          * Byte addressable non-volatile memory.
 244          */
 245         EFI_PERSISTENT_MEMORY_TYPE,
 246         /*
 247          * Unaccepted memory must be accepted by boot target before usage.
 248          */
 249         EFI_UNACCEPTED_MEMORY_TYPE,
 250
 251         EFI_MAX_MEMORY_TYPE,
 252 };
 253
 254 /* Attribute values */
 255 #define EFI_MEMORY_UC           ((u64)0x0000000000000001ULL)    /* uncached */
 256 #define EFI_MEMORY_WC           ((u64)0x0000000000000002ULL)    /* write-coalescing */
 257 #define EFI_MEMORY_WT           ((u64)0x0000000000000004ULL)    /* write-through */
 258 #define EFI_MEMORY_WB           ((u64)0x0000000000000008ULL)    /* write-back */
 259 #define EFI_MEMORY_UCE          ((u64)0x0000000000000010ULL)    /* uncached, exported */
 260 #define EFI_MEMORY_WP           ((u64)0x0000000000001000ULL)    /* write-protect */
 261 #define EFI_MEMORY_RP           ((u64)0x0000000000002000ULL)    /* read-protect */
 262 #define EFI_MEMORY_XP           ((u64)0x0000000000004000ULL)    /* execute-protect */
 263 #define EFI_MEMORY_NV           ((u64)0x0000000000008000ULL)    /* non-volatile */
 264 #define EFI_MEMORY_MORE_RELIABLE \
 265                                 ((u64)0x0000000000010000ULL)    /* higher reliability */
 266 #define EFI_MEMORY_RO           ((u64)0x0000000000020000ULL)    /* read-only */
 267 #define EFI_MEMORY_SP           ((u64)0x0000000000040000ULL)    /* specific-purpose memory (SPM) */
 268 #define EFI_MEMORY_CPU_CRYPTO   ((u64)0x0000000000080000ULL)    /* cryptographically protectable */
 269 #define EFI_MEMORY_RUNTIME      ((u64)0x8000000000000000ULL)    /* range requires runtime mapping */
 270 #define EFI_MEM_DESC_VERSION    1
 271
 272 #define EFI_PAGE_SHIFT          12
 273 #define EFI_PAGE_SIZE           (1ULL << EFI_PAGE_SHIFT)
 274 #define EFI_PAGE_MASK           (EFI_PAGE_SIZE - 1)
 275
 276 struct efi_mem_desc {
 277         u32 type;
 278         u32 reserved;
 279         efi_physical_addr_t physical_start;
 280         efi_virtual_addr_t virtual_start;
 281         u64 num_pages;
 282         u64 attribute;
 283 };
 284
 285 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
 286
 287 /* Types and defines for Time Services */
 288 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
 289 #define EFI_TIME_IN_DAYLIGHT     0x2
 290 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 291
 292 struct efi_time {
 293         u16 year;
 294         u8 month;
 295         u8 day;
 296         u8 hour;
 297         u8 minute;
 298         u8 second;
 299         u8 pad1;
 300         u32 nanosecond;
 301         s16 timezone;
 302         u8 daylight;
 303         u8 pad2;
 304 };
 305
 306 struct efi_time_cap {
 307         u32 resolution;
 308         u32 accuracy;
 309         u8 sets_to_zero;
 310 };
 311
 312 enum efi_locate_search_type {
 313         ALL_HANDLES,
 314         BY_REGISTER_NOTIFY,
 315         BY_PROTOCOL
 316 };
 317
 318 struct efi_open_protocol_info_entry {
 319         efi_handle_t agent_handle;
 320         efi_handle_t controller_handle;
 321         u32 attributes;
 322         u32 open_count;
 323 };
 324
 325 enum efi_entry_t {
 326         EFIET_END,      /* Signals this is the last (empty) entry */
 327         EFIET_MEMORY_MAP,
 328         EFIET_GOP_MODE,
 329         EFIET_SYS_TABLE,
 330
 331         /* Number of entries */
 332         EFIET_MEMORY_COUNT,
 333 };
 334
 335 #define EFI_TABLE_VERSION       1
 336
 337 /**
 338  * struct efi_info_hdr - Header for the EFI info table
 339  *
 340  * @version:    EFI_TABLE_VERSION
 341  * @hdr_size:   Size of this struct in bytes
 342  * @total_size: Total size of this header plus following data
 343  * @spare:      Spare space for expansion
 344  */
 345 struct efi_info_hdr {
 346         u32 version;
 347         u32 hdr_size;
 348         u32 total_size;
 349         u32 spare[5];
 350 };
 351
 352 /**
 353  * struct efi_entry_hdr - Header for a table entry
 354  *
 355  * @type:       enum eft_entry_t
 356  * @size:       size of entry bytes excluding header and padding
 357  * @addr:       address of this entry (0 if it follows the header )
 358  * @link:       size of entry including header and padding
 359  * @spare1:     Spare space for expansion
 360  * @spare2:     Spare space for expansion
 361  */
 362 struct efi_entry_hdr {
 363         u32 type;
 364         u32 size;
 365         u64 addr;
 366         u32 link;
 367         u32 spare1;
 368         u64 spare2;
 369 };
 370
 371 /**
 372  * struct efi_entry_memmap - a memory map table passed to U-Boot
 373  *
 374  * @version:    EFI's memory map table version
 375  * @desc_size:  EFI's size of each memory descriptor
 376  * @spare:      Spare space for expansion
 377  * @desc:       An array of descriptors, each @desc_size bytes apart
 378  */
 379 struct efi_entry_memmap {
 380         u32 version;
 381         u32 desc_size;
 382         u64 spare;
 383         struct efi_mem_desc desc[];
 384 };
 385
 386 /**
 387  * struct efi_entry_gopmode - a GOP mode table passed to U-Boot
 388  *
 389  * @fb_base:    EFI's framebuffer base address
 390  * @fb_size:    EFI's framebuffer size
 391  * @info_size:  GOP mode info structure size
 392  * @info:       Start address of the GOP mode info structure
 393  */
 394 struct efi_entry_gopmode {
 395         efi_physical_addr_t fb_base;
 396         /*
 397          * Not like the ones in 'struct efi_gop_mode' which are 'unsigned
 398          * long', @fb_size and @info_size have to be 'u64' here. As the EFI
 399          * stub codes may have different bit size from the U-Boot payload,
 400          * using 'long' will cause mismatch between the producer (stub) and
 401          * the consumer (payload).
 402          */
 403         u64 fb_size;
 404         u64 info_size;
 405         /*
 406          * We cannot directly use 'struct efi_gop_mode_info info[]' here as
 407          * it causes compiler to complain: array type has incomplete element
 408          * type 'struct efi_gop_mode_info'.
 409          */
 410         struct /* efi_gop_mode_info */ {
 411                 u32 version;
 412                 u32 width;
 413                 u32 height;
 414                 u32 pixel_format;
 415                 u32 pixel_bitmask[4];
 416                 u32 pixels_per_scanline;
 417         } info[];
 418 };
 419
 420 /**
 421  * struct efi_entry_systable - system table passed to U-Boot
 422  *
 423  * @sys_table:  EFI system table address
 424  */
 425 struct efi_entry_systable {
 426         efi_physical_addr_t sys_table;
 427 };
 428
 429 static inline struct efi_mem_desc *efi_get_next_mem_desc(
 430                 struct efi_mem_desc *desc, int desc_size)
 431 {
 432         return (struct efi_mem_desc *)((ulong)desc + desc_size);
 433 }
 434
 435 /**
 436  * struct efi_priv - Information about the environment provided by EFI
 437  *
 438  * @parent_image: image passed into the EFI app or stub
 439  * @sys_table: Pointer to system table
 440  * @boot: Pointer to boot-services table
 441  * @run: Pointer to runtime-services table
 442  * @memmap_key: Key returned from get_memory_map()
 443  * @memmap_desc: List of memory-map records
 444  * @memmap_alloc: Amount of memory allocated for memory map list
 445  * @memmap_size Size of memory-map list in bytes
 446  * @memmap_desc_size: Size of an individual memory-map record, in bytes
 447  * @memmap_version: Memory-map version
 448  *
 449  * @use_pool_for_malloc: true if all allocation should go through the EFI 'pool'
 450  *      methods allocate_pool() and free_pool(); false to use 'pages' methods
 451  *      allocate_pages() and free_pages()
 452  * @ram_base: Base address of RAM (size CONFIG_EFI_RAM_SIZE)
 453  * @image_data_type: Type of the loaded image (e.g. EFI_LOADER_CODE)
 454  *
 455  * @info: Header of the info list, holding info collected by the stub and passed
 456  *      to U-Boot
 457  * @info_size: Size of the info list @info in bytes
 458  * @next_hdr: Pointer to where to put the next header when adding to the list
 459  */
 460 struct efi_priv {
 461         efi_handle_t parent_image;
 462         struct efi_system_table *sys_table;
 463         struct efi_boot_services *boot;
 464         struct efi_runtime_services *run;
 465         efi_uintn_t memmap_key;
 466         struct efi_mem_desc *memmap_desc;
 467         efi_uintn_t memmap_alloc;
 468         efi_uintn_t memmap_size;
 469         efi_uintn_t memmap_desc_size;
 470         u32 memmap_version;
 471
 472         /* app: */
 473         bool use_pool_for_malloc;
 474         unsigned long ram_base;
 475         unsigned int image_data_type;
 476
 477         /* stub: */
 478         struct efi_info_hdr *info;
 479         unsigned int info_size;
 480         void *next_hdr;
 481 };
 482
 483 /*
 484  * EFI attributes of the udevice handled by efi_media driver
 485  *
 486  * @handle: handle of the controller on which this driver is installed
 487  * @blkio: block io protocol proxied by this driver
 488  * @device_path: EFI path to the device
 489  */
 490 struct efi_media_plat {
 491         efi_handle_t handle;
 492         struct efi_block_io *blkio;
 493         struct efi_device_path *device_path;
 494 };
 495
 496 /* Base address of the EFI image */
 497 extern char image_base[];
 498
 499 /* Start and end of U-Boot image (for payload) */
 500 extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
 501
 502 /*
 503  * Variable Attributes
 504  */
 505 #define EFI_VARIABLE_NON_VOLATILE                               0x00000001
 506 #define EFI_VARIABLE_BOOTSERVICE_ACCESS                         0x00000002
 507 #define EFI_VARIABLE_RUNTIME_ACCESS                             0x00000004
 508 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD                      0x00000008
 509 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS                 0x00000010
 510 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS      0x00000020
 511 #define EFI_VARIABLE_APPEND_WRITE                               0x00000040
 512 #define EFI_VARIABLE_ENHANCED_AUTHENTICATED_ACCESS              0x00000080
 513
 514 #define EFI_VARIABLE_MASK       (EFI_VARIABLE_NON_VOLATILE | \
 515                                 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
 516                                 EFI_VARIABLE_RUNTIME_ACCESS | \
 517                                 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
 518                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
 519                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
 520                                 EFI_VARIABLE_APPEND_WRITE | \
 521                                 EFI_VARIABLE_ENHANCED_AUTHENTICATED_ACCESS)
 522
 523 /**
 524  * efi_get_priv() - Get access to the EFI-private information
 525  *
 526  * This struct it used by both the stub and the app to record things about the
 527  * EFI environment. It is not available in U-Boot proper after the stub has
 528  * jumped there. Use efi_info_get() to obtain info in that case.
 529  *
 530  * Return: pointer to private info
 531  */
 532 struct efi_priv *efi_get_priv(void);
 533
 534 /**
 535  * efi_set_priv() - Set up a pointer to the EFI-private information
 536  *
 537  * This is called in the stub and app to record the location of this
 538  * information.
 539  *
 540  * @priv: New location of private data
 541  */
 542 void efi_set_priv(struct efi_priv *priv);
 543
 544 /**
 545  * efi_get_sys_table() - Get access to the main EFI system table
 546  *
 547  * Returns: pointer to EFI system table
 548  */
 549 struct efi_system_table *efi_get_sys_table(void);
 550
 551 /**
 552  * efi_get_boot() - Get access to the EFI boot services table
 553  *
 554  * Returns: pointer to EFI boot services table
 555  */
 556 struct efi_boot_services *efi_get_boot(void);
 557
 558 /**
 559  * efi_get_ram_base() - Find the base of RAM
 560  *
 561  * This is used when U-Boot is built as an EFI application.
 562  *
 563  * Returns: the base of RAM as known to U-Boot
 564  */
 565 unsigned long efi_get_ram_base(void);
 566
 567 /**
 568  * efi_init() - Set up ready for use of EFI boot services
 569  *
 570  * @priv:       Pointer to our private EFI structure to fill in
 571  * @banner:     Banner to display when starting
 572  * @image:      The image handle passed to efi_main()
 573  * @sys_table:  The EFI system table pointer passed to efi_main()
 574  * Return: 0 on succcess, EFI error code on failure
 575  */
 576 int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image,
 577              struct efi_system_table *sys_table);
 578
 579 /**
 580  * efi_malloc() - Allocate some memory from EFI
 581  *
 582  * @priv:       Pointer to private EFI structure
 583  * @size:       Number of bytes to allocate
 584  * @retp:       Return EFI status result
 585  * Returns: pointer to memory allocated, or NULL on error
 586  */
 587 void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp);
 588
 589 /**
 590  * efi_free() - Free memory allocated from EFI
 591  *
 592  * @priv:       Pointer to private EFI structure
 593  * @ptr:        Pointer to memory to free
 594  */
 595 void efi_free(struct efi_priv *priv, void *ptr);
 596
 597 /**
 598  * efi_puts() - Write out a string to the EFI console
 599  *
 600  * @priv:       Pointer to private EFI structure
 601  * @str:        String to write (note this is a ASCII, not unicode)
 602  */
 603 void efi_puts(struct efi_priv *priv, const char *str);
 604
 605 /**
 606  * efi_putc() - Write out a character to the EFI console
 607  *
 608  * @priv:       Pointer to private EFI structure
 609  * @ch:         Character to write (note this is not unicode)
 610  */
 611 void efi_putc(struct efi_priv *priv, const char ch);
 612
 613 /**
 614  * efi_info_get() - get an entry from an EFI table
 615  *
 616  * This function is called from U-Boot proper to read information set up by the
 617  * EFI stub. It can only be used when running from the EFI stub, not when U-Boot
 618  * is running as an app.
 619  *
 620  * @type:       Entry type to search for
 621  * @datap:      Returns pointer to entry data
 622  * @sizep:      Returns entry size
 623  * Return: 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
 624  * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
 625  */
 626 int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);
 627
 628 /**
 629  * efi_store_memory_map() - Collect the memory-map info from EFI
 630  *
 631  * Collect the memory info and store it for later use, e.g. in calling
 632  * exit_boot_services()
 633  *
 634  * @priv:       Pointer to private EFI structure
 635  * Returns: 0 if OK, non-zero on error
 636  */
 637 int efi_store_memory_map(struct efi_priv *priv);
 638
 639 /**
 640  * efi_call_exit_boot_services() - Handle the exit-boot-service procedure
 641  *
 642  * Tell EFI we don't want their boot services anymore
 643  *
 644  * Return: 0 if OK, non-zero on error
 645  */
 646 int efi_call_exit_boot_services(void);
 647
 648 /**
 649  * efi_get_mmap() - Get the memory map from EFI
 650  *
 651  * This is used in the app. The caller must free *@descp when done
 652  *
 653  * @descp:      Returns allocated pointer to EFI memory map table
 654  * @sizep:      Returns size of table in bytes
 655  * @keyp:       Returns memory-map key
 656  * @desc_sizep: Returns size of each @desc_base record
 657  * @versionp:   Returns version number of memory map
 658  * Returns: 0 on success, -ve on error
 659  */
 660 int efi_get_mmap(struct efi_mem_desc **descp, int *sizep, uint *keyp,
 661                  int *desc_sizep, uint *versionp);
 662
 663 /**
 664  * efi_show_tables() - Show a list of available tables
 665  *
 666  * Shows the address, GUID (and name where known) for each table
 667  *
 668  * @systab: System table containing the list of tables
 669  */
 670 void efi_show_tables(struct efi_system_table *systab);
 671
 672 /**
 673  * efi_get_basename() - Get the default filename to use when loading
 674  *
 675  * E.g. this function returns BOOTAA64.EFI for an aarch target
 676  *
 677  * Return: Default EFI filename
 678  */
 679 const char *efi_get_basename(void);
 680
 681 #ifdef CONFIG_SANDBOX
 682 #include <asm/state.h>
 683 #endif
 684
 685 static inline bool efi_use_host_arch(void)
 686 {
 687 #ifdef CONFIG_SANDBOX
 688         struct sandbox_state *state = state_get_current();
 689
 690         return state->native;
 691 #else
 692         return false;
 693 #endif
 694 }
 695
 696 /**
 697  * efi_get_pxe_arch() - Get the architecture value for PXE
 698  *
 699  * See:
 700  * http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml
 701  *
 702  * Return: Architecture value
 703  */
 704 int efi_get_pxe_arch(void);
 705
 706 #endif /* _LINUX_EFI_H */