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