2 * EFI application loader
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
13 /* No need for efi loader support in SPL */
14 #if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
16 #include <linux/list.h>
18 int __efi_entry_check(void);
19 int __efi_exit_check(void);
20 const char *__efi_nesting(void);
21 const char *__efi_nesting_inc(void);
22 const char *__efi_nesting_dec(void);
25 * Enter the u-boot world from UEFI:
27 #define EFI_ENTRY(format, ...) do { \
28 assert(__efi_entry_check()); \
29 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
30 __func__, ##__VA_ARGS__); \
34 * Exit the u-boot world back to UEFI:
36 #define EFI_EXIT(ret) ({ \
37 typeof(ret) _r = ret; \
38 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
39 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
40 assert(__efi_exit_check()); \
45 * Call non-void UEFI function from u-boot and retrieve return value:
47 #define EFI_CALL(exp) ({ \
48 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
49 assert(__efi_exit_check()); \
50 typeof(exp) _r = exp; \
51 assert(__efi_entry_check()); \
52 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
53 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
58 * Call void UEFI function from u-boot:
60 #define EFI_CALL_VOID(exp) do { \
61 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
62 assert(__efi_exit_check()); \
64 assert(__efi_entry_check()); \
65 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
71 #define EFI_PRINT_GUID(txt, guid) ({ \
72 debug("%sEFI: %s %pUl\n", __efi_nesting(), txt, guid); \
75 extern struct efi_runtime_services efi_runtime_services;
76 extern struct efi_system_table systab;
78 extern const struct efi_simple_text_output_protocol efi_con_out;
79 extern struct efi_simple_input_interface efi_con_in;
80 extern const struct efi_console_control_protocol efi_console_control;
81 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
83 extern const efi_guid_t efi_guid_console_control;
84 extern const efi_guid_t efi_guid_device_path;
85 extern const efi_guid_t efi_guid_loaded_image;
86 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
88 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
89 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
92 * When the UEFI payload wants to open a protocol on an object to get its
93 * interface (usually a struct with callback functions), this struct maps the
94 * protocol GUID to the respective protocol interface */
96 const efi_guid_t *guid;
97 void *protocol_interface;
101 * UEFI has a poor man's OO model where one "object" can be polymorphic and have
102 * multiple different protocols (classes) attached to it.
104 * This struct is the parent struct for all of our actual implementation objects
105 * that can include it to make themselves an EFI object
108 /* Every UEFI object is part of a global object list */
109 struct list_head link;
110 /* We support up to 8 "protocols" an object can be accessed through */
111 struct efi_handler protocols[8];
112 /* The object spawner can either use this for data or as identifier */
116 #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){ \
119 .protocol_interface = (void *)(_protocol), \
121 .handle = (void *)(_protocol), \
127 * @type: Type of event, see efi_create_event
128 * @notify_tpl: Task priority level of notifications
129 * @trigger_time: Period of the timer
130 * @trigger_next: Next time to trigger the timer
131 * @nofify_function: Function to call when the event is triggered
132 * @notify_context: Data to be passed to the notify function
133 * @trigger_type: Type of timer, see efi_set_timer
134 * @signaled: The notify function was already called
139 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
140 void *notify_context;
143 enum efi_timer_delay trigger_type;
148 /* This list contains all UEFI objects we know of */
149 extern struct list_head efi_obj_list;
151 /* Called by bootefi to make console interface available */
152 int efi_console_register(void);
153 /* Called by bootefi to make all disk storage accessible as EFI objects */
154 int efi_disk_register(void);
155 /* Called by bootefi to make GOP (graphical) interface available */
156 int efi_gop_register(void);
157 /* Called by bootefi to make the network interface available */
158 int efi_net_register(void **handle);
159 /* Called by bootefi to make SMBIOS tables available */
160 void efi_smbios_register(void);
162 /* Called by networking code to memorize the dhcp ack package */
163 void efi_net_set_dhcp_ack(void *pkt, int len);
165 /* Called from places to check whether a timer expired */
166 void efi_timer_check(void);
167 /* PE loader implementation */
168 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
169 /* Called once to store the pristine gd pointer */
170 void efi_save_gd(void);
171 /* Special case handler for error/abort that just tries to dtrt to get
172 * back to u-boot world */
173 void efi_restore_gd(void);
174 /* Call this to relocate the runtime section to an address space */
175 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
176 /* Call this to set the current device name */
177 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
178 /* Call this to create an event */
179 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl,
180 void (EFIAPI *notify_function) (
181 struct efi_event *event,
183 void *notify_context, struct efi_event **event);
184 /* Call this to set a timer */
185 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
186 uint64_t trigger_time);
187 /* Call this to signal an event */
188 void efi_signal_event(struct efi_event *event);
190 /* Generic EFI memory allocator, call this to get memory */
191 void *efi_alloc(uint64_t len, int memory_type);
192 /* More specific EFI memory allocator, called by EFI payloads */
193 efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
195 /* EFI memory free function. */
196 efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
197 /* EFI memory allocator for small allocations */
198 efi_status_t efi_allocate_pool(int pool_type, unsigned long size,
200 /* EFI pool memory free function. */
201 efi_status_t efi_free_pool(void *buffer);
202 /* Returns the EFI memory map */
203 efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
204 struct efi_mem_desc *memory_map,
205 unsigned long *map_key,
206 unsigned long *descriptor_size,
207 uint32_t *descriptor_version);
208 /* Adds a range into the EFI memory map */
209 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
210 bool overlap_only_ram);
211 /* Called by board init to initialize the EFI memory map */
212 int efi_memory_init(void);
213 /* Adds new or overrides configuration table entry to the system table */
214 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
216 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
217 extern void *efi_bounce_buffer;
218 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
221 /* Convert strings from normal C strings to uEFI strings */
222 static inline void ascii2unicode(u16 *unicode, const char *ascii)
225 *(unicode++) = *(ascii++);
228 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
230 return memcmp(g1, g2, sizeof(efi_guid_t));
234 * Use these to indicate that your code / data should go into the EFI runtime
235 * section and thus still be available when the OS is running
237 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
238 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
240 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
241 * to make it available at runtime */
242 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
244 /* Boards may provide the functions below to implement RTS functionality */
246 void __efi_runtime EFIAPI efi_reset_system(
247 enum efi_reset_type reset_type,
248 efi_status_t reset_status,
249 unsigned long data_size, void *reset_data);
250 void efi_reset_system_init(void);
252 efi_status_t __efi_runtime EFIAPI efi_get_time(
253 struct efi_time *time,
254 struct efi_time_cap *capabilities);
255 void efi_get_time_init(void);
257 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
259 * Entry point for the tests of the EFI API.
260 * It is called by 'bootefi selftest'
262 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
263 struct efi_system_table *systab);
266 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
268 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
269 #define __efi_runtime_data
270 #define __efi_runtime
271 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
273 /* No loader configured, stub out EFI_ENTRY */
274 static inline void efi_restore_gd(void) { }
275 static inline void efi_set_bootdev(const char *dev, const char *devnr,
276 const char *path) { }
277 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }