]>
Commit | Line | Data |
---|---|---|
cb149c66 AG |
1 | /* |
2 | * EFI application loader | |
3 | * | |
4 | * Copyright (c) 2016 Alexander Graf | |
5 | * | |
6 | * SPDX-License-Identifier: GPL-2.0+ | |
7 | */ | |
8 | ||
bee91169 | 9 | #include <common.h> |
cb149c66 AG |
10 | #include <part_efi.h> |
11 | #include <efi_api.h> | |
bee91169 AG |
12 | |
13 | /* No need for efi loader support in SPL */ | |
14 | #if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD) | |
15 | ||
cb149c66 AG |
16 | #include <linux/list.h> |
17 | ||
c160d2f5 RC |
18 | int __efi_entry_check(void); |
19 | int __efi_exit_check(void); | |
ae0bd3a9 | 20 | const char *__efi_nesting(void); |
af65db85 RC |
21 | const char *__efi_nesting_inc(void); |
22 | const char *__efi_nesting_dec(void); | |
c160d2f5 | 23 | |
a095aadf RC |
24 | /* |
25 | * Enter the u-boot world from UEFI: | |
26 | */ | |
bee91169 | 27 | #define EFI_ENTRY(format, ...) do { \ |
c160d2f5 | 28 | assert(__efi_entry_check()); \ |
af65db85 RC |
29 | debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \ |
30 | __func__, ##__VA_ARGS__); \ | |
bee91169 | 31 | } while(0) |
bee91169 | 32 | |
a095aadf RC |
33 | /* |
34 | * Exit the u-boot world back to UEFI: | |
35 | */ | |
804b1d73 | 36 | #define EFI_EXIT(ret) ({ \ |
c81883df | 37 | typeof(ret) _r = ret; \ |
af65db85 | 38 | debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \ |
c81883df | 39 | __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \ |
c160d2f5 RC |
40 | assert(__efi_exit_check()); \ |
41 | _r; \ | |
804b1d73 | 42 | }) |
bee91169 | 43 | |
a095aadf | 44 | /* |
ea630ce9 | 45 | * Call non-void UEFI function from u-boot and retrieve return value: |
a095aadf | 46 | */ |
ea630ce9 HS |
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); \ | |
54 | _r; \ | |
55 | }) | |
56 | ||
57 | /* | |
58 | * Call void UEFI function from u-boot: | |
59 | */ | |
60 | #define EFI_CALL_VOID(exp) do { \ | |
af65db85 | 61 | debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \ |
c160d2f5 | 62 | assert(__efi_exit_check()); \ |
a095aadf | 63 | exp; \ |
c160d2f5 | 64 | assert(__efi_entry_check()); \ |
af65db85 | 65 | debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \ |
a095aadf RC |
66 | } while(0) |
67 | ||
ae0bd3a9 HS |
68 | /* |
69 | * Write GUID | |
70 | */ | |
71 | #define EFI_PRINT_GUID(txt, guid) ({ \ | |
72 | debug("%sEFI: %s %pUl\n", __efi_nesting(), txt, guid); \ | |
73 | }) | |
74 | ||
50149ea3 | 75 | extern struct efi_runtime_services efi_runtime_services; |
bee91169 AG |
76 | extern struct efi_system_table systab; |
77 | ||
c1311ad4 | 78 | extern const struct efi_simple_text_output_protocol efi_con_out; |
91be9a77 | 79 | extern struct efi_simple_input_interface efi_con_in; |
c1311ad4 | 80 | extern const struct efi_console_control_protocol efi_console_control; |
cc5b7081 | 81 | extern const struct efi_device_path_to_text_protocol efi_device_path_to_text; |
c1311ad4 | 82 | |
adae4313 RC |
83 | uint16_t *efi_dp_str(struct efi_device_path *dp); |
84 | ||
c1311ad4 | 85 | extern const efi_guid_t efi_guid_console_control; |
cb149c66 AG |
86 | extern const efi_guid_t efi_guid_device_path; |
87 | extern const efi_guid_t efi_guid_loaded_image; | |
cc5b7081 | 88 | extern const efi_guid_t efi_guid_device_path_to_text_protocol; |
2a92080d RC |
89 | extern const efi_guid_t efi_simple_file_system_protocol_guid; |
90 | extern const efi_guid_t efi_file_info_guid; | |
cb149c66 | 91 | |
50149ea3 AG |
92 | extern unsigned int __efi_runtime_start, __efi_runtime_stop; |
93 | extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop; | |
94 | ||
bee91169 AG |
95 | /* |
96 | * When the UEFI payload wants to open a protocol on an object to get its | |
97 | * interface (usually a struct with callback functions), this struct maps the | |
b5349f74 | 98 | * protocol GUID to the respective protocol interface */ |
bee91169 AG |
99 | struct efi_handler { |
100 | const efi_guid_t *guid; | |
b5349f74 | 101 | void *protocol_interface; |
bee91169 AG |
102 | }; |
103 | ||
104 | /* | |
105 | * UEFI has a poor man's OO model where one "object" can be polymorphic and have | |
106 | * multiple different protocols (classes) attached to it. | |
107 | * | |
108 | * This struct is the parent struct for all of our actual implementation objects | |
109 | * that can include it to make themselves an EFI object | |
110 | */ | |
111 | struct efi_object { | |
112 | /* Every UEFI object is part of a global object list */ | |
113 | struct list_head link; | |
011f4327 HS |
114 | /* We support up to 8 "protocols" an object can be accessed through */ |
115 | struct efi_handler protocols[8]; | |
bee91169 AG |
116 | /* The object spawner can either use this for data or as identifier */ |
117 | void *handle; | |
118 | }; | |
119 | ||
641833db RC |
120 | #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){ \ |
121 | .protocols = {{ \ | |
122 | .guid = &(_guid), \ | |
123 | .protocol_interface = (void *)(_protocol), \ | |
124 | }}, \ | |
125 | .handle = (void *)(_protocol), \ | |
126 | } | |
127 | ||
c6841592 HS |
128 | /** |
129 | * struct efi_event | |
130 | * | |
131 | * @type: Type of event, see efi_create_event | |
132 | * @notify_tpl: Task priority level of notifications | |
133 | * @trigger_time: Period of the timer | |
134 | * @trigger_next: Next time to trigger the timer | |
135 | * @nofify_function: Function to call when the event is triggered | |
136 | * @notify_context: Data to be passed to the notify function | |
137 | * @trigger_type: Type of timer, see efi_set_timer | |
ca62a4f5 HS |
138 | * @queued: The notification functionis queued |
139 | * @signaled: The event occured | |
c6841592 HS |
140 | */ |
141 | struct efi_event { | |
b521d29e | 142 | uint32_t type; |
503f2695 | 143 | UINTN notify_tpl; |
c6841592 HS |
144 | void (EFIAPI *notify_function)(struct efi_event *event, void *context); |
145 | void *notify_context; | |
146 | u64 trigger_next; | |
147 | u64 trigger_time; | |
b521d29e | 148 | enum efi_timer_delay trigger_type; |
ca62a4f5 | 149 | int queued; |
c6841592 HS |
150 | int signaled; |
151 | }; | |
152 | ||
153 | ||
bee91169 AG |
154 | /* This list contains all UEFI objects we know of */ |
155 | extern struct list_head efi_obj_list; | |
156 | ||
91be9a77 HS |
157 | /* Called by bootefi to make console interface available */ |
158 | int efi_console_register(void); | |
2a22d05d AG |
159 | /* Called by bootefi to make all disk storage accessible as EFI objects */ |
160 | int efi_disk_register(void); | |
be8d3241 AG |
161 | /* Called by bootefi to make GOP (graphical) interface available */ |
162 | int efi_gop_register(void); | |
0efe1bcf | 163 | /* Called by bootefi to make the network interface available */ |
95c5553e | 164 | int efi_net_register(void); |
e663b350 AG |
165 | /* Called by bootefi to make SMBIOS tables available */ |
166 | void efi_smbios_register(void); | |
0efe1bcf | 167 | |
2a92080d RC |
168 | struct efi_simple_file_system_protocol * |
169 | efi_fs_from_path(struct efi_device_path *fp); | |
170 | ||
0efe1bcf AG |
171 | /* Called by networking code to memorize the dhcp ack package */ |
172 | void efi_net_set_dhcp_ack(void *pkt, int len); | |
173 | ||
bee91169 AG |
174 | /* Called from places to check whether a timer expired */ |
175 | void efi_timer_check(void); | |
176 | /* PE loader implementation */ | |
cb149c66 | 177 | void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info); |
bee91169 AG |
178 | /* Called once to store the pristine gd pointer */ |
179 | void efi_save_gd(void); | |
c160d2f5 RC |
180 | /* Special case handler for error/abort that just tries to dtrt to get |
181 | * back to u-boot world */ | |
bee91169 | 182 | void efi_restore_gd(void); |
50149ea3 AG |
183 | /* Call this to relocate the runtime section to an address space */ |
184 | void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map); | |
0f4060eb | 185 | /* Call this to set the current device name */ |
c07ad7c0 | 186 | void efi_set_bootdev(const char *dev, const char *devnr, const char *path); |
49deb455 | 187 | /* Call this to create an event */ |
b521d29e | 188 | efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl, |
49deb455 HS |
189 | void (EFIAPI *notify_function) ( |
190 | struct efi_event *event, | |
191 | void *context), | |
192 | void *notify_context, struct efi_event **event); | |
bfc72462 | 193 | /* Call this to set a timer */ |
b521d29e | 194 | efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type, |
bfc72462 | 195 | uint64_t trigger_time); |
91be9a77 HS |
196 | /* Call this to signal an event */ |
197 | void efi_signal_event(struct efi_event *event); | |
50149ea3 | 198 | |
2a92080d RC |
199 | /* open file system: */ |
200 | struct efi_simple_file_system_protocol *efi_simple_file_system( | |
201 | struct blk_desc *desc, int part, struct efi_device_path *dp); | |
202 | ||
203 | /* open file from device-path: */ | |
204 | struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp); | |
205 | ||
206 | ||
5d00995c AG |
207 | /* Generic EFI memory allocator, call this to get memory */ |
208 | void *efi_alloc(uint64_t len, int memory_type); | |
209 | /* More specific EFI memory allocator, called by EFI payloads */ | |
210 | efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages, | |
211 | uint64_t *memory); | |
b61d857b | 212 | /* EFI memory free function. */ |
5d00995c | 213 | efi_status_t efi_free_pages(uint64_t memory, unsigned long pages); |
ead1274b SB |
214 | /* EFI memory allocator for small allocations */ |
215 | efi_status_t efi_allocate_pool(int pool_type, unsigned long size, | |
216 | void **buffer); | |
42417bc8 SB |
217 | /* EFI pool memory free function. */ |
218 | efi_status_t efi_free_pool(void *buffer); | |
5d00995c AG |
219 | /* Returns the EFI memory map */ |
220 | efi_status_t efi_get_memory_map(unsigned long *memory_map_size, | |
221 | struct efi_mem_desc *memory_map, | |
222 | unsigned long *map_key, | |
223 | unsigned long *descriptor_size, | |
224 | uint32_t *descriptor_version); | |
225 | /* Adds a range into the EFI memory map */ | |
226 | uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type, | |
227 | bool overlap_only_ram); | |
228 | /* Called by board init to initialize the EFI memory map */ | |
229 | int efi_memory_init(void); | |
488bf12d AG |
230 | /* Adds new or overrides configuration table entry to the system table */ |
231 | efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table); | |
95c5553e RC |
232 | void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj, |
233 | struct efi_device_path *device_path, | |
234 | struct efi_device_path *file_path); | |
5d00995c | 235 | |
51735ae0 AG |
236 | #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER |
237 | extern void *efi_bounce_buffer; | |
238 | #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024) | |
239 | #endif | |
240 | ||
b66c60dd RC |
241 | |
242 | struct efi_device_path *efi_dp_next(const struct efi_device_path *dp); | |
243 | int efi_dp_match(struct efi_device_path *a, struct efi_device_path *b); | |
244 | struct efi_object *efi_dp_find_obj(struct efi_device_path *dp, | |
245 | struct efi_device_path **rem); | |
246 | unsigned efi_dp_size(const struct efi_device_path *dp); | |
247 | struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp); | |
248 | struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1, | |
249 | const struct efi_device_path *dp2); | |
250 | struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp, | |
251 | const struct efi_device_path *node); | |
252 | ||
253 | ||
254 | struct efi_device_path *efi_dp_from_dev(struct udevice *dev); | |
255 | struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part); | |
256 | struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part, | |
257 | const char *path); | |
258 | struct efi_device_path *efi_dp_from_eth(void); | |
259 | void efi_dp_split_file_path(struct efi_device_path *full_path, | |
260 | struct efi_device_path **device_path, | |
261 | struct efi_device_path **file_path); | |
262 | ||
263 | #define EFI_DP_TYPE(_dp, _type, _subtype) \ | |
264 | (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \ | |
265 | ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype)) | |
266 | ||
0f4060eb | 267 | /* Convert strings from normal C strings to uEFI strings */ |
487d756f | 268 | static inline void ascii2unicode(u16 *unicode, const char *ascii) |
0f4060eb AG |
269 | { |
270 | while (*ascii) | |
271 | *(unicode++) = *(ascii++); | |
272 | } | |
273 | ||
3e094c59 RC |
274 | static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2) |
275 | { | |
276 | return memcmp(g1, g2, sizeof(efi_guid_t)); | |
277 | } | |
278 | ||
50149ea3 AG |
279 | /* |
280 | * Use these to indicate that your code / data should go into the EFI runtime | |
281 | * section and thus still be available when the OS is running | |
282 | */ | |
3c63db9c AG |
283 | #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data"))) |
284 | #define __efi_runtime __attribute__ ((section ("efi_runtime_text"))) | |
bee91169 | 285 | |
80a4800e AG |
286 | /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region |
287 | * to make it available at runtime */ | |
288 | void efi_add_runtime_mmio(void *mmio_ptr, u64 len); | |
289 | ||
290 | /* Boards may provide the functions below to implement RTS functionality */ | |
291 | ||
3c63db9c | 292 | void __efi_runtime EFIAPI efi_reset_system( |
80a4800e AG |
293 | enum efi_reset_type reset_type, |
294 | efi_status_t reset_status, | |
295 | unsigned long data_size, void *reset_data); | |
296 | void efi_reset_system_init(void); | |
297 | ||
3c63db9c | 298 | efi_status_t __efi_runtime EFIAPI efi_get_time( |
80a4800e AG |
299 | struct efi_time *time, |
300 | struct efi_time_cap *capabilities); | |
301 | void efi_get_time_init(void); | |
302 | ||
623b3a57 HS |
303 | #ifdef CONFIG_CMD_BOOTEFI_SELFTEST |
304 | /* | |
305 | * Entry point for the tests of the EFI API. | |
306 | * It is called by 'bootefi selftest' | |
307 | */ | |
308 | efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle, | |
309 | struct efi_system_table *systab); | |
310 | #endif | |
311 | ||
ad644e7c RC |
312 | efi_status_t EFIAPI efi_get_variable(s16 *variable_name, |
313 | efi_guid_t *vendor, u32 *attributes, | |
314 | unsigned long *data_size, void *data); | |
315 | efi_status_t EFIAPI efi_get_next_variable( | |
316 | unsigned long *variable_name_size, | |
317 | s16 *variable_name, efi_guid_t *vendor); | |
318 | efi_status_t EFIAPI efi_set_variable(s16 *variable_name, | |
319 | efi_guid_t *vendor, u32 attributes, | |
320 | unsigned long data_size, void *data); | |
321 | ||
bee91169 AG |
322 | #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */ |
323 | ||
50149ea3 | 324 | /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */ |
3c63db9c AG |
325 | #define __efi_runtime_data |
326 | #define __efi_runtime | |
97d01444 | 327 | static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { } |
50149ea3 | 328 | |
bee91169 AG |
329 | /* No loader configured, stub out EFI_ENTRY */ |
330 | static inline void efi_restore_gd(void) { } | |
c07ad7c0 AG |
331 | static inline void efi_set_bootdev(const char *dev, const char *devnr, |
332 | const char *path) { } | |
0efe1bcf | 333 | static inline void efi_net_set_dhcp_ack(void *pkt, int len) { } |
bee91169 AG |
334 | |
335 | #endif |