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