blob: ea52b9539d5b37384ede55777bafffaf0b62c6a1 [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Grafbee91162016-03-04 01:09:59 +01002/*
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02003 * EFI application boot time services
Alexander Grafbee91162016-03-04 01:09:59 +01004 *
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02005 * Copyright (c) 2016 Alexander Graf
Alexander Grafbee91162016-03-04 01:09:59 +01006 */
7
Alexander Grafbee91162016-03-04 01:09:59 +01008#include <common.h>
Heinrich Schuchardt7d963322017-10-05 16:14:14 +02009#include <div64.h>
Alexander Grafbee91162016-03-04 01:09:59 +010010#include <efi_loader.h>
11#include <malloc.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090012#include <linux/libfdt_env.h>
Alexander Grafbee91162016-03-04 01:09:59 +010013#include <u-boot/crc.h>
14#include <bootm.h>
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +020015#include <pe.h>
Simon Glass3db71102019-11-14 12:57:16 -070016#include <u-boot/crc.h>
Alexander Grafbee91162016-03-04 01:09:59 +010017#include <watchdog.h>
18
19DECLARE_GLOBAL_DATA_PTR;
20
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020021/* Task priority level */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +010022static efi_uintn_t efi_tpl = TPL_APPLICATION;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020023
Alexander Grafbee91162016-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 Schuchardt43bce442018-02-18 15:17:50 +010027/* List of all events */
Heinrich Schuchardt14b40482019-07-11 20:15:09 +020028__efi_runtime_data LIST_HEAD(efi_events);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010029
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +020030/* List of queued events */
31LIST_HEAD(efi_event_queue);
32
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +020033/* Flag to disable timer activity in ExitBootServices() */
34static bool timers_enabled = true;
35
Heinrich Schuchardtab15d412019-05-04 17:27:54 +020036/* List of all events registered by RegisterProtocolNotify() */
37LIST_HEAD(efi_register_notify_events);
38
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +010039/* Handle of the currently executing image */
40static efi_handle_t current_image;
41
Simon Glass65e4c0b2016-09-25 15:27:35 -060042#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +010043/*
44 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
45 * fixed when compiling U-Boot. However, the payload does not know about that
46 * restriction so we need to manually swap its and our view of that register on
47 * EFI callback entry/exit.
48 */
49static volatile void *efi_gd, *app_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -060050#endif
Alexander Grafbee91162016-03-04 01:09:59 +010051
Heinrich Schuchardt914df752019-02-09 14:10:39 +010052/* 1 if inside U-Boot code, 0 if inside EFI payload code */
53static int entry_count = 1;
Rob Clarkaf65db82017-07-27 08:04:19 -040054static int nesting_level;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +010055/* GUID of the device tree table */
56const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +010057/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
58const efi_guid_t efi_guid_driver_binding_protocol =
59 EFI_DRIVER_BINDING_PROTOCOL_GUID;
Rob Clarkc160d2f2017-07-27 08:04:18 -040060
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010061/* event group ExitBootServices() invoked */
62const efi_guid_t efi_guid_event_group_exit_boot_services =
63 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
64/* event group SetVirtualAddressMap() invoked */
65const efi_guid_t efi_guid_event_group_virtual_address_change =
66 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
67/* event group memory map changed */
68const efi_guid_t efi_guid_event_group_memory_map_change =
69 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
70/* event group boot manager about to boot */
71const efi_guid_t efi_guid_event_group_ready_to_boot =
72 EFI_EVENT_GROUP_READY_TO_BOOT;
73/* event group ResetSystem() invoked (before ExitBootServices) */
74const efi_guid_t efi_guid_event_group_reset_system =
75 EFI_EVENT_GROUP_RESET_SYSTEM;
76
Heinrich Schuchardt2074f702018-01-11 08:16:09 +010077static efi_status_t EFIAPI efi_disconnect_controller(
78 efi_handle_t controller_handle,
79 efi_handle_t driver_image_handle,
80 efi_handle_t child_handle);
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +010081
Rob Clarkc160d2f2017-07-27 08:04:18 -040082/* Called on every callback entry */
83int __efi_entry_check(void)
84{
85 int ret = entry_count++ == 0;
86#ifdef CONFIG_ARM
87 assert(efi_gd);
88 app_gd = gd;
89 gd = efi_gd;
90#endif
91 return ret;
92}
93
94/* Called on every callback exit */
95int __efi_exit_check(void)
96{
97 int ret = --entry_count == 0;
98#ifdef CONFIG_ARM
99 gd = app_gd;
100#endif
101 return ret;
102}
103
Alexander Grafbee91162016-03-04 01:09:59 +0100104/* Called from do_bootefi_exec() */
105void efi_save_gd(void)
106{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600107#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100108 efi_gd = gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600109#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100110}
111
Rob Clarkc160d2f2017-07-27 08:04:18 -0400112/*
Mario Six78a88f72018-07-10 08:40:17 +0200113 * Special case handler for error/abort that just forces things back to u-boot
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200114 * world so we can dump out an abort message, without any care about returning
115 * back to UEFI world.
Rob Clarkc160d2f2017-07-27 08:04:18 -0400116 */
Alexander Grafbee91162016-03-04 01:09:59 +0100117void efi_restore_gd(void)
118{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600119#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100120 /* Only restore if we're already in EFI context */
121 if (!efi_gd)
122 return;
Alexander Grafbee91162016-03-04 01:09:59 +0100123 gd = efi_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600124#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100125}
126
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200127/**
Mario Six78a88f72018-07-10 08:40:17 +0200128 * indent_string() - returns a string for indenting with two spaces per level
129 * @level: indent level
Heinrich Schuchardtc8df80c2018-01-24 19:21:36 +0100130 *
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200131 * A maximum of ten indent levels is supported. Higher indent levels will be
132 * truncated.
133 *
Mario Six78a88f72018-07-10 08:40:17 +0200134 * Return: A string for indenting with two spaces per level is
135 * returned.
Rob Clarkaf65db82017-07-27 08:04:19 -0400136 */
137static const char *indent_string(int level)
138{
139 const char *indent = " ";
140 const int max = strlen(indent);
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +0100141
Rob Clarkaf65db82017-07-27 08:04:19 -0400142 level = min(max, level * 2);
143 return &indent[max - level];
144}
145
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200146const char *__efi_nesting(void)
147{
148 return indent_string(nesting_level);
149}
150
Rob Clarkaf65db82017-07-27 08:04:19 -0400151const char *__efi_nesting_inc(void)
152{
153 return indent_string(nesting_level++);
154}
155
156const char *__efi_nesting_dec(void)
157{
158 return indent_string(--nesting_level);
159}
160
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200161/**
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200162 * efi_event_is_queued() - check if an event is queued
163 *
164 * @event: event
165 * Return: true if event is queued
166 */
167static bool efi_event_is_queued(struct efi_event *event)
168{
169 return !!event->queue_link.next;
170}
171
172/**
173 * efi_process_event_queue() - process event queue
174 */
175static void efi_process_event_queue(void)
176{
177 while (!list_empty(&efi_event_queue)) {
178 struct efi_event *event;
179 efi_uintn_t old_tpl;
180
181 event = list_first_entry(&efi_event_queue, struct efi_event,
182 queue_link);
183 if (efi_tpl >= event->notify_tpl)
184 return;
185 list_del(&event->queue_link);
186 event->queue_link.next = NULL;
187 event->queue_link.prev = NULL;
188 /* Events must be executed at the event's TPL */
189 old_tpl = efi_tpl;
190 efi_tpl = event->notify_tpl;
191 EFI_CALL_VOID(event->notify_function(event,
192 event->notify_context));
193 efi_tpl = old_tpl;
194 if (event->type == EVT_NOTIFY_SIGNAL)
195 event->is_signaled = 0;
196 }
197}
198
199/**
Mario Six78a88f72018-07-10 08:40:17 +0200200 * efi_queue_event() - queue an EFI event
201 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200202 *
203 * This function queues the notification function of the event for future
204 * execution.
205 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200206 */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200207static void efi_queue_event(struct efi_event *event)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200208{
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200209 struct efi_event *item = NULL;
210
211 if (!event->notify_function)
212 return;
213
214 if (!efi_event_is_queued(event)) {
215 /*
216 * Events must be notified in order of decreasing task priority
217 * level. Insert the new event accordingly.
218 */
219 list_for_each_entry(item, &efi_event_queue, queue_link) {
220 if (item->notify_tpl < event->notify_tpl) {
221 list_add_tail(&event->queue_link,
222 &item->queue_link);
223 event = NULL;
224 break;
225 }
226 }
227 if (event)
228 list_add_tail(&event->queue_link, &efi_event_queue);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200229 }
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200230 efi_process_event_queue();
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200231}
232
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200233/**
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200234 * is_valid_tpl() - check if the task priority level is valid
235 *
236 * @tpl: TPL level to check
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200237 * Return: status code
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200238 */
239efi_status_t is_valid_tpl(efi_uintn_t tpl)
240{
241 switch (tpl) {
242 case TPL_APPLICATION:
243 case TPL_CALLBACK:
244 case TPL_NOTIFY:
245 case TPL_HIGH_LEVEL:
246 return EFI_SUCCESS;
247 default:
248 return EFI_INVALID_PARAMETER;
249 }
250}
251
252/**
Mario Six78a88f72018-07-10 08:40:17 +0200253 * efi_signal_event() - signal an EFI event
254 * @event: event to signal
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100255 *
Mario Six78a88f72018-07-10 08:40:17 +0200256 * This function signals an event. If the event belongs to an event group all
257 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100258 * their notification function is queued.
259 *
260 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100261 */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200262void efi_signal_event(struct efi_event *event)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100263{
Heinrich Schuchardtdfa306e2019-06-06 01:51:50 +0200264 if (event->is_signaled)
265 return;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100266 if (event->group) {
267 struct efi_event *evt;
268
269 /*
270 * The signaled state has to set before executing any
271 * notification function
272 */
273 list_for_each_entry(evt, &efi_events, link) {
274 if (!evt->group || guidcmp(evt->group, event->group))
275 continue;
276 if (evt->is_signaled)
277 continue;
278 evt->is_signaled = true;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100279 }
280 list_for_each_entry(evt, &efi_events, link) {
281 if (!evt->group || guidcmp(evt->group, event->group))
282 continue;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200283 efi_queue_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100284 }
Heinrich Schuchardt3626e532019-05-05 00:07:34 +0200285 } else {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100286 event->is_signaled = true;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200287 efi_queue_event(event);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100288 }
289}
290
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200291/**
Mario Six78a88f72018-07-10 08:40:17 +0200292 * efi_raise_tpl() - raise the task priority level
293 * @new_tpl: new value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200294 *
295 * This function implements the RaiseTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200296 *
Mario Six78a88f72018-07-10 08:40:17 +0200297 * See the Unified Extensible Firmware Interface (UEFI) specification for
298 * details.
299 *
300 * Return: old value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200301 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100302static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100303{
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100304 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200305
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200306 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200307
308 if (new_tpl < efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200309 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200310 efi_tpl = new_tpl;
311 if (efi_tpl > TPL_HIGH_LEVEL)
312 efi_tpl = TPL_HIGH_LEVEL;
313
314 EFI_EXIT(EFI_SUCCESS);
315 return old_tpl;
Alexander Grafbee91162016-03-04 01:09:59 +0100316}
317
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200318/**
Mario Six78a88f72018-07-10 08:40:17 +0200319 * efi_restore_tpl() - lower the task priority level
320 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200321 *
322 * This function implements the RestoreTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200323 *
Mario Six78a88f72018-07-10 08:40:17 +0200324 * See the Unified Extensible Firmware Interface (UEFI) specification for
325 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200326 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100327static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100328{
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200329 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200330
331 if (old_tpl > efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200332 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200333 efi_tpl = old_tpl;
334 if (efi_tpl > TPL_HIGH_LEVEL)
335 efi_tpl = TPL_HIGH_LEVEL;
336
Heinrich Schuchardt0f7fcc72018-03-24 18:40:21 +0100337 /*
338 * Lowering the TPL may have made queued events eligible for execution.
339 */
340 efi_timer_check();
341
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200342 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100343}
344
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200345/**
Mario Six78a88f72018-07-10 08:40:17 +0200346 * efi_allocate_pages_ext() - allocate memory pages
347 * @type: type of allocation to be performed
348 * @memory_type: usage type of the allocated memory
349 * @pages: number of pages to be allocated
350 * @memory: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200351 *
352 * This function implements the AllocatePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200353 *
Mario Six78a88f72018-07-10 08:40:17 +0200354 * See the Unified Extensible Firmware Interface (UEFI) specification for
355 * details.
356 *
357 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200358 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900359static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100360 efi_uintn_t pages,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900361 uint64_t *memory)
Alexander Grafbee91162016-03-04 01:09:59 +0100362{
363 efi_status_t r;
364
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100365 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafbee91162016-03-04 01:09:59 +0100366 r = efi_allocate_pages(type, memory_type, pages, memory);
367 return EFI_EXIT(r);
368}
369
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200370/**
Mario Six78a88f72018-07-10 08:40:17 +0200371 * efi_free_pages_ext() - Free memory pages.
372 * @memory: start of the memory area to be freed
373 * @pages: number of pages to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200374 *
375 * This function implements the FreePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200376 *
Mario Six78a88f72018-07-10 08:40:17 +0200377 * See the Unified Extensible Firmware Interface (UEFI) specification for
378 * details.
379 *
380 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200381 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900382static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100383 efi_uintn_t pages)
Alexander Grafbee91162016-03-04 01:09:59 +0100384{
385 efi_status_t r;
386
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900387 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafbee91162016-03-04 01:09:59 +0100388 r = efi_free_pages(memory, pages);
389 return EFI_EXIT(r);
390}
391
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200392/**
Mario Six78a88f72018-07-10 08:40:17 +0200393 * efi_get_memory_map_ext() - get map describing memory usage
394 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
395 * on exit the size of the copied memory map
396 * @memory_map: buffer to which the memory map is written
397 * @map_key: key for the memory map
398 * @descriptor_size: size of an individual memory descriptor
399 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200400 *
401 * This function implements the GetMemoryMap service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200402 *
Mario Six78a88f72018-07-10 08:40:17 +0200403 * See the Unified Extensible Firmware Interface (UEFI) specification for
404 * details.
405 *
406 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200407 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900408static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100409 efi_uintn_t *memory_map_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900410 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100411 efi_uintn_t *map_key,
412 efi_uintn_t *descriptor_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900413 uint32_t *descriptor_version)
Alexander Grafbee91162016-03-04 01:09:59 +0100414{
415 efi_status_t r;
416
417 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
418 map_key, descriptor_size, descriptor_version);
419 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
420 descriptor_size, descriptor_version);
421 return EFI_EXIT(r);
422}
423
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200424/**
Mario Six78a88f72018-07-10 08:40:17 +0200425 * efi_allocate_pool_ext() - allocate memory from pool
426 * @pool_type: type of the pool from which memory is to be allocated
427 * @size: number of bytes to be allocated
428 * @buffer: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200429 *
430 * This function implements the AllocatePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200431 *
Mario Six78a88f72018-07-10 08:40:17 +0200432 * See the Unified Extensible Firmware Interface (UEFI) specification for
433 * details.
434 *
435 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200436 */
Stefan Brünsead12742016-10-09 22:17:18 +0200437static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100438 efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200439 void **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100440{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100441 efi_status_t r;
442
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100443 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
Stefan Brünsead12742016-10-09 22:17:18 +0200444 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100445 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100446}
447
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200448/**
Mario Six78a88f72018-07-10 08:40:17 +0200449 * efi_free_pool_ext() - free memory from pool
450 * @buffer: start of memory to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200451 *
452 * This function implements the FreePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200453 *
Mario Six78a88f72018-07-10 08:40:17 +0200454 * See the Unified Extensible Firmware Interface (UEFI) specification for
455 * details.
456 *
457 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200458 */
Stefan Brüns42417bc2016-10-09 22:17:26 +0200459static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100460{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100461 efi_status_t r;
462
463 EFI_ENTRY("%p", buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200464 r = efi_free_pool(buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100465 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100466}
467
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200468/**
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200469 * efi_add_handle() - add a new handle to the object list
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100470 *
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200471 * @handle: handle to be added
472 *
473 * The protocols list is initialized. The handle is added to the list of known
474 * UEFI objects.
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100475 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200476void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100477{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200478 if (!handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100479 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200480 INIT_LIST_HEAD(&handle->protocols);
481 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100482}
483
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200484/**
Mario Six78a88f72018-07-10 08:40:17 +0200485 * efi_create_handle() - create handle
486 * @handle: new handle
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200487 *
Mario Six78a88f72018-07-10 08:40:17 +0200488 * Return: status code
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200489 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100490efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200491{
492 struct efi_object *obj;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200493
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200494 obj = calloc(1, sizeof(struct efi_object));
495 if (!obj)
496 return EFI_OUT_OF_RESOURCES;
497
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100498 efi_add_handle(obj);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200499 *handle = obj;
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200500
501 return EFI_SUCCESS;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200502}
503
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200504/**
Mario Six78a88f72018-07-10 08:40:17 +0200505 * efi_search_protocol() - find a protocol on a handle.
506 * @handle: handle
507 * @protocol_guid: GUID of the protocol
508 * @handler: reference to the protocol
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100509 *
Mario Six78a88f72018-07-10 08:40:17 +0200510 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100511 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100512efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100513 const efi_guid_t *protocol_guid,
514 struct efi_handler **handler)
515{
516 struct efi_object *efiobj;
517 struct list_head *lhandle;
518
519 if (!handle || !protocol_guid)
520 return EFI_INVALID_PARAMETER;
521 efiobj = efi_search_obj(handle);
522 if (!efiobj)
523 return EFI_INVALID_PARAMETER;
524 list_for_each(lhandle, &efiobj->protocols) {
525 struct efi_handler *protocol;
526
527 protocol = list_entry(lhandle, struct efi_handler, link);
528 if (!guidcmp(protocol->guid, protocol_guid)) {
529 if (handler)
530 *handler = protocol;
531 return EFI_SUCCESS;
532 }
533 }
534 return EFI_NOT_FOUND;
535}
536
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200537/**
Mario Six78a88f72018-07-10 08:40:17 +0200538 * efi_remove_protocol() - delete protocol from a handle
539 * @handle: handle from which the protocol shall be deleted
540 * @protocol: GUID of the protocol to be deleted
541 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100542 *
Mario Six78a88f72018-07-10 08:40:17 +0200543 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100544 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100545efi_status_t efi_remove_protocol(const efi_handle_t handle,
546 const efi_guid_t *protocol,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100547 void *protocol_interface)
548{
549 struct efi_handler *handler;
550 efi_status_t ret;
551
552 ret = efi_search_protocol(handle, protocol, &handler);
553 if (ret != EFI_SUCCESS)
554 return ret;
Heinrich Schuchardt1f470e12018-05-11 12:09:21 +0200555 if (handler->protocol_interface != protocol_interface)
Heinrich Schuchardt96aa99c2019-05-10 20:06:48 +0200556 return EFI_NOT_FOUND;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100557 list_del(&handler->link);
558 free(handler);
559 return EFI_SUCCESS;
560}
561
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200562/**
Mario Six78a88f72018-07-10 08:40:17 +0200563 * efi_remove_all_protocols() - delete all protocols from a handle
564 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100565 *
Mario Six78a88f72018-07-10 08:40:17 +0200566 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100567 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100568efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100569{
570 struct efi_object *efiobj;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100571 struct efi_handler *protocol;
572 struct efi_handler *pos;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100573
574 efiobj = efi_search_obj(handle);
575 if (!efiobj)
576 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100577 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100578 efi_status_t ret;
579
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100580 ret = efi_remove_protocol(handle, protocol->guid,
581 protocol->protocol_interface);
582 if (ret != EFI_SUCCESS)
583 return ret;
584 }
585 return EFI_SUCCESS;
586}
587
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200588/**
Mario Six78a88f72018-07-10 08:40:17 +0200589 * efi_delete_handle() - delete handle
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100590 *
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +0200591 * @handle: handle to delete
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100592 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200593void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100594{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200595 if (!handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100596 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200597 efi_remove_all_protocols(handle);
598 list_del(&handle->link);
599 free(handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100600}
601
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200602/**
Mario Six78a88f72018-07-10 08:40:17 +0200603 * efi_is_event() - check if a pointer is a valid event
604 * @event: pointer to check
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100605 *
Mario Six78a88f72018-07-10 08:40:17 +0200606 * Return: status code
Alexander Grafbee91162016-03-04 01:09:59 +0100607 */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100608static efi_status_t efi_is_event(const struct efi_event *event)
609{
610 const struct efi_event *evt;
611
612 if (!event)
613 return EFI_INVALID_PARAMETER;
614 list_for_each_entry(evt, &efi_events, link) {
615 if (evt == event)
616 return EFI_SUCCESS;
617 }
618 return EFI_INVALID_PARAMETER;
619}
Alexander Grafbee91162016-03-04 01:09:59 +0100620
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200621/**
Mario Six78a88f72018-07-10 08:40:17 +0200622 * efi_create_event() - create an event
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +0200623 *
Mario Six78a88f72018-07-10 08:40:17 +0200624 * @type: type of the event to create
625 * @notify_tpl: task priority level of the event
626 * @notify_function: notification function of the event
627 * @notify_context: pointer passed to the notification function
628 * @group: event group
629 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200630 *
631 * This function is used inside U-Boot code to create an event.
632 *
633 * For the API function implementing the CreateEvent service see
634 * efi_create_event_ext.
635 *
Mario Six78a88f72018-07-10 08:40:17 +0200636 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200637 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100638efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200639 void (EFIAPI *notify_function) (
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200640 struct efi_event *event,
641 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100642 void *notify_context, efi_guid_t *group,
643 struct efi_event **event)
Alexander Grafbee91162016-03-04 01:09:59 +0100644{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100645 struct efi_event *evt;
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200646 efi_status_t ret;
647 int pool_type;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200648
Jonathan Graya95343b2017-03-12 19:26:07 +1100649 if (event == NULL)
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200650 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100651
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200652 switch (type) {
653 case 0:
654 case EVT_TIMER:
655 case EVT_NOTIFY_SIGNAL:
656 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
657 case EVT_NOTIFY_WAIT:
658 case EVT_TIMER | EVT_NOTIFY_WAIT:
659 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200660 pool_type = EFI_BOOT_SERVICES_DATA;
661 break;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200662 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200663 pool_type = EFI_RUNTIME_SERVICES_DATA;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200664 break;
665 default:
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200666 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200667 }
Jonathan Graya95343b2017-03-12 19:26:07 +1100668
AKASHI Takahiro3748ed92018-08-10 15:36:32 +0900669 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardt751e9282019-04-25 07:30:41 +0200670 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200671 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100672
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200673 ret = efi_allocate_pool(pool_type, sizeof(struct efi_event),
674 (void **)&evt);
675 if (ret != EFI_SUCCESS)
676 return ret;
677 memset(evt, 0, sizeof(struct efi_event));
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100678 evt->type = type;
679 evt->notify_tpl = notify_tpl;
680 evt->notify_function = notify_function;
681 evt->notify_context = notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100682 evt->group = group;
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200683 /* Disable timers on boot up */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100684 evt->trigger_next = -1ULL;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100685 list_add_tail(&evt->link, &efi_events);
686 *event = evt;
687 return EFI_SUCCESS;
Alexander Grafbee91162016-03-04 01:09:59 +0100688}
689
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200690/*
Mario Six78a88f72018-07-10 08:40:17 +0200691 * efi_create_event_ex() - create an event in a group
692 * @type: type of the event to create
693 * @notify_tpl: task priority level of the event
694 * @notify_function: notification function of the event
695 * @notify_context: pointer passed to the notification function
696 * @event: created event
697 * @event_group: event group
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100698 *
699 * This function implements the CreateEventEx service.
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100700 *
Mario Six78a88f72018-07-10 08:40:17 +0200701 * See the Unified Extensible Firmware Interface (UEFI) specification for
702 * details.
703 *
704 * Return: status code
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100705 */
706efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
707 void (EFIAPI *notify_function) (
708 struct efi_event *event,
709 void *context),
710 void *notify_context,
711 efi_guid_t *event_group,
712 struct efi_event **event)
713{
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200714 efi_status_t ret;
715
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100716 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
717 notify_context, event_group);
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200718
719 /*
720 * The allowable input parameters are the same as in CreateEvent()
721 * except for the following two disallowed event types.
722 */
723 switch (type) {
724 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
725 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
726 ret = EFI_INVALID_PARAMETER;
727 goto out;
728 }
729
730 ret = efi_create_event(type, notify_tpl, notify_function,
731 notify_context, event_group, event);
732out:
733 return EFI_EXIT(ret);
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100734}
735
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200736/**
Mario Six78a88f72018-07-10 08:40:17 +0200737 * efi_create_event_ext() - create an event
738 * @type: type of the event to create
739 * @notify_tpl: task priority level of the event
740 * @notify_function: notification function of the event
741 * @notify_context: pointer passed to the notification function
742 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200743 *
744 * This function implements the CreateEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200745 *
Mario Six78a88f72018-07-10 08:40:17 +0200746 * See the Unified Extensible Firmware Interface (UEFI) specification for
747 * details.
748 *
749 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200750 */
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200751static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100752 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200753 void (EFIAPI *notify_function) (
754 struct efi_event *event,
755 void *context),
756 void *notify_context, struct efi_event **event)
757{
758 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
759 notify_context);
760 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100761 notify_context, NULL, event));
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200762}
763
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200764/**
Mario Six78a88f72018-07-10 08:40:17 +0200765 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200766 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200767 * Check if a timer event has occurred or a queued notification function should
768 * be called.
769 *
Alexander Grafbee91162016-03-04 01:09:59 +0100770 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200771 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafbee91162016-03-04 01:09:59 +0100772 */
773void efi_timer_check(void)
774{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100775 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +0100776 u64 now = timer_get_us();
777
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100778 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200779 if (!timers_enabled)
780 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100781 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200782 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100783 switch (evt->trigger_type) {
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200784 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100785 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200786 break;
787 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100788 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200789 break;
790 default:
791 continue;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200792 }
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100793 evt->is_signaled = false;
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200794 efi_signal_event(evt);
Alexander Grafbee91162016-03-04 01:09:59 +0100795 }
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200796 efi_process_event_queue();
Alexander Grafbee91162016-03-04 01:09:59 +0100797 WATCHDOG_RESET();
798}
799
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200800/**
Mario Six78a88f72018-07-10 08:40:17 +0200801 * efi_set_timer() - set the trigger time for a timer event or stop the event
802 * @event: event for which the timer is set
803 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200804 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200805 *
806 * This is the function for internal usage in U-Boot. For the API function
807 * implementing the SetTimer service see efi_set_timer_ext.
808 *
Mario Six78a88f72018-07-10 08:40:17 +0200809 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200810 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200811efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200812 uint64_t trigger_time)
Alexander Grafbee91162016-03-04 01:09:59 +0100813{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100814 /* Check that the event is valid */
815 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
816 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100817
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200818 /*
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200819 * The parameter defines a multiple of 100 ns.
820 * We use multiples of 1000 ns. So divide by 10.
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200821 */
Heinrich Schuchardt7d963322017-10-05 16:14:14 +0200822 do_div(trigger_time, 10);
Alexander Grafbee91162016-03-04 01:09:59 +0100823
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100824 switch (type) {
825 case EFI_TIMER_STOP:
826 event->trigger_next = -1ULL;
827 break;
828 case EFI_TIMER_PERIODIC:
829 case EFI_TIMER_RELATIVE:
830 event->trigger_next = timer_get_us() + trigger_time;
831 break;
832 default:
833 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100834 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100835 event->trigger_type = type;
836 event->trigger_time = trigger_time;
837 event->is_signaled = false;
838 return EFI_SUCCESS;
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200839}
840
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200841/**
Mario Six78a88f72018-07-10 08:40:17 +0200842 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
843 * event
844 * @event: event for which the timer is set
845 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200846 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200847 *
848 * This function implements the SetTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200849 *
Mario Six78a88f72018-07-10 08:40:17 +0200850 * See the Unified Extensible Firmware Interface (UEFI) specification for
851 * details.
852 *
853 *
854 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200855 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200856static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
857 enum efi_timer_delay type,
858 uint64_t trigger_time)
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200859{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900860 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200861 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
Alexander Grafbee91162016-03-04 01:09:59 +0100862}
863
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200864/**
Mario Six78a88f72018-07-10 08:40:17 +0200865 * efi_wait_for_event() - wait for events to be signaled
866 * @num_events: number of events to be waited for
867 * @event: events to be waited for
868 * @index: index of the event that was signaled
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200869 *
870 * This function implements the WaitForEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200871 *
Mario Six78a88f72018-07-10 08:40:17 +0200872 * See the Unified Extensible Firmware Interface (UEFI) specification for
873 * details.
874 *
875 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200876 */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100877static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200878 struct efi_event **event,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100879 efi_uintn_t *index)
Alexander Grafbee91162016-03-04 01:09:59 +0100880{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100881 int i;
Alexander Grafbee91162016-03-04 01:09:59 +0100882
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100883 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
Alexander Grafbee91162016-03-04 01:09:59 +0100884
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200885 /* Check parameters */
886 if (!num_events || !event)
887 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200888 /* Check TPL */
889 if (efi_tpl != TPL_APPLICATION)
890 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200891 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100892 if (efi_is_event(event[i]) != EFI_SUCCESS)
893 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200894 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
895 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200896 if (!event[i]->is_signaled)
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200897 efi_queue_event(event[i]);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200898 }
899
900 /* Wait for signal */
901 for (;;) {
902 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200903 if (event[i]->is_signaled)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200904 goto out;
905 }
906 /* Allow events to occur. */
907 efi_timer_check();
908 }
909
910out:
911 /*
912 * Reset the signal which is passed to the caller to allow periodic
913 * events to occur.
914 */
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200915 event[i]->is_signaled = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200916 if (index)
917 *index = i;
Alexander Grafbee91162016-03-04 01:09:59 +0100918
919 return EFI_EXIT(EFI_SUCCESS);
920}
921
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200922/**
Mario Six78a88f72018-07-10 08:40:17 +0200923 * efi_signal_event_ext() - signal an EFI event
924 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200925 *
926 * This function implements the SignalEvent service.
Mario Six78a88f72018-07-10 08:40:17 +0200927 *
928 * See the Unified Extensible Firmware Interface (UEFI) specification for
929 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200930 *
931 * This functions sets the signaled state of the event and queues the
932 * notification function for execution.
933 *
Mario Six78a88f72018-07-10 08:40:17 +0200934 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200935 */
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200936static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100937{
938 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100939 if (efi_is_event(event) != EFI_SUCCESS)
940 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200941 efi_signal_event(event);
Alexander Grafbee91162016-03-04 01:09:59 +0100942 return EFI_EXIT(EFI_SUCCESS);
943}
944
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200945/**
Mario Six78a88f72018-07-10 08:40:17 +0200946 * efi_close_event() - close an EFI event
947 * @event: event to close
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200948 *
949 * This function implements the CloseEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200950 *
Mario Six78a88f72018-07-10 08:40:17 +0200951 * See the Unified Extensible Firmware Interface (UEFI) specification for
952 * details.
953 *
954 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200955 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200956static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100957{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200958 struct efi_register_notify_event *item, *next;
959
Alexander Grafbee91162016-03-04 01:09:59 +0100960 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100961 if (efi_is_event(event) != EFI_SUCCESS)
962 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200963
964 /* Remove protocol notify registrations for the event */
965 list_for_each_entry_safe(item, next, &efi_register_notify_events,
966 link) {
967 if (event == item->event) {
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200968 struct efi_protocol_notification *hitem, *hnext;
969
970 /* Remove signaled handles */
971 list_for_each_entry_safe(hitem, hnext, &item->handles,
972 link) {
973 list_del(&hitem->link);
974 free(hitem);
975 }
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200976 list_del(&item->link);
977 free(item);
978 }
979 }
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200980 /* Remove event from queue */
981 if (efi_event_is_queued(event))
982 list_del(&event->queue_link);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200983
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100984 list_del(&event->link);
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200985 efi_free_pool(event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100986 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100987}
988
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200989/**
Mario Six78a88f72018-07-10 08:40:17 +0200990 * efi_check_event() - check if an event is signaled
991 * @event: event to check
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200992 *
993 * This function implements the CheckEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200994 *
Mario Six78a88f72018-07-10 08:40:17 +0200995 * See the Unified Extensible Firmware Interface (UEFI) specification for
996 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200997 *
Mario Six78a88f72018-07-10 08:40:17 +0200998 * If an event is not signaled yet, the notification function is queued. The
999 * signaled state is cleared.
1000 *
1001 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001002 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +02001003static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +01001004{
1005 EFI_ENTRY("%p", event);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02001006 efi_timer_check();
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001007 if (efi_is_event(event) != EFI_SUCCESS ||
1008 event->type & EVT_NOTIFY_SIGNAL)
1009 return EFI_EXIT(EFI_INVALID_PARAMETER);
1010 if (!event->is_signaled)
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001011 efi_queue_event(event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001012 if (event->is_signaled) {
1013 event->is_signaled = false;
1014 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02001015 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001016 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafbee91162016-03-04 01:09:59 +01001017}
1018
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001019/**
Mario Six78a88f72018-07-10 08:40:17 +02001020 * efi_search_obj() - find the internal EFI object for a handle
1021 * @handle: handle to find
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001022 *
Mario Six78a88f72018-07-10 08:40:17 +02001023 * Return: EFI object
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001024 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001025struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001026{
Heinrich Schuchardt1b681532017-11-06 21:17:50 +01001027 struct efi_object *efiobj;
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001028
Heinrich Schuchardtec163fa2019-05-05 10:37:51 +02001029 if (!handle)
1030 return NULL;
1031
Heinrich Schuchardt1b681532017-11-06 21:17:50 +01001032 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001033 if (efiobj == handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001034 return efiobj;
1035 }
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001036 return NULL;
1037}
1038
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001039/**
Mario Six78a88f72018-07-10 08:40:17 +02001040 * efi_open_protocol_info_entry() - create open protocol info entry and add it
1041 * to a protocol
1042 * @handler: handler of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001043 *
Mario Six78a88f72018-07-10 08:40:17 +02001044 * Return: open protocol info entry
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001045 */
1046static struct efi_open_protocol_info_entry *efi_create_open_info(
1047 struct efi_handler *handler)
1048{
1049 struct efi_open_protocol_info_item *item;
1050
1051 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
1052 if (!item)
1053 return NULL;
1054 /* Append the item to the open protocol info list. */
1055 list_add_tail(&item->link, &handler->open_infos);
1056
1057 return &item->info;
1058}
1059
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001060/**
Mario Six78a88f72018-07-10 08:40:17 +02001061 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1062 * @item: open protocol info entry to delete
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001063 *
Mario Six78a88f72018-07-10 08:40:17 +02001064 * Return: status code
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001065 */
1066static efi_status_t efi_delete_open_info(
1067 struct efi_open_protocol_info_item *item)
1068{
1069 list_del(&item->link);
1070 free(item);
1071 return EFI_SUCCESS;
1072}
1073
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001074/**
Mario Six78a88f72018-07-10 08:40:17 +02001075 * efi_add_protocol() - install new protocol on a handle
1076 * @handle: handle on which the protocol shall be installed
1077 * @protocol: GUID of the protocol to be installed
1078 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001079 *
Mario Six78a88f72018-07-10 08:40:17 +02001080 * Return: status code
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001081 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001082efi_status_t efi_add_protocol(const efi_handle_t handle,
1083 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001084 void *protocol_interface)
1085{
1086 struct efi_object *efiobj;
1087 struct efi_handler *handler;
1088 efi_status_t ret;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001089 struct efi_register_notify_event *event;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001090
1091 efiobj = efi_search_obj(handle);
1092 if (!efiobj)
1093 return EFI_INVALID_PARAMETER;
1094 ret = efi_search_protocol(handle, protocol, NULL);
1095 if (ret != EFI_NOT_FOUND)
1096 return EFI_INVALID_PARAMETER;
1097 handler = calloc(1, sizeof(struct efi_handler));
1098 if (!handler)
1099 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001100 handler->guid = protocol;
1101 handler->protocol_interface = protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001102 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001103 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001104
1105 /* Notify registered events */
1106 list_for_each_entry(event, &efi_register_notify_events, link) {
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001107 if (!guidcmp(protocol, &event->protocol)) {
1108 struct efi_protocol_notification *notif;
1109
1110 notif = calloc(1, sizeof(*notif));
1111 if (!notif) {
1112 list_del(&handler->link);
1113 free(handler);
1114 return EFI_OUT_OF_RESOURCES;
1115 }
1116 notif->handle = handle;
1117 list_add_tail(&notif->link, &event->handles);
Heinrich Schuchardtdaa3f842019-06-07 07:43:24 +02001118 event->event->is_signaled = false;
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001119 efi_signal_event(event->event);
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001120 }
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001121 }
1122
Heinrich Schuchardtd5504142018-01-11 08:16:01 +01001123 if (!guidcmp(&efi_guid_device_path, protocol))
1124 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001125 return EFI_SUCCESS;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001126}
1127
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001128/**
Mario Six78a88f72018-07-10 08:40:17 +02001129 * efi_install_protocol_interface() - install protocol interface
1130 * @handle: handle on which the protocol shall be installed
1131 * @protocol: GUID of the protocol to be installed
1132 * @protocol_interface_type: type of the interface to be installed,
1133 * always EFI_NATIVE_INTERFACE
1134 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001135 *
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001136 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001137 *
Mario Six78a88f72018-07-10 08:40:17 +02001138 * See the Unified Extensible Firmware Interface (UEFI) specification for
1139 * details.
1140 *
1141 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001142 */
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001143static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02001144 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001145 int protocol_interface_type, void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001146{
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001147 efi_status_t r;
1148
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001149 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1150 protocol_interface);
1151
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001152 if (!handle || !protocol ||
1153 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1154 r = EFI_INVALID_PARAMETER;
1155 goto out;
1156 }
1157
1158 /* Create new handle if requested. */
1159 if (!*handle) {
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +02001160 r = efi_create_handle(handle);
1161 if (r != EFI_SUCCESS)
1162 goto out;
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02001163 EFI_PRINT("new handle %p\n", *handle);
Heinrich Schuchardtaf1408e2017-10-26 19:25:43 +02001164 } else {
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02001165 EFI_PRINT("handle %p\n", *handle);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001166 }
Heinrich Schuchardt12025302017-10-26 19:25:54 +02001167 /* Add new protocol */
1168 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001169out:
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001170 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001171}
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001172
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001173/**
Mario Six78a88f72018-07-10 08:40:17 +02001174 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001175 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001176 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001177 * @number_of_drivers: number of child controllers
1178 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001179 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001180 * The allocated buffer has to be freed with free().
1181 *
Mario Six78a88f72018-07-10 08:40:17 +02001182 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001183 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001184static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001185 const efi_guid_t *protocol,
1186 efi_uintn_t *number_of_drivers,
1187 efi_handle_t **driver_handle_buffer)
1188{
1189 struct efi_handler *handler;
1190 struct efi_open_protocol_info_item *item;
1191 efi_uintn_t count = 0, i;
1192 bool duplicate;
1193
1194 /* Count all driver associations */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001195 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001196 if (protocol && guidcmp(handler->guid, protocol))
1197 continue;
1198 list_for_each_entry(item, &handler->open_infos, link) {
1199 if (item->info.attributes &
1200 EFI_OPEN_PROTOCOL_BY_DRIVER)
1201 ++count;
1202 }
1203 }
Heinrich Schuchardt66ca24a2019-06-02 01:43:33 +02001204 *number_of_drivers = 0;
1205 if (!count) {
1206 *driver_handle_buffer = NULL;
1207 return EFI_SUCCESS;
1208 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001209 /*
1210 * Create buffer. In case of duplicate driver assignments the buffer
1211 * will be too large. But that does not harm.
1212 */
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001213 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1214 if (!*driver_handle_buffer)
1215 return EFI_OUT_OF_RESOURCES;
1216 /* Collect unique driver handles */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001217 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001218 if (protocol && guidcmp(handler->guid, protocol))
1219 continue;
1220 list_for_each_entry(item, &handler->open_infos, link) {
1221 if (item->info.attributes &
1222 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1223 /* Check this is a new driver */
1224 duplicate = false;
1225 for (i = 0; i < *number_of_drivers; ++i) {
1226 if ((*driver_handle_buffer)[i] ==
1227 item->info.agent_handle)
1228 duplicate = true;
1229 }
1230 /* Copy handle to buffer */
1231 if (!duplicate) {
1232 i = (*number_of_drivers)++;
1233 (*driver_handle_buffer)[i] =
1234 item->info.agent_handle;
1235 }
1236 }
1237 }
1238 }
1239 return EFI_SUCCESS;
1240}
1241
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001242/**
Mario Six78a88f72018-07-10 08:40:17 +02001243 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001244 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001245 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001246 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001247 *
1248 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001249 *
Mario Six78a88f72018-07-10 08:40:17 +02001250 * See the Unified Extensible Firmware Interface (UEFI) specification for
1251 * details.
1252 *
1253 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001254 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001255static efi_status_t efi_disconnect_all_drivers
1256 (efi_handle_t handle,
1257 const efi_guid_t *protocol,
1258 efi_handle_t child_handle)
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001259{
1260 efi_uintn_t number_of_drivers;
1261 efi_handle_t *driver_handle_buffer;
1262 efi_status_t r, ret;
1263
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001264 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001265 &driver_handle_buffer);
1266 if (ret != EFI_SUCCESS)
1267 return ret;
Heinrich Schuchardt66ca24a2019-06-02 01:43:33 +02001268 if (!number_of_drivers)
1269 return EFI_SUCCESS;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001270 ret = EFI_NOT_FOUND;
1271 while (number_of_drivers) {
1272 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001273 handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001274 driver_handle_buffer[--number_of_drivers],
1275 child_handle));
1276 if (r == EFI_SUCCESS)
1277 ret = r;
1278 }
1279 free(driver_handle_buffer);
1280 return ret;
1281}
1282
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001283/**
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001284 * efi_uninstall_protocol() - uninstall protocol interface
1285 *
Mario Six78a88f72018-07-10 08:40:17 +02001286 * @handle: handle from which the protocol shall be removed
1287 * @protocol: GUID of the protocol to be removed
1288 * @protocol_interface: interface to be removed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001289 *
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001290 * This function DOES NOT delete a handle without installed protocol.
Mario Six78a88f72018-07-10 08:40:17 +02001291 *
1292 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001293 */
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001294static efi_status_t efi_uninstall_protocol
1295 (efi_handle_t handle, const efi_guid_t *protocol,
1296 void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001297{
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001298 struct efi_object *efiobj;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001299 struct efi_handler *handler;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001300 struct efi_open_protocol_info_item *item;
1301 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001302 efi_status_t r;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001303
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001304 /* Check handle */
1305 efiobj = efi_search_obj(handle);
1306 if (!efiobj) {
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001307 r = EFI_INVALID_PARAMETER;
1308 goto out;
1309 }
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001310 /* Find the protocol on the handle */
1311 r = efi_search_protocol(handle, protocol, &handler);
1312 if (r != EFI_SUCCESS)
1313 goto out;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001314 /* Disconnect controllers */
1315 efi_disconnect_all_drivers(efiobj, protocol, NULL);
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001316 /* Close protocol */
1317 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1318 if (item->info.attributes ==
1319 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1320 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1321 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1322 list_del(&item->link);
1323 }
1324 if (!list_empty(&handler->open_infos)) {
1325 r = EFI_ACCESS_DENIED;
1326 goto out;
1327 }
1328 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001329out:
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001330 return r;
1331}
1332
1333/**
1334 * efi_uninstall_protocol_interface() - uninstall protocol interface
1335 * @handle: handle from which the protocol shall be removed
1336 * @protocol: GUID of the protocol to be removed
1337 * @protocol_interface: interface to be removed
1338 *
1339 * This function implements the UninstallProtocolInterface service.
1340 *
1341 * See the Unified Extensible Firmware Interface (UEFI) specification for
1342 * details.
1343 *
1344 * Return: status code
1345 */
1346static efi_status_t EFIAPI efi_uninstall_protocol_interface
1347 (efi_handle_t handle, const efi_guid_t *protocol,
1348 void *protocol_interface)
1349{
1350 efi_status_t ret;
1351
1352 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1353
1354 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1355 if (ret != EFI_SUCCESS)
1356 goto out;
1357
1358 /* If the last protocol has been removed, delete the handle. */
1359 if (list_empty(&handle->protocols)) {
1360 list_del(&handle->link);
1361 free(handle);
1362 }
1363out:
1364 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001365}
1366
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001367/**
Mario Six78a88f72018-07-10 08:40:17 +02001368 * efi_register_protocol_notify() - register an event for notification when a
1369 * protocol is installed.
1370 * @protocol: GUID of the protocol whose installation shall be notified
1371 * @event: event to be signaled upon installation of the protocol
1372 * @registration: key for retrieving the registration information
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001373 *
1374 * This function implements the RegisterProtocolNotify service.
1375 * See the Unified Extensible Firmware Interface (UEFI) specification
1376 * for details.
1377 *
Mario Six78a88f72018-07-10 08:40:17 +02001378 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001379 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001380static efi_status_t EFIAPI efi_register_protocol_notify(
1381 const efi_guid_t *protocol,
1382 struct efi_event *event,
1383 void **registration)
Alexander Grafbee91162016-03-04 01:09:59 +01001384{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001385 struct efi_register_notify_event *item;
1386 efi_status_t ret = EFI_SUCCESS;
1387
Rob Clark778e6af2017-09-13 18:05:41 -04001388 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001389
1390 if (!protocol || !event || !registration) {
1391 ret = EFI_INVALID_PARAMETER;
1392 goto out;
1393 }
1394
1395 item = calloc(1, sizeof(struct efi_register_notify_event));
1396 if (!item) {
1397 ret = EFI_OUT_OF_RESOURCES;
1398 goto out;
1399 }
1400
1401 item->event = event;
1402 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001403 INIT_LIST_HEAD(&item->handles);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001404
1405 list_add_tail(&item->link, &efi_register_notify_events);
1406
1407 *registration = item;
1408out:
1409 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001410}
1411
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001412/**
Mario Six78a88f72018-07-10 08:40:17 +02001413 * efi_search() - determine if an EFI handle implements a protocol
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +02001414 *
Mario Six78a88f72018-07-10 08:40:17 +02001415 * @search_type: selection criterion
1416 * @protocol: GUID of the protocol
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001417 * @handle: handle
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001418 *
1419 * See the documentation of the LocateHandle service in the UEFI specification.
1420 *
Mario Six78a88f72018-07-10 08:40:17 +02001421 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001422 */
Alexander Grafbee91162016-03-04 01:09:59 +01001423static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001424 const efi_guid_t *protocol, efi_handle_t handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001425{
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001426 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01001427
1428 switch (search_type) {
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001429 case ALL_HANDLES:
Alexander Grafbee91162016-03-04 01:09:59 +01001430 return 0;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001431 case BY_PROTOCOL:
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001432 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001433 return (ret != EFI_SUCCESS);
1434 default:
1435 /* Invalid search type */
Alexander Grafbee91162016-03-04 01:09:59 +01001436 return -1;
1437 }
Alexander Grafbee91162016-03-04 01:09:59 +01001438}
1439
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001440/**
Heinrich Schuchardtb8abd742019-05-29 07:46:33 +02001441 * efi_check_register_notify_event() - check if registration key is valid
1442 *
1443 * Check that a pointer is a valid registration key as returned by
1444 * RegisterProtocolNotify().
1445 *
1446 * @key: registration key
1447 * Return: valid registration key or NULL
1448 */
1449static struct efi_register_notify_event *efi_check_register_notify_event
1450 (void *key)
1451{
1452 struct efi_register_notify_event *event;
1453
1454 list_for_each_entry(event, &efi_register_notify_events, link) {
1455 if (event == (struct efi_register_notify_event *)key)
1456 return event;
1457 }
1458 return NULL;
1459}
1460
1461/**
Mario Six78a88f72018-07-10 08:40:17 +02001462 * efi_locate_handle() - locate handles implementing a protocol
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001463 *
1464 * @search_type: selection criterion
1465 * @protocol: GUID of the protocol
1466 * @search_key: registration key
1467 * @buffer_size: size of the buffer to receive the handles in bytes
1468 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001469 *
1470 * This function is meant for U-Boot internal calls. For the API implementation
1471 * of the LocateHandle service see efi_locate_handle_ext.
1472 *
Mario Six78a88f72018-07-10 08:40:17 +02001473 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001474 */
xypron.glpk@gmx.deebf199b2017-08-09 20:55:00 +02001475static efi_status_t efi_locate_handle(
Alexander Grafbee91162016-03-04 01:09:59 +01001476 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001477 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001478 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01001479{
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001480 struct efi_object *efiobj;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001481 efi_uintn_t size = 0;
Heinrich Schuchardtb8abd742019-05-29 07:46:33 +02001482 struct efi_register_notify_event *event;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001483 struct efi_protocol_notification *handle = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01001484
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001485 /* Check parameters */
1486 switch (search_type) {
1487 case ALL_HANDLES:
1488 break;
1489 case BY_REGISTER_NOTIFY:
1490 if (!search_key)
1491 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001492 /* Check that the registration key is valid */
Heinrich Schuchardtb8abd742019-05-29 07:46:33 +02001493 event = efi_check_register_notify_event(search_key);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001494 if (!event)
1495 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001496 break;
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001497 case BY_PROTOCOL:
1498 if (!protocol)
1499 return EFI_INVALID_PARAMETER;
1500 break;
1501 default:
1502 return EFI_INVALID_PARAMETER;
1503 }
1504
Alexander Grafbee91162016-03-04 01:09:59 +01001505 /* Count how much space we need */
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001506 if (search_type == BY_REGISTER_NOTIFY) {
1507 if (list_empty(&event->handles))
1508 return EFI_NOT_FOUND;
1509 handle = list_first_entry(&event->handles,
1510 struct efi_protocol_notification,
1511 link);
1512 efiobj = handle->handle;
1513 size += sizeof(void *);
1514 } else {
1515 list_for_each_entry(efiobj, &efi_obj_list, link) {
1516 if (!efi_search(search_type, protocol, efiobj))
1517 size += sizeof(void *);
1518 }
1519 if (size == 0)
1520 return EFI_NOT_FOUND;
Alexander Grafbee91162016-03-04 01:09:59 +01001521 }
1522
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001523 if (!buffer_size)
1524 return EFI_INVALID_PARAMETER;
1525
Alexander Grafbee91162016-03-04 01:09:59 +01001526 if (*buffer_size < size) {
1527 *buffer_size = size;
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001528 return EFI_BUFFER_TOO_SMALL;
Alexander Grafbee91162016-03-04 01:09:59 +01001529 }
1530
Rob Clark796a78c2017-08-06 14:10:07 -04001531 *buffer_size = size;
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001532
Heinrich Schuchardt0a843192019-05-10 19:03:49 +02001533 /* The buffer size is sufficient but there is no buffer */
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001534 if (!buffer)
1535 return EFI_INVALID_PARAMETER;
Rob Clark796a78c2017-08-06 14:10:07 -04001536
Alexander Grafbee91162016-03-04 01:09:59 +01001537 /* Then fill the array */
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001538 if (search_type == BY_REGISTER_NOTIFY) {
1539 *buffer = efiobj;
1540 list_del(&handle->link);
1541 } else {
1542 list_for_each_entry(efiobj, &efi_obj_list, link) {
1543 if (!efi_search(search_type, protocol, efiobj))
1544 *buffer++ = efiobj;
1545 }
Alexander Grafbee91162016-03-04 01:09:59 +01001546 }
1547
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001548 return EFI_SUCCESS;
1549}
1550
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001551/**
Mario Six78a88f72018-07-10 08:40:17 +02001552 * efi_locate_handle_ext() - locate handles implementing a protocol.
1553 * @search_type: selection criterion
1554 * @protocol: GUID of the protocol
1555 * @search_key: registration key
1556 * @buffer_size: size of the buffer to receive the handles in bytes
1557 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001558 *
1559 * This function implements the LocateHandle service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001560 *
Mario Six78a88f72018-07-10 08:40:17 +02001561 * See the Unified Extensible Firmware Interface (UEFI) specification for
1562 * details.
1563 *
1564 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001565 */
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001566static efi_status_t EFIAPI efi_locate_handle_ext(
1567 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001568 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001569 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001570{
Rob Clark778e6af2017-09-13 18:05:41 -04001571 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001572 buffer_size, buffer);
1573
1574 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1575 buffer_size, buffer));
Alexander Grafbee91162016-03-04 01:09:59 +01001576}
1577
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001578/**
Mario Six78a88f72018-07-10 08:40:17 +02001579 * efi_remove_configuration_table() - collapses configuration table entries,
1580 * removing index i
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001581 *
Mario Six78a88f72018-07-10 08:40:17 +02001582 * @i: index of the table entry to be removed
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001583 */
Alexander Grafd98cdf62017-07-26 13:41:04 +02001584static void efi_remove_configuration_table(int i)
1585{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001586 struct efi_configuration_table *this = &systab.tables[i];
1587 struct efi_configuration_table *next = &systab.tables[i + 1];
1588 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Grafd98cdf62017-07-26 13:41:04 +02001589
1590 memmove(this, next, (ulong)end - (ulong)next);
1591 systab.nr_tables--;
1592}
1593
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001594/**
Mario Six78a88f72018-07-10 08:40:17 +02001595 * efi_install_configuration_table() - adds, updates, or removes a
1596 * configuration table
1597 * @guid: GUID of the installed table
1598 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001599 *
1600 * This function is used for internal calls. For the API implementation of the
1601 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1602 *
Mario Six78a88f72018-07-10 08:40:17 +02001603 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001604 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001605efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1606 void *table)
Alexander Grafbee91162016-03-04 01:09:59 +01001607{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001608 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +01001609 int i;
1610
Heinrich Schuchardteb68b4e2018-02-18 00:08:00 +01001611 if (!guid)
1612 return EFI_INVALID_PARAMETER;
1613
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001614 /* Check for GUID override */
Alexander Grafbee91162016-03-04 01:09:59 +01001615 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001616 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Grafd98cdf62017-07-26 13:41:04 +02001617 if (table)
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001618 systab.tables[i].table = table;
Alexander Grafd98cdf62017-07-26 13:41:04 +02001619 else
1620 efi_remove_configuration_table(i);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001621 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01001622 }
1623 }
1624
Alexander Grafd98cdf62017-07-26 13:41:04 +02001625 if (!table)
1626 return EFI_NOT_FOUND;
1627
Alexander Grafbee91162016-03-04 01:09:59 +01001628 /* No override, check for overflow */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001629 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Graf488bf122016-08-19 01:23:24 +02001630 return EFI_OUT_OF_RESOURCES;
Alexander Grafbee91162016-03-04 01:09:59 +01001631
1632 /* Add a new entry */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001633 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1634 systab.tables[i].table = table;
Alexander Grafaba5e912016-08-19 01:23:30 +02001635 systab.nr_tables = i + 1;
Alexander Grafbee91162016-03-04 01:09:59 +01001636
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001637out:
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001638 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardt55d8ee32018-07-07 15:36:05 +02001639 efi_update_table_header_crc32(&systab.hdr);
1640
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001641 /* Notify that the configuration table was changed */
1642 list_for_each_entry(evt, &efi_events, link) {
1643 if (evt->group && !guidcmp(evt->group, guid)) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001644 efi_signal_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001645 break;
1646 }
1647 }
1648
Alexander Graf488bf122016-08-19 01:23:24 +02001649 return EFI_SUCCESS;
1650}
1651
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001652/**
Mario Six78a88f72018-07-10 08:40:17 +02001653 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1654 * configuration table.
1655 * @guid: GUID of the installed table
1656 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001657 *
1658 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001659 *
Mario Six78a88f72018-07-10 08:40:17 +02001660 * See the Unified Extensible Firmware Interface (UEFI) specification for
1661 * details.
1662 *
1663 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001664 */
Alexander Graf488bf122016-08-19 01:23:24 +02001665static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1666 void *table)
1667{
Rob Clark778e6af2017-09-13 18:05:41 -04001668 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Graf488bf122016-08-19 01:23:24 +02001669 return EFI_EXIT(efi_install_configuration_table(guid, table));
Alexander Grafbee91162016-03-04 01:09:59 +01001670}
1671
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001672/**
Mario Six78a88f72018-07-10 08:40:17 +02001673 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001674 *
1675 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clark95c55532017-09-13 18:05:33 -04001676 * protocols, boot-device, etc.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001677 *
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +02001678 * In case of an error \*handle_ptr and \*info_ptr are set to NULL and an error
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001679 * code is returned.
1680 *
1681 * @device_path: device path of the loaded image
1682 * @file_path: file path of the loaded image
1683 * @handle_ptr: handle of the loaded image
1684 * @info_ptr: loaded image protocol
1685 * Return: status code
Rob Clark95c55532017-09-13 18:05:33 -04001686 */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001687efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1688 struct efi_device_path *file_path,
1689 struct efi_loaded_image_obj **handle_ptr,
1690 struct efi_loaded_image **info_ptr)
Rob Clark95c55532017-09-13 18:05:33 -04001691{
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001692 efi_status_t ret;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001693 struct efi_loaded_image *info = NULL;
1694 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001695 struct efi_device_path *dp;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001696
1697 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1698 *handle_ptr = NULL;
1699 *info_ptr = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001700
1701 info = calloc(1, sizeof(*info));
1702 if (!info)
1703 return EFI_OUT_OF_RESOURCES;
1704 obj = calloc(1, sizeof(*obj));
1705 if (!obj) {
1706 free(info);
1707 return EFI_OUT_OF_RESOURCES;
1708 }
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02001709 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001710
Heinrich Schuchardt44549d62017-11-26 14:05:23 +01001711 /* Add internal object to object list */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001712 efi_add_handle(&obj->header);
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001713
Heinrich Schuchardt95147312018-07-05 08:17:58 +02001714 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Rob Clark95c55532017-09-13 18:05:33 -04001715 info->file_path = file_path;
Heinrich Schuchardt7e1effc2018-08-26 15:31:52 +02001716 info->system_table = &systab;
Rob Clark95c55532017-09-13 18:05:33 -04001717
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001718 if (device_path) {
1719 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001720
1721 dp = efi_dp_append(device_path, file_path);
1722 if (!dp) {
1723 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001724 goto failure;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001725 }
1726 } else {
1727 dp = NULL;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001728 }
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001729 ret = efi_add_protocol(&obj->header,
1730 &efi_guid_loaded_image_device_path, dp);
1731 if (ret != EFI_SUCCESS)
1732 goto failure;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001733
1734 /*
1735 * When asking for the loaded_image interface, just
1736 * return handle which points to loaded_image_info
1737 */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001738 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001739 &efi_guid_loaded_image, info);
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001740 if (ret != EFI_SUCCESS)
1741 goto failure;
1742
Heinrich Schuchardtd5974af2019-03-19 18:58:58 +01001743 *info_ptr = info;
1744 *handle_ptr = obj;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001745
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001746 return ret;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001747failure:
1748 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001749 efi_delete_handle(&obj->header);
1750 free(info);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001751 return ret;
Rob Clark95c55532017-09-13 18:05:33 -04001752}
1753
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001754/**
Mario Six78a88f72018-07-10 08:40:17 +02001755 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001756 *
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001757 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1758 * callers obligation to update the memory type as needed.
1759 *
1760 * @file_path: the path of the image to load
1761 * @buffer: buffer containing the loaded image
1762 * @size: size of the loaded image
1763 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001764 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09001765static
Rob Clark9975fe92017-09-13 18:05:38 -04001766efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001767 void **buffer, efi_uintn_t *size)
Rob Clark838ee4b2017-09-13 18:05:35 -04001768{
1769 struct efi_file_info *info = NULL;
1770 struct efi_file_handle *f;
1771 static efi_status_t ret;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001772 u64 addr;
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001773 efi_uintn_t bs;
Rob Clark838ee4b2017-09-13 18:05:35 -04001774
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001775 /* In case of failure nothing is returned */
1776 *buffer = NULL;
1777 *size = 0;
1778
1779 /* Open file */
Rob Clark838ee4b2017-09-13 18:05:35 -04001780 f = efi_file_from_path(file_path);
1781 if (!f)
Heinrich Schuchardt20000032019-06-11 19:00:56 +02001782 return EFI_NOT_FOUND;
Rob Clark838ee4b2017-09-13 18:05:35 -04001783
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001784 /* Get file size */
Rob Clark838ee4b2017-09-13 18:05:35 -04001785 bs = 0;
1786 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1787 &bs, info));
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001788 if (ret != EFI_BUFFER_TOO_SMALL) {
1789 ret = EFI_DEVICE_ERROR;
1790 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001791 }
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001792
1793 info = malloc(bs);
1794 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1795 info));
Rob Clark838ee4b2017-09-13 18:05:35 -04001796 if (ret != EFI_SUCCESS)
1797 goto error;
1798
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001799 /*
1800 * When reading the file we do not yet know if it contains an
1801 * application, a boottime driver, or a runtime driver. So here we
1802 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1803 * update the reservation according to the image type.
1804 */
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001805 bs = info->file_size;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001806 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1807 EFI_BOOT_SERVICES_DATA,
1808 efi_size_in_pages(bs), &addr);
Rob Clark838ee4b2017-09-13 18:05:35 -04001809 if (ret != EFI_SUCCESS) {
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001810 ret = EFI_OUT_OF_RESOURCES;
1811 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001812 }
1813
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001814 /* Read file */
1815 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1816 if (ret != EFI_SUCCESS)
1817 efi_free_pages(addr, efi_size_in_pages(bs));
1818 *buffer = (void *)(uintptr_t)addr;
1819 *size = bs;
1820error:
1821 EFI_CALL(f->close(f));
1822 free(info);
Rob Clark838ee4b2017-09-13 18:05:35 -04001823 return ret;
1824}
1825
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001826/**
Mario Six78a88f72018-07-10 08:40:17 +02001827 * efi_load_image() - load an EFI image into memory
1828 * @boot_policy: true for request originating from the boot manager
1829 * @parent_image: the caller's image handle
1830 * @file_path: the path of the image to load
1831 * @source_buffer: memory location from which the image is installed
1832 * @source_size: size of the memory area from which the image is installed
1833 * @image_handle: handle for the newly installed image
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001834 *
1835 * This function implements the LoadImage service.
Mario Six78a88f72018-07-10 08:40:17 +02001836 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001837 * See the Unified Extensible Firmware Interface (UEFI) specification
1838 * for details.
1839 *
Mario Six78a88f72018-07-10 08:40:17 +02001840 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001841 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09001842efi_status_t EFIAPI efi_load_image(bool boot_policy,
1843 efi_handle_t parent_image,
1844 struct efi_device_path *file_path,
1845 void *source_buffer,
1846 efi_uintn_t source_size,
1847 efi_handle_t *image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001848{
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001849 struct efi_device_path *dp, *fp;
Tom Rini1c3b2f42018-09-30 10:38:15 -04001850 struct efi_loaded_image *info = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001851 struct efi_loaded_image_obj **image_obj =
1852 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001853 efi_status_t ret;
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001854 void *dest_buffer;
Alexander Grafbee91162016-03-04 01:09:59 +01001855
Heinrich Schuchardt7fb96a12018-04-03 22:29:30 +02001856 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafbee91162016-03-04 01:09:59 +01001857 file_path, source_buffer, source_size, image_handle);
Rob Clark838ee4b2017-09-13 18:05:35 -04001858
Heinrich Schuchardte4afcb22019-06-11 18:52:33 +02001859 if (!image_handle || (!source_buffer && !file_path) ||
1860 !efi_search_obj(parent_image) ||
1861 /* The parent image handle must refer to a loaded image */
1862 !parent_image->type) {
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +02001863 ret = EFI_INVALID_PARAMETER;
1864 goto error;
1865 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001866
Rob Clark838ee4b2017-09-13 18:05:35 -04001867 if (!source_buffer) {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001868 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001869 &source_size);
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001870 if (ret != EFI_SUCCESS)
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001871 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001872 } else {
Heinrich Schuchardt470dfa52019-05-05 16:55:06 +02001873 if (!source_size) {
1874 ret = EFI_LOAD_ERROR;
1875 goto error;
1876 }
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001877 dest_buffer = source_buffer;
Rob Clark838ee4b2017-09-13 18:05:35 -04001878 }
Heinrich Schuchardt1e15a9c2019-04-20 19:24:43 +00001879 /* split file_path which contains both the device and file parts */
1880 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001881 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001882 if (ret == EFI_SUCCESS)
1883 ret = efi_load_pe(*image_obj, dest_buffer, info);
1884 if (!source_buffer)
1885 /* Release buffer to which file was loaded */
1886 efi_free_pages((uintptr_t)dest_buffer,
1887 efi_size_in_pages(source_size));
1888 if (ret == EFI_SUCCESS) {
1889 info->system_table = &systab;
1890 info->parent_handle = parent_image;
1891 } else {
1892 /* The image is invalid. Release all associated resources. */
1893 efi_delete_handle(*image_handle);
1894 *image_handle = NULL;
1895 free(info);
1896 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001897error:
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001898 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001899}
1900
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001901/**
Alexander Graff31239a2018-11-15 21:23:47 +01001902 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1903 */
1904static void efi_exit_caches(void)
1905{
Heinrich Schuchardt6f3badb2019-07-22 22:04:36 +02001906#if defined(CONFIG_EFI_GRUB_ARM32_WORKAROUND)
Alexander Graff31239a2018-11-15 21:23:47 +01001907 /*
Heinrich Schuchardt6f3badb2019-07-22 22:04:36 +02001908 * Boooting Linux via GRUB prior to version 2.04 fails on 32bit ARM if
1909 * caches are enabled.
1910 *
1911 * TODO:
1912 * According to the UEFI spec caches that can be managed via CP15
1913 * operations should be enabled. Caches requiring platform information
1914 * to manage should be disabled. This should not happen in
1915 * ExitBootServices() but before invoking any UEFI binary is invoked.
1916 *
1917 * We want to keep the current workaround while GRUB prior to version
1918 * 2.04 is still in use.
Alexander Graff31239a2018-11-15 21:23:47 +01001919 */
Heinrich Schuchardt6f3badb2019-07-22 22:04:36 +02001920 cleanup_before_linux();
Alexander Graff31239a2018-11-15 21:23:47 +01001921#endif
1922}
1923
1924/**
Mario Six78a88f72018-07-10 08:40:17 +02001925 * efi_exit_boot_services() - stop all boot services
1926 * @image_handle: handle of the loaded image
1927 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001928 *
1929 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02001930 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001931 * See the Unified Extensible Firmware Interface (UEFI) specification
1932 * for details.
1933 *
Mario Six78a88f72018-07-10 08:40:17 +02001934 * All timer events are disabled. For exit boot services events the
1935 * notification function is called. The boot services are disabled in the
1936 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001937 *
Mario Six78a88f72018-07-10 08:40:17 +02001938 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001939 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001940static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001941 efi_uintn_t map_key)
Alexander Grafbee91162016-03-04 01:09:59 +01001942{
Heinrich Schuchardt14b40482019-07-11 20:15:09 +02001943 struct efi_event *evt, *next_event;
Heinrich Schuchardt98967372019-06-11 20:05:40 +02001944 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001945
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001946 EFI_ENTRY("%p, %zx", image_handle, map_key);
Alexander Grafbee91162016-03-04 01:09:59 +01001947
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001948 /* Check that the caller has read the current memory map */
Heinrich Schuchardt98967372019-06-11 20:05:40 +02001949 if (map_key != efi_memory_map_key) {
1950 ret = EFI_INVALID_PARAMETER;
1951 goto out;
1952 }
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001953
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001954 /* Check if ExitBootServices has already been called */
1955 if (!systab.boottime)
Heinrich Schuchardt98967372019-06-11 20:05:40 +02001956 goto out;
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001957
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001958 /* Stop all timer related activities */
1959 timers_enabled = false;
1960
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001961 /* Add related events to the event group */
1962 list_for_each_entry(evt, &efi_events, link) {
1963 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1964 evt->group = &efi_guid_event_group_exit_boot_services;
1965 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001966 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001967 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001968 if (evt->group &&
1969 !guidcmp(evt->group,
1970 &efi_guid_event_group_exit_boot_services)) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001971 efi_signal_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001972 break;
1973 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001974 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001975
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001976 /* Make sure that notification functions are not called anymore */
1977 efi_tpl = TPL_HIGH_LEVEL;
1978
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +02001979 /* Notify variable services */
1980 efi_variables_boot_exit_notify();
Rob Clarkad644e72017-09-13 18:05:37 -04001981
Heinrich Schuchardt14b40482019-07-11 20:15:09 +02001982 /* Remove all events except EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
1983 list_for_each_entry_safe(evt, next_event, &efi_events, link) {
1984 if (evt->type != EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE)
1985 list_del(&evt->link);
1986 }
1987
Alexander Grafb7b84102016-11-17 01:02:57 +01001988 board_quiesce_devices();
1989
Heinrich Schuchardt7f951042019-07-05 17:42:16 +02001990 /* Patch out unsupported runtime function */
1991 efi_runtime_detach();
1992
Alexander Graff31239a2018-11-15 21:23:47 +01001993 /* Fix up caches for EFI payloads if necessary */
1994 efi_exit_caches();
1995
Alexander Grafbee91162016-03-04 01:09:59 +01001996 /* This stops all lingering devices */
1997 bootm_disable_interrupts();
1998
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001999 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01002000 systab.con_in_handle = NULL;
2001 systab.con_in = NULL;
2002 systab.con_out_handle = NULL;
2003 systab.con_out = NULL;
2004 systab.stderr_handle = NULL;
2005 systab.std_err = NULL;
2006 systab.boottime = NULL;
2007
2008 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02002009 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01002010
Alexander Grafbee91162016-03-04 01:09:59 +01002011 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002012 efi_set_watchdog(0);
Alexander Grafbee91162016-03-04 01:09:59 +01002013 WATCHDOG_RESET();
Heinrich Schuchardt98967372019-06-11 20:05:40 +02002014out:
2015 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002016}
2017
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002018/**
Mario Six78a88f72018-07-10 08:40:17 +02002019 * efi_get_next_monotonic_count() - get next value of the counter
2020 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002021 *
2022 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002023 *
Mario Six78a88f72018-07-10 08:40:17 +02002024 * See the Unified Extensible Firmware Interface (UEFI) specification for
2025 * details.
2026 *
2027 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002028 */
Alexander Grafbee91162016-03-04 01:09:59 +01002029static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
2030{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002031 static uint64_t mono;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002032 efi_status_t ret;
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002033
Alexander Grafbee91162016-03-04 01:09:59 +01002034 EFI_ENTRY("%p", count);
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002035 if (!count) {
2036 ret = EFI_INVALID_PARAMETER;
2037 goto out;
2038 }
Alexander Grafbee91162016-03-04 01:09:59 +01002039 *count = mono++;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002040 ret = EFI_SUCCESS;
2041out:
2042 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002043}
2044
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002045/**
Mario Six78a88f72018-07-10 08:40:17 +02002046 * efi_stall() - sleep
2047 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002048 *
Mario Six78a88f72018-07-10 08:40:17 +02002049 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002050 *
Mario Six78a88f72018-07-10 08:40:17 +02002051 * See the Unified Extensible Firmware Interface (UEFI) specification for
2052 * details.
2053 *
2054 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002055 */
Alexander Grafbee91162016-03-04 01:09:59 +01002056static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
2057{
Heinrich Schuchardt22f23db2019-06-02 21:12:17 +02002058 u64 end_tick;
2059
Alexander Grafbee91162016-03-04 01:09:59 +01002060 EFI_ENTRY("%ld", microseconds);
Heinrich Schuchardt22f23db2019-06-02 21:12:17 +02002061
2062 end_tick = get_ticks() + usec_to_tick(microseconds);
2063 while (get_ticks() < end_tick)
2064 efi_timer_check();
2065
Alexander Grafbee91162016-03-04 01:09:59 +01002066 return EFI_EXIT(EFI_SUCCESS);
2067}
2068
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002069/**
Mario Six78a88f72018-07-10 08:40:17 +02002070 * efi_set_watchdog_timer() - reset the watchdog timer
2071 * @timeout: seconds before reset by watchdog
2072 * @watchdog_code: code to be logged when resetting
2073 * @data_size: size of buffer in bytes
2074 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002075 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002076 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002077 *
Mario Six78a88f72018-07-10 08:40:17 +02002078 * See the Unified Extensible Firmware Interface (UEFI) specification for
2079 * details.
2080 *
2081 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002082 */
Alexander Grafbee91162016-03-04 01:09:59 +01002083static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2084 uint64_t watchdog_code,
2085 unsigned long data_size,
2086 uint16_t *watchdog_data)
2087{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09002088 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01002089 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002090 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01002091}
2092
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002093/**
Mario Six78a88f72018-07-10 08:40:17 +02002094 * efi_close_protocol() - close a protocol
2095 * @handle: handle on which the protocol shall be closed
2096 * @protocol: GUID of the protocol to close
2097 * @agent_handle: handle of the driver
2098 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002099 *
2100 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002101 *
Mario Six78a88f72018-07-10 08:40:17 +02002102 * See the Unified Extensible Firmware Interface (UEFI) specification for
2103 * details.
2104 *
2105 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002106 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002107static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002108 const efi_guid_t *protocol,
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002109 efi_handle_t agent_handle,
2110 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01002111{
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002112 struct efi_handler *handler;
2113 struct efi_open_protocol_info_item *item;
2114 struct efi_open_protocol_info_item *pos;
2115 efi_status_t r;
2116
Rob Clark778e6af2017-09-13 18:05:41 -04002117 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01002118 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002119
Heinrich Schuchardtec163fa2019-05-05 10:37:51 +02002120 if (!efi_search_obj(agent_handle) ||
2121 (controller_handle && !efi_search_obj(controller_handle))) {
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002122 r = EFI_INVALID_PARAMETER;
2123 goto out;
2124 }
2125 r = efi_search_protocol(handle, protocol, &handler);
2126 if (r != EFI_SUCCESS)
2127 goto out;
2128
2129 r = EFI_NOT_FOUND;
2130 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2131 if (item->info.agent_handle == agent_handle &&
2132 item->info.controller_handle == controller_handle) {
2133 efi_delete_open_info(item);
2134 r = EFI_SUCCESS;
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002135 }
2136 }
2137out:
2138 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002139}
2140
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002141/**
Mario Six78a88f72018-07-10 08:40:17 +02002142 * efi_open_protocol_information() - provide information about then open status
2143 * of a protocol on a handle
2144 * @handle: handle for which the information shall be retrieved
2145 * @protocol: GUID of the protocol
2146 * @entry_buffer: buffer to receive the open protocol information
2147 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002148 *
2149 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002150 *
Mario Six78a88f72018-07-10 08:40:17 +02002151 * See the Unified Extensible Firmware Interface (UEFI) specification for
2152 * details.
2153 *
2154 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002155 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002156static efi_status_t EFIAPI efi_open_protocol_information(
2157 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002158 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002159 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002160{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002161 unsigned long buffer_size;
2162 unsigned long count;
2163 struct efi_handler *handler;
2164 struct efi_open_protocol_info_item *item;
2165 efi_status_t r;
2166
Rob Clark778e6af2017-09-13 18:05:41 -04002167 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01002168 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002169
2170 /* Check parameters */
2171 if (!entry_buffer) {
2172 r = EFI_INVALID_PARAMETER;
2173 goto out;
2174 }
2175 r = efi_search_protocol(handle, protocol, &handler);
2176 if (r != EFI_SUCCESS)
2177 goto out;
2178
2179 /* Count entries */
2180 count = 0;
2181 list_for_each_entry(item, &handler->open_infos, link) {
2182 if (item->info.open_count)
2183 ++count;
2184 }
2185 *entry_count = count;
2186 *entry_buffer = NULL;
2187 if (!count) {
2188 r = EFI_SUCCESS;
2189 goto out;
2190 }
2191
2192 /* Copy entries */
2193 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002194 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002195 (void **)entry_buffer);
2196 if (r != EFI_SUCCESS)
2197 goto out;
2198 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2199 if (item->info.open_count)
2200 (*entry_buffer)[--count] = item->info;
2201 }
2202out:
2203 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002204}
2205
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002206/**
Mario Six78a88f72018-07-10 08:40:17 +02002207 * efi_protocols_per_handle() - get protocols installed on a handle
2208 * @handle: handle for which the information is retrieved
2209 * @protocol_buffer: buffer with protocol GUIDs
2210 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002211 *
2212 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002213 *
Mario Six78a88f72018-07-10 08:40:17 +02002214 * See the Unified Extensible Firmware Interface (UEFI) specification for
2215 * details.
2216 *
2217 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002218 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002219static efi_status_t EFIAPI efi_protocols_per_handle(
2220 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002221 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002222{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002223 unsigned long buffer_size;
2224 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002225 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002226 efi_status_t r;
2227
Alexander Grafbee91162016-03-04 01:09:59 +01002228 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2229 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002230
2231 if (!handle || !protocol_buffer || !protocol_buffer_count)
2232 return EFI_EXIT(EFI_INVALID_PARAMETER);
2233
2234 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002235 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002236
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002237 efiobj = efi_search_obj(handle);
2238 if (!efiobj)
2239 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002240
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002241 /* Count protocols */
2242 list_for_each(protocol_handle, &efiobj->protocols) {
2243 ++*protocol_buffer_count;
2244 }
2245
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002246 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002247 if (*protocol_buffer_count) {
2248 size_t j = 0;
2249
2250 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002251 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002252 (void **)protocol_buffer);
2253 if (r != EFI_SUCCESS)
2254 return EFI_EXIT(r);
2255 list_for_each(protocol_handle, &efiobj->protocols) {
2256 struct efi_handler *protocol;
2257
2258 protocol = list_entry(protocol_handle,
2259 struct efi_handler, link);
2260 (*protocol_buffer)[j] = (void *)protocol->guid;
2261 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002262 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002263 }
2264
2265 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002266}
2267
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002268/**
Mario Six78a88f72018-07-10 08:40:17 +02002269 * efi_locate_handle_buffer() - locate handles implementing a protocol
2270 * @search_type: selection criterion
2271 * @protocol: GUID of the protocol
2272 * @search_key: registration key
2273 * @no_handles: number of returned handles
2274 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002275 *
2276 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002277 *
Mario Six78a88f72018-07-10 08:40:17 +02002278 * See the Unified Extensible Firmware Interface (UEFI) specification for
2279 * details.
2280 *
2281 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002282 */
Alexander Grafbee91162016-03-04 01:09:59 +01002283static efi_status_t EFIAPI efi_locate_handle_buffer(
2284 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002285 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002286 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002287{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002288 efi_status_t r;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002289 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002290
Rob Clark778e6af2017-09-13 18:05:41 -04002291 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002292 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002293
2294 if (!no_handles || !buffer) {
2295 r = EFI_INVALID_PARAMETER;
2296 goto out;
2297 }
2298 *no_handles = 0;
2299 *buffer = NULL;
2300 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2301 *buffer);
2302 if (r != EFI_BUFFER_TOO_SMALL)
2303 goto out;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002304 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002305 (void **)buffer);
2306 if (r != EFI_SUCCESS)
2307 goto out;
2308 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2309 *buffer);
2310 if (r == EFI_SUCCESS)
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002311 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002312out:
2313 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002314}
2315
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002316/**
Mario Six78a88f72018-07-10 08:40:17 +02002317 * efi_locate_protocol() - find an interface implementing a protocol
2318 * @protocol: GUID of the protocol
2319 * @registration: registration key passed to the notification function
2320 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002321 *
2322 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002323 *
Mario Six78a88f72018-07-10 08:40:17 +02002324 * See the Unified Extensible Firmware Interface (UEFI) specification for
2325 * details.
2326 *
2327 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002328 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002329static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002330 void *registration,
2331 void **protocol_interface)
2332{
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002333 struct efi_handler *handler;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002334 efi_status_t ret;
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002335 struct efi_object *efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01002336
Rob Clark778e6af2017-09-13 18:05:41 -04002337 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002338
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002339 /*
2340 * The UEFI spec explicitly requires a protocol even if a registration
2341 * key is provided. This differs from the logic in LocateHandle().
2342 */
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002343 if (!protocol || !protocol_interface)
2344 return EFI_EXIT(EFI_INVALID_PARAMETER);
2345
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002346 if (registration) {
2347 struct efi_register_notify_event *event;
2348 struct efi_protocol_notification *handle;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002349
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002350 event = efi_check_register_notify_event(registration);
2351 if (!event)
2352 return EFI_EXIT(EFI_INVALID_PARAMETER);
2353 /*
2354 * The UEFI spec requires to return EFI_NOT_FOUND if no
2355 * protocol instance matches protocol and registration.
2356 * So let's do the same for a mismatch between protocol and
2357 * registration.
2358 */
2359 if (guidcmp(&event->protocol, protocol))
2360 goto not_found;
2361 if (list_empty(&event->handles))
2362 goto not_found;
2363 handle = list_first_entry(&event->handles,
2364 struct efi_protocol_notification,
2365 link);
2366 efiobj = handle->handle;
2367 list_del(&handle->link);
2368 free(handle);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002369 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002370 if (ret == EFI_SUCCESS)
2371 goto found;
2372 } else {
2373 list_for_each_entry(efiobj, &efi_obj_list, link) {
2374 ret = efi_search_protocol(efiobj, protocol, &handler);
2375 if (ret == EFI_SUCCESS)
2376 goto found;
Alexander Grafbee91162016-03-04 01:09:59 +01002377 }
2378 }
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002379not_found:
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002380 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002381 return EFI_EXIT(EFI_NOT_FOUND);
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002382found:
2383 *protocol_interface = handler->protocol_interface;
2384 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002385}
2386
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002387/**
Mario Six78a88f72018-07-10 08:40:17 +02002388 * efi_locate_device_path() - Get the device path and handle of an device
2389 * implementing a protocol
2390 * @protocol: GUID of the protocol
2391 * @device_path: device path
2392 * @device: handle of the device
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002393 *
2394 * This function implements the LocateDevicePath service.
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002395 *
Mario Six78a88f72018-07-10 08:40:17 +02002396 * See the Unified Extensible Firmware Interface (UEFI) specification for
2397 * details.
2398 *
2399 * Return: status code
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002400 */
2401static efi_status_t EFIAPI efi_locate_device_path(
2402 const efi_guid_t *protocol,
2403 struct efi_device_path **device_path,
2404 efi_handle_t *device)
2405{
2406 struct efi_device_path *dp;
2407 size_t i;
2408 struct efi_handler *handler;
2409 efi_handle_t *handles;
2410 size_t len, len_dp;
2411 size_t len_best = 0;
2412 efi_uintn_t no_handles;
2413 u8 *remainder;
2414 efi_status_t ret;
2415
2416 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2417
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002418 if (!protocol || !device_path || !*device_path) {
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002419 ret = EFI_INVALID_PARAMETER;
2420 goto out;
2421 }
2422
2423 /* Find end of device path */
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002424 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002425
2426 /* Get all handles implementing the protocol */
2427 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2428 &no_handles, &handles));
2429 if (ret != EFI_SUCCESS)
2430 goto out;
2431
2432 for (i = 0; i < no_handles; ++i) {
2433 /* Find the device path protocol */
2434 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2435 &handler);
2436 if (ret != EFI_SUCCESS)
2437 continue;
2438 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002439 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002440 /*
2441 * This handle can only be a better fit
2442 * if its device path length is longer than the best fit and
2443 * if its device path length is shorter of equal the searched
2444 * device path.
2445 */
2446 if (len_dp <= len_best || len_dp > len)
2447 continue;
2448 /* Check if dp is a subpath of device_path */
2449 if (memcmp(*device_path, dp, len_dp))
2450 continue;
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002451 if (!device) {
2452 ret = EFI_INVALID_PARAMETER;
2453 goto out;
2454 }
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002455 *device = handles[i];
2456 len_best = len_dp;
2457 }
2458 if (len_best) {
2459 remainder = (u8 *)*device_path + len_best;
2460 *device_path = (struct efi_device_path *)remainder;
2461 ret = EFI_SUCCESS;
2462 } else {
2463 ret = EFI_NOT_FOUND;
2464 }
2465out:
2466 return EFI_EXIT(ret);
2467}
2468
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002469/**
Mario Six78a88f72018-07-10 08:40:17 +02002470 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2471 * interfaces
2472 * @handle: handle on which the protocol interfaces shall be installed
2473 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2474 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002475 *
2476 * This function implements the MultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002477 *
Mario Six78a88f72018-07-10 08:40:17 +02002478 * See the Unified Extensible Firmware Interface (UEFI) specification for
2479 * details.
2480 *
2481 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002482 */
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +02002483efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002484 (efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002485{
2486 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002487
Alexander Grafbeb077a2018-06-18 17:23:05 +02002488 efi_va_list argptr;
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002489 const efi_guid_t *protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002490 void *protocol_interface;
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002491 efi_handle_t old_handle;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002492 efi_status_t r = EFI_SUCCESS;
2493 int i = 0;
2494
2495 if (!handle)
2496 return EFI_EXIT(EFI_INVALID_PARAMETER);
2497
Alexander Grafbeb077a2018-06-18 17:23:05 +02002498 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002499 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002500 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002501 if (!protocol)
2502 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002503 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002504 /* Check that a device path has not been installed before */
2505 if (!guidcmp(protocol, &efi_guid_device_path)) {
2506 struct efi_device_path *dp = protocol_interface;
2507
2508 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2509 &old_handle));
Heinrich Schuchardt20562892019-05-20 19:55:18 +00002510 if (r == EFI_SUCCESS &&
2511 dp->type == DEVICE_PATH_TYPE_END) {
2512 EFI_PRINT("Path %pD already installed\n",
2513 protocol_interface);
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002514 r = EFI_ALREADY_STARTED;
2515 break;
2516 }
2517 }
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01002518 r = EFI_CALL(efi_install_protocol_interface(
2519 handle, protocol,
2520 EFI_NATIVE_INTERFACE,
2521 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002522 if (r != EFI_SUCCESS)
2523 break;
2524 i++;
2525 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002526 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002527 if (r == EFI_SUCCESS)
2528 return EFI_EXIT(r);
2529
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002530 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002531 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002532 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002533 protocol = efi_va_arg(argptr, efi_guid_t*);
2534 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002535 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01002536 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002537 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002538 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002539
2540 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002541}
2542
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002543/**
Mario Six78a88f72018-07-10 08:40:17 +02002544 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2545 * interfaces
2546 * @handle: handle from which the protocol interfaces shall be removed
2547 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2548 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002549 *
2550 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002551 *
Mario Six78a88f72018-07-10 08:40:17 +02002552 * See the Unified Extensible Firmware Interface (UEFI) specification for
2553 * details.
2554 *
2555 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002556 */
Alexander Grafbee91162016-03-04 01:09:59 +01002557static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002558 efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002559{
2560 EFI_ENTRY("%p", handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002561
Alexander Grafbeb077a2018-06-18 17:23:05 +02002562 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002563 const efi_guid_t *protocol;
2564 void *protocol_interface;
2565 efi_status_t r = EFI_SUCCESS;
2566 size_t i = 0;
2567
2568 if (!handle)
2569 return EFI_EXIT(EFI_INVALID_PARAMETER);
2570
Alexander Grafbeb077a2018-06-18 17:23:05 +02002571 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002572 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002573 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002574 if (!protocol)
2575 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002576 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002577 r = efi_uninstall_protocol(handle, protocol,
2578 protocol_interface);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002579 if (r != EFI_SUCCESS)
2580 break;
2581 i++;
2582 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002583 efi_va_end(argptr);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002584 if (r == EFI_SUCCESS) {
2585 /* If the last protocol has been removed, delete the handle. */
2586 if (list_empty(&handle->protocols)) {
2587 list_del(&handle->link);
2588 free(handle);
2589 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002590 return EFI_EXIT(r);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002591 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002592
2593 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002594 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002595 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002596 protocol = efi_va_arg(argptr, efi_guid_t*);
2597 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002598 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2599 EFI_NATIVE_INTERFACE,
2600 protocol_interface));
2601 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002602 efi_va_end(argptr);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002603
Heinrich Schuchardte2373022018-09-24 19:57:27 +02002604 /* In case of an error always return EFI_INVALID_PARAMETER */
2605 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafbee91162016-03-04 01:09:59 +01002606}
2607
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002608/**
Mario Six78a88f72018-07-10 08:40:17 +02002609 * efi_calculate_crc32() - calculate cyclic redundancy code
2610 * @data: buffer with data
2611 * @data_size: size of buffer in bytes
2612 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002613 *
2614 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002615 *
Mario Six78a88f72018-07-10 08:40:17 +02002616 * See the Unified Extensible Firmware Interface (UEFI) specification for
2617 * details.
2618 *
2619 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002620 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002621static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2622 efi_uintn_t data_size,
2623 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002624{
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002625 efi_status_t ret = EFI_SUCCESS;
2626
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002627 EFI_ENTRY("%p, %zu", data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002628 if (!data || !data_size || !crc32_p) {
2629 ret = EFI_INVALID_PARAMETER;
2630 goto out;
2631 }
Alexander Grafbee91162016-03-04 01:09:59 +01002632 *crc32_p = crc32(0, data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002633out:
2634 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002635}
2636
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002637/**
Mario Six78a88f72018-07-10 08:40:17 +02002638 * efi_copy_mem() - copy memory
2639 * @destination: destination of the copy operation
2640 * @source: source of the copy operation
2641 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002642 *
2643 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002644 *
Mario Six78a88f72018-07-10 08:40:17 +02002645 * See the Unified Extensible Firmware Interface (UEFI) specification for
2646 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002647 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002648static void EFIAPI efi_copy_mem(void *destination, const void *source,
2649 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002650{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002651 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002652 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002653 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002654}
2655
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002656/**
Mario Six78a88f72018-07-10 08:40:17 +02002657 * efi_set_mem() - Fill memory with a byte value.
2658 * @buffer: buffer to fill
2659 * @size: size of buffer in bytes
2660 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002661 *
2662 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002663 *
Mario Six78a88f72018-07-10 08:40:17 +02002664 * See the Unified Extensible Firmware Interface (UEFI) specification for
2665 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002666 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002667static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002668{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002669 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002670 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002671 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002672}
2673
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002674/**
Mario Six78a88f72018-07-10 08:40:17 +02002675 * efi_protocol_open() - open protocol interface on a handle
2676 * @handler: handler of a protocol
2677 * @protocol_interface: interface implementing the protocol
2678 * @agent_handle: handle of the driver
2679 * @controller_handle: handle of the controller
2680 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002681 *
Mario Six78a88f72018-07-10 08:40:17 +02002682 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002683 */
2684static efi_status_t efi_protocol_open(
2685 struct efi_handler *handler,
2686 void **protocol_interface, void *agent_handle,
2687 void *controller_handle, uint32_t attributes)
2688{
2689 struct efi_open_protocol_info_item *item;
2690 struct efi_open_protocol_info_entry *match = NULL;
2691 bool opened_by_driver = false;
2692 bool opened_exclusive = false;
2693
2694 /* If there is no agent, only return the interface */
2695 if (!agent_handle)
2696 goto out;
2697
2698 /* For TEST_PROTOCOL ignore interface attribute */
2699 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2700 *protocol_interface = NULL;
2701
2702 /*
2703 * Check if the protocol is already opened by a driver with the same
2704 * attributes or opened exclusively
2705 */
2706 list_for_each_entry(item, &handler->open_infos, link) {
2707 if (item->info.agent_handle == agent_handle) {
2708 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2709 (item->info.attributes == attributes))
2710 return EFI_ALREADY_STARTED;
Heinrich Schuchardt399a39e2019-05-30 14:16:31 +02002711 } else {
2712 if (item->info.attributes &
2713 EFI_OPEN_PROTOCOL_BY_DRIVER)
2714 opened_by_driver = true;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002715 }
2716 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2717 opened_exclusive = true;
2718 }
2719
2720 /* Only one controller can open the protocol exclusively */
Heinrich Schuchardt399a39e2019-05-30 14:16:31 +02002721 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2722 if (opened_exclusive)
2723 return EFI_ACCESS_DENIED;
2724 } else if (attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {
2725 if (opened_exclusive || opened_by_driver)
2726 return EFI_ACCESS_DENIED;
2727 }
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002728
2729 /* Prepare exclusive opening */
2730 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2731 /* Try to disconnect controllers */
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002732disconnect_next:
2733 opened_by_driver = false;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002734 list_for_each_entry(item, &handler->open_infos, link) {
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002735 efi_status_t ret;
2736
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002737 if (item->info.attributes ==
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002738 EFI_OPEN_PROTOCOL_BY_DRIVER) {
2739 ret = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002740 item->info.controller_handle,
2741 item->info.agent_handle,
2742 NULL));
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002743 if (ret == EFI_SUCCESS)
2744 /*
2745 * Child controllers may have been
2746 * removed from the open_infos list. So
2747 * let's restart the loop.
2748 */
2749 goto disconnect_next;
2750 else
2751 opened_by_driver = true;
2752 }
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002753 }
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002754 /* Only one driver can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002755 if (opened_by_driver)
2756 return EFI_ACCESS_DENIED;
2757 }
2758
2759 /* Find existing entry */
2760 list_for_each_entry(item, &handler->open_infos, link) {
2761 if (item->info.agent_handle == agent_handle &&
Heinrich Schuchardtb4863ba2019-06-01 20:15:10 +02002762 item->info.controller_handle == controller_handle &&
2763 item->info.attributes == attributes)
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002764 match = &item->info;
2765 }
2766 /* None found, create one */
2767 if (!match) {
2768 match = efi_create_open_info(handler);
2769 if (!match)
2770 return EFI_OUT_OF_RESOURCES;
2771 }
2772
2773 match->agent_handle = agent_handle;
2774 match->controller_handle = controller_handle;
2775 match->attributes = attributes;
2776 match->open_count++;
2777
2778out:
2779 /* For TEST_PROTOCOL ignore interface attribute. */
2780 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2781 *protocol_interface = handler->protocol_interface;
2782
2783 return EFI_SUCCESS;
2784}
2785
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002786/**
Mario Six78a88f72018-07-10 08:40:17 +02002787 * efi_open_protocol() - open protocol interface on a handle
2788 * @handle: handle on which the protocol shall be opened
2789 * @protocol: GUID of the protocol
2790 * @protocol_interface: interface implementing the protocol
2791 * @agent_handle: handle of the driver
2792 * @controller_handle: handle of the controller
2793 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002794 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002795 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002796 *
Mario Six78a88f72018-07-10 08:40:17 +02002797 * See the Unified Extensible Firmware Interface (UEFI) specification for
2798 * details.
2799 *
2800 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002801 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002802static efi_status_t EFIAPI efi_open_protocol
2803 (efi_handle_t handle, const efi_guid_t *protocol,
2804 void **protocol_interface, efi_handle_t agent_handle,
2805 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01002806{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002807 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002808 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01002809
Rob Clark778e6af2017-09-13 18:05:41 -04002810 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002811 protocol_interface, agent_handle, controller_handle,
2812 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002813
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002814 if (!handle || !protocol ||
2815 (!protocol_interface && attributes !=
2816 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2817 goto out;
2818 }
2819
2820 switch (attributes) {
2821 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2822 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2823 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2824 break;
2825 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2826 if (controller_handle == handle)
2827 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002828 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002829 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2830 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002831 /* Check that the controller handle is valid */
2832 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002833 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002834 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002835 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002836 /* Check that the agent handle is valid */
2837 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002838 goto out;
2839 break;
2840 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002841 goto out;
2842 }
2843
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002844 r = efi_search_protocol(handle, protocol, &handler);
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002845 switch (r) {
2846 case EFI_SUCCESS:
2847 break;
2848 case EFI_NOT_FOUND:
2849 r = EFI_UNSUPPORTED;
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002850 goto out;
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002851 default:
2852 goto out;
2853 }
Alexander Grafbee91162016-03-04 01:09:59 +01002854
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002855 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2856 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01002857out:
2858 return EFI_EXIT(r);
2859}
2860
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002861/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002862 * efi_start_image() - call the entry point of an image
2863 * @image_handle: handle of the image
2864 * @exit_data_size: size of the buffer
2865 * @exit_data: buffer to receive the exit data of the called image
2866 *
2867 * This function implements the StartImage service.
2868 *
2869 * See the Unified Extensible Firmware Interface (UEFI) specification for
2870 * details.
2871 *
2872 * Return: status code
2873 */
2874efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2875 efi_uintn_t *exit_data_size,
2876 u16 **exit_data)
2877{
2878 struct efi_loaded_image_obj *image_obj =
2879 (struct efi_loaded_image_obj *)image_handle;
2880 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002881 void *info;
2882 efi_handle_t parent_image = current_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002883
2884 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2885
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002886 /* Check parameters */
Heinrich Schuchardt1d3e8dc2019-06-11 19:35:20 +02002887 if (image_obj->header.type != EFI_OBJECT_TYPE_LOADED_IMAGE)
2888 return EFI_EXIT(EFI_INVALID_PARAMETER);
2889
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002890 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2891 &info, NULL, NULL,
2892 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2893 if (ret != EFI_SUCCESS)
2894 return EFI_EXIT(EFI_INVALID_PARAMETER);
2895
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002896 image_obj->exit_data_size = exit_data_size;
2897 image_obj->exit_data = exit_data;
2898
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002899 /* call the image! */
2900 if (setjmp(&image_obj->exit_jmp)) {
2901 /*
2902 * We called the entry point of the child image with EFI_CALL
2903 * in the lines below. The child image called the Exit() boot
2904 * service efi_exit() which executed the long jump that brought
2905 * us to the current line. This implies that the second half
2906 * of the EFI_CALL macro has not been executed.
2907 */
2908#ifdef CONFIG_ARM
2909 /*
2910 * efi_exit() called efi_restore_gd(). We have to undo this
2911 * otherwise __efi_entry_check() will put the wrong value into
2912 * app_gd.
2913 */
2914 gd = app_gd;
2915#endif
2916 /*
2917 * To get ready to call EFI_EXIT below we have to execute the
2918 * missed out steps of EFI_CALL.
2919 */
2920 assert(__efi_entry_check());
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02002921 EFI_PRINT("%lu returned by started image\n",
2922 (unsigned long)((uintptr_t)image_obj->exit_status &
2923 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002924 current_image = parent_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002925 return EFI_EXIT(image_obj->exit_status);
2926 }
2927
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002928 current_image = image_handle;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02002929 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09002930 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002931 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2932
2933 /*
2934 * Usually UEFI applications call Exit() instead of returning.
2935 * But because the world doesn't consist of ponies and unicorns,
2936 * we're happy to emulate that behavior on behalf of a payload
2937 * that forgot.
2938 */
2939 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2940}
2941
2942/**
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002943 * efi_delete_image() - delete loaded image from memory)
2944 *
2945 * @image_obj: handle of the loaded image
2946 * @loaded_image_protocol: loaded image protocol
2947 */
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02002948static efi_status_t efi_delete_image
2949 (struct efi_loaded_image_obj *image_obj,
2950 struct efi_loaded_image *loaded_image_protocol)
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002951{
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02002952 struct efi_object *efiobj;
2953 efi_status_t r, ret = EFI_SUCCESS;
2954
2955close_next:
2956 list_for_each_entry(efiobj, &efi_obj_list, link) {
2957 struct efi_handler *protocol;
2958
2959 list_for_each_entry(protocol, &efiobj->protocols, link) {
2960 struct efi_open_protocol_info_item *info;
2961
2962 list_for_each_entry(info, &protocol->open_infos, link) {
2963 if (info->info.agent_handle !=
2964 (efi_handle_t)image_obj)
2965 continue;
2966 r = EFI_CALL(efi_close_protocol
2967 (efiobj, protocol->guid,
2968 info->info.agent_handle,
2969 info->info.controller_handle
2970 ));
2971 if (r != EFI_SUCCESS)
2972 ret = r;
2973 /*
2974 * Closing protocols may results in further
2975 * items being deleted. To play it safe loop
2976 * over all elements again.
2977 */
2978 goto close_next;
2979 }
2980 }
2981 }
2982
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002983 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2984 efi_size_in_pages(loaded_image_protocol->image_size));
2985 efi_delete_handle(&image_obj->header);
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02002986
2987 return ret;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002988}
2989
2990/**
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002991 * efi_unload_image() - unload an EFI image
2992 * @image_handle: handle of the image to be unloaded
2993 *
2994 * This function implements the UnloadImage service.
2995 *
2996 * See the Unified Extensible Firmware Interface (UEFI) specification for
2997 * details.
2998 *
2999 * Return: status code
3000 */
3001efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
3002{
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003003 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003004 struct efi_object *efiobj;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003005 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003006
3007 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003008
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003009 efiobj = efi_search_obj(image_handle);
3010 if (!efiobj) {
3011 ret = EFI_INVALID_PARAMETER;
3012 goto out;
3013 }
3014 /* Find the loaded image protocol */
3015 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3016 (void **)&loaded_image_protocol,
3017 NULL, NULL,
3018 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3019 if (ret != EFI_SUCCESS) {
3020 ret = EFI_INVALID_PARAMETER;
3021 goto out;
3022 }
3023 switch (efiobj->type) {
3024 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3025 /* Call the unload function */
3026 if (!loaded_image_protocol->unload) {
3027 ret = EFI_UNSUPPORTED;
3028 goto out;
3029 }
3030 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
3031 if (ret != EFI_SUCCESS)
3032 goto out;
3033 break;
3034 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3035 break;
3036 default:
3037 ret = EFI_INVALID_PARAMETER;
3038 goto out;
3039 }
3040 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
3041 loaded_image_protocol);
3042out:
3043 return EFI_EXIT(ret);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003044}
3045
3046/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003047 * efi_update_exit_data() - fill exit data parameters of StartImage()
3048 *
Heinrich Schuchardt9ce91272019-07-14 11:25:06 +02003049 * @image_obj: image handle
3050 * @exit_data_size: size of the exit data buffer
3051 * @exit_data: buffer with data returned by UEFI payload
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003052 * Return: status code
3053 */
3054static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
3055 efi_uintn_t exit_data_size,
3056 u16 *exit_data)
3057{
3058 efi_status_t ret;
3059
3060 /*
3061 * If exit_data is not provided to StartImage(), exit_data_size must be
3062 * ignored.
3063 */
3064 if (!image_obj->exit_data)
3065 return EFI_SUCCESS;
3066 if (image_obj->exit_data_size)
3067 *image_obj->exit_data_size = exit_data_size;
3068 if (exit_data_size && exit_data) {
3069 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
3070 exit_data_size,
3071 (void **)image_obj->exit_data);
3072 if (ret != EFI_SUCCESS)
3073 return ret;
3074 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
3075 } else {
3076 image_obj->exit_data = NULL;
3077 }
3078 return EFI_SUCCESS;
3079}
3080
3081/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003082 * efi_exit() - leave an EFI application or driver
3083 * @image_handle: handle of the application or driver that is exiting
3084 * @exit_status: status code
3085 * @exit_data_size: size of the buffer in bytes
3086 * @exit_data: buffer with data describing an error
3087 *
3088 * This function implements the Exit service.
3089 *
3090 * See the Unified Extensible Firmware Interface (UEFI) specification for
3091 * details.
3092 *
3093 * Return: status code
3094 */
3095static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
3096 efi_status_t exit_status,
3097 efi_uintn_t exit_data_size,
3098 u16 *exit_data)
3099{
3100 /*
3101 * TODO: We should call the unload procedure of the loaded
3102 * image protocol.
3103 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003104 efi_status_t ret;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003105 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003106 struct efi_loaded_image_obj *image_obj =
3107 (struct efi_loaded_image_obj *)image_handle;
3108
3109 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
3110 exit_data_size, exit_data);
3111
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003112 /* Check parameters */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003113 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003114 (void **)&loaded_image_protocol,
3115 NULL, NULL,
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003116 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003117 if (ret != EFI_SUCCESS) {
3118 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003119 goto out;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003120 }
3121
3122 /* Unloading of unstarted images */
3123 switch (image_obj->header.type) {
3124 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3125 break;
3126 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3127 efi_delete_image(image_obj, loaded_image_protocol);
3128 ret = EFI_SUCCESS;
3129 goto out;
3130 default:
3131 /* Handle does not refer to loaded image */
3132 ret = EFI_INVALID_PARAMETER;
3133 goto out;
3134 }
3135 /* A started image can only be unloaded it is the last one started. */
3136 if (image_handle != current_image) {
3137 ret = EFI_INVALID_PARAMETER;
3138 goto out;
3139 }
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003140
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003141 /* Exit data is only foreseen in case of failure. */
3142 if (exit_status != EFI_SUCCESS) {
3143 ret = efi_update_exit_data(image_obj, exit_data_size,
3144 exit_data);
3145 /* Exiting has priority. Don't return error to caller. */
3146 if (ret != EFI_SUCCESS)
3147 EFI_PRINT("%s: out of memory\n", __func__);
3148 }
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003149 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
3150 exit_status != EFI_SUCCESS)
3151 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003152
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003153 /* Make sure entry/exit counts for EFI world cross-overs match */
3154 EFI_EXIT(exit_status);
3155
3156 /*
3157 * But longjmp out with the U-Boot gd, not the application's, as
3158 * the other end is a setjmp call inside EFI context.
3159 */
3160 efi_restore_gd();
3161
3162 image_obj->exit_status = exit_status;
3163 longjmp(&image_obj->exit_jmp, 1);
3164
3165 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003166out:
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003167 return EFI_EXIT(ret);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003168}
3169
3170/**
Mario Six78a88f72018-07-10 08:40:17 +02003171 * efi_handle_protocol() - get interface of a protocol on a handle
3172 * @handle: handle on which the protocol shall be opened
3173 * @protocol: GUID of the protocol
3174 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003175 *
3176 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003177 *
Mario Six78a88f72018-07-10 08:40:17 +02003178 * See the Unified Extensible Firmware Interface (UEFI) specification for
3179 * details.
3180 *
3181 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003182 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01003183static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02003184 const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01003185 void **protocol_interface)
3186{
Heinrich Schuchardt755d42d2019-06-01 19:29:39 +02003187 return efi_open_protocol(handle, protocol, protocol_interface, efi_root,
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02003188 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01003189}
3190
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003191/**
Mario Six78a88f72018-07-10 08:40:17 +02003192 * efi_bind_controller() - bind a single driver to a controller
3193 * @controller_handle: controller handle
3194 * @driver_image_handle: driver handle
3195 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003196 *
Mario Six78a88f72018-07-10 08:40:17 +02003197 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003198 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003199static efi_status_t efi_bind_controller(
3200 efi_handle_t controller_handle,
3201 efi_handle_t driver_image_handle,
3202 struct efi_device_path *remain_device_path)
3203{
3204 struct efi_driver_binding_protocol *binding_protocol;
3205 efi_status_t r;
3206
3207 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3208 &efi_guid_driver_binding_protocol,
3209 (void **)&binding_protocol,
3210 driver_image_handle, NULL,
3211 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3212 if (r != EFI_SUCCESS)
3213 return r;
3214 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3215 controller_handle,
3216 remain_device_path));
3217 if (r == EFI_SUCCESS)
3218 r = EFI_CALL(binding_protocol->start(binding_protocol,
3219 controller_handle,
3220 remain_device_path));
3221 EFI_CALL(efi_close_protocol(driver_image_handle,
3222 &efi_guid_driver_binding_protocol,
3223 driver_image_handle, NULL));
3224 return r;
3225}
3226
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003227/**
Mario Six78a88f72018-07-10 08:40:17 +02003228 * efi_connect_single_controller() - connect a single driver to a controller
3229 * @controller_handle: controller
3230 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003231 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003232 *
Mario Six78a88f72018-07-10 08:40:17 +02003233 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003234 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003235static efi_status_t efi_connect_single_controller(
3236 efi_handle_t controller_handle,
3237 efi_handle_t *driver_image_handle,
3238 struct efi_device_path *remain_device_path)
3239{
3240 efi_handle_t *buffer;
3241 size_t count;
3242 size_t i;
3243 efi_status_t r;
3244 size_t connected = 0;
3245
3246 /* Get buffer with all handles with driver binding protocol */
3247 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3248 &efi_guid_driver_binding_protocol,
3249 NULL, &count, &buffer));
3250 if (r != EFI_SUCCESS)
3251 return r;
3252
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02003253 /* Context Override */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003254 if (driver_image_handle) {
3255 for (; *driver_image_handle; ++driver_image_handle) {
3256 for (i = 0; i < count; ++i) {
3257 if (buffer[i] == *driver_image_handle) {
3258 buffer[i] = NULL;
3259 r = efi_bind_controller(
3260 controller_handle,
3261 *driver_image_handle,
3262 remain_device_path);
3263 /*
3264 * For drivers that do not support the
3265 * controller or are already connected
3266 * we receive an error code here.
3267 */
3268 if (r == EFI_SUCCESS)
3269 ++connected;
3270 }
3271 }
3272 }
3273 }
3274
3275 /*
3276 * TODO: Some overrides are not yet implemented:
3277 * - Platform Driver Override
3278 * - Driver Family Override Search
3279 * - Bus Specific Driver Override
3280 */
3281
3282 /* Driver Binding Search */
3283 for (i = 0; i < count; ++i) {
3284 if (buffer[i]) {
3285 r = efi_bind_controller(controller_handle,
3286 buffer[i],
3287 remain_device_path);
3288 if (r == EFI_SUCCESS)
3289 ++connected;
3290 }
3291 }
3292
3293 efi_free_pool(buffer);
3294 if (!connected)
3295 return EFI_NOT_FOUND;
3296 return EFI_SUCCESS;
3297}
3298
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003299/**
Mario Six78a88f72018-07-10 08:40:17 +02003300 * efi_connect_controller() - connect a controller to a driver
3301 * @controller_handle: handle of the controller
3302 * @driver_image_handle: handle of the driver
3303 * @remain_device_path: device path of a child controller
3304 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003305 *
3306 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02003307 *
3308 * See the Unified Extensible Firmware Interface (UEFI) specification for
3309 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003310 *
3311 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003312 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003313 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3314 *
Mario Six78a88f72018-07-10 08:40:17 +02003315 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003316 */
3317static efi_status_t EFIAPI efi_connect_controller(
3318 efi_handle_t controller_handle,
3319 efi_handle_t *driver_image_handle,
3320 struct efi_device_path *remain_device_path,
3321 bool recursive)
3322{
3323 efi_status_t r;
3324 efi_status_t ret = EFI_NOT_FOUND;
3325 struct efi_object *efiobj;
3326
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01003327 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003328 remain_device_path, recursive);
3329
3330 efiobj = efi_search_obj(controller_handle);
3331 if (!efiobj) {
3332 ret = EFI_INVALID_PARAMETER;
3333 goto out;
3334 }
3335
3336 r = efi_connect_single_controller(controller_handle,
3337 driver_image_handle,
3338 remain_device_path);
3339 if (r == EFI_SUCCESS)
3340 ret = EFI_SUCCESS;
3341 if (recursive) {
3342 struct efi_handler *handler;
3343 struct efi_open_protocol_info_item *item;
3344
3345 list_for_each_entry(handler, &efiobj->protocols, link) {
3346 list_for_each_entry(item, &handler->open_infos, link) {
3347 if (item->info.attributes &
3348 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3349 r = EFI_CALL(efi_connect_controller(
3350 item->info.controller_handle,
3351 driver_image_handle,
3352 remain_device_path,
3353 recursive));
3354 if (r == EFI_SUCCESS)
3355 ret = EFI_SUCCESS;
3356 }
3357 }
3358 }
3359 }
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02003360 /* Check for child controller specified by end node */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003361 if (ret != EFI_SUCCESS && remain_device_path &&
3362 remain_device_path->type == DEVICE_PATH_TYPE_END)
3363 ret = EFI_SUCCESS;
3364out:
3365 return EFI_EXIT(ret);
3366}
3367
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003368/**
Mario Six78a88f72018-07-10 08:40:17 +02003369 * efi_reinstall_protocol_interface() - reinstall protocol interface
3370 * @handle: handle on which the protocol shall be reinstalled
3371 * @protocol: GUID of the protocol to be installed
3372 * @old_interface: interface to be removed
3373 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003374 *
3375 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02003376 *
3377 * See the Unified Extensible Firmware Interface (UEFI) specification for
3378 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003379 *
3380 * The old interface is uninstalled. The new interface is installed.
3381 * Drivers are connected.
3382 *
Mario Six78a88f72018-07-10 08:40:17 +02003383 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003384 */
3385static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3386 efi_handle_t handle, const efi_guid_t *protocol,
3387 void *old_interface, void *new_interface)
3388{
3389 efi_status_t ret;
3390
3391 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3392 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003393
3394 /* Uninstall protocol but do not delete handle */
3395 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003396 if (ret != EFI_SUCCESS)
3397 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003398
3399 /* Install the new protocol */
3400 ret = efi_add_protocol(handle, protocol, new_interface);
3401 /*
3402 * The UEFI spec does not specify what should happen to the handle
3403 * if in case of an error no protocol interface remains on the handle.
3404 * So let's do nothing here.
3405 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003406 if (ret != EFI_SUCCESS)
3407 goto out;
3408 /*
3409 * The returned status code has to be ignored.
3410 * Do not create an error if no suitable driver for the handle exists.
3411 */
3412 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3413out:
3414 return EFI_EXIT(ret);
3415}
3416
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003417/**
Mario Six78a88f72018-07-10 08:40:17 +02003418 * efi_get_child_controllers() - get all child controllers associated to a driver
3419 * @efiobj: handle of the controller
3420 * @driver_handle: handle of the driver
3421 * @number_of_children: number of child controllers
3422 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003423 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003424 * The allocated buffer has to be freed with free().
3425 *
Mario Six78a88f72018-07-10 08:40:17 +02003426 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003427 */
3428static efi_status_t efi_get_child_controllers(
3429 struct efi_object *efiobj,
3430 efi_handle_t driver_handle,
3431 efi_uintn_t *number_of_children,
3432 efi_handle_t **child_handle_buffer)
3433{
3434 struct efi_handler *handler;
3435 struct efi_open_protocol_info_item *item;
3436 efi_uintn_t count = 0, i;
3437 bool duplicate;
3438
3439 /* Count all child controller associations */
3440 list_for_each_entry(handler, &efiobj->protocols, link) {
3441 list_for_each_entry(item, &handler->open_infos, link) {
3442 if (item->info.agent_handle == driver_handle &&
3443 item->info.attributes &
3444 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3445 ++count;
3446 }
3447 }
3448 /*
3449 * Create buffer. In case of duplicate child controller assignments
3450 * the buffer will be too large. But that does not harm.
3451 */
3452 *number_of_children = 0;
3453 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3454 if (!*child_handle_buffer)
3455 return EFI_OUT_OF_RESOURCES;
3456 /* Copy unique child handles */
3457 list_for_each_entry(handler, &efiobj->protocols, link) {
3458 list_for_each_entry(item, &handler->open_infos, link) {
3459 if (item->info.agent_handle == driver_handle &&
3460 item->info.attributes &
3461 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3462 /* Check this is a new child controller */
3463 duplicate = false;
3464 for (i = 0; i < *number_of_children; ++i) {
3465 if ((*child_handle_buffer)[i] ==
3466 item->info.controller_handle)
3467 duplicate = true;
3468 }
3469 /* Copy handle to buffer */
3470 if (!duplicate) {
3471 i = (*number_of_children)++;
3472 (*child_handle_buffer)[i] =
3473 item->info.controller_handle;
3474 }
3475 }
3476 }
3477 }
3478 return EFI_SUCCESS;
3479}
3480
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003481/**
Mario Six78a88f72018-07-10 08:40:17 +02003482 * efi_disconnect_controller() - disconnect a controller from a driver
3483 * @controller_handle: handle of the controller
3484 * @driver_image_handle: handle of the driver
3485 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003486 *
3487 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003488 *
Mario Six78a88f72018-07-10 08:40:17 +02003489 * See the Unified Extensible Firmware Interface (UEFI) specification for
3490 * details.
3491 *
3492 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003493 */
3494static efi_status_t EFIAPI efi_disconnect_controller(
3495 efi_handle_t controller_handle,
3496 efi_handle_t driver_image_handle,
3497 efi_handle_t child_handle)
3498{
3499 struct efi_driver_binding_protocol *binding_protocol;
3500 efi_handle_t *child_handle_buffer = NULL;
3501 size_t number_of_children = 0;
3502 efi_status_t r;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003503 struct efi_object *efiobj;
3504
3505 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3506 child_handle);
3507
3508 efiobj = efi_search_obj(controller_handle);
3509 if (!efiobj) {
3510 r = EFI_INVALID_PARAMETER;
3511 goto out;
3512 }
3513
3514 if (child_handle && !efi_search_obj(child_handle)) {
3515 r = EFI_INVALID_PARAMETER;
3516 goto out;
3517 }
3518
3519 /* If no driver handle is supplied, disconnect all drivers */
3520 if (!driver_image_handle) {
3521 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3522 goto out;
3523 }
3524
3525 /* Create list of child handles */
3526 if (child_handle) {
3527 number_of_children = 1;
3528 child_handle_buffer = &child_handle;
3529 } else {
3530 efi_get_child_controllers(efiobj,
3531 driver_image_handle,
3532 &number_of_children,
3533 &child_handle_buffer);
3534 }
3535
3536 /* Get the driver binding protocol */
3537 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3538 &efi_guid_driver_binding_protocol,
3539 (void **)&binding_protocol,
3540 driver_image_handle, NULL,
3541 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003542 if (r != EFI_SUCCESS) {
3543 r = EFI_INVALID_PARAMETER;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003544 goto out;
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003545 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003546 /* Remove the children */
3547 if (number_of_children) {
3548 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3549 controller_handle,
3550 number_of_children,
3551 child_handle_buffer));
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003552 if (r != EFI_SUCCESS) {
3553 r = EFI_DEVICE_ERROR;
3554 goto out;
3555 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003556 }
3557 /* Remove the driver */
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003558 if (!child_handle) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003559 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3560 controller_handle,
3561 0, NULL));
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003562 if (r != EFI_SUCCESS) {
3563 r = EFI_DEVICE_ERROR;
3564 goto out;
3565 }
3566 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003567 EFI_CALL(efi_close_protocol(driver_image_handle,
3568 &efi_guid_driver_binding_protocol,
3569 driver_image_handle, NULL));
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003570 r = EFI_SUCCESS;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003571out:
3572 if (!child_handle)
3573 free(child_handle_buffer);
3574 return EFI_EXIT(r);
3575}
3576
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003577static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003578 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003579 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3580 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003581 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003582 },
3583 .raise_tpl = efi_raise_tpl,
3584 .restore_tpl = efi_restore_tpl,
3585 .allocate_pages = efi_allocate_pages_ext,
3586 .free_pages = efi_free_pages_ext,
3587 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003588 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003589 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003590 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003591 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003592 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003593 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003594 .close_event = efi_close_event,
3595 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003596 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003597 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003598 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003599 .handle_protocol = efi_handle_protocol,
3600 .reserved = NULL,
3601 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003602 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003603 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003604 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003605 .load_image = efi_load_image,
3606 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003607 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003608 .unload_image = efi_unload_image,
3609 .exit_boot_services = efi_exit_boot_services,
3610 .get_next_monotonic_count = efi_get_next_monotonic_count,
3611 .stall = efi_stall,
3612 .set_watchdog_timer = efi_set_watchdog_timer,
3613 .connect_controller = efi_connect_controller,
3614 .disconnect_controller = efi_disconnect_controller,
3615 .open_protocol = efi_open_protocol,
3616 .close_protocol = efi_close_protocol,
3617 .open_protocol_information = efi_open_protocol_information,
3618 .protocols_per_handle = efi_protocols_per_handle,
3619 .locate_handle_buffer = efi_locate_handle_buffer,
3620 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003621 .install_multiple_protocol_interfaces =
3622 efi_install_multiple_protocol_interfaces,
3623 .uninstall_multiple_protocol_interfaces =
3624 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafbee91162016-03-04 01:09:59 +01003625 .calculate_crc32 = efi_calculate_crc32,
3626 .copy_mem = efi_copy_mem,
3627 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003628 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003629};
3630
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003631static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01003632
Alexander Graf3c63db92016-10-14 13:45:30 +02003633struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01003634 .hdr = {
3635 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003636 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003637 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01003638 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003639 .fw_vendor = firmware_vendor,
3640 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardt3c783bf2019-06-15 14:51:06 +02003641 .runtime = &efi_runtime_services,
Alexander Grafbee91162016-03-04 01:09:59 +01003642 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003643 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01003644};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003645
3646/**
3647 * efi_initialize_system_table() - Initialize system table
3648 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02003649 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003650 */
3651efi_status_t efi_initialize_system_table(void)
3652{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003653 efi_status_t ret;
3654
3655 /* Allocate configuration table array */
3656 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3657 EFI_MAX_CONFIGURATION_TABLES *
3658 sizeof(struct efi_configuration_table),
3659 (void **)&systab.tables);
3660
Heinrich Schuchardt93148eb2019-06-29 02:00:16 +02003661 /*
3662 * These entries will be set to NULL in ExitBootServices(). To avoid
3663 * relocation in SetVirtualAddressMap(), set them dynamically.
3664 */
3665 systab.con_in = &efi_con_in;
3666 systab.con_out = &efi_con_out;
3667 systab.std_err = &efi_con_out;
3668 systab.boottime = &efi_boot_services;
3669
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003670 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003671 efi_update_table_header_crc32(&systab.hdr);
3672 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3673 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003674
3675 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003676}