efi_loader: add file/filesys support
[platform/kernel/u-boot.git] / 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 #ifdef CONFIG_EFI_STUB_64BIT
23 /* EFI uses the Microsoft ABI which is not the default for GCC */
24 #define EFIAPI __attribute__((ms_abi))
25 #else
26 #define EFIAPI asmlinkage
27 #endif
28
29 struct efi_device_path;
30
31 typedef struct {
32         u8 b[16];
33 } efi_guid_t;
34
35 #define EFI_BITS_PER_LONG       BITS_PER_LONG
36
37 /*
38  * With 64-bit EFI stub, EFI_BITS_PER_LONG has to be 64. EFI_STUB is set
39  * in lib/efi/Makefile, when building the stub.
40  */
41 #if defined(CONFIG_EFI_STUB_64BIT) && defined(EFI_STUB)
42 #undef EFI_BITS_PER_LONG
43 #define EFI_BITS_PER_LONG       64
44 #endif
45
46 /* Bit mask for EFI status code with error */
47 #define EFI_ERROR_MASK (1UL << (EFI_BITS_PER_LONG - 1))
48 /* Status codes returned by EFI protocols */
49 #define EFI_SUCCESS                     0
50 #define EFI_LOAD_ERROR                  (EFI_ERROR_MASK | 1)
51 #define EFI_INVALID_PARAMETER           (EFI_ERROR_MASK | 2)
52 #define EFI_UNSUPPORTED                 (EFI_ERROR_MASK | 3)
53 #define EFI_BAD_BUFFER_SIZE             (EFI_ERROR_MASK | 4)
54 #define EFI_BUFFER_TOO_SMALL            (EFI_ERROR_MASK | 5)
55 #define EFI_NOT_READY                   (EFI_ERROR_MASK | 6)
56 #define EFI_DEVICE_ERROR                (EFI_ERROR_MASK | 7)
57 #define EFI_WRITE_PROTECTED             (EFI_ERROR_MASK | 8)
58 #define EFI_OUT_OF_RESOURCES            (EFI_ERROR_MASK | 9)
59 #define EFI_VOLUME_CORRUPTED            (EFI_ERROR_MASK | 10)
60 #define EFI_VOLUME_FULL                 (EFI_ERROR_MASK | 11)
61 #define EFI_NO_MEDIA                    (EFI_ERROR_MASK | 12)
62 #define EFI_MEDIA_CHANGED               (EFI_ERROR_MASK | 13)
63 #define EFI_NOT_FOUND                   (EFI_ERROR_MASK | 14)
64 #define EFI_ACCESS_DENIED               (EFI_ERROR_MASK | 15)
65 #define EFI_NO_RESPONSE                 (EFI_ERROR_MASK | 16)
66 #define EFI_NO_MAPPING                  (EFI_ERROR_MASK | 17)
67 #define EFI_TIMEOUT                     (EFI_ERROR_MASK | 18)
68 #define EFI_NOT_STARTED                 (EFI_ERROR_MASK | 19)
69 #define EFI_ALREADY_STARTED             (EFI_ERROR_MASK | 20)
70 #define EFI_ABORTED                     (EFI_ERROR_MASK | 21)
71 #define EFI_ICMP_ERROR                  (EFI_ERROR_MASK | 22)
72 #define EFI_TFTP_ERROR                  (EFI_ERROR_MASK | 23)
73 #define EFI_PROTOCOL_ERROR              (EFI_ERROR_MASK | 24)
74 #define EFI_INCOMPATIBLE_VERSION        (EFI_ERROR_MASK | 25)
75 #define EFI_SECURITY_VIOLATION          (EFI_ERROR_MASK | 26)
76 #define EFI_CRC_ERROR                   (EFI_ERROR_MASK | 27)
77 #define EFI_END_OF_MEDIA                (EFI_ERROR_MASK | 28)
78 #define EFI_END_OF_FILE                 (EFI_ERROR_MASK | 31)
79 #define EFI_INVALID_LANGUAGE            (EFI_ERROR_MASK | 32)
80 #define EFI_COMPROMISED_DATA            (EFI_ERROR_MASK | 33)
81 #define EFI_IP_ADDRESS_CONFLICT         (EFI_ERROR_MASK | 34)
82 #define EFI_HTTP_ERROR                  (EFI_ERROR_MASK | 35)
83
84 #define EFI_WARN_DELETE_FAILURE 2
85
86 typedef unsigned long efi_status_t;
87 typedef u64 efi_physical_addr_t;
88 typedef u64 efi_virtual_addr_t;
89 typedef void *efi_handle_t;
90
91 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
92         ((efi_guid_t) \
93         {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
94                 ((a) >> 24) & 0xff, \
95                 (b) & 0xff, ((b) >> 8) & 0xff, \
96                 (c) & 0xff, ((c) >> 8) & 0xff, \
97                 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } })
98
99 /* Generic EFI table header */
100 struct efi_table_hdr {
101         u64 signature;
102         u32 revision;
103         u32 headersize;
104         u32 crc32;
105         u32 reserved;
106 };
107
108 /* Enumeration of memory types introduced in UEFI */
109 enum efi_mem_type {
110         EFI_RESERVED_MEMORY_TYPE,
111         /*
112          * The code portions of a loaded application.
113          * (Note that UEFI OS loaders are UEFI applications.)
114          */
115         EFI_LOADER_CODE,
116         /*
117          * The data portions of a loaded application and
118          * the default data allocation type used by an application
119          * to allocate pool memory.
120          */
121         EFI_LOADER_DATA,
122         /* The code portions of a loaded Boot Services Driver */
123         EFI_BOOT_SERVICES_CODE,
124         /*
125          * The data portions of a loaded Boot Services Driver and
126          * the default data allocation type used by a Boot Services
127          * Driver to allocate pool memory.
128          */
129         EFI_BOOT_SERVICES_DATA,
130         /* The code portions of a loaded Runtime Services Driver */
131         EFI_RUNTIME_SERVICES_CODE,
132         /*
133          * The data portions of a loaded Runtime Services Driver and
134          * the default data allocation type used by a Runtime Services
135          * Driver to allocate pool memory.
136          */
137         EFI_RUNTIME_SERVICES_DATA,
138         /* Free (unallocated) memory */
139         EFI_CONVENTIONAL_MEMORY,
140         /* Memory in which errors have been detected */
141         EFI_UNUSABLE_MEMORY,
142         /* Memory that holds the ACPI tables */
143         EFI_ACPI_RECLAIM_MEMORY,
144         /* Address space reserved for use by the firmware */
145         EFI_ACPI_MEMORY_NVS,
146         /*
147          * Used by system firmware to request that a memory-mapped IO region
148          * be mapped by the OS to a virtual address so it can be accessed by
149          * EFI runtime services.
150          */
151         EFI_MMAP_IO,
152         /*
153          * System memory-mapped IO region that is used to translate
154          * memory cycles to IO cycles by the processor.
155          */
156         EFI_MMAP_IO_PORT,
157         /*
158          * Address space reserved by the firmware for code that is
159          * part of the processor.
160          */
161         EFI_PAL_CODE,
162
163         EFI_MAX_MEMORY_TYPE,
164         EFI_TABLE_END,  /* For efi_build_mem_table() */
165 };
166
167 /* Attribute values */
168 enum {
169         EFI_MEMORY_UC_SHIFT     = 0,    /* uncached */
170         EFI_MEMORY_WC_SHIFT     = 1,    /* write-coalescing */
171         EFI_MEMORY_WT_SHIFT     = 2,    /* write-through */
172         EFI_MEMORY_WB_SHIFT     = 3,    /* write-back */
173         EFI_MEMORY_UCE_SHIFT    = 4,    /* uncached, exported */
174         EFI_MEMORY_WP_SHIFT     = 12,   /* write-protect */
175         EFI_MEMORY_RP_SHIFT     = 13,   /* read-protect */
176         EFI_MEMORY_XP_SHIFT     = 14,   /* execute-protect */
177         EFI_MEMORY_RUNTIME_SHIFT = 63,  /* range requires runtime mapping */
178
179         EFI_MEMORY_RUNTIME = 1ULL << EFI_MEMORY_RUNTIME_SHIFT,
180         EFI_MEM_DESC_VERSION    = 1,
181 };
182
183 #define EFI_PAGE_SHIFT          12
184 #define EFI_PAGE_SIZE           (1UL << EFI_PAGE_SHIFT)
185 #define EFI_PAGE_MASK           (EFI_PAGE_SIZE - 1)
186
187 struct efi_mem_desc {
188         u32 type;
189         u32 reserved;
190         efi_physical_addr_t physical_start;
191         efi_virtual_addr_t virtual_start;
192         u64 num_pages;
193         u64 attribute;
194 };
195
196 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
197
198 /* Allocation types for calls to boottime->allocate_pages*/
199 #define EFI_ALLOCATE_ANY_PAGES          0
200 #define EFI_ALLOCATE_MAX_ADDRESS        1
201 #define EFI_ALLOCATE_ADDRESS            2
202 #define EFI_MAX_ALLOCATE_TYPE           3
203
204 /* Types and defines for Time Services */
205 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
206 #define EFI_TIME_IN_DAYLIGHT     0x2
207 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
208
209 struct efi_time {
210         u16 year;
211         u8 month;
212         u8 day;
213         u8 hour;
214         u8 minute;
215         u8 second;
216         u8 pad1;
217         u32 nanosecond;
218         s16 timezone;
219         u8 daylight;
220         u8 pad2;
221 };
222
223 struct efi_time_cap {
224         u32 resolution;
225         u32 accuracy;
226         u8 sets_to_zero;
227 };
228
229 enum efi_locate_search_type {
230         all_handles,
231         by_register_notify,
232         by_protocol
233 };
234
235 struct efi_open_protocol_info_entry {
236         efi_handle_t agent_handle;
237         efi_handle_t controller_handle;
238         u32 attributes;
239         u32 open_count;
240 };
241
242 enum efi_entry_t {
243         EFIET_END,      /* Signals this is the last (empty) entry */
244         EFIET_MEMORY_MAP,
245
246         /* Number of entries */
247         EFIET_MEMORY_COUNT,
248 };
249
250 #define EFI_TABLE_VERSION       1
251
252 /**
253  * struct efi_info_hdr - Header for the EFI info table
254  *
255  * @version:    EFI_TABLE_VERSION
256  * @hdr_size:   Size of this struct in bytes
257  * @total_size: Total size of this header plus following data
258  * @spare:      Spare space for expansion
259  */
260 struct efi_info_hdr {
261         u32 version;
262         u32 hdr_size;
263         u32 total_size;
264         u32 spare[5];
265 };
266
267 /**
268  * struct efi_entry_hdr - Header for a table entry
269  *
270  * @type:       enum eft_entry_t
271  * @size        size of entry bytes excluding header and padding
272  * @addr:       address of this entry (0 if it follows the header )
273  * @link:       size of entry including header and padding
274  * @spare1:     Spare space for expansion
275  * @spare2:     Spare space for expansion
276  */
277 struct efi_entry_hdr {
278         u32 type;
279         u32 size;
280         u64 addr;
281         u32 link;
282         u32 spare1;
283         u64 spare2;
284 };
285
286 /**
287  * struct efi_entry_memmap - a memory map table passed to U-Boot
288  *
289  * @version:    EFI's memory map table version
290  * @desc_size:  EFI's size of each memory descriptor
291  * @spare:      Spare space for expansion
292  * @desc:       An array of descriptors, each @desc_size bytes apart
293  */
294 struct efi_entry_memmap {
295         u32 version;
296         u32 desc_size;
297         u64 spare;
298         struct efi_mem_desc desc[];
299 };
300
301 static inline struct efi_mem_desc *efi_get_next_mem_desc(
302                 struct efi_entry_memmap *map, struct efi_mem_desc *desc)
303 {
304         return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
305 }
306
307 struct efi_priv {
308         efi_handle_t parent_image;
309         struct efi_device_path *device_path;
310         struct efi_system_table *sys_table;
311         struct efi_boot_services *boot;
312         struct efi_runtime_services *run;
313         bool use_pool_for_malloc;
314         unsigned long ram_base;
315         unsigned int image_data_type;
316         struct efi_info_hdr *info;
317         unsigned int info_size;
318         void *next_hdr;
319 };
320
321 /* Base address of the EFI image */
322 extern char image_base[];
323
324 /* Start and end of U-Boot image (for payload) */
325 extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
326
327 /**
328  * efi_get_sys_table() - Get access to the main EFI system table
329  *
330  * @return pointer to EFI system table
331  */
332
333 struct efi_system_table *efi_get_sys_table(void);
334
335 /**
336  * efi_get_ram_base() - Find the base of RAM
337  *
338  * This is used when U-Boot is built as an EFI application.
339  *
340  * @return the base of RAM as known to U-Boot
341  */
342 unsigned long efi_get_ram_base(void);
343
344 /**
345  * efi_init() - Set up ready for use of EFI boot services
346  *
347  * @priv:       Pointer to our private EFI structure to fill in
348  * @banner:     Banner to display when starting
349  * @image:      The image handle passed to efi_main()
350  * @sys_table:  The EFI system table pointer passed to efi_main()
351  */
352 int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image,
353              struct efi_system_table *sys_table);
354
355 /**
356  * efi_malloc() - Allocate some memory from EFI
357  *
358  * @priv:       Pointer to private EFI structure
359  * @size:       Number of bytes to allocate
360  * @retp:       Return EFI status result
361  * @return pointer to memory allocated, or NULL on error
362  */
363 void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp);
364
365 /**
366  * efi_free() - Free memory allocated from EFI
367  *
368  * @priv:       Pointer to private EFI structure
369  * @ptr:        Pointer to memory to free
370  */
371 void efi_free(struct efi_priv *priv, void *ptr);
372
373 /**
374  * efi_puts() - Write out a string to the EFI console
375  *
376  * @priv:       Pointer to private EFI structure
377  * @str:        String to write (note this is a ASCII, not unicode)
378  */
379 void efi_puts(struct efi_priv *priv, const char *str);
380
381 /**
382  * efi_putc() - Write out a character to the EFI console
383  *
384  * @priv:       Pointer to private EFI structure
385  * @ch:         Character to write (note this is not unicode)
386  */
387 void efi_putc(struct efi_priv *priv, const char ch);
388
389 /**
390  * efi_info_get() - get an entry from an EFI table
391  *
392  * @type:       Entry type to search for
393  * @datap:      Returns pointer to entry data
394  * @sizep:      Returns pointer to entry size
395  * @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
396  * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
397  */
398 int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);
399
400 /**
401  * efi_build_mem_table() - make a sorted copy of the memory table
402  *
403  * @map:        Pointer to EFI memory map table
404  * @size:       Size of table in bytes
405  * @skip_bs:    True to skip boot-time memory and merge it with conventional
406  *              memory. This will significantly reduce the number of table
407  *              entries.
408  * @return pointer to the new table. It should be freed with free() by the
409  *         caller
410  */
411 void *efi_build_mem_table(struct efi_entry_memmap *map, int size, bool skip_bs);
412
413 #endif /* _LINUX_EFI_H */