blob: 967b39b223ce2e12d8cecc64ef88950bc30c2153 [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Grafc15d9212016-03-04 01:09:59 +01002/*
3 * EFI application boot time services
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafc15d9212016-03-04 01:09:59 +01006 */
7
Alexander Grafc15d9212016-03-04 01:09:59 +01008#include <common.h>
Heinrich Schuchardt368ca642017-10-05 16:14:14 +02009#include <div64.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010010#include <efi_loader.h>
Rob Clark15f3d742017-09-13 18:05:37 -040011#include <environment.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010012#include <malloc.h>
Masahiro Yamada75f82d02018-03-05 01:20:11 +090013#include <linux/libfdt_env.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010014#include <u-boot/crc.h>
15#include <bootm.h>
Heinrich Schuchardt37587522019-05-01 20:07:04 +020016#include <pe.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010017#include <watchdog.h>
18
19DECLARE_GLOBAL_DATA_PTR;
20
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +020021/* Task priority level */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +010022static efi_uintn_t efi_tpl = TPL_APPLICATION;
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +020023
Alexander Grafc15d9212016-03-04 01:09:59 +010024/* This list contains all the EFI objects our payload has access to */
25LIST_HEAD(efi_obj_list);
26
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +010027/* List of all events */
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +010028LIST_HEAD(efi_events);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +010029
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +020030/* List of all events registered by RegisterProtocolNotify() */
31LIST_HEAD(efi_register_notify_events);
32
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +010033/* Handle of the currently executing image */
34static efi_handle_t current_image;
35
Alexander Graffa5246b2018-11-15 21:23:47 +010036/*
37 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
38 * we need to do trickery with caches. Since we don't want to break the EFI
39 * aware boot path, only apply hacks when loading exiting directly (breaking
40 * direct Linux EFI booting along the way - oh well).
41 */
42static bool efi_is_direct_boot = true;
43
Simon Glasscdfe6962016-09-25 15:27:35 -060044#ifdef CONFIG_ARM
Alexander Grafc15d9212016-03-04 01:09:59 +010045/*
46 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
47 * fixed when compiling U-Boot. However, the payload does not know about that
48 * restriction so we need to manually swap its and our view of that register on
49 * EFI callback entry/exit.
50 */
51static volatile void *efi_gd, *app_gd;
Simon Glasscdfe6962016-09-25 15:27:35 -060052#endif
Alexander Grafc15d9212016-03-04 01:09:59 +010053
Heinrich Schuchardt72506232019-02-09 14:10:39 +010054/* 1 if inside U-Boot code, 0 if inside EFI payload code */
55static int entry_count = 1;
Rob Clarke7896c32017-07-27 08:04:19 -040056static int nesting_level;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +010057/* GUID of the device tree table */
58const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +010059/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60const efi_guid_t efi_guid_driver_binding_protocol =
61 EFI_DRIVER_BINDING_PROTOCOL_GUID;
Rob Clark86789d52017-07-27 08:04:18 -040062
Heinrich Schuchardt672d99e2018-02-18 15:17:51 +010063/* event group ExitBootServices() invoked */
64const efi_guid_t efi_guid_event_group_exit_boot_services =
65 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
66/* event group SetVirtualAddressMap() invoked */
67const efi_guid_t efi_guid_event_group_virtual_address_change =
68 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
69/* event group memory map changed */
70const efi_guid_t efi_guid_event_group_memory_map_change =
71 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
72/* event group boot manager about to boot */
73const efi_guid_t efi_guid_event_group_ready_to_boot =
74 EFI_EVENT_GROUP_READY_TO_BOOT;
75/* event group ResetSystem() invoked (before ExitBootServices) */
76const efi_guid_t efi_guid_event_group_reset_system =
77 EFI_EVENT_GROUP_RESET_SYSTEM;
78
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +010079static efi_status_t EFIAPI efi_disconnect_controller(
80 efi_handle_t controller_handle,
81 efi_handle_t driver_image_handle,
82 efi_handle_t child_handle);
Heinrich Schuchardte9943282018-01-11 08:16:04 +010083
Rob Clark86789d52017-07-27 08:04:18 -040084/* Called on every callback entry */
85int __efi_entry_check(void)
86{
87 int ret = entry_count++ == 0;
88#ifdef CONFIG_ARM
89 assert(efi_gd);
90 app_gd = gd;
91 gd = efi_gd;
92#endif
93 return ret;
94}
95
96/* Called on every callback exit */
97int __efi_exit_check(void)
98{
99 int ret = --entry_count == 0;
100#ifdef CONFIG_ARM
101 gd = app_gd;
102#endif
103 return ret;
104}
105
Alexander Grafc15d9212016-03-04 01:09:59 +0100106/* Called from do_bootefi_exec() */
107void efi_save_gd(void)
108{
Simon Glasscdfe6962016-09-25 15:27:35 -0600109#ifdef CONFIG_ARM
Alexander Grafc15d9212016-03-04 01:09:59 +0100110 efi_gd = gd;
Simon Glasscdfe6962016-09-25 15:27:35 -0600111#endif
Alexander Grafc15d9212016-03-04 01:09:59 +0100112}
113
Rob Clark86789d52017-07-27 08:04:18 -0400114/*
Mario Six8fac2912018-07-10 08:40:17 +0200115 * Special case handler for error/abort that just forces things back to u-boot
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200116 * world so we can dump out an abort message, without any care about returning
117 * back to UEFI world.
Rob Clark86789d52017-07-27 08:04:18 -0400118 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100119void efi_restore_gd(void)
120{
Simon Glasscdfe6962016-09-25 15:27:35 -0600121#ifdef CONFIG_ARM
Alexander Grafc15d9212016-03-04 01:09:59 +0100122 /* Only restore if we're already in EFI context */
123 if (!efi_gd)
124 return;
Alexander Grafc15d9212016-03-04 01:09:59 +0100125 gd = efi_gd;
Simon Glasscdfe6962016-09-25 15:27:35 -0600126#endif
Alexander Grafc15d9212016-03-04 01:09:59 +0100127}
128
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200129/**
Mario Six8fac2912018-07-10 08:40:17 +0200130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
Heinrich Schuchardt091cf432018-01-24 19:21:36 +0100132 *
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200133 * A maximum of ten indent levels is supported. Higher indent levels will be
134 * truncated.
135 *
Mario Six8fac2912018-07-10 08:40:17 +0200136 * Return: A string for indenting with two spaces per level is
137 * returned.
Rob Clarke7896c32017-07-27 08:04:19 -0400138 */
139static const char *indent_string(int level)
140{
141 const char *indent = " ";
142 const int max = strlen(indent);
Heinrich Schuchardt91064592018-02-18 15:17:49 +0100143
Rob Clarke7896c32017-07-27 08:04:19 -0400144 level = min(max, level * 2);
145 return &indent[max - level];
146}
147
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200148const char *__efi_nesting(void)
149{
150 return indent_string(nesting_level);
151}
152
Rob Clarke7896c32017-07-27 08:04:19 -0400153const char *__efi_nesting_inc(void)
154{
155 return indent_string(nesting_level++);
156}
157
158const char *__efi_nesting_dec(void)
159{
160 return indent_string(--nesting_level);
161}
162
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200163/**
Mario Six8fac2912018-07-10 08:40:17 +0200164 * efi_queue_event() - queue an EFI event
165 * @event: event to signal
166 * @check_tpl: check the TPL level
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200167 *
168 * This function queues the notification function of the event for future
169 * execution.
170 *
Mario Six8fac2912018-07-10 08:40:17 +0200171 * The notification function is called if the task priority level of the event
172 * is higher than the current task priority level.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200173 *
174 * For the SignalEvent service see efi_signal_event_ext.
175 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200176 */
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100177static void efi_queue_event(struct efi_event *event, bool check_tpl)
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200178{
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200179 if (event->notify_function) {
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200180 event->is_queued = true;
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200181 /* Check TPL */
Heinrich Schuchardtd8b878a2018-01-19 20:24:51 +0100182 if (check_tpl && efi_tpl >= event->notify_tpl)
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200183 return;
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200184 EFI_CALL_VOID(event->notify_function(event,
185 event->notify_context));
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200186 }
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200187 event->is_queued = false;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200188}
189
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200190/**
Heinrich Schuchardt7f0f0052018-07-02 12:53:52 +0200191 * is_valid_tpl() - check if the task priority level is valid
192 *
193 * @tpl: TPL level to check
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200194 * Return: status code
Heinrich Schuchardt7f0f0052018-07-02 12:53:52 +0200195 */
196efi_status_t is_valid_tpl(efi_uintn_t tpl)
197{
198 switch (tpl) {
199 case TPL_APPLICATION:
200 case TPL_CALLBACK:
201 case TPL_NOTIFY:
202 case TPL_HIGH_LEVEL:
203 return EFI_SUCCESS;
204 default:
205 return EFI_INVALID_PARAMETER;
206 }
207}
208
209/**
Mario Six8fac2912018-07-10 08:40:17 +0200210 * efi_signal_event() - signal an EFI event
211 * @event: event to signal
212 * @check_tpl: check the TPL level
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100213 *
Mario Six8fac2912018-07-10 08:40:17 +0200214 * This function signals an event. If the event belongs to an event group all
215 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100216 * their notification function is queued.
217 *
218 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100219 */
220void efi_signal_event(struct efi_event *event, bool check_tpl)
221{
222 if (event->group) {
223 struct efi_event *evt;
224
225 /*
226 * The signaled state has to set before executing any
227 * notification function
228 */
229 list_for_each_entry(evt, &efi_events, link) {
230 if (!evt->group || guidcmp(evt->group, event->group))
231 continue;
232 if (evt->is_signaled)
233 continue;
234 evt->is_signaled = true;
235 if (evt->type & EVT_NOTIFY_SIGNAL &&
236 evt->notify_function)
237 evt->is_queued = true;
238 }
239 list_for_each_entry(evt, &efi_events, link) {
240 if (!evt->group || guidcmp(evt->group, event->group))
241 continue;
242 if (evt->is_queued)
243 efi_queue_event(evt, check_tpl);
244 }
Heinrich Schuchardt66ddc2e2019-05-05 00:07:34 +0200245 } else {
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100246 event->is_signaled = true;
247 if (event->type & EVT_NOTIFY_SIGNAL)
248 efi_queue_event(event, check_tpl);
249 }
250}
251
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200252/**
Mario Six8fac2912018-07-10 08:40:17 +0200253 * efi_raise_tpl() - raise the task priority level
254 * @new_tpl: new value of the task priority level
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200255 *
256 * This function implements the RaiseTpl service.
Mario Six8fac2912018-07-10 08:40:17 +0200257 *
258 * See the Unified Extensible Firmware Interface (UEFI) specification for
259 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200260 *
Mario Six8fac2912018-07-10 08:40:17 +0200261 * Return: old value of the task priority level
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200262 */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100263static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafc15d9212016-03-04 01:09:59 +0100264{
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100265 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200266
xypron.glpk@gmx.de48df2092017-07-18 20:17:19 +0200267 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200268
269 if (new_tpl < efi_tpl)
270 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
271 efi_tpl = new_tpl;
272 if (efi_tpl > TPL_HIGH_LEVEL)
273 efi_tpl = TPL_HIGH_LEVEL;
274
275 EFI_EXIT(EFI_SUCCESS);
276 return old_tpl;
Alexander Grafc15d9212016-03-04 01:09:59 +0100277}
278
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200279/**
Mario Six8fac2912018-07-10 08:40:17 +0200280 * efi_restore_tpl() - lower the task priority level
281 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200282 *
283 * This function implements the RestoreTpl service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200284 *
Mario Six8fac2912018-07-10 08:40:17 +0200285 * See the Unified Extensible Firmware Interface (UEFI) specification for
286 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200287 */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100288static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafc15d9212016-03-04 01:09:59 +0100289{
xypron.glpk@gmx.de48df2092017-07-18 20:17:19 +0200290 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200291
292 if (old_tpl > efi_tpl)
293 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
294 efi_tpl = old_tpl;
295 if (efi_tpl > TPL_HIGH_LEVEL)
296 efi_tpl = TPL_HIGH_LEVEL;
297
Heinrich Schuchardt59b20952018-03-24 18:40:21 +0100298 /*
299 * Lowering the TPL may have made queued events eligible for execution.
300 */
301 efi_timer_check();
302
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200303 EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +0100304}
305
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200306/**
Mario Six8fac2912018-07-10 08:40:17 +0200307 * efi_allocate_pages_ext() - allocate memory pages
308 * @type: type of allocation to be performed
309 * @memory_type: usage type of the allocated memory
310 * @pages: number of pages to be allocated
311 * @memory: allocated memory
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200312 *
313 * This function implements the AllocatePages service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200314 *
Mario Six8fac2912018-07-10 08:40:17 +0200315 * See the Unified Extensible Firmware Interface (UEFI) specification for
316 * details.
317 *
318 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200319 */
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900320static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100321 efi_uintn_t pages,
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900322 uint64_t *memory)
Alexander Grafc15d9212016-03-04 01:09:59 +0100323{
324 efi_status_t r;
325
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100326 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafc15d9212016-03-04 01:09:59 +0100327 r = efi_allocate_pages(type, memory_type, pages, memory);
328 return EFI_EXIT(r);
329}
330
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200331/**
Mario Six8fac2912018-07-10 08:40:17 +0200332 * efi_free_pages_ext() - Free memory pages.
333 * @memory: start of the memory area to be freed
334 * @pages: number of pages to be freed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200335 *
336 * This function implements the FreePages service.
Mario Six8fac2912018-07-10 08:40:17 +0200337 *
338 * See the Unified Extensible Firmware Interface (UEFI) specification for
339 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200340 *
Mario Six8fac2912018-07-10 08:40:17 +0200341 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200342 */
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900343static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100344 efi_uintn_t pages)
Alexander Grafc15d9212016-03-04 01:09:59 +0100345{
346 efi_status_t r;
347
Masahiro Yamadac7570a32018-08-06 20:47:40 +0900348 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafc15d9212016-03-04 01:09:59 +0100349 r = efi_free_pages(memory, pages);
350 return EFI_EXIT(r);
351}
352
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200353/**
Mario Six8fac2912018-07-10 08:40:17 +0200354 * efi_get_memory_map_ext() - get map describing memory usage
355 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
356 * on exit the size of the copied memory map
357 * @memory_map: buffer to which the memory map is written
358 * @map_key: key for the memory map
359 * @descriptor_size: size of an individual memory descriptor
360 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200361 *
362 * This function implements the GetMemoryMap service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200363 *
Mario Six8fac2912018-07-10 08:40:17 +0200364 * See the Unified Extensible Firmware Interface (UEFI) specification for
365 * details.
366 *
367 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200368 */
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900369static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100370 efi_uintn_t *memory_map_size,
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900371 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100372 efi_uintn_t *map_key,
373 efi_uintn_t *descriptor_size,
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900374 uint32_t *descriptor_version)
Alexander Grafc15d9212016-03-04 01:09:59 +0100375{
376 efi_status_t r;
377
378 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
379 map_key, descriptor_size, descriptor_version);
380 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
381 descriptor_size, descriptor_version);
382 return EFI_EXIT(r);
383}
384
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200385/**
Mario Six8fac2912018-07-10 08:40:17 +0200386 * efi_allocate_pool_ext() - allocate memory from pool
387 * @pool_type: type of the pool from which memory is to be allocated
388 * @size: number of bytes to be allocated
389 * @buffer: allocated memory
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200390 *
391 * This function implements the AllocatePool service.
Mario Six8fac2912018-07-10 08:40:17 +0200392 *
393 * See the Unified Extensible Firmware Interface (UEFI) specification for
394 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200395 *
Mario Six8fac2912018-07-10 08:40:17 +0200396 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200397 */
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200398static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100399 efi_uintn_t size,
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200400 void **buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +0100401{
Alexander Graf1c34fa82016-03-24 01:37:37 +0100402 efi_status_t r;
403
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100404 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200405 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1c34fa82016-03-24 01:37:37 +0100406 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +0100407}
408
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200409/**
Mario Six8fac2912018-07-10 08:40:17 +0200410 * efi_free_pool_ext() - free memory from pool
411 * @buffer: start of memory to be freed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200412 *
413 * This function implements the FreePool service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200414 *
Mario Six8fac2912018-07-10 08:40:17 +0200415 * See the Unified Extensible Firmware Interface (UEFI) specification for
416 * details.
417 *
418 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200419 */
Stefan Brüns67b67d92016-10-09 22:17:26 +0200420static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +0100421{
Alexander Graf1c34fa82016-03-24 01:37:37 +0100422 efi_status_t r;
423
424 EFI_ENTRY("%p", buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200425 r = efi_free_pool(buffer);
Alexander Graf1c34fa82016-03-24 01:37:37 +0100426 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +0100427}
428
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200429/**
Heinrich Schuchardt30cd0462019-05-01 09:42:39 +0200430 * efi_add_handle() - add a new handle to the object list
431 *
432 * @handle: handle to be added
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100433 *
Heinrich Schuchardt30cd0462019-05-01 09:42:39 +0200434 * The protocols list is initialized. The handle is added to the list of known
435 * UEFI objects.
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100436 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200437void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100438{
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200439 if (!handle)
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100440 return;
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200441 INIT_LIST_HEAD(&handle->protocols);
442 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100443}
444
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200445/**
Mario Six8fac2912018-07-10 08:40:17 +0200446 * efi_create_handle() - create handle
447 * @handle: new handle
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200448 *
Mario Six8fac2912018-07-10 08:40:17 +0200449 * Return: status code
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200450 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100451efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +0200452{
453 struct efi_object *obj;
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +0200454
Heinrich Schuchardtae1d2062018-05-27 16:47:21 +0200455 obj = calloc(1, sizeof(struct efi_object));
456 if (!obj)
457 return EFI_OUT_OF_RESOURCES;
458
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100459 efi_add_handle(obj);
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200460 *handle = obj;
Heinrich Schuchardtae1d2062018-05-27 16:47:21 +0200461
462 return EFI_SUCCESS;
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +0200463}
464
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200465/**
Mario Six8fac2912018-07-10 08:40:17 +0200466 * efi_search_protocol() - find a protocol on a handle.
467 * @handle: handle
468 * @protocol_guid: GUID of the protocol
469 * @handler: reference to the protocol
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100470 *
Mario Six8fac2912018-07-10 08:40:17 +0200471 * Return: status code
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100472 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100473efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100474 const efi_guid_t *protocol_guid,
475 struct efi_handler **handler)
476{
477 struct efi_object *efiobj;
478 struct list_head *lhandle;
479
480 if (!handle || !protocol_guid)
481 return EFI_INVALID_PARAMETER;
482 efiobj = efi_search_obj(handle);
483 if (!efiobj)
484 return EFI_INVALID_PARAMETER;
485 list_for_each(lhandle, &efiobj->protocols) {
486 struct efi_handler *protocol;
487
488 protocol = list_entry(lhandle, struct efi_handler, link);
489 if (!guidcmp(protocol->guid, protocol_guid)) {
490 if (handler)
491 *handler = protocol;
492 return EFI_SUCCESS;
493 }
494 }
495 return EFI_NOT_FOUND;
496}
497
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200498/**
Mario Six8fac2912018-07-10 08:40:17 +0200499 * efi_remove_protocol() - delete protocol from a handle
500 * @handle: handle from which the protocol shall be deleted
501 * @protocol: GUID of the protocol to be deleted
502 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100503 *
Mario Six8fac2912018-07-10 08:40:17 +0200504 * Return: status code
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100505 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100506efi_status_t efi_remove_protocol(const efi_handle_t handle,
507 const efi_guid_t *protocol,
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100508 void *protocol_interface)
509{
510 struct efi_handler *handler;
511 efi_status_t ret;
512
513 ret = efi_search_protocol(handle, protocol, &handler);
514 if (ret != EFI_SUCCESS)
515 return ret;
516 if (guidcmp(handler->guid, protocol))
517 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtb27594d2018-05-11 12:09:21 +0200518 if (handler->protocol_interface != protocol_interface)
519 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100520 list_del(&handler->link);
521 free(handler);
522 return EFI_SUCCESS;
523}
524
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200525/**
Mario Six8fac2912018-07-10 08:40:17 +0200526 * efi_remove_all_protocols() - delete all protocols from a handle
527 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100528 *
Mario Six8fac2912018-07-10 08:40:17 +0200529 * Return: status code
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100530 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100531efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100532{
533 struct efi_object *efiobj;
Heinrich Schuchardta84731d2018-01-11 08:15:55 +0100534 struct efi_handler *protocol;
535 struct efi_handler *pos;
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100536
537 efiobj = efi_search_obj(handle);
538 if (!efiobj)
539 return EFI_INVALID_PARAMETER;
Heinrich Schuchardta84731d2018-01-11 08:15:55 +0100540 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100541 efi_status_t ret;
542
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100543 ret = efi_remove_protocol(handle, protocol->guid,
544 protocol->protocol_interface);
545 if (ret != EFI_SUCCESS)
546 return ret;
547 }
548 return EFI_SUCCESS;
549}
550
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200551/**
Mario Six8fac2912018-07-10 08:40:17 +0200552 * efi_delete_handle() - delete handle
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100553 *
Mario Six8fac2912018-07-10 08:40:17 +0200554 * @obj: handle to delete
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100555 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200556void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100557{
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200558 if (!handle)
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100559 return;
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200560 efi_remove_all_protocols(handle);
561 list_del(&handle->link);
562 free(handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100563}
564
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200565/**
Mario Six8fac2912018-07-10 08:40:17 +0200566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100568 *
Mario Six8fac2912018-07-10 08:40:17 +0200569 * Return: status code
Alexander Grafc15d9212016-03-04 01:09:59 +0100570 */
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100571static efi_status_t efi_is_event(const struct efi_event *event)
572{
573 const struct efi_event *evt;
574
575 if (!event)
576 return EFI_INVALID_PARAMETER;
577 list_for_each_entry(evt, &efi_events, link) {
578 if (evt == event)
579 return EFI_SUCCESS;
580 }
581 return EFI_INVALID_PARAMETER;
582}
Alexander Grafc15d9212016-03-04 01:09:59 +0100583
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200584/**
Mario Six8fac2912018-07-10 08:40:17 +0200585 * efi_create_event() - create an event
586 * @type: type of the event to create
587 * @notify_tpl: task priority level of the event
588 * @notify_function: notification function of the event
589 * @notify_context: pointer passed to the notification function
590 * @group: event group
591 * @event: created event
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200592 *
593 * This function is used inside U-Boot code to create an event.
594 *
595 * For the API function implementing the CreateEvent service see
596 * efi_create_event_ext.
597 *
Mario Six8fac2912018-07-10 08:40:17 +0200598 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200599 */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100600efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200601 void (EFIAPI *notify_function) (
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200602 struct efi_event *event,
603 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100604 void *notify_context, efi_guid_t *group,
605 struct efi_event **event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100606{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100607 struct efi_event *evt;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200608
Jonathan Gray7758b212017-03-12 19:26:07 +1100609 if (event == NULL)
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200610 return EFI_INVALID_PARAMETER;
Jonathan Gray7758b212017-03-12 19:26:07 +1100611
Heinrich Schuchardt7f0f0052018-07-02 12:53:52 +0200612 switch (type) {
613 case 0:
614 case EVT_TIMER:
615 case EVT_NOTIFY_SIGNAL:
616 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
617 case EVT_NOTIFY_WAIT:
618 case EVT_TIMER | EVT_NOTIFY_WAIT:
619 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
620 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
621 break;
622 default:
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200623 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt7f0f0052018-07-02 12:53:52 +0200624 }
Jonathan Gray7758b212017-03-12 19:26:07 +1100625
AKASHI Takahiro3f3835d2018-08-10 15:36:32 +0900626 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardtad7a2152019-04-25 07:30:41 +0200627 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200628 return EFI_INVALID_PARAMETER;
Jonathan Gray7758b212017-03-12 19:26:07 +1100629
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100630 evt = calloc(1, sizeof(struct efi_event));
631 if (!evt)
632 return EFI_OUT_OF_RESOURCES;
633 evt->type = type;
634 evt->notify_tpl = notify_tpl;
635 evt->notify_function = notify_function;
636 evt->notify_context = notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100637 evt->group = group;
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200638 /* Disable timers on boot up */
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100639 evt->trigger_next = -1ULL;
640 evt->is_queued = false;
641 evt->is_signaled = false;
642 list_add_tail(&evt->link, &efi_events);
643 *event = evt;
644 return EFI_SUCCESS;
Alexander Grafc15d9212016-03-04 01:09:59 +0100645}
646
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200647/*
Mario Six8fac2912018-07-10 08:40:17 +0200648 * efi_create_event_ex() - create an event in a group
649 * @type: type of the event to create
650 * @notify_tpl: task priority level of the event
651 * @notify_function: notification function of the event
652 * @notify_context: pointer passed to the notification function
653 * @event: created event
654 * @event_group: event group
Heinrich Schuchardt717c4582018-02-04 23:05:13 +0100655 *
656 * This function implements the CreateEventEx service.
Heinrich Schuchardt717c4582018-02-04 23:05:13 +0100657 *
Mario Six8fac2912018-07-10 08:40:17 +0200658 * See the Unified Extensible Firmware Interface (UEFI) specification for
659 * details.
660 *
661 * Return: status code
Heinrich Schuchardt717c4582018-02-04 23:05:13 +0100662 */
663efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
664 void (EFIAPI *notify_function) (
665 struct efi_event *event,
666 void *context),
667 void *notify_context,
668 efi_guid_t *event_group,
669 struct efi_event **event)
670{
Heinrich Schuchardtce664992019-05-04 10:12:50 +0200671 efi_status_t ret;
672
Heinrich Schuchardt717c4582018-02-04 23:05:13 +0100673 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
674 notify_context, event_group);
Heinrich Schuchardtce664992019-05-04 10:12:50 +0200675
676 /*
677 * The allowable input parameters are the same as in CreateEvent()
678 * except for the following two disallowed event types.
679 */
680 switch (type) {
681 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
682 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
683 ret = EFI_INVALID_PARAMETER;
684 goto out;
685 }
686
687 ret = efi_create_event(type, notify_tpl, notify_function,
688 notify_context, event_group, event);
689out:
690 return EFI_EXIT(ret);
Heinrich Schuchardt717c4582018-02-04 23:05:13 +0100691}
692
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200693/**
Mario Six8fac2912018-07-10 08:40:17 +0200694 * efi_create_event_ext() - create an event
695 * @type: type of the event to create
696 * @notify_tpl: task priority level of the event
697 * @notify_function: notification function of the event
698 * @notify_context: pointer passed to the notification function
699 * @event: created event
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200700 *
701 * This function implements the CreateEvent service.
Mario Six8fac2912018-07-10 08:40:17 +0200702 *
703 * See the Unified Extensible Firmware Interface (UEFI) specification for
704 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200705 *
Mario Six8fac2912018-07-10 08:40:17 +0200706 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200707 */
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200708static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100709 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200710 void (EFIAPI *notify_function) (
711 struct efi_event *event,
712 void *context),
713 void *notify_context, struct efi_event **event)
714{
715 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
716 notify_context);
717 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100718 notify_context, NULL, event));
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200719}
720
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200721/**
Mario Six8fac2912018-07-10 08:40:17 +0200722 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200723 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200724 * Check if a timer event has occurred or a queued notification function should
725 * be called.
726 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100727 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200728 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafc15d9212016-03-04 01:09:59 +0100729 */
730void efi_timer_check(void)
731{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100732 struct efi_event *evt;
Alexander Grafc15d9212016-03-04 01:09:59 +0100733 u64 now = timer_get_us();
734
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100735 list_for_each_entry(evt, &efi_events, link) {
736 if (evt->is_queued)
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100737 efi_queue_event(evt, true);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100738 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200739 continue;
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100740 switch (evt->trigger_type) {
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200741 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100742 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200743 break;
744 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100745 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200746 break;
747 default:
748 continue;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200749 }
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100750 evt->is_signaled = false;
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100751 efi_signal_event(evt, true);
Alexander Grafc15d9212016-03-04 01:09:59 +0100752 }
Alexander Grafc15d9212016-03-04 01:09:59 +0100753 WATCHDOG_RESET();
754}
755
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200756/**
Mario Six8fac2912018-07-10 08:40:17 +0200757 * efi_set_timer() - set the trigger time for a timer event or stop the event
758 * @event: event for which the timer is set
759 * @type: type of the timer
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200760 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200761 *
762 * This is the function for internal usage in U-Boot. For the API function
763 * implementing the SetTimer service see efi_set_timer_ext.
764 *
Mario Six8fac2912018-07-10 08:40:17 +0200765 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200766 */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200767efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200768 uint64_t trigger_time)
Alexander Grafc15d9212016-03-04 01:09:59 +0100769{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100770 /* Check that the event is valid */
771 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
772 return EFI_INVALID_PARAMETER;
Alexander Grafc15d9212016-03-04 01:09:59 +0100773
xypron.glpk@gmx.de44c4be02017-07-18 20:17:23 +0200774 /*
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200775 * The parameter defines a multiple of 100 ns.
776 * We use multiples of 1000 ns. So divide by 10.
xypron.glpk@gmx.de44c4be02017-07-18 20:17:23 +0200777 */
Heinrich Schuchardt368ca642017-10-05 16:14:14 +0200778 do_div(trigger_time, 10);
Alexander Grafc15d9212016-03-04 01:09:59 +0100779
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100780 switch (type) {
781 case EFI_TIMER_STOP:
782 event->trigger_next = -1ULL;
783 break;
784 case EFI_TIMER_PERIODIC:
785 case EFI_TIMER_RELATIVE:
786 event->trigger_next = timer_get_us() + trigger_time;
787 break;
788 default:
789 return EFI_INVALID_PARAMETER;
Alexander Grafc15d9212016-03-04 01:09:59 +0100790 }
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100791 event->trigger_type = type;
792 event->trigger_time = trigger_time;
793 event->is_signaled = false;
794 return EFI_SUCCESS;
Alexander Grafc15d9212016-03-04 01:09:59 +0100795}
796
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200797/**
Mario Six8fac2912018-07-10 08:40:17 +0200798 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
799 * event
800 * @event: event for which the timer is set
801 * @type: type of the timer
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200802 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200803 *
804 * This function implements the SetTimer service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200805 *
Mario Six8fac2912018-07-10 08:40:17 +0200806 * See the Unified Extensible Firmware Interface (UEFI) specification for
807 * details.
808 *
809 *
810 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200811 */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200812static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
813 enum efi_timer_delay type,
814 uint64_t trigger_time)
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200815{
Masahiro Yamadac7570a32018-08-06 20:47:40 +0900816 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200817 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
818}
819
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200820/**
Mario Six8fac2912018-07-10 08:40:17 +0200821 * efi_wait_for_event() - wait for events to be signaled
822 * @num_events: number of events to be waited for
823 * @event: events to be waited for
824 * @index: index of the event that was signaled
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200825 *
826 * This function implements the WaitForEvent service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200827 *
Mario Six8fac2912018-07-10 08:40:17 +0200828 * See the Unified Extensible Firmware Interface (UEFI) specification for
829 * details.
830 *
831 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200832 */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100833static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200834 struct efi_event **event,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100835 efi_uintn_t *index)
Alexander Grafc15d9212016-03-04 01:09:59 +0100836{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100837 int i;
Alexander Grafc15d9212016-03-04 01:09:59 +0100838
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100839 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
Alexander Grafc15d9212016-03-04 01:09:59 +0100840
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200841 /* Check parameters */
842 if (!num_events || !event)
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200844 /* Check TPL */
845 if (efi_tpl != TPL_APPLICATION)
846 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200847 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100848 if (efi_is_event(event[i]) != EFI_SUCCESS)
849 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200850 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
851 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200852 if (!event[i]->is_signaled)
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100853 efi_queue_event(event[i], true);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200854 }
855
856 /* Wait for signal */
857 for (;;) {
858 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200859 if (event[i]->is_signaled)
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200860 goto out;
861 }
862 /* Allow events to occur. */
863 efi_timer_check();
864 }
865
866out:
867 /*
868 * Reset the signal which is passed to the caller to allow periodic
869 * events to occur.
870 */
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200871 event[i]->is_signaled = false;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200872 if (index)
873 *index = i;
Alexander Grafc15d9212016-03-04 01:09:59 +0100874
875 return EFI_EXIT(EFI_SUCCESS);
876}
877
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200878/**
Mario Six8fac2912018-07-10 08:40:17 +0200879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200881 *
882 * This function implements the SignalEvent service.
Mario Six8fac2912018-07-10 08:40:17 +0200883 *
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
885 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200886 *
887 * This functions sets the signaled state of the event and queues the
888 * notification function for execution.
889 *
Mario Six8fac2912018-07-10 08:40:17 +0200890 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200891 */
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200892static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100893{
894 EFI_ENTRY("%p", event);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100895 if (efi_is_event(event) != EFI_SUCCESS)
896 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100897 efi_signal_event(event, true);
Alexander Grafc15d9212016-03-04 01:09:59 +0100898 return EFI_EXIT(EFI_SUCCESS);
899}
900
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200901/**
Mario Six8fac2912018-07-10 08:40:17 +0200902 * efi_close_event() - close an EFI event
903 * @event: event to close
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200904 *
905 * This function implements the CloseEvent service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200906 *
Mario Six8fac2912018-07-10 08:40:17 +0200907 * See the Unified Extensible Firmware Interface (UEFI) specification for
908 * details.
909 *
910 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200911 */
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200912static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100913{
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200914 struct efi_register_notify_event *item, *next;
915
Alexander Grafc15d9212016-03-04 01:09:59 +0100916 EFI_ENTRY("%p", event);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100917 if (efi_is_event(event) != EFI_SUCCESS)
918 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200919
920 /* Remove protocol notify registrations for the event */
921 list_for_each_entry_safe(item, next, &efi_register_notify_events,
922 link) {
923 if (event == item->event) {
924 list_del(&item->link);
925 free(item);
926 }
927 }
928
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100929 list_del(&event->link);
930 free(event);
931 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +0100932}
933
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200934/**
Mario Six8fac2912018-07-10 08:40:17 +0200935 * efi_check_event() - check if an event is signaled
936 * @event: event to check
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200937 *
938 * This function implements the CheckEvent service.
Mario Six8fac2912018-07-10 08:40:17 +0200939 *
940 * See the Unified Extensible Firmware Interface (UEFI) specification for
941 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200942 *
Mario Six8fac2912018-07-10 08:40:17 +0200943 * If an event is not signaled yet, the notification function is queued. The
944 * signaled state is cleared.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200945 *
Mario Six8fac2912018-07-10 08:40:17 +0200946 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200947 */
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200948static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100949{
950 EFI_ENTRY("%p", event);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200951 efi_timer_check();
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100952 if (efi_is_event(event) != EFI_SUCCESS ||
953 event->type & EVT_NOTIFY_SIGNAL)
954 return EFI_EXIT(EFI_INVALID_PARAMETER);
955 if (!event->is_signaled)
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100956 efi_queue_event(event, true);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100957 if (event->is_signaled) {
958 event->is_signaled = false;
959 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200960 }
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100961 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafc15d9212016-03-04 01:09:59 +0100962}
963
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200964/**
Mario Six8fac2912018-07-10 08:40:17 +0200965 * efi_search_obj() - find the internal EFI object for a handle
966 * @handle: handle to find
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200967 *
Mario Six8fac2912018-07-10 08:40:17 +0200968 * Return: EFI object
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200969 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100970struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200971{
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100972 struct efi_object *efiobj;
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200973
Heinrich Schuchardt5d8231b2019-05-05 10:37:51 +0200974 if (!handle)
975 return NULL;
976
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100977 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200978 if (efiobj == handle)
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200979 return efiobj;
980 }
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200981 return NULL;
982}
983
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200984/**
Mario Six8fac2912018-07-10 08:40:17 +0200985 * efi_open_protocol_info_entry() - create open protocol info entry and add it
986 * to a protocol
987 * @handler: handler of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100988 *
Mario Six8fac2912018-07-10 08:40:17 +0200989 * Return: open protocol info entry
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100990 */
991static struct efi_open_protocol_info_entry *efi_create_open_info(
992 struct efi_handler *handler)
993{
994 struct efi_open_protocol_info_item *item;
995
996 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
997 if (!item)
998 return NULL;
999 /* Append the item to the open protocol info list. */
1000 list_add_tail(&item->link, &handler->open_infos);
1001
1002 return &item->info;
1003}
1004
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001005/**
Mario Six8fac2912018-07-10 08:40:17 +02001006 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1007 * @item: open protocol info entry to delete
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +01001008 *
Mario Six8fac2912018-07-10 08:40:17 +02001009 * Return: status code
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +01001010 */
1011static efi_status_t efi_delete_open_info(
1012 struct efi_open_protocol_info_item *item)
1013{
1014 list_del(&item->link);
1015 free(item);
1016 return EFI_SUCCESS;
1017}
1018
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001019/**
Mario Six8fac2912018-07-10 08:40:17 +02001020 * efi_add_protocol() - install new protocol on a handle
1021 * @handle: handle on which the protocol shall be installed
1022 * @protocol: GUID of the protocol to be installed
1023 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001024 *
Mario Six8fac2912018-07-10 08:40:17 +02001025 * Return: status code
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001026 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01001027efi_status_t efi_add_protocol(const efi_handle_t handle,
1028 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001029 void *protocol_interface)
1030{
1031 struct efi_object *efiobj;
1032 struct efi_handler *handler;
1033 efi_status_t ret;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001034 struct efi_register_notify_event *event;
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001035
1036 efiobj = efi_search_obj(handle);
1037 if (!efiobj)
1038 return EFI_INVALID_PARAMETER;
1039 ret = efi_search_protocol(handle, protocol, NULL);
1040 if (ret != EFI_NOT_FOUND)
1041 return EFI_INVALID_PARAMETER;
1042 handler = calloc(1, sizeof(struct efi_handler));
1043 if (!handler)
1044 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01001045 handler->guid = protocol;
1046 handler->protocol_interface = protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +01001047 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01001048 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001049
1050 /* Notify registered events */
1051 list_for_each_entry(event, &efi_register_notify_events, link) {
1052 if (!guidcmp(protocol, &event->protocol))
1053 efi_signal_event(event->event, true);
1054 }
1055
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +01001056 if (!guidcmp(&efi_guid_device_path, protocol))
1057 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01001058 return EFI_SUCCESS;
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001059}
1060
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001061/**
Mario Six8fac2912018-07-10 08:40:17 +02001062 * efi_install_protocol_interface() - install protocol interface
1063 * @handle: handle on which the protocol shall be installed
1064 * @protocol: GUID of the protocol to be installed
1065 * @protocol_interface_type: type of the interface to be installed,
1066 * always EFI_NATIVE_INTERFACE
1067 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001068 *
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001069 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001070 *
Mario Six8fac2912018-07-10 08:40:17 +02001071 * See the Unified Extensible Firmware Interface (UEFI) specification for
1072 * details.
1073 *
1074 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001075 */
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001076static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02001077 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001078 int protocol_interface_type, void *protocol_interface)
Alexander Grafc15d9212016-03-04 01:09:59 +01001079{
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001080 efi_status_t r;
1081
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001082 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1083 protocol_interface);
1084
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001085 if (!handle || !protocol ||
1086 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1087 r = EFI_INVALID_PARAMETER;
1088 goto out;
1089 }
1090
1091 /* Create new handle if requested. */
1092 if (!*handle) {
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +02001093 r = efi_create_handle(handle);
1094 if (r != EFI_SUCCESS)
1095 goto out;
Heinrich Schuchardt50f02102017-10-26 19:25:43 +02001096 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1097 *handle);
1098 } else {
1099 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1100 *handle);
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001101 }
Heinrich Schuchardt865d5f32017-10-26 19:25:54 +02001102 /* Add new protocol */
1103 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001104out:
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001105 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01001106}
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001107
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001108/**
Mario Six8fac2912018-07-10 08:40:17 +02001109 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001110 * @handle: handle of the controller
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001111 * @protocol: protocol GUID (optional)
Mario Six8fac2912018-07-10 08:40:17 +02001112 * @number_of_drivers: number of child controllers
1113 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001114 *
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001115 * The allocated buffer has to be freed with free().
1116 *
Mario Six8fac2912018-07-10 08:40:17 +02001117 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001118 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001119static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001120 const efi_guid_t *protocol,
1121 efi_uintn_t *number_of_drivers,
1122 efi_handle_t **driver_handle_buffer)
1123{
1124 struct efi_handler *handler;
1125 struct efi_open_protocol_info_item *item;
1126 efi_uintn_t count = 0, i;
1127 bool duplicate;
1128
1129 /* Count all driver associations */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001130 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001131 if (protocol && guidcmp(handler->guid, protocol))
1132 continue;
1133 list_for_each_entry(item, &handler->open_infos, link) {
1134 if (item->info.attributes &
1135 EFI_OPEN_PROTOCOL_BY_DRIVER)
1136 ++count;
1137 }
1138 }
1139 /*
1140 * Create buffer. In case of duplicate driver assignments the buffer
1141 * will be too large. But that does not harm.
1142 */
1143 *number_of_drivers = 0;
1144 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1145 if (!*driver_handle_buffer)
1146 return EFI_OUT_OF_RESOURCES;
1147 /* Collect unique driver handles */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001148 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001149 if (protocol && guidcmp(handler->guid, protocol))
1150 continue;
1151 list_for_each_entry(item, &handler->open_infos, link) {
1152 if (item->info.attributes &
1153 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1154 /* Check this is a new driver */
1155 duplicate = false;
1156 for (i = 0; i < *number_of_drivers; ++i) {
1157 if ((*driver_handle_buffer)[i] ==
1158 item->info.agent_handle)
1159 duplicate = true;
1160 }
1161 /* Copy handle to buffer */
1162 if (!duplicate) {
1163 i = (*number_of_drivers)++;
1164 (*driver_handle_buffer)[i] =
1165 item->info.agent_handle;
1166 }
1167 }
1168 }
1169 }
1170 return EFI_SUCCESS;
1171}
1172
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001173/**
Mario Six8fac2912018-07-10 08:40:17 +02001174 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001175 * @handle: handle of the controller
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001176 * @protocol: protocol GUID (optional)
Mario Six8fac2912018-07-10 08:40:17 +02001177 * @child_handle: handle of the child to destroy
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001178 *
1179 * This function implements the DisconnectController service.
Mario Six8fac2912018-07-10 08:40:17 +02001180 *
1181 * See the Unified Extensible Firmware Interface (UEFI) specification for
1182 * details.
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001183 *
Mario Six8fac2912018-07-10 08:40:17 +02001184 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001185 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001186static efi_status_t efi_disconnect_all_drivers
1187 (efi_handle_t handle,
1188 const efi_guid_t *protocol,
1189 efi_handle_t child_handle)
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001190{
1191 efi_uintn_t number_of_drivers;
1192 efi_handle_t *driver_handle_buffer;
1193 efi_status_t r, ret;
1194
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001195 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001196 &driver_handle_buffer);
1197 if (ret != EFI_SUCCESS)
1198 return ret;
1199
1200 ret = EFI_NOT_FOUND;
1201 while (number_of_drivers) {
1202 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001203 handle,
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001204 driver_handle_buffer[--number_of_drivers],
1205 child_handle));
1206 if (r == EFI_SUCCESS)
1207 ret = r;
1208 }
1209 free(driver_handle_buffer);
1210 return ret;
1211}
1212
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001213/**
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001214 * efi_uninstall_protocol() - uninstall protocol interface
1215 *
Mario Six8fac2912018-07-10 08:40:17 +02001216 * @handle: handle from which the protocol shall be removed
1217 * @protocol: GUID of the protocol to be removed
1218 * @protocol_interface: interface to be removed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001219 *
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001220 * This function DOES NOT delete a handle without installed protocol.
Mario Six8fac2912018-07-10 08:40:17 +02001221 *
1222 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001223 */
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001224static efi_status_t efi_uninstall_protocol
1225 (efi_handle_t handle, const efi_guid_t *protocol,
1226 void *protocol_interface)
Alexander Grafc15d9212016-03-04 01:09:59 +01001227{
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001228 struct efi_object *efiobj;
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001229 struct efi_handler *handler;
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001230 struct efi_open_protocol_info_item *item;
1231 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001232 efi_status_t r;
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001233
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001234 /* Check handle */
1235 efiobj = efi_search_obj(handle);
1236 if (!efiobj) {
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001237 r = EFI_INVALID_PARAMETER;
1238 goto out;
1239 }
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001240 /* Find the protocol on the handle */
1241 r = efi_search_protocol(handle, protocol, &handler);
1242 if (r != EFI_SUCCESS)
1243 goto out;
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001244 /* Disconnect controllers */
1245 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1246 if (!list_empty(&handler->open_infos)) {
1247 r = EFI_ACCESS_DENIED;
1248 goto out;
1249 }
1250 /* Close protocol */
1251 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1252 if (item->info.attributes ==
1253 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1254 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1255 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1256 list_del(&item->link);
1257 }
1258 if (!list_empty(&handler->open_infos)) {
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001259 r = EFI_ACCESS_DENIED;
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001260 goto out;
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001261 }
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001262 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001263out:
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001264 return r;
Alexander Grafc15d9212016-03-04 01:09:59 +01001265}
1266
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001267/**
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001268 * efi_uninstall_protocol_interface() - uninstall protocol interface
1269 * @handle: handle from which the protocol shall be removed
1270 * @protocol: GUID of the protocol to be removed
1271 * @protocol_interface: interface to be removed
1272 *
1273 * This function implements the UninstallProtocolInterface service.
1274 *
1275 * See the Unified Extensible Firmware Interface (UEFI) specification for
1276 * details.
1277 *
1278 * Return: status code
1279 */
1280static efi_status_t EFIAPI efi_uninstall_protocol_interface
1281 (efi_handle_t handle, const efi_guid_t *protocol,
1282 void *protocol_interface)
1283{
1284 efi_status_t ret;
1285
1286 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1287
1288 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1289 if (ret != EFI_SUCCESS)
1290 goto out;
1291
1292 /* If the last protocol has been removed, delete the handle. */
1293 if (list_empty(&handle->protocols)) {
1294 list_del(&handle->link);
1295 free(handle);
1296 }
1297out:
1298 return EFI_EXIT(ret);
1299}
1300
1301/**
Mario Six8fac2912018-07-10 08:40:17 +02001302 * efi_register_protocol_notify() - register an event for notification when a
1303 * protocol is installed.
1304 * @protocol: GUID of the protocol whose installation shall be notified
1305 * @event: event to be signaled upon installation of the protocol
1306 * @registration: key for retrieving the registration information
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001307 *
1308 * This function implements the RegisterProtocolNotify service.
1309 * See the Unified Extensible Firmware Interface (UEFI) specification
1310 * for details.
1311 *
Mario Six8fac2912018-07-10 08:40:17 +02001312 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001313 */
Heinrich Schuchardte547c662017-10-05 16:35:53 +02001314static efi_status_t EFIAPI efi_register_protocol_notify(
1315 const efi_guid_t *protocol,
1316 struct efi_event *event,
1317 void **registration)
Alexander Grafc15d9212016-03-04 01:09:59 +01001318{
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001319 struct efi_register_notify_event *item;
1320 efi_status_t ret = EFI_SUCCESS;
1321
Rob Clark238f88c2017-09-13 18:05:41 -04001322 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001323
1324 if (!protocol || !event || !registration) {
1325 ret = EFI_INVALID_PARAMETER;
1326 goto out;
1327 }
1328
1329 item = calloc(1, sizeof(struct efi_register_notify_event));
1330 if (!item) {
1331 ret = EFI_OUT_OF_RESOURCES;
1332 goto out;
1333 }
1334
1335 item->event = event;
1336 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1337
1338 list_add_tail(&item->link, &efi_register_notify_events);
1339
1340 *registration = item;
1341out:
1342 return EFI_EXIT(ret);
Alexander Grafc15d9212016-03-04 01:09:59 +01001343}
1344
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001345/**
Mario Six8fac2912018-07-10 08:40:17 +02001346 * efi_search() - determine if an EFI handle implements a protocol
1347 * @search_type: selection criterion
1348 * @protocol: GUID of the protocol
1349 * @search_key: registration key
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001350 * @handle: handle
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001351 *
1352 * See the documentation of the LocateHandle service in the UEFI specification.
1353 *
Mario Six8fac2912018-07-10 08:40:17 +02001354 * Return: 0 if the handle implements the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001355 */
Alexander Grafc15d9212016-03-04 01:09:59 +01001356static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001357 const efi_guid_t *protocol, efi_handle_t handle)
Alexander Grafc15d9212016-03-04 01:09:59 +01001358{
Heinrich Schuchardt6a430752017-10-26 19:25:55 +02001359 efi_status_t ret;
Alexander Grafc15d9212016-03-04 01:09:59 +01001360
1361 switch (search_type) {
Heinrich Schuchardt68845f02017-11-06 21:17:42 +01001362 case ALL_HANDLES:
Alexander Grafc15d9212016-03-04 01:09:59 +01001363 return 0;
Heinrich Schuchardt68845f02017-11-06 21:17:42 +01001364 case BY_REGISTER_NOTIFY:
Heinrich Schuchardt68845f02017-11-06 21:17:42 +01001365 case BY_PROTOCOL:
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001366 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt6a430752017-10-26 19:25:55 +02001367 return (ret != EFI_SUCCESS);
1368 default:
1369 /* Invalid search type */
Alexander Grafc15d9212016-03-04 01:09:59 +01001370 return -1;
1371 }
Alexander Grafc15d9212016-03-04 01:09:59 +01001372}
1373
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001374/**
Mario Six8fac2912018-07-10 08:40:17 +02001375 * efi_locate_handle() - locate handles implementing a protocol
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001376 *
1377 * @search_type: selection criterion
1378 * @protocol: GUID of the protocol
1379 * @search_key: registration key
1380 * @buffer_size: size of the buffer to receive the handles in bytes
1381 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001382 *
1383 * This function is meant for U-Boot internal calls. For the API implementation
1384 * of the LocateHandle service see efi_locate_handle_ext.
1385 *
Mario Six8fac2912018-07-10 08:40:17 +02001386 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001387 */
xypron.glpk@gmx.decab4dd52017-08-09 20:55:00 +02001388static efi_status_t efi_locate_handle(
Alexander Grafc15d9212016-03-04 01:09:59 +01001389 enum efi_locate_search_type search_type,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02001390 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01001391 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +01001392{
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001393 struct efi_object *efiobj;
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01001394 efi_uintn_t size = 0;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001395 struct efi_register_notify_event *item, *event = NULL;
Alexander Grafc15d9212016-03-04 01:09:59 +01001396
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001397 /* Check parameters */
1398 switch (search_type) {
1399 case ALL_HANDLES:
1400 break;
1401 case BY_REGISTER_NOTIFY:
1402 if (!search_key)
1403 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001404 /* Check that the registration key is valid */
1405 list_for_each_entry(item, &efi_register_notify_events, link) {
1406 if (item ==
1407 (struct efi_register_notify_event *)search_key) {
1408 event = item;
1409 break;
1410 }
1411 }
1412 if (!event)
1413 return EFI_INVALID_PARAMETER;
1414
1415 protocol = &event->protocol;
1416 break;
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001417 case BY_PROTOCOL:
1418 if (!protocol)
1419 return EFI_INVALID_PARAMETER;
1420 break;
1421 default:
1422 return EFI_INVALID_PARAMETER;
1423 }
1424
Alexander Grafc15d9212016-03-04 01:09:59 +01001425 /* Count how much space we need */
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001426 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001427 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardt91064592018-02-18 15:17:49 +01001428 size += sizeof(void *);
Alexander Grafc15d9212016-03-04 01:09:59 +01001429 }
1430
Heinrich Schuchardtc0ee5f32019-05-04 17:37:32 +02001431 if (size == 0)
1432 return EFI_NOT_FOUND;
1433
1434 if (!buffer_size)
1435 return EFI_INVALID_PARAMETER;
1436
Alexander Grafc15d9212016-03-04 01:09:59 +01001437 if (*buffer_size < size) {
1438 *buffer_size = size;
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001439 return EFI_BUFFER_TOO_SMALL;
Alexander Grafc15d9212016-03-04 01:09:59 +01001440 }
1441
Rob Clarkcdee3372017-08-06 14:10:07 -04001442 *buffer_size = size;
Heinrich Schuchardtc0ee5f32019-05-04 17:37:32 +02001443
1444 /* The buffer size is sufficient but there is not buffer */
1445 if (!buffer)
1446 return EFI_INVALID_PARAMETER;
Rob Clarkcdee3372017-08-06 14:10:07 -04001447
Alexander Grafc15d9212016-03-04 01:09:59 +01001448 /* Then fill the array */
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001449 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001450 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001451 *buffer++ = efiobj;
Alexander Grafc15d9212016-03-04 01:09:59 +01001452 }
1453
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001454 return EFI_SUCCESS;
1455}
1456
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001457/**
Mario Six8fac2912018-07-10 08:40:17 +02001458 * efi_locate_handle_ext() - locate handles implementing a protocol.
1459 * @search_type: selection criterion
1460 * @protocol: GUID of the protocol
1461 * @search_key: registration key
1462 * @buffer_size: size of the buffer to receive the handles in bytes
1463 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001464 *
1465 * This function implements the LocateHandle service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001466 *
Mario Six8fac2912018-07-10 08:40:17 +02001467 * See the Unified Extensible Firmware Interface (UEFI) specification for
1468 * details.
1469 *
1470 * Return: 0 if the handle implements the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001471 */
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001472static efi_status_t EFIAPI efi_locate_handle_ext(
1473 enum efi_locate_search_type search_type,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02001474 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01001475 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001476{
Rob Clark238f88c2017-09-13 18:05:41 -04001477 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001478 buffer_size, buffer);
1479
1480 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1481 buffer_size, buffer));
Alexander Grafc15d9212016-03-04 01:09:59 +01001482}
1483
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001484/**
Mario Six8fac2912018-07-10 08:40:17 +02001485 * efi_remove_configuration_table() - collapses configuration table entries,
1486 * removing index i
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001487 *
Mario Six8fac2912018-07-10 08:40:17 +02001488 * @i: index of the table entry to be removed
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001489 */
Alexander Graffe3366f2017-07-26 13:41:04 +02001490static void efi_remove_configuration_table(int i)
1491{
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001492 struct efi_configuration_table *this = &systab.tables[i];
1493 struct efi_configuration_table *next = &systab.tables[i + 1];
1494 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Graffe3366f2017-07-26 13:41:04 +02001495
1496 memmove(this, next, (ulong)end - (ulong)next);
1497 systab.nr_tables--;
1498}
1499
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001500/**
Mario Six8fac2912018-07-10 08:40:17 +02001501 * efi_install_configuration_table() - adds, updates, or removes a
1502 * configuration table
1503 * @guid: GUID of the installed table
1504 * @table: table to be installed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001505 *
1506 * This function is used for internal calls. For the API implementation of the
1507 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1508 *
Mario Six8fac2912018-07-10 08:40:17 +02001509 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001510 */
Heinrich Schuchardt91064592018-02-18 15:17:49 +01001511efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1512 void *table)
Alexander Grafc15d9212016-03-04 01:09:59 +01001513{
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001514 struct efi_event *evt;
Alexander Grafc15d9212016-03-04 01:09:59 +01001515 int i;
1516
Heinrich Schuchardt754ce102018-02-18 00:08:00 +01001517 if (!guid)
1518 return EFI_INVALID_PARAMETER;
1519
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001520 /* Check for GUID override */
Alexander Grafc15d9212016-03-04 01:09:59 +01001521 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001522 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Graffe3366f2017-07-26 13:41:04 +02001523 if (table)
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001524 systab.tables[i].table = table;
Alexander Graffe3366f2017-07-26 13:41:04 +02001525 else
1526 efi_remove_configuration_table(i);
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001527 goto out;
Alexander Grafc15d9212016-03-04 01:09:59 +01001528 }
1529 }
1530
Alexander Graffe3366f2017-07-26 13:41:04 +02001531 if (!table)
1532 return EFI_NOT_FOUND;
1533
Alexander Grafc15d9212016-03-04 01:09:59 +01001534 /* No override, check for overflow */
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001535 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Grafc5c11632016-08-19 01:23:24 +02001536 return EFI_OUT_OF_RESOURCES;
Alexander Grafc15d9212016-03-04 01:09:59 +01001537
1538 /* Add a new entry */
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001539 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1540 systab.tables[i].table = table;
Alexander Graf9982e672016-08-19 01:23:30 +02001541 systab.nr_tables = i + 1;
Alexander Grafc15d9212016-03-04 01:09:59 +01001542
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001543out:
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001544 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardtac2d4da2018-07-07 15:36:05 +02001545 efi_update_table_header_crc32(&systab.hdr);
1546
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001547 /* Notify that the configuration table was changed */
1548 list_for_each_entry(evt, &efi_events, link) {
1549 if (evt->group && !guidcmp(evt->group, guid)) {
1550 efi_signal_event(evt, false);
1551 break;
1552 }
1553 }
1554
Alexander Grafc5c11632016-08-19 01:23:24 +02001555 return EFI_SUCCESS;
Alexander Grafc15d9212016-03-04 01:09:59 +01001556}
1557
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001558/**
Mario Six8fac2912018-07-10 08:40:17 +02001559 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1560 * configuration table.
1561 * @guid: GUID of the installed table
1562 * @table: table to be installed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001563 *
1564 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001565 *
Mario Six8fac2912018-07-10 08:40:17 +02001566 * See the Unified Extensible Firmware Interface (UEFI) specification for
1567 * details.
1568 *
1569 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001570 */
Alexander Grafc5c11632016-08-19 01:23:24 +02001571static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1572 void *table)
1573{
Rob Clark238f88c2017-09-13 18:05:41 -04001574 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Grafc5c11632016-08-19 01:23:24 +02001575 return EFI_EXIT(efi_install_configuration_table(guid, table));
1576}
1577
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001578/**
Mario Six8fac2912018-07-10 08:40:17 +02001579 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001580 *
1581 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clarkf8db9222017-09-13 18:05:33 -04001582 * protocols, boot-device, etc.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001583 *
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001584 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1585 * code is returned.
1586 *
1587 * @device_path: device path of the loaded image
1588 * @file_path: file path of the loaded image
1589 * @handle_ptr: handle of the loaded image
1590 * @info_ptr: loaded image protocol
1591 * Return: status code
Rob Clarkf8db9222017-09-13 18:05:33 -04001592 */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001593efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1594 struct efi_device_path *file_path,
1595 struct efi_loaded_image_obj **handle_ptr,
1596 struct efi_loaded_image **info_ptr)
Rob Clarkf8db9222017-09-13 18:05:33 -04001597{
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001598 efi_status_t ret;
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001599 struct efi_loaded_image *info = NULL;
1600 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001601 struct efi_device_path *dp;
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001602
1603 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1604 *handle_ptr = NULL;
1605 *info_ptr = NULL;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001606
1607 info = calloc(1, sizeof(*info));
1608 if (!info)
1609 return EFI_OUT_OF_RESOURCES;
1610 obj = calloc(1, sizeof(*obj));
1611 if (!obj) {
1612 free(info);
1613 return EFI_OUT_OF_RESOURCES;
1614 }
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +02001615 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001616
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +01001617 /* Add internal object to object list */
Heinrich Schuchardt72928722018-09-26 05:27:56 +02001618 efi_add_handle(&obj->header);
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001619
Heinrich Schuchardtc47f8702018-07-05 08:17:58 +02001620 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001621 info->file_path = file_path;
Heinrich Schuchardt8a7e09d2018-08-26 15:31:52 +02001622 info->system_table = &systab;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001623
Heinrich Schuchardtf3996be2018-01-26 06:50:54 +01001624 if (device_path) {
1625 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001626
1627 dp = efi_dp_append(device_path, file_path);
1628 if (!dp) {
1629 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardtf3996be2018-01-26 06:50:54 +01001630 goto failure;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001631 }
1632 } else {
1633 dp = NULL;
Heinrich Schuchardtf3996be2018-01-26 06:50:54 +01001634 }
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001635 ret = efi_add_protocol(&obj->header,
1636 &efi_guid_loaded_image_device_path, dp);
1637 if (ret != EFI_SUCCESS)
1638 goto failure;
Rob Clarkf8db9222017-09-13 18:05:33 -04001639
1640 /*
1641 * When asking for the loaded_image interface, just
1642 * return handle which points to loaded_image_info
1643 */
Heinrich Schuchardt72928722018-09-26 05:27:56 +02001644 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001645 &efi_guid_loaded_image, info);
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001646 if (ret != EFI_SUCCESS)
1647 goto failure;
Rob Clarkf8db9222017-09-13 18:05:33 -04001648
Heinrich Schuchardtd20f5122019-03-19 18:58:58 +01001649 *info_ptr = info;
1650 *handle_ptr = obj;
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001651
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +01001652 return ret;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001653failure:
1654 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001655 efi_delete_handle(&obj->header);
1656 free(info);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +01001657 return ret;
Rob Clarkf8db9222017-09-13 18:05:33 -04001658}
1659
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001660/**
Mario Six8fac2912018-07-10 08:40:17 +02001661 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001662 *
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001663 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1664 * callers obligation to update the memory type as needed.
1665 *
1666 * @file_path: the path of the image to load
1667 * @buffer: buffer containing the loaded image
1668 * @size: size of the loaded image
1669 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001670 */
AKASHI Takahiro14ff23b2019-04-19 12:22:35 +09001671static
Rob Clarkc84c1102017-09-13 18:05:38 -04001672efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001673 void **buffer, efi_uintn_t *size)
Rob Clark857a1222017-09-13 18:05:35 -04001674{
1675 struct efi_file_info *info = NULL;
1676 struct efi_file_handle *f;
1677 static efi_status_t ret;
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001678 u64 addr;
Heinrich Schuchardt6b06e0d2018-04-03 22:37:11 +02001679 efi_uintn_t bs;
Rob Clark857a1222017-09-13 18:05:35 -04001680
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001681 /* In case of failure nothing is returned */
1682 *buffer = NULL;
1683 *size = 0;
1684
1685 /* Open file */
Rob Clark857a1222017-09-13 18:05:35 -04001686 f = efi_file_from_path(file_path);
1687 if (!f)
1688 return EFI_DEVICE_ERROR;
1689
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001690 /* Get file size */
Rob Clark857a1222017-09-13 18:05:35 -04001691 bs = 0;
1692 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1693 &bs, info));
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001694 if (ret != EFI_BUFFER_TOO_SMALL) {
1695 ret = EFI_DEVICE_ERROR;
Rob Clark857a1222017-09-13 18:05:35 -04001696 goto error;
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001697 }
Rob Clark857a1222017-09-13 18:05:35 -04001698
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001699 info = malloc(bs);
1700 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1701 info));
1702 if (ret != EFI_SUCCESS)
Rob Clark857a1222017-09-13 18:05:35 -04001703 goto error;
1704
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001705 /*
1706 * When reading the file we do not yet know if it contains an
1707 * application, a boottime driver, or a runtime driver. So here we
1708 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1709 * update the reservation according to the image type.
1710 */
Heinrich Schuchardt6b06e0d2018-04-03 22:37:11 +02001711 bs = info->file_size;
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001712 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1713 EFI_BOOT_SERVICES_DATA,
1714 efi_size_in_pages(bs), &addr);
Rob Clark857a1222017-09-13 18:05:35 -04001715 if (ret != EFI_SUCCESS) {
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001716 ret = EFI_OUT_OF_RESOURCES;
1717 goto error;
Rob Clark857a1222017-09-13 18:05:35 -04001718 }
1719
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001720 /* Read file */
1721 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1722 if (ret != EFI_SUCCESS)
1723 efi_free_pages(addr, efi_size_in_pages(bs));
1724 *buffer = (void *)(uintptr_t)addr;
1725 *size = bs;
1726error:
1727 EFI_CALL(f->close(f));
1728 free(info);
Rob Clark857a1222017-09-13 18:05:35 -04001729 return ret;
1730}
1731
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001732/**
Mario Six8fac2912018-07-10 08:40:17 +02001733 * efi_load_image() - load an EFI image into memory
1734 * @boot_policy: true for request originating from the boot manager
1735 * @parent_image: the caller's image handle
1736 * @file_path: the path of the image to load
1737 * @source_buffer: memory location from which the image is installed
1738 * @source_size: size of the memory area from which the image is installed
1739 * @image_handle: handle for the newly installed image
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001740 *
1741 * This function implements the LoadImage service.
Mario Six8fac2912018-07-10 08:40:17 +02001742 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001743 * See the Unified Extensible Firmware Interface (UEFI) specification
1744 * for details.
1745 *
Mario Six8fac2912018-07-10 08:40:17 +02001746 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001747 */
AKASHI Takahirob0ad9052019-03-05 14:53:31 +09001748efi_status_t EFIAPI efi_load_image(bool boot_policy,
1749 efi_handle_t parent_image,
1750 struct efi_device_path *file_path,
1751 void *source_buffer,
1752 efi_uintn_t source_size,
1753 efi_handle_t *image_handle)
Alexander Grafc15d9212016-03-04 01:09:59 +01001754{
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001755 struct efi_device_path *dp, *fp;
Tom Rini04c49062018-09-30 10:38:15 -04001756 struct efi_loaded_image *info = NULL;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001757 struct efi_loaded_image_obj **image_obj =
1758 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtd4d7ca92017-12-04 18:03:03 +01001759 efi_status_t ret;
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001760 void *dest_buffer;
Alexander Grafc15d9212016-03-04 01:09:59 +01001761
Heinrich Schuchardt4cde1fa2018-04-03 22:29:30 +02001762 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafc15d9212016-03-04 01:09:59 +01001763 file_path, source_buffer, source_size, image_handle);
Rob Clark857a1222017-09-13 18:05:35 -04001764
Heinrich Schuchardtc935c2f2018-03-07 02:40:51 +01001765 if (!image_handle || !parent_image) {
1766 ret = EFI_INVALID_PARAMETER;
1767 goto error;
1768 }
1769
1770 if (!source_buffer && !file_path) {
1771 ret = EFI_NOT_FOUND;
1772 goto error;
1773 }
Rob Clark857a1222017-09-13 18:05:35 -04001774
1775 if (!source_buffer) {
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001776 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001777 &source_size);
Heinrich Schuchardtd4d7ca92017-12-04 18:03:03 +01001778 if (ret != EFI_SUCCESS)
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001779 goto error;
Rob Clark857a1222017-09-13 18:05:35 -04001780 } else {
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001781 dest_buffer = source_buffer;
Rob Clark857a1222017-09-13 18:05:35 -04001782 }
Heinrich Schuchardt28b39172019-04-20 19:24:43 +00001783 /* split file_path which contains both the device and file parts */
1784 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001785 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001786 if (ret == EFI_SUCCESS)
1787 ret = efi_load_pe(*image_obj, dest_buffer, info);
1788 if (!source_buffer)
1789 /* Release buffer to which file was loaded */
1790 efi_free_pages((uintptr_t)dest_buffer,
1791 efi_size_in_pages(source_size));
1792 if (ret == EFI_SUCCESS) {
1793 info->system_table = &systab;
1794 info->parent_handle = parent_image;
1795 } else {
1796 /* The image is invalid. Release all associated resources. */
1797 efi_delete_handle(*image_handle);
1798 *image_handle = NULL;
1799 free(info);
1800 }
Heinrich Schuchardtc935c2f2018-03-07 02:40:51 +01001801error:
Heinrich Schuchardtd4d7ca92017-12-04 18:03:03 +01001802 return EFI_EXIT(ret);
Alexander Grafc15d9212016-03-04 01:09:59 +01001803}
1804
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001805/**
Alexander Graffa5246b2018-11-15 21:23:47 +01001806 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1807 */
1808static void efi_exit_caches(void)
1809{
1810#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1811 /*
1812 * Grub on 32bit ARM needs to have caches disabled before jumping into
1813 * a zImage, but does not know of all cache layers. Give it a hand.
1814 */
1815 if (efi_is_direct_boot)
1816 cleanup_before_linux();
1817#endif
1818}
1819
1820/**
Mario Six8fac2912018-07-10 08:40:17 +02001821 * efi_exit_boot_services() - stop all boot services
1822 * @image_handle: handle of the loaded image
1823 * @map_key: key of the memory map
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001824 *
1825 * This function implements the ExitBootServices service.
Mario Six8fac2912018-07-10 08:40:17 +02001826 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001827 * See the Unified Extensible Firmware Interface (UEFI) specification
1828 * for details.
1829 *
Mario Six8fac2912018-07-10 08:40:17 +02001830 * All timer events are disabled. For exit boot services events the
1831 * notification function is called. The boot services are disabled in the
1832 * system table.
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001833 *
Mario Six8fac2912018-07-10 08:40:17 +02001834 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001835 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01001836static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Alexander Grafc15d9212016-03-04 01:09:59 +01001837 unsigned long map_key)
1838{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +01001839 struct efi_event *evt;
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001840
Alexander Grafc15d9212016-03-04 01:09:59 +01001841 EFI_ENTRY("%p, %ld", image_handle, map_key);
1842
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +02001843 /* Check that the caller has read the current memory map */
1844 if (map_key != efi_memory_map_key)
1845 return EFI_INVALID_PARAMETER;
1846
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001847 /* Make sure that notification functions are not called anymore */
1848 efi_tpl = TPL_HIGH_LEVEL;
1849
1850 /* Check if ExitBootServices has already been called */
1851 if (!systab.boottime)
1852 return EFI_EXIT(EFI_SUCCESS);
1853
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001854 /* Add related events to the event group */
1855 list_for_each_entry(evt, &efi_events, link) {
1856 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1857 evt->group = &efi_guid_event_group_exit_boot_services;
1858 }
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001859 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +01001860 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001861 if (evt->group &&
1862 !guidcmp(evt->group,
1863 &efi_guid_event_group_exit_boot_services)) {
1864 efi_signal_event(evt, false);
1865 break;
1866 }
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001867 }
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001868
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001869 /* TODO: Should persist EFI variables here */
Rob Clark15f3d742017-09-13 18:05:37 -04001870
Alexander Graf2ebeb442016-11-17 01:02:57 +01001871 board_quiesce_devices();
1872
Alexander Graffa5246b2018-11-15 21:23:47 +01001873 /* Fix up caches for EFI payloads if necessary */
1874 efi_exit_caches();
1875
Alexander Grafc15d9212016-03-04 01:09:59 +01001876 /* This stops all lingering devices */
1877 bootm_disable_interrupts();
1878
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001879 /* Disable boot time services */
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001880 systab.con_in_handle = NULL;
1881 systab.con_in = NULL;
1882 systab.con_out_handle = NULL;
1883 systab.con_out = NULL;
1884 systab.stderr_handle = NULL;
1885 systab.std_err = NULL;
1886 systab.boottime = NULL;
1887
1888 /* Recalculate CRC32 */
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02001889 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001890
Alexander Grafc15d9212016-03-04 01:09:59 +01001891 /* Give the payload some time to boot */
Heinrich Schuchardt18081d42017-10-18 18:13:04 +02001892 efi_set_watchdog(0);
Alexander Grafc15d9212016-03-04 01:09:59 +01001893 WATCHDOG_RESET();
1894
1895 return EFI_EXIT(EFI_SUCCESS);
1896}
1897
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001898/**
Mario Six8fac2912018-07-10 08:40:17 +02001899 * efi_get_next_monotonic_count() - get next value of the counter
1900 * @count: returned value of the counter
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001901 *
1902 * This function implements the NextMonotonicCount service.
Mario Six8fac2912018-07-10 08:40:17 +02001903 *
1904 * See the Unified Extensible Firmware Interface (UEFI) specification for
1905 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001906 *
Mario Six8fac2912018-07-10 08:40:17 +02001907 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001908 */
Alexander Grafc15d9212016-03-04 01:09:59 +01001909static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1910{
Heinrich Schuchardt91064592018-02-18 15:17:49 +01001911 static uint64_t mono;
1912
Alexander Grafc15d9212016-03-04 01:09:59 +01001913 EFI_ENTRY("%p", count);
1914 *count = mono++;
1915 return EFI_EXIT(EFI_SUCCESS);
1916}
1917
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001918/**
Mario Six8fac2912018-07-10 08:40:17 +02001919 * efi_stall() - sleep
1920 * @microseconds: period to sleep in microseconds
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001921 *
Mario Six8fac2912018-07-10 08:40:17 +02001922 * This function implements the Stall service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001923 *
Mario Six8fac2912018-07-10 08:40:17 +02001924 * See the Unified Extensible Firmware Interface (UEFI) specification for
1925 * details.
1926 *
1927 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001928 */
Alexander Grafc15d9212016-03-04 01:09:59 +01001929static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1930{
1931 EFI_ENTRY("%ld", microseconds);
1932 udelay(microseconds);
1933 return EFI_EXIT(EFI_SUCCESS);
1934}
1935
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001936/**
Mario Six8fac2912018-07-10 08:40:17 +02001937 * efi_set_watchdog_timer() - reset the watchdog timer
1938 * @timeout: seconds before reset by watchdog
1939 * @watchdog_code: code to be logged when resetting
1940 * @data_size: size of buffer in bytes
1941 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001942 *
Heinrich Schuchardt18081d42017-10-18 18:13:04 +02001943 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001944 *
Mario Six8fac2912018-07-10 08:40:17 +02001945 * See the Unified Extensible Firmware Interface (UEFI) specification for
1946 * details.
1947 *
1948 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001949 */
Alexander Grafc15d9212016-03-04 01:09:59 +01001950static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1951 uint64_t watchdog_code,
1952 unsigned long data_size,
1953 uint16_t *watchdog_data)
1954{
Masahiro Yamadac7570a32018-08-06 20:47:40 +09001955 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafc15d9212016-03-04 01:09:59 +01001956 data_size, watchdog_data);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +02001957 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafc15d9212016-03-04 01:09:59 +01001958}
1959
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001960/**
Mario Six8fac2912018-07-10 08:40:17 +02001961 * efi_close_protocol() - close a protocol
1962 * @handle: handle on which the protocol shall be closed
1963 * @protocol: GUID of the protocol to close
1964 * @agent_handle: handle of the driver
1965 * @controller_handle: handle of the controller
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001966 *
1967 * This function implements the CloseProtocol service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001968 *
Mario Six8fac2912018-07-10 08:40:17 +02001969 * See the Unified Extensible Firmware Interface (UEFI) specification for
1970 * details.
1971 *
1972 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001973 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01001974static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02001975 const efi_guid_t *protocol,
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01001976 efi_handle_t agent_handle,
1977 efi_handle_t controller_handle)
Alexander Grafc15d9212016-03-04 01:09:59 +01001978{
Heinrich Schuchardt4fd1ee22018-01-11 08:15:59 +01001979 struct efi_handler *handler;
1980 struct efi_open_protocol_info_item *item;
1981 struct efi_open_protocol_info_item *pos;
1982 efi_status_t r;
1983
Rob Clark238f88c2017-09-13 18:05:41 -04001984 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafc15d9212016-03-04 01:09:59 +01001985 controller_handle);
Heinrich Schuchardt4fd1ee22018-01-11 08:15:59 +01001986
Heinrich Schuchardt5d8231b2019-05-05 10:37:51 +02001987 if (!efi_search_obj(agent_handle) ||
1988 (controller_handle && !efi_search_obj(controller_handle))) {
Heinrich Schuchardt4fd1ee22018-01-11 08:15:59 +01001989 r = EFI_INVALID_PARAMETER;
1990 goto out;
1991 }
1992 r = efi_search_protocol(handle, protocol, &handler);
1993 if (r != EFI_SUCCESS)
1994 goto out;
1995
1996 r = EFI_NOT_FOUND;
1997 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1998 if (item->info.agent_handle == agent_handle &&
1999 item->info.controller_handle == controller_handle) {
2000 efi_delete_open_info(item);
2001 r = EFI_SUCCESS;
2002 break;
2003 }
2004 }
2005out:
2006 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002007}
2008
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002009/**
Mario Six8fac2912018-07-10 08:40:17 +02002010 * efi_open_protocol_information() - provide information about then open status
2011 * of a protocol on a handle
2012 * @handle: handle for which the information shall be retrieved
2013 * @protocol: GUID of the protocol
2014 * @entry_buffer: buffer to receive the open protocol information
2015 * @entry_count: number of entries available in the buffer
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002016 *
2017 * This function implements the OpenProtocolInformation service.
Mario Six8fac2912018-07-10 08:40:17 +02002018 *
2019 * See the Unified Extensible Firmware Interface (UEFI) specification for
2020 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002021 *
Mario Six8fac2912018-07-10 08:40:17 +02002022 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002023 */
Heinrich Schuchardt91064592018-02-18 15:17:49 +01002024static efi_status_t EFIAPI efi_open_protocol_information(
2025 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01002026 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002027 efi_uintn_t *entry_count)
Alexander Grafc15d9212016-03-04 01:09:59 +01002028{
Heinrich Schuchardtf2ef22e2018-01-11 08:16:00 +01002029 unsigned long buffer_size;
2030 unsigned long count;
2031 struct efi_handler *handler;
2032 struct efi_open_protocol_info_item *item;
2033 efi_status_t r;
2034
Rob Clark238f88c2017-09-13 18:05:41 -04002035 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafc15d9212016-03-04 01:09:59 +01002036 entry_count);
Heinrich Schuchardtf2ef22e2018-01-11 08:16:00 +01002037
2038 /* Check parameters */
2039 if (!entry_buffer) {
2040 r = EFI_INVALID_PARAMETER;
2041 goto out;
2042 }
2043 r = efi_search_protocol(handle, protocol, &handler);
2044 if (r != EFI_SUCCESS)
2045 goto out;
2046
2047 /* Count entries */
2048 count = 0;
2049 list_for_each_entry(item, &handler->open_infos, link) {
2050 if (item->info.open_count)
2051 ++count;
2052 }
2053 *entry_count = count;
2054 *entry_buffer = NULL;
2055 if (!count) {
2056 r = EFI_SUCCESS;
2057 goto out;
2058 }
2059
2060 /* Copy entries */
2061 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardtabb43872018-10-03 20:02:29 +02002062 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardtf2ef22e2018-01-11 08:16:00 +01002063 (void **)entry_buffer);
2064 if (r != EFI_SUCCESS)
2065 goto out;
2066 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2067 if (item->info.open_count)
2068 (*entry_buffer)[--count] = item->info;
2069 }
2070out:
2071 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002072}
2073
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002074/**
Mario Six8fac2912018-07-10 08:40:17 +02002075 * efi_protocols_per_handle() - get protocols installed on a handle
2076 * @handle: handle for which the information is retrieved
2077 * @protocol_buffer: buffer with protocol GUIDs
2078 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002079 *
2080 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002081 *
Mario Six8fac2912018-07-10 08:40:17 +02002082 * See the Unified Extensible Firmware Interface (UEFI) specification for
2083 * details.
2084 *
2085 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002086 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01002087static efi_status_t EFIAPI efi_protocols_per_handle(
2088 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002089 efi_uintn_t *protocol_buffer_count)
Alexander Grafc15d9212016-03-04 01:09:59 +01002090{
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002091 unsigned long buffer_size;
2092 struct efi_object *efiobj;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002093 struct list_head *protocol_handle;
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002094 efi_status_t r;
2095
Alexander Grafc15d9212016-03-04 01:09:59 +01002096 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2097 protocol_buffer_count);
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002098
2099 if (!handle || !protocol_buffer || !protocol_buffer_count)
2100 return EFI_EXIT(EFI_INVALID_PARAMETER);
2101
2102 *protocol_buffer = NULL;
Rob Clarkd51b8ca2017-07-20 07:59:39 -04002103 *protocol_buffer_count = 0;
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002104
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002105 efiobj = efi_search_obj(handle);
2106 if (!efiobj)
2107 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002108
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002109 /* Count protocols */
2110 list_for_each(protocol_handle, &efiobj->protocols) {
2111 ++*protocol_buffer_count;
2112 }
2113
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02002114 /* Copy GUIDs */
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002115 if (*protocol_buffer_count) {
2116 size_t j = 0;
2117
2118 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardtabb43872018-10-03 20:02:29 +02002119 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002120 (void **)protocol_buffer);
2121 if (r != EFI_SUCCESS)
2122 return EFI_EXIT(r);
2123 list_for_each(protocol_handle, &efiobj->protocols) {
2124 struct efi_handler *protocol;
2125
2126 protocol = list_entry(protocol_handle,
2127 struct efi_handler, link);
2128 (*protocol_buffer)[j] = (void *)protocol->guid;
2129 ++j;
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002130 }
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002131 }
2132
2133 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002134}
2135
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002136/**
Mario Six8fac2912018-07-10 08:40:17 +02002137 * efi_locate_handle_buffer() - locate handles implementing a protocol
2138 * @search_type: selection criterion
2139 * @protocol: GUID of the protocol
2140 * @search_key: registration key
2141 * @no_handles: number of returned handles
2142 * @buffer: buffer with the returned handles
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002143 *
2144 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002145 *
Mario Six8fac2912018-07-10 08:40:17 +02002146 * See the Unified Extensible Firmware Interface (UEFI) specification for
2147 * details.
2148 *
2149 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002150 */
Alexander Grafc15d9212016-03-04 01:09:59 +01002151static efi_status_t EFIAPI efi_locate_handle_buffer(
2152 enum efi_locate_search_type search_type,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002153 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002154 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +01002155{
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002156 efi_status_t r;
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002157 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002158
Rob Clark238f88c2017-09-13 18:05:41 -04002159 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafc15d9212016-03-04 01:09:59 +01002160 no_handles, buffer);
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002161
2162 if (!no_handles || !buffer) {
2163 r = EFI_INVALID_PARAMETER;
2164 goto out;
2165 }
2166 *no_handles = 0;
2167 *buffer = NULL;
2168 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2169 *buffer);
2170 if (r != EFI_BUFFER_TOO_SMALL)
2171 goto out;
Heinrich Schuchardtabb43872018-10-03 20:02:29 +02002172 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002173 (void **)buffer);
2174 if (r != EFI_SUCCESS)
2175 goto out;
2176 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2177 *buffer);
2178 if (r == EFI_SUCCESS)
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01002179 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002180out:
2181 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002182}
2183
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002184/**
Mario Six8fac2912018-07-10 08:40:17 +02002185 * efi_locate_protocol() - find an interface implementing a protocol
2186 * @protocol: GUID of the protocol
2187 * @registration: registration key passed to the notification function
2188 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002189 *
2190 * This function implements the LocateProtocol service.
Mario Six8fac2912018-07-10 08:40:17 +02002191 *
2192 * See the Unified Extensible Firmware Interface (UEFI) specification for
2193 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002194 *
Mario Six8fac2912018-07-10 08:40:17 +02002195 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002196 */
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002197static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01002198 void *registration,
2199 void **protocol_interface)
2200{
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002201 struct list_head *lhandle;
Heinrich Schuchardt57505e92017-10-26 19:25:57 +02002202 efi_status_t ret;
Alexander Grafc15d9212016-03-04 01:09:59 +01002203
Rob Clark238f88c2017-09-13 18:05:41 -04002204 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002205
2206 if (!protocol || !protocol_interface)
2207 return EFI_EXIT(EFI_INVALID_PARAMETER);
2208
2209 list_for_each(lhandle, &efi_obj_list) {
2210 struct efi_object *efiobj;
Heinrich Schuchardt57505e92017-10-26 19:25:57 +02002211 struct efi_handler *handler;
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002212
2213 efiobj = list_entry(lhandle, struct efi_object, link);
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002214
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02002215 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardt57505e92017-10-26 19:25:57 +02002216 if (ret == EFI_SUCCESS) {
2217 *protocol_interface = handler->protocol_interface;
2218 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002219 }
2220 }
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002221 *protocol_interface = NULL;
Alexander Grafc15d9212016-03-04 01:09:59 +01002222
2223 return EFI_EXIT(EFI_NOT_FOUND);
2224}
2225
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002226/**
Mario Six8fac2912018-07-10 08:40:17 +02002227 * efi_locate_device_path() - Get the device path and handle of an device
2228 * implementing a protocol
2229 * @protocol: GUID of the protocol
2230 * @device_path: device path
2231 * @device: handle of the device
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002232 *
2233 * This function implements the LocateDevicePath service.
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002234 *
Mario Six8fac2912018-07-10 08:40:17 +02002235 * See the Unified Extensible Firmware Interface (UEFI) specification for
2236 * details.
2237 *
2238 * Return: status code
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002239 */
2240static efi_status_t EFIAPI efi_locate_device_path(
2241 const efi_guid_t *protocol,
2242 struct efi_device_path **device_path,
2243 efi_handle_t *device)
2244{
2245 struct efi_device_path *dp;
2246 size_t i;
2247 struct efi_handler *handler;
2248 efi_handle_t *handles;
2249 size_t len, len_dp;
2250 size_t len_best = 0;
2251 efi_uintn_t no_handles;
2252 u8 *remainder;
2253 efi_status_t ret;
2254
2255 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2256
2257 if (!protocol || !device_path || !*device_path || !device) {
2258 ret = EFI_INVALID_PARAMETER;
2259 goto out;
2260 }
2261
2262 /* Find end of device path */
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +02002263 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002264
2265 /* Get all handles implementing the protocol */
2266 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2267 &no_handles, &handles));
2268 if (ret != EFI_SUCCESS)
2269 goto out;
2270
2271 for (i = 0; i < no_handles; ++i) {
2272 /* Find the device path protocol */
2273 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2274 &handler);
2275 if (ret != EFI_SUCCESS)
2276 continue;
2277 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +02002278 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002279 /*
2280 * This handle can only be a better fit
2281 * if its device path length is longer than the best fit and
2282 * if its device path length is shorter of equal the searched
2283 * device path.
2284 */
2285 if (len_dp <= len_best || len_dp > len)
2286 continue;
2287 /* Check if dp is a subpath of device_path */
2288 if (memcmp(*device_path, dp, len_dp))
2289 continue;
2290 *device = handles[i];
2291 len_best = len_dp;
2292 }
2293 if (len_best) {
2294 remainder = (u8 *)*device_path + len_best;
2295 *device_path = (struct efi_device_path *)remainder;
2296 ret = EFI_SUCCESS;
2297 } else {
2298 ret = EFI_NOT_FOUND;
2299 }
2300out:
2301 return EFI_EXIT(ret);
2302}
2303
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002304/**
Mario Six8fac2912018-07-10 08:40:17 +02002305 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2306 * interfaces
2307 * @handle: handle on which the protocol interfaces shall be installed
2308 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2309 * interfaces
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002310 *
2311 * This function implements the MultipleProtocolInterfaces service.
Mario Six8fac2912018-07-10 08:40:17 +02002312 *
2313 * See the Unified Extensible Firmware Interface (UEFI) specification for
2314 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002315 *
Mario Six8fac2912018-07-10 08:40:17 +02002316 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002317 */
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +02002318efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002319 (efi_handle_t *handle, ...)
Alexander Grafc15d9212016-03-04 01:09:59 +01002320{
2321 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002322
Alexander Graf404a7c82018-06-18 17:23:05 +02002323 efi_va_list argptr;
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002324 const efi_guid_t *protocol;
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002325 void *protocol_interface;
2326 efi_status_t r = EFI_SUCCESS;
2327 int i = 0;
2328
2329 if (!handle)
2330 return EFI_EXIT(EFI_INVALID_PARAMETER);
2331
Alexander Graf404a7c82018-06-18 17:23:05 +02002332 efi_va_start(argptr, handle);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002333 for (;;) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002334 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002335 if (!protocol)
2336 break;
Alexander Graf404a7c82018-06-18 17:23:05 +02002337 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01002338 r = EFI_CALL(efi_install_protocol_interface(
2339 handle, protocol,
2340 EFI_NATIVE_INTERFACE,
2341 protocol_interface));
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002342 if (r != EFI_SUCCESS)
2343 break;
2344 i++;
2345 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002346 efi_va_end(argptr);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002347 if (r == EFI_SUCCESS)
2348 return EFI_EXIT(r);
2349
Heinrich Schuchardtec47f3e2017-10-26 19:25:42 +02002350 /* If an error occurred undo all changes. */
Alexander Graf404a7c82018-06-18 17:23:05 +02002351 efi_va_start(argptr, handle);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002352 for (; i; --i) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002353 protocol = efi_va_arg(argptr, efi_guid_t*);
2354 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002355 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardt7cdc17f2017-11-06 21:17:45 +01002356 protocol_interface));
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002357 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002358 efi_va_end(argptr);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002359
2360 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002361}
2362
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002363/**
Mario Six8fac2912018-07-10 08:40:17 +02002364 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2365 * interfaces
2366 * @handle: handle from which the protocol interfaces shall be removed
2367 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2368 * interfaces
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002369 *
2370 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002371 *
Mario Six8fac2912018-07-10 08:40:17 +02002372 * See the Unified Extensible Firmware Interface (UEFI) specification for
2373 * details.
2374 *
2375 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002376 */
Alexander Grafc15d9212016-03-04 01:09:59 +01002377static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002378 efi_handle_t handle, ...)
Alexander Grafc15d9212016-03-04 01:09:59 +01002379{
2380 EFI_ENTRY("%p", handle);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002381
Alexander Graf404a7c82018-06-18 17:23:05 +02002382 efi_va_list argptr;
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002383 const efi_guid_t *protocol;
2384 void *protocol_interface;
2385 efi_status_t r = EFI_SUCCESS;
2386 size_t i = 0;
2387
2388 if (!handle)
2389 return EFI_EXIT(EFI_INVALID_PARAMETER);
2390
Alexander Graf404a7c82018-06-18 17:23:05 +02002391 efi_va_start(argptr, handle);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002392 for (;;) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002393 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002394 if (!protocol)
2395 break;
Alexander Graf404a7c82018-06-18 17:23:05 +02002396 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02002397 r = efi_uninstall_protocol(handle, protocol,
2398 protocol_interface);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002399 if (r != EFI_SUCCESS)
2400 break;
2401 i++;
2402 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002403 efi_va_end(argptr);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02002404 if (r == EFI_SUCCESS) {
2405 /* If the last protocol has been removed, delete the handle. */
2406 if (list_empty(&handle->protocols)) {
2407 list_del(&handle->link);
2408 free(handle);
2409 }
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002410 return EFI_EXIT(r);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02002411 }
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002412
2413 /* If an error occurred undo all changes. */
Alexander Graf404a7c82018-06-18 17:23:05 +02002414 efi_va_start(argptr, handle);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002415 for (; i; --i) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002416 protocol = efi_va_arg(argptr, efi_guid_t*);
2417 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002418 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2419 EFI_NATIVE_INTERFACE,
2420 protocol_interface));
2421 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002422 efi_va_end(argptr);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002423
Heinrich Schuchardt1c76eda2018-09-24 19:57:27 +02002424 /* In case of an error always return EFI_INVALID_PARAMETER */
2425 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafc15d9212016-03-04 01:09:59 +01002426}
2427
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002428/**
Mario Six8fac2912018-07-10 08:40:17 +02002429 * efi_calculate_crc32() - calculate cyclic redundancy code
2430 * @data: buffer with data
2431 * @data_size: size of buffer in bytes
2432 * @crc32_p: cyclic redundancy code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002433 *
2434 * This function implements the CalculateCrc32 service.
Mario Six8fac2912018-07-10 08:40:17 +02002435 *
2436 * See the Unified Extensible Firmware Interface (UEFI) specification for
2437 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002438 *
Mario Six8fac2912018-07-10 08:40:17 +02002439 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002440 */
Heinrich Schuchardtf2725582018-07-07 15:36:04 +02002441static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2442 efi_uintn_t data_size,
2443 u32 *crc32_p)
Alexander Grafc15d9212016-03-04 01:09:59 +01002444{
Heinrich Schuchardtf2725582018-07-07 15:36:04 +02002445 EFI_ENTRY("%p, %zu", data, data_size);
Alexander Grafc15d9212016-03-04 01:09:59 +01002446 *crc32_p = crc32(0, data, data_size);
2447 return EFI_EXIT(EFI_SUCCESS);
2448}
2449
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002450/**
Mario Six8fac2912018-07-10 08:40:17 +02002451 * efi_copy_mem() - copy memory
2452 * @destination: destination of the copy operation
2453 * @source: source of the copy operation
2454 * @length: number of bytes to copy
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002455 *
2456 * This function implements the CopyMem service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002457 *
Mario Six8fac2912018-07-10 08:40:17 +02002458 * See the Unified Extensible Firmware Interface (UEFI) specification for
2459 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002460 */
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002461static void EFIAPI efi_copy_mem(void *destination, const void *source,
2462 size_t length)
Alexander Grafc15d9212016-03-04 01:09:59 +01002463{
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002464 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardtefba6ba2019-01-09 21:41:13 +01002465 memmove(destination, source, length);
Heinrich Schuchardta5270e02017-10-05 16:35:51 +02002466 EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002467}
2468
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002469/**
Mario Six8fac2912018-07-10 08:40:17 +02002470 * efi_set_mem() - Fill memory with a byte value.
2471 * @buffer: buffer to fill
2472 * @size: size of buffer in bytes
2473 * @value: byte to copy to the buffer
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002474 *
2475 * This function implements the SetMem service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002476 *
Mario Six8fac2912018-07-10 08:40:17 +02002477 * See the Unified Extensible Firmware Interface (UEFI) specification for
2478 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002479 */
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002480static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafc15d9212016-03-04 01:09:59 +01002481{
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002482 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafc15d9212016-03-04 01:09:59 +01002483 memset(buffer, value, size);
Heinrich Schuchardta5270e02017-10-05 16:35:51 +02002484 EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002485}
2486
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002487/**
Mario Six8fac2912018-07-10 08:40:17 +02002488 * efi_protocol_open() - open protocol interface on a handle
2489 * @handler: handler of a protocol
2490 * @protocol_interface: interface implementing the protocol
2491 * @agent_handle: handle of the driver
2492 * @controller_handle: handle of the controller
2493 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002494 *
Mario Six8fac2912018-07-10 08:40:17 +02002495 * Return: status code
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002496 */
2497static efi_status_t efi_protocol_open(
2498 struct efi_handler *handler,
2499 void **protocol_interface, void *agent_handle,
2500 void *controller_handle, uint32_t attributes)
2501{
2502 struct efi_open_protocol_info_item *item;
2503 struct efi_open_protocol_info_entry *match = NULL;
2504 bool opened_by_driver = false;
2505 bool opened_exclusive = false;
2506
2507 /* If there is no agent, only return the interface */
2508 if (!agent_handle)
2509 goto out;
2510
2511 /* For TEST_PROTOCOL ignore interface attribute */
2512 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2513 *protocol_interface = NULL;
2514
2515 /*
2516 * Check if the protocol is already opened by a driver with the same
2517 * attributes or opened exclusively
2518 */
2519 list_for_each_entry(item, &handler->open_infos, link) {
2520 if (item->info.agent_handle == agent_handle) {
2521 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2522 (item->info.attributes == attributes))
2523 return EFI_ALREADY_STARTED;
2524 }
2525 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2526 opened_exclusive = true;
2527 }
2528
2529 /* Only one controller can open the protocol exclusively */
2530 if (opened_exclusive && attributes &
2531 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2532 return EFI_ACCESS_DENIED;
2533
2534 /* Prepare exclusive opening */
2535 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2536 /* Try to disconnect controllers */
2537 list_for_each_entry(item, &handler->open_infos, link) {
2538 if (item->info.attributes ==
2539 EFI_OPEN_PROTOCOL_BY_DRIVER)
2540 EFI_CALL(efi_disconnect_controller(
2541 item->info.controller_handle,
2542 item->info.agent_handle,
2543 NULL));
2544 }
2545 opened_by_driver = false;
2546 /* Check if all controllers are disconnected */
2547 list_for_each_entry(item, &handler->open_infos, link) {
2548 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2549 opened_by_driver = true;
2550 }
Heinrich Schuchardt8d0b45d2018-09-30 13:40:43 +02002551 /* Only one controller can be connected */
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002552 if (opened_by_driver)
2553 return EFI_ACCESS_DENIED;
2554 }
2555
2556 /* Find existing entry */
2557 list_for_each_entry(item, &handler->open_infos, link) {
2558 if (item->info.agent_handle == agent_handle &&
2559 item->info.controller_handle == controller_handle)
2560 match = &item->info;
2561 }
2562 /* None found, create one */
2563 if (!match) {
2564 match = efi_create_open_info(handler);
2565 if (!match)
2566 return EFI_OUT_OF_RESOURCES;
2567 }
2568
2569 match->agent_handle = agent_handle;
2570 match->controller_handle = controller_handle;
2571 match->attributes = attributes;
2572 match->open_count++;
2573
2574out:
2575 /* For TEST_PROTOCOL ignore interface attribute. */
2576 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2577 *protocol_interface = handler->protocol_interface;
2578
2579 return EFI_SUCCESS;
2580}
2581
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002582/**
Mario Six8fac2912018-07-10 08:40:17 +02002583 * efi_open_protocol() - open protocol interface on a handle
2584 * @handle: handle on which the protocol shall be opened
2585 * @protocol: GUID of the protocol
2586 * @protocol_interface: interface implementing the protocol
2587 * @agent_handle: handle of the driver
2588 * @controller_handle: handle of the controller
2589 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002590 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002591 * This function implements the OpenProtocol interface.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002592 *
Mario Six8fac2912018-07-10 08:40:17 +02002593 * See the Unified Extensible Firmware Interface (UEFI) specification for
2594 * details.
2595 *
2596 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002597 */
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002598static efi_status_t EFIAPI efi_open_protocol
2599 (efi_handle_t handle, const efi_guid_t *protocol,
2600 void **protocol_interface, efi_handle_t agent_handle,
2601 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafc15d9212016-03-04 01:09:59 +01002602{
Heinrich Schuchardte5e78a32017-11-26 14:05:15 +01002603 struct efi_handler *handler;
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002604 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafc15d9212016-03-04 01:09:59 +01002605
Rob Clark238f88c2017-09-13 18:05:41 -04002606 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01002607 protocol_interface, agent_handle, controller_handle,
2608 attributes);
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +02002609
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002610 if (!handle || !protocol ||
2611 (!protocol_interface && attributes !=
2612 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +02002613 goto out;
2614 }
2615
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002616 switch (attributes) {
2617 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2618 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2619 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2620 break;
2621 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2622 if (controller_handle == handle)
2623 goto out;
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002624 /* fall-through */
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002625 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2626 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002627 /* Check that the controller handle is valid */
2628 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002629 goto out;
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002630 /* fall-through */
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002631 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002632 /* Check that the agent handle is valid */
2633 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002634 goto out;
2635 break;
2636 default:
2637 goto out;
2638 }
2639
Heinrich Schuchardte5e78a32017-11-26 14:05:15 +01002640 r = efi_search_protocol(handle, protocol, &handler);
2641 if (r != EFI_SUCCESS)
2642 goto out;
Alexander Grafc15d9212016-03-04 01:09:59 +01002643
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002644 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2645 controller_handle, attributes);
Alexander Grafc15d9212016-03-04 01:09:59 +01002646out:
2647 return EFI_EXIT(r);
2648}
2649
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002650/**
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002651 * efi_start_image() - call the entry point of an image
2652 * @image_handle: handle of the image
2653 * @exit_data_size: size of the buffer
2654 * @exit_data: buffer to receive the exit data of the called image
2655 *
2656 * This function implements the StartImage service.
2657 *
2658 * See the Unified Extensible Firmware Interface (UEFI) specification for
2659 * details.
2660 *
2661 * Return: status code
2662 */
2663efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2664 efi_uintn_t *exit_data_size,
2665 u16 **exit_data)
2666{
2667 struct efi_loaded_image_obj *image_obj =
2668 (struct efi_loaded_image_obj *)image_handle;
2669 efi_status_t ret;
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002670 void *info;
2671 efi_handle_t parent_image = current_image;
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002672
2673 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2674
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002675 /* Check parameters */
2676 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2677 &info, NULL, NULL,
2678 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2679 if (ret != EFI_SUCCESS)
2680 return EFI_EXIT(EFI_INVALID_PARAMETER);
2681
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002682 efi_is_direct_boot = false;
2683
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02002684 image_obj->exit_data_size = exit_data_size;
2685 image_obj->exit_data = exit_data;
2686
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002687 /* call the image! */
2688 if (setjmp(&image_obj->exit_jmp)) {
2689 /*
2690 * We called the entry point of the child image with EFI_CALL
2691 * in the lines below. The child image called the Exit() boot
2692 * service efi_exit() which executed the long jump that brought
2693 * us to the current line. This implies that the second half
2694 * of the EFI_CALL macro has not been executed.
2695 */
2696#ifdef CONFIG_ARM
2697 /*
2698 * efi_exit() called efi_restore_gd(). We have to undo this
2699 * otherwise __efi_entry_check() will put the wrong value into
2700 * app_gd.
2701 */
2702 gd = app_gd;
2703#endif
2704 /*
2705 * To get ready to call EFI_EXIT below we have to execute the
2706 * missed out steps of EFI_CALL.
2707 */
2708 assert(__efi_entry_check());
2709 debug("%sEFI: %lu returned by started image\n",
2710 __efi_nesting_dec(),
2711 (unsigned long)((uintptr_t)image_obj->exit_status &
2712 ~EFI_ERROR_MASK));
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002713 current_image = parent_image;
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002714 return EFI_EXIT(image_obj->exit_status);
2715 }
2716
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002717 current_image = image_handle;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +02002718 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro14ff23b2019-04-19 12:22:35 +09002719 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002720 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2721
2722 /*
2723 * Usually UEFI applications call Exit() instead of returning.
2724 * But because the world doesn't consist of ponies and unicorns,
2725 * we're happy to emulate that behavior on behalf of a payload
2726 * that forgot.
2727 */
2728 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2729}
2730
2731/**
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002732 * efi_delete_image() - delete loaded image from memory)
2733 *
2734 * @image_obj: handle of the loaded image
2735 * @loaded_image_protocol: loaded image protocol
2736 */
2737static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2738 struct efi_loaded_image *loaded_image_protocol)
2739{
2740 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2741 efi_size_in_pages(loaded_image_protocol->image_size));
2742 efi_delete_handle(&image_obj->header);
2743}
2744
2745/**
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002746 * efi_unload_image() - unload an EFI image
2747 * @image_handle: handle of the image to be unloaded
2748 *
2749 * This function implements the UnloadImage service.
2750 *
2751 * See the Unified Extensible Firmware Interface (UEFI) specification for
2752 * details.
2753 *
2754 * Return: status code
2755 */
2756efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2757{
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002758 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002759 struct efi_object *efiobj;
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002760 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002761
2762 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002763
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002764 efiobj = efi_search_obj(image_handle);
2765 if (!efiobj) {
2766 ret = EFI_INVALID_PARAMETER;
2767 goto out;
2768 }
2769 /* Find the loaded image protocol */
2770 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2771 (void **)&loaded_image_protocol,
2772 NULL, NULL,
2773 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2774 if (ret != EFI_SUCCESS) {
2775 ret = EFI_INVALID_PARAMETER;
2776 goto out;
2777 }
2778 switch (efiobj->type) {
2779 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2780 /* Call the unload function */
2781 if (!loaded_image_protocol->unload) {
2782 ret = EFI_UNSUPPORTED;
2783 goto out;
2784 }
2785 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2786 if (ret != EFI_SUCCESS)
2787 goto out;
2788 break;
2789 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2790 break;
2791 default:
2792 ret = EFI_INVALID_PARAMETER;
2793 goto out;
2794 }
2795 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2796 loaded_image_protocol);
2797out:
2798 return EFI_EXIT(ret);
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002799}
2800
2801/**
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02002802 * efi_update_exit_data() - fill exit data parameters of StartImage()
2803 *
2804 * @image_obj image handle
2805 * @exit_data_size size of the exit data buffer
2806 * @exit_data buffer with data returned by UEFI payload
2807 * Return: status code
2808 */
2809static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2810 efi_uintn_t exit_data_size,
2811 u16 *exit_data)
2812{
2813 efi_status_t ret;
2814
2815 /*
2816 * If exit_data is not provided to StartImage(), exit_data_size must be
2817 * ignored.
2818 */
2819 if (!image_obj->exit_data)
2820 return EFI_SUCCESS;
2821 if (image_obj->exit_data_size)
2822 *image_obj->exit_data_size = exit_data_size;
2823 if (exit_data_size && exit_data) {
2824 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2825 exit_data_size,
2826 (void **)image_obj->exit_data);
2827 if (ret != EFI_SUCCESS)
2828 return ret;
2829 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2830 } else {
2831 image_obj->exit_data = NULL;
2832 }
2833 return EFI_SUCCESS;
2834}
2835
2836/**
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002837 * efi_exit() - leave an EFI application or driver
2838 * @image_handle: handle of the application or driver that is exiting
2839 * @exit_status: status code
2840 * @exit_data_size: size of the buffer in bytes
2841 * @exit_data: buffer with data describing an error
2842 *
2843 * This function implements the Exit service.
2844 *
2845 * See the Unified Extensible Firmware Interface (UEFI) specification for
2846 * details.
2847 *
2848 * Return: status code
2849 */
2850static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2851 efi_status_t exit_status,
2852 efi_uintn_t exit_data_size,
2853 u16 *exit_data)
2854{
2855 /*
2856 * TODO: We should call the unload procedure of the loaded
2857 * image protocol.
2858 */
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002859 efi_status_t ret;
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002860 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002861 struct efi_loaded_image_obj *image_obj =
2862 (struct efi_loaded_image_obj *)image_handle;
2863
2864 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2865 exit_data_size, exit_data);
2866
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002867 /* Check parameters */
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002868 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002869 (void **)&loaded_image_protocol,
2870 NULL, NULL,
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002871 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002872 if (ret != EFI_SUCCESS) {
2873 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002874 goto out;
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002875 }
2876
2877 /* Unloading of unstarted images */
2878 switch (image_obj->header.type) {
2879 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2880 break;
2881 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2882 efi_delete_image(image_obj, loaded_image_protocol);
2883 ret = EFI_SUCCESS;
2884 goto out;
2885 default:
2886 /* Handle does not refer to loaded image */
2887 ret = EFI_INVALID_PARAMETER;
2888 goto out;
2889 }
2890 /* A started image can only be unloaded it is the last one started. */
2891 if (image_handle != current_image) {
2892 ret = EFI_INVALID_PARAMETER;
2893 goto out;
2894 }
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002895
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02002896 /* Exit data is only foreseen in case of failure. */
2897 if (exit_status != EFI_SUCCESS) {
2898 ret = efi_update_exit_data(image_obj, exit_data_size,
2899 exit_data);
2900 /* Exiting has priority. Don't return error to caller. */
2901 if (ret != EFI_SUCCESS)
2902 EFI_PRINT("%s: out of memory\n", __func__);
2903 }
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002904 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2905 exit_status != EFI_SUCCESS)
2906 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02002907
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002908 /* Make sure entry/exit counts for EFI world cross-overs match */
2909 EFI_EXIT(exit_status);
2910
2911 /*
2912 * But longjmp out with the U-Boot gd, not the application's, as
2913 * the other end is a setjmp call inside EFI context.
2914 */
2915 efi_restore_gd();
2916
2917 image_obj->exit_status = exit_status;
2918 longjmp(&image_obj->exit_jmp, 1);
2919
2920 panic("EFI application exited");
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002921out:
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002922 return EFI_EXIT(ret);
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002923}
2924
2925/**
Mario Six8fac2912018-07-10 08:40:17 +02002926 * efi_handle_protocol() - get interface of a protocol on a handle
2927 * @handle: handle on which the protocol shall be opened
2928 * @protocol: GUID of the protocol
2929 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002930 *
2931 * This function implements the HandleProtocol service.
Mario Six8fac2912018-07-10 08:40:17 +02002932 *
2933 * See the Unified Extensible Firmware Interface (UEFI) specification for
2934 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002935 *
Mario Six8fac2912018-07-10 08:40:17 +02002936 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002937 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01002938static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002939 const efi_guid_t *protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01002940 void **protocol_interface)
2941{
xypron.glpk@gmx.de1bf5d872017-06-29 21:16:19 +02002942 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2943 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafc15d9212016-03-04 01:09:59 +01002944}
2945
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002946/**
Mario Six8fac2912018-07-10 08:40:17 +02002947 * efi_bind_controller() - bind a single driver to a controller
2948 * @controller_handle: controller handle
2949 * @driver_image_handle: driver handle
2950 * @remain_device_path: remaining path
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002951 *
Mario Six8fac2912018-07-10 08:40:17 +02002952 * Return: status code
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002953 */
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01002954static efi_status_t efi_bind_controller(
2955 efi_handle_t controller_handle,
2956 efi_handle_t driver_image_handle,
2957 struct efi_device_path *remain_device_path)
2958{
2959 struct efi_driver_binding_protocol *binding_protocol;
2960 efi_status_t r;
2961
2962 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2963 &efi_guid_driver_binding_protocol,
2964 (void **)&binding_protocol,
2965 driver_image_handle, NULL,
2966 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2967 if (r != EFI_SUCCESS)
2968 return r;
2969 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2970 controller_handle,
2971 remain_device_path));
2972 if (r == EFI_SUCCESS)
2973 r = EFI_CALL(binding_protocol->start(binding_protocol,
2974 controller_handle,
2975 remain_device_path));
2976 EFI_CALL(efi_close_protocol(driver_image_handle,
2977 &efi_guid_driver_binding_protocol,
2978 driver_image_handle, NULL));
2979 return r;
2980}
2981
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002982/**
Mario Six8fac2912018-07-10 08:40:17 +02002983 * efi_connect_single_controller() - connect a single driver to a controller
2984 * @controller_handle: controller
2985 * @driver_image_handle: driver
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02002986 * @remain_device_path: remaining path
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002987 *
Mario Six8fac2912018-07-10 08:40:17 +02002988 * Return: status code
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002989 */
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01002990static efi_status_t efi_connect_single_controller(
2991 efi_handle_t controller_handle,
2992 efi_handle_t *driver_image_handle,
2993 struct efi_device_path *remain_device_path)
2994{
2995 efi_handle_t *buffer;
2996 size_t count;
2997 size_t i;
2998 efi_status_t r;
2999 size_t connected = 0;
3000
3001 /* Get buffer with all handles with driver binding protocol */
3002 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3003 &efi_guid_driver_binding_protocol,
3004 NULL, &count, &buffer));
3005 if (r != EFI_SUCCESS)
3006 return r;
3007
3008 /* Context Override */
3009 if (driver_image_handle) {
3010 for (; *driver_image_handle; ++driver_image_handle) {
3011 for (i = 0; i < count; ++i) {
3012 if (buffer[i] == *driver_image_handle) {
3013 buffer[i] = NULL;
3014 r = efi_bind_controller(
3015 controller_handle,
3016 *driver_image_handle,
3017 remain_device_path);
3018 /*
3019 * For drivers that do not support the
3020 * controller or are already connected
3021 * we receive an error code here.
3022 */
3023 if (r == EFI_SUCCESS)
3024 ++connected;
3025 }
3026 }
3027 }
3028 }
3029
3030 /*
3031 * TODO: Some overrides are not yet implemented:
3032 * - Platform Driver Override
3033 * - Driver Family Override Search
3034 * - Bus Specific Driver Override
3035 */
3036
3037 /* Driver Binding Search */
3038 for (i = 0; i < count; ++i) {
3039 if (buffer[i]) {
3040 r = efi_bind_controller(controller_handle,
3041 buffer[i],
3042 remain_device_path);
3043 if (r == EFI_SUCCESS)
3044 ++connected;
3045 }
3046 }
3047
3048 efi_free_pool(buffer);
3049 if (!connected)
3050 return EFI_NOT_FOUND;
3051 return EFI_SUCCESS;
3052}
3053
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003054/**
Mario Six8fac2912018-07-10 08:40:17 +02003055 * efi_connect_controller() - connect a controller to a driver
3056 * @controller_handle: handle of the controller
3057 * @driver_image_handle: handle of the driver
3058 * @remain_device_path: device path of a child controller
3059 * @recursive: true to connect all child controllers
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003060 *
3061 * This function implements the ConnectController service.
Mario Six8fac2912018-07-10 08:40:17 +02003062 *
3063 * See the Unified Extensible Firmware Interface (UEFI) specification for
3064 * details.
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003065 *
3066 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02003067 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003068 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3069 *
Mario Six8fac2912018-07-10 08:40:17 +02003070 * Return: status code
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003071 */
3072static efi_status_t EFIAPI efi_connect_controller(
3073 efi_handle_t controller_handle,
3074 efi_handle_t *driver_image_handle,
3075 struct efi_device_path *remain_device_path,
3076 bool recursive)
3077{
3078 efi_status_t r;
3079 efi_status_t ret = EFI_NOT_FOUND;
3080 struct efi_object *efiobj;
3081
Heinrich Schuchardt7c89fb02018-12-09 16:39:20 +01003082 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003083 remain_device_path, recursive);
3084
3085 efiobj = efi_search_obj(controller_handle);
3086 if (!efiobj) {
3087 ret = EFI_INVALID_PARAMETER;
3088 goto out;
3089 }
3090
3091 r = efi_connect_single_controller(controller_handle,
3092 driver_image_handle,
3093 remain_device_path);
3094 if (r == EFI_SUCCESS)
3095 ret = EFI_SUCCESS;
3096 if (recursive) {
3097 struct efi_handler *handler;
3098 struct efi_open_protocol_info_item *item;
3099
3100 list_for_each_entry(handler, &efiobj->protocols, link) {
3101 list_for_each_entry(item, &handler->open_infos, link) {
3102 if (item->info.attributes &
3103 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3104 r = EFI_CALL(efi_connect_controller(
3105 item->info.controller_handle,
3106 driver_image_handle,
3107 remain_device_path,
3108 recursive));
3109 if (r == EFI_SUCCESS)
3110 ret = EFI_SUCCESS;
3111 }
3112 }
3113 }
3114 }
3115 /* Check for child controller specified by end node */
3116 if (ret != EFI_SUCCESS && remain_device_path &&
3117 remain_device_path->type == DEVICE_PATH_TYPE_END)
3118 ret = EFI_SUCCESS;
3119out:
3120 return EFI_EXIT(ret);
3121}
3122
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003123/**
Mario Six8fac2912018-07-10 08:40:17 +02003124 * efi_reinstall_protocol_interface() - reinstall protocol interface
3125 * @handle: handle on which the protocol shall be reinstalled
3126 * @protocol: GUID of the protocol to be installed
3127 * @old_interface: interface to be removed
3128 * @new_interface: interface to be installed
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003129 *
3130 * This function implements the ReinstallProtocolInterface service.
Mario Six8fac2912018-07-10 08:40:17 +02003131 *
3132 * See the Unified Extensible Firmware Interface (UEFI) specification for
3133 * details.
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003134 *
3135 * The old interface is uninstalled. The new interface is installed.
3136 * Drivers are connected.
3137 *
Mario Six8fac2912018-07-10 08:40:17 +02003138 * Return: status code
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003139 */
3140static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3141 efi_handle_t handle, const efi_guid_t *protocol,
3142 void *old_interface, void *new_interface)
3143{
3144 efi_status_t ret;
3145
3146 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3147 new_interface);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02003148
3149 /* Uninstall protocol but do not delete handle */
3150 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003151 if (ret != EFI_SUCCESS)
3152 goto out;
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02003153
3154 /* Install the new protocol */
3155 ret = efi_add_protocol(handle, protocol, new_interface);
3156 /*
3157 * The UEFI spec does not specify what should happen to the handle
3158 * if in case of an error no protocol interface remains on the handle.
3159 * So let's do nothing here.
3160 */
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003161 if (ret != EFI_SUCCESS)
3162 goto out;
3163 /*
3164 * The returned status code has to be ignored.
3165 * Do not create an error if no suitable driver for the handle exists.
3166 */
3167 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3168out:
3169 return EFI_EXIT(ret);
3170}
3171
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003172/**
Mario Six8fac2912018-07-10 08:40:17 +02003173 * efi_get_child_controllers() - get all child controllers associated to a driver
3174 * @efiobj: handle of the controller
3175 * @driver_handle: handle of the driver
3176 * @number_of_children: number of child controllers
3177 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003178 *
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003179 * The allocated buffer has to be freed with free().
3180 *
Mario Six8fac2912018-07-10 08:40:17 +02003181 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003182 */
3183static efi_status_t efi_get_child_controllers(
3184 struct efi_object *efiobj,
3185 efi_handle_t driver_handle,
3186 efi_uintn_t *number_of_children,
3187 efi_handle_t **child_handle_buffer)
3188{
3189 struct efi_handler *handler;
3190 struct efi_open_protocol_info_item *item;
3191 efi_uintn_t count = 0, i;
3192 bool duplicate;
3193
3194 /* Count all child controller associations */
3195 list_for_each_entry(handler, &efiobj->protocols, link) {
3196 list_for_each_entry(item, &handler->open_infos, link) {
3197 if (item->info.agent_handle == driver_handle &&
3198 item->info.attributes &
3199 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3200 ++count;
3201 }
3202 }
3203 /*
3204 * Create buffer. In case of duplicate child controller assignments
3205 * the buffer will be too large. But that does not harm.
3206 */
3207 *number_of_children = 0;
3208 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3209 if (!*child_handle_buffer)
3210 return EFI_OUT_OF_RESOURCES;
3211 /* Copy unique child handles */
3212 list_for_each_entry(handler, &efiobj->protocols, link) {
3213 list_for_each_entry(item, &handler->open_infos, link) {
3214 if (item->info.agent_handle == driver_handle &&
3215 item->info.attributes &
3216 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3217 /* Check this is a new child controller */
3218 duplicate = false;
3219 for (i = 0; i < *number_of_children; ++i) {
3220 if ((*child_handle_buffer)[i] ==
3221 item->info.controller_handle)
3222 duplicate = true;
3223 }
3224 /* Copy handle to buffer */
3225 if (!duplicate) {
3226 i = (*number_of_children)++;
3227 (*child_handle_buffer)[i] =
3228 item->info.controller_handle;
3229 }
3230 }
3231 }
3232 }
3233 return EFI_SUCCESS;
3234}
3235
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003236/**
Mario Six8fac2912018-07-10 08:40:17 +02003237 * efi_disconnect_controller() - disconnect a controller from a driver
3238 * @controller_handle: handle of the controller
3239 * @driver_image_handle: handle of the driver
3240 * @child_handle: handle of the child to destroy
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003241 *
3242 * This function implements the DisconnectController service.
Mario Six8fac2912018-07-10 08:40:17 +02003243 *
3244 * See the Unified Extensible Firmware Interface (UEFI) specification for
3245 * details.
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003246 *
Mario Six8fac2912018-07-10 08:40:17 +02003247 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003248 */
3249static efi_status_t EFIAPI efi_disconnect_controller(
3250 efi_handle_t controller_handle,
3251 efi_handle_t driver_image_handle,
3252 efi_handle_t child_handle)
3253{
3254 struct efi_driver_binding_protocol *binding_protocol;
3255 efi_handle_t *child_handle_buffer = NULL;
3256 size_t number_of_children = 0;
3257 efi_status_t r;
3258 size_t stop_count = 0;
3259 struct efi_object *efiobj;
3260
3261 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3262 child_handle);
3263
3264 efiobj = efi_search_obj(controller_handle);
3265 if (!efiobj) {
3266 r = EFI_INVALID_PARAMETER;
3267 goto out;
3268 }
3269
3270 if (child_handle && !efi_search_obj(child_handle)) {
3271 r = EFI_INVALID_PARAMETER;
3272 goto out;
3273 }
3274
3275 /* If no driver handle is supplied, disconnect all drivers */
3276 if (!driver_image_handle) {
3277 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3278 goto out;
3279 }
3280
3281 /* Create list of child handles */
3282 if (child_handle) {
3283 number_of_children = 1;
3284 child_handle_buffer = &child_handle;
3285 } else {
3286 efi_get_child_controllers(efiobj,
3287 driver_image_handle,
3288 &number_of_children,
3289 &child_handle_buffer);
3290 }
3291
3292 /* Get the driver binding protocol */
3293 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3294 &efi_guid_driver_binding_protocol,
3295 (void **)&binding_protocol,
3296 driver_image_handle, NULL,
3297 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3298 if (r != EFI_SUCCESS)
3299 goto out;
3300 /* Remove the children */
3301 if (number_of_children) {
3302 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3303 controller_handle,
3304 number_of_children,
3305 child_handle_buffer));
3306 if (r == EFI_SUCCESS)
3307 ++stop_count;
3308 }
3309 /* Remove the driver */
3310 if (!child_handle)
3311 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3312 controller_handle,
3313 0, NULL));
3314 if (r == EFI_SUCCESS)
3315 ++stop_count;
3316 EFI_CALL(efi_close_protocol(driver_image_handle,
3317 &efi_guid_driver_binding_protocol,
3318 driver_image_handle, NULL));
3319
3320 if (stop_count)
3321 r = EFI_SUCCESS;
3322 else
3323 r = EFI_NOT_FOUND;
3324out:
3325 if (!child_handle)
3326 free(child_handle_buffer);
3327 return EFI_EXIT(r);
3328}
3329
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003330static struct efi_boot_services efi_boot_services = {
Alexander Grafc15d9212016-03-04 01:09:59 +01003331 .hdr = {
Heinrich Schuchardte75b3cb2018-06-28 12:45:27 +02003332 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3333 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt10204252018-06-28 12:45:29 +02003334 .headersize = sizeof(struct efi_boot_services),
Alexander Grafc15d9212016-03-04 01:09:59 +01003335 },
3336 .raise_tpl = efi_raise_tpl,
3337 .restore_tpl = efi_restore_tpl,
3338 .allocate_pages = efi_allocate_pages_ext,
3339 .free_pages = efi_free_pages_ext,
3340 .get_memory_map = efi_get_memory_map_ext,
Stefan Brüns5a09aef2016-10-09 22:17:18 +02003341 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns67b67d92016-10-09 22:17:26 +02003342 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +02003343 .create_event = efi_create_event_ext,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +02003344 .set_timer = efi_set_timer_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003345 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +02003346 .signal_event = efi_signal_event_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003347 .close_event = efi_close_event,
3348 .check_event = efi_check_event,
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01003349 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafc15d9212016-03-04 01:09:59 +01003350 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardt7cdc17f2017-11-06 21:17:45 +01003351 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafc15d9212016-03-04 01:09:59 +01003352 .handle_protocol = efi_handle_protocol,
3353 .reserved = NULL,
3354 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02003355 .locate_handle = efi_locate_handle_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003356 .locate_device_path = efi_locate_device_path,
Alexander Grafc5c11632016-08-19 01:23:24 +02003357 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003358 .load_image = efi_load_image,
3359 .start_image = efi_start_image,
Alexander Graf988c0662016-05-20 23:28:23 +02003360 .exit = efi_exit,
Alexander Grafc15d9212016-03-04 01:09:59 +01003361 .unload_image = efi_unload_image,
3362 .exit_boot_services = efi_exit_boot_services,
3363 .get_next_monotonic_count = efi_get_next_monotonic_count,
3364 .stall = efi_stall,
3365 .set_watchdog_timer = efi_set_watchdog_timer,
3366 .connect_controller = efi_connect_controller,
3367 .disconnect_controller = efi_disconnect_controller,
3368 .open_protocol = efi_open_protocol,
3369 .close_protocol = efi_close_protocol,
3370 .open_protocol_information = efi_open_protocol_information,
3371 .protocols_per_handle = efi_protocols_per_handle,
3372 .locate_handle_buffer = efi_locate_handle_buffer,
3373 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardt91064592018-02-18 15:17:49 +01003374 .install_multiple_protocol_interfaces =
3375 efi_install_multiple_protocol_interfaces,
3376 .uninstall_multiple_protocol_interfaces =
3377 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafc15d9212016-03-04 01:09:59 +01003378 .calculate_crc32 = efi_calculate_crc32,
3379 .copy_mem = efi_copy_mem,
3380 .set_mem = efi_set_mem,
Heinrich Schuchardt717c4582018-02-04 23:05:13 +01003381 .create_event_ex = efi_create_event_ex,
Alexander Grafc15d9212016-03-04 01:09:59 +01003382};
3383
Heinrich Schuchardt27685f72018-06-28 12:45:30 +02003384static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafc15d9212016-03-04 01:09:59 +01003385
Alexander Graf393dd912016-10-14 13:45:30 +02003386struct efi_system_table __efi_runtime_data systab = {
Alexander Grafc15d9212016-03-04 01:09:59 +01003387 .hdr = {
3388 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardte75b3cb2018-06-28 12:45:27 +02003389 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt10204252018-06-28 12:45:29 +02003390 .headersize = sizeof(struct efi_system_table),
Alexander Grafc15d9212016-03-04 01:09:59 +01003391 },
Heinrich Schuchardt27685f72018-06-28 12:45:30 +02003392 .fw_vendor = firmware_vendor,
3393 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardt91064592018-02-18 15:17:49 +01003394 .con_in = (void *)&efi_con_in,
3395 .con_out = (void *)&efi_con_out,
3396 .std_err = (void *)&efi_con_out,
3397 .runtime = (void *)&efi_runtime_services,
3398 .boottime = (void *)&efi_boot_services,
Alexander Grafc15d9212016-03-04 01:09:59 +01003399 .nr_tables = 0,
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02003400 .tables = NULL,
Alexander Grafc15d9212016-03-04 01:09:59 +01003401};
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003402
3403/**
3404 * efi_initialize_system_table() - Initialize system table
3405 *
Heinrich Schuchardt7b4b2a22018-09-03 05:00:43 +02003406 * Return: status code
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003407 */
3408efi_status_t efi_initialize_system_table(void)
3409{
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02003410 efi_status_t ret;
3411
3412 /* Allocate configuration table array */
3413 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3414 EFI_MAX_CONFIGURATION_TABLES *
3415 sizeof(struct efi_configuration_table),
3416 (void **)&systab.tables);
3417
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02003418 /* Set CRC32 field in table headers */
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003419 efi_update_table_header_crc32(&systab.hdr);
3420 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3421 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02003422
3423 return ret;
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003424}