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;
87 uint16_t *efi_dp_str(struct efi_device_path *dp);
89 extern const efi_guid_t efi_global_variable_guid;
90 extern const efi_guid_t efi_guid_console_control;
91 extern const efi_guid_t efi_guid_device_path;
92 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
93 extern const efi_guid_t efi_guid_driver_binding_protocol;
94 extern const efi_guid_t efi_guid_loaded_image;
95 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
96 extern const efi_guid_t efi_simple_file_system_protocol_guid;
97 extern const efi_guid_t efi_file_info_guid;
99 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
100 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
103 * When a protocol is opened a open protocol info entry is created.
104 * These are maintained in a list.
106 struct efi_open_protocol_info_item {
107 /* Link to the list of open protocol info entries of a protocol */
108 struct list_head link;
109 struct efi_open_protocol_info_entry info;
113 * When the UEFI payload wants to open a protocol on an object to get its
114 * interface (usually a struct with callback functions), this struct maps the
115 * protocol GUID to the respective protocol interface
118 /* Link to the list of protocols of a handle */
119 struct list_head link;
120 const efi_guid_t *guid;
121 void *protocol_interface;
122 /* Link to the list of open protocol info items */
123 struct list_head open_infos;
127 * UEFI has a poor man's OO model where one "object" can be polymorphic and have
128 * multiple different protocols (classes) attached to it.
130 * This struct is the parent struct for all of our actual implementation objects
131 * that can include it to make themselves an EFI object
134 /* Every UEFI object is part of a global object list */
135 struct list_head link;
136 /* The list of protocols */
137 struct list_head protocols;
138 /* The object spawner can either use this for data or as identifier */
145 * @type: Type of event, see efi_create_event
146 * @notify_tpl: Task priority level of notifications
147 * @trigger_time: Period of the timer
148 * @trigger_next: Next time to trigger the timer
149 * @nofify_function: Function to call when the event is triggered
150 * @notify_context: Data to be passed to the notify function
151 * @trigger_type: Type of timer, see efi_set_timer
152 * @queued: The notification function is queued
153 * @signaled: The event occurred. The event is in the signaled state.
157 efi_uintn_t notify_tpl;
158 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
159 void *notify_context;
162 enum efi_timer_delay trigger_type;
168 /* This list contains all UEFI objects we know of */
169 extern struct list_head efi_obj_list;
171 /* Called by bootefi to make console interface available */
172 int efi_console_register(void);
173 /* Called by bootefi to make all disk storage accessible as EFI objects */
174 int efi_disk_register(void);
175 /* Called by bootefi to make GOP (graphical) interface available */
176 int efi_gop_register(void);
177 /* Called by bootefi to make the network interface available */
178 int efi_net_register(void);
179 /* Called by bootefi to make the watchdog available */
180 int efi_watchdog_register(void);
181 /* Called by bootefi to make SMBIOS tables available */
182 void efi_smbios_register(void);
184 struct efi_simple_file_system_protocol *
185 efi_fs_from_path(struct efi_device_path *fp);
187 /* Called by networking code to memorize the dhcp ack package */
188 void efi_net_set_dhcp_ack(void *pkt, int len);
189 /* Called by efi_set_watchdog_timer to reset the timer */
190 efi_status_t efi_set_watchdog(unsigned long timeout);
192 /* Called from places to check whether a timer expired */
193 void efi_timer_check(void);
194 /* PE loader implementation */
195 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
196 /* Called once to store the pristine gd pointer */
197 void efi_save_gd(void);
198 /* Special case handler for error/abort that just tries to dtrt to get
199 * back to u-boot world */
200 void efi_restore_gd(void);
201 /* Call this to relocate the runtime section to an address space */
202 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
203 /* Call this to set the current device name */
204 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
205 /* Add a new object to the object list. */
206 void efi_add_handle(struct efi_object *obj);
208 efi_status_t efi_create_handle(efi_handle_t *handle);
210 void efi_delete_handle(struct efi_object *obj);
211 /* Call this to validate a handle and find the EFI object for it */
212 struct efi_object *efi_search_obj(const efi_handle_t handle);
213 /* Find a protocol on a handle */
214 efi_status_t efi_search_protocol(const efi_handle_t handle,
215 const efi_guid_t *protocol_guid,
216 struct efi_handler **handler);
217 /* Install new protocol on a handle */
218 efi_status_t efi_add_protocol(const efi_handle_t handle,
219 const efi_guid_t *protocol,
220 void *protocol_interface);
221 /* Delete protocol from a handle */
222 efi_status_t efi_remove_protocol(const efi_handle_t handle,
223 const efi_guid_t *protocol,
224 void *protocol_interface);
225 /* Delete all protocols from a handle */
226 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
227 /* Call this to create an event */
228 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
229 void (EFIAPI *notify_function) (
230 struct efi_event *event,
232 void *notify_context, struct efi_event **event);
233 /* Call this to set a timer */
234 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
235 uint64_t trigger_time);
236 /* Call this to signal an event */
237 void efi_signal_event(struct efi_event *event);
239 /* open file system: */
240 struct efi_simple_file_system_protocol *efi_simple_file_system(
241 struct blk_desc *desc, int part, struct efi_device_path *dp);
243 /* open file from device-path: */
244 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
247 /* Generic EFI memory allocator, call this to get memory */
248 void *efi_alloc(uint64_t len, int memory_type);
249 /* More specific EFI memory allocator, called by EFI payloads */
250 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
252 /* EFI memory free function. */
253 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
254 /* EFI memory allocator for small allocations */
255 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
257 /* EFI pool memory free function. */
258 efi_status_t efi_free_pool(void *buffer);
259 /* Returns the EFI memory map */
260 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
261 struct efi_mem_desc *memory_map,
262 efi_uintn_t *map_key,
263 efi_uintn_t *descriptor_size,
264 uint32_t *descriptor_version);
265 /* Adds a range into the EFI memory map */
266 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
267 bool overlap_only_ram);
268 /* Called by board init to initialize the EFI memory map */
269 int efi_memory_init(void);
270 /* Adds new or overrides configuration table entry to the system table */
271 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
272 /* Sets up a loaded image */
273 efi_status_t efi_setup_loaded_image(
274 struct efi_loaded_image *info, struct efi_object *obj,
275 struct efi_device_path *device_path,
276 struct efi_device_path *file_path);
277 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
280 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
281 extern void *efi_bounce_buffer;
282 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
286 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
287 int efi_dp_match(const struct efi_device_path *a,
288 const struct efi_device_path *b);
289 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
290 struct efi_device_path **rem);
291 unsigned efi_dp_size(const struct efi_device_path *dp);
292 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
293 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
294 const struct efi_device_path *dp2);
295 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
296 const struct efi_device_path *node);
299 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
300 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
301 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
303 struct efi_device_path *efi_dp_from_eth(void);
304 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
305 uint64_t start_address,
306 uint64_t end_address);
307 void efi_dp_split_file_path(struct efi_device_path *full_path,
308 struct efi_device_path **device_path,
309 struct efi_device_path **file_path);
311 #define EFI_DP_TYPE(_dp, _type, _subtype) \
312 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
313 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
315 /* Convert strings from normal C strings to uEFI strings */
316 static inline void ascii2unicode(u16 *unicode, const char *ascii)
319 *(unicode++) = *(ascii++);
322 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
324 return memcmp(g1, g2, sizeof(efi_guid_t));
328 * Use these to indicate that your code / data should go into the EFI runtime
329 * section and thus still be available when the OS is running
331 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
332 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
334 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
335 * to make it available at runtime */
336 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
338 /* Boards may provide the functions below to implement RTS functionality */
340 void __efi_runtime EFIAPI efi_reset_system(
341 enum efi_reset_type reset_type,
342 efi_status_t reset_status,
343 unsigned long data_size, void *reset_data);
344 void efi_reset_system_init(void);
346 efi_status_t __efi_runtime EFIAPI efi_get_time(
347 struct efi_time *time,
348 struct efi_time_cap *capabilities);
349 void efi_get_time_init(void);
351 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
353 * Entry point for the tests of the EFI API.
354 * It is called by 'bootefi selftest'
356 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
357 struct efi_system_table *systab);
360 efi_status_t EFIAPI efi_get_variable(s16 *variable_name,
361 efi_guid_t *vendor, u32 *attributes,
362 unsigned long *data_size, void *data);
363 efi_status_t EFIAPI efi_get_next_variable(
364 unsigned long *variable_name_size,
365 s16 *variable_name, efi_guid_t *vendor);
366 efi_status_t EFIAPI efi_set_variable(s16 *variable_name,
367 efi_guid_t *vendor, u32 attributes,
368 unsigned long data_size, void *data);
370 void *efi_bootmgr_load(struct efi_device_path **device_path,
371 struct efi_device_path **file_path);
373 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
375 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
376 #define __efi_runtime_data
377 #define __efi_runtime
378 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
380 /* No loader configured, stub out EFI_ENTRY */
381 static inline void efi_restore_gd(void) { }
382 static inline void efi_set_bootdev(const char *dev, const char *devnr,
383 const char *path) { }
384 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
386 #endif /* CONFIG_EFI_LOADER && !CONFIG_SPL_BUILD */
388 #endif /* _EFI_LOADER_H */