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 uint16_t *efi_dp_str(struct efi_device_path *dp);
85 extern const efi_guid_t efi_guid_console_control;
86 extern const efi_guid_t efi_guid_device_path;
87 extern const efi_guid_t efi_guid_loaded_image;
88 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
90 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
91 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
94 * When the UEFI payload wants to open a protocol on an object to get its
95 * interface (usually a struct with callback functions), this struct maps the
96 * protocol GUID to the respective protocol interface */
98 const efi_guid_t *guid;
99 void *protocol_interface;
103 * UEFI has a poor man's OO model where one "object" can be polymorphic and have
104 * multiple different protocols (classes) attached to it.
106 * This struct is the parent struct for all of our actual implementation objects
107 * that can include it to make themselves an EFI object
110 /* Every UEFI object is part of a global object list */
111 struct list_head link;
112 /* We support up to 8 "protocols" an object can be accessed through */
113 struct efi_handler protocols[8];
114 /* The object spawner can either use this for data or as identifier */
118 #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){ \
121 .protocol_interface = (void *)(_protocol), \
123 .handle = (void *)(_protocol), \
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 functionis queued
137 * @signaled: The event occured
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 SMBIOS tables available */
164 void efi_smbios_register(void);
166 /* Called by networking code to memorize the dhcp ack package */
167 void efi_net_set_dhcp_ack(void *pkt, int len);
169 /* Called from places to check whether a timer expired */
170 void efi_timer_check(void);
171 /* PE loader implementation */
172 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
173 /* Called once to store the pristine gd pointer */
174 void efi_save_gd(void);
175 /* Special case handler for error/abort that just tries to dtrt to get
176 * back to u-boot world */
177 void efi_restore_gd(void);
178 /* Call this to relocate the runtime section to an address space */
179 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
180 /* Call this to set the current device name */
181 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
182 /* Call this to create an event */
183 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl,
184 void (EFIAPI *notify_function) (
185 struct efi_event *event,
187 void *notify_context, struct efi_event **event);
188 /* Call this to set a timer */
189 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
190 uint64_t trigger_time);
191 /* Call this to signal an event */
192 void efi_signal_event(struct efi_event *event);
194 /* Generic EFI memory allocator, call this to get memory */
195 void *efi_alloc(uint64_t len, int memory_type);
196 /* More specific EFI memory allocator, called by EFI payloads */
197 efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
199 /* EFI memory free function. */
200 efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
201 /* EFI memory allocator for small allocations */
202 efi_status_t efi_allocate_pool(int pool_type, unsigned long size,
204 /* EFI pool memory free function. */
205 efi_status_t efi_free_pool(void *buffer);
206 /* Returns the EFI memory map */
207 efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
208 struct efi_mem_desc *memory_map,
209 unsigned long *map_key,
210 unsigned long *descriptor_size,
211 uint32_t *descriptor_version);
212 /* Adds a range into the EFI memory map */
213 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
214 bool overlap_only_ram);
215 /* Called by board init to initialize the EFI memory map */
216 int efi_memory_init(void);
217 /* Adds new or overrides configuration table entry to the system table */
218 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
219 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
220 struct efi_device_path *device_path,
221 struct efi_device_path *file_path);
223 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
224 extern void *efi_bounce_buffer;
225 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
229 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
230 int efi_dp_match(struct efi_device_path *a, struct efi_device_path *b);
231 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
232 struct efi_device_path **rem);
233 unsigned efi_dp_size(const struct efi_device_path *dp);
234 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
235 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
236 const struct efi_device_path *dp2);
237 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
238 const struct efi_device_path *node);
241 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
242 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
243 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
245 struct efi_device_path *efi_dp_from_eth(void);
246 void efi_dp_split_file_path(struct efi_device_path *full_path,
247 struct efi_device_path **device_path,
248 struct efi_device_path **file_path);
250 #define EFI_DP_TYPE(_dp, _type, _subtype) \
251 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
252 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
254 /* Convert strings from normal C strings to uEFI strings */
255 static inline void ascii2unicode(u16 *unicode, const char *ascii)
258 *(unicode++) = *(ascii++);
261 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
263 return memcmp(g1, g2, sizeof(efi_guid_t));
267 * Use these to indicate that your code / data should go into the EFI runtime
268 * section and thus still be available when the OS is running
270 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
271 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
273 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
274 * to make it available at runtime */
275 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
277 /* Boards may provide the functions below to implement RTS functionality */
279 void __efi_runtime EFIAPI efi_reset_system(
280 enum efi_reset_type reset_type,
281 efi_status_t reset_status,
282 unsigned long data_size, void *reset_data);
283 void efi_reset_system_init(void);
285 efi_status_t __efi_runtime EFIAPI efi_get_time(
286 struct efi_time *time,
287 struct efi_time_cap *capabilities);
288 void efi_get_time_init(void);
290 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
292 * Entry point for the tests of the EFI API.
293 * It is called by 'bootefi selftest'
295 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
296 struct efi_system_table *systab);
299 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
301 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
302 #define __efi_runtime_data
303 #define __efi_runtime
304 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
306 /* No loader configured, stub out EFI_ENTRY */
307 static inline void efi_restore_gd(void) { }
308 static inline void efi_set_bootdev(const char *dev, const char *devnr,
309 const char *path) { }
310 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }