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);
22 * Enter the u-boot world from UEFI:
24 #define EFI_ENTRY(format, ...) do { \
25 assert(__efi_entry_check()); \
26 debug("EFI: Entry %s(" format ")\n", __func__, ##__VA_ARGS__); \
30 * Exit the u-boot world back to UEFI:
32 #define EFI_EXIT(ret) ({ \
33 efi_status_t _r = ret; \
34 debug("EFI: Exit: %s: %u\n", __func__, (u32)(_r & ~EFI_ERROR_MASK)); \
35 assert(__efi_exit_check()); \
40 * Callback into UEFI world from u-boot:
42 #define EFI_CALL(exp) do { \
43 debug("EFI: Call: %s\n", #exp); \
44 assert(__efi_exit_check()); \
46 assert(__efi_entry_check()); \
47 debug("EFI: Return From: %s\n", #exp); \
50 extern struct efi_runtime_services efi_runtime_services;
51 extern struct efi_system_table systab;
53 extern const struct efi_simple_text_output_protocol efi_con_out;
54 extern struct efi_simple_input_interface efi_con_in;
55 extern const struct efi_console_control_protocol efi_console_control;
56 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
58 extern const efi_guid_t efi_guid_console_control;
59 extern const efi_guid_t efi_guid_device_path;
60 extern const efi_guid_t efi_guid_loaded_image;
61 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
63 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
64 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
67 * When the UEFI payload wants to open a protocol on an object to get its
68 * interface (usually a struct with callback functions), this struct maps the
69 * protocol GUID to the respective protocol interface */
71 const efi_guid_t *guid;
72 void *protocol_interface;
76 * UEFI has a poor man's OO model where one "object" can be polymorphic and have
77 * multiple different protocols (classes) attached to it.
79 * This struct is the parent struct for all of our actual implementation objects
80 * that can include it to make themselves an EFI object
83 /* Every UEFI object is part of a global object list */
84 struct list_head link;
85 /* We support up to 8 "protocols" an object can be accessed through */
86 struct efi_handler protocols[8];
87 /* The object spawner can either use this for data or as identifier */
91 #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){ \
94 .protocol_interface = (void *)(_protocol), \
96 .handle = (void *)(_protocol), \
102 * @type: Type of event, see efi_create_event
103 * @notify_tpl: Task priority level of notifications
104 * @trigger_time: Period of the timer
105 * @trigger_next: Next time to trigger the timer
106 * @nofify_function: Function to call when the event is triggered
107 * @notify_context: Data to be passed to the notify function
108 * @trigger_type: Type of timer, see efi_set_timer
109 * @signaled: The notify function was already called
114 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
115 void *notify_context;
118 enum efi_timer_delay trigger_type;
123 /* This list contains all UEFI objects we know of */
124 extern struct list_head efi_obj_list;
126 /* Called by bootefi to make console interface available */
127 int efi_console_register(void);
128 /* Called by bootefi to make all disk storage accessible as EFI objects */
129 int efi_disk_register(void);
130 /* Called by bootefi to make GOP (graphical) interface available */
131 int efi_gop_register(void);
132 /* Called by bootefi to make the network interface available */
133 int efi_net_register(void **handle);
134 /* Called by bootefi to make SMBIOS tables available */
135 void efi_smbios_register(void);
137 /* Called by networking code to memorize the dhcp ack package */
138 void efi_net_set_dhcp_ack(void *pkt, int len);
140 /* Called from places to check whether a timer expired */
141 void efi_timer_check(void);
142 /* PE loader implementation */
143 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
144 /* Called once to store the pristine gd pointer */
145 void efi_save_gd(void);
146 /* Special case handler for error/abort that just tries to dtrt to get
147 * back to u-boot world */
148 void efi_restore_gd(void);
149 /* Call this to relocate the runtime section to an address space */
150 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
151 /* Call this to set the current device name */
152 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
153 /* Call this to create an event */
154 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl,
155 void (EFIAPI *notify_function) (
156 struct efi_event *event,
158 void *notify_context, struct efi_event **event);
159 /* Call this to set a timer */
160 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
161 uint64_t trigger_time);
162 /* Call this to signal an event */
163 void efi_signal_event(struct efi_event *event);
165 /* Generic EFI memory allocator, call this to get memory */
166 void *efi_alloc(uint64_t len, int memory_type);
167 /* More specific EFI memory allocator, called by EFI payloads */
168 efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
170 /* EFI memory free function. */
171 efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
172 /* EFI memory allocator for small allocations */
173 efi_status_t efi_allocate_pool(int pool_type, unsigned long size,
175 /* EFI pool memory free function. */
176 efi_status_t efi_free_pool(void *buffer);
177 /* Returns the EFI memory map */
178 efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
179 struct efi_mem_desc *memory_map,
180 unsigned long *map_key,
181 unsigned long *descriptor_size,
182 uint32_t *descriptor_version);
183 /* Adds a range into the EFI memory map */
184 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
185 bool overlap_only_ram);
186 /* Called by board init to initialize the EFI memory map */
187 int efi_memory_init(void);
188 /* Adds new or overrides configuration table entry to the system table */
189 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
191 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
192 extern void *efi_bounce_buffer;
193 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
196 /* Convert strings from normal C strings to uEFI strings */
197 static inline void ascii2unicode(u16 *unicode, const char *ascii)
200 *(unicode++) = *(ascii++);
203 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
205 return memcmp(g1, g2, sizeof(efi_guid_t));
209 * Use these to indicate that your code / data should go into the EFI runtime
210 * section and thus still be available when the OS is running
212 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
213 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
215 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
216 * to make it available at runtime */
217 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
219 /* Boards may provide the functions below to implement RTS functionality */
221 void __efi_runtime EFIAPI efi_reset_system(
222 enum efi_reset_type reset_type,
223 efi_status_t reset_status,
224 unsigned long data_size, void *reset_data);
225 void efi_reset_system_init(void);
227 efi_status_t __efi_runtime EFIAPI efi_get_time(
228 struct efi_time *time,
229 struct efi_time_cap *capabilities);
230 void efi_get_time_init(void);
232 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
234 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
235 #define __efi_runtime_data
236 #define __efi_runtime
237 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
239 /* No loader configured, stub out EFI_ENTRY */
240 static inline void efi_restore_gd(void) { }
241 static inline void efi_set_bootdev(const char *dev, const char *devnr,
242 const char *path) { }
243 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }