blob: 0b7579cb5af1698f648ada6aee2cd26823198531 [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>
Ilias Apalodimas19763ea2020-10-22 01:04:20 +03009#include <bootm.h>
Heinrich Schuchardt7d963322017-10-05 16:14:14 +020010#include <div64.h>
Ilias Apalodimas529441c2020-10-22 01:04:21 +030011#include <dm/device.h>
12#include <dm/root.h>
Alexander Grafbee91162016-03-04 01:09:59 +010013#include <efi_loader.h>
Simon Glass36bf4462019-11-14 12:57:42 -070014#include <irq_func.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060015#include <log.h>
Alexander Grafbee91162016-03-04 01:09:59 +010016#include <malloc.h>
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +020017#include <pe.h>
Ilias Apalodimas19763ea2020-10-22 01:04:20 +030018#include <time.h>
Simon Glass3db71102019-11-14 12:57:16 -070019#include <u-boot/crc.h>
Ilias Apalodimas529441c2020-10-22 01:04:21 +030020#include <usb.h>
Alexander Grafbee91162016-03-04 01:09:59 +010021#include <watchdog.h>
Simon Glass401d1c42020-10-30 21:38:53 -060022#include <asm/global_data.h>
AKASHI Takahiro86a3d432021-07-20 14:57:02 +090023#include <asm/setjmp.h>
Ilias Apalodimas19763ea2020-10-22 01:04:20 +030024#include <linux/libfdt_env.h>
Alexander Grafbee91162016-03-04 01:09:59 +010025
26DECLARE_GLOBAL_DATA_PTR;
27
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020028/* Task priority level */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +010029static efi_uintn_t efi_tpl = TPL_APPLICATION;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020030
Alexander Grafbee91162016-03-04 01:09:59 +010031/* This list contains all the EFI objects our payload has access to */
32LIST_HEAD(efi_obj_list);
33
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010034/* List of all events */
Heinrich Schuchardt14b40482019-07-11 20:15:09 +020035__efi_runtime_data LIST_HEAD(efi_events);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010036
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +020037/* List of queued events */
Bin Mengee238302023-04-05 20:15:17 +080038static LIST_HEAD(efi_event_queue);
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +020039
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +020040/* Flag to disable timer activity in ExitBootServices() */
41static bool timers_enabled = true;
42
Heinrich Schuchardtfccd3d92020-11-12 21:26:28 +010043/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
44bool efi_st_keep_devices;
45
Heinrich Schuchardtab15d412019-05-04 17:27:54 +020046/* List of all events registered by RegisterProtocolNotify() */
Bin Mengee238302023-04-05 20:15:17 +080047static LIST_HEAD(efi_register_notify_events);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +020048
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +010049/* Handle of the currently executing image */
50static efi_handle_t current_image;
51
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +020052#if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
Alexander Grafbee91162016-03-04 01:09:59 +010053/*
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +020054 * The "gd" pointer lives in a register on ARM and RISC-V that we declare
Alexander Grafbee91162016-03-04 01:09:59 +010055 * fixed when compiling U-Boot. However, the payload does not know about that
56 * restriction so we need to manually swap its and our view of that register on
57 * EFI callback entry/exit.
58 */
Heinrich Schuchardt4f7dc5f2020-05-27 01:58:30 +020059static volatile gd_t *efi_gd, *app_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -060060#endif
Alexander Grafbee91162016-03-04 01:09:59 +010061
Ilias Apalodimas54edc372023-07-24 13:17:36 +030062static efi_status_t efi_uninstall_protocol
63 (efi_handle_t handle, const efi_guid_t *protocol,
Ilias Apalodimascc889bd2023-08-24 17:21:09 +030064 void *protocol_interface, bool preserve);
Ilias Apalodimas54edc372023-07-24 13:17:36 +030065
Heinrich Schuchardt914df752019-02-09 14:10:39 +010066/* 1 if inside U-Boot code, 0 if inside EFI payload code */
67static int entry_count = 1;
Rob Clarkaf65db82017-07-27 08:04:19 -040068static int nesting_level;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +010069/* GUID of the device tree table */
70const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +010071/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
72const efi_guid_t efi_guid_driver_binding_protocol =
73 EFI_DRIVER_BINDING_PROTOCOL_GUID;
Rob Clarkc160d2f2017-07-27 08:04:18 -040074
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010075/* event group ExitBootServices() invoked */
76const efi_guid_t efi_guid_event_group_exit_boot_services =
77 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
Heinrich Schuchardt43eaf5b2021-11-16 18:46:27 +010078/* event group before ExitBootServices() invoked */
79const efi_guid_t efi_guid_event_group_before_exit_boot_services =
80 EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010081/* event group SetVirtualAddressMap() invoked */
82const efi_guid_t efi_guid_event_group_virtual_address_change =
83 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
84/* event group memory map changed */
85const efi_guid_t efi_guid_event_group_memory_map_change =
86 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
87/* event group boot manager about to boot */
88const efi_guid_t efi_guid_event_group_ready_to_boot =
89 EFI_EVENT_GROUP_READY_TO_BOOT;
90/* event group ResetSystem() invoked (before ExitBootServices) */
91const efi_guid_t efi_guid_event_group_reset_system =
92 EFI_EVENT_GROUP_RESET_SYSTEM;
Heinrich Schuchardtb6f11092020-12-04 03:33:41 +010093/* GUIDs of the Load File and Load File2 protocols */
94const efi_guid_t efi_guid_load_file_protocol = EFI_LOAD_FILE_PROTOCOL_GUID;
95const efi_guid_t efi_guid_load_file2_protocol = EFI_LOAD_FILE2_PROTOCOL_GUID;
Masahisa Kojima3d49ee82021-10-26 17:27:24 +090096/* GUID of the SMBIOS table */
97const efi_guid_t smbios_guid = SMBIOS_TABLE_GUID;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010098
Heinrich Schuchardt2074f702018-01-11 08:16:09 +010099static efi_status_t EFIAPI efi_disconnect_controller(
100 efi_handle_t controller_handle,
101 efi_handle_t driver_image_handle,
102 efi_handle_t child_handle);
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +0100103
Ilias Apalodimas239d59a2023-06-20 09:19:28 +0300104static
105efi_status_t EFIAPI efi_connect_controller(efi_handle_t controller_handle,
106 efi_handle_t *driver_image_handle,
107 struct efi_device_path *remain_device_path,
108 bool recursive);
109
Rob Clarkc160d2f2017-07-27 08:04:18 -0400110/* Called on every callback entry */
111int __efi_entry_check(void)
112{
113 int ret = entry_count++ == 0;
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +0200114#if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
Rob Clarkc160d2f2017-07-27 08:04:18 -0400115 assert(efi_gd);
116 app_gd = gd;
Heinrich Schuchardt4f7dc5f2020-05-27 01:58:30 +0200117 set_gd(efi_gd);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400118#endif
119 return ret;
120}
121
122/* Called on every callback exit */
123int __efi_exit_check(void)
124{
125 int ret = --entry_count == 0;
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +0200126#if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
Heinrich Schuchardt4f7dc5f2020-05-27 01:58:30 +0200127 set_gd(app_gd);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400128#endif
129 return ret;
130}
131
Heinrich Schuchardte7d64062020-07-18 09:53:01 +0200132/**
133 * efi_save_gd() - save global data register
134 *
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +0200135 * On the ARM and RISC-V architectures gd is mapped to a fixed register.
Heinrich Schuchardte7d64062020-07-18 09:53:01 +0200136 * As this register may be overwritten by an EFI payload we save it here
137 * and restore it on every callback entered.
138 *
139 * This function is called after relocation from initr_reloc_global_data().
140 */
Alexander Grafbee91162016-03-04 01:09:59 +0100141void efi_save_gd(void)
142{
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +0200143#if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
Alexander Grafbee91162016-03-04 01:09:59 +0100144 efi_gd = gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600145#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100146}
147
Heinrich Schuchardte7d64062020-07-18 09:53:01 +0200148/**
149 * efi_restore_gd() - restore global data register
150 *
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +0200151 * On the ARM and RISC-V architectures gd is mapped to a fixed register.
Heinrich Schuchardte7d64062020-07-18 09:53:01 +0200152 * Restore it after returning from the UEFI world to the value saved via
153 * efi_save_gd().
Rob Clarkc160d2f2017-07-27 08:04:18 -0400154 */
Alexander Grafbee91162016-03-04 01:09:59 +0100155void efi_restore_gd(void)
156{
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +0200157#if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
Alexander Grafbee91162016-03-04 01:09:59 +0100158 /* Only restore if we're already in EFI context */
159 if (!efi_gd)
160 return;
Heinrich Schuchardt4f7dc5f2020-05-27 01:58:30 +0200161 set_gd(efi_gd);
Simon Glass65e4c0b2016-09-25 15:27:35 -0600162#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100163}
164
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200165/**
Mario Six78a88f72018-07-10 08:40:17 +0200166 * indent_string() - returns a string for indenting with two spaces per level
167 * @level: indent level
Heinrich Schuchardtc8df80c2018-01-24 19:21:36 +0100168 *
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200169 * A maximum of ten indent levels is supported. Higher indent levels will be
170 * truncated.
171 *
Mario Six78a88f72018-07-10 08:40:17 +0200172 * Return: A string for indenting with two spaces per level is
173 * returned.
Rob Clarkaf65db82017-07-27 08:04:19 -0400174 */
175static const char *indent_string(int level)
176{
177 const char *indent = " ";
178 const int max = strlen(indent);
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +0100179
Rob Clarkaf65db82017-07-27 08:04:19 -0400180 level = min(max, level * 2);
181 return &indent[max - level];
182}
183
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200184const char *__efi_nesting(void)
185{
186 return indent_string(nesting_level);
187}
188
Rob Clarkaf65db82017-07-27 08:04:19 -0400189const char *__efi_nesting_inc(void)
190{
191 return indent_string(nesting_level++);
192}
193
194const char *__efi_nesting_dec(void)
195{
196 return indent_string(--nesting_level);
197}
198
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200199/**
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200200 * efi_event_is_queued() - check if an event is queued
201 *
202 * @event: event
203 * Return: true if event is queued
204 */
205static bool efi_event_is_queued(struct efi_event *event)
206{
207 return !!event->queue_link.next;
208}
209
210/**
Ilias Apalodimascc889bd2023-08-24 17:21:09 +0300211 * efi_purge_handle() - Clean the deleted handle from the various lists
212 * @handle: handle to remove
213 *
214 * Return: status code
215 */
216static efi_status_t efi_purge_handle(efi_handle_t handle)
217{
218 struct efi_register_notify_event *item;
219
220 if (!list_empty(&handle->protocols))
221 return EFI_ACCESS_DENIED;
222 /* The handle is about to be freed. Remove it from events */
223 list_for_each_entry(item, &efi_register_notify_events, link) {
224 struct efi_protocol_notification *hitem, *hnext;
225
226 list_for_each_entry_safe(hitem, hnext, &item->handles, link) {
227 if (handle == hitem->handle) {
228 list_del(&hitem->link);
229 free(hitem);
230 }
231 }
232 }
233 /* The last protocol has been removed, delete the handle. */
234 list_del(&handle->link);
235 free(handle);
236
237 return EFI_SUCCESS;
238}
239
240/**
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200241 * efi_process_event_queue() - process event queue
242 */
243static void efi_process_event_queue(void)
244{
245 while (!list_empty(&efi_event_queue)) {
246 struct efi_event *event;
247 efi_uintn_t old_tpl;
248
249 event = list_first_entry(&efi_event_queue, struct efi_event,
250 queue_link);
251 if (efi_tpl >= event->notify_tpl)
252 return;
253 list_del(&event->queue_link);
254 event->queue_link.next = NULL;
255 event->queue_link.prev = NULL;
256 /* Events must be executed at the event's TPL */
257 old_tpl = efi_tpl;
258 efi_tpl = event->notify_tpl;
259 EFI_CALL_VOID(event->notify_function(event,
260 event->notify_context));
261 efi_tpl = old_tpl;
262 if (event->type == EVT_NOTIFY_SIGNAL)
263 event->is_signaled = 0;
264 }
265}
266
267/**
Mario Six78a88f72018-07-10 08:40:17 +0200268 * efi_queue_event() - queue an EFI event
269 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200270 *
271 * This function queues the notification function of the event for future
272 * execution.
273 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200274 */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200275static void efi_queue_event(struct efi_event *event)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200276{
Heinrich Schuchardt2b8568f2020-03-06 21:56:10 +0100277 struct efi_event *item;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200278
279 if (!event->notify_function)
280 return;
281
282 if (!efi_event_is_queued(event)) {
283 /*
284 * Events must be notified in order of decreasing task priority
285 * level. Insert the new event accordingly.
286 */
287 list_for_each_entry(item, &efi_event_queue, queue_link) {
288 if (item->notify_tpl < event->notify_tpl) {
289 list_add_tail(&event->queue_link,
290 &item->queue_link);
291 event = NULL;
292 break;
293 }
294 }
295 if (event)
296 list_add_tail(&event->queue_link, &efi_event_queue);
Heinrich Schuchardtb7d186f2020-12-28 00:25:34 +0100297 efi_process_event_queue();
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200298 }
299}
300
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200301/**
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200302 * is_valid_tpl() - check if the task priority level is valid
303 *
304 * @tpl: TPL level to check
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200305 * Return: status code
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200306 */
Heinrich Schuchardtbe678472023-02-10 08:50:06 +0100307static efi_status_t is_valid_tpl(efi_uintn_t tpl)
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200308{
309 switch (tpl) {
310 case TPL_APPLICATION:
311 case TPL_CALLBACK:
312 case TPL_NOTIFY:
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200313 return EFI_SUCCESS;
314 default:
315 return EFI_INVALID_PARAMETER;
316 }
317}
318
319/**
Mario Six78a88f72018-07-10 08:40:17 +0200320 * efi_signal_event() - signal an EFI event
321 * @event: event to signal
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100322 *
Heinrich Schuchardt2a0f80f2020-12-28 00:59:09 +0100323 * This function signals an event. If the event belongs to an event group, all
324 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100325 * their notification function is queued.
326 *
327 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100328 */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200329void efi_signal_event(struct efi_event *event)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100330{
Heinrich Schuchardtdfa306e2019-06-06 01:51:50 +0200331 if (event->is_signaled)
332 return;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100333 if (event->group) {
334 struct efi_event *evt;
335
336 /*
337 * The signaled state has to set before executing any
338 * notification function
339 */
340 list_for_each_entry(evt, &efi_events, link) {
341 if (!evt->group || guidcmp(evt->group, event->group))
342 continue;
343 if (evt->is_signaled)
344 continue;
345 evt->is_signaled = true;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100346 }
347 list_for_each_entry(evt, &efi_events, link) {
348 if (!evt->group || guidcmp(evt->group, event->group))
349 continue;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200350 efi_queue_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100351 }
Heinrich Schuchardt3626e532019-05-05 00:07:34 +0200352 } else {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100353 event->is_signaled = true;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200354 efi_queue_event(event);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100355 }
356}
357
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200358/**
Mario Six78a88f72018-07-10 08:40:17 +0200359 * efi_raise_tpl() - raise the task priority level
360 * @new_tpl: new value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200361 *
362 * This function implements the RaiseTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200363 *
Mario Six78a88f72018-07-10 08:40:17 +0200364 * See the Unified Extensible Firmware Interface (UEFI) specification for
365 * details.
366 *
367 * Return: old value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200368 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100369static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100370{
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100371 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200372
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200373 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200374
375 if (new_tpl < efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200376 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200377 efi_tpl = new_tpl;
378 if (efi_tpl > TPL_HIGH_LEVEL)
379 efi_tpl = TPL_HIGH_LEVEL;
380
381 EFI_EXIT(EFI_SUCCESS);
382 return old_tpl;
Alexander Grafbee91162016-03-04 01:09:59 +0100383}
384
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200385/**
Mario Six78a88f72018-07-10 08:40:17 +0200386 * efi_restore_tpl() - lower the task priority level
387 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200388 *
389 * This function implements the RestoreTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200390 *
Mario Six78a88f72018-07-10 08:40:17 +0200391 * See the Unified Extensible Firmware Interface (UEFI) specification for
392 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200393 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100394static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100395{
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200396 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200397
398 if (old_tpl > efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200399 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200400 efi_tpl = old_tpl;
401 if (efi_tpl > TPL_HIGH_LEVEL)
402 efi_tpl = TPL_HIGH_LEVEL;
403
Heinrich Schuchardt0f7fcc72018-03-24 18:40:21 +0100404 /*
405 * Lowering the TPL may have made queued events eligible for execution.
406 */
407 efi_timer_check();
408
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200409 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100410}
411
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200412/**
Mario Six78a88f72018-07-10 08:40:17 +0200413 * efi_allocate_pages_ext() - allocate memory pages
414 * @type: type of allocation to be performed
415 * @memory_type: usage type of the allocated memory
416 * @pages: number of pages to be allocated
417 * @memory: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200418 *
419 * This function implements the AllocatePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200420 *
Mario Six78a88f72018-07-10 08:40:17 +0200421 * See the Unified Extensible Firmware Interface (UEFI) specification for
422 * details.
423 *
424 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200425 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900426static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100427 efi_uintn_t pages,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900428 uint64_t *memory)
Alexander Grafbee91162016-03-04 01:09:59 +0100429{
430 efi_status_t r;
431
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100432 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafbee91162016-03-04 01:09:59 +0100433 r = efi_allocate_pages(type, memory_type, pages, memory);
434 return EFI_EXIT(r);
435}
436
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200437/**
Mario Six78a88f72018-07-10 08:40:17 +0200438 * efi_free_pages_ext() - Free memory pages.
439 * @memory: start of the memory area to be freed
440 * @pages: number of pages to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200441 *
442 * This function implements the FreePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200443 *
Mario Six78a88f72018-07-10 08:40:17 +0200444 * See the Unified Extensible Firmware Interface (UEFI) specification for
445 * details.
446 *
447 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200448 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900449static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100450 efi_uintn_t pages)
Alexander Grafbee91162016-03-04 01:09:59 +0100451{
452 efi_status_t r;
453
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900454 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafbee91162016-03-04 01:09:59 +0100455 r = efi_free_pages(memory, pages);
456 return EFI_EXIT(r);
457}
458
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200459/**
Mario Six78a88f72018-07-10 08:40:17 +0200460 * efi_get_memory_map_ext() - get map describing memory usage
461 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
462 * on exit the size of the copied memory map
463 * @memory_map: buffer to which the memory map is written
464 * @map_key: key for the memory map
465 * @descriptor_size: size of an individual memory descriptor
466 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200467 *
468 * This function implements the GetMemoryMap service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200469 *
Mario Six78a88f72018-07-10 08:40:17 +0200470 * See the Unified Extensible Firmware Interface (UEFI) specification for
471 * details.
472 *
473 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200474 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900475static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100476 efi_uintn_t *memory_map_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900477 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100478 efi_uintn_t *map_key,
479 efi_uintn_t *descriptor_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900480 uint32_t *descriptor_version)
Alexander Grafbee91162016-03-04 01:09:59 +0100481{
482 efi_status_t r;
483
484 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
485 map_key, descriptor_size, descriptor_version);
486 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
487 descriptor_size, descriptor_version);
488 return EFI_EXIT(r);
489}
490
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200491/**
Mario Six78a88f72018-07-10 08:40:17 +0200492 * efi_allocate_pool_ext() - allocate memory from pool
493 * @pool_type: type of the pool from which memory is to be allocated
494 * @size: number of bytes to be allocated
495 * @buffer: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200496 *
497 * This function implements the AllocatePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200498 *
Mario Six78a88f72018-07-10 08:40:17 +0200499 * See the Unified Extensible Firmware Interface (UEFI) specification for
500 * details.
501 *
502 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200503 */
Stefan Brünsead12742016-10-09 22:17:18 +0200504static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100505 efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200506 void **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100507{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100508 efi_status_t r;
509
Heinrich Schuchardte9df5492022-02-03 22:21:51 +0100510 EFI_ENTRY("%d, %zu, %p", pool_type, size, buffer);
Stefan Brünsead12742016-10-09 22:17:18 +0200511 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100512 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100513}
514
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200515/**
Mario Six78a88f72018-07-10 08:40:17 +0200516 * efi_free_pool_ext() - free memory from pool
517 * @buffer: start of memory to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200518 *
519 * This function implements the FreePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200520 *
Mario Six78a88f72018-07-10 08:40:17 +0200521 * See the Unified Extensible Firmware Interface (UEFI) specification for
522 * details.
523 *
524 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200525 */
Stefan Brüns42417bc2016-10-09 22:17:26 +0200526static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100527{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100528 efi_status_t r;
529
530 EFI_ENTRY("%p", buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200531 r = efi_free_pool(buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100532 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100533}
534
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200535/**
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200536 * efi_add_handle() - add a new handle to the object list
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100537 *
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200538 * @handle: handle to be added
539 *
540 * The protocols list is initialized. The handle is added to the list of known
541 * UEFI objects.
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100542 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200543void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100544{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200545 if (!handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100546 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200547 INIT_LIST_HEAD(&handle->protocols);
548 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100549}
550
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200551/**
Mario Six78a88f72018-07-10 08:40:17 +0200552 * efi_create_handle() - create handle
553 * @handle: new handle
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200554 *
Mario Six78a88f72018-07-10 08:40:17 +0200555 * Return: status code
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200556 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100557efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200558{
559 struct efi_object *obj;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200560
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200561 obj = calloc(1, sizeof(struct efi_object));
562 if (!obj)
563 return EFI_OUT_OF_RESOURCES;
564
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100565 efi_add_handle(obj);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200566 *handle = obj;
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200567
568 return EFI_SUCCESS;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200569}
570
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200571/**
Mario Six78a88f72018-07-10 08:40:17 +0200572 * efi_search_protocol() - find a protocol on a handle.
573 * @handle: handle
574 * @protocol_guid: GUID of the protocol
575 * @handler: reference to the protocol
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100576 *
Mario Six78a88f72018-07-10 08:40:17 +0200577 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100578 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100579efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100580 const efi_guid_t *protocol_guid,
581 struct efi_handler **handler)
582{
583 struct efi_object *efiobj;
584 struct list_head *lhandle;
585
586 if (!handle || !protocol_guid)
587 return EFI_INVALID_PARAMETER;
588 efiobj = efi_search_obj(handle);
589 if (!efiobj)
590 return EFI_INVALID_PARAMETER;
591 list_for_each(lhandle, &efiobj->protocols) {
592 struct efi_handler *protocol;
593
594 protocol = list_entry(lhandle, struct efi_handler, link);
Heinrich Schuchardt66028932022-03-09 19:56:23 +0100595 if (!guidcmp(&protocol->guid, protocol_guid)) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100596 if (handler)
597 *handler = protocol;
598 return EFI_SUCCESS;
599 }
600 }
601 return EFI_NOT_FOUND;
602}
603
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200604/**
Mario Six78a88f72018-07-10 08:40:17 +0200605 * efi_remove_protocol() - delete protocol from a handle
606 * @handle: handle from which the protocol shall be deleted
607 * @protocol: GUID of the protocol to be deleted
608 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100609 *
Mario Six78a88f72018-07-10 08:40:17 +0200610 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100611 */
Ilias Apalodimas21eb7c12023-06-19 14:14:03 +0300612static efi_status_t efi_remove_protocol(const efi_handle_t handle,
613 const efi_guid_t *protocol,
614 void *protocol_interface)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100615{
616 struct efi_handler *handler;
617 efi_status_t ret;
618
619 ret = efi_search_protocol(handle, protocol, &handler);
620 if (ret != EFI_SUCCESS)
621 return ret;
Heinrich Schuchardt1f470e12018-05-11 12:09:21 +0200622 if (handler->protocol_interface != protocol_interface)
Heinrich Schuchardt96aa99c2019-05-10 20:06:48 +0200623 return EFI_NOT_FOUND;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100624 list_del(&handler->link);
625 free(handler);
626 return EFI_SUCCESS;
627}
628
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200629/**
Mario Six78a88f72018-07-10 08:40:17 +0200630 * efi_remove_all_protocols() - delete all protocols from a handle
631 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100632 *
Mario Six78a88f72018-07-10 08:40:17 +0200633 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100634 */
Heinrich Schuchardtbe678472023-02-10 08:50:06 +0100635static efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100636{
637 struct efi_object *efiobj;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100638 struct efi_handler *protocol;
639 struct efi_handler *pos;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100640
641 efiobj = efi_search_obj(handle);
642 if (!efiobj)
643 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100644 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100645 efi_status_t ret;
646
Ilias Apalodimas54edc372023-07-24 13:17:36 +0300647 ret = efi_uninstall_protocol(handle, &protocol->guid,
Ilias Apalodimascc889bd2023-08-24 17:21:09 +0300648 protocol->protocol_interface, true);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100649 if (ret != EFI_SUCCESS)
650 return ret;
651 }
652 return EFI_SUCCESS;
653}
654
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200655/**
Mario Six78a88f72018-07-10 08:40:17 +0200656 * efi_delete_handle() - delete handle
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100657 *
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +0200658 * @handle: handle to delete
Ilias Apalodimas54edc372023-07-24 13:17:36 +0300659 *
660 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100661 */
Ilias Apalodimas54edc372023-07-24 13:17:36 +0300662efi_status_t efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100663{
Etienne Carriere79325482022-09-07 10:20:13 +0200664 efi_status_t ret;
665
666 ret = efi_remove_all_protocols(handle);
Ilias Apalodimas54edc372023-07-24 13:17:36 +0300667 if (ret != EFI_SUCCESS) {
668 log_err("Handle %p has protocols installed. Unable to delete\n", handle);
669 return ret;
Etienne Carriere79325482022-09-07 10:20:13 +0200670 }
671
Ilias Apalodimascc889bd2023-08-24 17:21:09 +0300672 return efi_purge_handle(handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100673}
674
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200675/**
Mario Six78a88f72018-07-10 08:40:17 +0200676 * efi_is_event() - check if a pointer is a valid event
677 * @event: pointer to check
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100678 *
Mario Six78a88f72018-07-10 08:40:17 +0200679 * Return: status code
Alexander Grafbee91162016-03-04 01:09:59 +0100680 */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100681static efi_status_t efi_is_event(const struct efi_event *event)
682{
683 const struct efi_event *evt;
684
685 if (!event)
686 return EFI_INVALID_PARAMETER;
687 list_for_each_entry(evt, &efi_events, link) {
688 if (evt == event)
689 return EFI_SUCCESS;
690 }
691 return EFI_INVALID_PARAMETER;
692}
Alexander Grafbee91162016-03-04 01:09:59 +0100693
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200694/**
Mario Six78a88f72018-07-10 08:40:17 +0200695 * efi_create_event() - create an event
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +0200696 *
Mario Six78a88f72018-07-10 08:40:17 +0200697 * @type: type of the event to create
698 * @notify_tpl: task priority level of the event
699 * @notify_function: notification function of the event
700 * @notify_context: pointer passed to the notification function
701 * @group: event group
702 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200703 *
704 * This function is used inside U-Boot code to create an event.
705 *
706 * For the API function implementing the CreateEvent service see
707 * efi_create_event_ext.
708 *
Mario Six78a88f72018-07-10 08:40:17 +0200709 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200710 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100711efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200712 void (EFIAPI *notify_function) (
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200713 struct efi_event *event,
714 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100715 void *notify_context, efi_guid_t *group,
716 struct efi_event **event)
Alexander Grafbee91162016-03-04 01:09:59 +0100717{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100718 struct efi_event *evt;
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200719 efi_status_t ret;
720 int pool_type;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200721
Jonathan Graya95343b2017-03-12 19:26:07 +1100722 if (event == NULL)
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200723 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100724
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200725 switch (type) {
726 case 0:
727 case EVT_TIMER:
728 case EVT_NOTIFY_SIGNAL:
729 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
730 case EVT_NOTIFY_WAIT:
731 case EVT_TIMER | EVT_NOTIFY_WAIT:
732 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200733 pool_type = EFI_BOOT_SERVICES_DATA;
734 break;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200735 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200736 pool_type = EFI_RUNTIME_SERVICES_DATA;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200737 break;
738 default:
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200739 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200740 }
Jonathan Graya95343b2017-03-12 19:26:07 +1100741
Heinrich Schuchardt2cfb68f2021-01-06 12:55:22 +0100742 /*
743 * The UEFI specification requires event notification levels to be
744 * > TPL_APPLICATION and <= TPL_HIGH_LEVEL.
745 *
746 * Parameter NotifyTpl should not be checked if it is not used.
747 */
AKASHI Takahiro3748ed92018-08-10 15:36:32 +0900748 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardt2cfb68f2021-01-06 12:55:22 +0100749 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS ||
750 notify_tpl == TPL_APPLICATION))
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200751 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100752
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200753 ret = efi_allocate_pool(pool_type, sizeof(struct efi_event),
754 (void **)&evt);
755 if (ret != EFI_SUCCESS)
756 return ret;
757 memset(evt, 0, sizeof(struct efi_event));
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100758 evt->type = type;
759 evt->notify_tpl = notify_tpl;
760 evt->notify_function = notify_function;
761 evt->notify_context = notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100762 evt->group = group;
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200763 /* Disable timers on boot up */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100764 evt->trigger_next = -1ULL;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100765 list_add_tail(&evt->link, &efi_events);
766 *event = evt;
767 return EFI_SUCCESS;
Alexander Grafbee91162016-03-04 01:09:59 +0100768}
769
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200770/*
Mario Six78a88f72018-07-10 08:40:17 +0200771 * efi_create_event_ex() - create an event in a group
Heinrich Schuchardtbe678472023-02-10 08:50:06 +0100772 *
Mario Six78a88f72018-07-10 08:40:17 +0200773 * @type: type of the event to create
774 * @notify_tpl: task priority level of the event
775 * @notify_function: notification function of the event
776 * @notify_context: pointer passed to the notification function
777 * @event: created event
778 * @event_group: event group
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100779 *
780 * This function implements the CreateEventEx service.
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100781 *
Mario Six78a88f72018-07-10 08:40:17 +0200782 * See the Unified Extensible Firmware Interface (UEFI) specification for
783 * details.
784 *
785 * Return: status code
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100786 */
Heinrich Schuchardtbe678472023-02-10 08:50:06 +0100787static
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100788efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
789 void (EFIAPI *notify_function) (
790 struct efi_event *event,
791 void *context),
792 void *notify_context,
793 efi_guid_t *event_group,
794 struct efi_event **event)
795{
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200796 efi_status_t ret;
797
Heinrich Schuchardtce00a742022-01-16 14:15:31 +0100798 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUs", type, notify_tpl, notify_function,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100799 notify_context, event_group);
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200800
801 /*
802 * The allowable input parameters are the same as in CreateEvent()
803 * except for the following two disallowed event types.
804 */
805 switch (type) {
806 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
807 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
808 ret = EFI_INVALID_PARAMETER;
809 goto out;
810 }
811
812 ret = efi_create_event(type, notify_tpl, notify_function,
813 notify_context, event_group, event);
814out:
815 return EFI_EXIT(ret);
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100816}
817
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200818/**
Mario Six78a88f72018-07-10 08:40:17 +0200819 * efi_create_event_ext() - create an event
820 * @type: type of the event to create
821 * @notify_tpl: task priority level of the event
822 * @notify_function: notification function of the event
823 * @notify_context: pointer passed to the notification function
824 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200825 *
826 * This function implements the CreateEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200827 *
Mario Six78a88f72018-07-10 08:40:17 +0200828 * See the Unified Extensible Firmware Interface (UEFI) specification for
829 * details.
830 *
831 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200832 */
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200833static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100834 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200835 void (EFIAPI *notify_function) (
836 struct efi_event *event,
837 void *context),
838 void *notify_context, struct efi_event **event)
839{
840 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
841 notify_context);
842 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100843 notify_context, NULL, event));
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200844}
845
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200846/**
Mario Six78a88f72018-07-10 08:40:17 +0200847 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200848 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200849 * Check if a timer event has occurred or a queued notification function should
850 * be called.
851 *
Alexander Grafbee91162016-03-04 01:09:59 +0100852 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200853 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafbee91162016-03-04 01:09:59 +0100854 */
855void efi_timer_check(void)
856{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100857 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +0100858 u64 now = timer_get_us();
859
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100860 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200861 if (!timers_enabled)
862 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100863 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200864 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100865 switch (evt->trigger_type) {
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200866 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100867 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200868 break;
869 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100870 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200871 break;
872 default:
873 continue;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200874 }
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100875 evt->is_signaled = false;
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200876 efi_signal_event(evt);
Alexander Grafbee91162016-03-04 01:09:59 +0100877 }
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200878 efi_process_event_queue();
Stefan Roese29caf932022-09-02 14:10:46 +0200879 schedule();
Alexander Grafbee91162016-03-04 01:09:59 +0100880}
881
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200882/**
Mario Six78a88f72018-07-10 08:40:17 +0200883 * efi_set_timer() - set the trigger time for a timer event or stop the event
884 * @event: event for which the timer is set
885 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200886 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200887 *
888 * This is the function for internal usage in U-Boot. For the API function
889 * implementing the SetTimer service see efi_set_timer_ext.
890 *
Mario Six78a88f72018-07-10 08:40:17 +0200891 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200892 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200893efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200894 uint64_t trigger_time)
Alexander Grafbee91162016-03-04 01:09:59 +0100895{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100896 /* Check that the event is valid */
897 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
898 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100899
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200900 /*
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200901 * The parameter defines a multiple of 100 ns.
902 * We use multiples of 1000 ns. So divide by 10.
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200903 */
Heinrich Schuchardt7d963322017-10-05 16:14:14 +0200904 do_div(trigger_time, 10);
Alexander Grafbee91162016-03-04 01:09:59 +0100905
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100906 switch (type) {
907 case EFI_TIMER_STOP:
908 event->trigger_next = -1ULL;
909 break;
910 case EFI_TIMER_PERIODIC:
911 case EFI_TIMER_RELATIVE:
912 event->trigger_next = timer_get_us() + trigger_time;
913 break;
914 default:
915 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100916 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100917 event->trigger_type = type;
918 event->trigger_time = trigger_time;
919 event->is_signaled = false;
920 return EFI_SUCCESS;
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200921}
922
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200923/**
Mario Six78a88f72018-07-10 08:40:17 +0200924 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
925 * event
926 * @event: event for which the timer is set
927 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200928 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200929 *
930 * This function implements the SetTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200931 *
Mario Six78a88f72018-07-10 08:40:17 +0200932 * See the Unified Extensible Firmware Interface (UEFI) specification for
933 * details.
934 *
935 *
936 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200937 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200938static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
939 enum efi_timer_delay type,
940 uint64_t trigger_time)
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200941{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900942 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200943 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
Alexander Grafbee91162016-03-04 01:09:59 +0100944}
945
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200946/**
Mario Six78a88f72018-07-10 08:40:17 +0200947 * efi_wait_for_event() - wait for events to be signaled
948 * @num_events: number of events to be waited for
949 * @event: events to be waited for
950 * @index: index of the event that was signaled
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200951 *
952 * This function implements the WaitForEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200953 *
Mario Six78a88f72018-07-10 08:40:17 +0200954 * See the Unified Extensible Firmware Interface (UEFI) specification for
955 * details.
956 *
957 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200958 */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100959static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200960 struct efi_event **event,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100961 efi_uintn_t *index)
Alexander Grafbee91162016-03-04 01:09:59 +0100962{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100963 int i;
Alexander Grafbee91162016-03-04 01:09:59 +0100964
Heinrich Schuchardte9df5492022-02-03 22:21:51 +0100965 EFI_ENTRY("%zu, %p, %p", num_events, event, index);
Alexander Grafbee91162016-03-04 01:09:59 +0100966
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200967 /* Check parameters */
968 if (!num_events || !event)
969 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200970 /* Check TPL */
971 if (efi_tpl != TPL_APPLICATION)
972 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200973 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100974 if (efi_is_event(event[i]) != EFI_SUCCESS)
975 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200976 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
977 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200978 if (!event[i]->is_signaled)
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200979 efi_queue_event(event[i]);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200980 }
981
982 /* Wait for signal */
983 for (;;) {
984 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200985 if (event[i]->is_signaled)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200986 goto out;
987 }
988 /* Allow events to occur. */
989 efi_timer_check();
990 }
991
992out:
993 /*
994 * Reset the signal which is passed to the caller to allow periodic
995 * events to occur.
996 */
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200997 event[i]->is_signaled = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200998 if (index)
999 *index = i;
Alexander Grafbee91162016-03-04 01:09:59 +01001000
1001 return EFI_EXIT(EFI_SUCCESS);
1002}
1003
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001004/**
Mario Six78a88f72018-07-10 08:40:17 +02001005 * efi_signal_event_ext() - signal an EFI event
1006 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001007 *
1008 * This function implements the SignalEvent service.
Mario Six78a88f72018-07-10 08:40:17 +02001009 *
1010 * See the Unified Extensible Firmware Interface (UEFI) specification for
1011 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001012 *
1013 * This functions sets the signaled state of the event and queues the
1014 * notification function for execution.
1015 *
Mario Six78a88f72018-07-10 08:40:17 +02001016 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001017 */
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02001018static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +01001019{
1020 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001021 if (efi_is_event(event) != EFI_SUCCESS)
1022 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001023 efi_signal_event(event);
Alexander Grafbee91162016-03-04 01:09:59 +01001024 return EFI_EXIT(EFI_SUCCESS);
1025}
1026
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001027/**
Mario Six78a88f72018-07-10 08:40:17 +02001028 * efi_close_event() - close an EFI event
1029 * @event: event to close
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001030 *
1031 * This function implements the CloseEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001032 *
Mario Six78a88f72018-07-10 08:40:17 +02001033 * See the Unified Extensible Firmware Interface (UEFI) specification for
1034 * details.
1035 *
1036 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001037 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +02001038static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +01001039{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001040 struct efi_register_notify_event *item, *next;
1041
Alexander Grafbee91162016-03-04 01:09:59 +01001042 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001043 if (efi_is_event(event) != EFI_SUCCESS)
1044 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001045
1046 /* Remove protocol notify registrations for the event */
1047 list_for_each_entry_safe(item, next, &efi_register_notify_events,
1048 link) {
1049 if (event == item->event) {
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001050 struct efi_protocol_notification *hitem, *hnext;
1051
1052 /* Remove signaled handles */
1053 list_for_each_entry_safe(hitem, hnext, &item->handles,
1054 link) {
1055 list_del(&hitem->link);
1056 free(hitem);
1057 }
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001058 list_del(&item->link);
1059 free(item);
1060 }
1061 }
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +02001062 /* Remove event from queue */
1063 if (efi_event_is_queued(event))
1064 list_del(&event->queue_link);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001065
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001066 list_del(&event->link);
Heinrich Schuchardt14b40482019-07-11 20:15:09 +02001067 efi_free_pool(event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001068 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01001069}
1070
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001071/**
Mario Six78a88f72018-07-10 08:40:17 +02001072 * efi_check_event() - check if an event is signaled
1073 * @event: event to check
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001074 *
1075 * This function implements the CheckEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001076 *
Mario Six78a88f72018-07-10 08:40:17 +02001077 * See the Unified Extensible Firmware Interface (UEFI) specification for
1078 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001079 *
Mario Six78a88f72018-07-10 08:40:17 +02001080 * If an event is not signaled yet, the notification function is queued. The
1081 * signaled state is cleared.
1082 *
1083 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001084 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +02001085static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +01001086{
1087 EFI_ENTRY("%p", event);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02001088 efi_timer_check();
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001089 if (efi_is_event(event) != EFI_SUCCESS ||
1090 event->type & EVT_NOTIFY_SIGNAL)
1091 return EFI_EXIT(EFI_INVALID_PARAMETER);
1092 if (!event->is_signaled)
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001093 efi_queue_event(event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001094 if (event->is_signaled) {
1095 event->is_signaled = false;
1096 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02001097 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001098 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafbee91162016-03-04 01:09:59 +01001099}
1100
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001101/**
Mario Six78a88f72018-07-10 08:40:17 +02001102 * efi_search_obj() - find the internal EFI object for a handle
1103 * @handle: handle to find
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001104 *
Mario Six78a88f72018-07-10 08:40:17 +02001105 * Return: EFI object
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001106 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001107struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001108{
Heinrich Schuchardt1b681532017-11-06 21:17:50 +01001109 struct efi_object *efiobj;
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001110
Heinrich Schuchardtec163fa2019-05-05 10:37:51 +02001111 if (!handle)
1112 return NULL;
1113
Heinrich Schuchardt1b681532017-11-06 21:17:50 +01001114 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001115 if (efiobj == handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001116 return efiobj;
1117 }
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +02001118 return NULL;
1119}
1120
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001121/**
Mario Six78a88f72018-07-10 08:40:17 +02001122 * efi_open_protocol_info_entry() - create open protocol info entry and add it
1123 * to a protocol
1124 * @handler: handler of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001125 *
Mario Six78a88f72018-07-10 08:40:17 +02001126 * Return: open protocol info entry
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001127 */
1128static struct efi_open_protocol_info_entry *efi_create_open_info(
1129 struct efi_handler *handler)
1130{
1131 struct efi_open_protocol_info_item *item;
1132
1133 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
1134 if (!item)
1135 return NULL;
1136 /* Append the item to the open protocol info list. */
1137 list_add_tail(&item->link, &handler->open_infos);
1138
1139 return &item->info;
1140}
1141
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001142/**
Mario Six78a88f72018-07-10 08:40:17 +02001143 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1144 * @item: open protocol info entry to delete
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001145 *
Mario Six78a88f72018-07-10 08:40:17 +02001146 * Return: status code
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001147 */
1148static efi_status_t efi_delete_open_info(
1149 struct efi_open_protocol_info_item *item)
1150{
1151 list_del(&item->link);
1152 free(item);
1153 return EFI_SUCCESS;
1154}
1155
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001156/**
Mario Six78a88f72018-07-10 08:40:17 +02001157 * efi_add_protocol() - install new protocol on a handle
1158 * @handle: handle on which the protocol shall be installed
1159 * @protocol: GUID of the protocol to be installed
1160 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001161 *
Mario Six78a88f72018-07-10 08:40:17 +02001162 * Return: status code
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001163 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001164efi_status_t efi_add_protocol(const efi_handle_t handle,
1165 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001166 void *protocol_interface)
1167{
1168 struct efi_object *efiobj;
1169 struct efi_handler *handler;
1170 efi_status_t ret;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001171 struct efi_register_notify_event *event;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001172
1173 efiobj = efi_search_obj(handle);
1174 if (!efiobj)
1175 return EFI_INVALID_PARAMETER;
1176 ret = efi_search_protocol(handle, protocol, NULL);
1177 if (ret != EFI_NOT_FOUND)
1178 return EFI_INVALID_PARAMETER;
1179 handler = calloc(1, sizeof(struct efi_handler));
1180 if (!handler)
1181 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt66028932022-03-09 19:56:23 +01001182 memcpy((void *)&handler->guid, protocol, sizeof(efi_guid_t));
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001183 handler->protocol_interface = protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001184 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001185 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001186
1187 /* Notify registered events */
1188 list_for_each_entry(event, &efi_register_notify_events, link) {
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001189 if (!guidcmp(protocol, &event->protocol)) {
1190 struct efi_protocol_notification *notif;
1191
1192 notif = calloc(1, sizeof(*notif));
1193 if (!notif) {
1194 list_del(&handler->link);
1195 free(handler);
1196 return EFI_OUT_OF_RESOURCES;
1197 }
1198 notif->handle = handle;
1199 list_add_tail(&notif->link, &event->handles);
Heinrich Schuchardtdaa3f842019-06-07 07:43:24 +02001200 event->event->is_signaled = false;
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001201 efi_signal_event(event->event);
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001202 }
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001203 }
1204
Heinrich Schuchardtd5504142018-01-11 08:16:01 +01001205 if (!guidcmp(&efi_guid_device_path, protocol))
1206 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001207 return EFI_SUCCESS;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001208}
1209
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001210/**
Mario Six78a88f72018-07-10 08:40:17 +02001211 * efi_install_protocol_interface() - install protocol interface
1212 * @handle: handle on which the protocol shall be installed
1213 * @protocol: GUID of the protocol to be installed
1214 * @protocol_interface_type: type of the interface to be installed,
1215 * always EFI_NATIVE_INTERFACE
1216 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001217 *
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001218 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001219 *
Mario Six78a88f72018-07-10 08:40:17 +02001220 * See the Unified Extensible Firmware Interface (UEFI) specification for
1221 * details.
1222 *
1223 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001224 */
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001225static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02001226 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001227 int protocol_interface_type, void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001228{
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001229 efi_status_t r;
1230
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01001231 EFI_ENTRY("%p, %pUs, %d, %p", handle, protocol, protocol_interface_type,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001232 protocol_interface);
1233
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001234 if (!handle || !protocol ||
1235 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1236 r = EFI_INVALID_PARAMETER;
1237 goto out;
1238 }
1239
1240 /* Create new handle if requested. */
1241 if (!*handle) {
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +02001242 r = efi_create_handle(handle);
1243 if (r != EFI_SUCCESS)
1244 goto out;
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02001245 EFI_PRINT("new handle %p\n", *handle);
Heinrich Schuchardtaf1408e2017-10-26 19:25:43 +02001246 } else {
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02001247 EFI_PRINT("handle %p\n", *handle);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001248 }
Heinrich Schuchardt12025302017-10-26 19:25:54 +02001249 /* Add new protocol */
1250 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001251out:
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001252 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001253}
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001254
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001255/**
Mario Six78a88f72018-07-10 08:40:17 +02001256 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001257 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001258 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001259 * @number_of_drivers: number of child controllers
1260 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001261 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001262 * The allocated buffer has to be freed with free().
1263 *
Mario Six78a88f72018-07-10 08:40:17 +02001264 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001265 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001266static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001267 const efi_guid_t *protocol,
1268 efi_uintn_t *number_of_drivers,
1269 efi_handle_t **driver_handle_buffer)
1270{
1271 struct efi_handler *handler;
1272 struct efi_open_protocol_info_item *item;
1273 efi_uintn_t count = 0, i;
1274 bool duplicate;
1275
1276 /* Count all driver associations */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001277 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt66028932022-03-09 19:56:23 +01001278 if (protocol && guidcmp(&handler->guid, protocol))
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001279 continue;
1280 list_for_each_entry(item, &handler->open_infos, link) {
1281 if (item->info.attributes &
1282 EFI_OPEN_PROTOCOL_BY_DRIVER)
1283 ++count;
1284 }
1285 }
Heinrich Schuchardt66ca24a2019-06-02 01:43:33 +02001286 *number_of_drivers = 0;
1287 if (!count) {
1288 *driver_handle_buffer = NULL;
1289 return EFI_SUCCESS;
1290 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001291 /*
1292 * Create buffer. In case of duplicate driver assignments the buffer
1293 * will be too large. But that does not harm.
1294 */
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001295 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1296 if (!*driver_handle_buffer)
1297 return EFI_OUT_OF_RESOURCES;
1298 /* Collect unique driver handles */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001299 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt66028932022-03-09 19:56:23 +01001300 if (protocol && guidcmp(&handler->guid, protocol))
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001301 continue;
1302 list_for_each_entry(item, &handler->open_infos, link) {
1303 if (item->info.attributes &
1304 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1305 /* Check this is a new driver */
1306 duplicate = false;
1307 for (i = 0; i < *number_of_drivers; ++i) {
1308 if ((*driver_handle_buffer)[i] ==
1309 item->info.agent_handle)
1310 duplicate = true;
1311 }
1312 /* Copy handle to buffer */
1313 if (!duplicate) {
1314 i = (*number_of_drivers)++;
1315 (*driver_handle_buffer)[i] =
1316 item->info.agent_handle;
1317 }
1318 }
1319 }
1320 }
1321 return EFI_SUCCESS;
1322}
1323
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001324/**
Mario Six78a88f72018-07-10 08:40:17 +02001325 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001326 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001327 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001328 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001329 *
1330 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001331 *
Mario Six78a88f72018-07-10 08:40:17 +02001332 * See the Unified Extensible Firmware Interface (UEFI) specification for
1333 * details.
1334 *
1335 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001336 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001337static efi_status_t efi_disconnect_all_drivers
1338 (efi_handle_t handle,
1339 const efi_guid_t *protocol,
1340 efi_handle_t child_handle)
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001341{
Ilias Apalodimas239d59a2023-06-20 09:19:28 +03001342 efi_uintn_t number_of_drivers, tmp;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001343 efi_handle_t *driver_handle_buffer;
1344 efi_status_t r, ret;
1345
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001346 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001347 &driver_handle_buffer);
1348 if (ret != EFI_SUCCESS)
1349 return ret;
Heinrich Schuchardt66ca24a2019-06-02 01:43:33 +02001350 if (!number_of_drivers)
1351 return EFI_SUCCESS;
Ilias Apalodimas239d59a2023-06-20 09:19:28 +03001352
1353 tmp = number_of_drivers;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001354 while (number_of_drivers) {
Ilias Apalodimas239d59a2023-06-20 09:19:28 +03001355 ret = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001356 handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001357 driver_handle_buffer[--number_of_drivers],
1358 child_handle));
Ilias Apalodimas239d59a2023-06-20 09:19:28 +03001359 if (ret != EFI_SUCCESS)
1360 goto reconnect;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001361 }
Ilias Apalodimas239d59a2023-06-20 09:19:28 +03001362
1363 free(driver_handle_buffer);
1364 return ret;
1365
1366reconnect:
1367 /* Reconnect all disconnected drivers */
1368 for (; number_of_drivers < tmp; number_of_drivers++) {
1369 r = EFI_CALL(efi_connect_controller(handle,
1370 &driver_handle_buffer[number_of_drivers],
1371 NULL, true));
1372 if (r != EFI_SUCCESS)
1373 EFI_PRINT("Failed to reconnect controller\n");
1374 }
1375
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001376 free(driver_handle_buffer);
1377 return ret;
1378}
1379
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001380/**
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001381 * efi_uninstall_protocol() - uninstall protocol interface
1382 *
Mario Six78a88f72018-07-10 08:40:17 +02001383 * @handle: handle from which the protocol shall be removed
1384 * @protocol: GUID of the protocol to be removed
1385 * @protocol_interface: interface to be removed
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03001386 * @preserve: preserve or delete the handle and remove it from any
1387 * list it participates if no protocols remain
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001388 *
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001389 * This function DOES NOT delete a handle without installed protocol.
Mario Six78a88f72018-07-10 08:40:17 +02001390 *
1391 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001392 */
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001393static efi_status_t efi_uninstall_protocol
1394 (efi_handle_t handle, const efi_guid_t *protocol,
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03001395 void *protocol_interface, bool preserve)
Alexander Grafbee91162016-03-04 01:09:59 +01001396{
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001397 struct efi_handler *handler;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001398 struct efi_open_protocol_info_item *item;
1399 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001400 efi_status_t r;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001401
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001402 /* Find the protocol on the handle */
1403 r = efi_search_protocol(handle, protocol, &handler);
1404 if (r != EFI_SUCCESS)
1405 goto out;
Ilias Apalodimas748cb552023-06-20 09:19:30 +03001406 if (handler->protocol_interface != protocol_interface)
1407 return EFI_NOT_FOUND;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001408 /* Disconnect controllers */
Heinrich Schuchardt62870212023-06-18 09:00:45 +02001409 r = efi_disconnect_all_drivers(handle, protocol, NULL);
Ilias Apalodimas747d16d2023-06-20 09:19:29 +03001410 if (r != EFI_SUCCESS) {
1411 r = EFI_ACCESS_DENIED;
1412 goto out;
1413 }
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001414 /* Close protocol */
1415 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1416 if (item->info.attributes ==
1417 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1418 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1419 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
Ilias Apalodimas747d16d2023-06-20 09:19:29 +03001420 efi_delete_open_info(item);
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001421 }
Ilias Apalodimas747d16d2023-06-20 09:19:29 +03001422 /* if agents didn't close the protocols properly */
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001423 if (!list_empty(&handler->open_infos)) {
1424 r = EFI_ACCESS_DENIED;
Ilias Apalodimas747d16d2023-06-20 09:19:29 +03001425 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001426 goto out;
1427 }
1428 r = efi_remove_protocol(handle, protocol, protocol_interface);
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03001429 if (r != EFI_SUCCESS)
1430 return r;
1431 /*
1432 * We don't care about the return value here since the
1433 * handle might have more protocols installed
1434 */
1435 if (!preserve)
1436 efi_purge_handle(handle);
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001437out:
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001438 return r;
1439}
1440
1441/**
1442 * efi_uninstall_protocol_interface() - uninstall protocol interface
1443 * @handle: handle from which the protocol shall be removed
1444 * @protocol: GUID of the protocol to be removed
1445 * @protocol_interface: interface to be removed
1446 *
1447 * This function implements the UninstallProtocolInterface service.
1448 *
1449 * See the Unified Extensible Firmware Interface (UEFI) specification for
1450 * details.
1451 *
1452 * Return: status code
1453 */
1454static efi_status_t EFIAPI efi_uninstall_protocol_interface
1455 (efi_handle_t handle, const efi_guid_t *protocol,
1456 void *protocol_interface)
1457{
1458 efi_status_t ret;
1459
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01001460 EFI_ENTRY("%p, %pUs, %p", handle, protocol, protocol_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001461
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03001462 ret = efi_uninstall_protocol(handle, protocol, protocol_interface, false);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001463 if (ret != EFI_SUCCESS)
1464 goto out;
1465
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001466out:
1467 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001468}
1469
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001470/**
Mario Six78a88f72018-07-10 08:40:17 +02001471 * efi_register_protocol_notify() - register an event for notification when a
1472 * protocol is installed.
1473 * @protocol: GUID of the protocol whose installation shall be notified
1474 * @event: event to be signaled upon installation of the protocol
1475 * @registration: key for retrieving the registration information
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001476 *
1477 * This function implements the RegisterProtocolNotify service.
1478 * See the Unified Extensible Firmware Interface (UEFI) specification
1479 * for details.
1480 *
Mario Six78a88f72018-07-10 08:40:17 +02001481 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001482 */
Jose Marinho64a8aae2021-03-02 17:26:38 +00001483efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
1484 struct efi_event *event,
1485 void **registration)
Alexander Grafbee91162016-03-04 01:09:59 +01001486{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001487 struct efi_register_notify_event *item;
1488 efi_status_t ret = EFI_SUCCESS;
1489
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01001490 EFI_ENTRY("%pUs, %p, %p", protocol, event, registration);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001491
1492 if (!protocol || !event || !registration) {
1493 ret = EFI_INVALID_PARAMETER;
1494 goto out;
1495 }
1496
1497 item = calloc(1, sizeof(struct efi_register_notify_event));
1498 if (!item) {
1499 ret = EFI_OUT_OF_RESOURCES;
1500 goto out;
1501 }
1502
1503 item->event = event;
Sughosh Ganu61e42d92019-12-29 00:01:04 +05301504 guidcpy(&item->protocol, protocol);
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001505 INIT_LIST_HEAD(&item->handles);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001506
1507 list_add_tail(&item->link, &efi_register_notify_events);
1508
1509 *registration = item;
1510out:
1511 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001512}
1513
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001514/**
Mario Six78a88f72018-07-10 08:40:17 +02001515 * efi_search() - determine if an EFI handle implements a protocol
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +02001516 *
Mario Six78a88f72018-07-10 08:40:17 +02001517 * @search_type: selection criterion
1518 * @protocol: GUID of the protocol
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001519 * @handle: handle
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001520 *
1521 * See the documentation of the LocateHandle service in the UEFI specification.
1522 *
Mario Six78a88f72018-07-10 08:40:17 +02001523 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001524 */
Alexander Grafbee91162016-03-04 01:09:59 +01001525static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001526 const efi_guid_t *protocol, efi_handle_t handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001527{
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001528 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01001529
1530 switch (search_type) {
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001531 case ALL_HANDLES:
Alexander Grafbee91162016-03-04 01:09:59 +01001532 return 0;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001533 case BY_PROTOCOL:
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001534 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001535 return (ret != EFI_SUCCESS);
1536 default:
1537 /* Invalid search type */
Alexander Grafbee91162016-03-04 01:09:59 +01001538 return -1;
1539 }
Alexander Grafbee91162016-03-04 01:09:59 +01001540}
1541
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001542/**
Heinrich Schuchardtb8abd742019-05-29 07:46:33 +02001543 * efi_check_register_notify_event() - check if registration key is valid
1544 *
1545 * Check that a pointer is a valid registration key as returned by
1546 * RegisterProtocolNotify().
1547 *
1548 * @key: registration key
1549 * Return: valid registration key or NULL
1550 */
1551static struct efi_register_notify_event *efi_check_register_notify_event
1552 (void *key)
1553{
1554 struct efi_register_notify_event *event;
1555
1556 list_for_each_entry(event, &efi_register_notify_events, link) {
1557 if (event == (struct efi_register_notify_event *)key)
1558 return event;
1559 }
1560 return NULL;
1561}
1562
1563/**
Mario Six78a88f72018-07-10 08:40:17 +02001564 * efi_locate_handle() - locate handles implementing a protocol
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001565 *
1566 * @search_type: selection criterion
1567 * @protocol: GUID of the protocol
1568 * @search_key: registration key
1569 * @buffer_size: size of the buffer to receive the handles in bytes
1570 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001571 *
1572 * This function is meant for U-Boot internal calls. For the API implementation
1573 * of the LocateHandle service see efi_locate_handle_ext.
1574 *
Mario Six78a88f72018-07-10 08:40:17 +02001575 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001576 */
xypron.glpk@gmx.deebf199b2017-08-09 20:55:00 +02001577static efi_status_t efi_locate_handle(
Alexander Grafbee91162016-03-04 01:09:59 +01001578 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001579 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001580 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01001581{
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001582 struct efi_object *efiobj;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001583 efi_uintn_t size = 0;
Heinrich Schuchardtb8abd742019-05-29 07:46:33 +02001584 struct efi_register_notify_event *event;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001585 struct efi_protocol_notification *handle = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01001586
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001587 /* Check parameters */
1588 switch (search_type) {
1589 case ALL_HANDLES:
1590 break;
1591 case BY_REGISTER_NOTIFY:
1592 if (!search_key)
1593 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001594 /* Check that the registration key is valid */
Heinrich Schuchardtb8abd742019-05-29 07:46:33 +02001595 event = efi_check_register_notify_event(search_key);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001596 if (!event)
1597 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001598 break;
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001599 case BY_PROTOCOL:
1600 if (!protocol)
1601 return EFI_INVALID_PARAMETER;
1602 break;
1603 default:
1604 return EFI_INVALID_PARAMETER;
1605 }
1606
Alexander Grafbee91162016-03-04 01:09:59 +01001607 /* Count how much space we need */
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001608 if (search_type == BY_REGISTER_NOTIFY) {
1609 if (list_empty(&event->handles))
1610 return EFI_NOT_FOUND;
1611 handle = list_first_entry(&event->handles,
1612 struct efi_protocol_notification,
1613 link);
1614 efiobj = handle->handle;
1615 size += sizeof(void *);
1616 } else {
1617 list_for_each_entry(efiobj, &efi_obj_list, link) {
1618 if (!efi_search(search_type, protocol, efiobj))
1619 size += sizeof(void *);
1620 }
1621 if (size == 0)
1622 return EFI_NOT_FOUND;
Alexander Grafbee91162016-03-04 01:09:59 +01001623 }
1624
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001625 if (!buffer_size)
1626 return EFI_INVALID_PARAMETER;
1627
Alexander Grafbee91162016-03-04 01:09:59 +01001628 if (*buffer_size < size) {
1629 *buffer_size = size;
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001630 return EFI_BUFFER_TOO_SMALL;
Alexander Grafbee91162016-03-04 01:09:59 +01001631 }
1632
Rob Clark796a78c2017-08-06 14:10:07 -04001633 *buffer_size = size;
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001634
Heinrich Schuchardt0a843192019-05-10 19:03:49 +02001635 /* The buffer size is sufficient but there is no buffer */
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001636 if (!buffer)
1637 return EFI_INVALID_PARAMETER;
Rob Clark796a78c2017-08-06 14:10:07 -04001638
Alexander Grafbee91162016-03-04 01:09:59 +01001639 /* Then fill the array */
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +02001640 if (search_type == BY_REGISTER_NOTIFY) {
1641 *buffer = efiobj;
1642 list_del(&handle->link);
1643 } else {
1644 list_for_each_entry(efiobj, &efi_obj_list, link) {
1645 if (!efi_search(search_type, protocol, efiobj))
1646 *buffer++ = efiobj;
1647 }
Alexander Grafbee91162016-03-04 01:09:59 +01001648 }
1649
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001650 return EFI_SUCCESS;
1651}
1652
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001653/**
Mario Six78a88f72018-07-10 08:40:17 +02001654 * efi_locate_handle_ext() - locate handles implementing a protocol.
1655 * @search_type: selection criterion
1656 * @protocol: GUID of the protocol
1657 * @search_key: registration key
1658 * @buffer_size: size of the buffer to receive the handles in bytes
1659 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001660 *
1661 * This function implements the LocateHandle service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001662 *
Mario Six78a88f72018-07-10 08:40:17 +02001663 * See the Unified Extensible Firmware Interface (UEFI) specification for
1664 * details.
1665 *
1666 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001667 */
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001668static efi_status_t EFIAPI efi_locate_handle_ext(
1669 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001670 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001671 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001672{
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01001673 EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001674 buffer_size, buffer);
1675
1676 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1677 buffer_size, buffer));
Alexander Grafbee91162016-03-04 01:09:59 +01001678}
1679
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001680/**
Mario Six78a88f72018-07-10 08:40:17 +02001681 * efi_remove_configuration_table() - collapses configuration table entries,
1682 * removing index i
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001683 *
Mario Six78a88f72018-07-10 08:40:17 +02001684 * @i: index of the table entry to be removed
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001685 */
Alexander Grafd98cdf62017-07-26 13:41:04 +02001686static void efi_remove_configuration_table(int i)
1687{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001688 struct efi_configuration_table *this = &systab.tables[i];
1689 struct efi_configuration_table *next = &systab.tables[i + 1];
1690 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Grafd98cdf62017-07-26 13:41:04 +02001691
1692 memmove(this, next, (ulong)end - (ulong)next);
1693 systab.nr_tables--;
1694}
1695
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001696/**
Mario Six78a88f72018-07-10 08:40:17 +02001697 * efi_install_configuration_table() - adds, updates, or removes a
1698 * configuration table
1699 * @guid: GUID of the installed table
1700 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001701 *
1702 * This function is used for internal calls. For the API implementation of the
1703 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1704 *
Mario Six78a88f72018-07-10 08:40:17 +02001705 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001706 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001707efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1708 void *table)
Alexander Grafbee91162016-03-04 01:09:59 +01001709{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001710 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +01001711 int i;
1712
Heinrich Schuchardteb68b4e2018-02-18 00:08:00 +01001713 if (!guid)
1714 return EFI_INVALID_PARAMETER;
1715
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001716 /* Check for GUID override */
Alexander Grafbee91162016-03-04 01:09:59 +01001717 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001718 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Grafd98cdf62017-07-26 13:41:04 +02001719 if (table)
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001720 systab.tables[i].table = table;
Alexander Grafd98cdf62017-07-26 13:41:04 +02001721 else
1722 efi_remove_configuration_table(i);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001723 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01001724 }
1725 }
1726
Alexander Grafd98cdf62017-07-26 13:41:04 +02001727 if (!table)
1728 return EFI_NOT_FOUND;
1729
Alexander Grafbee91162016-03-04 01:09:59 +01001730 /* No override, check for overflow */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001731 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Graf488bf122016-08-19 01:23:24 +02001732 return EFI_OUT_OF_RESOURCES;
Alexander Grafbee91162016-03-04 01:09:59 +01001733
1734 /* Add a new entry */
Sughosh Ganu61e42d92019-12-29 00:01:04 +05301735 guidcpy(&systab.tables[i].guid, guid);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001736 systab.tables[i].table = table;
Alexander Grafaba5e912016-08-19 01:23:30 +02001737 systab.nr_tables = i + 1;
Alexander Grafbee91162016-03-04 01:09:59 +01001738
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001739out:
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001740 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardt55d8ee32018-07-07 15:36:05 +02001741 efi_update_table_header_crc32(&systab.hdr);
1742
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001743 /* Notify that the configuration table was changed */
1744 list_for_each_entry(evt, &efi_events, link) {
1745 if (evt->group && !guidcmp(evt->group, guid)) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02001746 efi_signal_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001747 break;
1748 }
1749 }
1750
Alexander Graf488bf122016-08-19 01:23:24 +02001751 return EFI_SUCCESS;
1752}
1753
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001754/**
Mario Six78a88f72018-07-10 08:40:17 +02001755 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1756 * configuration table.
1757 * @guid: GUID of the installed table
1758 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001759 *
1760 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001761 *
Mario Six78a88f72018-07-10 08:40:17 +02001762 * See the Unified Extensible Firmware Interface (UEFI) specification for
1763 * details.
1764 *
1765 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001766 */
Masahisa Kojimaf86352e2021-10-22 20:24:24 +09001767static efi_status_t
1768EFIAPI efi_install_configuration_table_ext(const efi_guid_t *guid,
1769 void *table)
Alexander Graf488bf122016-08-19 01:23:24 +02001770{
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01001771 EFI_ENTRY("%pUs, %p", guid, table);
Alexander Graf488bf122016-08-19 01:23:24 +02001772 return EFI_EXIT(efi_install_configuration_table(guid, table));
Alexander Grafbee91162016-03-04 01:09:59 +01001773}
1774
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001775/**
Mario Six78a88f72018-07-10 08:40:17 +02001776 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001777 *
1778 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clark95c55532017-09-13 18:05:33 -04001779 * protocols, boot-device, etc.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001780 *
Heinrich Schuchardt6631ca52019-07-14 11:05:34 +02001781 * In case of an error \*handle_ptr and \*info_ptr are set to NULL and an error
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001782 * code is returned.
1783 *
1784 * @device_path: device path of the loaded image
1785 * @file_path: file path of the loaded image
1786 * @handle_ptr: handle of the loaded image
1787 * @info_ptr: loaded image protocol
1788 * Return: status code
Rob Clark95c55532017-09-13 18:05:33 -04001789 */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001790efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1791 struct efi_device_path *file_path,
1792 struct efi_loaded_image_obj **handle_ptr,
1793 struct efi_loaded_image **info_ptr)
Rob Clark95c55532017-09-13 18:05:33 -04001794{
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001795 efi_status_t ret;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001796 struct efi_loaded_image *info = NULL;
1797 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001798 struct efi_device_path *dp;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001799
1800 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1801 *handle_ptr = NULL;
1802 *info_ptr = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001803
1804 info = calloc(1, sizeof(*info));
1805 if (!info)
1806 return EFI_OUT_OF_RESOURCES;
1807 obj = calloc(1, sizeof(*obj));
1808 if (!obj) {
1809 free(info);
1810 return EFI_OUT_OF_RESOURCES;
1811 }
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02001812 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001813
Heinrich Schuchardt44549d62017-11-26 14:05:23 +01001814 /* Add internal object to object list */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001815 efi_add_handle(&obj->header);
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001816
Heinrich Schuchardt95147312018-07-05 08:17:58 +02001817 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Rob Clark95c55532017-09-13 18:05:33 -04001818 info->file_path = file_path;
Heinrich Schuchardt7e1effc2018-08-26 15:31:52 +02001819 info->system_table = &systab;
Rob Clark95c55532017-09-13 18:05:33 -04001820
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001821 if (device_path) {
Heinrich Schuchardte46ef1d2022-03-19 06:35:43 +01001822 info->device_handle = efi_dp_find_obj(device_path, NULL, NULL);
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001823
1824 dp = efi_dp_append(device_path, file_path);
1825 if (!dp) {
1826 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001827 goto failure;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001828 }
1829 } else {
1830 dp = NULL;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001831 }
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001832 ret = efi_add_protocol(&obj->header,
1833 &efi_guid_loaded_image_device_path, dp);
1834 if (ret != EFI_SUCCESS)
1835 goto failure;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001836
1837 /*
1838 * When asking for the loaded_image interface, just
1839 * return handle which points to loaded_image_info
1840 */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001841 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001842 &efi_guid_loaded_image, info);
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001843 if (ret != EFI_SUCCESS)
1844 goto failure;
1845
Heinrich Schuchardtd5974af2019-03-19 18:58:58 +01001846 *info_ptr = info;
1847 *handle_ptr = obj;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001848
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001849 return ret;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001850failure:
1851 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001852 efi_delete_handle(&obj->header);
1853 free(info);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001854 return ret;
Rob Clark95c55532017-09-13 18:05:33 -04001855}
1856
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001857/**
Heinrich Schuchardt0e9d2d72020-12-04 03:02:03 +01001858 * efi_locate_device_path() - Get the device path and handle of an device
1859 * implementing a protocol
1860 * @protocol: GUID of the protocol
1861 * @device_path: device path
1862 * @device: handle of the device
1863 *
1864 * This function implements the LocateDevicePath service.
1865 *
1866 * See the Unified Extensible Firmware Interface (UEFI) specification for
1867 * details.
1868 *
1869 * Return: status code
1870 */
AKASHI Takahirod8465ff2022-04-28 17:09:38 +09001871efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
1872 struct efi_device_path **device_path,
1873 efi_handle_t *device)
Heinrich Schuchardt0e9d2d72020-12-04 03:02:03 +01001874{
1875 struct efi_device_path *dp;
1876 size_t i;
1877 struct efi_handler *handler;
1878 efi_handle_t *handles;
1879 size_t len, len_dp;
1880 size_t len_best = 0;
1881 efi_uintn_t no_handles;
1882 u8 *remainder;
1883 efi_status_t ret;
1884
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01001885 EFI_ENTRY("%pUs, %p, %p", protocol, device_path, device);
Heinrich Schuchardt0e9d2d72020-12-04 03:02:03 +01001886
1887 if (!protocol || !device_path || !*device_path) {
1888 ret = EFI_INVALID_PARAMETER;
1889 goto out;
1890 }
1891
1892 /* Find end of device path */
1893 len = efi_dp_instance_size(*device_path);
1894
1895 /* Get all handles implementing the protocol */
1896 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
1897 &no_handles, &handles));
1898 if (ret != EFI_SUCCESS)
1899 goto out;
1900
1901 for (i = 0; i < no_handles; ++i) {
1902 /* Find the device path protocol */
1903 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
1904 &handler);
1905 if (ret != EFI_SUCCESS)
1906 continue;
1907 dp = (struct efi_device_path *)handler->protocol_interface;
1908 len_dp = efi_dp_instance_size(dp);
1909 /*
1910 * This handle can only be a better fit
1911 * if its device path length is longer than the best fit and
1912 * if its device path length is shorter of equal the searched
1913 * device path.
1914 */
1915 if (len_dp <= len_best || len_dp > len)
1916 continue;
1917 /* Check if dp is a subpath of device_path */
1918 if (memcmp(*device_path, dp, len_dp))
1919 continue;
1920 if (!device) {
1921 ret = EFI_INVALID_PARAMETER;
1922 goto out;
1923 }
1924 *device = handles[i];
1925 len_best = len_dp;
1926 }
1927 if (len_best) {
1928 remainder = (u8 *)*device_path + len_best;
1929 *device_path = (struct efi_device_path *)remainder;
1930 ret = EFI_SUCCESS;
1931 } else {
1932 ret = EFI_NOT_FOUND;
1933 }
1934out:
1935 return EFI_EXIT(ret);
1936}
1937
1938/**
Heinrich Schuchardt0e074d12020-12-06 10:47:57 +01001939 * efi_load_image_from_file() - load an image from file system
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001940 *
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001941 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1942 * callers obligation to update the memory type as needed.
1943 *
Heinrich Schuchardtc06c55b2020-12-04 09:27:41 +01001944 * @file_path: the path of the image to load
1945 * @buffer: buffer containing the loaded image
1946 * @size: size of the loaded image
1947 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001948 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09001949static
Heinrich Schuchardt0e074d12020-12-06 10:47:57 +01001950efi_status_t efi_load_image_from_file(struct efi_device_path *file_path,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001951 void **buffer, efi_uintn_t *size)
Rob Clark838ee4b2017-09-13 18:05:35 -04001952{
Rob Clark838ee4b2017-09-13 18:05:35 -04001953 struct efi_file_handle *f;
Heinrich Schuchardt0e074d12020-12-06 10:47:57 +01001954 efi_status_t ret;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001955 u64 addr;
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001956 efi_uintn_t bs;
Rob Clark838ee4b2017-09-13 18:05:35 -04001957
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001958 /* Open file */
Rob Clark838ee4b2017-09-13 18:05:35 -04001959 f = efi_file_from_path(file_path);
1960 if (!f)
Heinrich Schuchardt20000032019-06-11 19:00:56 +02001961 return EFI_NOT_FOUND;
Rob Clark838ee4b2017-09-13 18:05:35 -04001962
Ilias Apalodimasac30aad2021-03-25 21:55:16 +02001963 ret = efi_file_size(f, &bs);
Rob Clark838ee4b2017-09-13 18:05:35 -04001964 if (ret != EFI_SUCCESS)
1965 goto error;
1966
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001967 /*
1968 * When reading the file we do not yet know if it contains an
1969 * application, a boottime driver, or a runtime driver. So here we
1970 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1971 * update the reservation according to the image type.
1972 */
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001973 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1974 EFI_BOOT_SERVICES_DATA,
1975 efi_size_in_pages(bs), &addr);
Rob Clark838ee4b2017-09-13 18:05:35 -04001976 if (ret != EFI_SUCCESS) {
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001977 ret = EFI_OUT_OF_RESOURCES;
1978 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001979 }
1980
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001981 /* Read file */
1982 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1983 if (ret != EFI_SUCCESS)
1984 efi_free_pages(addr, efi_size_in_pages(bs));
1985 *buffer = (void *)(uintptr_t)addr;
1986 *size = bs;
1987error:
1988 EFI_CALL(f->close(f));
Rob Clark838ee4b2017-09-13 18:05:35 -04001989 return ret;
1990}
1991
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001992/**
Heinrich Schuchardt0e074d12020-12-06 10:47:57 +01001993 * efi_load_image_from_path() - load an image using a file path
1994 *
1995 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1996 * callers obligation to update the memory type as needed.
1997 *
1998 * @boot_policy: true for request originating from the boot manager
1999 * @file_path: the path of the image to load
2000 * @buffer: buffer containing the loaded image
2001 * @size: size of the loaded image
2002 * Return: status code
2003 */
2004static
2005efi_status_t efi_load_image_from_path(bool boot_policy,
2006 struct efi_device_path *file_path,
2007 void **buffer, efi_uintn_t *size)
2008{
2009 efi_handle_t device;
2010 efi_status_t ret;
Heinrich Schuchardt9cdf4702022-02-26 12:05:30 +01002011 struct efi_device_path *dp, *rem;
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002012 struct efi_load_file_protocol *load_file_protocol = NULL;
2013 efi_uintn_t buffer_size;
2014 uint64_t addr, pages;
2015 const efi_guid_t *guid;
Heinrich Schuchardt15436fa2023-01-24 20:36:45 +01002016 struct efi_handler *handler;
Heinrich Schuchardt0e074d12020-12-06 10:47:57 +01002017
2018 /* In case of failure nothing is returned */
2019 *buffer = NULL;
2020 *size = 0;
2021
2022 dp = file_path;
Heinrich Schuchardt9cdf4702022-02-26 12:05:30 +01002023 device = efi_dp_find_obj(dp, NULL, &rem);
2024 ret = efi_search_protocol(device, &efi_simple_file_system_protocol_guid,
2025 NULL);
Heinrich Schuchardt0e074d12020-12-06 10:47:57 +01002026 if (ret == EFI_SUCCESS)
2027 return efi_load_image_from_file(file_path, buffer, size);
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002028
Heinrich Schuchardt9cdf4702022-02-26 12:05:30 +01002029 ret = efi_search_protocol(device, &efi_guid_load_file_protocol, NULL);
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002030 if (ret == EFI_SUCCESS) {
2031 guid = &efi_guid_load_file_protocol;
2032 } else if (!boot_policy) {
2033 guid = &efi_guid_load_file2_protocol;
Heinrich Schuchardt9cdf4702022-02-26 12:05:30 +01002034 ret = efi_search_protocol(device, guid, NULL);
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002035 }
2036 if (ret != EFI_SUCCESS)
2037 return EFI_NOT_FOUND;
Heinrich Schuchardt15436fa2023-01-24 20:36:45 +01002038 ret = efi_search_protocol(device, guid, &handler);
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002039 if (ret != EFI_SUCCESS)
2040 return EFI_NOT_FOUND;
2041 buffer_size = 0;
Heinrich Schuchardt15436fa2023-01-24 20:36:45 +01002042 load_file_protocol = handler->protocol_interface;
Heinrich Schuchardt9cdf4702022-02-26 12:05:30 +01002043 ret = EFI_CALL(load_file_protocol->load_file(
2044 load_file_protocol, rem, boot_policy,
2045 &buffer_size, NULL));
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002046 if (ret != EFI_BUFFER_TOO_SMALL)
2047 goto out;
2048 pages = efi_size_in_pages(buffer_size);
2049 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, EFI_BOOT_SERVICES_DATA,
2050 pages, &addr);
2051 if (ret != EFI_SUCCESS) {
2052 ret = EFI_OUT_OF_RESOURCES;
2053 goto out;
2054 }
2055 ret = EFI_CALL(load_file_protocol->load_file(
Heinrich Schuchardt9cdf4702022-02-26 12:05:30 +01002056 load_file_protocol, rem, boot_policy,
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002057 &buffer_size, (void *)(uintptr_t)addr));
2058 if (ret != EFI_SUCCESS)
2059 efi_free_pages(addr, pages);
2060out:
Heinrich Schuchardtef185762022-10-07 15:18:15 +02002061 efi_close_protocol(device, guid, efi_root, NULL);
Heinrich Schuchardt3da0b282020-12-06 13:00:15 +01002062 if (ret == EFI_SUCCESS) {
2063 *buffer = (void *)(uintptr_t)addr;
2064 *size = buffer_size;
2065 }
2066
2067 return ret;
Heinrich Schuchardt0e074d12020-12-06 10:47:57 +01002068}
2069
2070/**
Mario Six78a88f72018-07-10 08:40:17 +02002071 * efi_load_image() - load an EFI image into memory
2072 * @boot_policy: true for request originating from the boot manager
2073 * @parent_image: the caller's image handle
2074 * @file_path: the path of the image to load
2075 * @source_buffer: memory location from which the image is installed
2076 * @source_size: size of the memory area from which the image is installed
2077 * @image_handle: handle for the newly installed image
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002078 *
2079 * This function implements the LoadImage service.
Mario Six78a88f72018-07-10 08:40:17 +02002080 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002081 * See the Unified Extensible Firmware Interface (UEFI) specification
2082 * for details.
2083 *
Mario Six78a88f72018-07-10 08:40:17 +02002084 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002085 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09002086efi_status_t EFIAPI efi_load_image(bool boot_policy,
2087 efi_handle_t parent_image,
2088 struct efi_device_path *file_path,
2089 void *source_buffer,
2090 efi_uintn_t source_size,
2091 efi_handle_t *image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01002092{
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01002093 struct efi_device_path *dp, *fp;
Tom Rini1c3b2f42018-09-30 10:38:15 -04002094 struct efi_loaded_image *info = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02002095 struct efi_loaded_image_obj **image_obj =
2096 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01002097 efi_status_t ret;
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01002098 void *dest_buffer;
Alexander Grafbee91162016-03-04 01:09:59 +01002099
Heinrich Schuchardte9df5492022-02-03 22:21:51 +01002100 EFI_ENTRY("%d, %p, %pD, %p, %zu, %p", boot_policy, parent_image,
Alexander Grafbee91162016-03-04 01:09:59 +01002101 file_path, source_buffer, source_size, image_handle);
Rob Clark838ee4b2017-09-13 18:05:35 -04002102
Heinrich Schuchardte4afcb22019-06-11 18:52:33 +02002103 if (!image_handle || (!source_buffer && !file_path) ||
2104 !efi_search_obj(parent_image) ||
2105 /* The parent image handle must refer to a loaded image */
2106 !parent_image->type) {
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +02002107 ret = EFI_INVALID_PARAMETER;
2108 goto error;
2109 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01002110
Rob Clark838ee4b2017-09-13 18:05:35 -04002111 if (!source_buffer) {
Heinrich Schuchardtc06c55b2020-12-04 09:27:41 +01002112 ret = efi_load_image_from_path(boot_policy, file_path,
2113 &dest_buffer, &source_size);
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01002114 if (ret != EFI_SUCCESS)
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01002115 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04002116 } else {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01002117 dest_buffer = source_buffer;
Rob Clark838ee4b2017-09-13 18:05:35 -04002118 }
Heinrich Schuchardt1e15a9c2019-04-20 19:24:43 +00002119 /* split file_path which contains both the device and file parts */
2120 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01002121 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01002122 if (ret == EFI_SUCCESS)
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09002123 ret = efi_load_pe(*image_obj, dest_buffer, source_size, info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01002124 if (!source_buffer)
2125 /* Release buffer to which file was loaded */
2126 efi_free_pages((uintptr_t)dest_buffer,
2127 efi_size_in_pages(source_size));
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09002128 if (ret == EFI_SUCCESS || ret == EFI_SECURITY_VIOLATION) {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01002129 info->system_table = &systab;
2130 info->parent_handle = parent_image;
2131 } else {
2132 /* The image is invalid. Release all associated resources. */
2133 efi_delete_handle(*image_handle);
2134 *image_handle = NULL;
2135 free(info);
2136 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01002137error:
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01002138 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002139}
2140
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002141/**
Alexander Graff31239a2018-11-15 21:23:47 +01002142 * efi_exit_caches() - fix up caches for EFI payloads if necessary
2143 */
2144static void efi_exit_caches(void)
2145{
Heinrich Schuchardt6f3badb2019-07-22 22:04:36 +02002146#if defined(CONFIG_EFI_GRUB_ARM32_WORKAROUND)
Alexander Graff31239a2018-11-15 21:23:47 +01002147 /*
Heinrich Schuchardt6f3badb2019-07-22 22:04:36 +02002148 * Boooting Linux via GRUB prior to version 2.04 fails on 32bit ARM if
2149 * caches are enabled.
2150 *
2151 * TODO:
2152 * According to the UEFI spec caches that can be managed via CP15
2153 * operations should be enabled. Caches requiring platform information
2154 * to manage should be disabled. This should not happen in
2155 * ExitBootServices() but before invoking any UEFI binary is invoked.
2156 *
2157 * We want to keep the current workaround while GRUB prior to version
2158 * 2.04 is still in use.
Alexander Graff31239a2018-11-15 21:23:47 +01002159 */
Heinrich Schuchardt6f3badb2019-07-22 22:04:36 +02002160 cleanup_before_linux();
Alexander Graff31239a2018-11-15 21:23:47 +01002161#endif
2162}
2163
2164/**
Mario Six78a88f72018-07-10 08:40:17 +02002165 * efi_exit_boot_services() - stop all boot services
2166 * @image_handle: handle of the loaded image
2167 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002168 *
2169 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02002170 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002171 * See the Unified Extensible Firmware Interface (UEFI) specification
2172 * for details.
2173 *
Mario Six78a88f72018-07-10 08:40:17 +02002174 * All timer events are disabled. For exit boot services events the
2175 * notification function is called. The boot services are disabled in the
2176 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01002177 *
Mario Six78a88f72018-07-10 08:40:17 +02002178 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002179 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002180static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02002181 efi_uintn_t map_key)
Alexander Grafbee91162016-03-04 01:09:59 +01002182{
Heinrich Schuchardt14b40482019-07-11 20:15:09 +02002183 struct efi_event *evt, *next_event;
Heinrich Schuchardt98967372019-06-11 20:05:40 +02002184 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02002185
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02002186 EFI_ENTRY("%p, %zx", image_handle, map_key);
Alexander Grafbee91162016-03-04 01:09:59 +01002187
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02002188 /* Check that the caller has read the current memory map */
Heinrich Schuchardt98967372019-06-11 20:05:40 +02002189 if (map_key != efi_memory_map_key) {
2190 ret = EFI_INVALID_PARAMETER;
2191 goto out;
2192 }
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02002193
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01002194 /* Check if ExitBootServices has already been called */
2195 if (!systab.boottime)
Heinrich Schuchardt98967372019-06-11 20:05:40 +02002196 goto out;
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01002197
Heinrich Schuchardt43eaf5b2021-11-16 18:46:27 +01002198 /* Notify EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES event group. */
2199 list_for_each_entry(evt, &efi_events, link) {
2200 if (evt->group &&
2201 !guidcmp(evt->group,
2202 &efi_guid_event_group_before_exit_boot_services)) {
2203 efi_signal_event(evt);
2204 break;
2205 }
2206 }
2207
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02002208 /* Stop all timer related activities */
2209 timers_enabled = false;
2210
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01002211 /* Add related events to the event group */
2212 list_for_each_entry(evt, &efi_events, link) {
2213 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
2214 evt->group = &efi_guid_event_group_exit_boot_services;
2215 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02002216 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01002217 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01002218 if (evt->group &&
2219 !guidcmp(evt->group,
2220 &efi_guid_event_group_exit_boot_services)) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02002221 efi_signal_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01002222 break;
2223 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02002224 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02002225
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +02002226 /* Make sure that notification functions are not called anymore */
2227 efi_tpl = TPL_HIGH_LEVEL;
2228
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +02002229 /* Notify variable services */
2230 efi_variables_boot_exit_notify();
Rob Clarkad644e72017-09-13 18:05:37 -04002231
Heinrich Schuchardt14b40482019-07-11 20:15:09 +02002232 /* Remove all events except EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
2233 list_for_each_entry_safe(evt, next_event, &efi_events, link) {
2234 if (evt->type != EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE)
2235 list_del(&evt->link);
2236 }
2237
Heinrich Schuchardtfccd3d92020-11-12 21:26:28 +01002238 if (!efi_st_keep_devices) {
Tom Rini3f73e792021-11-19 16:33:04 -05002239 bootm_disable_interrupts();
Heinrich Schuchardtdb6288d2020-12-27 15:33:09 +01002240 if (IS_ENABLED(CONFIG_USB_DEVICE))
Heinrich Schuchardtfccd3d92020-11-12 21:26:28 +01002241 udc_disconnect();
2242 board_quiesce_devices();
2243 dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
2244 }
Alexander Grafb7b84102016-11-17 01:02:57 +01002245
Heinrich Schuchardt7f951042019-07-05 17:42:16 +02002246 /* Patch out unsupported runtime function */
2247 efi_runtime_detach();
2248
Alexander Graff31239a2018-11-15 21:23:47 +01002249 /* Fix up caches for EFI payloads if necessary */
2250 efi_exit_caches();
2251
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002252 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01002253 systab.con_in_handle = NULL;
2254 systab.con_in = NULL;
2255 systab.con_out_handle = NULL;
2256 systab.con_out = NULL;
2257 systab.stderr_handle = NULL;
2258 systab.std_err = NULL;
2259 systab.boottime = NULL;
2260
2261 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02002262 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01002263
Alexander Grafbee91162016-03-04 01:09:59 +01002264 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002265 efi_set_watchdog(0);
Stefan Roese29caf932022-09-02 14:10:46 +02002266 schedule();
Heinrich Schuchardt98967372019-06-11 20:05:40 +02002267out:
Masahisa Kojimafdff03e2021-08-13 16:12:41 +09002268 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
2269 if (ret != EFI_SUCCESS)
2270 efi_tcg2_notify_exit_boot_services_failed();
2271 }
2272
Heinrich Schuchardt98967372019-06-11 20:05:40 +02002273 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002274}
2275
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002276/**
Mario Six78a88f72018-07-10 08:40:17 +02002277 * efi_get_next_monotonic_count() - get next value of the counter
2278 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002279 *
2280 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002281 *
Mario Six78a88f72018-07-10 08:40:17 +02002282 * See the Unified Extensible Firmware Interface (UEFI) specification for
2283 * details.
2284 *
2285 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002286 */
Alexander Grafbee91162016-03-04 01:09:59 +01002287static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
2288{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002289 static uint64_t mono;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002290 efi_status_t ret;
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002291
Alexander Grafbee91162016-03-04 01:09:59 +01002292 EFI_ENTRY("%p", count);
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002293 if (!count) {
2294 ret = EFI_INVALID_PARAMETER;
2295 goto out;
2296 }
Alexander Grafbee91162016-03-04 01:09:59 +01002297 *count = mono++;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02002298 ret = EFI_SUCCESS;
2299out:
2300 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002301}
2302
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002303/**
Mario Six78a88f72018-07-10 08:40:17 +02002304 * efi_stall() - sleep
2305 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002306 *
Mario Six78a88f72018-07-10 08:40:17 +02002307 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002308 *
Mario Six78a88f72018-07-10 08:40:17 +02002309 * See the Unified Extensible Firmware Interface (UEFI) specification for
2310 * details.
2311 *
2312 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002313 */
Alexander Grafbee91162016-03-04 01:09:59 +01002314static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
2315{
Heinrich Schuchardt22f23db2019-06-02 21:12:17 +02002316 u64 end_tick;
2317
Alexander Grafbee91162016-03-04 01:09:59 +01002318 EFI_ENTRY("%ld", microseconds);
Heinrich Schuchardt22f23db2019-06-02 21:12:17 +02002319
2320 end_tick = get_ticks() + usec_to_tick(microseconds);
2321 while (get_ticks() < end_tick)
2322 efi_timer_check();
2323
Alexander Grafbee91162016-03-04 01:09:59 +01002324 return EFI_EXIT(EFI_SUCCESS);
2325}
2326
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002327/**
Mario Six78a88f72018-07-10 08:40:17 +02002328 * efi_set_watchdog_timer() - reset the watchdog timer
2329 * @timeout: seconds before reset by watchdog
2330 * @watchdog_code: code to be logged when resetting
2331 * @data_size: size of buffer in bytes
2332 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002333 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002334 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002335 *
Mario Six78a88f72018-07-10 08:40:17 +02002336 * See the Unified Extensible Firmware Interface (UEFI) specification for
2337 * details.
2338 *
2339 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002340 */
Alexander Grafbee91162016-03-04 01:09:59 +01002341static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2342 uint64_t watchdog_code,
2343 unsigned long data_size,
2344 uint16_t *watchdog_data)
2345{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09002346 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01002347 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02002348 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01002349}
2350
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002351/**
Mario Six78a88f72018-07-10 08:40:17 +02002352 * efi_close_protocol() - close a protocol
2353 * @handle: handle on which the protocol shall be closed
2354 * @protocol: GUID of the protocol to close
2355 * @agent_handle: handle of the driver
2356 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002357 *
Heinrich Schuchardtef185762022-10-07 15:18:15 +02002358 * This is the function implementing the CloseProtocol service is for internal
2359 * usage in U-Boot. For API usage wrapper efi_close_protocol_ext() is provided.
2360 *
2361 * See the Unified Extensible Firmware Interface (UEFI) specification for
2362 * details.
2363 *
2364 * Return: status code
2365 */
2366efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
2367 efi_handle_t agent_handle,
2368 efi_handle_t controller_handle)
2369{
2370 struct efi_handler *handler;
2371 struct efi_open_protocol_info_item *item;
2372 struct efi_open_protocol_info_item *pos;
2373 efi_status_t ret;
2374
2375 if (!efi_search_obj(agent_handle) ||
2376 (controller_handle && !efi_search_obj(controller_handle)))
2377 return EFI_INVALID_PARAMETER;
2378 ret = efi_search_protocol(handle, protocol, &handler);
2379 if (ret != EFI_SUCCESS)
2380 return ret;
2381
2382 ret = EFI_NOT_FOUND;
2383 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2384 if (item->info.agent_handle == agent_handle &&
2385 item->info.controller_handle == controller_handle) {
2386 efi_delete_open_info(item);
2387 ret = EFI_SUCCESS;
2388 }
2389 }
2390
2391 return ret;
2392}
2393
2394/**
2395 * efi_close_protocol_ext() - close a protocol
2396 * @handle: handle on which the protocol shall be closed
2397 * @protocol: GUID of the protocol to close
2398 * @agent_handle: handle of the driver
2399 * @controller_handle: handle of the controller
2400 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002401 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002402 *
Mario Six78a88f72018-07-10 08:40:17 +02002403 * See the Unified Extensible Firmware Interface (UEFI) specification for
2404 * details.
2405 *
2406 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002407 */
Heinrich Schuchardtef185762022-10-07 15:18:15 +02002408static efi_status_t EFIAPI
2409efi_close_protocol_ext(efi_handle_t handle, const efi_guid_t *protocol,
2410 efi_handle_t agent_handle,
2411 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01002412{
Heinrich Schuchardtef185762022-10-07 15:18:15 +02002413 efi_status_t ret;
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002414
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01002415 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01002416 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002417
Heinrich Schuchardtef185762022-10-07 15:18:15 +02002418 ret = efi_close_protocol(handle, protocol,
2419 agent_handle, controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002420
Heinrich Schuchardtef185762022-10-07 15:18:15 +02002421 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002422}
2423
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002424/**
Mario Six78a88f72018-07-10 08:40:17 +02002425 * efi_open_protocol_information() - provide information about then open status
2426 * of a protocol on a handle
2427 * @handle: handle for which the information shall be retrieved
2428 * @protocol: GUID of the protocol
2429 * @entry_buffer: buffer to receive the open protocol information
2430 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002431 *
2432 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002433 *
Mario Six78a88f72018-07-10 08:40:17 +02002434 * See the Unified Extensible Firmware Interface (UEFI) specification for
2435 * details.
2436 *
2437 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002438 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002439static efi_status_t EFIAPI efi_open_protocol_information(
2440 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002441 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002442 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002443{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002444 unsigned long buffer_size;
2445 unsigned long count;
2446 struct efi_handler *handler;
2447 struct efi_open_protocol_info_item *item;
2448 efi_status_t r;
2449
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01002450 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01002451 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002452
2453 /* Check parameters */
2454 if (!entry_buffer) {
2455 r = EFI_INVALID_PARAMETER;
2456 goto out;
2457 }
2458 r = efi_search_protocol(handle, protocol, &handler);
2459 if (r != EFI_SUCCESS)
2460 goto out;
2461
2462 /* Count entries */
2463 count = 0;
2464 list_for_each_entry(item, &handler->open_infos, link) {
2465 if (item->info.open_count)
2466 ++count;
2467 }
2468 *entry_count = count;
2469 *entry_buffer = NULL;
2470 if (!count) {
2471 r = EFI_SUCCESS;
2472 goto out;
2473 }
2474
2475 /* Copy entries */
2476 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002477 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002478 (void **)entry_buffer);
2479 if (r != EFI_SUCCESS)
2480 goto out;
2481 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2482 if (item->info.open_count)
2483 (*entry_buffer)[--count] = item->info;
2484 }
2485out:
2486 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002487}
2488
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002489/**
Mario Six78a88f72018-07-10 08:40:17 +02002490 * efi_protocols_per_handle() - get protocols installed on a handle
2491 * @handle: handle for which the information is retrieved
2492 * @protocol_buffer: buffer with protocol GUIDs
2493 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002494 *
2495 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002496 *
Mario Six78a88f72018-07-10 08:40:17 +02002497 * See the Unified Extensible Firmware Interface (UEFI) specification for
2498 * details.
2499 *
2500 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002501 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002502static efi_status_t EFIAPI efi_protocols_per_handle(
2503 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002504 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002505{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002506 unsigned long buffer_size;
2507 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002508 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002509 efi_status_t r;
2510
Alexander Grafbee91162016-03-04 01:09:59 +01002511 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2512 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002513
2514 if (!handle || !protocol_buffer || !protocol_buffer_count)
2515 return EFI_EXIT(EFI_INVALID_PARAMETER);
2516
2517 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002518 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002519
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002520 efiobj = efi_search_obj(handle);
2521 if (!efiobj)
2522 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002523
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002524 /* Count protocols */
2525 list_for_each(protocol_handle, &efiobj->protocols) {
2526 ++*protocol_buffer_count;
2527 }
2528
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002529 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002530 if (*protocol_buffer_count) {
2531 size_t j = 0;
2532
2533 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002534 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002535 (void **)protocol_buffer);
2536 if (r != EFI_SUCCESS)
2537 return EFI_EXIT(r);
2538 list_for_each(protocol_handle, &efiobj->protocols) {
2539 struct efi_handler *protocol;
2540
2541 protocol = list_entry(protocol_handle,
2542 struct efi_handler, link);
Heinrich Schuchardt66028932022-03-09 19:56:23 +01002543 (*protocol_buffer)[j] = (void *)&protocol->guid;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002544 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002545 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002546 }
2547
2548 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002549}
2550
Masahisa Kojima87d79142022-09-12 17:33:50 +09002551efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
2552 const efi_guid_t *protocol, void *search_key,
2553 efi_uintn_t *no_handles, efi_handle_t **buffer)
2554{
2555 efi_status_t r;
2556 efi_uintn_t buffer_size = 0;
2557
2558 if (!no_handles || !buffer) {
2559 r = EFI_INVALID_PARAMETER;
2560 goto out;
2561 }
2562 *no_handles = 0;
2563 *buffer = NULL;
2564 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2565 *buffer);
2566 if (r != EFI_BUFFER_TOO_SMALL)
2567 goto out;
2568 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2569 (void **)buffer);
2570 if (r != EFI_SUCCESS)
2571 goto out;
2572 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2573 *buffer);
2574 if (r == EFI_SUCCESS)
2575 *no_handles = buffer_size / sizeof(efi_handle_t);
2576out:
2577 return r;
2578}
2579
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002580/**
Mario Six78a88f72018-07-10 08:40:17 +02002581 * efi_locate_handle_buffer() - locate handles implementing a protocol
2582 * @search_type: selection criterion
2583 * @protocol: GUID of the protocol
2584 * @search_key: registration key
2585 * @no_handles: number of returned handles
2586 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002587 *
2588 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002589 *
Mario Six78a88f72018-07-10 08:40:17 +02002590 * See the Unified Extensible Firmware Interface (UEFI) specification for
2591 * details.
2592 *
2593 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002594 */
AKASHI Takahirob51ec632020-03-17 11:12:36 +09002595efi_status_t EFIAPI efi_locate_handle_buffer(
Alexander Grafbee91162016-03-04 01:09:59 +01002596 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002597 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002598 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002599{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002600 efi_status_t r;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002601
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01002602 EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002603 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002604
Masahisa Kojima87d79142022-09-12 17:33:50 +09002605 r = efi_locate_handle_buffer_int(search_type, protocol, search_key,
2606 no_handles, buffer);
2607
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002608 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002609}
2610
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002611/**
Mario Six78a88f72018-07-10 08:40:17 +02002612 * efi_locate_protocol() - find an interface implementing a protocol
2613 * @protocol: GUID of the protocol
2614 * @registration: registration key passed to the notification function
2615 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002616 *
2617 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002618 *
Mario Six78a88f72018-07-10 08:40:17 +02002619 * See the Unified Extensible Firmware Interface (UEFI) specification for
2620 * details.
2621 *
2622 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002623 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002624static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002625 void *registration,
2626 void **protocol_interface)
2627{
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002628 struct efi_handler *handler;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002629 efi_status_t ret;
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002630 struct efi_object *efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01002631
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01002632 EFI_ENTRY("%pUs, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002633
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002634 /*
2635 * The UEFI spec explicitly requires a protocol even if a registration
2636 * key is provided. This differs from the logic in LocateHandle().
2637 */
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002638 if (!protocol || !protocol_interface)
2639 return EFI_EXIT(EFI_INVALID_PARAMETER);
2640
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002641 if (registration) {
2642 struct efi_register_notify_event *event;
2643 struct efi_protocol_notification *handle;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002644
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002645 event = efi_check_register_notify_event(registration);
2646 if (!event)
2647 return EFI_EXIT(EFI_INVALID_PARAMETER);
2648 /*
2649 * The UEFI spec requires to return EFI_NOT_FOUND if no
2650 * protocol instance matches protocol and registration.
2651 * So let's do the same for a mismatch between protocol and
2652 * registration.
2653 */
2654 if (guidcmp(&event->protocol, protocol))
2655 goto not_found;
2656 if (list_empty(&event->handles))
2657 goto not_found;
2658 handle = list_first_entry(&event->handles,
2659 struct efi_protocol_notification,
2660 link);
2661 efiobj = handle->handle;
2662 list_del(&handle->link);
2663 free(handle);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002664 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002665 if (ret == EFI_SUCCESS)
2666 goto found;
2667 } else {
2668 list_for_each_entry(efiobj, &efi_obj_list, link) {
2669 ret = efi_search_protocol(efiobj, protocol, &handler);
2670 if (ret == EFI_SUCCESS)
2671 goto found;
Alexander Grafbee91162016-03-04 01:09:59 +01002672 }
2673 }
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002674not_found:
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002675 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002676 return EFI_EXIT(EFI_NOT_FOUND);
Heinrich Schuchardte31b3b12019-05-29 18:06:46 +02002677found:
2678 *protocol_interface = handler->protocol_interface;
2679 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002680}
2681
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002682/**
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002683 * efi_install_multiple_protocol_interfaces_int() - Install multiple protocol
2684 * interfaces
2685 * @handle: handle on which the protocol interfaces shall be installed
2686 * @argptr: va_list of args
2687 *
2688 * Core functionality of efi_install_multiple_protocol_interfaces
2689 * Must not be called directly
2690 *
2691 * Return: status code
2692 */
2693static efi_status_t EFIAPI
2694efi_install_multiple_protocol_interfaces_int(efi_handle_t *handle,
2695 efi_va_list argptr)
2696{
2697 const efi_guid_t *protocol;
2698 void *protocol_interface;
2699 efi_handle_t old_handle;
2700 efi_status_t ret = EFI_SUCCESS;
2701 int i = 0;
2702 efi_va_list argptr_copy;
2703
2704 if (!handle)
2705 return EFI_INVALID_PARAMETER;
2706
2707 efi_va_copy(argptr_copy, argptr);
2708 for (;;) {
2709 protocol = efi_va_arg(argptr, efi_guid_t*);
2710 if (!protocol)
2711 break;
2712 protocol_interface = efi_va_arg(argptr, void*);
2713 /* Check that a device path has not been installed before */
2714 if (!guidcmp(protocol, &efi_guid_device_path)) {
2715 struct efi_device_path *dp = protocol_interface;
2716
2717 ret = EFI_CALL(efi_locate_device_path(protocol, &dp,
2718 &old_handle));
2719 if (ret == EFI_SUCCESS &&
2720 dp->type == DEVICE_PATH_TYPE_END) {
2721 EFI_PRINT("Path %pD already installed\n",
2722 protocol_interface);
2723 ret = EFI_ALREADY_STARTED;
2724 break;
2725 }
2726 }
2727 ret = EFI_CALL(efi_install_protocol_interface(handle, protocol,
2728 EFI_NATIVE_INTERFACE,
2729 protocol_interface));
2730 if (ret != EFI_SUCCESS)
2731 break;
2732 i++;
2733 }
2734 if (ret == EFI_SUCCESS)
2735 goto out;
2736
2737 /* If an error occurred undo all changes. */
2738 for (; i; --i) {
2739 protocol = efi_va_arg(argptr_copy, efi_guid_t*);
2740 protocol_interface = efi_va_arg(argptr_copy, void*);
2741 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2742 protocol_interface));
2743 }
2744
2745out:
2746 efi_va_end(argptr_copy);
2747 return ret;
2748
2749}
2750
2751/**
Mario Six78a88f72018-07-10 08:40:17 +02002752 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2753 * interfaces
2754 * @handle: handle on which the protocol interfaces shall be installed
2755 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2756 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002757 *
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002758 *
2759 * This is the function for internal usage in U-Boot. For the API function
2760 * implementing the InstallMultipleProtocol service see
2761 * efi_install_multiple_protocol_interfaces_ext()
2762 *
2763 * Return: status code
2764 */
2765efi_status_t EFIAPI
2766efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...)
2767{
2768 efi_status_t ret;
2769 efi_va_list argptr;
2770
2771 efi_va_start(argptr, handle);
2772 ret = efi_install_multiple_protocol_interfaces_int(handle, argptr);
2773 efi_va_end(argptr);
2774 return ret;
2775}
2776
2777/**
2778 * efi_install_multiple_protocol_interfaces_ext() - Install multiple protocol
2779 * interfaces
2780 * @handle: handle on which the protocol interfaces shall be installed
2781 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2782 * interfaces
2783 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002784 * This function implements the MultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002785 *
Mario Six78a88f72018-07-10 08:40:17 +02002786 * See the Unified Extensible Firmware Interface (UEFI) specification for
2787 * details.
2788 *
2789 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002790 */
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002791static efi_status_t EFIAPI
2792efi_install_multiple_protocol_interfaces_ext(efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002793{
2794 EFI_ENTRY("%p", handle);
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002795 efi_status_t ret;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002796 efi_va_list argptr;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002797
Alexander Grafbeb077a2018-06-18 17:23:05 +02002798 efi_va_start(argptr, handle);
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002799 ret = efi_install_multiple_protocol_interfaces_int(handle, argptr);
2800 efi_va_end(argptr);
2801 return EFI_EXIT(ret);
2802}
2803
2804/**
2805 * efi_uninstall_multiple_protocol_interfaces_int() - wrapper for uninstall
2806 * multiple protocol
2807 * interfaces
2808 * @handle: handle from which the protocol interfaces shall be removed
2809 * @argptr: va_list of args
2810 *
2811 * Core functionality of efi_uninstall_multiple_protocol_interfaces
2812 * Must not be called directly
2813 *
2814 * Return: status code
2815 */
2816static efi_status_t EFIAPI
2817efi_uninstall_multiple_protocol_interfaces_int(efi_handle_t handle,
2818 efi_va_list argptr)
2819{
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03002820 const efi_guid_t *protocol, *next_protocol;
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002821 void *protocol_interface;
Ilias Apalodimas9fb32692022-11-10 10:21:24 +02002822 efi_status_t ret = EFI_SUCCESS;
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002823 size_t i = 0;
2824 efi_va_list argptr_copy;
2825
2826 if (!handle)
2827 return EFI_INVALID_PARAMETER;
2828
2829 efi_va_copy(argptr_copy, argptr);
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03002830 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002831 for (;;) {
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03002832 /*
2833 * If efi_uninstall_protocol() fails we need to be able to
2834 * reinstall the previously uninstalled protocols on the same
2835 * handle.
2836 * Instead of calling efi_uninstall_protocol(...,..., false)
2837 * and potentially removing the handle, only allow the handle
2838 * removal on the last protocol that we requested to uninstall.
2839 * That way we can preserve the handle in case the latter fails
2840 */
2841 bool preserve = true;
2842
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002843 if (!protocol)
2844 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002845 protocol_interface = efi_va_arg(argptr, void*);
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03002846 next_protocol = efi_va_arg(argptr, efi_guid_t*);
2847 if (!next_protocol)
2848 preserve = false;
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002849 ret = efi_uninstall_protocol(handle, protocol,
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03002850 protocol_interface, preserve);
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002851 if (ret != EFI_SUCCESS)
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002852 break;
2853 i++;
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03002854 protocol = next_protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002855 }
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03002856 if (ret == EFI_SUCCESS)
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002857 goto out;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002858
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002859 /* If an error occurred undo all changes. */
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002860 for (; i; --i) {
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002861 protocol = efi_va_arg(argptr_copy, efi_guid_t*);
2862 protocol_interface = efi_va_arg(argptr_copy, void*);
2863 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2864 EFI_NATIVE_INTERFACE,
2865 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002866 }
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002867 /*
2868 * If any errors are generated while the protocol interfaces are being
2869 * uninstalled, then the protocols uninstalled prior to the error will
2870 * be reinstalled using InstallProtocolInterface() and the status code
2871 * EFI_INVALID_PARAMETER is returned.
2872 */
2873 ret = EFI_INVALID_PARAMETER;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002874
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002875out:
2876 efi_va_end(argptr_copy);
2877 return ret;
Alexander Grafbee91162016-03-04 01:09:59 +01002878}
2879
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002880/**
Mario Six78a88f72018-07-10 08:40:17 +02002881 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2882 * interfaces
2883 * @handle: handle from which the protocol interfaces shall be removed
2884 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2885 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002886 *
2887 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002888 *
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002889 * This is the function for internal usage in U-Boot. For the API function
2890 * implementing the UninstallMultipleProtocolInterfaces service see
2891 * efi_uninstall_multiple_protocol_interfaces_ext()
2892 *
2893 * Return: status code
2894 */
2895efi_status_t EFIAPI
2896efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...)
2897{
2898 efi_status_t ret;
2899 efi_va_list argptr;
2900
2901 efi_va_start(argptr, handle);
2902 ret = efi_uninstall_multiple_protocol_interfaces_int(handle, argptr);
2903 efi_va_end(argptr);
2904 return ret;
2905}
2906
2907/**
2908 * efi_uninstall_multiple_protocol_interfaces_ext() - uninstall multiple protocol
2909 * interfaces
2910 * @handle: handle from which the protocol interfaces shall be removed
2911 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2912 * interfaces
2913 *
2914 * This function implements the UninstallMultipleProtocolInterfaces service.
2915 *
Mario Six78a88f72018-07-10 08:40:17 +02002916 * See the Unified Extensible Firmware Interface (UEFI) specification for
2917 * details.
2918 *
2919 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002920 */
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002921static efi_status_t EFIAPI
2922efi_uninstall_multiple_protocol_interfaces_ext(efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002923{
2924 EFI_ENTRY("%p", handle);
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002925 efi_status_t ret;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002926 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002927
Alexander Grafbeb077a2018-06-18 17:23:05 +02002928 efi_va_start(argptr, handle);
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002929 ret = efi_uninstall_multiple_protocol_interfaces_int(handle, argptr);
Alexander Grafbeb077a2018-06-18 17:23:05 +02002930 efi_va_end(argptr);
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03002931 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002932}
2933
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002934/**
Mario Six78a88f72018-07-10 08:40:17 +02002935 * efi_calculate_crc32() - calculate cyclic redundancy code
2936 * @data: buffer with data
2937 * @data_size: size of buffer in bytes
2938 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002939 *
2940 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002941 *
Mario Six78a88f72018-07-10 08:40:17 +02002942 * See the Unified Extensible Firmware Interface (UEFI) specification for
2943 * details.
2944 *
2945 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002946 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002947static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2948 efi_uintn_t data_size,
2949 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002950{
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002951 efi_status_t ret = EFI_SUCCESS;
2952
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002953 EFI_ENTRY("%p, %zu", data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002954 if (!data || !data_size || !crc32_p) {
2955 ret = EFI_INVALID_PARAMETER;
2956 goto out;
2957 }
Alexander Grafbee91162016-03-04 01:09:59 +01002958 *crc32_p = crc32(0, data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002959out:
2960 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002961}
2962
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002963/**
Mario Six78a88f72018-07-10 08:40:17 +02002964 * efi_copy_mem() - copy memory
2965 * @destination: destination of the copy operation
2966 * @source: source of the copy operation
2967 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002968 *
2969 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002970 *
Mario Six78a88f72018-07-10 08:40:17 +02002971 * See the Unified Extensible Firmware Interface (UEFI) specification for
2972 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002973 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002974static void EFIAPI efi_copy_mem(void *destination, const void *source,
2975 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002976{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002977 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002978 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002979 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002980}
2981
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002982/**
Mario Six78a88f72018-07-10 08:40:17 +02002983 * efi_set_mem() - Fill memory with a byte value.
2984 * @buffer: buffer to fill
2985 * @size: size of buffer in bytes
2986 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002987 *
2988 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002989 *
Mario Six78a88f72018-07-10 08:40:17 +02002990 * See the Unified Extensible Firmware Interface (UEFI) specification for
2991 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002992 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002993static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002994{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002995 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002996 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002997 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002998}
2999
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003000/**
Mario Six78a88f72018-07-10 08:40:17 +02003001 * efi_protocol_open() - open protocol interface on a handle
3002 * @handler: handler of a protocol
3003 * @protocol_interface: interface implementing the protocol
3004 * @agent_handle: handle of the driver
3005 * @controller_handle: handle of the controller
3006 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003007 *
Mario Six78a88f72018-07-10 08:40:17 +02003008 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003009 */
Heinrich Schuchardtf9ad2402020-01-10 12:33:59 +01003010efi_status_t efi_protocol_open(
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003011 struct efi_handler *handler,
3012 void **protocol_interface, void *agent_handle,
3013 void *controller_handle, uint32_t attributes)
3014{
3015 struct efi_open_protocol_info_item *item;
3016 struct efi_open_protocol_info_entry *match = NULL;
3017 bool opened_by_driver = false;
3018 bool opened_exclusive = false;
3019
3020 /* If there is no agent, only return the interface */
3021 if (!agent_handle)
3022 goto out;
3023
3024 /* For TEST_PROTOCOL ignore interface attribute */
3025 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
3026 *protocol_interface = NULL;
3027
3028 /*
3029 * Check if the protocol is already opened by a driver with the same
3030 * attributes or opened exclusively
3031 */
3032 list_for_each_entry(item, &handler->open_infos, link) {
3033 if (item->info.agent_handle == agent_handle) {
3034 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
3035 (item->info.attributes == attributes))
3036 return EFI_ALREADY_STARTED;
Heinrich Schuchardt399a39e2019-05-30 14:16:31 +02003037 } else {
3038 if (item->info.attributes &
3039 EFI_OPEN_PROTOCOL_BY_DRIVER)
3040 opened_by_driver = true;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003041 }
3042 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
3043 opened_exclusive = true;
3044 }
3045
3046 /* Only one controller can open the protocol exclusively */
Heinrich Schuchardt399a39e2019-05-30 14:16:31 +02003047 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
3048 if (opened_exclusive)
3049 return EFI_ACCESS_DENIED;
3050 } else if (attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {
3051 if (opened_exclusive || opened_by_driver)
3052 return EFI_ACCESS_DENIED;
3053 }
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003054
3055 /* Prepare exclusive opening */
3056 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
3057 /* Try to disconnect controllers */
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02003058disconnect_next:
3059 opened_by_driver = false;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003060 list_for_each_entry(item, &handler->open_infos, link) {
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02003061 efi_status_t ret;
3062
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003063 if (item->info.attributes ==
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02003064 EFI_OPEN_PROTOCOL_BY_DRIVER) {
3065 ret = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003066 item->info.controller_handle,
3067 item->info.agent_handle,
3068 NULL));
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02003069 if (ret == EFI_SUCCESS)
3070 /*
3071 * Child controllers may have been
3072 * removed from the open_infos list. So
3073 * let's restart the loop.
3074 */
3075 goto disconnect_next;
3076 else
3077 opened_by_driver = true;
3078 }
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003079 }
Heinrich Schuchardtdae7ce42019-05-30 14:16:31 +02003080 /* Only one driver can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003081 if (opened_by_driver)
3082 return EFI_ACCESS_DENIED;
3083 }
3084
3085 /* Find existing entry */
3086 list_for_each_entry(item, &handler->open_infos, link) {
3087 if (item->info.agent_handle == agent_handle &&
Heinrich Schuchardtb4863ba2019-06-01 20:15:10 +02003088 item->info.controller_handle == controller_handle &&
3089 item->info.attributes == attributes)
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003090 match = &item->info;
3091 }
3092 /* None found, create one */
3093 if (!match) {
3094 match = efi_create_open_info(handler);
3095 if (!match)
3096 return EFI_OUT_OF_RESOURCES;
3097 }
3098
3099 match->agent_handle = agent_handle;
3100 match->controller_handle = controller_handle;
3101 match->attributes = attributes;
3102 match->open_count++;
3103
3104out:
3105 /* For TEST_PROTOCOL ignore interface attribute. */
3106 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
3107 *protocol_interface = handler->protocol_interface;
3108
3109 return EFI_SUCCESS;
3110}
3111
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003112/**
Mario Six78a88f72018-07-10 08:40:17 +02003113 * efi_open_protocol() - open protocol interface on a handle
3114 * @handle: handle on which the protocol shall be opened
3115 * @protocol: GUID of the protocol
3116 * @protocol_interface: interface implementing the protocol
3117 * @agent_handle: handle of the driver
3118 * @controller_handle: handle of the controller
3119 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003120 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003121 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003122 *
Mario Six78a88f72018-07-10 08:40:17 +02003123 * See the Unified Extensible Firmware Interface (UEFI) specification for
3124 * details.
3125 *
3126 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003127 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02003128static efi_status_t EFIAPI efi_open_protocol
3129 (efi_handle_t handle, const efi_guid_t *protocol,
3130 void **protocol_interface, efi_handle_t agent_handle,
3131 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01003132{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01003133 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02003134 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01003135
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01003136 EFI_ENTRY("%p, %pUs, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01003137 protocol_interface, agent_handle, controller_handle,
3138 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02003139
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02003140 if (!handle || !protocol ||
3141 (!protocol_interface && attributes !=
3142 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
3143 goto out;
3144 }
3145
3146 switch (attributes) {
3147 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
3148 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
3149 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
3150 break;
3151 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
3152 if (controller_handle == handle)
3153 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003154 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02003155 case EFI_OPEN_PROTOCOL_BY_DRIVER:
3156 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003157 /* Check that the controller handle is valid */
3158 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02003159 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003160 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02003161 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003162 /* Check that the agent handle is valid */
3163 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02003164 goto out;
3165 break;
3166 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02003167 goto out;
3168 }
3169
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01003170 r = efi_search_protocol(handle, protocol, &handler);
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02003171 switch (r) {
3172 case EFI_SUCCESS:
3173 break;
3174 case EFI_NOT_FOUND:
3175 r = EFI_UNSUPPORTED;
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01003176 goto out;
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02003177 default:
3178 goto out;
3179 }
Alexander Grafbee91162016-03-04 01:09:59 +01003180
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01003181 r = efi_protocol_open(handler, protocol_interface, agent_handle,
3182 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01003183out:
3184 return EFI_EXIT(r);
3185}
3186
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003187/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003188 * efi_start_image() - call the entry point of an image
3189 * @image_handle: handle of the image
3190 * @exit_data_size: size of the buffer
3191 * @exit_data: buffer to receive the exit data of the called image
3192 *
3193 * This function implements the StartImage service.
3194 *
3195 * See the Unified Extensible Firmware Interface (UEFI) specification for
3196 * details.
3197 *
3198 * Return: status code
3199 */
3200efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
3201 efi_uintn_t *exit_data_size,
3202 u16 **exit_data)
3203{
3204 struct efi_loaded_image_obj *image_obj =
3205 (struct efi_loaded_image_obj *)image_handle;
3206 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003207 void *info;
3208 efi_handle_t parent_image = current_image;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003209 efi_status_t exit_status;
3210 struct jmp_buf_data exit_jmp;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003211
3212 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
3213
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09003214 if (!efi_search_obj(image_handle))
3215 return EFI_EXIT(EFI_INVALID_PARAMETER);
3216
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003217 /* Check parameters */
Heinrich Schuchardt1d3e8dc2019-06-11 19:35:20 +02003218 if (image_obj->header.type != EFI_OBJECT_TYPE_LOADED_IMAGE)
3219 return EFI_EXIT(EFI_INVALID_PARAMETER);
3220
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09003221 if (image_obj->auth_status != EFI_IMAGE_AUTH_PASSED)
3222 return EFI_EXIT(EFI_SECURITY_VIOLATION);
3223
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003224 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3225 &info, NULL, NULL,
3226 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3227 if (ret != EFI_SUCCESS)
3228 return EFI_EXIT(EFI_INVALID_PARAMETER);
3229
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003230 image_obj->exit_data_size = exit_data_size;
3231 image_obj->exit_data = exit_data;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003232 image_obj->exit_status = &exit_status;
3233 image_obj->exit_jmp = &exit_jmp;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003234
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +09003235 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3236 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
Masahisa Kojimace3dbc52021-10-26 17:27:25 +09003237 ret = efi_tcg2_measure_efi_app_invocation(image_obj);
Masahisa Kojimaf9b51dc2021-12-07 14:15:33 +09003238 if (ret == EFI_SECURITY_VIOLATION) {
3239 /*
3240 * TCG2 Protocol is installed but no TPM device found,
3241 * this is not expected.
3242 */
3243 return EFI_EXIT(EFI_SECURITY_VIOLATION);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +09003244 }
3245 }
3246 }
3247
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003248 /* call the image! */
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003249 if (setjmp(&exit_jmp)) {
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003250 /*
3251 * We called the entry point of the child image with EFI_CALL
3252 * in the lines below. The child image called the Exit() boot
3253 * service efi_exit() which executed the long jump that brought
3254 * us to the current line. This implies that the second half
3255 * of the EFI_CALL macro has not been executed.
3256 */
Heinrich Schuchardtd68d7f42020-09-10 12:22:54 +02003257#if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003258 /*
3259 * efi_exit() called efi_restore_gd(). We have to undo this
3260 * otherwise __efi_entry_check() will put the wrong value into
3261 * app_gd.
3262 */
Heinrich Schuchardt4f7dc5f2020-05-27 01:58:30 +02003263 set_gd(app_gd);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003264#endif
3265 /*
3266 * To get ready to call EFI_EXIT below we have to execute the
3267 * missed out steps of EFI_CALL.
3268 */
3269 assert(__efi_entry_check());
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02003270 EFI_PRINT("%lu returned by started image\n",
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003271 (unsigned long)((uintptr_t)exit_status &
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02003272 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003273 current_image = parent_image;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003274 return EFI_EXIT(exit_status);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003275 }
3276
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003277 current_image = image_handle;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02003278 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09003279 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003280 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
3281
3282 /*
Heinrich Schuchardt55111c52020-01-10 22:06:54 +01003283 * Control is returned from a started UEFI image either by calling
3284 * Exit() (where exit data can be provided) or by simply returning from
3285 * the entry point. In the latter case call Exit() on behalf of the
3286 * image.
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003287 */
3288 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
3289}
3290
3291/**
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003292 * efi_delete_image() - delete loaded image from memory)
3293 *
3294 * @image_obj: handle of the loaded image
3295 * @loaded_image_protocol: loaded image protocol
3296 */
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02003297static efi_status_t efi_delete_image
3298 (struct efi_loaded_image_obj *image_obj,
3299 struct efi_loaded_image *loaded_image_protocol)
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003300{
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02003301 struct efi_object *efiobj;
3302 efi_status_t r, ret = EFI_SUCCESS;
3303
3304close_next:
3305 list_for_each_entry(efiobj, &efi_obj_list, link) {
3306 struct efi_handler *protocol;
3307
3308 list_for_each_entry(protocol, &efiobj->protocols, link) {
3309 struct efi_open_protocol_info_item *info;
3310
3311 list_for_each_entry(info, &protocol->open_infos, link) {
3312 if (info->info.agent_handle !=
3313 (efi_handle_t)image_obj)
3314 continue;
Heinrich Schuchardtef185762022-10-07 15:18:15 +02003315 r = efi_close_protocol(
3316 efiobj, &protocol->guid,
3317 info->info.agent_handle,
3318 info->info.controller_handle);
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02003319 if (r != EFI_SUCCESS)
3320 ret = r;
3321 /*
3322 * Closing protocols may results in further
3323 * items being deleted. To play it safe loop
3324 * over all elements again.
3325 */
3326 goto close_next;
3327 }
3328 }
3329 }
3330
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003331 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
3332 efi_size_in_pages(loaded_image_protocol->image_size));
3333 efi_delete_handle(&image_obj->header);
Heinrich Schuchardt120ff7b2019-06-02 20:02:32 +02003334
3335 return ret;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003336}
3337
3338/**
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003339 * efi_unload_image() - unload an EFI image
3340 * @image_handle: handle of the image to be unloaded
3341 *
3342 * This function implements the UnloadImage service.
3343 *
3344 * See the Unified Extensible Firmware Interface (UEFI) specification for
3345 * details.
3346 *
3347 * Return: status code
3348 */
3349efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
3350{
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003351 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003352 struct efi_object *efiobj;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003353 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003354
3355 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003356
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02003357 efiobj = efi_search_obj(image_handle);
3358 if (!efiobj) {
3359 ret = EFI_INVALID_PARAMETER;
3360 goto out;
3361 }
3362 /* Find the loaded image protocol */
3363 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3364 (void **)&loaded_image_protocol,
3365 NULL, NULL,
3366 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3367 if (ret != EFI_SUCCESS) {
3368 ret = EFI_INVALID_PARAMETER;
3369 goto out;
3370 }
3371 switch (efiobj->type) {
3372 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3373 /* Call the unload function */
3374 if (!loaded_image_protocol->unload) {
3375 ret = EFI_UNSUPPORTED;
3376 goto out;
3377 }
3378 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
3379 if (ret != EFI_SUCCESS)
3380 goto out;
3381 break;
3382 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3383 break;
3384 default:
3385 ret = EFI_INVALID_PARAMETER;
3386 goto out;
3387 }
3388 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
3389 loaded_image_protocol);
3390out:
3391 return EFI_EXIT(ret);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02003392}
3393
3394/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003395 * efi_update_exit_data() - fill exit data parameters of StartImage()
3396 *
Heinrich Schuchardt9ce91272019-07-14 11:25:06 +02003397 * @image_obj: image handle
3398 * @exit_data_size: size of the exit data buffer
3399 * @exit_data: buffer with data returned by UEFI payload
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003400 * Return: status code
3401 */
3402static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
3403 efi_uintn_t exit_data_size,
3404 u16 *exit_data)
3405{
3406 efi_status_t ret;
3407
3408 /*
3409 * If exit_data is not provided to StartImage(), exit_data_size must be
3410 * ignored.
3411 */
3412 if (!image_obj->exit_data)
3413 return EFI_SUCCESS;
3414 if (image_obj->exit_data_size)
3415 *image_obj->exit_data_size = exit_data_size;
3416 if (exit_data_size && exit_data) {
3417 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
3418 exit_data_size,
3419 (void **)image_obj->exit_data);
3420 if (ret != EFI_SUCCESS)
3421 return ret;
3422 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
3423 } else {
3424 image_obj->exit_data = NULL;
3425 }
3426 return EFI_SUCCESS;
3427}
3428
3429/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003430 * efi_exit() - leave an EFI application or driver
3431 * @image_handle: handle of the application or driver that is exiting
3432 * @exit_status: status code
3433 * @exit_data_size: size of the buffer in bytes
3434 * @exit_data: buffer with data describing an error
3435 *
3436 * This function implements the Exit service.
3437 *
3438 * See the Unified Extensible Firmware Interface (UEFI) specification for
3439 * details.
3440 *
3441 * Return: status code
3442 */
3443static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
3444 efi_status_t exit_status,
3445 efi_uintn_t exit_data_size,
3446 u16 *exit_data)
3447{
3448 /*
3449 * TODO: We should call the unload procedure of the loaded
3450 * image protocol.
3451 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003452 efi_status_t ret;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003453 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003454 struct efi_loaded_image_obj *image_obj =
3455 (struct efi_loaded_image_obj *)image_handle;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003456 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003457
3458 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
3459 exit_data_size, exit_data);
3460
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003461 /* Check parameters */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003462 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003463 (void **)&loaded_image_protocol,
3464 NULL, NULL,
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003465 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003466 if (ret != EFI_SUCCESS) {
3467 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003468 goto out;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003469 }
3470
3471 /* Unloading of unstarted images */
3472 switch (image_obj->header.type) {
3473 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3474 break;
3475 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3476 efi_delete_image(image_obj, loaded_image_protocol);
3477 ret = EFI_SUCCESS;
3478 goto out;
3479 default:
3480 /* Handle does not refer to loaded image */
3481 ret = EFI_INVALID_PARAMETER;
3482 goto out;
3483 }
3484 /* A started image can only be unloaded it is the last one started. */
3485 if (image_handle != current_image) {
3486 ret = EFI_INVALID_PARAMETER;
3487 goto out;
3488 }
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003489
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003490 /* Exit data is only foreseen in case of failure. */
3491 if (exit_status != EFI_SUCCESS) {
3492 ret = efi_update_exit_data(image_obj, exit_data_size,
3493 exit_data);
3494 /* Exiting has priority. Don't return error to caller. */
3495 if (ret != EFI_SUCCESS)
3496 EFI_PRINT("%s: out of memory\n", __func__);
3497 }
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003498 /* efi_delete_image() frees image_obj. Copy before the call. */
3499 exit_jmp = image_obj->exit_jmp;
3500 *image_obj->exit_status = exit_status;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003501 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
3502 exit_status != EFI_SUCCESS)
3503 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02003504
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +09003505 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3506 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
3507 ret = efi_tcg2_measure_efi_app_exit();
3508 if (ret != EFI_SUCCESS) {
3509 log_warning("tcg2 measurement fails(0x%lx)\n",
3510 ret);
3511 }
3512 }
3513 }
3514
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003515 /* Make sure entry/exit counts for EFI world cross-overs match */
3516 EFI_EXIT(exit_status);
3517
3518 /*
3519 * But longjmp out with the U-Boot gd, not the application's, as
3520 * the other end is a setjmp call inside EFI context.
3521 */
3522 efi_restore_gd();
3523
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +01003524 longjmp(exit_jmp, 1);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003525
3526 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01003527out:
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02003528 return EFI_EXIT(ret);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01003529}
3530
3531/**
Mario Six78a88f72018-07-10 08:40:17 +02003532 * efi_handle_protocol() - get interface of a protocol on a handle
3533 * @handle: handle on which the protocol shall be opened
3534 * @protocol: GUID of the protocol
3535 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003536 *
3537 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003538 *
Mario Six78a88f72018-07-10 08:40:17 +02003539 * See the Unified Extensible Firmware Interface (UEFI) specification for
3540 * details.
3541 *
3542 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02003543 */
AKASHI Takahirob51ec632020-03-17 11:12:36 +09003544efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
3545 const efi_guid_t *protocol,
3546 void **protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01003547{
Heinrich Schuchardt755d42d2019-06-01 19:29:39 +02003548 return efi_open_protocol(handle, protocol, protocol_interface, efi_root,
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02003549 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01003550}
3551
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003552/**
Mario Six78a88f72018-07-10 08:40:17 +02003553 * efi_bind_controller() - bind a single driver to a controller
3554 * @controller_handle: controller handle
3555 * @driver_image_handle: driver handle
3556 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003557 *
Mario Six78a88f72018-07-10 08:40:17 +02003558 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003559 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003560static efi_status_t efi_bind_controller(
3561 efi_handle_t controller_handle,
3562 efi_handle_t driver_image_handle,
3563 struct efi_device_path *remain_device_path)
3564{
3565 struct efi_driver_binding_protocol *binding_protocol;
3566 efi_status_t r;
3567
3568 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3569 &efi_guid_driver_binding_protocol,
3570 (void **)&binding_protocol,
3571 driver_image_handle, NULL,
3572 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3573 if (r != EFI_SUCCESS)
3574 return r;
3575 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3576 controller_handle,
3577 remain_device_path));
3578 if (r == EFI_SUCCESS)
3579 r = EFI_CALL(binding_protocol->start(binding_protocol,
3580 controller_handle,
3581 remain_device_path));
Heinrich Schuchardtef185762022-10-07 15:18:15 +02003582 efi_close_protocol(driver_image_handle,
3583 &efi_guid_driver_binding_protocol,
3584 driver_image_handle, NULL);
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003585 return r;
3586}
3587
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003588/**
Mario Six78a88f72018-07-10 08:40:17 +02003589 * efi_connect_single_controller() - connect a single driver to a controller
3590 * @controller_handle: controller
3591 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003592 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003593 *
Mario Six78a88f72018-07-10 08:40:17 +02003594 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003595 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003596static efi_status_t efi_connect_single_controller(
3597 efi_handle_t controller_handle,
3598 efi_handle_t *driver_image_handle,
3599 struct efi_device_path *remain_device_path)
3600{
3601 efi_handle_t *buffer;
3602 size_t count;
3603 size_t i;
3604 efi_status_t r;
3605 size_t connected = 0;
3606
3607 /* Get buffer with all handles with driver binding protocol */
3608 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3609 &efi_guid_driver_binding_protocol,
3610 NULL, &count, &buffer));
3611 if (r != EFI_SUCCESS)
3612 return r;
3613
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02003614 /* Context Override */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003615 if (driver_image_handle) {
3616 for (; *driver_image_handle; ++driver_image_handle) {
3617 for (i = 0; i < count; ++i) {
3618 if (buffer[i] == *driver_image_handle) {
3619 buffer[i] = NULL;
3620 r = efi_bind_controller(
3621 controller_handle,
3622 *driver_image_handle,
3623 remain_device_path);
3624 /*
3625 * For drivers that do not support the
3626 * controller or are already connected
3627 * we receive an error code here.
3628 */
3629 if (r == EFI_SUCCESS)
3630 ++connected;
3631 }
3632 }
3633 }
3634 }
3635
3636 /*
3637 * TODO: Some overrides are not yet implemented:
3638 * - Platform Driver Override
3639 * - Driver Family Override Search
3640 * - Bus Specific Driver Override
3641 */
3642
3643 /* Driver Binding Search */
3644 for (i = 0; i < count; ++i) {
3645 if (buffer[i]) {
3646 r = efi_bind_controller(controller_handle,
3647 buffer[i],
3648 remain_device_path);
3649 if (r == EFI_SUCCESS)
3650 ++connected;
3651 }
3652 }
3653
3654 efi_free_pool(buffer);
3655 if (!connected)
3656 return EFI_NOT_FOUND;
3657 return EFI_SUCCESS;
3658}
3659
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003660/**
Mario Six78a88f72018-07-10 08:40:17 +02003661 * efi_connect_controller() - connect a controller to a driver
3662 * @controller_handle: handle of the controller
3663 * @driver_image_handle: handle of the driver
3664 * @remain_device_path: device path of a child controller
3665 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003666 *
3667 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02003668 *
3669 * See the Unified Extensible Firmware Interface (UEFI) specification for
3670 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003671 *
3672 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003673 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003674 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3675 *
Mario Six78a88f72018-07-10 08:40:17 +02003676 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003677 */
3678static efi_status_t EFIAPI efi_connect_controller(
3679 efi_handle_t controller_handle,
3680 efi_handle_t *driver_image_handle,
3681 struct efi_device_path *remain_device_path,
3682 bool recursive)
3683{
3684 efi_status_t r;
3685 efi_status_t ret = EFI_NOT_FOUND;
3686 struct efi_object *efiobj;
3687
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01003688 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003689 remain_device_path, recursive);
3690
3691 efiobj = efi_search_obj(controller_handle);
3692 if (!efiobj) {
3693 ret = EFI_INVALID_PARAMETER;
3694 goto out;
3695 }
3696
3697 r = efi_connect_single_controller(controller_handle,
3698 driver_image_handle,
3699 remain_device_path);
3700 if (r == EFI_SUCCESS)
3701 ret = EFI_SUCCESS;
3702 if (recursive) {
3703 struct efi_handler *handler;
3704 struct efi_open_protocol_info_item *item;
3705
3706 list_for_each_entry(handler, &efiobj->protocols, link) {
3707 list_for_each_entry(item, &handler->open_infos, link) {
3708 if (item->info.attributes &
3709 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3710 r = EFI_CALL(efi_connect_controller(
3711 item->info.controller_handle,
3712 driver_image_handle,
3713 remain_device_path,
3714 recursive));
3715 if (r == EFI_SUCCESS)
3716 ret = EFI_SUCCESS;
3717 }
3718 }
3719 }
3720 }
Heinrich Schuchardt359a6992019-07-03 20:27:24 +02003721 /* Check for child controller specified by end node */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003722 if (ret != EFI_SUCCESS && remain_device_path &&
3723 remain_device_path->type == DEVICE_PATH_TYPE_END)
3724 ret = EFI_SUCCESS;
3725out:
3726 return EFI_EXIT(ret);
3727}
3728
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003729/**
Mario Six78a88f72018-07-10 08:40:17 +02003730 * efi_reinstall_protocol_interface() - reinstall protocol interface
3731 * @handle: handle on which the protocol shall be reinstalled
3732 * @protocol: GUID of the protocol to be installed
3733 * @old_interface: interface to be removed
3734 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003735 *
3736 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02003737 *
3738 * See the Unified Extensible Firmware Interface (UEFI) specification for
3739 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003740 *
3741 * The old interface is uninstalled. The new interface is installed.
3742 * Drivers are connected.
3743 *
Mario Six78a88f72018-07-10 08:40:17 +02003744 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003745 */
3746static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3747 efi_handle_t handle, const efi_guid_t *protocol,
3748 void *old_interface, void *new_interface)
3749{
3750 efi_status_t ret;
3751
Heinrich Schuchardtce00a742022-01-16 14:15:31 +01003752 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, old_interface,
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003753 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003754
3755 /* Uninstall protocol but do not delete handle */
Ilias Apalodimascc889bd2023-08-24 17:21:09 +03003756 ret = efi_uninstall_protocol(handle, protocol, old_interface, true);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003757 if (ret != EFI_SUCCESS)
3758 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003759
3760 /* Install the new protocol */
3761 ret = efi_add_protocol(handle, protocol, new_interface);
3762 /*
3763 * The UEFI spec does not specify what should happen to the handle
3764 * if in case of an error no protocol interface remains on the handle.
3765 * So let's do nothing here.
3766 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003767 if (ret != EFI_SUCCESS)
3768 goto out;
3769 /*
3770 * The returned status code has to be ignored.
3771 * Do not create an error if no suitable driver for the handle exists.
3772 */
3773 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3774out:
3775 return EFI_EXIT(ret);
3776}
3777
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003778/**
Mario Six78a88f72018-07-10 08:40:17 +02003779 * efi_get_child_controllers() - get all child controllers associated to a driver
3780 * @efiobj: handle of the controller
3781 * @driver_handle: handle of the driver
3782 * @number_of_children: number of child controllers
3783 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003784 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003785 * The allocated buffer has to be freed with free().
3786 *
Mario Six78a88f72018-07-10 08:40:17 +02003787 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003788 */
3789static efi_status_t efi_get_child_controllers(
3790 struct efi_object *efiobj,
3791 efi_handle_t driver_handle,
3792 efi_uintn_t *number_of_children,
3793 efi_handle_t **child_handle_buffer)
3794{
3795 struct efi_handler *handler;
3796 struct efi_open_protocol_info_item *item;
3797 efi_uintn_t count = 0, i;
3798 bool duplicate;
3799
3800 /* Count all child controller associations */
3801 list_for_each_entry(handler, &efiobj->protocols, link) {
3802 list_for_each_entry(item, &handler->open_infos, link) {
3803 if (item->info.agent_handle == driver_handle &&
3804 item->info.attributes &
3805 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3806 ++count;
3807 }
3808 }
3809 /*
3810 * Create buffer. In case of duplicate child controller assignments
3811 * the buffer will be too large. But that does not harm.
3812 */
3813 *number_of_children = 0;
Heinrich Schuchardt1047c6e2020-07-07 04:21:26 +02003814 if (!count)
3815 return EFI_SUCCESS;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003816 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3817 if (!*child_handle_buffer)
3818 return EFI_OUT_OF_RESOURCES;
3819 /* Copy unique child handles */
3820 list_for_each_entry(handler, &efiobj->protocols, link) {
3821 list_for_each_entry(item, &handler->open_infos, link) {
3822 if (item->info.agent_handle == driver_handle &&
3823 item->info.attributes &
3824 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3825 /* Check this is a new child controller */
3826 duplicate = false;
3827 for (i = 0; i < *number_of_children; ++i) {
3828 if ((*child_handle_buffer)[i] ==
3829 item->info.controller_handle)
3830 duplicate = true;
3831 }
3832 /* Copy handle to buffer */
3833 if (!duplicate) {
3834 i = (*number_of_children)++;
3835 (*child_handle_buffer)[i] =
3836 item->info.controller_handle;
3837 }
3838 }
3839 }
3840 }
3841 return EFI_SUCCESS;
3842}
3843
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003844/**
Mario Six78a88f72018-07-10 08:40:17 +02003845 * efi_disconnect_controller() - disconnect a controller from a driver
3846 * @controller_handle: handle of the controller
3847 * @driver_image_handle: handle of the driver
3848 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003849 *
3850 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003851 *
Mario Six78a88f72018-07-10 08:40:17 +02003852 * See the Unified Extensible Firmware Interface (UEFI) specification for
3853 * details.
3854 *
3855 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003856 */
3857static efi_status_t EFIAPI efi_disconnect_controller(
3858 efi_handle_t controller_handle,
3859 efi_handle_t driver_image_handle,
3860 efi_handle_t child_handle)
3861{
3862 struct efi_driver_binding_protocol *binding_protocol;
3863 efi_handle_t *child_handle_buffer = NULL;
3864 size_t number_of_children = 0;
3865 efi_status_t r;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003866 struct efi_object *efiobj;
Heinrich Schuchardt314bed62020-10-28 18:45:47 +01003867 bool sole_child;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003868
3869 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3870 child_handle);
3871
3872 efiobj = efi_search_obj(controller_handle);
3873 if (!efiobj) {
3874 r = EFI_INVALID_PARAMETER;
3875 goto out;
3876 }
3877
3878 if (child_handle && !efi_search_obj(child_handle)) {
3879 r = EFI_INVALID_PARAMETER;
3880 goto out;
3881 }
3882
3883 /* If no driver handle is supplied, disconnect all drivers */
3884 if (!driver_image_handle) {
3885 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3886 goto out;
3887 }
3888
3889 /* Create list of child handles */
Heinrich Schuchardt314bed62020-10-28 18:45:47 +01003890 r = efi_get_child_controllers(efiobj,
3891 driver_image_handle,
3892 &number_of_children,
3893 &child_handle_buffer);
3894 if (r != EFI_SUCCESS)
3895 return r;
3896 sole_child = (number_of_children == 1);
3897
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003898 if (child_handle) {
3899 number_of_children = 1;
Heinrich Schuchardt314bed62020-10-28 18:45:47 +01003900 free(child_handle_buffer);
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003901 child_handle_buffer = &child_handle;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003902 }
3903
3904 /* Get the driver binding protocol */
3905 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3906 &efi_guid_driver_binding_protocol,
3907 (void **)&binding_protocol,
3908 driver_image_handle, NULL,
3909 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003910 if (r != EFI_SUCCESS) {
3911 r = EFI_INVALID_PARAMETER;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003912 goto out;
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003913 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003914 /* Remove the children */
3915 if (number_of_children) {
3916 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3917 controller_handle,
3918 number_of_children,
3919 child_handle_buffer));
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003920 if (r != EFI_SUCCESS) {
3921 r = EFI_DEVICE_ERROR;
3922 goto out;
3923 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003924 }
3925 /* Remove the driver */
Heinrich Schuchardt314bed62020-10-28 18:45:47 +01003926 if (!child_handle || sole_child) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003927 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3928 controller_handle,
3929 0, NULL));
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003930 if (r != EFI_SUCCESS) {
3931 r = EFI_DEVICE_ERROR;
3932 goto out;
3933 }
3934 }
Heinrich Schuchardtef185762022-10-07 15:18:15 +02003935 efi_close_protocol(driver_image_handle,
3936 &efi_guid_driver_binding_protocol,
3937 driver_image_handle, NULL);
Heinrich Schuchardt7dc10c92019-09-13 18:20:40 +02003938 r = EFI_SUCCESS;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003939out:
3940 if (!child_handle)
3941 free(child_handle_buffer);
3942 return EFI_EXIT(r);
3943}
3944
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003945static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003946 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003947 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3948 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003949 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003950 },
3951 .raise_tpl = efi_raise_tpl,
3952 .restore_tpl = efi_restore_tpl,
3953 .allocate_pages = efi_allocate_pages_ext,
3954 .free_pages = efi_free_pages_ext,
3955 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003956 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003957 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003958 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003959 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003960 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003961 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003962 .close_event = efi_close_event,
3963 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003964 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003965 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003966 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003967 .handle_protocol = efi_handle_protocol,
3968 .reserved = NULL,
3969 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003970 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003971 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003972 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003973 .load_image = efi_load_image,
3974 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003975 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003976 .unload_image = efi_unload_image,
3977 .exit_boot_services = efi_exit_boot_services,
3978 .get_next_monotonic_count = efi_get_next_monotonic_count,
3979 .stall = efi_stall,
3980 .set_watchdog_timer = efi_set_watchdog_timer,
3981 .connect_controller = efi_connect_controller,
3982 .disconnect_controller = efi_disconnect_controller,
3983 .open_protocol = efi_open_protocol,
Heinrich Schuchardtef185762022-10-07 15:18:15 +02003984 .close_protocol = efi_close_protocol_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003985 .open_protocol_information = efi_open_protocol_information,
3986 .protocols_per_handle = efi_protocols_per_handle,
3987 .locate_handle_buffer = efi_locate_handle_buffer,
3988 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003989 .install_multiple_protocol_interfaces =
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03003990 efi_install_multiple_protocol_interfaces_ext,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003991 .uninstall_multiple_protocol_interfaces =
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +03003992 efi_uninstall_multiple_protocol_interfaces_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003993 .calculate_crc32 = efi_calculate_crc32,
3994 .copy_mem = efi_copy_mem,
3995 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003996 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003997};
3998
Simon Glass156ccbc2022-01-23 12:55:12 -07003999static u16 __efi_runtime_data firmware_vendor[] = u"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01004000
Alexander Graf3c63db92016-10-14 13:45:30 +02004001struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01004002 .hdr = {
4003 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02004004 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02004005 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01004006 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02004007 .fw_vendor = firmware_vendor,
4008 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardt3c783bf2019-06-15 14:51:06 +02004009 .runtime = &efi_runtime_services,
Alexander Grafbee91162016-03-04 01:09:59 +01004010 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02004011 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01004012};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02004013
4014/**
4015 * efi_initialize_system_table() - Initialize system table
4016 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02004017 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02004018 */
4019efi_status_t efi_initialize_system_table(void)
4020{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02004021 efi_status_t ret;
4022
4023 /* Allocate configuration table array */
4024 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
4025 EFI_MAX_CONFIGURATION_TABLES *
4026 sizeof(struct efi_configuration_table),
4027 (void **)&systab.tables);
4028
Heinrich Schuchardt93148eb2019-06-29 02:00:16 +02004029 /*
4030 * These entries will be set to NULL in ExitBootServices(). To avoid
4031 * relocation in SetVirtualAddressMap(), set them dynamically.
4032 */
Heinrich Schuchardt60bba6e2023-01-04 05:56:09 +01004033 systab.con_in_handle = efi_root;
Heinrich Schuchardt93148eb2019-06-29 02:00:16 +02004034 systab.con_in = &efi_con_in;
Heinrich Schuchardt60bba6e2023-01-04 05:56:09 +01004035 systab.con_out_handle = efi_root;
Heinrich Schuchardt93148eb2019-06-29 02:00:16 +02004036 systab.con_out = &efi_con_out;
Heinrich Schuchardt60bba6e2023-01-04 05:56:09 +01004037 systab.stderr_handle = efi_root;
Heinrich Schuchardt93148eb2019-06-29 02:00:16 +02004038 systab.std_err = &efi_con_out;
4039 systab.boottime = &efi_boot_services;
4040
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02004041 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02004042 efi_update_table_header_crc32(&systab.hdr);
4043 efi_update_table_header_crc32(&efi_runtime_services.hdr);
4044 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02004045
4046 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02004047}