blob: d5af213994683f0a81dbf2028748a587f73ef026 [file] [log] [blame]
Heinrich Schuchardt1fce3c02018-09-08 10:57:59 +02001/* SPDX-License-Identifier: GPL-2.0 */
Simon Glass9539e692015-07-31 09:31:36 -06002/*
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
Simon Glasscc022562016-09-25 15:27:31 -060019#include <linux/linkage.h>
Simon Glass9539e692015-07-31 09:31:36 -060020#include <linux/string.h>
21#include <linux/types.h>
22
Heinrich Schuchardt546a52f2021-01-05 07:52:48 +010023/* 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
Alexander Grafff592b22018-06-22 01:38:26 -070028/*
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__
Simon Glassce62a252015-08-04 12:33:56 -060037#define EFIAPI __attribute__((ms_abi))
Alexander Graf404a7c82018-06-18 17:23:05 +020038#define efi_va_list __builtin_ms_va_list
39#define efi_va_start __builtin_ms_va_start
Ilias Apalodimas8ac0ebe2022-10-06 16:08:46 +030040#define efi_va_copy __builtin_ms_va_copy
Alexander Graf404a7c82018-06-18 17:23:05 +020041#define efi_va_arg __builtin_va_arg
42#define efi_va_end __builtin_ms_va_end
Simon Glassce62a252015-08-04 12:33:56 -060043#else
Simon Glasscc022562016-09-25 15:27:31 -060044#define EFIAPI asmlinkage
Alexander Graf404a7c82018-06-18 17:23:05 +020045#define efi_va_list va_list
46#define efi_va_start va_start
Ilias Apalodimas8ac0ebe2022-10-06 16:08:46 +030047#define efi_va_copy va_copy
Alexander Graf404a7c82018-06-18 17:23:05 +020048#define efi_va_arg va_arg
49#define efi_va_end va_end
Alexander Grafff592b22018-06-22 01:38:26 -070050#endif /* __x86_64__ */
Simon Glassce62a252015-08-04 12:33:56 -060051
Bin Meng106dcfc2018-08-23 08:24:10 -070052#define EFI32_LOADER_SIGNATURE "EL32"
53#define EFI64_LOADER_SIGNATURE "EL64"
54
Heinrich Schuchardt2010d852023-03-19 08:59:33 +010055/**
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 */
62struct efi_device_path {
63 u8 type;
64 u8 sub_type;
65 u16 length;
66} __packed;
Simon Glass9539e692015-07-31 09:31:36 -060067
Masahisa Kojimad81f5292023-01-28 13:56:14 +090068/*
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 */
Rob Clark224ee842017-09-13 18:05:24 -040077typedef struct {
78 u8 b[16];
Masahisa Kojimad81f5292023-01-28 13:56:14 +090079} efi_guid_t __attribute__((aligned(4)));
Rob Clark224ee842017-09-13 18:05:24 -040080
Vincent Stehlé1ebd0782024-07-03 13:37:55 +020081static inline int guidcmp(const void *g1, const void *g2)
82{
83 return memcmp(g1, g2, sizeof(efi_guid_t));
84}
85
86static inline void *guidcpy(void *dst, const void *src)
87{
88 return memcpy(dst, src, sizeof(efi_guid_t));
89}
90
Alexander Grafff592b22018-06-22 01:38:26 -070091#define EFI_BITS_PER_LONG (sizeof(long) * 8)
Bin Menge20a69c2016-08-25 01:47:18 -070092
xypron.glpk@gmx.deb343d932017-07-04 23:15:22 +020093/* 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)
Simon Glass9539e692015-07-31 09:31:36 -0600130
Heinrich Schuchardt91aab822020-01-03 22:47:19 +0100131#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
Rob Clark53142032017-09-13 18:05:34 -0400138
Simon Glass9539e692015-07-31 09:31:36 -0600139typedef unsigned long efi_status_t;
140typedef u64 efi_physical_addr_t;
141typedef u64 efi_virtual_addr_t;
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +0200142typedef struct efi_object *efi_handle_t;
Simon Glass9539e692015-07-31 09:31:36 -0600143
144#define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
Simon Glass9539e692015-07-31 09:31:36 -0600145 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
146 ((a) >> 24) & 0xff, \
147 (b) & 0xff, ((b) >> 8) & 0xff, \
148 (c) & 0xff, ((c) >> 8) & 0xff, \
Heinrich Schuchardtfac78672018-06-09 17:50:18 +0200149 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } }
Simon Glass9539e692015-07-31 09:31:36 -0600150
151/* Generic EFI table header */
152struct efi_table_hdr {
153 u64 signature;
154 u32 revision;
155 u32 headersize;
156 u32 crc32;
157 u32 reserved;
158};
159
Heinrich Schuchardt05824ee2021-08-17 14:52:16 +0200160/* Allocation types for calls to boottime->allocate_pages*/
161/**
162 * enum efi_allocate_type - address restriction for memory allocation
163 */
164enum 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 indicatged adress.
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
Simon Glass9539e692015-07-31 09:31:36 -0600188/* Enumeration of memory types introduced in UEFI */
Heinrich Schuchardt96066462021-08-17 15:02:23 +0200189enum efi_memory_type {
Simon Glass9539e692015-07-31 09:31:36 -0600190 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 /*
Heinrich Schuchardt514b91f2017-09-18 07:54:50 +0200205 * The data portions of a loaded Boot Services Driver and
Simon Glass9539e692015-07-31 09:31:36 -0600206 * 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,
Heinrich Schuchardtf7272332019-04-23 00:30:53 +0200242 /*
Heinrich Schuchardt61e44662021-04-02 22:16:22 +0200243 * Byte addressable non-volatile memory.
Heinrich Schuchardtf7272332019-04-23 00:30:53 +0200244 */
245 EFI_PERSISTENT_MEMORY_TYPE,
Heinrich Schuchardt61e44662021-04-02 22:16:22 +0200246 /*
247 * Unaccepted memory must be accepted by boot target before usage.
248 */
249 EFI_UNACCEPTED_MEMORY_TYPE,
Simon Glass9539e692015-07-31 09:31:36 -0600250
251 EFI_MAX_MEMORY_TYPE,
Simon Glass9539e692015-07-31 09:31:36 -0600252};
253
254/* Attribute values */
Eugeniu Roscac86c0812018-07-14 22:53:30 +0200255#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 */
Eugeniu Rosca4e442332018-07-14 22:53:31 +0200263#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 */
Heinrich Schuchardte76f0e42020-05-19 07:20:46 +0200267#define EFI_MEMORY_SP ((u64)0x0000000000040000ULL) /* specific-purpose memory (SPM) */
Heinrich Schuchardt61e44662021-04-02 22:16:22 +0200268#define EFI_MEMORY_CPU_CRYPTO ((u64)0x0000000000080000ULL) /* cryptographically protectable */
Eugeniu Roscac86c0812018-07-14 22:53:30 +0200269#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
270#define EFI_MEM_DESC_VERSION 1
Simon Glass9539e692015-07-31 09:31:36 -0600271
272#define EFI_PAGE_SHIFT 12
Patrick Wildta98bd392019-04-09 22:58:30 +0200273#define EFI_PAGE_SIZE (1ULL << EFI_PAGE_SHIFT)
Alexander Graf3ad57b42016-03-04 01:09:57 +0100274#define EFI_PAGE_MASK (EFI_PAGE_SIZE - 1)
Simon Glass9539e692015-07-31 09:31:36 -0600275
276struct 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
Mian Yousaf Kaukab338cf562016-09-05 23:59:22 +0200285#define EFI_MEMORY_DESCRIPTOR_VERSION 1
286
Simon Glass9539e692015-07-31 09:31:36 -0600287/* 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
292struct 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
306struct efi_time_cap {
307 u32 resolution;
308 u32 accuracy;
309 u8 sets_to_zero;
310};
311
312enum efi_locate_search_type {
Heinrich Schuchardt68845f02017-11-06 21:17:42 +0100313 ALL_HANDLES,
314 BY_REGISTER_NOTIFY,
315 BY_PROTOCOL
Simon Glass9539e692015-07-31 09:31:36 -0600316};
317
318struct 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
325enum efi_entry_t {
326 EFIET_END, /* Signals this is the last (empty) entry */
327 EFIET_MEMORY_MAP,
Bin Mengcb787cb2018-06-12 08:36:21 -0700328 EFIET_GOP_MODE,
Bin Meng88398512018-08-23 08:24:09 -0700329 EFIET_SYS_TABLE,
Simon Glass9539e692015-07-31 09:31:36 -0600330
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 */
345struct 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
Heinrich Schuchardtef476882021-12-21 09:09:48 +0100356 * @size: size of entry bytes excluding header and padding
Simon Glass9539e692015-07-31 09:31:36 -0600357 * @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 */
362struct 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 */
379struct efi_entry_memmap {
380 u32 version;
381 u32 desc_size;
382 u64 spare;
383 struct efi_mem_desc desc[];
384};
385
Bin Mengcb787cb2018-06-12 08:36:21 -0700386/**
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 */
394struct 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
Bin Meng88398512018-08-23 08:24:09 -0700420/**
421 * struct efi_entry_systable - system table passed to U-Boot
422 *
423 * @sys_table: EFI system table address
424 */
425struct efi_entry_systable {
426 efi_physical_addr_t sys_table;
427};
428
Simon Glass9539e692015-07-31 09:31:36 -0600429static inline struct efi_mem_desc *efi_get_next_mem_desc(
Simon Glass6f4d7aa2022-01-04 03:51:11 -0700430 struct efi_mem_desc *desc, int desc_size)
Simon Glass9539e692015-07-31 09:31:36 -0600431{
Simon Glass6f4d7aa2022-01-04 03:51:11 -0700432 return (struct efi_mem_desc *)((ulong)desc + desc_size);
Simon Glass9539e692015-07-31 09:31:36 -0600433}
434
Simon Glass26ae0c52021-12-29 11:57:42 -0700435/**
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
Simon Glass029f48e2022-01-04 03:51:10 -0700442 * @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
Simon Glass26ae0c52021-12-29 11:57:42 -0700448 *
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 */
Simon Glass9539e692015-07-31 09:31:36 -0600460struct efi_priv {
461 efi_handle_t parent_image;
Simon Glass9539e692015-07-31 09:31:36 -0600462 struct efi_system_table *sys_table;
463 struct efi_boot_services *boot;
464 struct efi_runtime_services *run;
Simon Glass029f48e2022-01-04 03:51:10 -0700465 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;
Simon Glass26ae0c52021-12-29 11:57:42 -0700471
472 /* app: */
Simon Glass9539e692015-07-31 09:31:36 -0600473 bool use_pool_for_malloc;
474 unsigned long ram_base;
475 unsigned int image_data_type;
Simon Glass26ae0c52021-12-29 11:57:42 -0700476
477 /* stub: */
Simon Glass9539e692015-07-31 09:31:36 -0600478 struct efi_info_hdr *info;
479 unsigned int info_size;
480 void *next_hdr;
481};
482
Simon Glassc4688392021-12-04 08:56:32 -0700483/*
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
Simon Glass2d4b33e2021-12-29 11:57:36 -0700488 * @device_path: EFI path to the device
Simon Glassc4688392021-12-04 08:56:32 -0700489 */
490struct efi_media_plat {
Simon Glass2d4b33e2021-12-29 11:57:36 -0700491 efi_handle_t handle;
492 struct efi_block_io *blkio;
493 struct efi_device_path *device_path;
Simon Glassc4688392021-12-04 08:56:32 -0700494};
495
Simon Glass9539e692015-07-31 09:31:36 -0600496/* Base address of the EFI image */
497extern char image_base[];
498
Simon Glass63f581f2015-08-04 12:33:52 -0600499/* Start and end of U-Boot image (for payload) */
Bin Meng7c78bf92016-08-25 01:47:17 -0700500extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
Simon Glass63f581f2015-08-04 12:33:52 -0600501
Rob Clark15f3d742017-09-13 18:05:37 -0400502/*
503 * Variable Attributes
504 */
Heinrich Schuchardt698cfde2024-04-03 17:33:33 +0200505#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
Rob Clark15f3d742017-09-13 18:05:37 -0400513
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 | \
Heinrich Schuchardt75dffaa2024-04-03 17:33:35 +0200520 EFI_VARIABLE_APPEND_WRITE | \
521 EFI_VARIABLE_ENHANCED_AUTHENTICATED_ACCESS)
Rob Clark15f3d742017-09-13 18:05:37 -0400522
Simon Glass9539e692015-07-31 09:31:36 -0600523/**
Simon Glassb13771f2021-12-29 11:57:45 -0700524 * 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 */
532struct 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 */
542void efi_set_priv(struct efi_priv *priv);
543
544/**
Simon Glass9539e692015-07-31 09:31:36 -0600545 * efi_get_sys_table() - Get access to the main EFI system table
546 *
Simon Glass50f31422022-01-04 03:51:18 -0700547 * Returns: pointer to EFI system table
Simon Glass9539e692015-07-31 09:31:36 -0600548 */
Simon Glass9539e692015-07-31 09:31:36 -0600549struct efi_system_table *efi_get_sys_table(void);
550
551/**
Simon Glass0a3e7b32021-11-03 21:09:09 -0600552 * efi_get_boot() - Get access to the EFI boot services table
553 *
Simon Glass50f31422022-01-04 03:51:18 -0700554 * Returns: pointer to EFI boot services table
Simon Glass0a3e7b32021-11-03 21:09:09 -0600555 */
556struct efi_boot_services *efi_get_boot(void);
557
558/**
Simon Glass9539e692015-07-31 09:31:36 -0600559 * efi_get_ram_base() - Find the base of RAM
560 *
561 * This is used when U-Boot is built as an EFI application.
562 *
Simon Glass50f31422022-01-04 03:51:18 -0700563 * Returns: the base of RAM as known to U-Boot
Simon Glass9539e692015-07-31 09:31:36 -0600564 */
565unsigned 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()
Simon Glass50f31422022-01-04 03:51:18 -0700574 * Return: 0 on succcess, EFI error code on failure
Simon Glass9539e692015-07-31 09:31:36 -0600575 */
576int 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
Simon Glass50f31422022-01-04 03:51:18 -0700585 * Returns: pointer to memory allocated, or NULL on error
Simon Glass9539e692015-07-31 09:31:36 -0600586 */
587void *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 */
595void 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 */
603void 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 */
611void efi_putc(struct efi_priv *priv, const char ch);
612
613/**
614 * efi_info_get() - get an entry from an EFI table
615 *
Simon Glasse5232582021-12-29 11:57:48 -0700616 * 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 *
Simon Glass9539e692015-07-31 09:31:36 -0600620 * @type: Entry type to search for
621 * @datap: Returns pointer to entry data
Simon Glass50f31422022-01-04 03:51:18 -0700622 * @sizep: Returns entry size
623 * Return: 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
Simon Glass9539e692015-07-31 09:31:36 -0600624 * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
625 */
626int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);
627
Simon Glass029f48e2022-01-04 03:51:10 -0700628/**
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
Simon Glass50f31422022-01-04 03:51:18 -0700635 * Returns: 0 if OK, non-zero on error
Simon Glass029f48e2022-01-04 03:51:10 -0700636 */
637int 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 */
646int efi_call_exit_boot_services(void);
647
Simon Glassba042532022-01-04 03:51:12 -0700648/**
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
Simon Glass50f31422022-01-04 03:51:18 -0700658 * Returns: 0 on success, -ve on error
Simon Glassba042532022-01-04 03:51:12 -0700659 */
660int efi_get_mmap(struct efi_mem_desc **descp, int *sizep, uint *keyp,
661 int *desc_sizep, uint *versionp);
662
Simon Glass55de3e52023-03-20 08:30:14 +1300663/**
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 */
670void efi_show_tables(struct efi_system_table *systab);
671
Simon Glass9539e692015-07-31 09:31:36 -0600672#endif /* _LINUX_EFI_H */