2 * Extensible Firmware Interface
3 * Based on 'Extensible Firmware Interface Specification' version 0.9,
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>
12 * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
18 #include <linux/string.h>
19 #include <linux/types.h>
21 #ifdef CONFIG_EFI_STUB_64BIT
22 /* EFI uses the Microsoft ABI which is not the default for GCC */
23 #define EFIAPI __attribute__((ms_abi))
28 struct efi_device_path;
30 #define EFI_BITS_PER_LONG BITS_PER_LONG
32 /* With 64-bit EFI stub, EFI_BITS_PER_LONG has to be 64 */
33 #ifdef CONFIG_EFI_STUB_64BIT
34 #undef EFI_BITS_PER_LONG
35 #define EFI_BITS_PER_LONG 64
39 #define EFI_LOAD_ERROR (1 | (1UL << (EFI_BITS_PER_LONG - 1)))
40 #define EFI_INVALID_PARAMETER (2 | (1UL << (EFI_BITS_PER_LONG - 1)))
41 #define EFI_UNSUPPORTED (3 | (1UL << (EFI_BITS_PER_LONG - 1)))
42 #define EFI_BAD_BUFFER_SIZE (4 | (1UL << (EFI_BITS_PER_LONG - 1)))
43 #define EFI_BUFFER_TOO_SMALL (5 | (1UL << (EFI_BITS_PER_LONG - 1)))
44 #define EFI_NOT_READY (6 | (1UL << (EFI_BITS_PER_LONG - 1)))
45 #define EFI_DEVICE_ERROR (7 | (1UL << (EFI_BITS_PER_LONG - 1)))
46 #define EFI_WRITE_PROTECTED (8 | (1UL << (EFI_BITS_PER_LONG - 1)))
47 #define EFI_OUT_OF_RESOURCES (9 | (1UL << (EFI_BITS_PER_LONG - 1)))
48 #define EFI_NOT_FOUND (14 | (1UL << (EFI_BITS_PER_LONG - 1)))
49 #define EFI_ACCESS_DENIED (15 | (1UL << (EFI_BITS_PER_LONG - 1)))
50 #define EFI_SECURITY_VIOLATION (26 | (1UL << (EFI_BITS_PER_LONG - 1)))
52 typedef unsigned long efi_status_t;
53 typedef u64 efi_physical_addr_t;
54 typedef u64 efi_virtual_addr_t;
55 typedef void *efi_handle_t;
57 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
59 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
61 (b) & 0xff, ((b) >> 8) & 0xff, \
62 (c) & 0xff, ((c) >> 8) & 0xff, \
63 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } })
65 /* Generic EFI table header */
66 struct efi_table_hdr {
74 /* Enumeration of memory types introduced in UEFI */
76 EFI_RESERVED_MEMORY_TYPE,
78 * The code portions of a loaded application.
79 * (Note that UEFI OS loaders are UEFI applications.)
83 * The data portions of a loaded application and
84 * the default data allocation type used by an application
85 * to allocate pool memory.
88 /* The code portions of a loaded Boot Services Driver */
89 EFI_BOOT_SERVICES_CODE,
91 * The data portions of a loaded Boot Serves Driver and
92 * the default data allocation type used by a Boot Services
93 * Driver to allocate pool memory.
95 EFI_BOOT_SERVICES_DATA,
96 /* The code portions of a loaded Runtime Services Driver */
97 EFI_RUNTIME_SERVICES_CODE,
99 * The data portions of a loaded Runtime Services Driver and
100 * the default data allocation type used by a Runtime Services
101 * Driver to allocate pool memory.
103 EFI_RUNTIME_SERVICES_DATA,
104 /* Free (unallocated) memory */
105 EFI_CONVENTIONAL_MEMORY,
106 /* Memory in which errors have been detected */
108 /* Memory that holds the ACPI tables */
109 EFI_ACPI_RECLAIM_MEMORY,
110 /* Address space reserved for use by the firmware */
113 * Used by system firmware to request that a memory-mapped IO region
114 * be mapped by the OS to a virtual address so it can be accessed by
115 * EFI runtime services.
119 * System memory-mapped IO region that is used to translate
120 * memory cycles to IO cycles by the processor.
124 * Address space reserved by the firmware for code that is
125 * part of the processor.
130 EFI_TABLE_END, /* For efi_build_mem_table() */
133 /* Attribute values */
135 EFI_MEMORY_UC_SHIFT = 0, /* uncached */
136 EFI_MEMORY_WC_SHIFT = 1, /* write-coalescing */
137 EFI_MEMORY_WT_SHIFT = 2, /* write-through */
138 EFI_MEMORY_WB_SHIFT = 3, /* write-back */
139 EFI_MEMORY_UCE_SHIFT = 4, /* uncached, exported */
140 EFI_MEMORY_WP_SHIFT = 12, /* write-protect */
141 EFI_MEMORY_RP_SHIFT = 13, /* read-protect */
142 EFI_MEMORY_XP_SHIFT = 14, /* execute-protect */
143 EFI_MEMORY_RUNTIME_SHIFT = 63, /* range requires runtime mapping */
145 EFI_MEMORY_RUNTIME = 1ULL << EFI_MEMORY_RUNTIME_SHIFT,
146 EFI_MEM_DESC_VERSION = 1,
149 #define EFI_PAGE_SHIFT 12
150 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
151 #define EFI_PAGE_MASK (EFI_PAGE_SIZE - 1)
153 struct efi_mem_desc {
156 efi_physical_addr_t physical_start;
157 efi_virtual_addr_t virtual_start;
162 /* Allocation types for calls to boottime->allocate_pages*/
163 #define EFI_ALLOCATE_ANY_PAGES 0
164 #define EFI_ALLOCATE_MAX_ADDRESS 1
165 #define EFI_ALLOCATE_ADDRESS 2
166 #define EFI_MAX_ALLOCATE_TYPE 3
168 /* Types and defines for Time Services */
169 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
170 #define EFI_TIME_IN_DAYLIGHT 0x2
171 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
187 struct efi_time_cap {
193 enum efi_locate_search_type {
199 struct efi_open_protocol_info_entry {
200 efi_handle_t agent_handle;
201 efi_handle_t controller_handle;
207 EFIET_END, /* Signals this is the last (empty) entry */
210 /* Number of entries */
214 #define EFI_TABLE_VERSION 1
217 * struct efi_info_hdr - Header for the EFI info table
219 * @version: EFI_TABLE_VERSION
220 * @hdr_size: Size of this struct in bytes
221 * @total_size: Total size of this header plus following data
222 * @spare: Spare space for expansion
224 struct efi_info_hdr {
232 * struct efi_entry_hdr - Header for a table entry
234 * @type: enum eft_entry_t
235 * @size size of entry bytes excluding header and padding
236 * @addr: address of this entry (0 if it follows the header )
237 * @link: size of entry including header and padding
238 * @spare1: Spare space for expansion
239 * @spare2: Spare space for expansion
241 struct efi_entry_hdr {
251 * struct efi_entry_memmap - a memory map table passed to U-Boot
253 * @version: EFI's memory map table version
254 * @desc_size: EFI's size of each memory descriptor
255 * @spare: Spare space for expansion
256 * @desc: An array of descriptors, each @desc_size bytes apart
258 struct efi_entry_memmap {
262 struct efi_mem_desc desc[];
265 static inline struct efi_mem_desc *efi_get_next_mem_desc(
266 struct efi_entry_memmap *map, struct efi_mem_desc *desc)
268 return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
272 efi_handle_t parent_image;
273 struct efi_device_path *device_path;
274 struct efi_system_table *sys_table;
275 struct efi_boot_services *boot;
276 struct efi_runtime_services *run;
277 bool use_pool_for_malloc;
278 unsigned long ram_base;
279 unsigned int image_data_type;
280 struct efi_info_hdr *info;
281 unsigned int info_size;
285 /* Base address of the EFI image */
286 extern char image_base[];
288 /* Start and end of U-Boot image (for payload) */
289 extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
292 * efi_get_sys_table() - Get access to the main EFI system table
294 * @return pointer to EFI system table
297 struct efi_system_table *efi_get_sys_table(void);
300 * efi_get_ram_base() - Find the base of RAM
302 * This is used when U-Boot is built as an EFI application.
304 * @return the base of RAM as known to U-Boot
306 unsigned long efi_get_ram_base(void);
309 * efi_init() - Set up ready for use of EFI boot services
311 * @priv: Pointer to our private EFI structure to fill in
312 * @banner: Banner to display when starting
313 * @image: The image handle passed to efi_main()
314 * @sys_table: The EFI system table pointer passed to efi_main()
316 int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image,
317 struct efi_system_table *sys_table);
320 * efi_malloc() - Allocate some memory from EFI
322 * @priv: Pointer to private EFI structure
323 * @size: Number of bytes to allocate
324 * @retp: Return EFI status result
325 * @return pointer to memory allocated, or NULL on error
327 void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp);
330 * efi_free() - Free memory allocated from EFI
332 * @priv: Pointer to private EFI structure
333 * @ptr: Pointer to memory to free
335 void efi_free(struct efi_priv *priv, void *ptr);
338 * efi_puts() - Write out a string to the EFI console
340 * @priv: Pointer to private EFI structure
341 * @str: String to write (note this is a ASCII, not unicode)
343 void efi_puts(struct efi_priv *priv, const char *str);
346 * efi_putc() - Write out a character to the EFI console
348 * @priv: Pointer to private EFI structure
349 * @ch: Character to write (note this is not unicode)
351 void efi_putc(struct efi_priv *priv, const char ch);
354 * efi_info_get() - get an entry from an EFI table
356 * @type: Entry type to search for
357 * @datap: Returns pointer to entry data
358 * @sizep: Returns pointer to entry size
359 * @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
360 * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
362 int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);
365 * efi_build_mem_table() - make a sorted copy of the memory table
367 * @map: Pointer to EFI memory map table
368 * @size: Size of table in bytes
369 * @skip_bs: True to skip boot-time memory and merge it with conventional
370 * memory. This will significantly reduce the number of table
372 * @return pointer to the new table. It should be freed with free() by the
375 void *efi_build_mem_table(struct efi_entry_memmap *map, int size, bool skip_bs);
377 #endif /* _LINUX_EFI_H */