blob: ec6f5758ded3d7812eb47957ee142be77061affa [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 }
1137 /*
1138 * Create buffer. In case of duplicate driver assignments the buffer
1139 * will be too large. But that does not harm.
1140 */
1141 *number_of_drivers = 0;
1142 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1143 if (!*driver_handle_buffer)
1144 return EFI_OUT_OF_RESOURCES;
1145 /* Collect unique driver handles */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001146 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001147 if (protocol && guidcmp(handler->guid, protocol))
1148 continue;
1149 list_for_each_entry(item, &handler->open_infos, link) {
1150 if (item->info.attributes &
1151 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1152 /* Check this is a new driver */
1153 duplicate = false;
1154 for (i = 0; i < *number_of_drivers; ++i) {
1155 if ((*driver_handle_buffer)[i] ==
1156 item->info.agent_handle)
1157 duplicate = true;
1158 }
1159 /* Copy handle to buffer */
1160 if (!duplicate) {
1161 i = (*number_of_drivers)++;
1162 (*driver_handle_buffer)[i] =
1163 item->info.agent_handle;
1164 }
1165 }
1166 }
1167 }
1168 return EFI_SUCCESS;
1169}
1170
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001171/**
Mario Six78a88f72018-07-10 08:40:17 +02001172 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001173 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001174 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001175 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001176 *
1177 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001178 *
Mario Six78a88f72018-07-10 08:40:17 +02001179 * See the Unified Extensible Firmware Interface (UEFI) specification for
1180 * details.
1181 *
1182 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001183 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001184static efi_status_t efi_disconnect_all_drivers
1185 (efi_handle_t handle,
1186 const efi_guid_t *protocol,
1187 efi_handle_t child_handle)
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001188{
1189 efi_uintn_t number_of_drivers;
1190 efi_handle_t *driver_handle_buffer;
1191 efi_status_t r, ret;
1192
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001193 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001194 &driver_handle_buffer);
1195 if (ret != EFI_SUCCESS)
1196 return ret;
1197
1198 ret = EFI_NOT_FOUND;
1199 while (number_of_drivers) {
1200 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001201 handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001202 driver_handle_buffer[--number_of_drivers],
1203 child_handle));
1204 if (r == EFI_SUCCESS)
1205 ret = r;
1206 }
1207 free(driver_handle_buffer);
1208 return ret;
1209}
1210
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001211/**
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001212 * efi_uninstall_protocol() - uninstall protocol interface
1213 *
Mario Six78a88f72018-07-10 08:40:17 +02001214 * @handle: handle from which the protocol shall be removed
1215 * @protocol: GUID of the protocol to be removed
1216 * @protocol_interface: interface to be removed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001217 *
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001218 * This function DOES NOT delete a handle without installed protocol.
Mario Six78a88f72018-07-10 08:40:17 +02001219 *
1220 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001221 */
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001222static efi_status_t efi_uninstall_protocol
1223 (efi_handle_t handle, const efi_guid_t *protocol,
1224 void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001225{
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001226 struct efi_object *efiobj;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001227 struct efi_handler *handler;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001228 struct efi_open_protocol_info_item *item;
1229 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001230 efi_status_t r;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001231
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001232 /* Check handle */
1233 efiobj = efi_search_obj(handle);
1234 if (!efiobj) {
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001235 r = EFI_INVALID_PARAMETER;
1236 goto out;
1237 }
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001238 /* Find the protocol on the handle */
1239 r = efi_search_protocol(handle, protocol, &handler);
1240 if (r != EFI_SUCCESS)
1241 goto out;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001242 /* Disconnect controllers */
1243 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1244 if (!list_empty(&handler->open_infos)) {
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001245 r = EFI_ACCESS_DENIED;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001246 goto out;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001247 }
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001248 /* Close protocol */
1249 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1250 if (item->info.attributes ==
1251 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1252 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1253 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1254 list_del(&item->link);
1255 }
1256 if (!list_empty(&handler->open_infos)) {
1257 r = EFI_ACCESS_DENIED;
1258 goto out;
1259 }
1260 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001261out:
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001262 return r;
1263}
1264
1265/**
1266 * efi_uninstall_protocol_interface() - uninstall protocol interface
1267 * @handle: handle from which the protocol shall be removed
1268 * @protocol: GUID of the protocol to be removed
1269 * @protocol_interface: interface to be removed
1270 *
1271 * This function implements the UninstallProtocolInterface service.
1272 *
1273 * See the Unified Extensible Firmware Interface (UEFI) specification for
1274 * details.
1275 *
1276 * Return: status code
1277 */
1278static efi_status_t EFIAPI efi_uninstall_protocol_interface
1279 (efi_handle_t handle, const efi_guid_t *protocol,
1280 void *protocol_interface)
1281{
1282 efi_status_t ret;
1283
1284 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1285
1286 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1287 if (ret != EFI_SUCCESS)
1288 goto out;
1289
1290 /* If the last protocol has been removed, delete the handle. */
1291 if (list_empty(&handle->protocols)) {
1292 list_del(&handle->link);
1293 free(handle);
1294 }
1295out:
1296 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001297}
1298
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001299/**
Mario Six78a88f72018-07-10 08:40:17 +02001300 * efi_register_protocol_notify() - register an event for notification when a
1301 * protocol is installed.
1302 * @protocol: GUID of the protocol whose installation shall be notified
1303 * @event: event to be signaled upon installation of the protocol
1304 * @registration: key for retrieving the registration information
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001305 *
1306 * This function implements the RegisterProtocolNotify service.
1307 * See the Unified Extensible Firmware Interface (UEFI) specification
1308 * for details.
1309 *
Mario Six78a88f72018-07-10 08:40:17 +02001310 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001311 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001312static efi_status_t EFIAPI efi_register_protocol_notify(
1313 const efi_guid_t *protocol,
1314 struct efi_event *event,
1315 void **registration)
Alexander Grafbee91162016-03-04 01:09:59 +01001316{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001317 struct efi_register_notify_event *item;
1318 efi_status_t ret = EFI_SUCCESS;
1319
Rob Clark778e6af2017-09-13 18:05:41 -04001320 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001321
1322 if (!protocol || !event || !registration) {
1323 ret = EFI_INVALID_PARAMETER;
1324 goto out;
1325 }
1326
1327 item = calloc(1, sizeof(struct efi_register_notify_event));
1328 if (!item) {
1329 ret = EFI_OUT_OF_RESOURCES;
1330 goto out;
1331 }
1332
1333 item->event = event;
1334 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1335
1336 list_add_tail(&item->link, &efi_register_notify_events);
1337
1338 *registration = item;
1339out:
1340 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001341}
1342
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001343/**
Mario Six78a88f72018-07-10 08:40:17 +02001344 * efi_search() - determine if an EFI handle implements a protocol
1345 * @search_type: selection criterion
1346 * @protocol: GUID of the protocol
1347 * @search_key: registration key
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001348 * @handle: handle
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001349 *
1350 * See the documentation of the LocateHandle service in the UEFI specification.
1351 *
Mario Six78a88f72018-07-10 08:40:17 +02001352 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001353 */
Alexander Grafbee91162016-03-04 01:09:59 +01001354static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001355 const efi_guid_t *protocol, efi_handle_t handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001356{
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001357 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01001358
1359 switch (search_type) {
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001360 case ALL_HANDLES:
Alexander Grafbee91162016-03-04 01:09:59 +01001361 return 0;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001362 case BY_REGISTER_NOTIFY:
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001363 case BY_PROTOCOL:
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001364 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001365 return (ret != EFI_SUCCESS);
1366 default:
1367 /* Invalid search type */
Alexander Grafbee91162016-03-04 01:09:59 +01001368 return -1;
1369 }
Alexander Grafbee91162016-03-04 01:09:59 +01001370}
1371
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001372/**
Mario Six78a88f72018-07-10 08:40:17 +02001373 * efi_locate_handle() - locate handles implementing a protocol
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001374 *
1375 * @search_type: selection criterion
1376 * @protocol: GUID of the protocol
1377 * @search_key: registration key
1378 * @buffer_size: size of the buffer to receive the handles in bytes
1379 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001380 *
1381 * This function is meant for U-Boot internal calls. For the API implementation
1382 * of the LocateHandle service see efi_locate_handle_ext.
1383 *
Mario Six78a88f72018-07-10 08:40:17 +02001384 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001385 */
xypron.glpk@gmx.deebf199b2017-08-09 20:55:00 +02001386static efi_status_t efi_locate_handle(
Alexander Grafbee91162016-03-04 01:09:59 +01001387 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001388 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001389 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01001390{
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001391 struct efi_object *efiobj;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001392 efi_uintn_t size = 0;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001393 struct efi_register_notify_event *item, *event = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01001394
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001395 /* Check parameters */
1396 switch (search_type) {
1397 case ALL_HANDLES:
1398 break;
1399 case BY_REGISTER_NOTIFY:
1400 if (!search_key)
1401 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001402 /* Check that the registration key is valid */
1403 list_for_each_entry(item, &efi_register_notify_events, link) {
1404 if (item ==
1405 (struct efi_register_notify_event *)search_key) {
1406 event = item;
1407 break;
1408 }
1409 }
1410 if (!event)
1411 return EFI_INVALID_PARAMETER;
1412
1413 protocol = &event->protocol;
1414 break;
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001415 case BY_PROTOCOL:
1416 if (!protocol)
1417 return EFI_INVALID_PARAMETER;
1418 break;
1419 default:
1420 return EFI_INVALID_PARAMETER;
1421 }
1422
Alexander Grafbee91162016-03-04 01:09:59 +01001423 /* Count how much space we need */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001424 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001425 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001426 size += sizeof(void *);
Alexander Grafbee91162016-03-04 01:09:59 +01001427 }
1428
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001429 if (size == 0)
1430 return EFI_NOT_FOUND;
1431
1432 if (!buffer_size)
1433 return EFI_INVALID_PARAMETER;
1434
Alexander Grafbee91162016-03-04 01:09:59 +01001435 if (*buffer_size < size) {
1436 *buffer_size = size;
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001437 return EFI_BUFFER_TOO_SMALL;
Alexander Grafbee91162016-03-04 01:09:59 +01001438 }
1439
Rob Clark796a78c2017-08-06 14:10:07 -04001440 *buffer_size = size;
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001441
Heinrich Schuchardt0a843192019-05-10 19:03:49 +02001442 /* The buffer size is sufficient but there is no buffer */
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001443 if (!buffer)
1444 return EFI_INVALID_PARAMETER;
Rob Clark796a78c2017-08-06 14:10:07 -04001445
Alexander Grafbee91162016-03-04 01:09:59 +01001446 /* Then fill the array */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001447 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001448 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001449 *buffer++ = efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01001450 }
1451
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001452 return EFI_SUCCESS;
1453}
1454
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001455/**
Mario Six78a88f72018-07-10 08:40:17 +02001456 * efi_locate_handle_ext() - locate handles implementing a protocol.
1457 * @search_type: selection criterion
1458 * @protocol: GUID of the protocol
1459 * @search_key: registration key
1460 * @buffer_size: size of the buffer to receive the handles in bytes
1461 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001462 *
1463 * This function implements the LocateHandle service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001464 *
Mario Six78a88f72018-07-10 08:40:17 +02001465 * See the Unified Extensible Firmware Interface (UEFI) specification for
1466 * details.
1467 *
1468 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001469 */
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001470static efi_status_t EFIAPI efi_locate_handle_ext(
1471 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001472 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001473 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001474{
Rob Clark778e6af2017-09-13 18:05:41 -04001475 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001476 buffer_size, buffer);
1477
1478 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1479 buffer_size, buffer));
Alexander Grafbee91162016-03-04 01:09:59 +01001480}
1481
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001482/**
Mario Six78a88f72018-07-10 08:40:17 +02001483 * efi_remove_configuration_table() - collapses configuration table entries,
1484 * removing index i
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001485 *
Mario Six78a88f72018-07-10 08:40:17 +02001486 * @i: index of the table entry to be removed
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001487 */
Alexander Grafd98cdf62017-07-26 13:41:04 +02001488static void efi_remove_configuration_table(int i)
1489{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001490 struct efi_configuration_table *this = &systab.tables[i];
1491 struct efi_configuration_table *next = &systab.tables[i + 1];
1492 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Grafd98cdf62017-07-26 13:41:04 +02001493
1494 memmove(this, next, (ulong)end - (ulong)next);
1495 systab.nr_tables--;
1496}
1497
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001498/**
Mario Six78a88f72018-07-10 08:40:17 +02001499 * efi_install_configuration_table() - adds, updates, or removes a
1500 * configuration table
1501 * @guid: GUID of the installed table
1502 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001503 *
1504 * This function is used for internal calls. For the API implementation of the
1505 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1506 *
Mario Six78a88f72018-07-10 08:40:17 +02001507 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001508 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001509efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1510 void *table)
Alexander Grafbee91162016-03-04 01:09:59 +01001511{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001512 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +01001513 int i;
1514
Heinrich Schuchardteb68b4e2018-02-18 00:08:00 +01001515 if (!guid)
1516 return EFI_INVALID_PARAMETER;
1517
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001518 /* Check for GUID override */
Alexander Grafbee91162016-03-04 01:09:59 +01001519 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001520 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Grafd98cdf62017-07-26 13:41:04 +02001521 if (table)
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001522 systab.tables[i].table = table;
Alexander Grafd98cdf62017-07-26 13:41:04 +02001523 else
1524 efi_remove_configuration_table(i);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001525 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01001526 }
1527 }
1528
Alexander Grafd98cdf62017-07-26 13:41:04 +02001529 if (!table)
1530 return EFI_NOT_FOUND;
1531
Alexander Grafbee91162016-03-04 01:09:59 +01001532 /* No override, check for overflow */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001533 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Graf488bf122016-08-19 01:23:24 +02001534 return EFI_OUT_OF_RESOURCES;
Alexander Grafbee91162016-03-04 01:09:59 +01001535
1536 /* Add a new entry */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001537 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1538 systab.tables[i].table = table;
Alexander Grafaba5e912016-08-19 01:23:30 +02001539 systab.nr_tables = i + 1;
Alexander Grafbee91162016-03-04 01:09:59 +01001540
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001541out:
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001542 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardt55d8ee32018-07-07 15:36:05 +02001543 efi_update_table_header_crc32(&systab.hdr);
1544
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001545 /* Notify that the configuration table was changed */
1546 list_for_each_entry(evt, &efi_events, link) {
1547 if (evt->group && !guidcmp(evt->group, guid)) {
1548 efi_signal_event(evt, false);
1549 break;
1550 }
1551 }
1552
Alexander Graf488bf122016-08-19 01:23:24 +02001553 return EFI_SUCCESS;
1554}
1555
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001556/**
Mario Six78a88f72018-07-10 08:40:17 +02001557 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1558 * configuration table.
1559 * @guid: GUID of the installed table
1560 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001561 *
1562 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001563 *
Mario Six78a88f72018-07-10 08:40:17 +02001564 * See the Unified Extensible Firmware Interface (UEFI) specification for
1565 * details.
1566 *
1567 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001568 */
Alexander Graf488bf122016-08-19 01:23:24 +02001569static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1570 void *table)
1571{
Rob Clark778e6af2017-09-13 18:05:41 -04001572 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Graf488bf122016-08-19 01:23:24 +02001573 return EFI_EXIT(efi_install_configuration_table(guid, table));
Alexander Grafbee91162016-03-04 01:09:59 +01001574}
1575
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001576/**
Mario Six78a88f72018-07-10 08:40:17 +02001577 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001578 *
1579 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clark95c55532017-09-13 18:05:33 -04001580 * protocols, boot-device, etc.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001581 *
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001582 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1583 * code is returned.
1584 *
1585 * @device_path: device path of the loaded image
1586 * @file_path: file path of the loaded image
1587 * @handle_ptr: handle of the loaded image
1588 * @info_ptr: loaded image protocol
1589 * Return: status code
Rob Clark95c55532017-09-13 18:05:33 -04001590 */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001591efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1592 struct efi_device_path *file_path,
1593 struct efi_loaded_image_obj **handle_ptr,
1594 struct efi_loaded_image **info_ptr)
Rob Clark95c55532017-09-13 18:05:33 -04001595{
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001596 efi_status_t ret;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001597 struct efi_loaded_image *info = NULL;
1598 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001599 struct efi_device_path *dp;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001600
1601 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1602 *handle_ptr = NULL;
1603 *info_ptr = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001604
1605 info = calloc(1, sizeof(*info));
1606 if (!info)
1607 return EFI_OUT_OF_RESOURCES;
1608 obj = calloc(1, sizeof(*obj));
1609 if (!obj) {
1610 free(info);
1611 return EFI_OUT_OF_RESOURCES;
1612 }
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02001613 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001614
Heinrich Schuchardt44549d62017-11-26 14:05:23 +01001615 /* Add internal object to object list */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001616 efi_add_handle(&obj->header);
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001617
Heinrich Schuchardt95147312018-07-05 08:17:58 +02001618 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Rob Clark95c55532017-09-13 18:05:33 -04001619 info->file_path = file_path;
Heinrich Schuchardt7e1effc2018-08-26 15:31:52 +02001620 info->system_table = &systab;
Rob Clark95c55532017-09-13 18:05:33 -04001621
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001622 if (device_path) {
1623 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001624
1625 dp = efi_dp_append(device_path, file_path);
1626 if (!dp) {
1627 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001628 goto failure;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001629 }
1630 } else {
1631 dp = NULL;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001632 }
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001633 ret = efi_add_protocol(&obj->header,
1634 &efi_guid_loaded_image_device_path, dp);
1635 if (ret != EFI_SUCCESS)
1636 goto failure;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001637
1638 /*
1639 * When asking for the loaded_image interface, just
1640 * return handle which points to loaded_image_info
1641 */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001642 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001643 &efi_guid_loaded_image, info);
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001644 if (ret != EFI_SUCCESS)
1645 goto failure;
1646
Heinrich Schuchardtd5974af2019-03-19 18:58:58 +01001647 *info_ptr = info;
1648 *handle_ptr = obj;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001649
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001650 return ret;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001651failure:
1652 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001653 efi_delete_handle(&obj->header);
1654 free(info);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001655 return ret;
Rob Clark95c55532017-09-13 18:05:33 -04001656}
1657
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001658/**
Mario Six78a88f72018-07-10 08:40:17 +02001659 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001660 *
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001661 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1662 * callers obligation to update the memory type as needed.
1663 *
1664 * @file_path: the path of the image to load
1665 * @buffer: buffer containing the loaded image
1666 * @size: size of the loaded image
1667 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001668 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09001669static
Rob Clark9975fe92017-09-13 18:05:38 -04001670efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001671 void **buffer, efi_uintn_t *size)
Rob Clark838ee4b2017-09-13 18:05:35 -04001672{
1673 struct efi_file_info *info = NULL;
1674 struct efi_file_handle *f;
1675 static efi_status_t ret;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001676 u64 addr;
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001677 efi_uintn_t bs;
Rob Clark838ee4b2017-09-13 18:05:35 -04001678
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001679 /* In case of failure nothing is returned */
1680 *buffer = NULL;
1681 *size = 0;
1682
1683 /* Open file */
Rob Clark838ee4b2017-09-13 18:05:35 -04001684 f = efi_file_from_path(file_path);
1685 if (!f)
1686 return EFI_DEVICE_ERROR;
1687
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001688 /* Get file size */
Rob Clark838ee4b2017-09-13 18:05:35 -04001689 bs = 0;
1690 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1691 &bs, info));
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001692 if (ret != EFI_BUFFER_TOO_SMALL) {
1693 ret = EFI_DEVICE_ERROR;
1694 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001695 }
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001696
1697 info = malloc(bs);
1698 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1699 info));
Rob Clark838ee4b2017-09-13 18:05:35 -04001700 if (ret != EFI_SUCCESS)
1701 goto error;
1702
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001703 /*
1704 * When reading the file we do not yet know if it contains an
1705 * application, a boottime driver, or a runtime driver. So here we
1706 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1707 * update the reservation according to the image type.
1708 */
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001709 bs = info->file_size;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001710 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1711 EFI_BOOT_SERVICES_DATA,
1712 efi_size_in_pages(bs), &addr);
Rob Clark838ee4b2017-09-13 18:05:35 -04001713 if (ret != EFI_SUCCESS) {
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001714 ret = EFI_OUT_OF_RESOURCES;
1715 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001716 }
1717
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001718 /* Read file */
1719 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1720 if (ret != EFI_SUCCESS)
1721 efi_free_pages(addr, efi_size_in_pages(bs));
1722 *buffer = (void *)(uintptr_t)addr;
1723 *size = bs;
1724error:
1725 EFI_CALL(f->close(f));
1726 free(info);
Rob Clark838ee4b2017-09-13 18:05:35 -04001727 return ret;
1728}
1729
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001730/**
Mario Six78a88f72018-07-10 08:40:17 +02001731 * efi_load_image() - load an EFI image into memory
1732 * @boot_policy: true for request originating from the boot manager
1733 * @parent_image: the caller's image handle
1734 * @file_path: the path of the image to load
1735 * @source_buffer: memory location from which the image is installed
1736 * @source_size: size of the memory area from which the image is installed
1737 * @image_handle: handle for the newly installed image
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001738 *
1739 * This function implements the LoadImage service.
Mario Six78a88f72018-07-10 08:40:17 +02001740 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001741 * See the Unified Extensible Firmware Interface (UEFI) specification
1742 * for details.
1743 *
Mario Six78a88f72018-07-10 08:40:17 +02001744 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001745 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09001746efi_status_t EFIAPI efi_load_image(bool boot_policy,
1747 efi_handle_t parent_image,
1748 struct efi_device_path *file_path,
1749 void *source_buffer,
1750 efi_uintn_t source_size,
1751 efi_handle_t *image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001752{
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001753 struct efi_device_path *dp, *fp;
Tom Rini1c3b2f42018-09-30 10:38:15 -04001754 struct efi_loaded_image *info = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001755 struct efi_loaded_image_obj **image_obj =
1756 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001757 efi_status_t ret;
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001758 void *dest_buffer;
Alexander Grafbee91162016-03-04 01:09:59 +01001759
Heinrich Schuchardt7fb96a12018-04-03 22:29:30 +02001760 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafbee91162016-03-04 01:09:59 +01001761 file_path, source_buffer, source_size, image_handle);
Rob Clark838ee4b2017-09-13 18:05:35 -04001762
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +02001763 if (!image_handle || !efi_search_obj(parent_image)) {
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001764 ret = EFI_INVALID_PARAMETER;
1765 goto error;
1766 }
1767
1768 if (!source_buffer && !file_path) {
1769 ret = EFI_NOT_FOUND;
1770 goto error;
1771 }
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +02001772 /* The parent image handle must refer to a loaded image */
1773 if (!parent_image->type) {
1774 ret = EFI_INVALID_PARAMETER;
1775 goto error;
1776 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001777
Rob Clark838ee4b2017-09-13 18:05:35 -04001778 if (!source_buffer) {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001779 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001780 &source_size);
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001781 if (ret != EFI_SUCCESS)
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001782 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001783 } else {
Heinrich Schuchardt470dfa52019-05-05 16:55:06 +02001784 if (!source_size) {
1785 ret = EFI_LOAD_ERROR;
1786 goto error;
1787 }
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001788 dest_buffer = source_buffer;
Rob Clark838ee4b2017-09-13 18:05:35 -04001789 }
Heinrich Schuchardt1e15a9c2019-04-20 19:24:43 +00001790 /* split file_path which contains both the device and file parts */
1791 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001792 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001793 if (ret == EFI_SUCCESS)
1794 ret = efi_load_pe(*image_obj, dest_buffer, info);
1795 if (!source_buffer)
1796 /* Release buffer to which file was loaded */
1797 efi_free_pages((uintptr_t)dest_buffer,
1798 efi_size_in_pages(source_size));
1799 if (ret == EFI_SUCCESS) {
1800 info->system_table = &systab;
1801 info->parent_handle = parent_image;
1802 } else {
1803 /* The image is invalid. Release all associated resources. */
1804 efi_delete_handle(*image_handle);
1805 *image_handle = NULL;
1806 free(info);
1807 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001808error:
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001809 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001810}
1811
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001812/**
Alexander Graff31239a2018-11-15 21:23:47 +01001813 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1814 */
1815static void efi_exit_caches(void)
1816{
1817#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1818 /*
1819 * Grub on 32bit ARM needs to have caches disabled before jumping into
1820 * a zImage, but does not know of all cache layers. Give it a hand.
1821 */
1822 if (efi_is_direct_boot)
1823 cleanup_before_linux();
1824#endif
1825}
1826
1827/**
Mario Six78a88f72018-07-10 08:40:17 +02001828 * efi_exit_boot_services() - stop all boot services
1829 * @image_handle: handle of the loaded image
1830 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001831 *
1832 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02001833 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001834 * See the Unified Extensible Firmware Interface (UEFI) specification
1835 * for details.
1836 *
Mario Six78a88f72018-07-10 08:40:17 +02001837 * All timer events are disabled. For exit boot services events the
1838 * notification function is called. The boot services are disabled in the
1839 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001840 *
Mario Six78a88f72018-07-10 08:40:17 +02001841 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001842 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001843static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001844 efi_uintn_t map_key)
Alexander Grafbee91162016-03-04 01:09:59 +01001845{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001846 struct efi_event *evt;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001847
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +02001848 EFI_ENTRY("%p, %zx", image_handle, map_key);
Alexander Grafbee91162016-03-04 01:09:59 +01001849
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001850 /* Check that the caller has read the current memory map */
1851 if (map_key != efi_memory_map_key)
1852 return EFI_INVALID_PARAMETER;
1853
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001854 /* Make sure that notification functions are not called anymore */
1855 efi_tpl = TPL_HIGH_LEVEL;
1856
1857 /* Check if ExitBootServices has already been called */
1858 if (!systab.boottime)
1859 return EFI_EXIT(EFI_SUCCESS);
1860
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001861 /* Add related events to the event group */
1862 list_for_each_entry(evt, &efi_events, link) {
1863 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1864 evt->group = &efi_guid_event_group_exit_boot_services;
1865 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001866 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001867 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001868 if (evt->group &&
1869 !guidcmp(evt->group,
1870 &efi_guid_event_group_exit_boot_services)) {
1871 efi_signal_event(evt, false);
1872 break;
1873 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001874 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001875
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001876 /* TODO: Should persist EFI variables here */
Rob Clarkad644e72017-09-13 18:05:37 -04001877
Alexander Grafb7b84102016-11-17 01:02:57 +01001878 board_quiesce_devices();
1879
Alexander Graff31239a2018-11-15 21:23:47 +01001880 /* Fix up caches for EFI payloads if necessary */
1881 efi_exit_caches();
1882
Alexander Grafbee91162016-03-04 01:09:59 +01001883 /* This stops all lingering devices */
1884 bootm_disable_interrupts();
1885
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001886 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001887 systab.con_in_handle = NULL;
1888 systab.con_in = NULL;
1889 systab.con_out_handle = NULL;
1890 systab.con_out = NULL;
1891 systab.stderr_handle = NULL;
1892 systab.std_err = NULL;
1893 systab.boottime = NULL;
1894
1895 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02001896 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001897
Alexander Grafbee91162016-03-04 01:09:59 +01001898 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001899 efi_set_watchdog(0);
Alexander Grafbee91162016-03-04 01:09:59 +01001900 WATCHDOG_RESET();
1901
1902 return EFI_EXIT(EFI_SUCCESS);
1903}
1904
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001905/**
Mario Six78a88f72018-07-10 08:40:17 +02001906 * efi_get_next_monotonic_count() - get next value of the counter
1907 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001908 *
1909 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001910 *
Mario Six78a88f72018-07-10 08:40:17 +02001911 * See the Unified Extensible Firmware Interface (UEFI) specification for
1912 * details.
1913 *
1914 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001915 */
Alexander Grafbee91162016-03-04 01:09:59 +01001916static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1917{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001918 static uint64_t mono;
1919
Alexander Grafbee91162016-03-04 01:09:59 +01001920 EFI_ENTRY("%p", count);
1921 *count = mono++;
1922 return EFI_EXIT(EFI_SUCCESS);
1923}
1924
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001925/**
Mario Six78a88f72018-07-10 08:40:17 +02001926 * efi_stall() - sleep
1927 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001928 *
Mario Six78a88f72018-07-10 08:40:17 +02001929 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001930 *
Mario Six78a88f72018-07-10 08:40:17 +02001931 * See the Unified Extensible Firmware Interface (UEFI) specification for
1932 * details.
1933 *
1934 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001935 */
Alexander Grafbee91162016-03-04 01:09:59 +01001936static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1937{
1938 EFI_ENTRY("%ld", microseconds);
1939 udelay(microseconds);
1940 return EFI_EXIT(EFI_SUCCESS);
1941}
1942
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001943/**
Mario Six78a88f72018-07-10 08:40:17 +02001944 * efi_set_watchdog_timer() - reset the watchdog timer
1945 * @timeout: seconds before reset by watchdog
1946 * @watchdog_code: code to be logged when resetting
1947 * @data_size: size of buffer in bytes
1948 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001949 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001950 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001951 *
Mario Six78a88f72018-07-10 08:40:17 +02001952 * See the Unified Extensible Firmware Interface (UEFI) specification for
1953 * details.
1954 *
1955 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001956 */
Alexander Grafbee91162016-03-04 01:09:59 +01001957static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1958 uint64_t watchdog_code,
1959 unsigned long data_size,
1960 uint16_t *watchdog_data)
1961{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09001962 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01001963 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001964 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01001965}
1966
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001967/**
Mario Six78a88f72018-07-10 08:40:17 +02001968 * efi_close_protocol() - close a protocol
1969 * @handle: handle on which the protocol shall be closed
1970 * @protocol: GUID of the protocol to close
1971 * @agent_handle: handle of the driver
1972 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001973 *
1974 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001975 *
Mario Six78a88f72018-07-10 08:40:17 +02001976 * See the Unified Extensible Firmware Interface (UEFI) specification for
1977 * details.
1978 *
1979 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001980 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001981static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001982 const efi_guid_t *protocol,
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001983 efi_handle_t agent_handle,
1984 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001985{
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001986 struct efi_handler *handler;
1987 struct efi_open_protocol_info_item *item;
1988 struct efi_open_protocol_info_item *pos;
1989 efi_status_t r;
1990
Rob Clark778e6af2017-09-13 18:05:41 -04001991 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01001992 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001993
Heinrich Schuchardtec163fa2019-05-05 10:37:51 +02001994 if (!efi_search_obj(agent_handle) ||
1995 (controller_handle && !efi_search_obj(controller_handle))) {
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001996 r = EFI_INVALID_PARAMETER;
1997 goto out;
1998 }
1999 r = efi_search_protocol(handle, protocol, &handler);
2000 if (r != EFI_SUCCESS)
2001 goto out;
2002
2003 r = EFI_NOT_FOUND;
2004 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2005 if (item->info.agent_handle == agent_handle &&
2006 item->info.controller_handle == controller_handle) {
2007 efi_delete_open_info(item);
2008 r = EFI_SUCCESS;
2009 break;
2010 }
2011 }
2012out:
2013 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002014}
2015
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002016/**
Mario Six78a88f72018-07-10 08:40:17 +02002017 * efi_open_protocol_information() - provide information about then open status
2018 * of a protocol on a handle
2019 * @handle: handle for which the information shall be retrieved
2020 * @protocol: GUID of the protocol
2021 * @entry_buffer: buffer to receive the open protocol information
2022 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002023 *
2024 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002025 *
Mario Six78a88f72018-07-10 08:40:17 +02002026 * See the Unified Extensible Firmware Interface (UEFI) specification for
2027 * details.
2028 *
2029 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002030 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002031static efi_status_t EFIAPI efi_open_protocol_information(
2032 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002033 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002034 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002035{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002036 unsigned long buffer_size;
2037 unsigned long count;
2038 struct efi_handler *handler;
2039 struct efi_open_protocol_info_item *item;
2040 efi_status_t r;
2041
Rob Clark778e6af2017-09-13 18:05:41 -04002042 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01002043 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002044
2045 /* Check parameters */
2046 if (!entry_buffer) {
2047 r = EFI_INVALID_PARAMETER;
2048 goto out;
2049 }
2050 r = efi_search_protocol(handle, protocol, &handler);
2051 if (r != EFI_SUCCESS)
2052 goto out;
2053
2054 /* Count entries */
2055 count = 0;
2056 list_for_each_entry(item, &handler->open_infos, link) {
2057 if (item->info.open_count)
2058 ++count;
2059 }
2060 *entry_count = count;
2061 *entry_buffer = NULL;
2062 if (!count) {
2063 r = EFI_SUCCESS;
2064 goto out;
2065 }
2066
2067 /* Copy entries */
2068 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002069 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002070 (void **)entry_buffer);
2071 if (r != EFI_SUCCESS)
2072 goto out;
2073 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2074 if (item->info.open_count)
2075 (*entry_buffer)[--count] = item->info;
2076 }
2077out:
2078 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002079}
2080
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002081/**
Mario Six78a88f72018-07-10 08:40:17 +02002082 * efi_protocols_per_handle() - get protocols installed on a handle
2083 * @handle: handle for which the information is retrieved
2084 * @protocol_buffer: buffer with protocol GUIDs
2085 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002086 *
2087 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002088 *
Mario Six78a88f72018-07-10 08:40:17 +02002089 * See the Unified Extensible Firmware Interface (UEFI) specification for
2090 * details.
2091 *
2092 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002093 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002094static efi_status_t EFIAPI efi_protocols_per_handle(
2095 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002096 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002097{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002098 unsigned long buffer_size;
2099 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002100 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002101 efi_status_t r;
2102
Alexander Grafbee91162016-03-04 01:09:59 +01002103 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2104 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002105
2106 if (!handle || !protocol_buffer || !protocol_buffer_count)
2107 return EFI_EXIT(EFI_INVALID_PARAMETER);
2108
2109 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002110 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002111
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002112 efiobj = efi_search_obj(handle);
2113 if (!efiobj)
2114 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002115
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002116 /* Count protocols */
2117 list_for_each(protocol_handle, &efiobj->protocols) {
2118 ++*protocol_buffer_count;
2119 }
2120
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002121 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002122 if (*protocol_buffer_count) {
2123 size_t j = 0;
2124
2125 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002126 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002127 (void **)protocol_buffer);
2128 if (r != EFI_SUCCESS)
2129 return EFI_EXIT(r);
2130 list_for_each(protocol_handle, &efiobj->protocols) {
2131 struct efi_handler *protocol;
2132
2133 protocol = list_entry(protocol_handle,
2134 struct efi_handler, link);
2135 (*protocol_buffer)[j] = (void *)protocol->guid;
2136 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002137 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002138 }
2139
2140 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002141}
2142
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002143/**
Mario Six78a88f72018-07-10 08:40:17 +02002144 * efi_locate_handle_buffer() - locate handles implementing a protocol
2145 * @search_type: selection criterion
2146 * @protocol: GUID of the protocol
2147 * @search_key: registration key
2148 * @no_handles: number of returned handles
2149 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002150 *
2151 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002152 *
Mario Six78a88f72018-07-10 08:40:17 +02002153 * See the Unified Extensible Firmware Interface (UEFI) specification for
2154 * details.
2155 *
2156 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002157 */
Alexander Grafbee91162016-03-04 01:09:59 +01002158static efi_status_t EFIAPI efi_locate_handle_buffer(
2159 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002160 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002161 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002162{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002163 efi_status_t r;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002164 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002165
Rob Clark778e6af2017-09-13 18:05:41 -04002166 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002167 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002168
2169 if (!no_handles || !buffer) {
2170 r = EFI_INVALID_PARAMETER;
2171 goto out;
2172 }
2173 *no_handles = 0;
2174 *buffer = NULL;
2175 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2176 *buffer);
2177 if (r != EFI_BUFFER_TOO_SMALL)
2178 goto out;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002179 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002180 (void **)buffer);
2181 if (r != EFI_SUCCESS)
2182 goto out;
2183 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2184 *buffer);
2185 if (r == EFI_SUCCESS)
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002186 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002187out:
2188 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002189}
2190
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002191/**
Mario Six78a88f72018-07-10 08:40:17 +02002192 * efi_locate_protocol() - find an interface implementing a protocol
2193 * @protocol: GUID of the protocol
2194 * @registration: registration key passed to the notification function
2195 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002196 *
2197 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002198 *
Mario Six78a88f72018-07-10 08:40:17 +02002199 * See the Unified Extensible Firmware Interface (UEFI) specification for
2200 * details.
2201 *
2202 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002203 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002204static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002205 void *registration,
2206 void **protocol_interface)
2207{
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002208 struct list_head *lhandle;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002209 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01002210
Rob Clark778e6af2017-09-13 18:05:41 -04002211 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002212
2213 if (!protocol || !protocol_interface)
2214 return EFI_EXIT(EFI_INVALID_PARAMETER);
2215
2216 list_for_each(lhandle, &efi_obj_list) {
2217 struct efi_object *efiobj;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002218 struct efi_handler *handler;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002219
2220 efiobj = list_entry(lhandle, struct efi_object, link);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002221
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002222 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002223 if (ret == EFI_SUCCESS) {
2224 *protocol_interface = handler->protocol_interface;
2225 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002226 }
2227 }
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002228 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002229
2230 return EFI_EXIT(EFI_NOT_FOUND);
2231}
2232
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002233/**
Mario Six78a88f72018-07-10 08:40:17 +02002234 * efi_locate_device_path() - Get the device path and handle of an device
2235 * implementing a protocol
2236 * @protocol: GUID of the protocol
2237 * @device_path: device path
2238 * @device: handle of the device
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002239 *
2240 * This function implements the LocateDevicePath service.
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002241 *
Mario Six78a88f72018-07-10 08:40:17 +02002242 * See the Unified Extensible Firmware Interface (UEFI) specification for
2243 * details.
2244 *
2245 * Return: status code
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002246 */
2247static efi_status_t EFIAPI efi_locate_device_path(
2248 const efi_guid_t *protocol,
2249 struct efi_device_path **device_path,
2250 efi_handle_t *device)
2251{
2252 struct efi_device_path *dp;
2253 size_t i;
2254 struct efi_handler *handler;
2255 efi_handle_t *handles;
2256 size_t len, len_dp;
2257 size_t len_best = 0;
2258 efi_uintn_t no_handles;
2259 u8 *remainder;
2260 efi_status_t ret;
2261
2262 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2263
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002264 if (!protocol || !device_path || !*device_path) {
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002265 ret = EFI_INVALID_PARAMETER;
2266 goto out;
2267 }
2268
2269 /* Find end of device path */
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002270 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002271
2272 /* Get all handles implementing the protocol */
2273 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2274 &no_handles, &handles));
2275 if (ret != EFI_SUCCESS)
2276 goto out;
2277
2278 for (i = 0; i < no_handles; ++i) {
2279 /* Find the device path protocol */
2280 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2281 &handler);
2282 if (ret != EFI_SUCCESS)
2283 continue;
2284 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002285 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002286 /*
2287 * This handle can only be a better fit
2288 * if its device path length is longer than the best fit and
2289 * if its device path length is shorter of equal the searched
2290 * device path.
2291 */
2292 if (len_dp <= len_best || len_dp > len)
2293 continue;
2294 /* Check if dp is a subpath of device_path */
2295 if (memcmp(*device_path, dp, len_dp))
2296 continue;
Heinrich Schuchardtab557142019-05-10 19:21:41 +02002297 if (!device) {
2298 ret = EFI_INVALID_PARAMETER;
2299 goto out;
2300 }
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002301 *device = handles[i];
2302 len_best = len_dp;
2303 }
2304 if (len_best) {
2305 remainder = (u8 *)*device_path + len_best;
2306 *device_path = (struct efi_device_path *)remainder;
2307 ret = EFI_SUCCESS;
2308 } else {
2309 ret = EFI_NOT_FOUND;
2310 }
2311out:
2312 return EFI_EXIT(ret);
2313}
2314
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002315/**
Mario Six78a88f72018-07-10 08:40:17 +02002316 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2317 * interfaces
2318 * @handle: handle on which the protocol interfaces shall be installed
2319 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2320 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002321 *
2322 * This function implements the MultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002323 *
Mario Six78a88f72018-07-10 08:40:17 +02002324 * See the Unified Extensible Firmware Interface (UEFI) specification for
2325 * details.
2326 *
2327 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002328 */
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +02002329efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002330 (efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002331{
2332 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002333
Alexander Grafbeb077a2018-06-18 17:23:05 +02002334 efi_va_list argptr;
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002335 const efi_guid_t *protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002336 void *protocol_interface;
2337 efi_status_t r = EFI_SUCCESS;
2338 int i = 0;
2339
2340 if (!handle)
2341 return EFI_EXIT(EFI_INVALID_PARAMETER);
2342
Alexander Grafbeb077a2018-06-18 17:23:05 +02002343 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002344 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002345 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002346 if (!protocol)
2347 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002348 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01002349 r = EFI_CALL(efi_install_protocol_interface(
2350 handle, protocol,
2351 EFI_NATIVE_INTERFACE,
2352 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002353 if (r != EFI_SUCCESS)
2354 break;
2355 i++;
2356 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002357 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002358 if (r == EFI_SUCCESS)
2359 return EFI_EXIT(r);
2360
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002361 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002362 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002363 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002364 protocol = efi_va_arg(argptr, efi_guid_t*);
2365 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002366 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01002367 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002368 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002369 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002370
2371 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002372}
2373
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002374/**
Mario Six78a88f72018-07-10 08:40:17 +02002375 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2376 * interfaces
2377 * @handle: handle from which the protocol interfaces shall be removed
2378 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2379 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002380 *
2381 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002382 *
Mario Six78a88f72018-07-10 08:40:17 +02002383 * See the Unified Extensible Firmware Interface (UEFI) specification for
2384 * details.
2385 *
2386 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002387 */
Alexander Grafbee91162016-03-04 01:09:59 +01002388static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002389 efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002390{
2391 EFI_ENTRY("%p", handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002392
Alexander Grafbeb077a2018-06-18 17:23:05 +02002393 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002394 const efi_guid_t *protocol;
2395 void *protocol_interface;
2396 efi_status_t r = EFI_SUCCESS;
2397 size_t i = 0;
2398
2399 if (!handle)
2400 return EFI_EXIT(EFI_INVALID_PARAMETER);
2401
Alexander Grafbeb077a2018-06-18 17:23:05 +02002402 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002403 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002404 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002405 if (!protocol)
2406 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002407 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002408 r = efi_uninstall_protocol(handle, protocol,
2409 protocol_interface);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002410 if (r != EFI_SUCCESS)
2411 break;
2412 i++;
2413 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002414 efi_va_end(argptr);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002415 if (r == EFI_SUCCESS) {
2416 /* If the last protocol has been removed, delete the handle. */
2417 if (list_empty(&handle->protocols)) {
2418 list_del(&handle->link);
2419 free(handle);
2420 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002421 return EFI_EXIT(r);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002422 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002423
2424 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002425 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002426 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002427 protocol = efi_va_arg(argptr, efi_guid_t*);
2428 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002429 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2430 EFI_NATIVE_INTERFACE,
2431 protocol_interface));
2432 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002433 efi_va_end(argptr);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002434
Heinrich Schuchardte2373022018-09-24 19:57:27 +02002435 /* In case of an error always return EFI_INVALID_PARAMETER */
2436 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafbee91162016-03-04 01:09:59 +01002437}
2438
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002439/**
Mario Six78a88f72018-07-10 08:40:17 +02002440 * efi_calculate_crc32() - calculate cyclic redundancy code
2441 * @data: buffer with data
2442 * @data_size: size of buffer in bytes
2443 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002444 *
2445 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002446 *
Mario Six78a88f72018-07-10 08:40:17 +02002447 * See the Unified Extensible Firmware Interface (UEFI) specification for
2448 * details.
2449 *
2450 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002451 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002452static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2453 efi_uintn_t data_size,
2454 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002455{
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002456 EFI_ENTRY("%p, %zu", data, data_size);
Alexander Grafbee91162016-03-04 01:09:59 +01002457 *crc32_p = crc32(0, data, data_size);
2458 return EFI_EXIT(EFI_SUCCESS);
2459}
2460
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002461/**
Mario Six78a88f72018-07-10 08:40:17 +02002462 * efi_copy_mem() - copy memory
2463 * @destination: destination of the copy operation
2464 * @source: source of the copy operation
2465 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002466 *
2467 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002468 *
Mario Six78a88f72018-07-10 08:40:17 +02002469 * See the Unified Extensible Firmware Interface (UEFI) specification for
2470 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002471 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002472static void EFIAPI efi_copy_mem(void *destination, const void *source,
2473 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002474{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002475 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002476 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002477 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002478}
2479
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002480/**
Mario Six78a88f72018-07-10 08:40:17 +02002481 * efi_set_mem() - Fill memory with a byte value.
2482 * @buffer: buffer to fill
2483 * @size: size of buffer in bytes
2484 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002485 *
2486 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002487 *
Mario Six78a88f72018-07-10 08:40:17 +02002488 * See the Unified Extensible Firmware Interface (UEFI) specification for
2489 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002490 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002491static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002492{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002493 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002494 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002495 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002496}
2497
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002498/**
Mario Six78a88f72018-07-10 08:40:17 +02002499 * efi_protocol_open() - open protocol interface on a handle
2500 * @handler: handler of a protocol
2501 * @protocol_interface: interface implementing the protocol
2502 * @agent_handle: handle of the driver
2503 * @controller_handle: handle of the controller
2504 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002505 *
Mario Six78a88f72018-07-10 08:40:17 +02002506 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002507 */
2508static efi_status_t efi_protocol_open(
2509 struct efi_handler *handler,
2510 void **protocol_interface, void *agent_handle,
2511 void *controller_handle, uint32_t attributes)
2512{
2513 struct efi_open_protocol_info_item *item;
2514 struct efi_open_protocol_info_entry *match = NULL;
2515 bool opened_by_driver = false;
2516 bool opened_exclusive = false;
2517
2518 /* If there is no agent, only return the interface */
2519 if (!agent_handle)
2520 goto out;
2521
2522 /* For TEST_PROTOCOL ignore interface attribute */
2523 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2524 *protocol_interface = NULL;
2525
2526 /*
2527 * Check if the protocol is already opened by a driver with the same
2528 * attributes or opened exclusively
2529 */
2530 list_for_each_entry(item, &handler->open_infos, link) {
2531 if (item->info.agent_handle == agent_handle) {
2532 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2533 (item->info.attributes == attributes))
2534 return EFI_ALREADY_STARTED;
2535 }
2536 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2537 opened_exclusive = true;
2538 }
2539
2540 /* Only one controller can open the protocol exclusively */
2541 if (opened_exclusive && attributes &
2542 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2543 return EFI_ACCESS_DENIED;
2544
2545 /* Prepare exclusive opening */
2546 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2547 /* Try to disconnect controllers */
2548 list_for_each_entry(item, &handler->open_infos, link) {
2549 if (item->info.attributes ==
2550 EFI_OPEN_PROTOCOL_BY_DRIVER)
2551 EFI_CALL(efi_disconnect_controller(
2552 item->info.controller_handle,
2553 item->info.agent_handle,
2554 NULL));
2555 }
2556 opened_by_driver = false;
2557 /* Check if all controllers are disconnected */
2558 list_for_each_entry(item, &handler->open_infos, link) {
2559 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2560 opened_by_driver = true;
2561 }
Heinrich Schuchardt4f37fa42018-09-30 13:40:43 +02002562 /* Only one controller can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002563 if (opened_by_driver)
2564 return EFI_ACCESS_DENIED;
2565 }
2566
2567 /* Find existing entry */
2568 list_for_each_entry(item, &handler->open_infos, link) {
2569 if (item->info.agent_handle == agent_handle &&
2570 item->info.controller_handle == controller_handle)
2571 match = &item->info;
2572 }
2573 /* None found, create one */
2574 if (!match) {
2575 match = efi_create_open_info(handler);
2576 if (!match)
2577 return EFI_OUT_OF_RESOURCES;
2578 }
2579
2580 match->agent_handle = agent_handle;
2581 match->controller_handle = controller_handle;
2582 match->attributes = attributes;
2583 match->open_count++;
2584
2585out:
2586 /* For TEST_PROTOCOL ignore interface attribute. */
2587 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2588 *protocol_interface = handler->protocol_interface;
2589
2590 return EFI_SUCCESS;
2591}
2592
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002593/**
Mario Six78a88f72018-07-10 08:40:17 +02002594 * efi_open_protocol() - open protocol interface on a handle
2595 * @handle: handle on which the protocol shall be opened
2596 * @protocol: GUID of the protocol
2597 * @protocol_interface: interface implementing the protocol
2598 * @agent_handle: handle of the driver
2599 * @controller_handle: handle of the controller
2600 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002601 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002602 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002603 *
Mario Six78a88f72018-07-10 08:40:17 +02002604 * See the Unified Extensible Firmware Interface (UEFI) specification for
2605 * details.
2606 *
2607 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002608 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002609static efi_status_t EFIAPI efi_open_protocol
2610 (efi_handle_t handle, const efi_guid_t *protocol,
2611 void **protocol_interface, efi_handle_t agent_handle,
2612 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01002613{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002614 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002615 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01002616
Rob Clark778e6af2017-09-13 18:05:41 -04002617 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002618 protocol_interface, agent_handle, controller_handle,
2619 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002620
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002621 if (!handle || !protocol ||
2622 (!protocol_interface && attributes !=
2623 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2624 goto out;
2625 }
2626
2627 switch (attributes) {
2628 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2629 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2630 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2631 break;
2632 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2633 if (controller_handle == handle)
2634 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002635 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002636 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2637 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002638 /* Check that the controller handle is valid */
2639 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002640 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002641 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002642 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002643 /* Check that the agent handle is valid */
2644 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002645 goto out;
2646 break;
2647 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002648 goto out;
2649 }
2650
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002651 r = efi_search_protocol(handle, protocol, &handler);
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002652 switch (r) {
2653 case EFI_SUCCESS:
2654 break;
2655 case EFI_NOT_FOUND:
2656 r = EFI_UNSUPPORTED;
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002657 goto out;
Heinrich Schuchardte7c3cd62019-05-05 11:24:53 +02002658 default:
2659 goto out;
2660 }
Alexander Grafbee91162016-03-04 01:09:59 +01002661
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002662 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2663 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01002664out:
2665 return EFI_EXIT(r);
2666}
2667
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002668/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002669 * efi_start_image() - call the entry point of an image
2670 * @image_handle: handle of the image
2671 * @exit_data_size: size of the buffer
2672 * @exit_data: buffer to receive the exit data of the called image
2673 *
2674 * This function implements the StartImage service.
2675 *
2676 * See the Unified Extensible Firmware Interface (UEFI) specification for
2677 * details.
2678 *
2679 * Return: status code
2680 */
2681efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2682 efi_uintn_t *exit_data_size,
2683 u16 **exit_data)
2684{
2685 struct efi_loaded_image_obj *image_obj =
2686 (struct efi_loaded_image_obj *)image_handle;
2687 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002688 void *info;
2689 efi_handle_t parent_image = current_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002690
2691 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2692
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002693 /* Check parameters */
2694 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2695 &info, NULL, NULL,
2696 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2697 if (ret != EFI_SUCCESS)
2698 return EFI_EXIT(EFI_INVALID_PARAMETER);
2699
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002700 efi_is_direct_boot = false;
2701
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002702 image_obj->exit_data_size = exit_data_size;
2703 image_obj->exit_data = exit_data;
2704
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002705 /* call the image! */
2706 if (setjmp(&image_obj->exit_jmp)) {
2707 /*
2708 * We called the entry point of the child image with EFI_CALL
2709 * in the lines below. The child image called the Exit() boot
2710 * service efi_exit() which executed the long jump that brought
2711 * us to the current line. This implies that the second half
2712 * of the EFI_CALL macro has not been executed.
2713 */
2714#ifdef CONFIG_ARM
2715 /*
2716 * efi_exit() called efi_restore_gd(). We have to undo this
2717 * otherwise __efi_entry_check() will put the wrong value into
2718 * app_gd.
2719 */
2720 gd = app_gd;
2721#endif
2722 /*
2723 * To get ready to call EFI_EXIT below we have to execute the
2724 * missed out steps of EFI_CALL.
2725 */
2726 assert(__efi_entry_check());
Heinrich Schuchardt529886a2019-05-05 11:56:23 +02002727 EFI_PRINT("%lu returned by started image\n",
2728 (unsigned long)((uintptr_t)image_obj->exit_status &
2729 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002730 current_image = parent_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002731 return EFI_EXIT(image_obj->exit_status);
2732 }
2733
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002734 current_image = image_handle;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02002735 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09002736 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002737 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2738
2739 /*
2740 * Usually UEFI applications call Exit() instead of returning.
2741 * But because the world doesn't consist of ponies and unicorns,
2742 * we're happy to emulate that behavior on behalf of a payload
2743 * that forgot.
2744 */
2745 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2746}
2747
2748/**
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002749 * efi_delete_image() - delete loaded image from memory)
2750 *
2751 * @image_obj: handle of the loaded image
2752 * @loaded_image_protocol: loaded image protocol
2753 */
2754static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2755 struct efi_loaded_image *loaded_image_protocol)
2756{
2757 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2758 efi_size_in_pages(loaded_image_protocol->image_size));
2759 efi_delete_handle(&image_obj->header);
2760}
2761
2762/**
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002763 * efi_unload_image() - unload an EFI image
2764 * @image_handle: handle of the image to be unloaded
2765 *
2766 * This function implements the UnloadImage service.
2767 *
2768 * See the Unified Extensible Firmware Interface (UEFI) specification for
2769 * details.
2770 *
2771 * Return: status code
2772 */
2773efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2774{
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002775 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002776 struct efi_object *efiobj;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002777 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002778
2779 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002780
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002781 efiobj = efi_search_obj(image_handle);
2782 if (!efiobj) {
2783 ret = EFI_INVALID_PARAMETER;
2784 goto out;
2785 }
2786 /* Find the loaded image protocol */
2787 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2788 (void **)&loaded_image_protocol,
2789 NULL, NULL,
2790 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2791 if (ret != EFI_SUCCESS) {
2792 ret = EFI_INVALID_PARAMETER;
2793 goto out;
2794 }
2795 switch (efiobj->type) {
2796 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2797 /* Call the unload function */
2798 if (!loaded_image_protocol->unload) {
2799 ret = EFI_UNSUPPORTED;
2800 goto out;
2801 }
2802 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2803 if (ret != EFI_SUCCESS)
2804 goto out;
2805 break;
2806 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2807 break;
2808 default:
2809 ret = EFI_INVALID_PARAMETER;
2810 goto out;
2811 }
2812 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2813 loaded_image_protocol);
2814out:
2815 return EFI_EXIT(ret);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002816}
2817
2818/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002819 * efi_update_exit_data() - fill exit data parameters of StartImage()
2820 *
2821 * @image_obj image handle
2822 * @exit_data_size size of the exit data buffer
2823 * @exit_data buffer with data returned by UEFI payload
2824 * Return: status code
2825 */
2826static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2827 efi_uintn_t exit_data_size,
2828 u16 *exit_data)
2829{
2830 efi_status_t ret;
2831
2832 /*
2833 * If exit_data is not provided to StartImage(), exit_data_size must be
2834 * ignored.
2835 */
2836 if (!image_obj->exit_data)
2837 return EFI_SUCCESS;
2838 if (image_obj->exit_data_size)
2839 *image_obj->exit_data_size = exit_data_size;
2840 if (exit_data_size && exit_data) {
2841 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2842 exit_data_size,
2843 (void **)image_obj->exit_data);
2844 if (ret != EFI_SUCCESS)
2845 return ret;
2846 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2847 } else {
2848 image_obj->exit_data = NULL;
2849 }
2850 return EFI_SUCCESS;
2851}
2852
2853/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002854 * efi_exit() - leave an EFI application or driver
2855 * @image_handle: handle of the application or driver that is exiting
2856 * @exit_status: status code
2857 * @exit_data_size: size of the buffer in bytes
2858 * @exit_data: buffer with data describing an error
2859 *
2860 * This function implements the Exit service.
2861 *
2862 * See the Unified Extensible Firmware Interface (UEFI) specification for
2863 * details.
2864 *
2865 * Return: status code
2866 */
2867static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2868 efi_status_t exit_status,
2869 efi_uintn_t exit_data_size,
2870 u16 *exit_data)
2871{
2872 /*
2873 * TODO: We should call the unload procedure of the loaded
2874 * image protocol.
2875 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002876 efi_status_t ret;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002877 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002878 struct efi_loaded_image_obj *image_obj =
2879 (struct efi_loaded_image_obj *)image_handle;
2880
2881 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2882 exit_data_size, exit_data);
2883
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002884 /* Check parameters */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002885 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002886 (void **)&loaded_image_protocol,
2887 NULL, NULL,
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002888 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002889 if (ret != EFI_SUCCESS) {
2890 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002891 goto out;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002892 }
2893
2894 /* Unloading of unstarted images */
2895 switch (image_obj->header.type) {
2896 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2897 break;
2898 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2899 efi_delete_image(image_obj, loaded_image_protocol);
2900 ret = EFI_SUCCESS;
2901 goto out;
2902 default:
2903 /* Handle does not refer to loaded image */
2904 ret = EFI_INVALID_PARAMETER;
2905 goto out;
2906 }
2907 /* A started image can only be unloaded it is the last one started. */
2908 if (image_handle != current_image) {
2909 ret = EFI_INVALID_PARAMETER;
2910 goto out;
2911 }
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002912
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002913 /* Exit data is only foreseen in case of failure. */
2914 if (exit_status != EFI_SUCCESS) {
2915 ret = efi_update_exit_data(image_obj, exit_data_size,
2916 exit_data);
2917 /* Exiting has priority. Don't return error to caller. */
2918 if (ret != EFI_SUCCESS)
2919 EFI_PRINT("%s: out of memory\n", __func__);
2920 }
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002921 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2922 exit_status != EFI_SUCCESS)
2923 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002924
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002925 /* Make sure entry/exit counts for EFI world cross-overs match */
2926 EFI_EXIT(exit_status);
2927
2928 /*
2929 * But longjmp out with the U-Boot gd, not the application's, as
2930 * the other end is a setjmp call inside EFI context.
2931 */
2932 efi_restore_gd();
2933
2934 image_obj->exit_status = exit_status;
2935 longjmp(&image_obj->exit_jmp, 1);
2936
2937 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002938out:
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002939 return EFI_EXIT(ret);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002940}
2941
2942/**
Mario Six78a88f72018-07-10 08:40:17 +02002943 * efi_handle_protocol() - get interface of a protocol on a handle
2944 * @handle: handle on which the protocol shall be opened
2945 * @protocol: GUID of the protocol
2946 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002947 *
2948 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002949 *
Mario Six78a88f72018-07-10 08:40:17 +02002950 * See the Unified Extensible Firmware Interface (UEFI) specification for
2951 * details.
2952 *
2953 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002954 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002955static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002956 const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002957 void **protocol_interface)
2958{
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02002959 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2960 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01002961}
2962
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002963/**
Mario Six78a88f72018-07-10 08:40:17 +02002964 * efi_bind_controller() - bind a single driver to a controller
2965 * @controller_handle: controller handle
2966 * @driver_image_handle: driver handle
2967 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002968 *
Mario Six78a88f72018-07-10 08:40:17 +02002969 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002970 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002971static efi_status_t efi_bind_controller(
2972 efi_handle_t controller_handle,
2973 efi_handle_t driver_image_handle,
2974 struct efi_device_path *remain_device_path)
2975{
2976 struct efi_driver_binding_protocol *binding_protocol;
2977 efi_status_t r;
2978
2979 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2980 &efi_guid_driver_binding_protocol,
2981 (void **)&binding_protocol,
2982 driver_image_handle, NULL,
2983 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2984 if (r != EFI_SUCCESS)
2985 return r;
2986 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2987 controller_handle,
2988 remain_device_path));
2989 if (r == EFI_SUCCESS)
2990 r = EFI_CALL(binding_protocol->start(binding_protocol,
2991 controller_handle,
2992 remain_device_path));
2993 EFI_CALL(efi_close_protocol(driver_image_handle,
2994 &efi_guid_driver_binding_protocol,
2995 driver_image_handle, NULL));
2996 return r;
2997}
2998
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002999/**
Mario Six78a88f72018-07-10 08:40:17 +02003000 * efi_connect_single_controller() - connect a single driver to a controller
3001 * @controller_handle: controller
3002 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003003 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003004 *
Mario Six78a88f72018-07-10 08:40:17 +02003005 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003006 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003007static efi_status_t efi_connect_single_controller(
3008 efi_handle_t controller_handle,
3009 efi_handle_t *driver_image_handle,
3010 struct efi_device_path *remain_device_path)
3011{
3012 efi_handle_t *buffer;
3013 size_t count;
3014 size_t i;
3015 efi_status_t r;
3016 size_t connected = 0;
3017
3018 /* Get buffer with all handles with driver binding protocol */
3019 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3020 &efi_guid_driver_binding_protocol,
3021 NULL, &count, &buffer));
3022 if (r != EFI_SUCCESS)
3023 return r;
3024
3025 /* Context Override */
3026 if (driver_image_handle) {
3027 for (; *driver_image_handle; ++driver_image_handle) {
3028 for (i = 0; i < count; ++i) {
3029 if (buffer[i] == *driver_image_handle) {
3030 buffer[i] = NULL;
3031 r = efi_bind_controller(
3032 controller_handle,
3033 *driver_image_handle,
3034 remain_device_path);
3035 /*
3036 * For drivers that do not support the
3037 * controller or are already connected
3038 * we receive an error code here.
3039 */
3040 if (r == EFI_SUCCESS)
3041 ++connected;
3042 }
3043 }
3044 }
3045 }
3046
3047 /*
3048 * TODO: Some overrides are not yet implemented:
3049 * - Platform Driver Override
3050 * - Driver Family Override Search
3051 * - Bus Specific Driver Override
3052 */
3053
3054 /* Driver Binding Search */
3055 for (i = 0; i < count; ++i) {
3056 if (buffer[i]) {
3057 r = efi_bind_controller(controller_handle,
3058 buffer[i],
3059 remain_device_path);
3060 if (r == EFI_SUCCESS)
3061 ++connected;
3062 }
3063 }
3064
3065 efi_free_pool(buffer);
3066 if (!connected)
3067 return EFI_NOT_FOUND;
3068 return EFI_SUCCESS;
3069}
3070
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003071/**
Mario Six78a88f72018-07-10 08:40:17 +02003072 * efi_connect_controller() - connect a controller to a driver
3073 * @controller_handle: handle of the controller
3074 * @driver_image_handle: handle of the driver
3075 * @remain_device_path: device path of a child controller
3076 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003077 *
3078 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02003079 *
3080 * See the Unified Extensible Firmware Interface (UEFI) specification for
3081 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003082 *
3083 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003084 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003085 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3086 *
Mario Six78a88f72018-07-10 08:40:17 +02003087 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003088 */
3089static efi_status_t EFIAPI efi_connect_controller(
3090 efi_handle_t controller_handle,
3091 efi_handle_t *driver_image_handle,
3092 struct efi_device_path *remain_device_path,
3093 bool recursive)
3094{
3095 efi_status_t r;
3096 efi_status_t ret = EFI_NOT_FOUND;
3097 struct efi_object *efiobj;
3098
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01003099 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003100 remain_device_path, recursive);
3101
3102 efiobj = efi_search_obj(controller_handle);
3103 if (!efiobj) {
3104 ret = EFI_INVALID_PARAMETER;
3105 goto out;
3106 }
3107
3108 r = efi_connect_single_controller(controller_handle,
3109 driver_image_handle,
3110 remain_device_path);
3111 if (r == EFI_SUCCESS)
3112 ret = EFI_SUCCESS;
3113 if (recursive) {
3114 struct efi_handler *handler;
3115 struct efi_open_protocol_info_item *item;
3116
3117 list_for_each_entry(handler, &efiobj->protocols, link) {
3118 list_for_each_entry(item, &handler->open_infos, link) {
3119 if (item->info.attributes &
3120 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3121 r = EFI_CALL(efi_connect_controller(
3122 item->info.controller_handle,
3123 driver_image_handle,
3124 remain_device_path,
3125 recursive));
3126 if (r == EFI_SUCCESS)
3127 ret = EFI_SUCCESS;
3128 }
3129 }
3130 }
3131 }
3132 /* Check for child controller specified by end node */
3133 if (ret != EFI_SUCCESS && remain_device_path &&
3134 remain_device_path->type == DEVICE_PATH_TYPE_END)
3135 ret = EFI_SUCCESS;
3136out:
3137 return EFI_EXIT(ret);
3138}
3139
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003140/**
Mario Six78a88f72018-07-10 08:40:17 +02003141 * efi_reinstall_protocol_interface() - reinstall protocol interface
3142 * @handle: handle on which the protocol shall be reinstalled
3143 * @protocol: GUID of the protocol to be installed
3144 * @old_interface: interface to be removed
3145 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003146 *
3147 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02003148 *
3149 * See the Unified Extensible Firmware Interface (UEFI) specification for
3150 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003151 *
3152 * The old interface is uninstalled. The new interface is installed.
3153 * Drivers are connected.
3154 *
Mario Six78a88f72018-07-10 08:40:17 +02003155 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003156 */
3157static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3158 efi_handle_t handle, const efi_guid_t *protocol,
3159 void *old_interface, void *new_interface)
3160{
3161 efi_status_t ret;
3162
3163 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3164 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003165
3166 /* Uninstall protocol but do not delete handle */
3167 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003168 if (ret != EFI_SUCCESS)
3169 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003170
3171 /* Install the new protocol */
3172 ret = efi_add_protocol(handle, protocol, new_interface);
3173 /*
3174 * The UEFI spec does not specify what should happen to the handle
3175 * if in case of an error no protocol interface remains on the handle.
3176 * So let's do nothing here.
3177 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003178 if (ret != EFI_SUCCESS)
3179 goto out;
3180 /*
3181 * The returned status code has to be ignored.
3182 * Do not create an error if no suitable driver for the handle exists.
3183 */
3184 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3185out:
3186 return EFI_EXIT(ret);
3187}
3188
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003189/**
Mario Six78a88f72018-07-10 08:40:17 +02003190 * efi_get_child_controllers() - get all child controllers associated to a driver
3191 * @efiobj: handle of the controller
3192 * @driver_handle: handle of the driver
3193 * @number_of_children: number of child controllers
3194 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003195 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003196 * The allocated buffer has to be freed with free().
3197 *
Mario Six78a88f72018-07-10 08:40:17 +02003198 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003199 */
3200static efi_status_t efi_get_child_controllers(
3201 struct efi_object *efiobj,
3202 efi_handle_t driver_handle,
3203 efi_uintn_t *number_of_children,
3204 efi_handle_t **child_handle_buffer)
3205{
3206 struct efi_handler *handler;
3207 struct efi_open_protocol_info_item *item;
3208 efi_uintn_t count = 0, i;
3209 bool duplicate;
3210
3211 /* Count all child controller associations */
3212 list_for_each_entry(handler, &efiobj->protocols, link) {
3213 list_for_each_entry(item, &handler->open_infos, link) {
3214 if (item->info.agent_handle == driver_handle &&
3215 item->info.attributes &
3216 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3217 ++count;
3218 }
3219 }
3220 /*
3221 * Create buffer. In case of duplicate child controller assignments
3222 * the buffer will be too large. But that does not harm.
3223 */
3224 *number_of_children = 0;
3225 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3226 if (!*child_handle_buffer)
3227 return EFI_OUT_OF_RESOURCES;
3228 /* Copy unique child handles */
3229 list_for_each_entry(handler, &efiobj->protocols, link) {
3230 list_for_each_entry(item, &handler->open_infos, link) {
3231 if (item->info.agent_handle == driver_handle &&
3232 item->info.attributes &
3233 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3234 /* Check this is a new child controller */
3235 duplicate = false;
3236 for (i = 0; i < *number_of_children; ++i) {
3237 if ((*child_handle_buffer)[i] ==
3238 item->info.controller_handle)
3239 duplicate = true;
3240 }
3241 /* Copy handle to buffer */
3242 if (!duplicate) {
3243 i = (*number_of_children)++;
3244 (*child_handle_buffer)[i] =
3245 item->info.controller_handle;
3246 }
3247 }
3248 }
3249 }
3250 return EFI_SUCCESS;
3251}
3252
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003253/**
Mario Six78a88f72018-07-10 08:40:17 +02003254 * efi_disconnect_controller() - disconnect a controller from a driver
3255 * @controller_handle: handle of the controller
3256 * @driver_image_handle: handle of the driver
3257 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003258 *
3259 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003260 *
Mario Six78a88f72018-07-10 08:40:17 +02003261 * See the Unified Extensible Firmware Interface (UEFI) specification for
3262 * details.
3263 *
3264 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003265 */
3266static efi_status_t EFIAPI efi_disconnect_controller(
3267 efi_handle_t controller_handle,
3268 efi_handle_t driver_image_handle,
3269 efi_handle_t child_handle)
3270{
3271 struct efi_driver_binding_protocol *binding_protocol;
3272 efi_handle_t *child_handle_buffer = NULL;
3273 size_t number_of_children = 0;
3274 efi_status_t r;
3275 size_t stop_count = 0;
3276 struct efi_object *efiobj;
3277
3278 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3279 child_handle);
3280
3281 efiobj = efi_search_obj(controller_handle);
3282 if (!efiobj) {
3283 r = EFI_INVALID_PARAMETER;
3284 goto out;
3285 }
3286
3287 if (child_handle && !efi_search_obj(child_handle)) {
3288 r = EFI_INVALID_PARAMETER;
3289 goto out;
3290 }
3291
3292 /* If no driver handle is supplied, disconnect all drivers */
3293 if (!driver_image_handle) {
3294 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3295 goto out;
3296 }
3297
3298 /* Create list of child handles */
3299 if (child_handle) {
3300 number_of_children = 1;
3301 child_handle_buffer = &child_handle;
3302 } else {
3303 efi_get_child_controllers(efiobj,
3304 driver_image_handle,
3305 &number_of_children,
3306 &child_handle_buffer);
3307 }
3308
3309 /* Get the driver binding protocol */
3310 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3311 &efi_guid_driver_binding_protocol,
3312 (void **)&binding_protocol,
3313 driver_image_handle, NULL,
3314 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3315 if (r != EFI_SUCCESS)
3316 goto out;
3317 /* Remove the children */
3318 if (number_of_children) {
3319 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3320 controller_handle,
3321 number_of_children,
3322 child_handle_buffer));
3323 if (r == EFI_SUCCESS)
3324 ++stop_count;
3325 }
3326 /* Remove the driver */
3327 if (!child_handle)
3328 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3329 controller_handle,
3330 0, NULL));
3331 if (r == EFI_SUCCESS)
3332 ++stop_count;
3333 EFI_CALL(efi_close_protocol(driver_image_handle,
3334 &efi_guid_driver_binding_protocol,
3335 driver_image_handle, NULL));
3336
3337 if (stop_count)
3338 r = EFI_SUCCESS;
3339 else
3340 r = EFI_NOT_FOUND;
3341out:
3342 if (!child_handle)
3343 free(child_handle_buffer);
3344 return EFI_EXIT(r);
3345}
3346
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003347static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003348 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003349 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3350 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003351 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003352 },
3353 .raise_tpl = efi_raise_tpl,
3354 .restore_tpl = efi_restore_tpl,
3355 .allocate_pages = efi_allocate_pages_ext,
3356 .free_pages = efi_free_pages_ext,
3357 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003358 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003359 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003360 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003361 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003362 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003363 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003364 .close_event = efi_close_event,
3365 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003366 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003367 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003368 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003369 .handle_protocol = efi_handle_protocol,
3370 .reserved = NULL,
3371 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003372 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003373 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003374 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003375 .load_image = efi_load_image,
3376 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003377 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003378 .unload_image = efi_unload_image,
3379 .exit_boot_services = efi_exit_boot_services,
3380 .get_next_monotonic_count = efi_get_next_monotonic_count,
3381 .stall = efi_stall,
3382 .set_watchdog_timer = efi_set_watchdog_timer,
3383 .connect_controller = efi_connect_controller,
3384 .disconnect_controller = efi_disconnect_controller,
3385 .open_protocol = efi_open_protocol,
3386 .close_protocol = efi_close_protocol,
3387 .open_protocol_information = efi_open_protocol_information,
3388 .protocols_per_handle = efi_protocols_per_handle,
3389 .locate_handle_buffer = efi_locate_handle_buffer,
3390 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003391 .install_multiple_protocol_interfaces =
3392 efi_install_multiple_protocol_interfaces,
3393 .uninstall_multiple_protocol_interfaces =
3394 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafbee91162016-03-04 01:09:59 +01003395 .calculate_crc32 = efi_calculate_crc32,
3396 .copy_mem = efi_copy_mem,
3397 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003398 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003399};
3400
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003401static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01003402
Alexander Graf3c63db92016-10-14 13:45:30 +02003403struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01003404 .hdr = {
3405 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003406 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003407 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01003408 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003409 .fw_vendor = firmware_vendor,
3410 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003411 .con_in = (void *)&efi_con_in,
3412 .con_out = (void *)&efi_con_out,
3413 .std_err = (void *)&efi_con_out,
3414 .runtime = (void *)&efi_runtime_services,
3415 .boottime = (void *)&efi_boot_services,
Alexander Grafbee91162016-03-04 01:09:59 +01003416 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003417 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01003418};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003419
3420/**
3421 * efi_initialize_system_table() - Initialize system table
3422 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02003423 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003424 */
3425efi_status_t efi_initialize_system_table(void)
3426{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003427 efi_status_t ret;
3428
3429 /* Allocate configuration table array */
3430 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3431 EFI_MAX_CONFIGURATION_TABLES *
3432 sizeof(struct efi_configuration_table),
3433 (void **)&systab.tables);
3434
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003435 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003436 efi_update_table_header_crc32(&systab.hdr);
3437 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3438 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003439
3440 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003441}