blob: ba4c1e5765bf002a6e54590405ce6e00623f2de9 [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>
Rob Clarkad644e72017-09-13 18:05:37 -040011#include <environment.h>
Alexander Grafbee91162016-03-04 01:09:59 +010012#include <malloc.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090013#include <linux/libfdt_env.h>
Alexander Grafbee91162016-03-04 01:09:59 +010014#include <u-boot/crc.h>
15#include <bootm.h>
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +020016#include <pe.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 Schuchardtb095f3c2018-02-18 15:17:52 +010028LIST_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
Alexander Graff31239a2018-11-15 21:23:47 +010042/*
43 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
44 * we need to do trickery with caches. Since we don't want to break the EFI
45 * aware boot path, only apply hacks when loading exiting directly (breaking
46 * direct Linux EFI booting along the way - oh well).
47 */
48static bool efi_is_direct_boot = true;
49
Simon Glass65e4c0b2016-09-25 15:27:35 -060050#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +010051/*
52 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
53 * fixed when compiling U-Boot. However, the payload does not know about that
54 * restriction so we need to manually swap its and our view of that register on
55 * EFI callback entry/exit.
56 */
57static volatile void *efi_gd, *app_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -060058#endif
Alexander Grafbee91162016-03-04 01:09:59 +010059
Heinrich Schuchardt914df752019-02-09 14:10:39 +010060/* 1 if inside U-Boot code, 0 if inside EFI payload code */
61static int entry_count = 1;
Rob Clarkaf65db82017-07-27 08:04:19 -040062static int nesting_level;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +010063/* GUID of the device tree table */
64const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +010065/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
66const efi_guid_t efi_guid_driver_binding_protocol =
67 EFI_DRIVER_BINDING_PROTOCOL_GUID;
Rob Clarkc160d2f2017-07-27 08:04:18 -040068
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010069/* event group ExitBootServices() invoked */
70const efi_guid_t efi_guid_event_group_exit_boot_services =
71 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
72/* event group SetVirtualAddressMap() invoked */
73const efi_guid_t efi_guid_event_group_virtual_address_change =
74 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
75/* event group memory map changed */
76const efi_guid_t efi_guid_event_group_memory_map_change =
77 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
78/* event group boot manager about to boot */
79const efi_guid_t efi_guid_event_group_ready_to_boot =
80 EFI_EVENT_GROUP_READY_TO_BOOT;
81/* event group ResetSystem() invoked (before ExitBootServices) */
82const efi_guid_t efi_guid_event_group_reset_system =
83 EFI_EVENT_GROUP_RESET_SYSTEM;
84
Heinrich Schuchardt2074f702018-01-11 08:16:09 +010085static efi_status_t EFIAPI efi_disconnect_controller(
86 efi_handle_t controller_handle,
87 efi_handle_t driver_image_handle,
88 efi_handle_t child_handle);
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +010089
Rob Clarkc160d2f2017-07-27 08:04:18 -040090/* Called on every callback entry */
91int __efi_entry_check(void)
92{
93 int ret = entry_count++ == 0;
94#ifdef CONFIG_ARM
95 assert(efi_gd);
96 app_gd = gd;
97 gd = efi_gd;
98#endif
99 return ret;
100}
101
102/* Called on every callback exit */
103int __efi_exit_check(void)
104{
105 int ret = --entry_count == 0;
106#ifdef CONFIG_ARM
107 gd = app_gd;
108#endif
109 return ret;
110}
111
Alexander Grafbee91162016-03-04 01:09:59 +0100112/* Called from do_bootefi_exec() */
113void efi_save_gd(void)
114{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600115#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100116 efi_gd = gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600117#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100118}
119
Rob Clarkc160d2f2017-07-27 08:04:18 -0400120/*
Mario Six78a88f72018-07-10 08:40:17 +0200121 * Special case handler for error/abort that just forces things back to u-boot
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200122 * world so we can dump out an abort message, without any care about returning
123 * back to UEFI world.
Rob Clarkc160d2f2017-07-27 08:04:18 -0400124 */
Alexander Grafbee91162016-03-04 01:09:59 +0100125void efi_restore_gd(void)
126{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600127#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100128 /* Only restore if we're already in EFI context */
129 if (!efi_gd)
130 return;
Alexander Grafbee91162016-03-04 01:09:59 +0100131 gd = efi_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600132#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100133}
134
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200135/**
Mario Six78a88f72018-07-10 08:40:17 +0200136 * indent_string() - returns a string for indenting with two spaces per level
137 * @level: indent level
Heinrich Schuchardtc8df80c2018-01-24 19:21:36 +0100138 *
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200139 * A maximum of ten indent levels is supported. Higher indent levels will be
140 * truncated.
141 *
Mario Six78a88f72018-07-10 08:40:17 +0200142 * Return: A string for indenting with two spaces per level is
143 * returned.
Rob Clarkaf65db82017-07-27 08:04:19 -0400144 */
145static const char *indent_string(int level)
146{
147 const char *indent = " ";
148 const int max = strlen(indent);
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +0100149
Rob Clarkaf65db82017-07-27 08:04:19 -0400150 level = min(max, level * 2);
151 return &indent[max - level];
152}
153
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200154const char *__efi_nesting(void)
155{
156 return indent_string(nesting_level);
157}
158
Rob Clarkaf65db82017-07-27 08:04:19 -0400159const char *__efi_nesting_inc(void)
160{
161 return indent_string(nesting_level++);
162}
163
164const char *__efi_nesting_dec(void)
165{
166 return indent_string(--nesting_level);
167}
168
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200169/**
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200170 * efi_event_is_queued() - check if an event is queued
171 *
172 * @event: event
173 * Return: true if event is queued
174 */
175static bool efi_event_is_queued(struct efi_event *event)
176{
177 return !!event->queue_link.next;
178}
179
180/**
181 * efi_process_event_queue() - process event queue
182 */
183static void efi_process_event_queue(void)
184{
185 while (!list_empty(&efi_event_queue)) {
186 struct efi_event *event;
187 efi_uintn_t old_tpl;
188
189 event = list_first_entry(&efi_event_queue, struct efi_event,
190 queue_link);
191 if (efi_tpl >= event->notify_tpl)
192 return;
193 list_del(&event->queue_link);
194 event->queue_link.next = NULL;
195 event->queue_link.prev = NULL;
196 /* Events must be executed at the event's TPL */
197 old_tpl = efi_tpl;
198 efi_tpl = event->notify_tpl;
199 EFI_CALL_VOID(event->notify_function(event,
200 event->notify_context));
201 efi_tpl = old_tpl;
202 if (event->type == EVT_NOTIFY_SIGNAL)
203 event->is_signaled = 0;
204 }
205}
206
207/**
Mario Six78a88f72018-07-10 08:40:17 +0200208 * efi_queue_event() - queue an EFI event
209 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200210 *
211 * This function queues the notification function of the event for future
212 * execution.
213 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200214 */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200215static void efi_queue_event(struct efi_event *event)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200216{
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200217 struct efi_event *item = NULL;
218
219 if (!event->notify_function)
220 return;
221
222 if (!efi_event_is_queued(event)) {
223 /*
224 * Events must be notified in order of decreasing task priority
225 * level. Insert the new event accordingly.
226 */
227 list_for_each_entry(item, &efi_event_queue, queue_link) {
228 if (item->notify_tpl < event->notify_tpl) {
229 list_add_tail(&event->queue_link,
230 &item->queue_link);
231 event = NULL;
232 break;
233 }
234 }
235 if (event)
236 list_add_tail(&event->queue_link, &efi_event_queue);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200237 }
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200238 efi_process_event_queue();
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200239}
240
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200241/**
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200242 * is_valid_tpl() - check if the task priority level is valid
243 *
244 * @tpl: TPL level to check
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200245 * Return: status code
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200246 */
247efi_status_t is_valid_tpl(efi_uintn_t tpl)
248{
249 switch (tpl) {
250 case TPL_APPLICATION:
251 case TPL_CALLBACK:
252 case TPL_NOTIFY:
253 case TPL_HIGH_LEVEL:
254 return EFI_SUCCESS;
255 default:
256 return EFI_INVALID_PARAMETER;
257 }
258}
259
260/**
Mario Six78a88f72018-07-10 08:40:17 +0200261 * efi_signal_event() - signal an EFI event
262 * @event: event to signal
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100263 *
Mario Six78a88f72018-07-10 08:40:17 +0200264 * This function signals an event. If the event belongs to an event group all
265 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100266 * their notification function is queued.
267 *
268 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100269 */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200270void efi_signal_event(struct efi_event *event)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100271{
Heinrich Schuchardtdfa306e2019-06-06 01:51:50 +0200272 if (event->is_signaled)
273 return;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100274 if (event->group) {
275 struct efi_event *evt;
276
277 /*
278 * The signaled state has to set before executing any
279 * notification function
280 */
281 list_for_each_entry(evt, &efi_events, link) {
282 if (!evt->group || guidcmp(evt->group, event->group))
283 continue;
284 if (evt->is_signaled)
285 continue;
286 evt->is_signaled = true;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100287 }
288 list_for_each_entry(evt, &efi_events, link) {
289 if (!evt->group || guidcmp(evt->group, event->group))
290 continue;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200291 efi_queue_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100292 }
Heinrich Schuchardt3626e532019-05-05 00:07:34 +0200293 } else {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100294 event->is_signaled = true;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200295 efi_queue_event(event);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100296 }
297}
298
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200299/**
Mario Six78a88f72018-07-10 08:40:17 +0200300 * efi_raise_tpl() - raise the task priority level
301 * @new_tpl: new value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200302 *
303 * This function implements the RaiseTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200304 *
Mario Six78a88f72018-07-10 08:40:17 +0200305 * See the Unified Extensible Firmware Interface (UEFI) specification for
306 * details.
307 *
308 * Return: old value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200309 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100310static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100311{
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100312 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200313
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200314 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200315
316 if (new_tpl < efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200317 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200318 efi_tpl = new_tpl;
319 if (efi_tpl > TPL_HIGH_LEVEL)
320 efi_tpl = TPL_HIGH_LEVEL;
321
322 EFI_EXIT(EFI_SUCCESS);
323 return old_tpl;
Alexander Grafbee91162016-03-04 01:09:59 +0100324}
325
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200326/**
Mario Six78a88f72018-07-10 08:40:17 +0200327 * efi_restore_tpl() - lower the task priority level
328 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200329 *
330 * This function implements the RestoreTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200331 *
Mario Six78a88f72018-07-10 08:40:17 +0200332 * See the Unified Extensible Firmware Interface (UEFI) specification for
333 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200334 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100335static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100336{
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200337 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200338
339 if (old_tpl > efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200340 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200341 efi_tpl = old_tpl;
342 if (efi_tpl > TPL_HIGH_LEVEL)
343 efi_tpl = TPL_HIGH_LEVEL;
344
Heinrich Schuchardt0f7fcc72018-03-24 18:40:21 +0100345 /*
346 * Lowering the TPL may have made queued events eligible for execution.
347 */
348 efi_timer_check();
349
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200350 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100351}
352
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200353/**
Mario Six78a88f72018-07-10 08:40:17 +0200354 * efi_allocate_pages_ext() - allocate memory pages
355 * @type: type of allocation to be performed
356 * @memory_type: usage type of the allocated memory
357 * @pages: number of pages to be allocated
358 * @memory: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200359 *
360 * This function implements the AllocatePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200361 *
Mario Six78a88f72018-07-10 08:40:17 +0200362 * See the Unified Extensible Firmware Interface (UEFI) specification for
363 * details.
364 *
365 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200366 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900367static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100368 efi_uintn_t pages,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900369 uint64_t *memory)
Alexander Grafbee91162016-03-04 01:09:59 +0100370{
371 efi_status_t r;
372
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100373 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafbee91162016-03-04 01:09:59 +0100374 r = efi_allocate_pages(type, memory_type, pages, memory);
375 return EFI_EXIT(r);
376}
377
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200378/**
Mario Six78a88f72018-07-10 08:40:17 +0200379 * efi_free_pages_ext() - Free memory pages.
380 * @memory: start of the memory area to be freed
381 * @pages: number of pages to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200382 *
383 * This function implements the FreePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200384 *
Mario Six78a88f72018-07-10 08:40:17 +0200385 * See the Unified Extensible Firmware Interface (UEFI) specification for
386 * details.
387 *
388 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200389 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900390static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100391 efi_uintn_t pages)
Alexander Grafbee91162016-03-04 01:09:59 +0100392{
393 efi_status_t r;
394
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900395 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafbee91162016-03-04 01:09:59 +0100396 r = efi_free_pages(memory, pages);
397 return EFI_EXIT(r);
398}
399
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200400/**
Mario Six78a88f72018-07-10 08:40:17 +0200401 * efi_get_memory_map_ext() - get map describing memory usage
402 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
403 * on exit the size of the copied memory map
404 * @memory_map: buffer to which the memory map is written
405 * @map_key: key for the memory map
406 * @descriptor_size: size of an individual memory descriptor
407 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200408 *
409 * This function implements the GetMemoryMap service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200410 *
Mario Six78a88f72018-07-10 08:40:17 +0200411 * See the Unified Extensible Firmware Interface (UEFI) specification for
412 * details.
413 *
414 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200415 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900416static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100417 efi_uintn_t *memory_map_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900418 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100419 efi_uintn_t *map_key,
420 efi_uintn_t *descriptor_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900421 uint32_t *descriptor_version)
Alexander Grafbee91162016-03-04 01:09:59 +0100422{
423 efi_status_t r;
424
425 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
426 map_key, descriptor_size, descriptor_version);
427 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
428 descriptor_size, descriptor_version);
429 return EFI_EXIT(r);
430}
431
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200432/**
Mario Six78a88f72018-07-10 08:40:17 +0200433 * efi_allocate_pool_ext() - allocate memory from pool
434 * @pool_type: type of the pool from which memory is to be allocated
435 * @size: number of bytes to be allocated
436 * @buffer: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200437 *
438 * This function implements the AllocatePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200439 *
Mario Six78a88f72018-07-10 08:40:17 +0200440 * See the Unified Extensible Firmware Interface (UEFI) specification for
441 * details.
442 *
443 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200444 */
Stefan Brünsead12742016-10-09 22:17:18 +0200445static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100446 efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200447 void **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100448{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100449 efi_status_t r;
450
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100451 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
Stefan Brünsead12742016-10-09 22:17:18 +0200452 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100453 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100454}
455
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200456/**
Mario Six78a88f72018-07-10 08:40:17 +0200457 * efi_free_pool_ext() - free memory from pool
458 * @buffer: start of memory to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200459 *
460 * This function implements the FreePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200461 *
Mario Six78a88f72018-07-10 08:40:17 +0200462 * See the Unified Extensible Firmware Interface (UEFI) specification for
463 * details.
464 *
465 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200466 */
Stefan Brüns42417bc2016-10-09 22:17:26 +0200467static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100468{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100469 efi_status_t r;
470
471 EFI_ENTRY("%p", buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200472 r = efi_free_pool(buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100473 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100474}
475
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200476/**
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200477 * efi_add_handle() - add a new handle to the object list
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100478 *
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200479 * @handle: handle to be added
480 *
481 * The protocols list is initialized. The handle is added to the list of known
482 * UEFI objects.
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100483 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200484void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100485{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200486 if (!handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100487 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200488 INIT_LIST_HEAD(&handle->protocols);
489 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100490}
491
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200492/**
Mario Six78a88f72018-07-10 08:40:17 +0200493 * efi_create_handle() - create handle
494 * @handle: new handle
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200495 *
Mario Six78a88f72018-07-10 08:40:17 +0200496 * Return: status code
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200497 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100498efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200499{
500 struct efi_object *obj;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200501
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200502 obj = calloc(1, sizeof(struct efi_object));
503 if (!obj)
504 return EFI_OUT_OF_RESOURCES;
505
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100506 efi_add_handle(obj);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200507 *handle = obj;
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200508
509 return EFI_SUCCESS;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200510}
511
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200512/**
Mario Six78a88f72018-07-10 08:40:17 +0200513 * efi_search_protocol() - find a protocol on a handle.
514 * @handle: handle
515 * @protocol_guid: GUID of the protocol
516 * @handler: reference to the protocol
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100517 *
Mario Six78a88f72018-07-10 08:40:17 +0200518 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100519 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100520efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100521 const efi_guid_t *protocol_guid,
522 struct efi_handler **handler)
523{
524 struct efi_object *efiobj;
525 struct list_head *lhandle;
526
527 if (!handle || !protocol_guid)
528 return EFI_INVALID_PARAMETER;
529 efiobj = efi_search_obj(handle);
530 if (!efiobj)
531 return EFI_INVALID_PARAMETER;
532 list_for_each(lhandle, &efiobj->protocols) {
533 struct efi_handler *protocol;
534
535 protocol = list_entry(lhandle, struct efi_handler, link);
536 if (!guidcmp(protocol->guid, protocol_guid)) {
537 if (handler)
538 *handler = protocol;
539 return EFI_SUCCESS;
540 }
541 }
542 return EFI_NOT_FOUND;
543}
544
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200545/**
Mario Six78a88f72018-07-10 08:40:17 +0200546 * efi_remove_protocol() - delete protocol from a handle
547 * @handle: handle from which the protocol shall be deleted
548 * @protocol: GUID of the protocol to be deleted
549 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100550 *
Mario Six78a88f72018-07-10 08:40:17 +0200551 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100552 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100553efi_status_t efi_remove_protocol(const efi_handle_t handle,
554 const efi_guid_t *protocol,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100555 void *protocol_interface)
556{
557 struct efi_handler *handler;
558 efi_status_t ret;
559
560 ret = efi_search_protocol(handle, protocol, &handler);
561 if (ret != EFI_SUCCESS)
562 return ret;
Heinrich Schuchardt1f470e12018-05-11 12:09:21 +0200563 if (handler->protocol_interface != protocol_interface)
Heinrich Schuchardt96aa99c2019-05-10 20:06:48 +0200564 return EFI_NOT_FOUND;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100565 list_del(&handler->link);
566 free(handler);
567 return EFI_SUCCESS;
568}
569
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200570/**
Mario Six78a88f72018-07-10 08:40:17 +0200571 * efi_remove_all_protocols() - delete all protocols from a handle
572 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100573 *
Mario Six78a88f72018-07-10 08:40:17 +0200574 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100575 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100576efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100577{
578 struct efi_object *efiobj;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100579 struct efi_handler *protocol;
580 struct efi_handler *pos;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100581
582 efiobj = efi_search_obj(handle);
583 if (!efiobj)
584 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100585 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100586 efi_status_t ret;
587
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100588 ret = efi_remove_protocol(handle, protocol->guid,
589 protocol->protocol_interface);
590 if (ret != EFI_SUCCESS)
591 return ret;
592 }
593 return EFI_SUCCESS;
594}
595
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200596/**
Mario Six78a88f72018-07-10 08:40:17 +0200597 * efi_delete_handle() - delete handle
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100598 *
Mario Six78a88f72018-07-10 08:40:17 +0200599 * @obj: handle to delete
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100600 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200601void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100602{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200603 if (!handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100604 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200605 efi_remove_all_protocols(handle);
606 list_del(&handle->link);
607 free(handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100608}
609
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200610/**
Mario Six78a88f72018-07-10 08:40:17 +0200611 * efi_is_event() - check if a pointer is a valid event
612 * @event: pointer to check
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100613 *
Mario Six78a88f72018-07-10 08:40:17 +0200614 * Return: status code
Alexander Grafbee91162016-03-04 01:09:59 +0100615 */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100616static efi_status_t efi_is_event(const struct efi_event *event)
617{
618 const struct efi_event *evt;
619
620 if (!event)
621 return EFI_INVALID_PARAMETER;
622 list_for_each_entry(evt, &efi_events, link) {
623 if (evt == event)
624 return EFI_SUCCESS;
625 }
626 return EFI_INVALID_PARAMETER;
627}
Alexander Grafbee91162016-03-04 01:09:59 +0100628
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200629/**
Mario Six78a88f72018-07-10 08:40:17 +0200630 * efi_create_event() - create an event
631 * @type: type of the event to create
632 * @notify_tpl: task priority level of the event
633 * @notify_function: notification function of the event
634 * @notify_context: pointer passed to the notification function
635 * @group: event group
636 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200637 *
638 * This function is used inside U-Boot code to create an event.
639 *
640 * For the API function implementing the CreateEvent service see
641 * efi_create_event_ext.
642 *
Mario Six78a88f72018-07-10 08:40:17 +0200643 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200644 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100645efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200646 void (EFIAPI *notify_function) (
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200647 struct efi_event *event,
648 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100649 void *notify_context, efi_guid_t *group,
650 struct efi_event **event)
Alexander Grafbee91162016-03-04 01:09:59 +0100651{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100652 struct efi_event *evt;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200653
Jonathan Graya95343b2017-03-12 19:26:07 +1100654 if (event == NULL)
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200655 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100656
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200657 switch (type) {
658 case 0:
659 case EVT_TIMER:
660 case EVT_NOTIFY_SIGNAL:
661 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
662 case EVT_NOTIFY_WAIT:
663 case EVT_TIMER | EVT_NOTIFY_WAIT:
664 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
665 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
666 break;
667 default:
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200668 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200669 }
Jonathan Graya95343b2017-03-12 19:26:07 +1100670
AKASHI Takahiro3748ed92018-08-10 15:36:32 +0900671 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardt751e9282019-04-25 07:30:41 +0200672 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200673 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100674
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100675 evt = calloc(1, sizeof(struct efi_event));
676 if (!evt)
677 return EFI_OUT_OF_RESOURCES;
678 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);
985 free(event);
986 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
1414 * @search_type: selection criterion
1415 * @protocol: GUID of the protocol
1416 * @search_key: registration key
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 Schuchardt16112f92019-02-06 19:41:29 +01001678 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1679 * 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{
1906#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1907 /*
1908 * Grub on 32bit ARM needs to have caches disabled before jumping into
1909 * a zImage, but does not know of all cache layers. Give it a hand.
1910 */
1911 if (efi_is_direct_boot)
1912 cleanup_before_linux();
1913#endif
1914}
1915
1916/**
Mario Six78a88f72018-07-10 08:40:17 +02001917 * efi_exit_boot_services() - stop all boot services
1918 * @image_handle: handle of the loaded image
1919 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001920 *
1921 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02001922 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001923 * See the Unified Extensible Firmware Interface (UEFI) specification
1924 * for details.
1925 *
Mario Six78a88f72018-07-10 08:40:17 +02001926 * All timer events are disabled. For exit boot services events the
1927 * notification function is called. The boot services are disabled in the
1928 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001929 *
Mario Six78a88f72018-07-10 08:40:17 +02001930 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001931 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001932static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001933 efi_uintn_t map_key)
Alexander Grafbee91162016-03-04 01:09:59 +01001934{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001935 struct efi_event *evt;
Heinrich Schuchardt98967372019-06-11 20:05:40 +02001936 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001937
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001938 EFI_ENTRY("%p, %zx", image_handle, map_key);
Alexander Grafbee91162016-03-04 01:09:59 +01001939
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001940 /* Check that the caller has read the current memory map */
Heinrich Schuchardt98967372019-06-11 20:05:40 +02001941 if (map_key != efi_memory_map_key) {
1942 ret = EFI_INVALID_PARAMETER;
1943 goto out;
1944 }
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001945
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001946 /* Check if ExitBootServices has already been called */
1947 if (!systab.boottime)
Heinrich Schuchardt98967372019-06-11 20:05:40 +02001948 goto out;
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001949
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001950 /* Stop all timer related activities */
1951 timers_enabled = false;
1952
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001953 /* Add related events to the event group */
1954 list_for_each_entry(evt, &efi_events, link) {
1955 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1956 evt->group = &efi_guid_event_group_exit_boot_services;
1957 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001958 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001959 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001960 if (evt->group &&
1961 !guidcmp(evt->group,
1962 &efi_guid_event_group_exit_boot_services)) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001963 efi_signal_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001964 break;
1965 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001966 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001967
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001968 /* Make sure that notification functions are not called anymore */
1969 efi_tpl = TPL_HIGH_LEVEL;
1970
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +02001971 /* Notify variable services */
1972 efi_variables_boot_exit_notify();
Rob Clarkad644e72017-09-13 18:05:37 -04001973
Alexander Grafb7b84102016-11-17 01:02:57 +01001974 board_quiesce_devices();
1975
Alexander Graff31239a2018-11-15 21:23:47 +01001976 /* Fix up caches for EFI payloads if necessary */
1977 efi_exit_caches();
1978
Alexander Grafbee91162016-03-04 01:09:59 +01001979 /* This stops all lingering devices */
1980 bootm_disable_interrupts();
1981
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001982 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001983 systab.con_in_handle = NULL;
1984 systab.con_in = NULL;
1985 systab.con_out_handle = NULL;
1986 systab.con_out = NULL;
1987 systab.stderr_handle = NULL;
1988 systab.std_err = NULL;
1989 systab.boottime = NULL;
1990
1991 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02001992 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001993
Alexander Grafbee91162016-03-04 01:09:59 +01001994 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001995 efi_set_watchdog(0);
Alexander Grafbee91162016-03-04 01:09:59 +01001996 WATCHDOG_RESET();
Heinrich Schuchardt98967372019-06-11 20:05:40 +02001997out:
1998 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001999}
2000
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002001/**
Mario Six78a88f72018-07-10 08:40:17 +02002002 * efi_get_next_monotonic_count() - get next value of the counter
2003 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002004 *
2005 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002006 *
Mario Six78a88f72018-07-10 08:40:17 +02002007 * See the Unified Extensible Firmware Interface (UEFI) specification for
2008 * details.
2009 *
2010 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002011 */
Alexander Grafbee91162016-03-04 01:09:59 +01002012static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
2013{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002014 static uint64_t mono;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002015 efi_status_t ret;
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002016
Alexander Grafbee91162016-03-04 01:09:59 +01002017 EFI_ENTRY("%p", count);
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002018 if (!count) {
2019 ret = EFI_INVALID_PARAMETER;
2020 goto out;
2021 }
Alexander Grafbee91162016-03-04 01:09:59 +01002022 *count = mono++;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002023 ret = EFI_SUCCESS;
2024out:
2025 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002026}
2027
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002028/**
Mario Six78a88f72018-07-10 08:40:17 +02002029 * efi_stall() - sleep
2030 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002031 *
Mario Six78a88f72018-07-10 08:40:17 +02002032 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002033 *
Mario Six78a88f72018-07-10 08:40:17 +02002034 * See the Unified Extensible Firmware Interface (UEFI) specification for
2035 * details.
2036 *
2037 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002038 */
Alexander Grafbee91162016-03-04 01:09:59 +01002039static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
2040{
Heinrich Schuchardt22f23db2019-06-02 21:12:17 +02002041 u64 end_tick;
2042
Alexander Grafbee91162016-03-04 01:09:59 +01002043 EFI_ENTRY("%ld", microseconds);
Heinrich Schuchardt22f23db2019-06-02 21:12:17 +02002044
2045 end_tick = get_ticks() + usec_to_tick(microseconds);
2046 while (get_ticks() < end_tick)
2047 efi_timer_check();
2048
Alexander Grafbee91162016-03-04 01:09:59 +01002049 return EFI_EXIT(EFI_SUCCESS);
2050}
2051
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002052/**
Mario Six78a88f72018-07-10 08:40:17 +02002053 * efi_set_watchdog_timer() - reset the watchdog timer
2054 * @timeout: seconds before reset by watchdog
2055 * @watchdog_code: code to be logged when resetting
2056 * @data_size: size of buffer in bytes
2057 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002058 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002059 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002060 *
Mario Six78a88f72018-07-10 08:40:17 +02002061 * See the Unified Extensible Firmware Interface (UEFI) specification for
2062 * details.
2063 *
2064 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002065 */
Alexander Grafbee91162016-03-04 01:09:59 +01002066static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2067 uint64_t watchdog_code,
2068 unsigned long data_size,
2069 uint16_t *watchdog_data)
2070{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09002071 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01002072 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002073 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01002074}
2075
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002076/**
Mario Six78a88f72018-07-10 08:40:17 +02002077 * efi_close_protocol() - close a protocol
2078 * @handle: handle on which the protocol shall be closed
2079 * @protocol: GUID of the protocol to close
2080 * @agent_handle: handle of the driver
2081 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002082 *
2083 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002084 *
Mario Six78a88f72018-07-10 08:40:17 +02002085 * See the Unified Extensible Firmware Interface (UEFI) specification for
2086 * details.
2087 *
2088 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002089 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002090static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002091 const efi_guid_t *protocol,
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002092 efi_handle_t agent_handle,
2093 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01002094{
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002095 struct efi_handler *handler;
2096 struct efi_open_protocol_info_item *item;
2097 struct efi_open_protocol_info_item *pos;
2098 efi_status_t r;
2099
Rob Clark778e6af2017-09-13 18:05:41 -04002100 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01002101 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002102
Heinrich Schuchardtec163fa2019-05-05 10:37:51 +02002103 if (!efi_search_obj(agent_handle) ||
2104 (controller_handle && !efi_search_obj(controller_handle))) {
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002105 r = EFI_INVALID_PARAMETER;
2106 goto out;
2107 }
2108 r = efi_search_protocol(handle, protocol, &handler);
2109 if (r != EFI_SUCCESS)
2110 goto out;
2111
2112 r = EFI_NOT_FOUND;
2113 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2114 if (item->info.agent_handle == agent_handle &&
2115 item->info.controller_handle == controller_handle) {
2116 efi_delete_open_info(item);
2117 r = EFI_SUCCESS;
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002118 }
2119 }
2120out:
2121 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002122}
2123
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002124/**
Mario Six78a88f72018-07-10 08:40:17 +02002125 * efi_open_protocol_information() - provide information about then open status
2126 * of a protocol on a handle
2127 * @handle: handle for which the information shall be retrieved
2128 * @protocol: GUID of the protocol
2129 * @entry_buffer: buffer to receive the open protocol information
2130 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002131 *
2132 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002133 *
Mario Six78a88f72018-07-10 08:40:17 +02002134 * See the Unified Extensible Firmware Interface (UEFI) specification for
2135 * details.
2136 *
2137 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002138 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002139static efi_status_t EFIAPI efi_open_protocol_information(
2140 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002141 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002142 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002143{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002144 unsigned long buffer_size;
2145 unsigned long count;
2146 struct efi_handler *handler;
2147 struct efi_open_protocol_info_item *item;
2148 efi_status_t r;
2149
Rob Clark778e6af2017-09-13 18:05:41 -04002150 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01002151 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002152
2153 /* Check parameters */
2154 if (!entry_buffer) {
2155 r = EFI_INVALID_PARAMETER;
2156 goto out;
2157 }
2158 r = efi_search_protocol(handle, protocol, &handler);
2159 if (r != EFI_SUCCESS)
2160 goto out;
2161
2162 /* Count entries */
2163 count = 0;
2164 list_for_each_entry(item, &handler->open_infos, link) {
2165 if (item->info.open_count)
2166 ++count;
2167 }
2168 *entry_count = count;
2169 *entry_buffer = NULL;
2170 if (!count) {
2171 r = EFI_SUCCESS;
2172 goto out;
2173 }
2174
2175 /* Copy entries */
2176 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002177 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002178 (void **)entry_buffer);
2179 if (r != EFI_SUCCESS)
2180 goto out;
2181 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2182 if (item->info.open_count)
2183 (*entry_buffer)[--count] = item->info;
2184 }
2185out:
2186 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002187}
2188
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002189/**
Mario Six78a88f72018-07-10 08:40:17 +02002190 * efi_protocols_per_handle() - get protocols installed on a handle
2191 * @handle: handle for which the information is retrieved
2192 * @protocol_buffer: buffer with protocol GUIDs
2193 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002194 *
2195 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002196 *
Mario Six78a88f72018-07-10 08:40:17 +02002197 * See the Unified Extensible Firmware Interface (UEFI) specification for
2198 * details.
2199 *
2200 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002201 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002202static efi_status_t EFIAPI efi_protocols_per_handle(
2203 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002204 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002205{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002206 unsigned long buffer_size;
2207 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002208 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002209 efi_status_t r;
2210
Alexander Grafbee91162016-03-04 01:09:59 +01002211 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2212 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002213
2214 if (!handle || !protocol_buffer || !protocol_buffer_count)
2215 return EFI_EXIT(EFI_INVALID_PARAMETER);
2216
2217 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002218 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002219
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002220 efiobj = efi_search_obj(handle);
2221 if (!efiobj)
2222 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002223
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002224 /* Count protocols */
2225 list_for_each(protocol_handle, &efiobj->protocols) {
2226 ++*protocol_buffer_count;
2227 }
2228
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002229 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002230 if (*protocol_buffer_count) {
2231 size_t j = 0;
2232
2233 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002234 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002235 (void **)protocol_buffer);
2236 if (r != EFI_SUCCESS)
2237 return EFI_EXIT(r);
2238 list_for_each(protocol_handle, &efiobj->protocols) {
2239 struct efi_handler *protocol;
2240
2241 protocol = list_entry(protocol_handle,
2242 struct efi_handler, link);
2243 (*protocol_buffer)[j] = (void *)protocol->guid;
2244 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002245 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002246 }
2247
2248 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002249}
2250
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002251/**
Mario Six78a88f72018-07-10 08:40:17 +02002252 * efi_locate_handle_buffer() - locate handles implementing a protocol
2253 * @search_type: selection criterion
2254 * @protocol: GUID of the protocol
2255 * @search_key: registration key
2256 * @no_handles: number of returned handles
2257 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002258 *
2259 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002260 *
Mario Six78a88f72018-07-10 08:40:17 +02002261 * See the Unified Extensible Firmware Interface (UEFI) specification for
2262 * details.
2263 *
2264 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002265 */
Alexander Grafbee91162016-03-04 01:09:59 +01002266static efi_status_t EFIAPI efi_locate_handle_buffer(
2267 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002268 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002269 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002270{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002271 efi_status_t r;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002272 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002273
Rob Clark778e6af2017-09-13 18:05:41 -04002274 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002275 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002276
2277 if (!no_handles || !buffer) {
2278 r = EFI_INVALID_PARAMETER;
2279 goto out;
2280 }
2281 *no_handles = 0;
2282 *buffer = NULL;
2283 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2284 *buffer);
2285 if (r != EFI_BUFFER_TOO_SMALL)
2286 goto out;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002287 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002288 (void **)buffer);
2289 if (r != EFI_SUCCESS)
2290 goto out;
2291 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2292 *buffer);
2293 if (r == EFI_SUCCESS)
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002294 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002295out:
2296 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002297}
2298
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002299/**
Mario Six78a88f72018-07-10 08:40:17 +02002300 * efi_locate_protocol() - find an interface implementing a protocol
2301 * @protocol: GUID of the protocol
2302 * @registration: registration key passed to the notification function
2303 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002304 *
2305 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002306 *
Mario Six78a88f72018-07-10 08:40:17 +02002307 * See the Unified Extensible Firmware Interface (UEFI) specification for
2308 * details.
2309 *
2310 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002311 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002312static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002313 void *registration,
2314 void **protocol_interface)
2315{
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002316 struct efi_handler *handler;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002317 efi_status_t ret;
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002318 struct efi_object *efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01002319
Rob Clark778e6af2017-09-13 18:05:41 -04002320 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002321
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002322 /*
2323 * The UEFI spec explicitly requires a protocol even if a registration
2324 * key is provided. This differs from the logic in LocateHandle().
2325 */
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002326 if (!protocol || !protocol_interface)
2327 return EFI_EXIT(EFI_INVALID_PARAMETER);
2328
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002329 if (registration) {
2330 struct efi_register_notify_event *event;
2331 struct efi_protocol_notification *handle;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002332
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002333 event = efi_check_register_notify_event(registration);
2334 if (!event)
2335 return EFI_EXIT(EFI_INVALID_PARAMETER);
2336 /*
2337 * The UEFI spec requires to return EFI_NOT_FOUND if no
2338 * protocol instance matches protocol and registration.
2339 * So let's do the same for a mismatch between protocol and
2340 * registration.
2341 */
2342 if (guidcmp(&event->protocol, protocol))
2343 goto not_found;
2344 if (list_empty(&event->handles))
2345 goto not_found;
2346 handle = list_first_entry(&event->handles,
2347 struct efi_protocol_notification,
2348 link);
2349 efiobj = handle->handle;
2350 list_del(&handle->link);
2351 free(handle);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002352 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002353 if (ret == EFI_SUCCESS)
2354 goto found;
2355 } else {
2356 list_for_each_entry(efiobj, &efi_obj_list, link) {
2357 ret = efi_search_protocol(efiobj, protocol, &handler);
2358 if (ret == EFI_SUCCESS)
2359 goto found;
Alexander Grafbee91162016-03-04 01:09:59 +01002360 }
2361 }
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002362not_found:
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002363 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002364 return EFI_EXIT(EFI_NOT_FOUND);
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002365found:
2366 *protocol_interface = handler->protocol_interface;
2367 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002368}
2369
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002370/**
Mario Six78a88f72018-07-10 08:40:17 +02002371 * efi_locate_device_path() - Get the device path and handle of an device
2372 * implementing a protocol
2373 * @protocol: GUID of the protocol
2374 * @device_path: device path
2375 * @device: handle of the device
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002376 *
2377 * This function implements the LocateDevicePath service.
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002378 *
Mario Six78a88f72018-07-10 08:40:17 +02002379 * See the Unified Extensible Firmware Interface (UEFI) specification for
2380 * details.
2381 *
2382 * Return: status code
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002383 */
2384static efi_status_t EFIAPI efi_locate_device_path(
2385 const efi_guid_t *protocol,
2386 struct efi_device_path **device_path,
2387 efi_handle_t *device)
2388{
2389 struct efi_device_path *dp;
2390 size_t i;
2391 struct efi_handler *handler;
2392 efi_handle_t *handles;
2393 size_t len, len_dp;
2394 size_t len_best = 0;
2395 efi_uintn_t no_handles;
2396 u8 *remainder;
2397 efi_status_t ret;
2398
2399 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2400
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002401 if (!protocol || !device_path || !*device_path) {
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002402 ret = EFI_INVALID_PARAMETER;
2403 goto out;
2404 }
2405
2406 /* Find end of device path */
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002407 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002408
2409 /* Get all handles implementing the protocol */
2410 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2411 &no_handles, &handles));
2412 if (ret != EFI_SUCCESS)
2413 goto out;
2414
2415 for (i = 0; i < no_handles; ++i) {
2416 /* Find the device path protocol */
2417 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2418 &handler);
2419 if (ret != EFI_SUCCESS)
2420 continue;
2421 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002422 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002423 /*
2424 * This handle can only be a better fit
2425 * if its device path length is longer than the best fit and
2426 * if its device path length is shorter of equal the searched
2427 * device path.
2428 */
2429 if (len_dp <= len_best || len_dp > len)
2430 continue;
2431 /* Check if dp is a subpath of device_path */
2432 if (memcmp(*device_path, dp, len_dp))
2433 continue;
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002434 if (!device) {
2435 ret = EFI_INVALID_PARAMETER;
2436 goto out;
2437 }
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002438 *device = handles[i];
2439 len_best = len_dp;
2440 }
2441 if (len_best) {
2442 remainder = (u8 *)*device_path + len_best;
2443 *device_path = (struct efi_device_path *)remainder;
2444 ret = EFI_SUCCESS;
2445 } else {
2446 ret = EFI_NOT_FOUND;
2447 }
2448out:
2449 return EFI_EXIT(ret);
2450}
2451
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002452/**
Mario Six78a88f72018-07-10 08:40:17 +02002453 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2454 * interfaces
2455 * @handle: handle on which the protocol interfaces shall be installed
2456 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2457 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002458 *
2459 * This function implements the MultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002460 *
Mario Six78a88f72018-07-10 08:40:17 +02002461 * See the Unified Extensible Firmware Interface (UEFI) specification for
2462 * details.
2463 *
2464 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002465 */
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +02002466efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002467 (efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002468{
2469 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002470
Alexander Grafbeb077a2018-06-18 17:23:05 +02002471 efi_va_list argptr;
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002472 const efi_guid_t *protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002473 void *protocol_interface;
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002474 efi_handle_t old_handle;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002475 efi_status_t r = EFI_SUCCESS;
2476 int i = 0;
2477
2478 if (!handle)
2479 return EFI_EXIT(EFI_INVALID_PARAMETER);
2480
Alexander Grafbeb077a2018-06-18 17:23:05 +02002481 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002482 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002483 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002484 if (!protocol)
2485 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002486 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002487 /* Check that a device path has not been installed before */
2488 if (!guidcmp(protocol, &efi_guid_device_path)) {
2489 struct efi_device_path *dp = protocol_interface;
2490
2491 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2492 &old_handle));
Heinrich Schuchardt20562892019-05-20 19:55:18 +00002493 if (r == EFI_SUCCESS &&
2494 dp->type == DEVICE_PATH_TYPE_END) {
2495 EFI_PRINT("Path %pD already installed\n",
2496 protocol_interface);
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002497 r = EFI_ALREADY_STARTED;
2498 break;
2499 }
2500 }
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01002501 r = EFI_CALL(efi_install_protocol_interface(
2502 handle, protocol,
2503 EFI_NATIVE_INTERFACE,
2504 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002505 if (r != EFI_SUCCESS)
2506 break;
2507 i++;
2508 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002509 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002510 if (r == EFI_SUCCESS)
2511 return EFI_EXIT(r);
2512
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002513 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002514 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002515 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002516 protocol = efi_va_arg(argptr, efi_guid_t*);
2517 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002518 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01002519 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002520 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002521 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002522
2523 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002524}
2525
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002526/**
Mario Six78a88f72018-07-10 08:40:17 +02002527 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2528 * interfaces
2529 * @handle: handle from which the protocol interfaces shall be removed
2530 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2531 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002532 *
2533 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002534 *
Mario Six78a88f72018-07-10 08:40:17 +02002535 * See the Unified Extensible Firmware Interface (UEFI) specification for
2536 * details.
2537 *
2538 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002539 */
Alexander Grafbee91162016-03-04 01:09:59 +01002540static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002541 efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002542{
2543 EFI_ENTRY("%p", handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002544
Alexander Grafbeb077a2018-06-18 17:23:05 +02002545 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002546 const efi_guid_t *protocol;
2547 void *protocol_interface;
2548 efi_status_t r = EFI_SUCCESS;
2549 size_t i = 0;
2550
2551 if (!handle)
2552 return EFI_EXIT(EFI_INVALID_PARAMETER);
2553
Alexander Grafbeb077a2018-06-18 17:23:05 +02002554 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002555 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002556 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002557 if (!protocol)
2558 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002559 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002560 r = efi_uninstall_protocol(handle, protocol,
2561 protocol_interface);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002562 if (r != EFI_SUCCESS)
2563 break;
2564 i++;
2565 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002566 efi_va_end(argptr);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002567 if (r == EFI_SUCCESS) {
2568 /* If the last protocol has been removed, delete the handle. */
2569 if (list_empty(&handle->protocols)) {
2570 list_del(&handle->link);
2571 free(handle);
2572 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002573 return EFI_EXIT(r);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002574 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002575
2576 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002577 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002578 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002579 protocol = efi_va_arg(argptr, efi_guid_t*);
2580 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002581 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2582 EFI_NATIVE_INTERFACE,
2583 protocol_interface));
2584 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002585 efi_va_end(argptr);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002586
Heinrich Schuchardte2373022018-09-24 19:57:27 +02002587 /* In case of an error always return EFI_INVALID_PARAMETER */
2588 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafbee91162016-03-04 01:09:59 +01002589}
2590
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002591/**
Mario Six78a88f72018-07-10 08:40:17 +02002592 * efi_calculate_crc32() - calculate cyclic redundancy code
2593 * @data: buffer with data
2594 * @data_size: size of buffer in bytes
2595 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002596 *
2597 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002598 *
Mario Six78a88f72018-07-10 08:40:17 +02002599 * See the Unified Extensible Firmware Interface (UEFI) specification for
2600 * details.
2601 *
2602 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002603 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002604static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2605 efi_uintn_t data_size,
2606 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002607{
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002608 efi_status_t ret = EFI_SUCCESS;
2609
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002610 EFI_ENTRY("%p, %zu", data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002611 if (!data || !data_size || !crc32_p) {
2612 ret = EFI_INVALID_PARAMETER;
2613 goto out;
2614 }
Alexander Grafbee91162016-03-04 01:09:59 +01002615 *crc32_p = crc32(0, data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002616out:
2617 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002618}
2619
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002620/**
Mario Six78a88f72018-07-10 08:40:17 +02002621 * efi_copy_mem() - copy memory
2622 * @destination: destination of the copy operation
2623 * @source: source of the copy operation
2624 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002625 *
2626 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002627 *
Mario Six78a88f72018-07-10 08:40:17 +02002628 * See the Unified Extensible Firmware Interface (UEFI) specification for
2629 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002630 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002631static void EFIAPI efi_copy_mem(void *destination, const void *source,
2632 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002633{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002634 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002635 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002636 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002637}
2638
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002639/**
Mario Six78a88f72018-07-10 08:40:17 +02002640 * efi_set_mem() - Fill memory with a byte value.
2641 * @buffer: buffer to fill
2642 * @size: size of buffer in bytes
2643 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002644 *
2645 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002646 *
Mario Six78a88f72018-07-10 08:40:17 +02002647 * See the Unified Extensible Firmware Interface (UEFI) specification for
2648 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002649 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002650static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002651{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002652 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002653 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002654 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002655}
2656
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002657/**
Mario Six78a88f72018-07-10 08:40:17 +02002658 * efi_protocol_open() - open protocol interface on a handle
2659 * @handler: handler of a protocol
2660 * @protocol_interface: interface implementing the protocol
2661 * @agent_handle: handle of the driver
2662 * @controller_handle: handle of the controller
2663 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002664 *
Mario Six78a88f72018-07-10 08:40:17 +02002665 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002666 */
2667static efi_status_t efi_protocol_open(
2668 struct efi_handler *handler,
2669 void **protocol_interface, void *agent_handle,
2670 void *controller_handle, uint32_t attributes)
2671{
2672 struct efi_open_protocol_info_item *item;
2673 struct efi_open_protocol_info_entry *match = NULL;
2674 bool opened_by_driver = false;
2675 bool opened_exclusive = false;
2676
2677 /* If there is no agent, only return the interface */
2678 if (!agent_handle)
2679 goto out;
2680
2681 /* For TEST_PROTOCOL ignore interface attribute */
2682 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2683 *protocol_interface = NULL;
2684
2685 /*
2686 * Check if the protocol is already opened by a driver with the same
2687 * attributes or opened exclusively
2688 */
2689 list_for_each_entry(item, &handler->open_infos, link) {
2690 if (item->info.agent_handle == agent_handle) {
2691 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2692 (item->info.attributes == attributes))
2693 return EFI_ALREADY_STARTED;
Heinrich Schuchardt399a39e2019-05-30 14:16:31 +02002694 } else {
2695 if (item->info.attributes &
2696 EFI_OPEN_PROTOCOL_BY_DRIVER)
2697 opened_by_driver = true;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002698 }
2699 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2700 opened_exclusive = true;
2701 }
2702
2703 /* Only one controller can open the protocol exclusively */
Heinrich Schuchardt399a39e2019-05-30 14:16:31 +02002704 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2705 if (opened_exclusive)
2706 return EFI_ACCESS_DENIED;
2707 } else if (attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {
2708 if (opened_exclusive || opened_by_driver)
2709 return EFI_ACCESS_DENIED;
2710 }
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002711
2712 /* Prepare exclusive opening */
2713 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2714 /* Try to disconnect controllers */
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002715disconnect_next:
2716 opened_by_driver = false;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002717 list_for_each_entry(item, &handler->open_infos, link) {
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002718 efi_status_t ret;
2719
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002720 if (item->info.attributes ==
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002721 EFI_OPEN_PROTOCOL_BY_DRIVER) {
2722 ret = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002723 item->info.controller_handle,
2724 item->info.agent_handle,
2725 NULL));
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002726 if (ret == EFI_SUCCESS)
2727 /*
2728 * Child controllers may have been
2729 * removed from the open_infos list. So
2730 * let's restart the loop.
2731 */
2732 goto disconnect_next;
2733 else
2734 opened_by_driver = true;
2735 }
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002736 }
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02002737 /* Only one driver can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002738 if (opened_by_driver)
2739 return EFI_ACCESS_DENIED;
2740 }
2741
2742 /* Find existing entry */
2743 list_for_each_entry(item, &handler->open_infos, link) {
2744 if (item->info.agent_handle == agent_handle &&
Heinrich Schuchardtb4863ba2019-06-01 20:15:10 +02002745 item->info.controller_handle == controller_handle &&
2746 item->info.attributes == attributes)
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002747 match = &item->info;
2748 }
2749 /* None found, create one */
2750 if (!match) {
2751 match = efi_create_open_info(handler);
2752 if (!match)
2753 return EFI_OUT_OF_RESOURCES;
2754 }
2755
2756 match->agent_handle = agent_handle;
2757 match->controller_handle = controller_handle;
2758 match->attributes = attributes;
2759 match->open_count++;
2760
2761out:
2762 /* For TEST_PROTOCOL ignore interface attribute. */
2763 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2764 *protocol_interface = handler->protocol_interface;
2765
2766 return EFI_SUCCESS;
2767}
2768
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002769/**
Mario Six78a88f72018-07-10 08:40:17 +02002770 * efi_open_protocol() - open protocol interface on a handle
2771 * @handle: handle on which the protocol shall be opened
2772 * @protocol: GUID of the protocol
2773 * @protocol_interface: interface implementing the protocol
2774 * @agent_handle: handle of the driver
2775 * @controller_handle: handle of the controller
2776 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002777 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002778 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002779 *
Mario Six78a88f72018-07-10 08:40:17 +02002780 * See the Unified Extensible Firmware Interface (UEFI) specification for
2781 * details.
2782 *
2783 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002784 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002785static efi_status_t EFIAPI efi_open_protocol
2786 (efi_handle_t handle, const efi_guid_t *protocol,
2787 void **protocol_interface, efi_handle_t agent_handle,
2788 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01002789{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002790 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002791 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01002792
Rob Clark778e6af2017-09-13 18:05:41 -04002793 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002794 protocol_interface, agent_handle, controller_handle,
2795 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002796
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002797 if (!handle || !protocol ||
2798 (!protocol_interface && attributes !=
2799 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2800 goto out;
2801 }
2802
2803 switch (attributes) {
2804 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2805 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2806 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2807 break;
2808 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2809 if (controller_handle == handle)
2810 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002811 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002812 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2813 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002814 /* Check that the controller handle is valid */
2815 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002816 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002817 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002818 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002819 /* Check that the agent handle is valid */
2820 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002821 goto out;
2822 break;
2823 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002824 goto out;
2825 }
2826
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002827 r = efi_search_protocol(handle, protocol, &handler);
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002828 switch (r) {
2829 case EFI_SUCCESS:
2830 break;
2831 case EFI_NOT_FOUND:
2832 r = EFI_UNSUPPORTED;
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002833 goto out;
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002834 default:
2835 goto out;
2836 }
Alexander Grafbee91162016-03-04 01:09:59 +01002837
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002838 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2839 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01002840out:
2841 return EFI_EXIT(r);
2842}
2843
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002844/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002845 * efi_start_image() - call the entry point of an image
2846 * @image_handle: handle of the image
2847 * @exit_data_size: size of the buffer
2848 * @exit_data: buffer to receive the exit data of the called image
2849 *
2850 * This function implements the StartImage service.
2851 *
2852 * See the Unified Extensible Firmware Interface (UEFI) specification for
2853 * details.
2854 *
2855 * Return: status code
2856 */
2857efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2858 efi_uintn_t *exit_data_size,
2859 u16 **exit_data)
2860{
2861 struct efi_loaded_image_obj *image_obj =
2862 (struct efi_loaded_image_obj *)image_handle;
2863 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002864 void *info;
2865 efi_handle_t parent_image = current_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002866
2867 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2868
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002869 /* Check parameters */
Heinrich Schuchardt1d3e8dc2019-06-11 19:35:20 +02002870 if (image_obj->header.type != EFI_OBJECT_TYPE_LOADED_IMAGE)
2871 return EFI_EXIT(EFI_INVALID_PARAMETER);
2872
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002873 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2874 &info, NULL, NULL,
2875 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2876 if (ret != EFI_SUCCESS)
2877 return EFI_EXIT(EFI_INVALID_PARAMETER);
2878
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002879 efi_is_direct_boot = false;
2880
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002881 image_obj->exit_data_size = exit_data_size;
2882 image_obj->exit_data = exit_data;
2883
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002884 /* call the image! */
2885 if (setjmp(&image_obj->exit_jmp)) {
2886 /*
2887 * We called the entry point of the child image with EFI_CALL
2888 * in the lines below. The child image called the Exit() boot
2889 * service efi_exit() which executed the long jump that brought
2890 * us to the current line. This implies that the second half
2891 * of the EFI_CALL macro has not been executed.
2892 */
2893#ifdef CONFIG_ARM
2894 /*
2895 * efi_exit() called efi_restore_gd(). We have to undo this
2896 * otherwise __efi_entry_check() will put the wrong value into
2897 * app_gd.
2898 */
2899 gd = app_gd;
2900#endif
2901 /*
2902 * To get ready to call EFI_EXIT below we have to execute the
2903 * missed out steps of EFI_CALL.
2904 */
2905 assert(__efi_entry_check());
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02002906 EFI_PRINT("%lu returned by started image\n",
2907 (unsigned long)((uintptr_t)image_obj->exit_status &
2908 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002909 current_image = parent_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002910 return EFI_EXIT(image_obj->exit_status);
2911 }
2912
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002913 current_image = image_handle;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02002914 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09002915 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002916 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2917
2918 /*
2919 * Usually UEFI applications call Exit() instead of returning.
2920 * But because the world doesn't consist of ponies and unicorns,
2921 * we're happy to emulate that behavior on behalf of a payload
2922 * that forgot.
2923 */
2924 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2925}
2926
2927/**
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002928 * efi_delete_image() - delete loaded image from memory)
2929 *
2930 * @image_obj: handle of the loaded image
2931 * @loaded_image_protocol: loaded image protocol
2932 */
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02002933static efi_status_t efi_delete_image
2934 (struct efi_loaded_image_obj *image_obj,
2935 struct efi_loaded_image *loaded_image_protocol)
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002936{
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02002937 struct efi_object *efiobj;
2938 efi_status_t r, ret = EFI_SUCCESS;
2939
2940close_next:
2941 list_for_each_entry(efiobj, &efi_obj_list, link) {
2942 struct efi_handler *protocol;
2943
2944 list_for_each_entry(protocol, &efiobj->protocols, link) {
2945 struct efi_open_protocol_info_item *info;
2946
2947 list_for_each_entry(info, &protocol->open_infos, link) {
2948 if (info->info.agent_handle !=
2949 (efi_handle_t)image_obj)
2950 continue;
2951 r = EFI_CALL(efi_close_protocol
2952 (efiobj, protocol->guid,
2953 info->info.agent_handle,
2954 info->info.controller_handle
2955 ));
2956 if (r != EFI_SUCCESS)
2957 ret = r;
2958 /*
2959 * Closing protocols may results in further
2960 * items being deleted. To play it safe loop
2961 * over all elements again.
2962 */
2963 goto close_next;
2964 }
2965 }
2966 }
2967
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002968 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2969 efi_size_in_pages(loaded_image_protocol->image_size));
2970 efi_delete_handle(&image_obj->header);
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02002971
2972 return ret;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002973}
2974
2975/**
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002976 * efi_unload_image() - unload an EFI image
2977 * @image_handle: handle of the image to be unloaded
2978 *
2979 * This function implements the UnloadImage service.
2980 *
2981 * See the Unified Extensible Firmware Interface (UEFI) specification for
2982 * details.
2983 *
2984 * Return: status code
2985 */
2986efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2987{
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002988 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002989 struct efi_object *efiobj;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002990 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002991
2992 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002993
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002994 efiobj = efi_search_obj(image_handle);
2995 if (!efiobj) {
2996 ret = EFI_INVALID_PARAMETER;
2997 goto out;
2998 }
2999 /* Find the loaded image protocol */
3000 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3001 (void **)&loaded_image_protocol,
3002 NULL, NULL,
3003 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3004 if (ret != EFI_SUCCESS) {
3005 ret = EFI_INVALID_PARAMETER;
3006 goto out;
3007 }
3008 switch (efiobj->type) {
3009 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3010 /* Call the unload function */
3011 if (!loaded_image_protocol->unload) {
3012 ret = EFI_UNSUPPORTED;
3013 goto out;
3014 }
3015 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
3016 if (ret != EFI_SUCCESS)
3017 goto out;
3018 break;
3019 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3020 break;
3021 default:
3022 ret = EFI_INVALID_PARAMETER;
3023 goto out;
3024 }
3025 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
3026 loaded_image_protocol);
3027out:
3028 return EFI_EXIT(ret);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003029}
3030
3031/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003032 * efi_update_exit_data() - fill exit data parameters of StartImage()
3033 *
3034 * @image_obj image handle
3035 * @exit_data_size size of the exit data buffer
3036 * @exit_data buffer with data returned by UEFI payload
3037 * Return: status code
3038 */
3039static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
3040 efi_uintn_t exit_data_size,
3041 u16 *exit_data)
3042{
3043 efi_status_t ret;
3044
3045 /*
3046 * If exit_data is not provided to StartImage(), exit_data_size must be
3047 * ignored.
3048 */
3049 if (!image_obj->exit_data)
3050 return EFI_SUCCESS;
3051 if (image_obj->exit_data_size)
3052 *image_obj->exit_data_size = exit_data_size;
3053 if (exit_data_size && exit_data) {
3054 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
3055 exit_data_size,
3056 (void **)image_obj->exit_data);
3057 if (ret != EFI_SUCCESS)
3058 return ret;
3059 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
3060 } else {
3061 image_obj->exit_data = NULL;
3062 }
3063 return EFI_SUCCESS;
3064}
3065
3066/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003067 * efi_exit() - leave an EFI application or driver
3068 * @image_handle: handle of the application or driver that is exiting
3069 * @exit_status: status code
3070 * @exit_data_size: size of the buffer in bytes
3071 * @exit_data: buffer with data describing an error
3072 *
3073 * This function implements the Exit service.
3074 *
3075 * See the Unified Extensible Firmware Interface (UEFI) specification for
3076 * details.
3077 *
3078 * Return: status code
3079 */
3080static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
3081 efi_status_t exit_status,
3082 efi_uintn_t exit_data_size,
3083 u16 *exit_data)
3084{
3085 /*
3086 * TODO: We should call the unload procedure of the loaded
3087 * image protocol.
3088 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003089 efi_status_t ret;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003090 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003091 struct efi_loaded_image_obj *image_obj =
3092 (struct efi_loaded_image_obj *)image_handle;
3093
3094 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
3095 exit_data_size, exit_data);
3096
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003097 /* Check parameters */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003098 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003099 (void **)&loaded_image_protocol,
3100 NULL, NULL,
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003101 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003102 if (ret != EFI_SUCCESS) {
3103 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003104 goto out;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003105 }
3106
3107 /* Unloading of unstarted images */
3108 switch (image_obj->header.type) {
3109 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3110 break;
3111 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3112 efi_delete_image(image_obj, loaded_image_protocol);
3113 ret = EFI_SUCCESS;
3114 goto out;
3115 default:
3116 /* Handle does not refer to loaded image */
3117 ret = EFI_INVALID_PARAMETER;
3118 goto out;
3119 }
3120 /* A started image can only be unloaded it is the last one started. */
3121 if (image_handle != current_image) {
3122 ret = EFI_INVALID_PARAMETER;
3123 goto out;
3124 }
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003125
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003126 /* Exit data is only foreseen in case of failure. */
3127 if (exit_status != EFI_SUCCESS) {
3128 ret = efi_update_exit_data(image_obj, exit_data_size,
3129 exit_data);
3130 /* Exiting has priority. Don't return error to caller. */
3131 if (ret != EFI_SUCCESS)
3132 EFI_PRINT("%s: out of memory\n", __func__);
3133 }
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003134 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
3135 exit_status != EFI_SUCCESS)
3136 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003137
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003138 /* Make sure entry/exit counts for EFI world cross-overs match */
3139 EFI_EXIT(exit_status);
3140
3141 /*
3142 * But longjmp out with the U-Boot gd, not the application's, as
3143 * the other end is a setjmp call inside EFI context.
3144 */
3145 efi_restore_gd();
3146
3147 image_obj->exit_status = exit_status;
3148 longjmp(&image_obj->exit_jmp, 1);
3149
3150 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003151out:
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003152 return EFI_EXIT(ret);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003153}
3154
3155/**
Mario Six78a88f72018-07-10 08:40:17 +02003156 * efi_handle_protocol() - get interface of a protocol on a handle
3157 * @handle: handle on which the protocol shall be opened
3158 * @protocol: GUID of the protocol
3159 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003160 *
3161 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003162 *
Mario Six78a88f72018-07-10 08:40:17 +02003163 * See the Unified Extensible Firmware Interface (UEFI) specification for
3164 * details.
3165 *
3166 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003167 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01003168static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02003169 const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01003170 void **protocol_interface)
3171{
Heinrich Schuchardt755d42d2019-06-01 19:29:39 +02003172 return efi_open_protocol(handle, protocol, protocol_interface, efi_root,
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02003173 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01003174}
3175
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003176/**
Mario Six78a88f72018-07-10 08:40:17 +02003177 * efi_bind_controller() - bind a single driver to a controller
3178 * @controller_handle: controller handle
3179 * @driver_image_handle: driver handle
3180 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003181 *
Mario Six78a88f72018-07-10 08:40:17 +02003182 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003183 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003184static efi_status_t efi_bind_controller(
3185 efi_handle_t controller_handle,
3186 efi_handle_t driver_image_handle,
3187 struct efi_device_path *remain_device_path)
3188{
3189 struct efi_driver_binding_protocol *binding_protocol;
3190 efi_status_t r;
3191
3192 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3193 &efi_guid_driver_binding_protocol,
3194 (void **)&binding_protocol,
3195 driver_image_handle, NULL,
3196 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3197 if (r != EFI_SUCCESS)
3198 return r;
3199 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3200 controller_handle,
3201 remain_device_path));
3202 if (r == EFI_SUCCESS)
3203 r = EFI_CALL(binding_protocol->start(binding_protocol,
3204 controller_handle,
3205 remain_device_path));
3206 EFI_CALL(efi_close_protocol(driver_image_handle,
3207 &efi_guid_driver_binding_protocol,
3208 driver_image_handle, NULL));
3209 return r;
3210}
3211
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003212/**
Mario Six78a88f72018-07-10 08:40:17 +02003213 * efi_connect_single_controller() - connect a single driver to a controller
3214 * @controller_handle: controller
3215 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003216 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003217 *
Mario Six78a88f72018-07-10 08:40:17 +02003218 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003219 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003220static efi_status_t efi_connect_single_controller(
3221 efi_handle_t controller_handle,
3222 efi_handle_t *driver_image_handle,
3223 struct efi_device_path *remain_device_path)
3224{
3225 efi_handle_t *buffer;
3226 size_t count;
3227 size_t i;
3228 efi_status_t r;
3229 size_t connected = 0;
3230
3231 /* Get buffer with all handles with driver binding protocol */
3232 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3233 &efi_guid_driver_binding_protocol,
3234 NULL, &count, &buffer));
3235 if (r != EFI_SUCCESS)
3236 return r;
3237
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02003238 /* Context Override */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003239 if (driver_image_handle) {
3240 for (; *driver_image_handle; ++driver_image_handle) {
3241 for (i = 0; i < count; ++i) {
3242 if (buffer[i] == *driver_image_handle) {
3243 buffer[i] = NULL;
3244 r = efi_bind_controller(
3245 controller_handle,
3246 *driver_image_handle,
3247 remain_device_path);
3248 /*
3249 * For drivers that do not support the
3250 * controller or are already connected
3251 * we receive an error code here.
3252 */
3253 if (r == EFI_SUCCESS)
3254 ++connected;
3255 }
3256 }
3257 }
3258 }
3259
3260 /*
3261 * TODO: Some overrides are not yet implemented:
3262 * - Platform Driver Override
3263 * - Driver Family Override Search
3264 * - Bus Specific Driver Override
3265 */
3266
3267 /* Driver Binding Search */
3268 for (i = 0; i < count; ++i) {
3269 if (buffer[i]) {
3270 r = efi_bind_controller(controller_handle,
3271 buffer[i],
3272 remain_device_path);
3273 if (r == EFI_SUCCESS)
3274 ++connected;
3275 }
3276 }
3277
3278 efi_free_pool(buffer);
3279 if (!connected)
3280 return EFI_NOT_FOUND;
3281 return EFI_SUCCESS;
3282}
3283
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003284/**
Mario Six78a88f72018-07-10 08:40:17 +02003285 * efi_connect_controller() - connect a controller to a driver
3286 * @controller_handle: handle of the controller
3287 * @driver_image_handle: handle of the driver
3288 * @remain_device_path: device path of a child controller
3289 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003290 *
3291 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02003292 *
3293 * See the Unified Extensible Firmware Interface (UEFI) specification for
3294 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003295 *
3296 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003297 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003298 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3299 *
Mario Six78a88f72018-07-10 08:40:17 +02003300 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003301 */
3302static efi_status_t EFIAPI efi_connect_controller(
3303 efi_handle_t controller_handle,
3304 efi_handle_t *driver_image_handle,
3305 struct efi_device_path *remain_device_path,
3306 bool recursive)
3307{
3308 efi_status_t r;
3309 efi_status_t ret = EFI_NOT_FOUND;
3310 struct efi_object *efiobj;
3311
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01003312 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003313 remain_device_path, recursive);
3314
3315 efiobj = efi_search_obj(controller_handle);
3316 if (!efiobj) {
3317 ret = EFI_INVALID_PARAMETER;
3318 goto out;
3319 }
3320
3321 r = efi_connect_single_controller(controller_handle,
3322 driver_image_handle,
3323 remain_device_path);
3324 if (r == EFI_SUCCESS)
3325 ret = EFI_SUCCESS;
3326 if (recursive) {
3327 struct efi_handler *handler;
3328 struct efi_open_protocol_info_item *item;
3329
3330 list_for_each_entry(handler, &efiobj->protocols, link) {
3331 list_for_each_entry(item, &handler->open_infos, link) {
3332 if (item->info.attributes &
3333 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3334 r = EFI_CALL(efi_connect_controller(
3335 item->info.controller_handle,
3336 driver_image_handle,
3337 remain_device_path,
3338 recursive));
3339 if (r == EFI_SUCCESS)
3340 ret = EFI_SUCCESS;
3341 }
3342 }
3343 }
3344 }
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02003345 /* Check for child controller specified by end node */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003346 if (ret != EFI_SUCCESS && remain_device_path &&
3347 remain_device_path->type == DEVICE_PATH_TYPE_END)
3348 ret = EFI_SUCCESS;
3349out:
3350 return EFI_EXIT(ret);
3351}
3352
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003353/**
Mario Six78a88f72018-07-10 08:40:17 +02003354 * efi_reinstall_protocol_interface() - reinstall protocol interface
3355 * @handle: handle on which the protocol shall be reinstalled
3356 * @protocol: GUID of the protocol to be installed
3357 * @old_interface: interface to be removed
3358 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003359 *
3360 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02003361 *
3362 * See the Unified Extensible Firmware Interface (UEFI) specification for
3363 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003364 *
3365 * The old interface is uninstalled. The new interface is installed.
3366 * Drivers are connected.
3367 *
Mario Six78a88f72018-07-10 08:40:17 +02003368 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003369 */
3370static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3371 efi_handle_t handle, const efi_guid_t *protocol,
3372 void *old_interface, void *new_interface)
3373{
3374 efi_status_t ret;
3375
3376 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3377 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003378
3379 /* Uninstall protocol but do not delete handle */
3380 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003381 if (ret != EFI_SUCCESS)
3382 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003383
3384 /* Install the new protocol */
3385 ret = efi_add_protocol(handle, protocol, new_interface);
3386 /*
3387 * The UEFI spec does not specify what should happen to the handle
3388 * if in case of an error no protocol interface remains on the handle.
3389 * So let's do nothing here.
3390 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003391 if (ret != EFI_SUCCESS)
3392 goto out;
3393 /*
3394 * The returned status code has to be ignored.
3395 * Do not create an error if no suitable driver for the handle exists.
3396 */
3397 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3398out:
3399 return EFI_EXIT(ret);
3400}
3401
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003402/**
Mario Six78a88f72018-07-10 08:40:17 +02003403 * efi_get_child_controllers() - get all child controllers associated to a driver
3404 * @efiobj: handle of the controller
3405 * @driver_handle: handle of the driver
3406 * @number_of_children: number of child controllers
3407 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003408 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003409 * The allocated buffer has to be freed with free().
3410 *
Mario Six78a88f72018-07-10 08:40:17 +02003411 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003412 */
3413static efi_status_t efi_get_child_controllers(
3414 struct efi_object *efiobj,
3415 efi_handle_t driver_handle,
3416 efi_uintn_t *number_of_children,
3417 efi_handle_t **child_handle_buffer)
3418{
3419 struct efi_handler *handler;
3420 struct efi_open_protocol_info_item *item;
3421 efi_uintn_t count = 0, i;
3422 bool duplicate;
3423
3424 /* Count all child controller associations */
3425 list_for_each_entry(handler, &efiobj->protocols, link) {
3426 list_for_each_entry(item, &handler->open_infos, link) {
3427 if (item->info.agent_handle == driver_handle &&
3428 item->info.attributes &
3429 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3430 ++count;
3431 }
3432 }
3433 /*
3434 * Create buffer. In case of duplicate child controller assignments
3435 * the buffer will be too large. But that does not harm.
3436 */
3437 *number_of_children = 0;
3438 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3439 if (!*child_handle_buffer)
3440 return EFI_OUT_OF_RESOURCES;
3441 /* Copy unique child handles */
3442 list_for_each_entry(handler, &efiobj->protocols, link) {
3443 list_for_each_entry(item, &handler->open_infos, link) {
3444 if (item->info.agent_handle == driver_handle &&
3445 item->info.attributes &
3446 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3447 /* Check this is a new child controller */
3448 duplicate = false;
3449 for (i = 0; i < *number_of_children; ++i) {
3450 if ((*child_handle_buffer)[i] ==
3451 item->info.controller_handle)
3452 duplicate = true;
3453 }
3454 /* Copy handle to buffer */
3455 if (!duplicate) {
3456 i = (*number_of_children)++;
3457 (*child_handle_buffer)[i] =
3458 item->info.controller_handle;
3459 }
3460 }
3461 }
3462 }
3463 return EFI_SUCCESS;
3464}
3465
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003466/**
Mario Six78a88f72018-07-10 08:40:17 +02003467 * efi_disconnect_controller() - disconnect a controller from a driver
3468 * @controller_handle: handle of the controller
3469 * @driver_image_handle: handle of the driver
3470 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003471 *
3472 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003473 *
Mario Six78a88f72018-07-10 08:40:17 +02003474 * See the Unified Extensible Firmware Interface (UEFI) specification for
3475 * details.
3476 *
3477 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003478 */
3479static efi_status_t EFIAPI efi_disconnect_controller(
3480 efi_handle_t controller_handle,
3481 efi_handle_t driver_image_handle,
3482 efi_handle_t child_handle)
3483{
3484 struct efi_driver_binding_protocol *binding_protocol;
3485 efi_handle_t *child_handle_buffer = NULL;
3486 size_t number_of_children = 0;
3487 efi_status_t r;
3488 size_t stop_count = 0;
3489 struct efi_object *efiobj;
3490
3491 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3492 child_handle);
3493
3494 efiobj = efi_search_obj(controller_handle);
3495 if (!efiobj) {
3496 r = EFI_INVALID_PARAMETER;
3497 goto out;
3498 }
3499
3500 if (child_handle && !efi_search_obj(child_handle)) {
3501 r = EFI_INVALID_PARAMETER;
3502 goto out;
3503 }
3504
3505 /* If no driver handle is supplied, disconnect all drivers */
3506 if (!driver_image_handle) {
3507 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3508 goto out;
3509 }
3510
3511 /* Create list of child handles */
3512 if (child_handle) {
3513 number_of_children = 1;
3514 child_handle_buffer = &child_handle;
3515 } else {
3516 efi_get_child_controllers(efiobj,
3517 driver_image_handle,
3518 &number_of_children,
3519 &child_handle_buffer);
3520 }
3521
3522 /* Get the driver binding protocol */
3523 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3524 &efi_guid_driver_binding_protocol,
3525 (void **)&binding_protocol,
3526 driver_image_handle, NULL,
3527 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3528 if (r != EFI_SUCCESS)
3529 goto out;
3530 /* Remove the children */
3531 if (number_of_children) {
3532 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3533 controller_handle,
3534 number_of_children,
3535 child_handle_buffer));
3536 if (r == EFI_SUCCESS)
3537 ++stop_count;
3538 }
3539 /* Remove the driver */
3540 if (!child_handle)
3541 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3542 controller_handle,
3543 0, NULL));
3544 if (r == EFI_SUCCESS)
3545 ++stop_count;
3546 EFI_CALL(efi_close_protocol(driver_image_handle,
3547 &efi_guid_driver_binding_protocol,
3548 driver_image_handle, NULL));
3549
3550 if (stop_count)
3551 r = EFI_SUCCESS;
3552 else
3553 r = EFI_NOT_FOUND;
3554out:
3555 if (!child_handle)
3556 free(child_handle_buffer);
3557 return EFI_EXIT(r);
3558}
3559
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003560static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003561 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003562 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3563 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003564 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003565 },
3566 .raise_tpl = efi_raise_tpl,
3567 .restore_tpl = efi_restore_tpl,
3568 .allocate_pages = efi_allocate_pages_ext,
3569 .free_pages = efi_free_pages_ext,
3570 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003571 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003572 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003573 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003574 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003575 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003576 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003577 .close_event = efi_close_event,
3578 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003579 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003580 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003581 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003582 .handle_protocol = efi_handle_protocol,
3583 .reserved = NULL,
3584 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003585 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003586 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003587 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003588 .load_image = efi_load_image,
3589 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003590 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003591 .unload_image = efi_unload_image,
3592 .exit_boot_services = efi_exit_boot_services,
3593 .get_next_monotonic_count = efi_get_next_monotonic_count,
3594 .stall = efi_stall,
3595 .set_watchdog_timer = efi_set_watchdog_timer,
3596 .connect_controller = efi_connect_controller,
3597 .disconnect_controller = efi_disconnect_controller,
3598 .open_protocol = efi_open_protocol,
3599 .close_protocol = efi_close_protocol,
3600 .open_protocol_information = efi_open_protocol_information,
3601 .protocols_per_handle = efi_protocols_per_handle,
3602 .locate_handle_buffer = efi_locate_handle_buffer,
3603 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003604 .install_multiple_protocol_interfaces =
3605 efi_install_multiple_protocol_interfaces,
3606 .uninstall_multiple_protocol_interfaces =
3607 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafbee91162016-03-04 01:09:59 +01003608 .calculate_crc32 = efi_calculate_crc32,
3609 .copy_mem = efi_copy_mem,
3610 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003611 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003612};
3613
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003614static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01003615
Alexander Graf3c63db92016-10-14 13:45:30 +02003616struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01003617 .hdr = {
3618 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003619 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003620 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01003621 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003622 .fw_vendor = firmware_vendor,
3623 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardt3c783bf2019-06-15 14:51:06 +02003624 .runtime = &efi_runtime_services,
Alexander Grafbee91162016-03-04 01:09:59 +01003625 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003626 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01003627};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003628
3629/**
3630 * efi_initialize_system_table() - Initialize system table
3631 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02003632 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003633 */
3634efi_status_t efi_initialize_system_table(void)
3635{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003636 efi_status_t ret;
3637
3638 /* Allocate configuration table array */
3639 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3640 EFI_MAX_CONFIGURATION_TABLES *
3641 sizeof(struct efi_configuration_table),
3642 (void **)&systab.tables);
3643
Heinrich Schuchardt93148eb2019-06-29 02:00:16 +02003644 /*
3645 * These entries will be set to NULL in ExitBootServices(). To avoid
3646 * relocation in SetVirtualAddressMap(), set them dynamically.
3647 */
3648 systab.con_in = &efi_con_in;
3649 systab.con_out = &efi_con_out;
3650 systab.std_err = &efi_con_out;
3651 systab.boottime = &efi_boot_services;
3652
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003653 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003654 efi_update_table_header_crc32(&systab.hdr);
3655 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3656 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003657
3658 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003659}