2 * EFI application loader
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
10 #define _EFI_LOADER_H 1
16 /* No need for efi loader support in SPL */
17 #if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
19 #include <linux/list.h>
21 int __efi_entry_check(void);
22 int __efi_exit_check(void);
23 const char *__efi_nesting(void);
24 const char *__efi_nesting_inc(void);
25 const char *__efi_nesting_dec(void);
28 * Enter the u-boot world from UEFI:
30 #define EFI_ENTRY(format, ...) do { \
31 assert(__efi_entry_check()); \
32 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
33 __func__, ##__VA_ARGS__); \
37 * Exit the u-boot world back to UEFI:
39 #define EFI_EXIT(ret) ({ \
40 typeof(ret) _r = ret; \
41 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
42 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
43 assert(__efi_exit_check()); \
48 * Call non-void UEFI function from u-boot and retrieve return value:
50 #define EFI_CALL(exp) ({ \
51 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
52 assert(__efi_exit_check()); \
53 typeof(exp) _r = exp; \
54 assert(__efi_entry_check()); \
55 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
56 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
61 * Call void UEFI function from u-boot:
63 #define EFI_CALL_VOID(exp) do { \
64 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
65 assert(__efi_exit_check()); \
67 assert(__efi_entry_check()); \
68 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
72 * Write an indented message with EFI prefix
74 #define EFI_PRINT(format, ...) ({ \
75 debug("%sEFI: " format, __efi_nesting(), \
79 extern struct efi_runtime_services efi_runtime_services;
80 extern struct efi_system_table systab;
82 extern struct efi_simple_text_output_protocol efi_con_out;
83 extern struct efi_simple_input_interface efi_con_in;
84 extern struct efi_console_control_protocol efi_console_control;
85 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
86 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
87 extern const struct efi_device_path_utilities_protocol
88 efi_device_path_utilities;
90 uint16_t *efi_dp_str(struct efi_device_path *dp);
92 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
93 extern const efi_guid_t efi_block_io_guid;
94 extern const efi_guid_t efi_global_variable_guid;
95 extern const efi_guid_t efi_guid_console_control;
96 extern const efi_guid_t efi_guid_device_path;
97 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
98 extern const efi_guid_t efi_guid_driver_binding_protocol;
99 /* event group ExitBootServices() invoked */
100 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
101 /* event group SetVirtualAddressMap() invoked */
102 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
103 /* event group memory map changed */
104 extern const efi_guid_t efi_guid_event_group_memory_map_change;
105 /* event group boot manager about to boot */
106 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
107 /* event group ResetSystem() invoked (before ExitBootServices) */
108 extern const efi_guid_t efi_guid_event_group_reset_system;
109 /* GUID of the device tree table */
110 extern const efi_guid_t efi_guid_fdt;
111 extern const efi_guid_t efi_guid_loaded_image;
112 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
113 extern const efi_guid_t efi_simple_file_system_protocol_guid;
114 extern const efi_guid_t efi_file_info_guid;
115 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
117 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
118 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
121 * When a protocol is opened a open protocol info entry is created.
122 * These are maintained in a list.
124 struct efi_open_protocol_info_item {
125 /* Link to the list of open protocol info entries of a protocol */
126 struct list_head link;
127 struct efi_open_protocol_info_entry info;
131 * When the UEFI payload wants to open a protocol on an object to get its
132 * interface (usually a struct with callback functions), this struct maps the
133 * protocol GUID to the respective protocol interface
136 /* Link to the list of protocols of a handle */
137 struct list_head link;
138 const efi_guid_t *guid;
139 void *protocol_interface;
140 /* Link to the list of open protocol info items */
141 struct list_head open_infos;
145 * UEFI has a poor man's OO model where one "object" can be polymorphic and have
146 * multiple different protocols (classes) attached to it.
148 * This struct is the parent struct for all of our actual implementation objects
149 * that can include it to make themselves an EFI object
152 /* Every UEFI object is part of a global object list */
153 struct list_head link;
154 /* The list of protocols */
155 struct list_head protocols;
156 /* The object spawner can either use this for data or as identifier */
163 * @link: Link to list of all events
164 * @type: Type of event, see efi_create_event
165 * @notify_tpl: Task priority level of notifications
166 * @nofify_function: Function to call when the event is triggered
167 * @notify_context: Data to be passed to the notify function
168 * @group: Event group
169 * @trigger_time: Period of the timer
170 * @trigger_next: Next time to trigger the timer
171 * @trigger_type: Type of timer, see efi_set_timer
172 * @is_queued: The notification function is queued
173 * @is_signaled: The event occurred. The event is in the signaled state.
176 struct list_head link;
178 efi_uintn_t notify_tpl;
179 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
180 void *notify_context;
181 const efi_guid_t *group;
184 enum efi_timer_delay trigger_type;
189 /* This list contains all UEFI objects we know of */
190 extern struct list_head efi_obj_list;
191 /* List of all events */
192 extern struct list_head efi_events;
194 /* Called by bootefi to make console interface available */
195 int efi_console_register(void);
196 /* Called by bootefi to make all disk storage accessible as EFI objects */
197 efi_status_t efi_disk_register(void);
198 /* Create handles and protocols for the partitions of a block device */
199 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
200 const char *if_typename, int diskid,
201 const char *pdevname);
202 /* Called by bootefi to make GOP (graphical) interface available */
203 efi_status_t efi_gop_register(void);
204 /* Called by bootefi to make the network interface available */
205 efi_status_t efi_net_register(void);
206 /* Called by bootefi to make the watchdog available */
207 efi_status_t efi_watchdog_register(void);
208 /* Called by bootefi to make SMBIOS tables available */
209 efi_status_t efi_smbios_register(void);
211 struct efi_simple_file_system_protocol *
212 efi_fs_from_path(struct efi_device_path *fp);
214 /* Called by networking code to memorize the dhcp ack package */
215 void efi_net_set_dhcp_ack(void *pkt, int len);
216 /* Called by efi_set_watchdog_timer to reset the timer */
217 efi_status_t efi_set_watchdog(unsigned long timeout);
219 /* Called from places to check whether a timer expired */
220 void efi_timer_check(void);
221 /* PE loader implementation */
222 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
223 /* Called once to store the pristine gd pointer */
224 void efi_save_gd(void);
225 /* Special case handler for error/abort that just tries to dtrt to get
226 * back to u-boot world */
227 void efi_restore_gd(void);
228 /* Call this to relocate the runtime section to an address space */
229 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
230 /* Call this to set the current device name */
231 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
232 /* Add a new object to the object list. */
233 void efi_add_handle(struct efi_object *obj);
235 efi_status_t efi_create_handle(efi_handle_t *handle);
237 void efi_delete_handle(struct efi_object *obj);
238 /* Call this to validate a handle and find the EFI object for it */
239 struct efi_object *efi_search_obj(const efi_handle_t handle);
240 /* Find a protocol on a handle */
241 efi_status_t efi_search_protocol(const efi_handle_t handle,
242 const efi_guid_t *protocol_guid,
243 struct efi_handler **handler);
244 /* Install new protocol on a handle */
245 efi_status_t efi_add_protocol(const efi_handle_t handle,
246 const efi_guid_t *protocol,
247 void *protocol_interface);
248 /* Delete protocol from a handle */
249 efi_status_t efi_remove_protocol(const efi_handle_t handle,
250 const efi_guid_t *protocol,
251 void *protocol_interface);
252 /* Delete all protocols from a handle */
253 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
254 /* Call this to create an event */
255 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
256 void (EFIAPI *notify_function) (
257 struct efi_event *event,
259 void *notify_context, efi_guid_t *group,
260 struct efi_event **event);
261 /* Call this to set a timer */
262 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
263 uint64_t trigger_time);
264 /* Call this to signal an event */
265 void efi_signal_event(struct efi_event *event, bool check_tpl);
267 /* open file system: */
268 struct efi_simple_file_system_protocol *efi_simple_file_system(
269 struct blk_desc *desc, int part, struct efi_device_path *dp);
271 /* open file from device-path: */
272 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
275 /* Generic EFI memory allocator, call this to get memory */
276 void *efi_alloc(uint64_t len, int memory_type);
277 /* More specific EFI memory allocator, called by EFI payloads */
278 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
280 /* EFI memory free function. */
281 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
282 /* EFI memory allocator for small allocations */
283 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
285 /* EFI pool memory free function. */
286 efi_status_t efi_free_pool(void *buffer);
287 /* Returns the EFI memory map */
288 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
289 struct efi_mem_desc *memory_map,
290 efi_uintn_t *map_key,
291 efi_uintn_t *descriptor_size,
292 uint32_t *descriptor_version);
293 /* Adds a range into the EFI memory map */
294 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
295 bool overlap_only_ram);
296 /* Called by board init to initialize the EFI drivers */
297 efi_status_t efi_driver_init(void);
298 /* Called by board init to initialize the EFI memory map */
299 int efi_memory_init(void);
300 /* Adds new or overrides configuration table entry to the system table */
301 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
302 /* Sets up a loaded image */
303 efi_status_t efi_setup_loaded_image(
304 struct efi_loaded_image *info, struct efi_object *obj,
305 struct efi_device_path *device_path,
306 struct efi_device_path *file_path);
307 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
310 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
311 extern void *efi_bounce_buffer;
312 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
316 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
317 int efi_dp_match(const struct efi_device_path *a,
318 const struct efi_device_path *b);
319 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
320 struct efi_device_path **rem);
321 unsigned efi_dp_size(const struct efi_device_path *dp);
322 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
323 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
324 const struct efi_device_path *dp2);
325 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
326 const struct efi_device_path *node);
329 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
330 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
331 /* Create a device node for a block device partition. */
332 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
333 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
335 struct efi_device_path *efi_dp_from_eth(void);
336 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
337 uint64_t start_address,
338 uint64_t end_address);
339 /* Determine the last device path node that is not the end node. */
340 const struct efi_device_path *efi_dp_last_node(
341 const struct efi_device_path *dp);
342 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
343 struct efi_device_path **device_path,
344 struct efi_device_path **file_path);
346 #define EFI_DP_TYPE(_dp, _type, _subtype) \
347 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
348 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
350 /* Convert strings from normal C strings to uEFI strings */
351 static inline void ascii2unicode(u16 *unicode, const char *ascii)
354 *(unicode++) = *(ascii++);
357 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
359 return memcmp(g1, g2, sizeof(efi_guid_t));
363 * Use these to indicate that your code / data should go into the EFI runtime
364 * section and thus still be available when the OS is running
366 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
367 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
369 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
370 * to make it available at runtime */
371 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
373 /* Boards may provide the functions below to implement RTS functionality */
375 void __efi_runtime EFIAPI efi_reset_system(
376 enum efi_reset_type reset_type,
377 efi_status_t reset_status,
378 unsigned long data_size, void *reset_data);
380 /* Architecture specific initialization of the EFI subsystem */
381 efi_status_t efi_reset_system_init(void);
383 efi_status_t __efi_runtime EFIAPI efi_get_time(
384 struct efi_time *time,
385 struct efi_time_cap *capabilities);
386 efi_status_t efi_get_time_init(void);
388 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
390 * Entry point for the tests of the EFI API.
391 * It is called by 'bootefi selftest'
393 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
394 struct efi_system_table *systab);
397 efi_status_t EFIAPI efi_get_variable(s16 *variable_name,
398 efi_guid_t *vendor, u32 *attributes,
399 unsigned long *data_size, void *data);
400 efi_status_t EFIAPI efi_get_next_variable(
401 unsigned long *variable_name_size,
402 s16 *variable_name, efi_guid_t *vendor);
403 efi_status_t EFIAPI efi_set_variable(s16 *variable_name,
404 efi_guid_t *vendor, u32 attributes,
405 unsigned long data_size, void *data);
407 void *efi_bootmgr_load(struct efi_device_path **device_path,
408 struct efi_device_path **file_path);
410 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
412 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
413 #define __efi_runtime_data
414 #define __efi_runtime
415 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
420 /* No loader configured, stub out EFI_ENTRY */
421 static inline void efi_restore_gd(void) { }
422 static inline void efi_set_bootdev(const char *dev, const char *devnr,
423 const char *path) { }
424 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
426 #endif /* CONFIG_EFI_LOADER && !CONFIG_SPL_BUILD */
428 #endif /* _EFI_LOADER_H */