blob: 027bd6d4d32146f3dbd08afc433770bc6abcb409 [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/*
3 * EFI application boot time services
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafbee91162016-03-04 01:09:59 +01006 */
7
Alexander Grafbee91162016-03-04 01:09:59 +01008#include <common.h>
Heinrich Schuchardt7d963322017-10-05 16:14:14 +02009#include <div64.h>
Alexander Grafbee91162016-03-04 01:09:59 +010010#include <efi_loader.h>
Rob Clarkad644e72017-09-13 18:05:37 -040011#include <environment.h>
Alexander Grafbee91162016-03-04 01:09:59 +010012#include <malloc.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090013#include <linux/libfdt_env.h>
Alexander Grafbee91162016-03-04 01:09:59 +010014#include <u-boot/crc.h>
15#include <bootm.h>
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +020016#include <pe.h>
Alexander Grafbee91162016-03-04 01:09:59 +010017#include <watchdog.h>
18
19DECLARE_GLOBAL_DATA_PTR;
20
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020021/* Task priority level */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +010022static efi_uintn_t efi_tpl = TPL_APPLICATION;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020023
Alexander Grafbee91162016-03-04 01:09:59 +010024/* This list contains all the EFI objects our payload has access to */
25LIST_HEAD(efi_obj_list);
26
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010027/* List of all events */
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +010028LIST_HEAD(efi_events);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010029
Heinrich Schuchardtab15d412019-05-04 17:27:54 +020030/* List of all events registered by RegisterProtocolNotify() */
31LIST_HEAD(efi_register_notify_events);
32
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +010033/* Handle of the currently executing image */
34static efi_handle_t current_image;
35
Alexander Graff31239a2018-11-15 21:23:47 +010036/*
37 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
38 * we need to do trickery with caches. Since we don't want to break the EFI
39 * aware boot path, only apply hacks when loading exiting directly (breaking
40 * direct Linux EFI booting along the way - oh well).
41 */
42static bool efi_is_direct_boot = true;
43
Simon Glass65e4c0b2016-09-25 15:27:35 -060044#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +010045/*
46 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
47 * fixed when compiling U-Boot. However, the payload does not know about that
48 * restriction so we need to manually swap its and our view of that register on
49 * EFI callback entry/exit.
50 */
51static volatile void *efi_gd, *app_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -060052#endif
Alexander Grafbee91162016-03-04 01:09:59 +010053
Heinrich Schuchardt914df752019-02-09 14:10:39 +010054/* 1 if inside U-Boot code, 0 if inside EFI payload code */
55static int entry_count = 1;
Rob Clarkaf65db82017-07-27 08:04:19 -040056static int nesting_level;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +010057/* GUID of the device tree table */
58const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +010059/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60const efi_guid_t efi_guid_driver_binding_protocol =
61 EFI_DRIVER_BINDING_PROTOCOL_GUID;
Rob Clarkc160d2f2017-07-27 08:04:18 -040062
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010063/* event group ExitBootServices() invoked */
64const efi_guid_t efi_guid_event_group_exit_boot_services =
65 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
66/* event group SetVirtualAddressMap() invoked */
67const efi_guid_t efi_guid_event_group_virtual_address_change =
68 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
69/* event group memory map changed */
70const efi_guid_t efi_guid_event_group_memory_map_change =
71 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
72/* event group boot manager about to boot */
73const efi_guid_t efi_guid_event_group_ready_to_boot =
74 EFI_EVENT_GROUP_READY_TO_BOOT;
75/* event group ResetSystem() invoked (before ExitBootServices) */
76const efi_guid_t efi_guid_event_group_reset_system =
77 EFI_EVENT_GROUP_RESET_SYSTEM;
78
Heinrich Schuchardt2074f702018-01-11 08:16:09 +010079static efi_status_t EFIAPI efi_disconnect_controller(
80 efi_handle_t controller_handle,
81 efi_handle_t driver_image_handle,
82 efi_handle_t child_handle);
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +010083
Rob Clarkc160d2f2017-07-27 08:04:18 -040084/* Called on every callback entry */
85int __efi_entry_check(void)
86{
87 int ret = entry_count++ == 0;
88#ifdef CONFIG_ARM
89 assert(efi_gd);
90 app_gd = gd;
91 gd = efi_gd;
92#endif
93 return ret;
94}
95
96/* Called on every callback exit */
97int __efi_exit_check(void)
98{
99 int ret = --entry_count == 0;
100#ifdef CONFIG_ARM
101 gd = app_gd;
102#endif
103 return ret;
104}
105
Alexander Grafbee91162016-03-04 01:09:59 +0100106/* Called from do_bootefi_exec() */
107void efi_save_gd(void)
108{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600109#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100110 efi_gd = gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600111#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100112}
113
Rob Clarkc160d2f2017-07-27 08:04:18 -0400114/*
Mario Six78a88f72018-07-10 08:40:17 +0200115 * Special case handler for error/abort that just forces things back to u-boot
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200116 * world so we can dump out an abort message, without any care about returning
117 * back to UEFI world.
Rob Clarkc160d2f2017-07-27 08:04:18 -0400118 */
Alexander Grafbee91162016-03-04 01:09:59 +0100119void efi_restore_gd(void)
120{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600121#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100122 /* Only restore if we're already in EFI context */
123 if (!efi_gd)
124 return;
Alexander Grafbee91162016-03-04 01:09:59 +0100125 gd = efi_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600126#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100127}
128
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200129/**
Mario Six78a88f72018-07-10 08:40:17 +0200130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
Heinrich Schuchardtc8df80c2018-01-24 19:21:36 +0100132 *
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200133 * A maximum of ten indent levels is supported. Higher indent levels will be
134 * truncated.
135 *
Mario Six78a88f72018-07-10 08:40:17 +0200136 * Return: A string for indenting with two spaces per level is
137 * returned.
Rob Clarkaf65db82017-07-27 08:04:19 -0400138 */
139static const char *indent_string(int level)
140{
141 const char *indent = " ";
142 const int max = strlen(indent);
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +0100143
Rob Clarkaf65db82017-07-27 08:04:19 -0400144 level = min(max, level * 2);
145 return &indent[max - level];
146}
147
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200148const char *__efi_nesting(void)
149{
150 return indent_string(nesting_level);
151}
152
Rob Clarkaf65db82017-07-27 08:04:19 -0400153const char *__efi_nesting_inc(void)
154{
155 return indent_string(nesting_level++);
156}
157
158const char *__efi_nesting_dec(void)
159{
160 return indent_string(--nesting_level);
161}
162
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200163/**
Mario Six78a88f72018-07-10 08:40:17 +0200164 * efi_queue_event() - queue an EFI event
165 * @event: event to signal
166 * @check_tpl: check the TPL level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200167 *
168 * This function queues the notification function of the event for future
169 * execution.
170 *
Mario Six78a88f72018-07-10 08:40:17 +0200171 * The notification function is called if the task priority level of the event
172 * is higher than the current task priority level.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200173 *
174 * For the SignalEvent service see efi_signal_event_ext.
175 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200176 */
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100177static void efi_queue_event(struct efi_event *event, bool check_tpl)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200178{
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200179 if (event->notify_function) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200180 event->is_queued = true;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200181 /* Check TPL */
Heinrich Schuchardt9bc96642018-01-19 20:24:51 +0100182 if (check_tpl && efi_tpl >= event->notify_tpl)
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200183 return;
Heinrich Schuchardt3b985112019-05-11 21:44:59 +0200184 event->is_queued = false;
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200185 EFI_CALL_VOID(event->notify_function(event,
186 event->notify_context));
Heinrich Schuchardt3b985112019-05-11 21:44:59 +0200187 } else {
188 event->is_queued = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200189 }
190}
191
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200192/**
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200193 * is_valid_tpl() - check if the task priority level is valid
194 *
195 * @tpl: TPL level to check
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200196 * Return: status code
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200197 */
198efi_status_t is_valid_tpl(efi_uintn_t tpl)
199{
200 switch (tpl) {
201 case TPL_APPLICATION:
202 case TPL_CALLBACK:
203 case TPL_NOTIFY:
204 case TPL_HIGH_LEVEL:
205 return EFI_SUCCESS;
206 default:
207 return EFI_INVALID_PARAMETER;
208 }
209}
210
211/**
Mario Six78a88f72018-07-10 08:40:17 +0200212 * efi_signal_event() - signal an EFI event
213 * @event: event to signal
214 * @check_tpl: check the TPL level
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100215 *
Mario Six78a88f72018-07-10 08:40:17 +0200216 * This function signals an event. If the event belongs to an event group all
217 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100218 * their notification function is queued.
219 *
220 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100221 */
222void efi_signal_event(struct efi_event *event, bool check_tpl)
223{
224 if (event->group) {
225 struct efi_event *evt;
226
227 /*
228 * The signaled state has to set before executing any
229 * notification function
230 */
231 list_for_each_entry(evt, &efi_events, link) {
232 if (!evt->group || guidcmp(evt->group, event->group))
233 continue;
234 if (evt->is_signaled)
235 continue;
236 evt->is_signaled = true;
237 if (evt->type & EVT_NOTIFY_SIGNAL &&
238 evt->notify_function)
239 evt->is_queued = true;
240 }
241 list_for_each_entry(evt, &efi_events, link) {
242 if (!evt->group || guidcmp(evt->group, event->group))
243 continue;
244 if (evt->is_queued)
245 efi_queue_event(evt, check_tpl);
246 }
Heinrich Schuchardt3626e532019-05-05 00:07:34 +0200247 } else {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100248 event->is_signaled = true;
249 if (event->type & EVT_NOTIFY_SIGNAL)
250 efi_queue_event(event, check_tpl);
251 }
252}
253
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200254/**
Mario Six78a88f72018-07-10 08:40:17 +0200255 * efi_raise_tpl() - raise the task priority level
256 * @new_tpl: new value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200257 *
258 * This function implements the RaiseTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200259 *
Mario Six78a88f72018-07-10 08:40:17 +0200260 * See the Unified Extensible Firmware Interface (UEFI) specification for
261 * details.
262 *
263 * Return: old value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200264 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100265static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100266{
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100267 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200268
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200269 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200270
271 if (new_tpl < efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200272 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200273 efi_tpl = new_tpl;
274 if (efi_tpl > TPL_HIGH_LEVEL)
275 efi_tpl = TPL_HIGH_LEVEL;
276
277 EFI_EXIT(EFI_SUCCESS);
278 return old_tpl;
Alexander Grafbee91162016-03-04 01:09:59 +0100279}
280
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200281/**
Mario Six78a88f72018-07-10 08:40:17 +0200282 * efi_restore_tpl() - lower the task priority level
283 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200284 *
285 * This function implements the RestoreTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200286 *
Mario Six78a88f72018-07-10 08:40:17 +0200287 * See the Unified Extensible Firmware Interface (UEFI) specification for
288 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200289 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100290static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100291{
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200292 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200293
294 if (old_tpl > efi_tpl)
Heinrich Schuchardt529886a2019-05-05 11:56:23 +0200295 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200296 efi_tpl = old_tpl;
297 if (efi_tpl > TPL_HIGH_LEVEL)
298 efi_tpl = TPL_HIGH_LEVEL;
299
Heinrich Schuchardt0f7fcc72018-03-24 18:40:21 +0100300 /*
301 * Lowering the TPL may have made queued events eligible for execution.
302 */
303 efi_timer_check();
304
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200305 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100306}
307
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200308/**
Mario Six78a88f72018-07-10 08:40:17 +0200309 * efi_allocate_pages_ext() - allocate memory pages
310 * @type: type of allocation to be performed
311 * @memory_type: usage type of the allocated memory
312 * @pages: number of pages to be allocated
313 * @memory: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200314 *
315 * This function implements the AllocatePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200316 *
Mario Six78a88f72018-07-10 08:40:17 +0200317 * See the Unified Extensible Firmware Interface (UEFI) specification for
318 * details.
319 *
320 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200321 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900322static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100323 efi_uintn_t pages,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900324 uint64_t *memory)
Alexander Grafbee91162016-03-04 01:09:59 +0100325{
326 efi_status_t r;
327
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100328 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafbee91162016-03-04 01:09:59 +0100329 r = efi_allocate_pages(type, memory_type, pages, memory);
330 return EFI_EXIT(r);
331}
332
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200333/**
Mario Six78a88f72018-07-10 08:40:17 +0200334 * efi_free_pages_ext() - Free memory pages.
335 * @memory: start of the memory area to be freed
336 * @pages: number of pages to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200337 *
338 * This function implements the FreePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200339 *
Mario Six78a88f72018-07-10 08:40:17 +0200340 * See the Unified Extensible Firmware Interface (UEFI) specification for
341 * details.
342 *
343 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200344 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900345static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100346 efi_uintn_t pages)
Alexander Grafbee91162016-03-04 01:09:59 +0100347{
348 efi_status_t r;
349
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900350 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafbee91162016-03-04 01:09:59 +0100351 r = efi_free_pages(memory, pages);
352 return EFI_EXIT(r);
353}
354
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200355/**
Mario Six78a88f72018-07-10 08:40:17 +0200356 * efi_get_memory_map_ext() - get map describing memory usage
357 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
358 * on exit the size of the copied memory map
359 * @memory_map: buffer to which the memory map is written
360 * @map_key: key for the memory map
361 * @descriptor_size: size of an individual memory descriptor
362 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200363 *
364 * This function implements the GetMemoryMap service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200365 *
Mario Six78a88f72018-07-10 08:40:17 +0200366 * See the Unified Extensible Firmware Interface (UEFI) specification for
367 * details.
368 *
369 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200370 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900371static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100372 efi_uintn_t *memory_map_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900373 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100374 efi_uintn_t *map_key,
375 efi_uintn_t *descriptor_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900376 uint32_t *descriptor_version)
Alexander Grafbee91162016-03-04 01:09:59 +0100377{
378 efi_status_t r;
379
380 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
381 map_key, descriptor_size, descriptor_version);
382 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
383 descriptor_size, descriptor_version);
384 return EFI_EXIT(r);
385}
386
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200387/**
Mario Six78a88f72018-07-10 08:40:17 +0200388 * efi_allocate_pool_ext() - allocate memory from pool
389 * @pool_type: type of the pool from which memory is to be allocated
390 * @size: number of bytes to be allocated
391 * @buffer: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200392 *
393 * This function implements the AllocatePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200394 *
Mario Six78a88f72018-07-10 08:40:17 +0200395 * See the Unified Extensible Firmware Interface (UEFI) specification for
396 * details.
397 *
398 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200399 */
Stefan Brünsead12742016-10-09 22:17:18 +0200400static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100401 efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200402 void **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100403{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100404 efi_status_t r;
405
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100406 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
Stefan Brünsead12742016-10-09 22:17:18 +0200407 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100408 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100409}
410
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200411/**
Mario Six78a88f72018-07-10 08:40:17 +0200412 * efi_free_pool_ext() - free memory from pool
413 * @buffer: start of memory to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200414 *
415 * This function implements the FreePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200416 *
Mario Six78a88f72018-07-10 08:40:17 +0200417 * See the Unified Extensible Firmware Interface (UEFI) specification for
418 * details.
419 *
420 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200421 */
Stefan Brüns42417bc2016-10-09 22:17:26 +0200422static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100423{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100424 efi_status_t r;
425
426 EFI_ENTRY("%p", buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200427 r = efi_free_pool(buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100428 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100429}
430
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200431/**
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200432 * efi_add_handle() - add a new handle to the object list
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100433 *
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200434 * @handle: handle to be added
435 *
436 * The protocols list is initialized. The handle is added to the list of known
437 * UEFI objects.
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100438 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200439void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100440{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200441 if (!handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100442 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200443 INIT_LIST_HEAD(&handle->protocols);
444 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100445}
446
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200447/**
Mario Six78a88f72018-07-10 08:40:17 +0200448 * efi_create_handle() - create handle
449 * @handle: new handle
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200450 *
Mario Six78a88f72018-07-10 08:40:17 +0200451 * Return: status code
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200452 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100453efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200454{
455 struct efi_object *obj;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200456
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200457 obj = calloc(1, sizeof(struct efi_object));
458 if (!obj)
459 return EFI_OUT_OF_RESOURCES;
460
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100461 efi_add_handle(obj);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200462 *handle = obj;
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200463
464 return EFI_SUCCESS;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200465}
466
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200467/**
Mario Six78a88f72018-07-10 08:40:17 +0200468 * efi_search_protocol() - find a protocol on a handle.
469 * @handle: handle
470 * @protocol_guid: GUID of the protocol
471 * @handler: reference to the protocol
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100472 *
Mario Six78a88f72018-07-10 08:40:17 +0200473 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100474 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100475efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100476 const efi_guid_t *protocol_guid,
477 struct efi_handler **handler)
478{
479 struct efi_object *efiobj;
480 struct list_head *lhandle;
481
482 if (!handle || !protocol_guid)
483 return EFI_INVALID_PARAMETER;
484 efiobj = efi_search_obj(handle);
485 if (!efiobj)
486 return EFI_INVALID_PARAMETER;
487 list_for_each(lhandle, &efiobj->protocols) {
488 struct efi_handler *protocol;
489
490 protocol = list_entry(lhandle, struct efi_handler, link);
491 if (!guidcmp(protocol->guid, protocol_guid)) {
492 if (handler)
493 *handler = protocol;
494 return EFI_SUCCESS;
495 }
496 }
497 return EFI_NOT_FOUND;
498}
499
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200500/**
Mario Six78a88f72018-07-10 08:40:17 +0200501 * efi_remove_protocol() - delete protocol from a handle
502 * @handle: handle from which the protocol shall be deleted
503 * @protocol: GUID of the protocol to be deleted
504 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100505 *
Mario Six78a88f72018-07-10 08:40:17 +0200506 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100507 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100508efi_status_t efi_remove_protocol(const efi_handle_t handle,
509 const efi_guid_t *protocol,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100510 void *protocol_interface)
511{
512 struct efi_handler *handler;
513 efi_status_t ret;
514
515 ret = efi_search_protocol(handle, protocol, &handler);
516 if (ret != EFI_SUCCESS)
517 return ret;
Heinrich Schuchardt1f470e12018-05-11 12:09:21 +0200518 if (handler->protocol_interface != protocol_interface)
Heinrich Schuchardt96aa99c2019-05-10 20:06:48 +0200519 return EFI_NOT_FOUND;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100520 list_del(&handler->link);
521 free(handler);
522 return EFI_SUCCESS;
523}
524
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200525/**
Mario Six78a88f72018-07-10 08:40:17 +0200526 * efi_remove_all_protocols() - delete all protocols from a handle
527 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100528 *
Mario Six78a88f72018-07-10 08:40:17 +0200529 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100530 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100531efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100532{
533 struct efi_object *efiobj;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100534 struct efi_handler *protocol;
535 struct efi_handler *pos;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100536
537 efiobj = efi_search_obj(handle);
538 if (!efiobj)
539 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100540 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100541 efi_status_t ret;
542
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100543 ret = efi_remove_protocol(handle, protocol->guid,
544 protocol->protocol_interface);
545 if (ret != EFI_SUCCESS)
546 return ret;
547 }
548 return EFI_SUCCESS;
549}
550
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200551/**
Mario Six78a88f72018-07-10 08:40:17 +0200552 * efi_delete_handle() - delete handle
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100553 *
Mario Six78a88f72018-07-10 08:40:17 +0200554 * @obj: handle to delete
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100555 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200556void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100557{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200558 if (!handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100559 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200560 efi_remove_all_protocols(handle);
561 list_del(&handle->link);
562 free(handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100563}
564
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200565/**
Mario Six78a88f72018-07-10 08:40:17 +0200566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100568 *
Mario Six78a88f72018-07-10 08:40:17 +0200569 * Return: status code
Alexander Grafbee91162016-03-04 01:09:59 +0100570 */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100571static efi_status_t efi_is_event(const struct efi_event *event)
572{
573 const struct efi_event *evt;
574
575 if (!event)
576 return EFI_INVALID_PARAMETER;
577 list_for_each_entry(evt, &efi_events, link) {
578 if (evt == event)
579 return EFI_SUCCESS;
580 }
581 return EFI_INVALID_PARAMETER;
582}
Alexander Grafbee91162016-03-04 01:09:59 +0100583
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200584/**
Mario Six78a88f72018-07-10 08:40:17 +0200585 * efi_create_event() - create an event
586 * @type: type of the event to create
587 * @notify_tpl: task priority level of the event
588 * @notify_function: notification function of the event
589 * @notify_context: pointer passed to the notification function
590 * @group: event group
591 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200592 *
593 * This function is used inside U-Boot code to create an event.
594 *
595 * For the API function implementing the CreateEvent service see
596 * efi_create_event_ext.
597 *
Mario Six78a88f72018-07-10 08:40:17 +0200598 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200599 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100600efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200601 void (EFIAPI *notify_function) (
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200602 struct efi_event *event,
603 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100604 void *notify_context, efi_guid_t *group,
605 struct efi_event **event)
Alexander Grafbee91162016-03-04 01:09:59 +0100606{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100607 struct efi_event *evt;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200608
Jonathan Graya95343b2017-03-12 19:26:07 +1100609 if (event == NULL)
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200610 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100611
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200612 switch (type) {
613 case 0:
614 case EVT_TIMER:
615 case EVT_NOTIFY_SIGNAL:
616 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
617 case EVT_NOTIFY_WAIT:
618 case EVT_TIMER | EVT_NOTIFY_WAIT:
619 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
620 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
621 break;
622 default:
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200623 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200624 }
Jonathan Graya95343b2017-03-12 19:26:07 +1100625
AKASHI Takahiro3748ed92018-08-10 15:36:32 +0900626 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardt751e9282019-04-25 07:30:41 +0200627 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200628 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100629
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100630 evt = calloc(1, sizeof(struct efi_event));
631 if (!evt)
632 return EFI_OUT_OF_RESOURCES;
633 evt->type = type;
634 evt->notify_tpl = notify_tpl;
635 evt->notify_function = notify_function;
636 evt->notify_context = notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100637 evt->group = group;
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200638 /* Disable timers on boot up */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100639 evt->trigger_next = -1ULL;
640 evt->is_queued = false;
641 evt->is_signaled = false;
642 list_add_tail(&evt->link, &efi_events);
643 *event = evt;
644 return EFI_SUCCESS;
Alexander Grafbee91162016-03-04 01:09:59 +0100645}
646
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200647/*
Mario Six78a88f72018-07-10 08:40:17 +0200648 * efi_create_event_ex() - create an event in a group
649 * @type: type of the event to create
650 * @notify_tpl: task priority level of the event
651 * @notify_function: notification function of the event
652 * @notify_context: pointer passed to the notification function
653 * @event: created event
654 * @event_group: event group
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100655 *
656 * This function implements the CreateEventEx service.
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100657 *
Mario Six78a88f72018-07-10 08:40:17 +0200658 * See the Unified Extensible Firmware Interface (UEFI) specification for
659 * details.
660 *
661 * Return: status code
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100662 */
663efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
664 void (EFIAPI *notify_function) (
665 struct efi_event *event,
666 void *context),
667 void *notify_context,
668 efi_guid_t *event_group,
669 struct efi_event **event)
670{
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200671 efi_status_t ret;
672
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100673 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
674 notify_context, event_group);
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200675
676 /*
677 * The allowable input parameters are the same as in CreateEvent()
678 * except for the following two disallowed event types.
679 */
680 switch (type) {
681 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
682 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
683 ret = EFI_INVALID_PARAMETER;
684 goto out;
685 }
686
687 ret = efi_create_event(type, notify_tpl, notify_function,
688 notify_context, event_group, event);
689out:
690 return EFI_EXIT(ret);
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100691}
692
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200693/**
Mario Six78a88f72018-07-10 08:40:17 +0200694 * efi_create_event_ext() - create an event
695 * @type: type of the event to create
696 * @notify_tpl: task priority level of the event
697 * @notify_function: notification function of the event
698 * @notify_context: pointer passed to the notification function
699 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200700 *
701 * This function implements the CreateEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200702 *
Mario Six78a88f72018-07-10 08:40:17 +0200703 * See the Unified Extensible Firmware Interface (UEFI) specification for
704 * details.
705 *
706 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200707 */
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200708static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100709 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200710 void (EFIAPI *notify_function) (
711 struct efi_event *event,
712 void *context),
713 void *notify_context, struct efi_event **event)
714{
715 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
716 notify_context);
717 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100718 notify_context, NULL, event));
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200719}
720
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200721/**
Mario Six78a88f72018-07-10 08:40:17 +0200722 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200723 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200724 * Check if a timer event has occurred or a queued notification function should
725 * be called.
726 *
Alexander Grafbee91162016-03-04 01:09:59 +0100727 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200728 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafbee91162016-03-04 01:09:59 +0100729 */
730void efi_timer_check(void)
731{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100732 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +0100733 u64 now = timer_get_us();
734
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100735 list_for_each_entry(evt, &efi_events, link) {
736 if (evt->is_queued)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100737 efi_queue_event(evt, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100738 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200739 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100740 switch (evt->trigger_type) {
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200741 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100742 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200743 break;
744 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100745 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200746 break;
747 default:
748 continue;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200749 }
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100750 evt->is_signaled = false;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100751 efi_signal_event(evt, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100752 }
Alexander Grafbee91162016-03-04 01:09:59 +0100753 WATCHDOG_RESET();
754}
755
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200756/**
Mario Six78a88f72018-07-10 08:40:17 +0200757 * efi_set_timer() - set the trigger time for a timer event or stop the event
758 * @event: event for which the timer is set
759 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200760 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200761 *
762 * This is the function for internal usage in U-Boot. For the API function
763 * implementing the SetTimer service see efi_set_timer_ext.
764 *
Mario Six78a88f72018-07-10 08:40:17 +0200765 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200766 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200767efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200768 uint64_t trigger_time)
Alexander Grafbee91162016-03-04 01:09:59 +0100769{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100770 /* Check that the event is valid */
771 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
772 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100773
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200774 /*
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200775 * The parameter defines a multiple of 100 ns.
776 * We use multiples of 1000 ns. So divide by 10.
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200777 */
Heinrich Schuchardt7d963322017-10-05 16:14:14 +0200778 do_div(trigger_time, 10);
Alexander Grafbee91162016-03-04 01:09:59 +0100779
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100780 switch (type) {
781 case EFI_TIMER_STOP:
782 event->trigger_next = -1ULL;
783 break;
784 case EFI_TIMER_PERIODIC:
785 case EFI_TIMER_RELATIVE:
786 event->trigger_next = timer_get_us() + trigger_time;
787 break;
788 default:
789 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100790 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100791 event->trigger_type = type;
792 event->trigger_time = trigger_time;
793 event->is_signaled = false;
794 return EFI_SUCCESS;
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200795}
796
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200797/**
Mario Six78a88f72018-07-10 08:40:17 +0200798 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
799 * event
800 * @event: event for which the timer is set
801 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200802 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200803 *
804 * This function implements the SetTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200805 *
Mario Six78a88f72018-07-10 08:40:17 +0200806 * See the Unified Extensible Firmware Interface (UEFI) specification for
807 * details.
808 *
809 *
810 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200811 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200812static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
813 enum efi_timer_delay type,
814 uint64_t trigger_time)
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200815{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900816 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200817 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
Alexander Grafbee91162016-03-04 01:09:59 +0100818}
819
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200820/**
Mario Six78a88f72018-07-10 08:40:17 +0200821 * efi_wait_for_event() - wait for events to be signaled
822 * @num_events: number of events to be waited for
823 * @event: events to be waited for
824 * @index: index of the event that was signaled
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200825 *
826 * This function implements the WaitForEvent 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 */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100833static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200834 struct efi_event **event,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100835 efi_uintn_t *index)
Alexander Grafbee91162016-03-04 01:09:59 +0100836{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100837 int i;
Alexander Grafbee91162016-03-04 01:09:59 +0100838
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100839 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
Alexander Grafbee91162016-03-04 01:09:59 +0100840
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200841 /* Check parameters */
842 if (!num_events || !event)
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200844 /* Check TPL */
845 if (efi_tpl != TPL_APPLICATION)
846 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200847 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100848 if (efi_is_event(event[i]) != EFI_SUCCESS)
849 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200850 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
851 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200852 if (!event[i]->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100853 efi_queue_event(event[i], true);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200854 }
855
856 /* Wait for signal */
857 for (;;) {
858 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200859 if (event[i]->is_signaled)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200860 goto out;
861 }
862 /* Allow events to occur. */
863 efi_timer_check();
864 }
865
866out:
867 /*
868 * Reset the signal which is passed to the caller to allow periodic
869 * events to occur.
870 */
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200871 event[i]->is_signaled = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200872 if (index)
873 *index = i;
Alexander Grafbee91162016-03-04 01:09:59 +0100874
875 return EFI_EXIT(EFI_SUCCESS);
876}
877
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200878/**
Mario Six78a88f72018-07-10 08:40:17 +0200879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200881 *
882 * This function implements the SignalEvent service.
Mario Six78a88f72018-07-10 08:40:17 +0200883 *
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
885 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200886 *
887 * This functions sets the signaled state of the event and queues the
888 * notification function for execution.
889 *
Mario Six78a88f72018-07-10 08:40:17 +0200890 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200891 */
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200892static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100893{
894 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100895 if (efi_is_event(event) != EFI_SUCCESS)
896 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100897 efi_signal_event(event, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100898 return EFI_EXIT(EFI_SUCCESS);
899}
900
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200901/**
Mario Six78a88f72018-07-10 08:40:17 +0200902 * efi_close_event() - close an EFI event
903 * @event: event to close
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200904 *
905 * This function implements the CloseEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200906 *
Mario Six78a88f72018-07-10 08:40:17 +0200907 * See the Unified Extensible Firmware Interface (UEFI) specification for
908 * details.
909 *
910 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200911 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200912static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100913{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200914 struct efi_register_notify_event *item, *next;
915
Alexander Grafbee91162016-03-04 01:09:59 +0100916 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100917 if (efi_is_event(event) != EFI_SUCCESS)
918 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200919
920 /* Remove protocol notify registrations for the event */
921 list_for_each_entry_safe(item, next, &efi_register_notify_events,
922 link) {
923 if (event == item->event) {
924 list_del(&item->link);
925 free(item);
926 }
927 }
928
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100929 list_del(&event->link);
930 free(event);
931 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100932}
933
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200934/**
Mario Six78a88f72018-07-10 08:40:17 +0200935 * efi_check_event() - check if an event is signaled
936 * @event: event to check
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200937 *
938 * This function implements the CheckEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200939 *
Mario Six78a88f72018-07-10 08:40:17 +0200940 * See the Unified Extensible Firmware Interface (UEFI) specification for
941 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200942 *
Mario Six78a88f72018-07-10 08:40:17 +0200943 * If an event is not signaled yet, the notification function is queued. The
944 * signaled state is cleared.
945 *
946 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200947 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200948static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100949{
950 EFI_ENTRY("%p", event);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200951 efi_timer_check();
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100952 if (efi_is_event(event) != EFI_SUCCESS ||
953 event->type & EVT_NOTIFY_SIGNAL)
954 return EFI_EXIT(EFI_INVALID_PARAMETER);
955 if (!event->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100956 efi_queue_event(event, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100957 if (event->is_signaled) {
958 event->is_signaled = false;
959 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200960 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100961 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafbee91162016-03-04 01:09:59 +0100962}
963
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200964/**
Mario Six78a88f72018-07-10 08:40:17 +0200965 * efi_search_obj() - find the internal EFI object for a handle
966 * @handle: handle to find
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200967 *
Mario Six78a88f72018-07-10 08:40:17 +0200968 * Return: EFI object
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200969 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100970struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200971{
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100972 struct efi_object *efiobj;
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200973
Heinrich Schuchardtec163fa2019-05-05 10:37:51 +0200974 if (!handle)
975 return NULL;
976
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100977 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200978 if (efiobj == handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200979 return efiobj;
980 }
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200981 return NULL;
982}
983
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200984/**
Mario Six78a88f72018-07-10 08:40:17 +0200985 * efi_open_protocol_info_entry() - create open protocol info entry and add it
986 * to a protocol
987 * @handler: handler of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100988 *
Mario Six78a88f72018-07-10 08:40:17 +0200989 * Return: open protocol info entry
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100990 */
991static struct efi_open_protocol_info_entry *efi_create_open_info(
992 struct efi_handler *handler)
993{
994 struct efi_open_protocol_info_item *item;
995
996 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
997 if (!item)
998 return NULL;
999 /* Append the item to the open protocol info list. */
1000 list_add_tail(&item->link, &handler->open_infos);
1001
1002 return &item->info;
1003}
1004
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001005/**
Mario Six78a88f72018-07-10 08:40:17 +02001006 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1007 * @item: open protocol info entry to delete
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001008 *
Mario Six78a88f72018-07-10 08:40:17 +02001009 * Return: status code
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001010 */
1011static efi_status_t efi_delete_open_info(
1012 struct efi_open_protocol_info_item *item)
1013{
1014 list_del(&item->link);
1015 free(item);
1016 return EFI_SUCCESS;
1017}
1018
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001019/**
Mario Six78a88f72018-07-10 08:40:17 +02001020 * efi_add_protocol() - install new protocol on a handle
1021 * @handle: handle on which the protocol shall be installed
1022 * @protocol: GUID of the protocol to be installed
1023 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001024 *
Mario Six78a88f72018-07-10 08:40:17 +02001025 * Return: status code
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001026 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001027efi_status_t efi_add_protocol(const efi_handle_t handle,
1028 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001029 void *protocol_interface)
1030{
1031 struct efi_object *efiobj;
1032 struct efi_handler *handler;
1033 efi_status_t ret;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001034 struct efi_register_notify_event *event;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001035
1036 efiobj = efi_search_obj(handle);
1037 if (!efiobj)
1038 return EFI_INVALID_PARAMETER;
1039 ret = efi_search_protocol(handle, protocol, NULL);
1040 if (ret != EFI_NOT_FOUND)
1041 return EFI_INVALID_PARAMETER;
1042 handler = calloc(1, sizeof(struct efi_handler));
1043 if (!handler)
1044 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001045 handler->guid = protocol;
1046 handler->protocol_interface = protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001047 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001048 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001049
1050 /* Notify registered events */
1051 list_for_each_entry(event, &efi_register_notify_events, link) {
1052 if (!guidcmp(protocol, &event->protocol))
1053 efi_signal_event(event->event, true);
1054 }
1055
Heinrich Schuchardtd5504142018-01-11 08:16:01 +01001056 if (!guidcmp(&efi_guid_device_path, protocol))
1057 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001058 return EFI_SUCCESS;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001059}
1060
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001061/**
Mario Six78a88f72018-07-10 08:40:17 +02001062 * efi_install_protocol_interface() - install protocol interface
1063 * @handle: handle on which the protocol shall be installed
1064 * @protocol: GUID of the protocol to be installed
1065 * @protocol_interface_type: type of the interface to be installed,
1066 * always EFI_NATIVE_INTERFACE
1067 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001068 *
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001069 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001070 *
Mario Six78a88f72018-07-10 08:40:17 +02001071 * See the Unified Extensible Firmware Interface (UEFI) specification for
1072 * details.
1073 *
1074 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001075 */
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001076static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02001077 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001078 int protocol_interface_type, void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001079{
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001080 efi_status_t r;
1081
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001082 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1083 protocol_interface);
1084
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001085 if (!handle || !protocol ||
1086 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1087 r = EFI_INVALID_PARAMETER;
1088 goto out;
1089 }
1090
1091 /* Create new handle if requested. */
1092 if (!*handle) {
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +02001093 r = efi_create_handle(handle);
1094 if (r != EFI_SUCCESS)
1095 goto out;
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02001096 EFI_PRINT("new handle %p\n", *handle);
Heinrich Schuchardtaf1408e2017-10-26 19:25:43 +02001097 } else {
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02001098 EFI_PRINT("handle %p\n", *handle);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001099 }
Heinrich Schuchardt12025302017-10-26 19:25:54 +02001100 /* Add new protocol */
1101 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001102out:
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001103 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001104}
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001105
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001106/**
Mario Six78a88f72018-07-10 08:40:17 +02001107 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001108 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001109 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001110 * @number_of_drivers: number of child controllers
1111 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001112 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001113 * The allocated buffer has to be freed with free().
1114 *
Mario Six78a88f72018-07-10 08:40:17 +02001115 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001116 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001117static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001118 const efi_guid_t *protocol,
1119 efi_uintn_t *number_of_drivers,
1120 efi_handle_t **driver_handle_buffer)
1121{
1122 struct efi_handler *handler;
1123 struct efi_open_protocol_info_item *item;
1124 efi_uintn_t count = 0, i;
1125 bool duplicate;
1126
1127 /* Count all driver associations */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001128 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001129 if (protocol && guidcmp(handler->guid, protocol))
1130 continue;
1131 list_for_each_entry(item, &handler->open_infos, link) {
1132 if (item->info.attributes &
1133 EFI_OPEN_PROTOCOL_BY_DRIVER)
1134 ++count;
1135 }
1136 }
Heinrich Schuchardt66ca24a2019-06-02 01:43:33 +02001137 *number_of_drivers = 0;
1138 if (!count) {
1139 *driver_handle_buffer = NULL;
1140 return EFI_SUCCESS;
1141 }
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001142 /*
1143 * Create buffer. In case of duplicate driver assignments the buffer
1144 * will be too large. But that does not harm.
1145 */
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001146 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1147 if (!*driver_handle_buffer)
1148 return EFI_OUT_OF_RESOURCES;
1149 /* Collect unique driver handles */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001150 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001151 if (protocol && guidcmp(handler->guid, protocol))
1152 continue;
1153 list_for_each_entry(item, &handler->open_infos, link) {
1154 if (item->info.attributes &
1155 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1156 /* Check this is a new driver */
1157 duplicate = false;
1158 for (i = 0; i < *number_of_drivers; ++i) {
1159 if ((*driver_handle_buffer)[i] ==
1160 item->info.agent_handle)
1161 duplicate = true;
1162 }
1163 /* Copy handle to buffer */
1164 if (!duplicate) {
1165 i = (*number_of_drivers)++;
1166 (*driver_handle_buffer)[i] =
1167 item->info.agent_handle;
1168 }
1169 }
1170 }
1171 }
1172 return EFI_SUCCESS;
1173}
1174
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001175/**
Mario Six78a88f72018-07-10 08:40:17 +02001176 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001177 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001178 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001179 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001180 *
1181 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001182 *
Mario Six78a88f72018-07-10 08:40:17 +02001183 * See the Unified Extensible Firmware Interface (UEFI) specification for
1184 * details.
1185 *
1186 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001187 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001188static efi_status_t efi_disconnect_all_drivers
1189 (efi_handle_t handle,
1190 const efi_guid_t *protocol,
1191 efi_handle_t child_handle)
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001192{
1193 efi_uintn_t number_of_drivers;
1194 efi_handle_t *driver_handle_buffer;
1195 efi_status_t r, ret;
1196
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001197 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001198 &driver_handle_buffer);
1199 if (ret != EFI_SUCCESS)
1200 return ret;
Heinrich Schuchardt66ca24a2019-06-02 01:43:33 +02001201 if (!number_of_drivers)
1202 return EFI_SUCCESS;
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001203 ret = EFI_NOT_FOUND;
1204 while (number_of_drivers) {
1205 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001206 handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001207 driver_handle_buffer[--number_of_drivers],
1208 child_handle));
1209 if (r == EFI_SUCCESS)
1210 ret = r;
1211 }
1212 free(driver_handle_buffer);
1213 return ret;
1214}
1215
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001216/**
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001217 * efi_uninstall_protocol() - uninstall protocol interface
1218 *
Mario Six78a88f72018-07-10 08:40:17 +02001219 * @handle: handle from which the protocol shall be removed
1220 * @protocol: GUID of the protocol to be removed
1221 * @protocol_interface: interface to be removed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001222 *
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001223 * This function DOES NOT delete a handle without installed protocol.
Mario Six78a88f72018-07-10 08:40:17 +02001224 *
1225 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001226 */
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001227static efi_status_t efi_uninstall_protocol
1228 (efi_handle_t handle, const efi_guid_t *protocol,
1229 void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001230{
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001231 struct efi_object *efiobj;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001232 struct efi_handler *handler;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001233 struct efi_open_protocol_info_item *item;
1234 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001235 efi_status_t r;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001236
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001237 /* Check handle */
1238 efiobj = efi_search_obj(handle);
1239 if (!efiobj) {
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001240 r = EFI_INVALID_PARAMETER;
1241 goto out;
1242 }
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001243 /* Find the protocol on the handle */
1244 r = efi_search_protocol(handle, protocol, &handler);
1245 if (r != EFI_SUCCESS)
1246 goto out;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001247 /* Disconnect controllers */
1248 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1249 if (!list_empty(&handler->open_infos)) {
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001250 r = EFI_ACCESS_DENIED;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001251 goto out;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001252 }
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001253 /* Close protocol */
1254 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1255 if (item->info.attributes ==
1256 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1257 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1258 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1259 list_del(&item->link);
1260 }
1261 if (!list_empty(&handler->open_infos)) {
1262 r = EFI_ACCESS_DENIED;
1263 goto out;
1264 }
1265 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001266out:
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001267 return r;
1268}
1269
1270/**
1271 * efi_uninstall_protocol_interface() - uninstall protocol interface
1272 * @handle: handle from which the protocol shall be removed
1273 * @protocol: GUID of the protocol to be removed
1274 * @protocol_interface: interface to be removed
1275 *
1276 * This function implements the UninstallProtocolInterface service.
1277 *
1278 * See the Unified Extensible Firmware Interface (UEFI) specification for
1279 * details.
1280 *
1281 * Return: status code
1282 */
1283static efi_status_t EFIAPI efi_uninstall_protocol_interface
1284 (efi_handle_t handle, const efi_guid_t *protocol,
1285 void *protocol_interface)
1286{
1287 efi_status_t ret;
1288
1289 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1290
1291 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1292 if (ret != EFI_SUCCESS)
1293 goto out;
1294
1295 /* If the last protocol has been removed, delete the handle. */
1296 if (list_empty(&handle->protocols)) {
1297 list_del(&handle->link);
1298 free(handle);
1299 }
1300out:
1301 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001302}
1303
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001304/**
Mario Six78a88f72018-07-10 08:40:17 +02001305 * efi_register_protocol_notify() - register an event for notification when a
1306 * protocol is installed.
1307 * @protocol: GUID of the protocol whose installation shall be notified
1308 * @event: event to be signaled upon installation of the protocol
1309 * @registration: key for retrieving the registration information
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001310 *
1311 * This function implements the RegisterProtocolNotify service.
1312 * See the Unified Extensible Firmware Interface (UEFI) specification
1313 * for details.
1314 *
Mario Six78a88f72018-07-10 08:40:17 +02001315 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001316 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001317static efi_status_t EFIAPI efi_register_protocol_notify(
1318 const efi_guid_t *protocol,
1319 struct efi_event *event,
1320 void **registration)
Alexander Grafbee91162016-03-04 01:09:59 +01001321{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001322 struct efi_register_notify_event *item;
1323 efi_status_t ret = EFI_SUCCESS;
1324
Rob Clark778e6af2017-09-13 18:05:41 -04001325 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001326
1327 if (!protocol || !event || !registration) {
1328 ret = EFI_INVALID_PARAMETER;
1329 goto out;
1330 }
1331
1332 item = calloc(1, sizeof(struct efi_register_notify_event));
1333 if (!item) {
1334 ret = EFI_OUT_OF_RESOURCES;
1335 goto out;
1336 }
1337
1338 item->event = event;
1339 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1340
1341 list_add_tail(&item->link, &efi_register_notify_events);
1342
1343 *registration = item;
1344out:
1345 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001346}
1347
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001348/**
Mario Six78a88f72018-07-10 08:40:17 +02001349 * efi_search() - determine if an EFI handle implements a protocol
1350 * @search_type: selection criterion
1351 * @protocol: GUID of the protocol
1352 * @search_key: registration key
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001353 * @handle: handle
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001354 *
1355 * See the documentation of the LocateHandle service in the UEFI specification.
1356 *
Mario Six78a88f72018-07-10 08:40:17 +02001357 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001358 */
Alexander Grafbee91162016-03-04 01:09:59 +01001359static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001360 const efi_guid_t *protocol, efi_handle_t handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001361{
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001362 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01001363
1364 switch (search_type) {
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001365 case ALL_HANDLES:
Alexander Grafbee91162016-03-04 01:09:59 +01001366 return 0;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001367 case BY_REGISTER_NOTIFY:
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001368 case BY_PROTOCOL:
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001369 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001370 return (ret != EFI_SUCCESS);
1371 default:
1372 /* Invalid search type */
Alexander Grafbee91162016-03-04 01:09:59 +01001373 return -1;
1374 }
Alexander Grafbee91162016-03-04 01:09:59 +01001375}
1376
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001377/**
Mario Six78a88f72018-07-10 08:40:17 +02001378 * efi_locate_handle() - locate handles implementing a protocol
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001379 *
1380 * @search_type: selection criterion
1381 * @protocol: GUID of the protocol
1382 * @search_key: registration key
1383 * @buffer_size: size of the buffer to receive the handles in bytes
1384 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001385 *
1386 * This function is meant for U-Boot internal calls. For the API implementation
1387 * of the LocateHandle service see efi_locate_handle_ext.
1388 *
Mario Six78a88f72018-07-10 08:40:17 +02001389 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001390 */
xypron.glpk@gmx.deebf199b2017-08-09 20:55:00 +02001391static efi_status_t efi_locate_handle(
Alexander Grafbee91162016-03-04 01:09:59 +01001392 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001393 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001394 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01001395{
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001396 struct efi_object *efiobj;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001397 efi_uintn_t size = 0;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001398 struct efi_register_notify_event *item, *event = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01001399
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001400 /* Check parameters */
1401 switch (search_type) {
1402 case ALL_HANDLES:
1403 break;
1404 case BY_REGISTER_NOTIFY:
1405 if (!search_key)
1406 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001407 /* Check that the registration key is valid */
1408 list_for_each_entry(item, &efi_register_notify_events, link) {
1409 if (item ==
1410 (struct efi_register_notify_event *)search_key) {
1411 event = item;
1412 break;
1413 }
1414 }
1415 if (!event)
1416 return EFI_INVALID_PARAMETER;
1417
1418 protocol = &event->protocol;
1419 break;
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001420 case BY_PROTOCOL:
1421 if (!protocol)
1422 return EFI_INVALID_PARAMETER;
1423 break;
1424 default:
1425 return EFI_INVALID_PARAMETER;
1426 }
1427
Alexander Grafbee91162016-03-04 01:09:59 +01001428 /* Count how much space we need */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001429 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001430 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001431 size += sizeof(void *);
Alexander Grafbee91162016-03-04 01:09:59 +01001432 }
1433
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001434 if (size == 0)
1435 return EFI_NOT_FOUND;
1436
1437 if (!buffer_size)
1438 return EFI_INVALID_PARAMETER;
1439
Alexander Grafbee91162016-03-04 01:09:59 +01001440 if (*buffer_size < size) {
1441 *buffer_size = size;
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001442 return EFI_BUFFER_TOO_SMALL;
Alexander Grafbee91162016-03-04 01:09:59 +01001443 }
1444
Rob Clark796a78c2017-08-06 14:10:07 -04001445 *buffer_size = size;
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001446
Heinrich Schuchardt0a843192019-05-10 19:03:49 +02001447 /* The buffer size is sufficient but there is no buffer */
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001448 if (!buffer)
1449 return EFI_INVALID_PARAMETER;
Rob Clark796a78c2017-08-06 14:10:07 -04001450
Alexander Grafbee91162016-03-04 01:09:59 +01001451 /* Then fill the array */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001452 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001453 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001454 *buffer++ = efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01001455 }
1456
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001457 return EFI_SUCCESS;
1458}
1459
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001460/**
Mario Six78a88f72018-07-10 08:40:17 +02001461 * efi_locate_handle_ext() - locate handles implementing a protocol.
1462 * @search_type: selection criterion
1463 * @protocol: GUID of the protocol
1464 * @search_key: registration key
1465 * @buffer_size: size of the buffer to receive the handles in bytes
1466 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001467 *
1468 * This function implements the LocateHandle service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001469 *
Mario Six78a88f72018-07-10 08:40:17 +02001470 * See the Unified Extensible Firmware Interface (UEFI) specification for
1471 * details.
1472 *
1473 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001474 */
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001475static efi_status_t EFIAPI efi_locate_handle_ext(
1476 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001477 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001478 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001479{
Rob Clark778e6af2017-09-13 18:05:41 -04001480 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001481 buffer_size, buffer);
1482
1483 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1484 buffer_size, buffer));
Alexander Grafbee91162016-03-04 01:09:59 +01001485}
1486
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001487/**
Mario Six78a88f72018-07-10 08:40:17 +02001488 * efi_remove_configuration_table() - collapses configuration table entries,
1489 * removing index i
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001490 *
Mario Six78a88f72018-07-10 08:40:17 +02001491 * @i: index of the table entry to be removed
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001492 */
Alexander Grafd98cdf62017-07-26 13:41:04 +02001493static void efi_remove_configuration_table(int i)
1494{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001495 struct efi_configuration_table *this = &systab.tables[i];
1496 struct efi_configuration_table *next = &systab.tables[i + 1];
1497 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Grafd98cdf62017-07-26 13:41:04 +02001498
1499 memmove(this, next, (ulong)end - (ulong)next);
1500 systab.nr_tables--;
1501}
1502
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001503/**
Mario Six78a88f72018-07-10 08:40:17 +02001504 * efi_install_configuration_table() - adds, updates, or removes a
1505 * configuration table
1506 * @guid: GUID of the installed table
1507 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001508 *
1509 * This function is used for internal calls. For the API implementation of the
1510 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1511 *
Mario Six78a88f72018-07-10 08:40:17 +02001512 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001513 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001514efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1515 void *table)
Alexander Grafbee91162016-03-04 01:09:59 +01001516{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001517 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +01001518 int i;
1519
Heinrich Schuchardteb68b4e2018-02-18 00:08:00 +01001520 if (!guid)
1521 return EFI_INVALID_PARAMETER;
1522
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001523 /* Check for GUID override */
Alexander Grafbee91162016-03-04 01:09:59 +01001524 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001525 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Grafd98cdf62017-07-26 13:41:04 +02001526 if (table)
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001527 systab.tables[i].table = table;
Alexander Grafd98cdf62017-07-26 13:41:04 +02001528 else
1529 efi_remove_configuration_table(i);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001530 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01001531 }
1532 }
1533
Alexander Grafd98cdf62017-07-26 13:41:04 +02001534 if (!table)
1535 return EFI_NOT_FOUND;
1536
Alexander Grafbee91162016-03-04 01:09:59 +01001537 /* No override, check for overflow */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001538 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Graf488bf122016-08-19 01:23:24 +02001539 return EFI_OUT_OF_RESOURCES;
Alexander Grafbee91162016-03-04 01:09:59 +01001540
1541 /* Add a new entry */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001542 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1543 systab.tables[i].table = table;
Alexander Grafaba5e912016-08-19 01:23:30 +02001544 systab.nr_tables = i + 1;
Alexander Grafbee91162016-03-04 01:09:59 +01001545
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001546out:
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001547 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardt55d8ee32018-07-07 15:36:05 +02001548 efi_update_table_header_crc32(&systab.hdr);
1549
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001550 /* Notify that the configuration table was changed */
1551 list_for_each_entry(evt, &efi_events, link) {
1552 if (evt->group && !guidcmp(evt->group, guid)) {
1553 efi_signal_event(evt, false);
1554 break;
1555 }
1556 }
1557
Alexander Graf488bf122016-08-19 01:23:24 +02001558 return EFI_SUCCESS;
1559}
1560
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001561/**
Mario Six78a88f72018-07-10 08:40:17 +02001562 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1563 * configuration table.
1564 * @guid: GUID of the installed table
1565 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001566 *
1567 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001568 *
Mario Six78a88f72018-07-10 08:40:17 +02001569 * See the Unified Extensible Firmware Interface (UEFI) specification for
1570 * details.
1571 *
1572 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001573 */
Alexander Graf488bf122016-08-19 01:23:24 +02001574static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1575 void *table)
1576{
Rob Clark778e6af2017-09-13 18:05:41 -04001577 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Graf488bf122016-08-19 01:23:24 +02001578 return EFI_EXIT(efi_install_configuration_table(guid, table));
Alexander Grafbee91162016-03-04 01:09:59 +01001579}
1580
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001581/**
Mario Six78a88f72018-07-10 08:40:17 +02001582 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001583 *
1584 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clark95c55532017-09-13 18:05:33 -04001585 * protocols, boot-device, etc.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001586 *
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001587 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1588 * code is returned.
1589 *
1590 * @device_path: device path of the loaded image
1591 * @file_path: file path of the loaded image
1592 * @handle_ptr: handle of the loaded image
1593 * @info_ptr: loaded image protocol
1594 * Return: status code
Rob Clark95c55532017-09-13 18:05:33 -04001595 */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001596efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1597 struct efi_device_path *file_path,
1598 struct efi_loaded_image_obj **handle_ptr,
1599 struct efi_loaded_image **info_ptr)
Rob Clark95c55532017-09-13 18:05:33 -04001600{
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001601 efi_status_t ret;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001602 struct efi_loaded_image *info = NULL;
1603 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001604 struct efi_device_path *dp;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001605
1606 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1607 *handle_ptr = NULL;
1608 *info_ptr = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001609
1610 info = calloc(1, sizeof(*info));
1611 if (!info)
1612 return EFI_OUT_OF_RESOURCES;
1613 obj = calloc(1, sizeof(*obj));
1614 if (!obj) {
1615 free(info);
1616 return EFI_OUT_OF_RESOURCES;
1617 }
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02001618 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001619
Heinrich Schuchardt44549d62017-11-26 14:05:23 +01001620 /* Add internal object to object list */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001621 efi_add_handle(&obj->header);
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001622
Heinrich Schuchardt95147312018-07-05 08:17:58 +02001623 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Rob Clark95c55532017-09-13 18:05:33 -04001624 info->file_path = file_path;
Heinrich Schuchardt7e1effc2018-08-26 15:31:52 +02001625 info->system_table = &systab;
Rob Clark95c55532017-09-13 18:05:33 -04001626
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001627 if (device_path) {
1628 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001629
1630 dp = efi_dp_append(device_path, file_path);
1631 if (!dp) {
1632 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001633 goto failure;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001634 }
1635 } else {
1636 dp = NULL;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001637 }
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001638 ret = efi_add_protocol(&obj->header,
1639 &efi_guid_loaded_image_device_path, dp);
1640 if (ret != EFI_SUCCESS)
1641 goto failure;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001642
1643 /*
1644 * When asking for the loaded_image interface, just
1645 * return handle which points to loaded_image_info
1646 */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001647 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001648 &efi_guid_loaded_image, info);
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001649 if (ret != EFI_SUCCESS)
1650 goto failure;
1651
Heinrich Schuchardtd5974af2019-03-19 18:58:58 +01001652 *info_ptr = info;
1653 *handle_ptr = obj;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001654
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001655 return ret;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001656failure:
1657 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001658 efi_delete_handle(&obj->header);
1659 free(info);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001660 return ret;
Rob Clark95c55532017-09-13 18:05:33 -04001661}
1662
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001663/**
Mario Six78a88f72018-07-10 08:40:17 +02001664 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001665 *
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001666 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1667 * callers obligation to update the memory type as needed.
1668 *
1669 * @file_path: the path of the image to load
1670 * @buffer: buffer containing the loaded image
1671 * @size: size of the loaded image
1672 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001673 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09001674static
Rob Clark9975fe92017-09-13 18:05:38 -04001675efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001676 void **buffer, efi_uintn_t *size)
Rob Clark838ee4b2017-09-13 18:05:35 -04001677{
1678 struct efi_file_info *info = NULL;
1679 struct efi_file_handle *f;
1680 static efi_status_t ret;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001681 u64 addr;
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001682 efi_uintn_t bs;
Rob Clark838ee4b2017-09-13 18:05:35 -04001683
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001684 /* In case of failure nothing is returned */
1685 *buffer = NULL;
1686 *size = 0;
1687
1688 /* Open file */
Rob Clark838ee4b2017-09-13 18:05:35 -04001689 f = efi_file_from_path(file_path);
1690 if (!f)
1691 return EFI_DEVICE_ERROR;
1692
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001693 /* Get file size */
Rob Clark838ee4b2017-09-13 18:05:35 -04001694 bs = 0;
1695 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1696 &bs, info));
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001697 if (ret != EFI_BUFFER_TOO_SMALL) {
1698 ret = EFI_DEVICE_ERROR;
1699 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001700 }
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001701
1702 info = malloc(bs);
1703 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1704 info));
Rob Clark838ee4b2017-09-13 18:05:35 -04001705 if (ret != EFI_SUCCESS)
1706 goto error;
1707
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001708 /*
1709 * When reading the file we do not yet know if it contains an
1710 * application, a boottime driver, or a runtime driver. So here we
1711 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1712 * update the reservation according to the image type.
1713 */
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001714 bs = info->file_size;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001715 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1716 EFI_BOOT_SERVICES_DATA,
1717 efi_size_in_pages(bs), &addr);
Rob Clark838ee4b2017-09-13 18:05:35 -04001718 if (ret != EFI_SUCCESS) {
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001719 ret = EFI_OUT_OF_RESOURCES;
1720 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001721 }
1722
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001723 /* Read file */
1724 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1725 if (ret != EFI_SUCCESS)
1726 efi_free_pages(addr, efi_size_in_pages(bs));
1727 *buffer = (void *)(uintptr_t)addr;
1728 *size = bs;
1729error:
1730 EFI_CALL(f->close(f));
1731 free(info);
Rob Clark838ee4b2017-09-13 18:05:35 -04001732 return ret;
1733}
1734
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001735/**
Mario Six78a88f72018-07-10 08:40:17 +02001736 * efi_load_image() - load an EFI image into memory
1737 * @boot_policy: true for request originating from the boot manager
1738 * @parent_image: the caller's image handle
1739 * @file_path: the path of the image to load
1740 * @source_buffer: memory location from which the image is installed
1741 * @source_size: size of the memory area from which the image is installed
1742 * @image_handle: handle for the newly installed image
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001743 *
1744 * This function implements the LoadImage service.
Mario Six78a88f72018-07-10 08:40:17 +02001745 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001746 * See the Unified Extensible Firmware Interface (UEFI) specification
1747 * for details.
1748 *
Mario Six78a88f72018-07-10 08:40:17 +02001749 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001750 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09001751efi_status_t EFIAPI efi_load_image(bool boot_policy,
1752 efi_handle_t parent_image,
1753 struct efi_device_path *file_path,
1754 void *source_buffer,
1755 efi_uintn_t source_size,
1756 efi_handle_t *image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001757{
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001758 struct efi_device_path *dp, *fp;
Tom Rini1c3b2f42018-09-30 10:38:15 -04001759 struct efi_loaded_image *info = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001760 struct efi_loaded_image_obj **image_obj =
1761 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001762 efi_status_t ret;
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001763 void *dest_buffer;
Alexander Grafbee91162016-03-04 01:09:59 +01001764
Heinrich Schuchardt7fb96a12018-04-03 22:29:30 +02001765 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafbee91162016-03-04 01:09:59 +01001766 file_path, source_buffer, source_size, image_handle);
Rob Clark838ee4b2017-09-13 18:05:35 -04001767
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +02001768 if (!image_handle || !efi_search_obj(parent_image)) {
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001769 ret = EFI_INVALID_PARAMETER;
1770 goto error;
1771 }
1772
1773 if (!source_buffer && !file_path) {
1774 ret = EFI_NOT_FOUND;
1775 goto error;
1776 }
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +02001777 /* The parent image handle must refer to a loaded image */
1778 if (!parent_image->type) {
1779 ret = EFI_INVALID_PARAMETER;
1780 goto error;
1781 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001782
Rob Clark838ee4b2017-09-13 18:05:35 -04001783 if (!source_buffer) {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001784 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001785 &source_size);
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001786 if (ret != EFI_SUCCESS)
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001787 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001788 } else {
Heinrich Schuchardt470dfa52019-05-05 16:55:06 +02001789 if (!source_size) {
1790 ret = EFI_LOAD_ERROR;
1791 goto error;
1792 }
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001793 dest_buffer = source_buffer;
Rob Clark838ee4b2017-09-13 18:05:35 -04001794 }
Heinrich Schuchardt1e15a9c2019-04-20 19:24:43 +00001795 /* split file_path which contains both the device and file parts */
1796 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001797 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001798 if (ret == EFI_SUCCESS)
1799 ret = efi_load_pe(*image_obj, dest_buffer, info);
1800 if (!source_buffer)
1801 /* Release buffer to which file was loaded */
1802 efi_free_pages((uintptr_t)dest_buffer,
1803 efi_size_in_pages(source_size));
1804 if (ret == EFI_SUCCESS) {
1805 info->system_table = &systab;
1806 info->parent_handle = parent_image;
1807 } else {
1808 /* The image is invalid. Release all associated resources. */
1809 efi_delete_handle(*image_handle);
1810 *image_handle = NULL;
1811 free(info);
1812 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001813error:
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001814 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001815}
1816
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001817/**
Alexander Graff31239a2018-11-15 21:23:47 +01001818 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1819 */
1820static void efi_exit_caches(void)
1821{
1822#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1823 /*
1824 * Grub on 32bit ARM needs to have caches disabled before jumping into
1825 * a zImage, but does not know of all cache layers. Give it a hand.
1826 */
1827 if (efi_is_direct_boot)
1828 cleanup_before_linux();
1829#endif
1830}
1831
1832/**
Mario Six78a88f72018-07-10 08:40:17 +02001833 * efi_exit_boot_services() - stop all boot services
1834 * @image_handle: handle of the loaded image
1835 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001836 *
1837 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02001838 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001839 * See the Unified Extensible Firmware Interface (UEFI) specification
1840 * for details.
1841 *
Mario Six78a88f72018-07-10 08:40:17 +02001842 * All timer events are disabled. For exit boot services events the
1843 * notification function is called. The boot services are disabled in the
1844 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001845 *
Mario Six78a88f72018-07-10 08:40:17 +02001846 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001847 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001848static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001849 efi_uintn_t map_key)
Alexander Grafbee91162016-03-04 01:09:59 +01001850{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001851 struct efi_event *evt;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001852
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001853 EFI_ENTRY("%p, %zx", image_handle, map_key);
Alexander Grafbee91162016-03-04 01:09:59 +01001854
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001855 /* Check that the caller has read the current memory map */
1856 if (map_key != efi_memory_map_key)
1857 return EFI_INVALID_PARAMETER;
1858
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001859 /* Make sure that notification functions are not called anymore */
1860 efi_tpl = TPL_HIGH_LEVEL;
1861
1862 /* Check if ExitBootServices has already been called */
1863 if (!systab.boottime)
1864 return EFI_EXIT(EFI_SUCCESS);
1865
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001866 /* Add related events to the event group */
1867 list_for_each_entry(evt, &efi_events, link) {
1868 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1869 evt->group = &efi_guid_event_group_exit_boot_services;
1870 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001871 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001872 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001873 if (evt->group &&
1874 !guidcmp(evt->group,
1875 &efi_guid_event_group_exit_boot_services)) {
1876 efi_signal_event(evt, false);
1877 break;
1878 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001879 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001880
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001881 /* TODO: Should persist EFI variables here */
Rob Clarkad644e72017-09-13 18:05:37 -04001882
Alexander Grafb7b84102016-11-17 01:02:57 +01001883 board_quiesce_devices();
1884
Alexander Graff31239a2018-11-15 21:23:47 +01001885 /* Fix up caches for EFI payloads if necessary */
1886 efi_exit_caches();
1887
Alexander Grafbee91162016-03-04 01:09:59 +01001888 /* This stops all lingering devices */
1889 bootm_disable_interrupts();
1890
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001891 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001892 systab.con_in_handle = NULL;
1893 systab.con_in = NULL;
1894 systab.con_out_handle = NULL;
1895 systab.con_out = NULL;
1896 systab.stderr_handle = NULL;
1897 systab.std_err = NULL;
1898 systab.boottime = NULL;
1899
1900 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02001901 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001902
Alexander Grafbee91162016-03-04 01:09:59 +01001903 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001904 efi_set_watchdog(0);
Alexander Grafbee91162016-03-04 01:09:59 +01001905 WATCHDOG_RESET();
1906
1907 return EFI_EXIT(EFI_SUCCESS);
1908}
1909
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001910/**
Mario Six78a88f72018-07-10 08:40:17 +02001911 * efi_get_next_monotonic_count() - get next value of the counter
1912 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001913 *
1914 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001915 *
Mario Six78a88f72018-07-10 08:40:17 +02001916 * See the Unified Extensible Firmware Interface (UEFI) specification for
1917 * details.
1918 *
1919 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001920 */
Alexander Grafbee91162016-03-04 01:09:59 +01001921static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1922{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001923 static uint64_t mono;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02001924 efi_status_t ret;
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001925
Alexander Grafbee91162016-03-04 01:09:59 +01001926 EFI_ENTRY("%p", count);
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02001927 if (!count) {
1928 ret = EFI_INVALID_PARAMETER;
1929 goto out;
1930 }
Alexander Grafbee91162016-03-04 01:09:59 +01001931 *count = mono++;
Heinrich Schuchardt1344f7d2019-05-17 12:47:17 +02001932 ret = EFI_SUCCESS;
1933out:
1934 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001935}
1936
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001937/**
Mario Six78a88f72018-07-10 08:40:17 +02001938 * efi_stall() - sleep
1939 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001940 *
Mario Six78a88f72018-07-10 08:40:17 +02001941 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001942 *
Mario Six78a88f72018-07-10 08:40:17 +02001943 * See the Unified Extensible Firmware Interface (UEFI) specification for
1944 * details.
1945 *
1946 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001947 */
Alexander Grafbee91162016-03-04 01:09:59 +01001948static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1949{
1950 EFI_ENTRY("%ld", microseconds);
1951 udelay(microseconds);
1952 return EFI_EXIT(EFI_SUCCESS);
1953}
1954
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001955/**
Mario Six78a88f72018-07-10 08:40:17 +02001956 * efi_set_watchdog_timer() - reset the watchdog timer
1957 * @timeout: seconds before reset by watchdog
1958 * @watchdog_code: code to be logged when resetting
1959 * @data_size: size of buffer in bytes
1960 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001961 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001962 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001963 *
Mario Six78a88f72018-07-10 08:40:17 +02001964 * See the Unified Extensible Firmware Interface (UEFI) specification for
1965 * details.
1966 *
1967 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001968 */
Alexander Grafbee91162016-03-04 01:09:59 +01001969static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1970 uint64_t watchdog_code,
1971 unsigned long data_size,
1972 uint16_t *watchdog_data)
1973{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09001974 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01001975 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001976 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01001977}
1978
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001979/**
Mario Six78a88f72018-07-10 08:40:17 +02001980 * efi_close_protocol() - close a protocol
1981 * @handle: handle on which the protocol shall be closed
1982 * @protocol: GUID of the protocol to close
1983 * @agent_handle: handle of the driver
1984 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001985 *
1986 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001987 *
Mario Six78a88f72018-07-10 08:40:17 +02001988 * See the Unified Extensible Firmware Interface (UEFI) specification for
1989 * details.
1990 *
1991 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001992 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001993static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001994 const efi_guid_t *protocol,
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001995 efi_handle_t agent_handle,
1996 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001997{
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001998 struct efi_handler *handler;
1999 struct efi_open_protocol_info_item *item;
2000 struct efi_open_protocol_info_item *pos;
2001 efi_status_t r;
2002
Rob Clark778e6af2017-09-13 18:05:41 -04002003 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01002004 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002005
Heinrich Schuchardtec163fa2019-05-05 10:37:51 +02002006 if (!efi_search_obj(agent_handle) ||
2007 (controller_handle && !efi_search_obj(controller_handle))) {
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01002008 r = EFI_INVALID_PARAMETER;
2009 goto out;
2010 }
2011 r = efi_search_protocol(handle, protocol, &handler);
2012 if (r != EFI_SUCCESS)
2013 goto out;
2014
2015 r = EFI_NOT_FOUND;
2016 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2017 if (item->info.agent_handle == agent_handle &&
2018 item->info.controller_handle == controller_handle) {
2019 efi_delete_open_info(item);
2020 r = EFI_SUCCESS;
2021 break;
2022 }
2023 }
2024out:
2025 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002026}
2027
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002028/**
Mario Six78a88f72018-07-10 08:40:17 +02002029 * efi_open_protocol_information() - provide information about then open status
2030 * of a protocol on a handle
2031 * @handle: handle for which the information shall be retrieved
2032 * @protocol: GUID of the protocol
2033 * @entry_buffer: buffer to receive the open protocol information
2034 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002035 *
2036 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002037 *
Mario Six78a88f72018-07-10 08:40:17 +02002038 * See the Unified Extensible Firmware Interface (UEFI) specification for
2039 * details.
2040 *
2041 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002042 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002043static efi_status_t EFIAPI efi_open_protocol_information(
2044 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002045 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002046 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002047{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002048 unsigned long buffer_size;
2049 unsigned long count;
2050 struct efi_handler *handler;
2051 struct efi_open_protocol_info_item *item;
2052 efi_status_t r;
2053
Rob Clark778e6af2017-09-13 18:05:41 -04002054 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01002055 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002056
2057 /* Check parameters */
2058 if (!entry_buffer) {
2059 r = EFI_INVALID_PARAMETER;
2060 goto out;
2061 }
2062 r = efi_search_protocol(handle, protocol, &handler);
2063 if (r != EFI_SUCCESS)
2064 goto out;
2065
2066 /* Count entries */
2067 count = 0;
2068 list_for_each_entry(item, &handler->open_infos, link) {
2069 if (item->info.open_count)
2070 ++count;
2071 }
2072 *entry_count = count;
2073 *entry_buffer = NULL;
2074 if (!count) {
2075 r = EFI_SUCCESS;
2076 goto out;
2077 }
2078
2079 /* Copy entries */
2080 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002081 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002082 (void **)entry_buffer);
2083 if (r != EFI_SUCCESS)
2084 goto out;
2085 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2086 if (item->info.open_count)
2087 (*entry_buffer)[--count] = item->info;
2088 }
2089out:
2090 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002091}
2092
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002093/**
Mario Six78a88f72018-07-10 08:40:17 +02002094 * efi_protocols_per_handle() - get protocols installed on a handle
2095 * @handle: handle for which the information is retrieved
2096 * @protocol_buffer: buffer with protocol GUIDs
2097 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002098 *
2099 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002100 *
Mario Six78a88f72018-07-10 08:40:17 +02002101 * See the Unified Extensible Firmware Interface (UEFI) specification for
2102 * details.
2103 *
2104 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002105 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002106static efi_status_t EFIAPI efi_protocols_per_handle(
2107 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002108 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002109{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002110 unsigned long buffer_size;
2111 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002112 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002113 efi_status_t r;
2114
Alexander Grafbee91162016-03-04 01:09:59 +01002115 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2116 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002117
2118 if (!handle || !protocol_buffer || !protocol_buffer_count)
2119 return EFI_EXIT(EFI_INVALID_PARAMETER);
2120
2121 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002122 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002123
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002124 efiobj = efi_search_obj(handle);
2125 if (!efiobj)
2126 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002127
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002128 /* Count protocols */
2129 list_for_each(protocol_handle, &efiobj->protocols) {
2130 ++*protocol_buffer_count;
2131 }
2132
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002133 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002134 if (*protocol_buffer_count) {
2135 size_t j = 0;
2136
2137 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002138 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002139 (void **)protocol_buffer);
2140 if (r != EFI_SUCCESS)
2141 return EFI_EXIT(r);
2142 list_for_each(protocol_handle, &efiobj->protocols) {
2143 struct efi_handler *protocol;
2144
2145 protocol = list_entry(protocol_handle,
2146 struct efi_handler, link);
2147 (*protocol_buffer)[j] = (void *)protocol->guid;
2148 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002149 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002150 }
2151
2152 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002153}
2154
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002155/**
Mario Six78a88f72018-07-10 08:40:17 +02002156 * efi_locate_handle_buffer() - locate handles implementing a protocol
2157 * @search_type: selection criterion
2158 * @protocol: GUID of the protocol
2159 * @search_key: registration key
2160 * @no_handles: number of returned handles
2161 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002162 *
2163 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002164 *
Mario Six78a88f72018-07-10 08:40:17 +02002165 * See the Unified Extensible Firmware Interface (UEFI) specification for
2166 * details.
2167 *
2168 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002169 */
Alexander Grafbee91162016-03-04 01:09:59 +01002170static efi_status_t EFIAPI efi_locate_handle_buffer(
2171 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002172 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002173 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002174{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002175 efi_status_t r;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002176 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002177
Rob Clark778e6af2017-09-13 18:05:41 -04002178 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002179 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002180
2181 if (!no_handles || !buffer) {
2182 r = EFI_INVALID_PARAMETER;
2183 goto out;
2184 }
2185 *no_handles = 0;
2186 *buffer = NULL;
2187 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2188 *buffer);
2189 if (r != EFI_BUFFER_TOO_SMALL)
2190 goto out;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002191 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002192 (void **)buffer);
2193 if (r != EFI_SUCCESS)
2194 goto out;
2195 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2196 *buffer);
2197 if (r == EFI_SUCCESS)
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002198 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002199out:
2200 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002201}
2202
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002203/**
Mario Six78a88f72018-07-10 08:40:17 +02002204 * efi_locate_protocol() - find an interface implementing a protocol
2205 * @protocol: GUID of the protocol
2206 * @registration: registration key passed to the notification function
2207 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002208 *
2209 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002210 *
Mario Six78a88f72018-07-10 08:40:17 +02002211 * See the Unified Extensible Firmware Interface (UEFI) specification for
2212 * details.
2213 *
2214 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002215 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002216static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002217 void *registration,
2218 void **protocol_interface)
2219{
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002220 struct list_head *lhandle;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002221 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01002222
Rob Clark778e6af2017-09-13 18:05:41 -04002223 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002224
2225 if (!protocol || !protocol_interface)
2226 return EFI_EXIT(EFI_INVALID_PARAMETER);
2227
2228 list_for_each(lhandle, &efi_obj_list) {
2229 struct efi_object *efiobj;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002230 struct efi_handler *handler;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002231
2232 efiobj = list_entry(lhandle, struct efi_object, link);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002233
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002234 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002235 if (ret == EFI_SUCCESS) {
2236 *protocol_interface = handler->protocol_interface;
2237 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002238 }
2239 }
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002240 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002241
2242 return EFI_EXIT(EFI_NOT_FOUND);
2243}
2244
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002245/**
Mario Six78a88f72018-07-10 08:40:17 +02002246 * efi_locate_device_path() - Get the device path and handle of an device
2247 * implementing a protocol
2248 * @protocol: GUID of the protocol
2249 * @device_path: device path
2250 * @device: handle of the device
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002251 *
2252 * This function implements the LocateDevicePath service.
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002253 *
Mario Six78a88f72018-07-10 08:40:17 +02002254 * See the Unified Extensible Firmware Interface (UEFI) specification for
2255 * details.
2256 *
2257 * Return: status code
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002258 */
2259static efi_status_t EFIAPI efi_locate_device_path(
2260 const efi_guid_t *protocol,
2261 struct efi_device_path **device_path,
2262 efi_handle_t *device)
2263{
2264 struct efi_device_path *dp;
2265 size_t i;
2266 struct efi_handler *handler;
2267 efi_handle_t *handles;
2268 size_t len, len_dp;
2269 size_t len_best = 0;
2270 efi_uintn_t no_handles;
2271 u8 *remainder;
2272 efi_status_t ret;
2273
2274 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2275
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002276 if (!protocol || !device_path || !*device_path) {
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002277 ret = EFI_INVALID_PARAMETER;
2278 goto out;
2279 }
2280
2281 /* Find end of device path */
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002282 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002283
2284 /* Get all handles implementing the protocol */
2285 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2286 &no_handles, &handles));
2287 if (ret != EFI_SUCCESS)
2288 goto out;
2289
2290 for (i = 0; i < no_handles; ++i) {
2291 /* Find the device path protocol */
2292 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2293 &handler);
2294 if (ret != EFI_SUCCESS)
2295 continue;
2296 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002297 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002298 /*
2299 * This handle can only be a better fit
2300 * if its device path length is longer than the best fit and
2301 * if its device path length is shorter of equal the searched
2302 * device path.
2303 */
2304 if (len_dp <= len_best || len_dp > len)
2305 continue;
2306 /* Check if dp is a subpath of device_path */
2307 if (memcmp(*device_path, dp, len_dp))
2308 continue;
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002309 if (!device) {
2310 ret = EFI_INVALID_PARAMETER;
2311 goto out;
2312 }
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002313 *device = handles[i];
2314 len_best = len_dp;
2315 }
2316 if (len_best) {
2317 remainder = (u8 *)*device_path + len_best;
2318 *device_path = (struct efi_device_path *)remainder;
2319 ret = EFI_SUCCESS;
2320 } else {
2321 ret = EFI_NOT_FOUND;
2322 }
2323out:
2324 return EFI_EXIT(ret);
2325}
2326
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002327/**
Mario Six78a88f72018-07-10 08:40:17 +02002328 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2329 * interfaces
2330 * @handle: handle on which the protocol interfaces shall be installed
2331 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2332 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002333 *
2334 * This function implements the MultipleProtocolInterfaces 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 */
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +02002341efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002342 (efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002343{
2344 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002345
Alexander Grafbeb077a2018-06-18 17:23:05 +02002346 efi_va_list argptr;
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002347 const efi_guid_t *protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002348 void *protocol_interface;
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002349 efi_handle_t old_handle;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002350 efi_status_t r = EFI_SUCCESS;
2351 int i = 0;
2352
2353 if (!handle)
2354 return EFI_EXIT(EFI_INVALID_PARAMETER);
2355
Alexander Grafbeb077a2018-06-18 17:23:05 +02002356 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002357 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002358 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002359 if (!protocol)
2360 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002361 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002362 /* Check that a device path has not been installed before */
2363 if (!guidcmp(protocol, &efi_guid_device_path)) {
2364 struct efi_device_path *dp = protocol_interface;
2365
2366 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2367 &old_handle));
Heinrich Schuchardt20562892019-05-20 19:55:18 +00002368 if (r == EFI_SUCCESS &&
2369 dp->type == DEVICE_PATH_TYPE_END) {
2370 EFI_PRINT("Path %pD already installed\n",
2371 protocol_interface);
Heinrich Schuchardt226cddb2019-05-16 21:54:04 +02002372 r = EFI_ALREADY_STARTED;
2373 break;
2374 }
2375 }
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01002376 r = EFI_CALL(efi_install_protocol_interface(
2377 handle, protocol,
2378 EFI_NATIVE_INTERFACE,
2379 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002380 if (r != EFI_SUCCESS)
2381 break;
2382 i++;
2383 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002384 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002385 if (r == EFI_SUCCESS)
2386 return EFI_EXIT(r);
2387
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002388 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002389 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002390 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002391 protocol = efi_va_arg(argptr, efi_guid_t*);
2392 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002393 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01002394 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002395 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002396 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002397
2398 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002399}
2400
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002401/**
Mario Six78a88f72018-07-10 08:40:17 +02002402 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2403 * interfaces
2404 * @handle: handle from which the protocol interfaces shall be removed
2405 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2406 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002407 *
2408 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002409 *
Mario Six78a88f72018-07-10 08:40:17 +02002410 * See the Unified Extensible Firmware Interface (UEFI) specification for
2411 * details.
2412 *
2413 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002414 */
Alexander Grafbee91162016-03-04 01:09:59 +01002415static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002416 efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002417{
2418 EFI_ENTRY("%p", handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002419
Alexander Grafbeb077a2018-06-18 17:23:05 +02002420 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002421 const efi_guid_t *protocol;
2422 void *protocol_interface;
2423 efi_status_t r = EFI_SUCCESS;
2424 size_t i = 0;
2425
2426 if (!handle)
2427 return EFI_EXIT(EFI_INVALID_PARAMETER);
2428
Alexander Grafbeb077a2018-06-18 17:23:05 +02002429 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002430 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002431 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002432 if (!protocol)
2433 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002434 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002435 r = efi_uninstall_protocol(handle, protocol,
2436 protocol_interface);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002437 if (r != EFI_SUCCESS)
2438 break;
2439 i++;
2440 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002441 efi_va_end(argptr);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002442 if (r == EFI_SUCCESS) {
2443 /* If the last protocol has been removed, delete the handle. */
2444 if (list_empty(&handle->protocols)) {
2445 list_del(&handle->link);
2446 free(handle);
2447 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002448 return EFI_EXIT(r);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002449 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002450
2451 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002452 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002453 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002454 protocol = efi_va_arg(argptr, efi_guid_t*);
2455 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002456 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2457 EFI_NATIVE_INTERFACE,
2458 protocol_interface));
2459 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002460 efi_va_end(argptr);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002461
Heinrich Schuchardte2373022018-09-24 19:57:27 +02002462 /* In case of an error always return EFI_INVALID_PARAMETER */
2463 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafbee91162016-03-04 01:09:59 +01002464}
2465
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002466/**
Mario Six78a88f72018-07-10 08:40:17 +02002467 * efi_calculate_crc32() - calculate cyclic redundancy code
2468 * @data: buffer with data
2469 * @data_size: size of buffer in bytes
2470 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002471 *
2472 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002473 *
Mario Six78a88f72018-07-10 08:40:17 +02002474 * See the Unified Extensible Firmware Interface (UEFI) specification for
2475 * details.
2476 *
2477 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002478 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002479static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2480 efi_uintn_t data_size,
2481 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002482{
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002483 efi_status_t ret = EFI_SUCCESS;
2484
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002485 EFI_ENTRY("%p, %zu", data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002486 if (!data || !data_size || !crc32_p) {
2487 ret = EFI_INVALID_PARAMETER;
2488 goto out;
2489 }
Alexander Grafbee91162016-03-04 01:09:59 +01002490 *crc32_p = crc32(0, data, data_size);
Heinrich Schuchardtdb80fe32019-05-16 23:31:29 +02002491out:
2492 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01002493}
2494
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002495/**
Mario Six78a88f72018-07-10 08:40:17 +02002496 * efi_copy_mem() - copy memory
2497 * @destination: destination of the copy operation
2498 * @source: source of the copy operation
2499 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002500 *
2501 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002502 *
Mario Six78a88f72018-07-10 08:40:17 +02002503 * See the Unified Extensible Firmware Interface (UEFI) specification for
2504 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002505 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002506static void EFIAPI efi_copy_mem(void *destination, const void *source,
2507 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002508{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002509 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002510 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002511 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002512}
2513
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002514/**
Mario Six78a88f72018-07-10 08:40:17 +02002515 * efi_set_mem() - Fill memory with a byte value.
2516 * @buffer: buffer to fill
2517 * @size: size of buffer in bytes
2518 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002519 *
2520 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002521 *
Mario Six78a88f72018-07-10 08:40:17 +02002522 * See the Unified Extensible Firmware Interface (UEFI) specification for
2523 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002524 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002525static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002526{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002527 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002528 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002529 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002530}
2531
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002532/**
Mario Six78a88f72018-07-10 08:40:17 +02002533 * efi_protocol_open() - open protocol interface on a handle
2534 * @handler: handler of a protocol
2535 * @protocol_interface: interface implementing the protocol
2536 * @agent_handle: handle of the driver
2537 * @controller_handle: handle of the controller
2538 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002539 *
Mario Six78a88f72018-07-10 08:40:17 +02002540 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002541 */
2542static efi_status_t efi_protocol_open(
2543 struct efi_handler *handler,
2544 void **protocol_interface, void *agent_handle,
2545 void *controller_handle, uint32_t attributes)
2546{
2547 struct efi_open_protocol_info_item *item;
2548 struct efi_open_protocol_info_entry *match = NULL;
2549 bool opened_by_driver = false;
2550 bool opened_exclusive = false;
2551
2552 /* If there is no agent, only return the interface */
2553 if (!agent_handle)
2554 goto out;
2555
2556 /* For TEST_PROTOCOL ignore interface attribute */
2557 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2558 *protocol_interface = NULL;
2559
2560 /*
2561 * Check if the protocol is already opened by a driver with the same
2562 * attributes or opened exclusively
2563 */
2564 list_for_each_entry(item, &handler->open_infos, link) {
2565 if (item->info.agent_handle == agent_handle) {
2566 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2567 (item->info.attributes == attributes))
2568 return EFI_ALREADY_STARTED;
2569 }
2570 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2571 opened_exclusive = true;
2572 }
2573
2574 /* Only one controller can open the protocol exclusively */
2575 if (opened_exclusive && attributes &
2576 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2577 return EFI_ACCESS_DENIED;
2578
2579 /* Prepare exclusive opening */
2580 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2581 /* Try to disconnect controllers */
2582 list_for_each_entry(item, &handler->open_infos, link) {
2583 if (item->info.attributes ==
2584 EFI_OPEN_PROTOCOL_BY_DRIVER)
2585 EFI_CALL(efi_disconnect_controller(
2586 item->info.controller_handle,
2587 item->info.agent_handle,
2588 NULL));
2589 }
2590 opened_by_driver = false;
2591 /* Check if all controllers are disconnected */
2592 list_for_each_entry(item, &handler->open_infos, link) {
2593 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2594 opened_by_driver = true;
2595 }
Heinrich Schuchardt4f37fa42018-09-30 13:40:43 +02002596 /* Only one controller can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002597 if (opened_by_driver)
2598 return EFI_ACCESS_DENIED;
2599 }
2600
2601 /* Find existing entry */
2602 list_for_each_entry(item, &handler->open_infos, link) {
2603 if (item->info.agent_handle == agent_handle &&
2604 item->info.controller_handle == controller_handle)
2605 match = &item->info;
2606 }
2607 /* None found, create one */
2608 if (!match) {
2609 match = efi_create_open_info(handler);
2610 if (!match)
2611 return EFI_OUT_OF_RESOURCES;
2612 }
2613
2614 match->agent_handle = agent_handle;
2615 match->controller_handle = controller_handle;
2616 match->attributes = attributes;
2617 match->open_count++;
2618
2619out:
2620 /* For TEST_PROTOCOL ignore interface attribute. */
2621 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2622 *protocol_interface = handler->protocol_interface;
2623
2624 return EFI_SUCCESS;
2625}
2626
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002627/**
Mario Six78a88f72018-07-10 08:40:17 +02002628 * efi_open_protocol() - open protocol interface on a handle
2629 * @handle: handle on which the protocol shall be opened
2630 * @protocol: GUID of the protocol
2631 * @protocol_interface: interface implementing the protocol
2632 * @agent_handle: handle of the driver
2633 * @controller_handle: handle of the controller
2634 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002635 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002636 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002637 *
Mario Six78a88f72018-07-10 08:40:17 +02002638 * See the Unified Extensible Firmware Interface (UEFI) specification for
2639 * details.
2640 *
2641 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002642 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002643static efi_status_t EFIAPI efi_open_protocol
2644 (efi_handle_t handle, const efi_guid_t *protocol,
2645 void **protocol_interface, efi_handle_t agent_handle,
2646 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01002647{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002648 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002649 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01002650
Rob Clark778e6af2017-09-13 18:05:41 -04002651 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002652 protocol_interface, agent_handle, controller_handle,
2653 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002654
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002655 if (!handle || !protocol ||
2656 (!protocol_interface && attributes !=
2657 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2658 goto out;
2659 }
2660
2661 switch (attributes) {
2662 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2663 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2664 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2665 break;
2666 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2667 if (controller_handle == handle)
2668 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002669 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002670 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2671 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002672 /* Check that the controller handle is valid */
2673 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002674 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002675 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002676 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002677 /* Check that the agent handle is valid */
2678 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002679 goto out;
2680 break;
2681 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002682 goto out;
2683 }
2684
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002685 r = efi_search_protocol(handle, protocol, &handler);
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002686 switch (r) {
2687 case EFI_SUCCESS:
2688 break;
2689 case EFI_NOT_FOUND:
2690 r = EFI_UNSUPPORTED;
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002691 goto out;
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002692 default:
2693 goto out;
2694 }
Alexander Grafbee91162016-03-04 01:09:59 +01002695
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002696 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2697 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01002698out:
2699 return EFI_EXIT(r);
2700}
2701
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002702/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002703 * efi_start_image() - call the entry point of an image
2704 * @image_handle: handle of the image
2705 * @exit_data_size: size of the buffer
2706 * @exit_data: buffer to receive the exit data of the called image
2707 *
2708 * This function implements the StartImage service.
2709 *
2710 * See the Unified Extensible Firmware Interface (UEFI) specification for
2711 * details.
2712 *
2713 * Return: status code
2714 */
2715efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2716 efi_uintn_t *exit_data_size,
2717 u16 **exit_data)
2718{
2719 struct efi_loaded_image_obj *image_obj =
2720 (struct efi_loaded_image_obj *)image_handle;
2721 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002722 void *info;
2723 efi_handle_t parent_image = current_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002724
2725 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2726
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002727 /* Check parameters */
2728 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2729 &info, NULL, NULL,
2730 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2731 if (ret != EFI_SUCCESS)
2732 return EFI_EXIT(EFI_INVALID_PARAMETER);
2733
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002734 efi_is_direct_boot = false;
2735
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002736 image_obj->exit_data_size = exit_data_size;
2737 image_obj->exit_data = exit_data;
2738
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002739 /* call the image! */
2740 if (setjmp(&image_obj->exit_jmp)) {
2741 /*
2742 * We called the entry point of the child image with EFI_CALL
2743 * in the lines below. The child image called the Exit() boot
2744 * service efi_exit() which executed the long jump that brought
2745 * us to the current line. This implies that the second half
2746 * of the EFI_CALL macro has not been executed.
2747 */
2748#ifdef CONFIG_ARM
2749 /*
2750 * efi_exit() called efi_restore_gd(). We have to undo this
2751 * otherwise __efi_entry_check() will put the wrong value into
2752 * app_gd.
2753 */
2754 gd = app_gd;
2755#endif
2756 /*
2757 * To get ready to call EFI_EXIT below we have to execute the
2758 * missed out steps of EFI_CALL.
2759 */
2760 assert(__efi_entry_check());
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02002761 EFI_PRINT("%lu returned by started image\n",
2762 (unsigned long)((uintptr_t)image_obj->exit_status &
2763 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002764 current_image = parent_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002765 return EFI_EXIT(image_obj->exit_status);
2766 }
2767
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002768 current_image = image_handle;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02002769 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09002770 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002771 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2772
2773 /*
2774 * Usually UEFI applications call Exit() instead of returning.
2775 * But because the world doesn't consist of ponies and unicorns,
2776 * we're happy to emulate that behavior on behalf of a payload
2777 * that forgot.
2778 */
2779 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2780}
2781
2782/**
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002783 * efi_delete_image() - delete loaded image from memory)
2784 *
2785 * @image_obj: handle of the loaded image
2786 * @loaded_image_protocol: loaded image protocol
2787 */
2788static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2789 struct efi_loaded_image *loaded_image_protocol)
2790{
2791 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2792 efi_size_in_pages(loaded_image_protocol->image_size));
2793 efi_delete_handle(&image_obj->header);
2794}
2795
2796/**
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002797 * efi_unload_image() - unload an EFI image
2798 * @image_handle: handle of the image to be unloaded
2799 *
2800 * This function implements the UnloadImage service.
2801 *
2802 * See the Unified Extensible Firmware Interface (UEFI) specification for
2803 * details.
2804 *
2805 * Return: status code
2806 */
2807efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2808{
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002809 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002810 struct efi_object *efiobj;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002811 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002812
2813 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002814
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002815 efiobj = efi_search_obj(image_handle);
2816 if (!efiobj) {
2817 ret = EFI_INVALID_PARAMETER;
2818 goto out;
2819 }
2820 /* Find the loaded image protocol */
2821 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2822 (void **)&loaded_image_protocol,
2823 NULL, NULL,
2824 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2825 if (ret != EFI_SUCCESS) {
2826 ret = EFI_INVALID_PARAMETER;
2827 goto out;
2828 }
2829 switch (efiobj->type) {
2830 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2831 /* Call the unload function */
2832 if (!loaded_image_protocol->unload) {
2833 ret = EFI_UNSUPPORTED;
2834 goto out;
2835 }
2836 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2837 if (ret != EFI_SUCCESS)
2838 goto out;
2839 break;
2840 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2841 break;
2842 default:
2843 ret = EFI_INVALID_PARAMETER;
2844 goto out;
2845 }
2846 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2847 loaded_image_protocol);
2848out:
2849 return EFI_EXIT(ret);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002850}
2851
2852/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002853 * efi_update_exit_data() - fill exit data parameters of StartImage()
2854 *
2855 * @image_obj image handle
2856 * @exit_data_size size of the exit data buffer
2857 * @exit_data buffer with data returned by UEFI payload
2858 * Return: status code
2859 */
2860static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2861 efi_uintn_t exit_data_size,
2862 u16 *exit_data)
2863{
2864 efi_status_t ret;
2865
2866 /*
2867 * If exit_data is not provided to StartImage(), exit_data_size must be
2868 * ignored.
2869 */
2870 if (!image_obj->exit_data)
2871 return EFI_SUCCESS;
2872 if (image_obj->exit_data_size)
2873 *image_obj->exit_data_size = exit_data_size;
2874 if (exit_data_size && exit_data) {
2875 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2876 exit_data_size,
2877 (void **)image_obj->exit_data);
2878 if (ret != EFI_SUCCESS)
2879 return ret;
2880 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2881 } else {
2882 image_obj->exit_data = NULL;
2883 }
2884 return EFI_SUCCESS;
2885}
2886
2887/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002888 * efi_exit() - leave an EFI application or driver
2889 * @image_handle: handle of the application or driver that is exiting
2890 * @exit_status: status code
2891 * @exit_data_size: size of the buffer in bytes
2892 * @exit_data: buffer with data describing an error
2893 *
2894 * This function implements the Exit service.
2895 *
2896 * See the Unified Extensible Firmware Interface (UEFI) specification for
2897 * details.
2898 *
2899 * Return: status code
2900 */
2901static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2902 efi_status_t exit_status,
2903 efi_uintn_t exit_data_size,
2904 u16 *exit_data)
2905{
2906 /*
2907 * TODO: We should call the unload procedure of the loaded
2908 * image protocol.
2909 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002910 efi_status_t ret;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002911 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002912 struct efi_loaded_image_obj *image_obj =
2913 (struct efi_loaded_image_obj *)image_handle;
2914
2915 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2916 exit_data_size, exit_data);
2917
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002918 /* Check parameters */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002919 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002920 (void **)&loaded_image_protocol,
2921 NULL, NULL,
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002922 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002923 if (ret != EFI_SUCCESS) {
2924 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002925 goto out;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002926 }
2927
2928 /* Unloading of unstarted images */
2929 switch (image_obj->header.type) {
2930 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2931 break;
2932 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2933 efi_delete_image(image_obj, loaded_image_protocol);
2934 ret = EFI_SUCCESS;
2935 goto out;
2936 default:
2937 /* Handle does not refer to loaded image */
2938 ret = EFI_INVALID_PARAMETER;
2939 goto out;
2940 }
2941 /* A started image can only be unloaded it is the last one started. */
2942 if (image_handle != current_image) {
2943 ret = EFI_INVALID_PARAMETER;
2944 goto out;
2945 }
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002946
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002947 /* Exit data is only foreseen in case of failure. */
2948 if (exit_status != EFI_SUCCESS) {
2949 ret = efi_update_exit_data(image_obj, exit_data_size,
2950 exit_data);
2951 /* Exiting has priority. Don't return error to caller. */
2952 if (ret != EFI_SUCCESS)
2953 EFI_PRINT("%s: out of memory\n", __func__);
2954 }
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002955 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2956 exit_status != EFI_SUCCESS)
2957 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002958
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002959 /* Make sure entry/exit counts for EFI world cross-overs match */
2960 EFI_EXIT(exit_status);
2961
2962 /*
2963 * But longjmp out with the U-Boot gd, not the application's, as
2964 * the other end is a setjmp call inside EFI context.
2965 */
2966 efi_restore_gd();
2967
2968 image_obj->exit_status = exit_status;
2969 longjmp(&image_obj->exit_jmp, 1);
2970
2971 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002972out:
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002973 return EFI_EXIT(ret);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002974}
2975
2976/**
Mario Six78a88f72018-07-10 08:40:17 +02002977 * efi_handle_protocol() - get interface of a protocol on a handle
2978 * @handle: handle on which the protocol shall be opened
2979 * @protocol: GUID of the protocol
2980 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002981 *
2982 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002983 *
Mario Six78a88f72018-07-10 08:40:17 +02002984 * See the Unified Extensible Firmware Interface (UEFI) specification for
2985 * details.
2986 *
2987 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002988 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002989static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002990 const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002991 void **protocol_interface)
2992{
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02002993 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2994 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01002995}
2996
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002997/**
Mario Six78a88f72018-07-10 08:40:17 +02002998 * efi_bind_controller() - bind a single driver to a controller
2999 * @controller_handle: controller handle
3000 * @driver_image_handle: driver handle
3001 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003002 *
Mario Six78a88f72018-07-10 08:40:17 +02003003 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003004 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003005static efi_status_t efi_bind_controller(
3006 efi_handle_t controller_handle,
3007 efi_handle_t driver_image_handle,
3008 struct efi_device_path *remain_device_path)
3009{
3010 struct efi_driver_binding_protocol *binding_protocol;
3011 efi_status_t r;
3012
3013 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3014 &efi_guid_driver_binding_protocol,
3015 (void **)&binding_protocol,
3016 driver_image_handle, NULL,
3017 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3018 if (r != EFI_SUCCESS)
3019 return r;
3020 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3021 controller_handle,
3022 remain_device_path));
3023 if (r == EFI_SUCCESS)
3024 r = EFI_CALL(binding_protocol->start(binding_protocol,
3025 controller_handle,
3026 remain_device_path));
3027 EFI_CALL(efi_close_protocol(driver_image_handle,
3028 &efi_guid_driver_binding_protocol,
3029 driver_image_handle, NULL));
3030 return r;
3031}
3032
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003033/**
Mario Six78a88f72018-07-10 08:40:17 +02003034 * efi_connect_single_controller() - connect a single driver to a controller
3035 * @controller_handle: controller
3036 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003037 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003038 *
Mario Six78a88f72018-07-10 08:40:17 +02003039 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003040 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003041static efi_status_t efi_connect_single_controller(
3042 efi_handle_t controller_handle,
3043 efi_handle_t *driver_image_handle,
3044 struct efi_device_path *remain_device_path)
3045{
3046 efi_handle_t *buffer;
3047 size_t count;
3048 size_t i;
3049 efi_status_t r;
3050 size_t connected = 0;
3051
3052 /* Get buffer with all handles with driver binding protocol */
3053 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3054 &efi_guid_driver_binding_protocol,
3055 NULL, &count, &buffer));
3056 if (r != EFI_SUCCESS)
3057 return r;
3058
3059 /* Context Override */
3060 if (driver_image_handle) {
3061 for (; *driver_image_handle; ++driver_image_handle) {
3062 for (i = 0; i < count; ++i) {
3063 if (buffer[i] == *driver_image_handle) {
3064 buffer[i] = NULL;
3065 r = efi_bind_controller(
3066 controller_handle,
3067 *driver_image_handle,
3068 remain_device_path);
3069 /*
3070 * For drivers that do not support the
3071 * controller or are already connected
3072 * we receive an error code here.
3073 */
3074 if (r == EFI_SUCCESS)
3075 ++connected;
3076 }
3077 }
3078 }
3079 }
3080
3081 /*
3082 * TODO: Some overrides are not yet implemented:
3083 * - Platform Driver Override
3084 * - Driver Family Override Search
3085 * - Bus Specific Driver Override
3086 */
3087
3088 /* Driver Binding Search */
3089 for (i = 0; i < count; ++i) {
3090 if (buffer[i]) {
3091 r = efi_bind_controller(controller_handle,
3092 buffer[i],
3093 remain_device_path);
3094 if (r == EFI_SUCCESS)
3095 ++connected;
3096 }
3097 }
3098
3099 efi_free_pool(buffer);
3100 if (!connected)
3101 return EFI_NOT_FOUND;
3102 return EFI_SUCCESS;
3103}
3104
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003105/**
Mario Six78a88f72018-07-10 08:40:17 +02003106 * efi_connect_controller() - connect a controller to a driver
3107 * @controller_handle: handle of the controller
3108 * @driver_image_handle: handle of the driver
3109 * @remain_device_path: device path of a child controller
3110 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003111 *
3112 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02003113 *
3114 * See the Unified Extensible Firmware Interface (UEFI) specification for
3115 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003116 *
3117 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003118 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003119 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3120 *
Mario Six78a88f72018-07-10 08:40:17 +02003121 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003122 */
3123static efi_status_t EFIAPI efi_connect_controller(
3124 efi_handle_t controller_handle,
3125 efi_handle_t *driver_image_handle,
3126 struct efi_device_path *remain_device_path,
3127 bool recursive)
3128{
3129 efi_status_t r;
3130 efi_status_t ret = EFI_NOT_FOUND;
3131 struct efi_object *efiobj;
3132
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01003133 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003134 remain_device_path, recursive);
3135
3136 efiobj = efi_search_obj(controller_handle);
3137 if (!efiobj) {
3138 ret = EFI_INVALID_PARAMETER;
3139 goto out;
3140 }
3141
3142 r = efi_connect_single_controller(controller_handle,
3143 driver_image_handle,
3144 remain_device_path);
3145 if (r == EFI_SUCCESS)
3146 ret = EFI_SUCCESS;
3147 if (recursive) {
3148 struct efi_handler *handler;
3149 struct efi_open_protocol_info_item *item;
3150
3151 list_for_each_entry(handler, &efiobj->protocols, link) {
3152 list_for_each_entry(item, &handler->open_infos, link) {
3153 if (item->info.attributes &
3154 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3155 r = EFI_CALL(efi_connect_controller(
3156 item->info.controller_handle,
3157 driver_image_handle,
3158 remain_device_path,
3159 recursive));
3160 if (r == EFI_SUCCESS)
3161 ret = EFI_SUCCESS;
3162 }
3163 }
3164 }
3165 }
3166 /* Check for child controller specified by end node */
3167 if (ret != EFI_SUCCESS && remain_device_path &&
3168 remain_device_path->type == DEVICE_PATH_TYPE_END)
3169 ret = EFI_SUCCESS;
3170out:
3171 return EFI_EXIT(ret);
3172}
3173
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003174/**
Mario Six78a88f72018-07-10 08:40:17 +02003175 * efi_reinstall_protocol_interface() - reinstall protocol interface
3176 * @handle: handle on which the protocol shall be reinstalled
3177 * @protocol: GUID of the protocol to be installed
3178 * @old_interface: interface to be removed
3179 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003180 *
3181 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02003182 *
3183 * See the Unified Extensible Firmware Interface (UEFI) specification for
3184 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003185 *
3186 * The old interface is uninstalled. The new interface is installed.
3187 * Drivers are connected.
3188 *
Mario Six78a88f72018-07-10 08:40:17 +02003189 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003190 */
3191static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3192 efi_handle_t handle, const efi_guid_t *protocol,
3193 void *old_interface, void *new_interface)
3194{
3195 efi_status_t ret;
3196
3197 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3198 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003199
3200 /* Uninstall protocol but do not delete handle */
3201 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003202 if (ret != EFI_SUCCESS)
3203 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003204
3205 /* Install the new protocol */
3206 ret = efi_add_protocol(handle, protocol, new_interface);
3207 /*
3208 * The UEFI spec does not specify what should happen to the handle
3209 * if in case of an error no protocol interface remains on the handle.
3210 * So let's do nothing here.
3211 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003212 if (ret != EFI_SUCCESS)
3213 goto out;
3214 /*
3215 * The returned status code has to be ignored.
3216 * Do not create an error if no suitable driver for the handle exists.
3217 */
3218 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3219out:
3220 return EFI_EXIT(ret);
3221}
3222
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003223/**
Mario Six78a88f72018-07-10 08:40:17 +02003224 * efi_get_child_controllers() - get all child controllers associated to a driver
3225 * @efiobj: handle of the controller
3226 * @driver_handle: handle of the driver
3227 * @number_of_children: number of child controllers
3228 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003229 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003230 * The allocated buffer has to be freed with free().
3231 *
Mario Six78a88f72018-07-10 08:40:17 +02003232 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003233 */
3234static efi_status_t efi_get_child_controllers(
3235 struct efi_object *efiobj,
3236 efi_handle_t driver_handle,
3237 efi_uintn_t *number_of_children,
3238 efi_handle_t **child_handle_buffer)
3239{
3240 struct efi_handler *handler;
3241 struct efi_open_protocol_info_item *item;
3242 efi_uintn_t count = 0, i;
3243 bool duplicate;
3244
3245 /* Count all child controller associations */
3246 list_for_each_entry(handler, &efiobj->protocols, link) {
3247 list_for_each_entry(item, &handler->open_infos, link) {
3248 if (item->info.agent_handle == driver_handle &&
3249 item->info.attributes &
3250 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3251 ++count;
3252 }
3253 }
3254 /*
3255 * Create buffer. In case of duplicate child controller assignments
3256 * the buffer will be too large. But that does not harm.
3257 */
3258 *number_of_children = 0;
3259 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3260 if (!*child_handle_buffer)
3261 return EFI_OUT_OF_RESOURCES;
3262 /* Copy unique child handles */
3263 list_for_each_entry(handler, &efiobj->protocols, link) {
3264 list_for_each_entry(item, &handler->open_infos, link) {
3265 if (item->info.agent_handle == driver_handle &&
3266 item->info.attributes &
3267 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3268 /* Check this is a new child controller */
3269 duplicate = false;
3270 for (i = 0; i < *number_of_children; ++i) {
3271 if ((*child_handle_buffer)[i] ==
3272 item->info.controller_handle)
3273 duplicate = true;
3274 }
3275 /* Copy handle to buffer */
3276 if (!duplicate) {
3277 i = (*number_of_children)++;
3278 (*child_handle_buffer)[i] =
3279 item->info.controller_handle;
3280 }
3281 }
3282 }
3283 }
3284 return EFI_SUCCESS;
3285}
3286
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003287/**
Mario Six78a88f72018-07-10 08:40:17 +02003288 * efi_disconnect_controller() - disconnect a controller from a driver
3289 * @controller_handle: handle of the controller
3290 * @driver_image_handle: handle of the driver
3291 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003292 *
3293 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003294 *
Mario Six78a88f72018-07-10 08:40:17 +02003295 * See the Unified Extensible Firmware Interface (UEFI) specification for
3296 * details.
3297 *
3298 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003299 */
3300static efi_status_t EFIAPI efi_disconnect_controller(
3301 efi_handle_t controller_handle,
3302 efi_handle_t driver_image_handle,
3303 efi_handle_t child_handle)
3304{
3305 struct efi_driver_binding_protocol *binding_protocol;
3306 efi_handle_t *child_handle_buffer = NULL;
3307 size_t number_of_children = 0;
3308 efi_status_t r;
3309 size_t stop_count = 0;
3310 struct efi_object *efiobj;
3311
3312 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3313 child_handle);
3314
3315 efiobj = efi_search_obj(controller_handle);
3316 if (!efiobj) {
3317 r = EFI_INVALID_PARAMETER;
3318 goto out;
3319 }
3320
3321 if (child_handle && !efi_search_obj(child_handle)) {
3322 r = EFI_INVALID_PARAMETER;
3323 goto out;
3324 }
3325
3326 /* If no driver handle is supplied, disconnect all drivers */
3327 if (!driver_image_handle) {
3328 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3329 goto out;
3330 }
3331
3332 /* Create list of child handles */
3333 if (child_handle) {
3334 number_of_children = 1;
3335 child_handle_buffer = &child_handle;
3336 } else {
3337 efi_get_child_controllers(efiobj,
3338 driver_image_handle,
3339 &number_of_children,
3340 &child_handle_buffer);
3341 }
3342
3343 /* Get the driver binding protocol */
3344 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3345 &efi_guid_driver_binding_protocol,
3346 (void **)&binding_protocol,
3347 driver_image_handle, NULL,
3348 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3349 if (r != EFI_SUCCESS)
3350 goto out;
3351 /* Remove the children */
3352 if (number_of_children) {
3353 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3354 controller_handle,
3355 number_of_children,
3356 child_handle_buffer));
3357 if (r == EFI_SUCCESS)
3358 ++stop_count;
3359 }
3360 /* Remove the driver */
3361 if (!child_handle)
3362 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3363 controller_handle,
3364 0, NULL));
3365 if (r == EFI_SUCCESS)
3366 ++stop_count;
3367 EFI_CALL(efi_close_protocol(driver_image_handle,
3368 &efi_guid_driver_binding_protocol,
3369 driver_image_handle, NULL));
3370
3371 if (stop_count)
3372 r = EFI_SUCCESS;
3373 else
3374 r = EFI_NOT_FOUND;
3375out:
3376 if (!child_handle)
3377 free(child_handle_buffer);
3378 return EFI_EXIT(r);
3379}
3380
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003381static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003382 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003383 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3384 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003385 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003386 },
3387 .raise_tpl = efi_raise_tpl,
3388 .restore_tpl = efi_restore_tpl,
3389 .allocate_pages = efi_allocate_pages_ext,
3390 .free_pages = efi_free_pages_ext,
3391 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003392 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003393 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003394 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003395 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003396 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003397 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003398 .close_event = efi_close_event,
3399 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003400 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003401 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003402 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003403 .handle_protocol = efi_handle_protocol,
3404 .reserved = NULL,
3405 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003406 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003407 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003408 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003409 .load_image = efi_load_image,
3410 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003411 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003412 .unload_image = efi_unload_image,
3413 .exit_boot_services = efi_exit_boot_services,
3414 .get_next_monotonic_count = efi_get_next_monotonic_count,
3415 .stall = efi_stall,
3416 .set_watchdog_timer = efi_set_watchdog_timer,
3417 .connect_controller = efi_connect_controller,
3418 .disconnect_controller = efi_disconnect_controller,
3419 .open_protocol = efi_open_protocol,
3420 .close_protocol = efi_close_protocol,
3421 .open_protocol_information = efi_open_protocol_information,
3422 .protocols_per_handle = efi_protocols_per_handle,
3423 .locate_handle_buffer = efi_locate_handle_buffer,
3424 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003425 .install_multiple_protocol_interfaces =
3426 efi_install_multiple_protocol_interfaces,
3427 .uninstall_multiple_protocol_interfaces =
3428 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafbee91162016-03-04 01:09:59 +01003429 .calculate_crc32 = efi_calculate_crc32,
3430 .copy_mem = efi_copy_mem,
3431 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003432 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003433};
3434
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003435static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01003436
Alexander Graf3c63db92016-10-14 13:45:30 +02003437struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01003438 .hdr = {
3439 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003440 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003441 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01003442 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003443 .fw_vendor = firmware_vendor,
3444 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003445 .con_in = (void *)&efi_con_in,
3446 .con_out = (void *)&efi_con_out,
3447 .std_err = (void *)&efi_con_out,
3448 .runtime = (void *)&efi_runtime_services,
3449 .boottime = (void *)&efi_boot_services,
Alexander Grafbee91162016-03-04 01:09:59 +01003450 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003451 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01003452};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003453
3454/**
3455 * efi_initialize_system_table() - Initialize system table
3456 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02003457 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003458 */
3459efi_status_t efi_initialize_system_table(void)
3460{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003461 efi_status_t ret;
3462
3463 /* Allocate configuration table array */
3464 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3465 EFI_MAX_CONFIGURATION_TABLES *
3466 sizeof(struct efi_configuration_table),
3467 (void **)&systab.tables);
3468
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003469 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003470 efi_update_table_header_crc32(&systab.hdr);
3471 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3472 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003473
3474 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003475}