blob: 6d2dc2dda36dcacbdcc092cf4cf8f525b4eea2d7 [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>
Alexander Grafbee91162016-03-04 01:09:59 +010016#include <watchdog.h>
17
18DECLARE_GLOBAL_DATA_PTR;
19
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020020/* Task priority level */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +010021static efi_uintn_t efi_tpl = TPL_APPLICATION;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020022
Alexander Grafbee91162016-03-04 01:09:59 +010023/* This list contains all the EFI objects our payload has access to */
24LIST_HEAD(efi_obj_list);
25
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010026/* List of all events */
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +010027LIST_HEAD(efi_events);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010028
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +010029/* Handle of the currently executing image */
30static efi_handle_t current_image;
31
Alexander Graff31239a2018-11-15 21:23:47 +010032/*
33 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
34 * we need to do trickery with caches. Since we don't want to break the EFI
35 * aware boot path, only apply hacks when loading exiting directly (breaking
36 * direct Linux EFI booting along the way - oh well).
37 */
38static bool efi_is_direct_boot = true;
39
Simon Glass65e4c0b2016-09-25 15:27:35 -060040#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +010041/*
42 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
43 * fixed when compiling U-Boot. However, the payload does not know about that
44 * restriction so we need to manually swap its and our view of that register on
45 * EFI callback entry/exit.
46 */
47static volatile void *efi_gd, *app_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -060048#endif
Alexander Grafbee91162016-03-04 01:09:59 +010049
Heinrich Schuchardt914df752019-02-09 14:10:39 +010050/* 1 if inside U-Boot code, 0 if inside EFI payload code */
51static int entry_count = 1;
Rob Clarkaf65db82017-07-27 08:04:19 -040052static int nesting_level;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +010053/* GUID of the device tree table */
54const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +010055/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
56const efi_guid_t efi_guid_driver_binding_protocol =
57 EFI_DRIVER_BINDING_PROTOCOL_GUID;
Rob Clarkc160d2f2017-07-27 08:04:18 -040058
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010059/* event group ExitBootServices() invoked */
60const efi_guid_t efi_guid_event_group_exit_boot_services =
61 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
62/* event group SetVirtualAddressMap() invoked */
63const efi_guid_t efi_guid_event_group_virtual_address_change =
64 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
65/* event group memory map changed */
66const efi_guid_t efi_guid_event_group_memory_map_change =
67 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
68/* event group boot manager about to boot */
69const efi_guid_t efi_guid_event_group_ready_to_boot =
70 EFI_EVENT_GROUP_READY_TO_BOOT;
71/* event group ResetSystem() invoked (before ExitBootServices) */
72const efi_guid_t efi_guid_event_group_reset_system =
73 EFI_EVENT_GROUP_RESET_SYSTEM;
74
Heinrich Schuchardt2074f702018-01-11 08:16:09 +010075static efi_status_t EFIAPI efi_disconnect_controller(
76 efi_handle_t controller_handle,
77 efi_handle_t driver_image_handle,
78 efi_handle_t child_handle);
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +010079
Rob Clarkc160d2f2017-07-27 08:04:18 -040080/* Called on every callback entry */
81int __efi_entry_check(void)
82{
83 int ret = entry_count++ == 0;
84#ifdef CONFIG_ARM
85 assert(efi_gd);
86 app_gd = gd;
87 gd = efi_gd;
88#endif
89 return ret;
90}
91
92/* Called on every callback exit */
93int __efi_exit_check(void)
94{
95 int ret = --entry_count == 0;
96#ifdef CONFIG_ARM
97 gd = app_gd;
98#endif
99 return ret;
100}
101
Alexander Grafbee91162016-03-04 01:09:59 +0100102/* Called from do_bootefi_exec() */
103void efi_save_gd(void)
104{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600105#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100106 efi_gd = gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600107#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100108}
109
Rob Clarkc160d2f2017-07-27 08:04:18 -0400110/*
Mario Six78a88f72018-07-10 08:40:17 +0200111 * Special case handler for error/abort that just forces things back to u-boot
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200112 * world so we can dump out an abort message, without any care about returning
113 * back to UEFI world.
Rob Clarkc160d2f2017-07-27 08:04:18 -0400114 */
Alexander Grafbee91162016-03-04 01:09:59 +0100115void efi_restore_gd(void)
116{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600117#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100118 /* Only restore if we're already in EFI context */
119 if (!efi_gd)
120 return;
Alexander Grafbee91162016-03-04 01:09:59 +0100121 gd = efi_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600122#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100123}
124
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200125/**
Mario Six78a88f72018-07-10 08:40:17 +0200126 * indent_string() - returns a string for indenting with two spaces per level
127 * @level: indent level
Heinrich Schuchardtc8df80c2018-01-24 19:21:36 +0100128 *
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200129 * A maximum of ten indent levels is supported. Higher indent levels will be
130 * truncated.
131 *
Mario Six78a88f72018-07-10 08:40:17 +0200132 * Return: A string for indenting with two spaces per level is
133 * returned.
Rob Clarkaf65db82017-07-27 08:04:19 -0400134 */
135static const char *indent_string(int level)
136{
137 const char *indent = " ";
138 const int max = strlen(indent);
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +0100139
Rob Clarkaf65db82017-07-27 08:04:19 -0400140 level = min(max, level * 2);
141 return &indent[max - level];
142}
143
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200144const char *__efi_nesting(void)
145{
146 return indent_string(nesting_level);
147}
148
Rob Clarkaf65db82017-07-27 08:04:19 -0400149const char *__efi_nesting_inc(void)
150{
151 return indent_string(nesting_level++);
152}
153
154const char *__efi_nesting_dec(void)
155{
156 return indent_string(--nesting_level);
157}
158
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200159/**
Mario Six78a88f72018-07-10 08:40:17 +0200160 * efi_queue_event() - queue an EFI event
161 * @event: event to signal
162 * @check_tpl: check the TPL level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200163 *
164 * This function queues the notification function of the event for future
165 * execution.
166 *
Mario Six78a88f72018-07-10 08:40:17 +0200167 * The notification function is called if the task priority level of the event
168 * is higher than the current task priority level.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200169 *
170 * For the SignalEvent service see efi_signal_event_ext.
171 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200172 */
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100173static void efi_queue_event(struct efi_event *event, bool check_tpl)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200174{
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200175 if (event->notify_function) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200176 event->is_queued = true;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200177 /* Check TPL */
Heinrich Schuchardt9bc96642018-01-19 20:24:51 +0100178 if (check_tpl && efi_tpl >= event->notify_tpl)
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200179 return;
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200180 EFI_CALL_VOID(event->notify_function(event,
181 event->notify_context));
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200182 }
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200183 event->is_queued = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200184}
185
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200186/**
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200187 * is_valid_tpl() - check if the task priority level is valid
188 *
189 * @tpl: TPL level to check
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200190 * Return: status code
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200191 */
192efi_status_t is_valid_tpl(efi_uintn_t tpl)
193{
194 switch (tpl) {
195 case TPL_APPLICATION:
196 case TPL_CALLBACK:
197 case TPL_NOTIFY:
198 case TPL_HIGH_LEVEL:
199 return EFI_SUCCESS;
200 default:
201 return EFI_INVALID_PARAMETER;
202 }
203}
204
205/**
Mario Six78a88f72018-07-10 08:40:17 +0200206 * efi_signal_event() - signal an EFI event
207 * @event: event to signal
208 * @check_tpl: check the TPL level
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100209 *
Mario Six78a88f72018-07-10 08:40:17 +0200210 * This function signals an event. If the event belongs to an event group all
211 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100212 * their notification function is queued.
213 *
214 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100215 */
216void efi_signal_event(struct efi_event *event, bool check_tpl)
217{
218 if (event->group) {
219 struct efi_event *evt;
220
221 /*
222 * The signaled state has to set before executing any
223 * notification function
224 */
225 list_for_each_entry(evt, &efi_events, link) {
226 if (!evt->group || guidcmp(evt->group, event->group))
227 continue;
228 if (evt->is_signaled)
229 continue;
230 evt->is_signaled = true;
231 if (evt->type & EVT_NOTIFY_SIGNAL &&
232 evt->notify_function)
233 evt->is_queued = true;
234 }
235 list_for_each_entry(evt, &efi_events, link) {
236 if (!evt->group || guidcmp(evt->group, event->group))
237 continue;
238 if (evt->is_queued)
239 efi_queue_event(evt, check_tpl);
240 }
241 } else if (!event->is_signaled) {
242 event->is_signaled = true;
243 if (event->type & EVT_NOTIFY_SIGNAL)
244 efi_queue_event(event, check_tpl);
245 }
246}
247
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200248/**
Mario Six78a88f72018-07-10 08:40:17 +0200249 * efi_raise_tpl() - raise the task priority level
250 * @new_tpl: new value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200251 *
252 * This function implements the RaiseTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200253 *
Mario Six78a88f72018-07-10 08:40:17 +0200254 * See the Unified Extensible Firmware Interface (UEFI) specification for
255 * details.
256 *
257 * Return: old value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200258 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100259static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100260{
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100261 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200262
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200263 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200264
265 if (new_tpl < efi_tpl)
266 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
267 efi_tpl = new_tpl;
268 if (efi_tpl > TPL_HIGH_LEVEL)
269 efi_tpl = TPL_HIGH_LEVEL;
270
271 EFI_EXIT(EFI_SUCCESS);
272 return old_tpl;
Alexander Grafbee91162016-03-04 01:09:59 +0100273}
274
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200275/**
Mario Six78a88f72018-07-10 08:40:17 +0200276 * efi_restore_tpl() - lower the task priority level
277 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200278 *
279 * This function implements the RestoreTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200280 *
Mario Six78a88f72018-07-10 08:40:17 +0200281 * See the Unified Extensible Firmware Interface (UEFI) specification for
282 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200283 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100284static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100285{
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200286 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200287
288 if (old_tpl > efi_tpl)
289 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
290 efi_tpl = old_tpl;
291 if (efi_tpl > TPL_HIGH_LEVEL)
292 efi_tpl = TPL_HIGH_LEVEL;
293
Heinrich Schuchardt0f7fcc72018-03-24 18:40:21 +0100294 /*
295 * Lowering the TPL may have made queued events eligible for execution.
296 */
297 efi_timer_check();
298
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200299 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100300}
301
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200302/**
Mario Six78a88f72018-07-10 08:40:17 +0200303 * efi_allocate_pages_ext() - allocate memory pages
304 * @type: type of allocation to be performed
305 * @memory_type: usage type of the allocated memory
306 * @pages: number of pages to be allocated
307 * @memory: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200308 *
309 * This function implements the AllocatePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200310 *
Mario Six78a88f72018-07-10 08:40:17 +0200311 * See the Unified Extensible Firmware Interface (UEFI) specification for
312 * details.
313 *
314 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200315 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900316static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100317 efi_uintn_t pages,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900318 uint64_t *memory)
Alexander Grafbee91162016-03-04 01:09:59 +0100319{
320 efi_status_t r;
321
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100322 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafbee91162016-03-04 01:09:59 +0100323 r = efi_allocate_pages(type, memory_type, pages, memory);
324 return EFI_EXIT(r);
325}
326
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200327/**
Mario Six78a88f72018-07-10 08:40:17 +0200328 * efi_free_pages_ext() - Free memory pages.
329 * @memory: start of the memory area to be freed
330 * @pages: number of pages to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200331 *
332 * This function implements the FreePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200333 *
Mario Six78a88f72018-07-10 08:40:17 +0200334 * See the Unified Extensible Firmware Interface (UEFI) specification for
335 * details.
336 *
337 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200338 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900339static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100340 efi_uintn_t pages)
Alexander Grafbee91162016-03-04 01:09:59 +0100341{
342 efi_status_t r;
343
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900344 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafbee91162016-03-04 01:09:59 +0100345 r = efi_free_pages(memory, pages);
346 return EFI_EXIT(r);
347}
348
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200349/**
Mario Six78a88f72018-07-10 08:40:17 +0200350 * efi_get_memory_map_ext() - get map describing memory usage
351 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
352 * on exit the size of the copied memory map
353 * @memory_map: buffer to which the memory map is written
354 * @map_key: key for the memory map
355 * @descriptor_size: size of an individual memory descriptor
356 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200357 *
358 * This function implements the GetMemoryMap service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200359 *
Mario Six78a88f72018-07-10 08:40:17 +0200360 * See the Unified Extensible Firmware Interface (UEFI) specification for
361 * details.
362 *
363 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200364 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900365static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100366 efi_uintn_t *memory_map_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900367 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100368 efi_uintn_t *map_key,
369 efi_uintn_t *descriptor_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900370 uint32_t *descriptor_version)
Alexander Grafbee91162016-03-04 01:09:59 +0100371{
372 efi_status_t r;
373
374 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
375 map_key, descriptor_size, descriptor_version);
376 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
377 descriptor_size, descriptor_version);
378 return EFI_EXIT(r);
379}
380
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200381/**
Mario Six78a88f72018-07-10 08:40:17 +0200382 * efi_allocate_pool_ext() - allocate memory from pool
383 * @pool_type: type of the pool from which memory is to be allocated
384 * @size: number of bytes to be allocated
385 * @buffer: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200386 *
387 * This function implements the AllocatePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200388 *
Mario Six78a88f72018-07-10 08:40:17 +0200389 * See the Unified Extensible Firmware Interface (UEFI) specification for
390 * details.
391 *
392 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200393 */
Stefan Brünsead12742016-10-09 22:17:18 +0200394static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100395 efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200396 void **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100397{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100398 efi_status_t r;
399
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100400 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
Stefan Brünsead12742016-10-09 22:17:18 +0200401 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100402 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100403}
404
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200405/**
Mario Six78a88f72018-07-10 08:40:17 +0200406 * efi_free_pool_ext() - free memory from pool
407 * @buffer: start of memory to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200408 *
409 * This function implements the FreePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200410 *
Mario Six78a88f72018-07-10 08:40:17 +0200411 * See the Unified Extensible Firmware Interface (UEFI) specification for
412 * details.
413 *
414 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200415 */
Stefan Brüns42417bc2016-10-09 22:17:26 +0200416static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100417{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100418 efi_status_t r;
419
420 EFI_ENTRY("%p", buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200421 r = efi_free_pool(buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100422 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100423}
424
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200425/**
Mario Six78a88f72018-07-10 08:40:17 +0200426 * efi_add_handle() - add a new object to the object list
427 * @obj: object to be added
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100428 *
Mario Six78a88f72018-07-10 08:40:17 +0200429 * The protocols list is initialized. The object handle is set.
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100430 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200431void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100432{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200433 if (!handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100434 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200435 INIT_LIST_HEAD(&handle->protocols);
436 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100437}
438
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200439/**
Mario Six78a88f72018-07-10 08:40:17 +0200440 * efi_create_handle() - create handle
441 * @handle: new handle
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200442 *
Mario Six78a88f72018-07-10 08:40:17 +0200443 * Return: status code
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200444 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100445efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200446{
447 struct efi_object *obj;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200448
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200449 obj = calloc(1, sizeof(struct efi_object));
450 if (!obj)
451 return EFI_OUT_OF_RESOURCES;
452
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100453 efi_add_handle(obj);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200454 *handle = obj;
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200455
456 return EFI_SUCCESS;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200457}
458
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200459/**
Mario Six78a88f72018-07-10 08:40:17 +0200460 * efi_search_protocol() - find a protocol on a handle.
461 * @handle: handle
462 * @protocol_guid: GUID of the protocol
463 * @handler: reference to the protocol
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100464 *
Mario Six78a88f72018-07-10 08:40:17 +0200465 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100466 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100467efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100468 const efi_guid_t *protocol_guid,
469 struct efi_handler **handler)
470{
471 struct efi_object *efiobj;
472 struct list_head *lhandle;
473
474 if (!handle || !protocol_guid)
475 return EFI_INVALID_PARAMETER;
476 efiobj = efi_search_obj(handle);
477 if (!efiobj)
478 return EFI_INVALID_PARAMETER;
479 list_for_each(lhandle, &efiobj->protocols) {
480 struct efi_handler *protocol;
481
482 protocol = list_entry(lhandle, struct efi_handler, link);
483 if (!guidcmp(protocol->guid, protocol_guid)) {
484 if (handler)
485 *handler = protocol;
486 return EFI_SUCCESS;
487 }
488 }
489 return EFI_NOT_FOUND;
490}
491
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200492/**
Mario Six78a88f72018-07-10 08:40:17 +0200493 * efi_remove_protocol() - delete protocol from a handle
494 * @handle: handle from which the protocol shall be deleted
495 * @protocol: GUID of the protocol to be deleted
496 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100497 *
Mario Six78a88f72018-07-10 08:40:17 +0200498 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100499 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100500efi_status_t efi_remove_protocol(const efi_handle_t handle,
501 const efi_guid_t *protocol,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100502 void *protocol_interface)
503{
504 struct efi_handler *handler;
505 efi_status_t ret;
506
507 ret = efi_search_protocol(handle, protocol, &handler);
508 if (ret != EFI_SUCCESS)
509 return ret;
510 if (guidcmp(handler->guid, protocol))
511 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt1f470e12018-05-11 12:09:21 +0200512 if (handler->protocol_interface != protocol_interface)
513 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100514 list_del(&handler->link);
515 free(handler);
516 return EFI_SUCCESS;
517}
518
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200519/**
Mario Six78a88f72018-07-10 08:40:17 +0200520 * efi_remove_all_protocols() - delete all protocols from a handle
521 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100522 *
Mario Six78a88f72018-07-10 08:40:17 +0200523 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100524 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100525efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100526{
527 struct efi_object *efiobj;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100528 struct efi_handler *protocol;
529 struct efi_handler *pos;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100530
531 efiobj = efi_search_obj(handle);
532 if (!efiobj)
533 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100534 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100535 efi_status_t ret;
536
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100537 ret = efi_remove_protocol(handle, protocol->guid,
538 protocol->protocol_interface);
539 if (ret != EFI_SUCCESS)
540 return ret;
541 }
542 return EFI_SUCCESS;
543}
544
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200545/**
Mario Six78a88f72018-07-10 08:40:17 +0200546 * efi_delete_handle() - delete handle
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100547 *
Mario Six78a88f72018-07-10 08:40:17 +0200548 * @obj: handle to delete
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100549 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200550void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100551{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200552 if (!handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100553 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200554 efi_remove_all_protocols(handle);
555 list_del(&handle->link);
556 free(handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100557}
558
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200559/**
Mario Six78a88f72018-07-10 08:40:17 +0200560 * efi_is_event() - check if a pointer is a valid event
561 * @event: pointer to check
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100562 *
Mario Six78a88f72018-07-10 08:40:17 +0200563 * Return: status code
Alexander Grafbee91162016-03-04 01:09:59 +0100564 */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100565static efi_status_t efi_is_event(const struct efi_event *event)
566{
567 const struct efi_event *evt;
568
569 if (!event)
570 return EFI_INVALID_PARAMETER;
571 list_for_each_entry(evt, &efi_events, link) {
572 if (evt == event)
573 return EFI_SUCCESS;
574 }
575 return EFI_INVALID_PARAMETER;
576}
Alexander Grafbee91162016-03-04 01:09:59 +0100577
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200578/**
Mario Six78a88f72018-07-10 08:40:17 +0200579 * efi_create_event() - create an event
580 * @type: type of the event to create
581 * @notify_tpl: task priority level of the event
582 * @notify_function: notification function of the event
583 * @notify_context: pointer passed to the notification function
584 * @group: event group
585 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200586 *
587 * This function is used inside U-Boot code to create an event.
588 *
589 * For the API function implementing the CreateEvent service see
590 * efi_create_event_ext.
591 *
Mario Six78a88f72018-07-10 08:40:17 +0200592 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200593 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100594efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200595 void (EFIAPI *notify_function) (
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200596 struct efi_event *event,
597 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100598 void *notify_context, efi_guid_t *group,
599 struct efi_event **event)
Alexander Grafbee91162016-03-04 01:09:59 +0100600{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100601 struct efi_event *evt;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200602
Jonathan Graya95343b2017-03-12 19:26:07 +1100603 if (event == NULL)
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200604 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100605
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200606 switch (type) {
607 case 0:
608 case EVT_TIMER:
609 case EVT_NOTIFY_SIGNAL:
610 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
611 case EVT_NOTIFY_WAIT:
612 case EVT_TIMER | EVT_NOTIFY_WAIT:
613 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
614 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
615 break;
616 default:
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200617 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200618 }
Jonathan Graya95343b2017-03-12 19:26:07 +1100619
AKASHI Takahiro3748ed92018-08-10 15:36:32 +0900620 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardt751e9282019-04-25 07:30:41 +0200621 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200622 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100623
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100624 evt = calloc(1, sizeof(struct efi_event));
625 if (!evt)
626 return EFI_OUT_OF_RESOURCES;
627 evt->type = type;
628 evt->notify_tpl = notify_tpl;
629 evt->notify_function = notify_function;
630 evt->notify_context = notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100631 evt->group = group;
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200632 /* Disable timers on boot up */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100633 evt->trigger_next = -1ULL;
634 evt->is_queued = false;
635 evt->is_signaled = false;
636 list_add_tail(&evt->link, &efi_events);
637 *event = evt;
638 return EFI_SUCCESS;
Alexander Grafbee91162016-03-04 01:09:59 +0100639}
640
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200641/*
Mario Six78a88f72018-07-10 08:40:17 +0200642 * efi_create_event_ex() - create an event in a group
643 * @type: type of the event to create
644 * @notify_tpl: task priority level of the event
645 * @notify_function: notification function of the event
646 * @notify_context: pointer passed to the notification function
647 * @event: created event
648 * @event_group: event group
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100649 *
650 * This function implements the CreateEventEx service.
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100651 *
Mario Six78a88f72018-07-10 08:40:17 +0200652 * See the Unified Extensible Firmware Interface (UEFI) specification for
653 * details.
654 *
655 * Return: status code
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100656 */
657efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
658 void (EFIAPI *notify_function) (
659 struct efi_event *event,
660 void *context),
661 void *notify_context,
662 efi_guid_t *event_group,
663 struct efi_event **event)
664{
665 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
666 notify_context, event_group);
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100667 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100668 notify_context, event_group, event));
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100669}
670
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200671/**
Mario Six78a88f72018-07-10 08:40:17 +0200672 * efi_create_event_ext() - create an event
673 * @type: type of the event to create
674 * @notify_tpl: task priority level of the event
675 * @notify_function: notification function of the event
676 * @notify_context: pointer passed to the notification function
677 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200678 *
679 * This function implements the CreateEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200680 *
Mario Six78a88f72018-07-10 08:40:17 +0200681 * See the Unified Extensible Firmware Interface (UEFI) specification for
682 * details.
683 *
684 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200685 */
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200686static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100687 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200688 void (EFIAPI *notify_function) (
689 struct efi_event *event,
690 void *context),
691 void *notify_context, struct efi_event **event)
692{
693 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
694 notify_context);
695 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100696 notify_context, NULL, event));
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200697}
698
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200699/**
Mario Six78a88f72018-07-10 08:40:17 +0200700 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200701 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200702 * Check if a timer event has occurred or a queued notification function should
703 * be called.
704 *
Alexander Grafbee91162016-03-04 01:09:59 +0100705 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200706 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafbee91162016-03-04 01:09:59 +0100707 */
708void efi_timer_check(void)
709{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100710 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +0100711 u64 now = timer_get_us();
712
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100713 list_for_each_entry(evt, &efi_events, link) {
714 if (evt->is_queued)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100715 efi_queue_event(evt, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100716 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200717 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100718 switch (evt->trigger_type) {
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200719 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100720 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200721 break;
722 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100723 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200724 break;
725 default:
726 continue;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200727 }
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100728 evt->is_signaled = false;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100729 efi_signal_event(evt, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100730 }
Alexander Grafbee91162016-03-04 01:09:59 +0100731 WATCHDOG_RESET();
732}
733
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200734/**
Mario Six78a88f72018-07-10 08:40:17 +0200735 * efi_set_timer() - set the trigger time for a timer event or stop the event
736 * @event: event for which the timer is set
737 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200738 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200739 *
740 * This is the function for internal usage in U-Boot. For the API function
741 * implementing the SetTimer service see efi_set_timer_ext.
742 *
Mario Six78a88f72018-07-10 08:40:17 +0200743 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200744 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200745efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200746 uint64_t trigger_time)
Alexander Grafbee91162016-03-04 01:09:59 +0100747{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100748 /* Check that the event is valid */
749 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
750 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100751
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200752 /*
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200753 * The parameter defines a multiple of 100 ns.
754 * We use multiples of 1000 ns. So divide by 10.
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200755 */
Heinrich Schuchardt7d963322017-10-05 16:14:14 +0200756 do_div(trigger_time, 10);
Alexander Grafbee91162016-03-04 01:09:59 +0100757
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100758 switch (type) {
759 case EFI_TIMER_STOP:
760 event->trigger_next = -1ULL;
761 break;
762 case EFI_TIMER_PERIODIC:
763 case EFI_TIMER_RELATIVE:
764 event->trigger_next = timer_get_us() + trigger_time;
765 break;
766 default:
767 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100768 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100769 event->trigger_type = type;
770 event->trigger_time = trigger_time;
771 event->is_signaled = false;
772 return EFI_SUCCESS;
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200773}
774
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200775/**
Mario Six78a88f72018-07-10 08:40:17 +0200776 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
777 * event
778 * @event: event for which the timer is set
779 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200780 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200781 *
782 * This function implements the SetTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200783 *
Mario Six78a88f72018-07-10 08:40:17 +0200784 * See the Unified Extensible Firmware Interface (UEFI) specification for
785 * details.
786 *
787 *
788 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200789 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200790static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
791 enum efi_timer_delay type,
792 uint64_t trigger_time)
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200793{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900794 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200795 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
Alexander Grafbee91162016-03-04 01:09:59 +0100796}
797
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200798/**
Mario Six78a88f72018-07-10 08:40:17 +0200799 * efi_wait_for_event() - wait for events to be signaled
800 * @num_events: number of events to be waited for
801 * @event: events to be waited for
802 * @index: index of the event that was signaled
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200803 *
804 * This function implements the WaitForEvent 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 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200810 */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100811static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200812 struct efi_event **event,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100813 efi_uintn_t *index)
Alexander Grafbee91162016-03-04 01:09:59 +0100814{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100815 int i;
Alexander Grafbee91162016-03-04 01:09:59 +0100816
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100817 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
Alexander Grafbee91162016-03-04 01:09:59 +0100818
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200819 /* Check parameters */
820 if (!num_events || !event)
821 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200822 /* Check TPL */
823 if (efi_tpl != TPL_APPLICATION)
824 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200825 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100826 if (efi_is_event(event[i]) != EFI_SUCCESS)
827 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200828 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
829 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200830 if (!event[i]->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100831 efi_queue_event(event[i], true);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200832 }
833
834 /* Wait for signal */
835 for (;;) {
836 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200837 if (event[i]->is_signaled)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200838 goto out;
839 }
840 /* Allow events to occur. */
841 efi_timer_check();
842 }
843
844out:
845 /*
846 * Reset the signal which is passed to the caller to allow periodic
847 * events to occur.
848 */
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200849 event[i]->is_signaled = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200850 if (index)
851 *index = i;
Alexander Grafbee91162016-03-04 01:09:59 +0100852
853 return EFI_EXIT(EFI_SUCCESS);
854}
855
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200856/**
Mario Six78a88f72018-07-10 08:40:17 +0200857 * efi_signal_event_ext() - signal an EFI event
858 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200859 *
860 * This function implements the SignalEvent service.
Mario Six78a88f72018-07-10 08:40:17 +0200861 *
862 * See the Unified Extensible Firmware Interface (UEFI) specification for
863 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200864 *
865 * This functions sets the signaled state of the event and queues the
866 * notification function for execution.
867 *
Mario Six78a88f72018-07-10 08:40:17 +0200868 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200869 */
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200870static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100871{
872 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100873 if (efi_is_event(event) != EFI_SUCCESS)
874 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100875 efi_signal_event(event, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100876 return EFI_EXIT(EFI_SUCCESS);
877}
878
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200879/**
Mario Six78a88f72018-07-10 08:40:17 +0200880 * efi_close_event() - close an EFI event
881 * @event: event to close
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200882 *
883 * This function implements the CloseEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200884 *
Mario Six78a88f72018-07-10 08:40:17 +0200885 * See the Unified Extensible Firmware Interface (UEFI) specification for
886 * details.
887 *
888 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200889 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200890static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100891{
892 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100893 if (efi_is_event(event) != EFI_SUCCESS)
894 return EFI_EXIT(EFI_INVALID_PARAMETER);
895 list_del(&event->link);
896 free(event);
897 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100898}
899
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200900/**
Mario Six78a88f72018-07-10 08:40:17 +0200901 * efi_check_event() - check if an event is signaled
902 * @event: event to check
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200903 *
904 * This function implements the CheckEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200905 *
Mario Six78a88f72018-07-10 08:40:17 +0200906 * See the Unified Extensible Firmware Interface (UEFI) specification for
907 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200908 *
Mario Six78a88f72018-07-10 08:40:17 +0200909 * If an event is not signaled yet, the notification function is queued. The
910 * signaled state is cleared.
911 *
912 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200913 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200914static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100915{
916 EFI_ENTRY("%p", event);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200917 efi_timer_check();
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100918 if (efi_is_event(event) != EFI_SUCCESS ||
919 event->type & EVT_NOTIFY_SIGNAL)
920 return EFI_EXIT(EFI_INVALID_PARAMETER);
921 if (!event->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100922 efi_queue_event(event, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100923 if (event->is_signaled) {
924 event->is_signaled = false;
925 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200926 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100927 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafbee91162016-03-04 01:09:59 +0100928}
929
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200930/**
Mario Six78a88f72018-07-10 08:40:17 +0200931 * efi_search_obj() - find the internal EFI object for a handle
932 * @handle: handle to find
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200933 *
Mario Six78a88f72018-07-10 08:40:17 +0200934 * Return: EFI object
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200935 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100936struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200937{
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100938 struct efi_object *efiobj;
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200939
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100940 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200941 if (efiobj == handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200942 return efiobj;
943 }
944
945 return NULL;
946}
947
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200948/**
Mario Six78a88f72018-07-10 08:40:17 +0200949 * efi_open_protocol_info_entry() - create open protocol info entry and add it
950 * to a protocol
951 * @handler: handler of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100952 *
Mario Six78a88f72018-07-10 08:40:17 +0200953 * Return: open protocol info entry
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100954 */
955static struct efi_open_protocol_info_entry *efi_create_open_info(
956 struct efi_handler *handler)
957{
958 struct efi_open_protocol_info_item *item;
959
960 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
961 if (!item)
962 return NULL;
963 /* Append the item to the open protocol info list. */
964 list_add_tail(&item->link, &handler->open_infos);
965
966 return &item->info;
967}
968
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200969/**
Mario Six78a88f72018-07-10 08:40:17 +0200970 * efi_delete_open_info() - remove an open protocol info entry from a protocol
971 * @item: open protocol info entry to delete
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100972 *
Mario Six78a88f72018-07-10 08:40:17 +0200973 * Return: status code
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100974 */
975static efi_status_t efi_delete_open_info(
976 struct efi_open_protocol_info_item *item)
977{
978 list_del(&item->link);
979 free(item);
980 return EFI_SUCCESS;
981}
982
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200983/**
Mario Six78a88f72018-07-10 08:40:17 +0200984 * efi_add_protocol() - install new protocol on a handle
985 * @handle: handle on which the protocol shall be installed
986 * @protocol: GUID of the protocol to be installed
987 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200988 *
Mario Six78a88f72018-07-10 08:40:17 +0200989 * Return: status code
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200990 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100991efi_status_t efi_add_protocol(const efi_handle_t handle,
992 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200993 void *protocol_interface)
994{
995 struct efi_object *efiobj;
996 struct efi_handler *handler;
997 efi_status_t ret;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200998
999 efiobj = efi_search_obj(handle);
1000 if (!efiobj)
1001 return EFI_INVALID_PARAMETER;
1002 ret = efi_search_protocol(handle, protocol, NULL);
1003 if (ret != EFI_NOT_FOUND)
1004 return EFI_INVALID_PARAMETER;
1005 handler = calloc(1, sizeof(struct efi_handler));
1006 if (!handler)
1007 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001008 handler->guid = protocol;
1009 handler->protocol_interface = protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001010 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001011 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardtd5504142018-01-11 08:16:01 +01001012 if (!guidcmp(&efi_guid_device_path, protocol))
1013 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001014 return EFI_SUCCESS;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001015}
1016
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001017/**
Mario Six78a88f72018-07-10 08:40:17 +02001018 * efi_install_protocol_interface() - install protocol interface
1019 * @handle: handle on which the protocol shall be installed
1020 * @protocol: GUID of the protocol to be installed
1021 * @protocol_interface_type: type of the interface to be installed,
1022 * always EFI_NATIVE_INTERFACE
1023 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001024 *
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001025 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001026 *
Mario Six78a88f72018-07-10 08:40:17 +02001027 * See the Unified Extensible Firmware Interface (UEFI) specification for
1028 * details.
1029 *
1030 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001031 */
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001032static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02001033 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001034 int protocol_interface_type, void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001035{
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001036 efi_status_t r;
1037
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001038 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1039 protocol_interface);
1040
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001041 if (!handle || !protocol ||
1042 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1043 r = EFI_INVALID_PARAMETER;
1044 goto out;
1045 }
1046
1047 /* Create new handle if requested. */
1048 if (!*handle) {
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +02001049 r = efi_create_handle(handle);
1050 if (r != EFI_SUCCESS)
1051 goto out;
Heinrich Schuchardtaf1408e2017-10-26 19:25:43 +02001052 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1053 *handle);
1054 } else {
1055 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1056 *handle);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001057 }
Heinrich Schuchardt12025302017-10-26 19:25:54 +02001058 /* Add new protocol */
1059 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001060out:
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001061 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001062}
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001063
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001064/**
Mario Six78a88f72018-07-10 08:40:17 +02001065 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001066 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001067 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001068 * @number_of_drivers: number of child controllers
1069 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001070 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001071 * The allocated buffer has to be freed with free().
1072 *
Mario Six78a88f72018-07-10 08:40:17 +02001073 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001074 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001075static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001076 const efi_guid_t *protocol,
1077 efi_uintn_t *number_of_drivers,
1078 efi_handle_t **driver_handle_buffer)
1079{
1080 struct efi_handler *handler;
1081 struct efi_open_protocol_info_item *item;
1082 efi_uintn_t count = 0, i;
1083 bool duplicate;
1084
1085 /* Count all driver associations */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001086 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001087 if (protocol && guidcmp(handler->guid, protocol))
1088 continue;
1089 list_for_each_entry(item, &handler->open_infos, link) {
1090 if (item->info.attributes &
1091 EFI_OPEN_PROTOCOL_BY_DRIVER)
1092 ++count;
1093 }
1094 }
1095 /*
1096 * Create buffer. In case of duplicate driver assignments the buffer
1097 * will be too large. But that does not harm.
1098 */
1099 *number_of_drivers = 0;
1100 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1101 if (!*driver_handle_buffer)
1102 return EFI_OUT_OF_RESOURCES;
1103 /* Collect unique driver handles */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001104 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001105 if (protocol && guidcmp(handler->guid, protocol))
1106 continue;
1107 list_for_each_entry(item, &handler->open_infos, link) {
1108 if (item->info.attributes &
1109 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1110 /* Check this is a new driver */
1111 duplicate = false;
1112 for (i = 0; i < *number_of_drivers; ++i) {
1113 if ((*driver_handle_buffer)[i] ==
1114 item->info.agent_handle)
1115 duplicate = true;
1116 }
1117 /* Copy handle to buffer */
1118 if (!duplicate) {
1119 i = (*number_of_drivers)++;
1120 (*driver_handle_buffer)[i] =
1121 item->info.agent_handle;
1122 }
1123 }
1124 }
1125 }
1126 return EFI_SUCCESS;
1127}
1128
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001129/**
Mario Six78a88f72018-07-10 08:40:17 +02001130 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001131 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001132 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001133 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001134 *
1135 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001136 *
Mario Six78a88f72018-07-10 08:40:17 +02001137 * See the Unified Extensible Firmware Interface (UEFI) specification for
1138 * details.
1139 *
1140 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001141 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001142static efi_status_t efi_disconnect_all_drivers
1143 (efi_handle_t handle,
1144 const efi_guid_t *protocol,
1145 efi_handle_t child_handle)
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001146{
1147 efi_uintn_t number_of_drivers;
1148 efi_handle_t *driver_handle_buffer;
1149 efi_status_t r, ret;
1150
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001151 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001152 &driver_handle_buffer);
1153 if (ret != EFI_SUCCESS)
1154 return ret;
1155
1156 ret = EFI_NOT_FOUND;
1157 while (number_of_drivers) {
1158 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001159 handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001160 driver_handle_buffer[--number_of_drivers],
1161 child_handle));
1162 if (r == EFI_SUCCESS)
1163 ret = r;
1164 }
1165 free(driver_handle_buffer);
1166 return ret;
1167}
1168
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001169/**
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001170 * efi_uninstall_protocol() - uninstall protocol interface
1171 *
Mario Six78a88f72018-07-10 08:40:17 +02001172 * @handle: handle from which the protocol shall be removed
1173 * @protocol: GUID of the protocol to be removed
1174 * @protocol_interface: interface to be removed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001175 *
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001176 * This function DOES NOT delete a handle without installed protocol.
Mario Six78a88f72018-07-10 08:40:17 +02001177 *
1178 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001179 */
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001180static efi_status_t efi_uninstall_protocol
1181 (efi_handle_t handle, const efi_guid_t *protocol,
1182 void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001183{
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001184 struct efi_object *efiobj;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001185 struct efi_handler *handler;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001186 struct efi_open_protocol_info_item *item;
1187 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001188 efi_status_t r;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001189
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001190 /* Check handle */
1191 efiobj = efi_search_obj(handle);
1192 if (!efiobj) {
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001193 r = EFI_INVALID_PARAMETER;
1194 goto out;
1195 }
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001196 /* Find the protocol on the handle */
1197 r = efi_search_protocol(handle, protocol, &handler);
1198 if (r != EFI_SUCCESS)
1199 goto out;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001200 /* Disconnect controllers */
1201 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1202 if (!list_empty(&handler->open_infos)) {
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001203 r = EFI_ACCESS_DENIED;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001204 goto out;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001205 }
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001206 /* Close protocol */
1207 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1208 if (item->info.attributes ==
1209 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1210 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1211 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1212 list_del(&item->link);
1213 }
1214 if (!list_empty(&handler->open_infos)) {
1215 r = EFI_ACCESS_DENIED;
1216 goto out;
1217 }
1218 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001219out:
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001220 return r;
1221}
1222
1223/**
1224 * efi_uninstall_protocol_interface() - uninstall protocol interface
1225 * @handle: handle from which the protocol shall be removed
1226 * @protocol: GUID of the protocol to be removed
1227 * @protocol_interface: interface to be removed
1228 *
1229 * This function implements the UninstallProtocolInterface service.
1230 *
1231 * See the Unified Extensible Firmware Interface (UEFI) specification for
1232 * details.
1233 *
1234 * Return: status code
1235 */
1236static efi_status_t EFIAPI efi_uninstall_protocol_interface
1237 (efi_handle_t handle, const efi_guid_t *protocol,
1238 void *protocol_interface)
1239{
1240 efi_status_t ret;
1241
1242 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1243
1244 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1245 if (ret != EFI_SUCCESS)
1246 goto out;
1247
1248 /* If the last protocol has been removed, delete the handle. */
1249 if (list_empty(&handle->protocols)) {
1250 list_del(&handle->link);
1251 free(handle);
1252 }
1253out:
1254 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001255}
1256
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001257/**
Mario Six78a88f72018-07-10 08:40:17 +02001258 * efi_register_protocol_notify() - register an event for notification when a
1259 * protocol is installed.
1260 * @protocol: GUID of the protocol whose installation shall be notified
1261 * @event: event to be signaled upon installation of the protocol
1262 * @registration: key for retrieving the registration information
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001263 *
1264 * This function implements the RegisterProtocolNotify service.
1265 * See the Unified Extensible Firmware Interface (UEFI) specification
1266 * for details.
1267 *
Mario Six78a88f72018-07-10 08:40:17 +02001268 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001269 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001270static efi_status_t EFIAPI efi_register_protocol_notify(
1271 const efi_guid_t *protocol,
1272 struct efi_event *event,
1273 void **registration)
Alexander Grafbee91162016-03-04 01:09:59 +01001274{
Rob Clark778e6af2017-09-13 18:05:41 -04001275 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Alexander Grafbee91162016-03-04 01:09:59 +01001276 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1277}
1278
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001279/**
Mario Six78a88f72018-07-10 08:40:17 +02001280 * efi_search() - determine if an EFI handle implements a protocol
1281 * @search_type: selection criterion
1282 * @protocol: GUID of the protocol
1283 * @search_key: registration key
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001284 * @handle: handle
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001285 *
1286 * See the documentation of the LocateHandle service in the UEFI specification.
1287 *
Mario Six78a88f72018-07-10 08:40:17 +02001288 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001289 */
Alexander Grafbee91162016-03-04 01:09:59 +01001290static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001291 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001292 efi_handle_t handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001293{
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001294 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01001295
1296 switch (search_type) {
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001297 case ALL_HANDLES:
Alexander Grafbee91162016-03-04 01:09:59 +01001298 return 0;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001299 case BY_REGISTER_NOTIFY:
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001300 /* TODO: RegisterProtocolNotify is not implemented yet */
Alexander Grafbee91162016-03-04 01:09:59 +01001301 return -1;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001302 case BY_PROTOCOL:
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001303 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001304 return (ret != EFI_SUCCESS);
1305 default:
1306 /* Invalid search type */
Alexander Grafbee91162016-03-04 01:09:59 +01001307 return -1;
1308 }
Alexander Grafbee91162016-03-04 01:09:59 +01001309}
1310
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001311/**
Mario Six78a88f72018-07-10 08:40:17 +02001312 * efi_locate_handle() - locate handles implementing a protocol
1313 * @search_type: selection criterion
1314 * @protocol: GUID of the protocol
1315 * @search_key: registration key
1316 * @buffer_size: size of the buffer to receive the handles in bytes
1317 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001318 *
1319 * This function is meant for U-Boot internal calls. For the API implementation
1320 * of the LocateHandle service see efi_locate_handle_ext.
1321 *
Mario Six78a88f72018-07-10 08:40:17 +02001322 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001323 */
xypron.glpk@gmx.deebf199b2017-08-09 20:55:00 +02001324static efi_status_t efi_locate_handle(
Alexander Grafbee91162016-03-04 01:09:59 +01001325 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001326 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001327 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01001328{
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001329 struct efi_object *efiobj;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001330 efi_uintn_t size = 0;
Alexander Grafbee91162016-03-04 01:09:59 +01001331
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001332 /* Check parameters */
1333 switch (search_type) {
1334 case ALL_HANDLES:
1335 break;
1336 case BY_REGISTER_NOTIFY:
1337 if (!search_key)
1338 return EFI_INVALID_PARAMETER;
1339 /* RegisterProtocolNotify is not implemented yet */
1340 return EFI_UNSUPPORTED;
1341 case BY_PROTOCOL:
1342 if (!protocol)
1343 return EFI_INVALID_PARAMETER;
1344 break;
1345 default:
1346 return EFI_INVALID_PARAMETER;
1347 }
1348
1349 /*
1350 * efi_locate_handle_buffer uses this function for
1351 * the calculation of the necessary buffer size.
1352 * So do not require a buffer for buffersize == 0.
1353 */
1354 if (!buffer_size || (*buffer_size && !buffer))
1355 return EFI_INVALID_PARAMETER;
1356
Alexander Grafbee91162016-03-04 01:09:59 +01001357 /* Count how much space we need */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001358 list_for_each_entry(efiobj, &efi_obj_list, link) {
1359 if (!efi_search(search_type, protocol, search_key, efiobj))
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001360 size += sizeof(void *);
Alexander Grafbee91162016-03-04 01:09:59 +01001361 }
1362
1363 if (*buffer_size < size) {
1364 *buffer_size = size;
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001365 return EFI_BUFFER_TOO_SMALL;
Alexander Grafbee91162016-03-04 01:09:59 +01001366 }
1367
Rob Clark796a78c2017-08-06 14:10:07 -04001368 *buffer_size = size;
1369 if (size == 0)
1370 return EFI_NOT_FOUND;
1371
Alexander Grafbee91162016-03-04 01:09:59 +01001372 /* Then fill the array */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001373 list_for_each_entry(efiobj, &efi_obj_list, link) {
1374 if (!efi_search(search_type, protocol, search_key, efiobj))
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001375 *buffer++ = efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01001376 }
1377
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001378 return EFI_SUCCESS;
1379}
1380
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001381/**
Mario Six78a88f72018-07-10 08:40:17 +02001382 * efi_locate_handle_ext() - locate handles implementing a protocol.
1383 * @search_type: selection criterion
1384 * @protocol: GUID of the protocol
1385 * @search_key: registration key
1386 * @buffer_size: size of the buffer to receive the handles in bytes
1387 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001388 *
1389 * This function implements the LocateHandle service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001390 *
Mario Six78a88f72018-07-10 08:40:17 +02001391 * See the Unified Extensible Firmware Interface (UEFI) specification for
1392 * details.
1393 *
1394 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001395 */
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001396static efi_status_t EFIAPI efi_locate_handle_ext(
1397 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001398 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001399 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001400{
Rob Clark778e6af2017-09-13 18:05:41 -04001401 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001402 buffer_size, buffer);
1403
1404 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1405 buffer_size, buffer));
Alexander Grafbee91162016-03-04 01:09:59 +01001406}
1407
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001408/**
Mario Six78a88f72018-07-10 08:40:17 +02001409 * efi_remove_configuration_table() - collapses configuration table entries,
1410 * removing index i
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001411 *
Mario Six78a88f72018-07-10 08:40:17 +02001412 * @i: index of the table entry to be removed
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001413 */
Alexander Grafd98cdf62017-07-26 13:41:04 +02001414static void efi_remove_configuration_table(int i)
1415{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001416 struct efi_configuration_table *this = &systab.tables[i];
1417 struct efi_configuration_table *next = &systab.tables[i + 1];
1418 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Grafd98cdf62017-07-26 13:41:04 +02001419
1420 memmove(this, next, (ulong)end - (ulong)next);
1421 systab.nr_tables--;
1422}
1423
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001424/**
Mario Six78a88f72018-07-10 08:40:17 +02001425 * efi_install_configuration_table() - adds, updates, or removes a
1426 * configuration table
1427 * @guid: GUID of the installed table
1428 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001429 *
1430 * This function is used for internal calls. For the API implementation of the
1431 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1432 *
Mario Six78a88f72018-07-10 08:40:17 +02001433 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001434 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001435efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1436 void *table)
Alexander Grafbee91162016-03-04 01:09:59 +01001437{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001438 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +01001439 int i;
1440
Heinrich Schuchardteb68b4e2018-02-18 00:08:00 +01001441 if (!guid)
1442 return EFI_INVALID_PARAMETER;
1443
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001444 /* Check for GUID override */
Alexander Grafbee91162016-03-04 01:09:59 +01001445 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001446 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Grafd98cdf62017-07-26 13:41:04 +02001447 if (table)
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001448 systab.tables[i].table = table;
Alexander Grafd98cdf62017-07-26 13:41:04 +02001449 else
1450 efi_remove_configuration_table(i);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001451 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01001452 }
1453 }
1454
Alexander Grafd98cdf62017-07-26 13:41:04 +02001455 if (!table)
1456 return EFI_NOT_FOUND;
1457
Alexander Grafbee91162016-03-04 01:09:59 +01001458 /* No override, check for overflow */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001459 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Graf488bf122016-08-19 01:23:24 +02001460 return EFI_OUT_OF_RESOURCES;
Alexander Grafbee91162016-03-04 01:09:59 +01001461
1462 /* Add a new entry */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001463 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1464 systab.tables[i].table = table;
Alexander Grafaba5e912016-08-19 01:23:30 +02001465 systab.nr_tables = i + 1;
Alexander Grafbee91162016-03-04 01:09:59 +01001466
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001467out:
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001468 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardt55d8ee32018-07-07 15:36:05 +02001469 efi_update_table_header_crc32(&systab.hdr);
1470
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001471 /* Notify that the configuration table was changed */
1472 list_for_each_entry(evt, &efi_events, link) {
1473 if (evt->group && !guidcmp(evt->group, guid)) {
1474 efi_signal_event(evt, false);
1475 break;
1476 }
1477 }
1478
Alexander Graf488bf122016-08-19 01:23:24 +02001479 return EFI_SUCCESS;
1480}
1481
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001482/**
Mario Six78a88f72018-07-10 08:40:17 +02001483 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1484 * configuration table.
1485 * @guid: GUID of the installed table
1486 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001487 *
1488 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001489 *
Mario Six78a88f72018-07-10 08:40:17 +02001490 * See the Unified Extensible Firmware Interface (UEFI) specification for
1491 * details.
1492 *
1493 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001494 */
Alexander Graf488bf122016-08-19 01:23:24 +02001495static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1496 void *table)
1497{
Rob Clark778e6af2017-09-13 18:05:41 -04001498 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Graf488bf122016-08-19 01:23:24 +02001499 return EFI_EXIT(efi_install_configuration_table(guid, table));
Alexander Grafbee91162016-03-04 01:09:59 +01001500}
1501
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001502/**
Mario Six78a88f72018-07-10 08:40:17 +02001503 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001504 *
1505 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clark95c55532017-09-13 18:05:33 -04001506 * protocols, boot-device, etc.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001507 *
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001508 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1509 * code is returned.
1510 *
1511 * @device_path: device path of the loaded image
1512 * @file_path: file path of the loaded image
1513 * @handle_ptr: handle of the loaded image
1514 * @info_ptr: loaded image protocol
1515 * Return: status code
Rob Clark95c55532017-09-13 18:05:33 -04001516 */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001517efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1518 struct efi_device_path *file_path,
1519 struct efi_loaded_image_obj **handle_ptr,
1520 struct efi_loaded_image **info_ptr)
Rob Clark95c55532017-09-13 18:05:33 -04001521{
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001522 efi_status_t ret;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001523 struct efi_loaded_image *info = NULL;
1524 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001525 struct efi_device_path *dp;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001526
1527 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1528 *handle_ptr = NULL;
1529 *info_ptr = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001530
1531 info = calloc(1, sizeof(*info));
1532 if (!info)
1533 return EFI_OUT_OF_RESOURCES;
1534 obj = calloc(1, sizeof(*obj));
1535 if (!obj) {
1536 free(info);
1537 return EFI_OUT_OF_RESOURCES;
1538 }
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001539
Heinrich Schuchardt44549d62017-11-26 14:05:23 +01001540 /* Add internal object to object list */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001541 efi_add_handle(&obj->header);
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001542
Heinrich Schuchardt95147312018-07-05 08:17:58 +02001543 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Rob Clark95c55532017-09-13 18:05:33 -04001544 info->file_path = file_path;
Heinrich Schuchardt7e1effc2018-08-26 15:31:52 +02001545 info->system_table = &systab;
Rob Clark95c55532017-09-13 18:05:33 -04001546
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001547 if (device_path) {
1548 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001549
1550 dp = efi_dp_append(device_path, file_path);
1551 if (!dp) {
1552 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001553 goto failure;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001554 }
1555 } else {
1556 dp = NULL;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001557 }
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001558 ret = efi_add_protocol(&obj->header,
1559 &efi_guid_loaded_image_device_path, dp);
1560 if (ret != EFI_SUCCESS)
1561 goto failure;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001562
1563 /*
1564 * When asking for the loaded_image interface, just
1565 * return handle which points to loaded_image_info
1566 */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001567 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001568 &efi_guid_loaded_image, info);
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001569 if (ret != EFI_SUCCESS)
1570 goto failure;
1571
Heinrich Schuchardtd5974af2019-03-19 18:58:58 +01001572 *info_ptr = info;
1573 *handle_ptr = obj;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001574
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001575 return ret;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001576failure:
1577 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001578 efi_delete_handle(&obj->header);
1579 free(info);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001580 return ret;
Rob Clark95c55532017-09-13 18:05:33 -04001581}
1582
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001583/**
Mario Six78a88f72018-07-10 08:40:17 +02001584 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001585 *
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001586 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1587 * callers obligation to update the memory type as needed.
1588 *
1589 * @file_path: the path of the image to load
1590 * @buffer: buffer containing the loaded image
1591 * @size: size of the loaded image
1592 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001593 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09001594static
Rob Clark9975fe92017-09-13 18:05:38 -04001595efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001596 void **buffer, efi_uintn_t *size)
Rob Clark838ee4b2017-09-13 18:05:35 -04001597{
1598 struct efi_file_info *info = NULL;
1599 struct efi_file_handle *f;
1600 static efi_status_t ret;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001601 u64 addr;
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001602 efi_uintn_t bs;
Rob Clark838ee4b2017-09-13 18:05:35 -04001603
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001604 /* In case of failure nothing is returned */
1605 *buffer = NULL;
1606 *size = 0;
1607
1608 /* Open file */
Rob Clark838ee4b2017-09-13 18:05:35 -04001609 f = efi_file_from_path(file_path);
1610 if (!f)
1611 return EFI_DEVICE_ERROR;
1612
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001613 /* Get file size */
Rob Clark838ee4b2017-09-13 18:05:35 -04001614 bs = 0;
1615 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1616 &bs, info));
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001617 if (ret != EFI_BUFFER_TOO_SMALL) {
1618 ret = EFI_DEVICE_ERROR;
1619 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001620 }
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001621
1622 info = malloc(bs);
1623 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1624 info));
Rob Clark838ee4b2017-09-13 18:05:35 -04001625 if (ret != EFI_SUCCESS)
1626 goto error;
1627
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001628 /*
1629 * When reading the file we do not yet know if it contains an
1630 * application, a boottime driver, or a runtime driver. So here we
1631 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1632 * update the reservation according to the image type.
1633 */
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001634 bs = info->file_size;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001635 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1636 EFI_BOOT_SERVICES_DATA,
1637 efi_size_in_pages(bs), &addr);
Rob Clark838ee4b2017-09-13 18:05:35 -04001638 if (ret != EFI_SUCCESS) {
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001639 ret = EFI_OUT_OF_RESOURCES;
1640 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001641 }
1642
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001643 /* Read file */
1644 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1645 if (ret != EFI_SUCCESS)
1646 efi_free_pages(addr, efi_size_in_pages(bs));
1647 *buffer = (void *)(uintptr_t)addr;
1648 *size = bs;
1649error:
1650 EFI_CALL(f->close(f));
1651 free(info);
Rob Clark838ee4b2017-09-13 18:05:35 -04001652 return ret;
1653}
1654
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001655/**
Mario Six78a88f72018-07-10 08:40:17 +02001656 * efi_load_image() - load an EFI image into memory
1657 * @boot_policy: true for request originating from the boot manager
1658 * @parent_image: the caller's image handle
1659 * @file_path: the path of the image to load
1660 * @source_buffer: memory location from which the image is installed
1661 * @source_size: size of the memory area from which the image is installed
1662 * @image_handle: handle for the newly installed image
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001663 *
1664 * This function implements the LoadImage service.
Mario Six78a88f72018-07-10 08:40:17 +02001665 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001666 * See the Unified Extensible Firmware Interface (UEFI) specification
1667 * for details.
1668 *
Mario Six78a88f72018-07-10 08:40:17 +02001669 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001670 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09001671efi_status_t EFIAPI efi_load_image(bool boot_policy,
1672 efi_handle_t parent_image,
1673 struct efi_device_path *file_path,
1674 void *source_buffer,
1675 efi_uintn_t source_size,
1676 efi_handle_t *image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001677{
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001678 struct efi_device_path *dp, *fp;
Tom Rini1c3b2f42018-09-30 10:38:15 -04001679 struct efi_loaded_image *info = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001680 struct efi_loaded_image_obj **image_obj =
1681 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001682 efi_status_t ret;
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001683 void *dest_buffer;
Alexander Grafbee91162016-03-04 01:09:59 +01001684
Heinrich Schuchardt7fb96a12018-04-03 22:29:30 +02001685 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafbee91162016-03-04 01:09:59 +01001686 file_path, source_buffer, source_size, image_handle);
Rob Clark838ee4b2017-09-13 18:05:35 -04001687
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001688 if (!image_handle || !parent_image) {
1689 ret = EFI_INVALID_PARAMETER;
1690 goto error;
1691 }
1692
1693 if (!source_buffer && !file_path) {
1694 ret = EFI_NOT_FOUND;
1695 goto error;
1696 }
1697
Rob Clark838ee4b2017-09-13 18:05:35 -04001698 if (!source_buffer) {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001699 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001700 &source_size);
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001701 if (ret != EFI_SUCCESS)
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001702 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001703 } else {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001704 dest_buffer = source_buffer;
Rob Clark838ee4b2017-09-13 18:05:35 -04001705 }
Heinrich Schuchardt1e15a9c2019-04-20 19:24:43 +00001706 /* split file_path which contains both the device and file parts */
1707 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001708 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001709 if (ret == EFI_SUCCESS)
1710 ret = efi_load_pe(*image_obj, dest_buffer, info);
1711 if (!source_buffer)
1712 /* Release buffer to which file was loaded */
1713 efi_free_pages((uintptr_t)dest_buffer,
1714 efi_size_in_pages(source_size));
1715 if (ret == EFI_SUCCESS) {
1716 info->system_table = &systab;
1717 info->parent_handle = parent_image;
1718 } else {
1719 /* The image is invalid. Release all associated resources. */
1720 efi_delete_handle(*image_handle);
1721 *image_handle = NULL;
1722 free(info);
1723 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001724error:
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001725 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001726}
1727
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001728/**
Mario Six78a88f72018-07-10 08:40:17 +02001729 * efi_unload_image() - unload an EFI image
1730 * @image_handle: handle of the image to be unloaded
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001731 *
1732 * This function implements the UnloadImage service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001733 *
Mario Six78a88f72018-07-10 08:40:17 +02001734 * See the Unified Extensible Firmware Interface (UEFI) specification for
1735 * details.
1736 *
1737 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001738 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09001739efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001740{
1741 struct efi_object *efiobj;
1742
1743 EFI_ENTRY("%p", image_handle);
1744 efiobj = efi_search_obj(image_handle);
1745 if (efiobj)
1746 list_del(&efiobj->link);
1747
1748 return EFI_EXIT(EFI_SUCCESS);
1749}
1750
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001751/**
Alexander Graff31239a2018-11-15 21:23:47 +01001752 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1753 */
1754static void efi_exit_caches(void)
1755{
1756#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1757 /*
1758 * Grub on 32bit ARM needs to have caches disabled before jumping into
1759 * a zImage, but does not know of all cache layers. Give it a hand.
1760 */
1761 if (efi_is_direct_boot)
1762 cleanup_before_linux();
1763#endif
1764}
1765
1766/**
Mario Six78a88f72018-07-10 08:40:17 +02001767 * efi_exit_boot_services() - stop all boot services
1768 * @image_handle: handle of the loaded image
1769 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001770 *
1771 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02001772 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001773 * See the Unified Extensible Firmware Interface (UEFI) specification
1774 * for details.
1775 *
Mario Six78a88f72018-07-10 08:40:17 +02001776 * All timer events are disabled. For exit boot services events the
1777 * notification function is called. The boot services are disabled in the
1778 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001779 *
Mario Six78a88f72018-07-10 08:40:17 +02001780 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001781 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001782static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01001783 unsigned long map_key)
1784{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001785 struct efi_event *evt;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001786
Alexander Grafbee91162016-03-04 01:09:59 +01001787 EFI_ENTRY("%p, %ld", image_handle, map_key);
1788
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001789 /* Check that the caller has read the current memory map */
1790 if (map_key != efi_memory_map_key)
1791 return EFI_INVALID_PARAMETER;
1792
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001793 /* Make sure that notification functions are not called anymore */
1794 efi_tpl = TPL_HIGH_LEVEL;
1795
1796 /* Check if ExitBootServices has already been called */
1797 if (!systab.boottime)
1798 return EFI_EXIT(EFI_SUCCESS);
1799
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001800 /* Add related events to the event group */
1801 list_for_each_entry(evt, &efi_events, link) {
1802 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1803 evt->group = &efi_guid_event_group_exit_boot_services;
1804 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001805 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001806 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001807 if (evt->group &&
1808 !guidcmp(evt->group,
1809 &efi_guid_event_group_exit_boot_services)) {
1810 efi_signal_event(evt, false);
1811 break;
1812 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001813 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001814
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001815 /* TODO: Should persist EFI variables here */
Rob Clarkad644e72017-09-13 18:05:37 -04001816
Alexander Grafb7b84102016-11-17 01:02:57 +01001817 board_quiesce_devices();
1818
Alexander Graff31239a2018-11-15 21:23:47 +01001819 /* Fix up caches for EFI payloads if necessary */
1820 efi_exit_caches();
1821
Alexander Grafbee91162016-03-04 01:09:59 +01001822 /* This stops all lingering devices */
1823 bootm_disable_interrupts();
1824
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001825 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001826 systab.con_in_handle = NULL;
1827 systab.con_in = NULL;
1828 systab.con_out_handle = NULL;
1829 systab.con_out = NULL;
1830 systab.stderr_handle = NULL;
1831 systab.std_err = NULL;
1832 systab.boottime = NULL;
1833
1834 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02001835 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001836
Alexander Grafbee91162016-03-04 01:09:59 +01001837 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001838 efi_set_watchdog(0);
Alexander Grafbee91162016-03-04 01:09:59 +01001839 WATCHDOG_RESET();
1840
1841 return EFI_EXIT(EFI_SUCCESS);
1842}
1843
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001844/**
Mario Six78a88f72018-07-10 08:40:17 +02001845 * efi_get_next_monotonic_count() - get next value of the counter
1846 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001847 *
1848 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001849 *
Mario Six78a88f72018-07-10 08:40:17 +02001850 * See the Unified Extensible Firmware Interface (UEFI) specification for
1851 * details.
1852 *
1853 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001854 */
Alexander Grafbee91162016-03-04 01:09:59 +01001855static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1856{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001857 static uint64_t mono;
1858
Alexander Grafbee91162016-03-04 01:09:59 +01001859 EFI_ENTRY("%p", count);
1860 *count = mono++;
1861 return EFI_EXIT(EFI_SUCCESS);
1862}
1863
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001864/**
Mario Six78a88f72018-07-10 08:40:17 +02001865 * efi_stall() - sleep
1866 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001867 *
Mario Six78a88f72018-07-10 08:40:17 +02001868 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001869 *
Mario Six78a88f72018-07-10 08:40:17 +02001870 * See the Unified Extensible Firmware Interface (UEFI) specification for
1871 * details.
1872 *
1873 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001874 */
Alexander Grafbee91162016-03-04 01:09:59 +01001875static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1876{
1877 EFI_ENTRY("%ld", microseconds);
1878 udelay(microseconds);
1879 return EFI_EXIT(EFI_SUCCESS);
1880}
1881
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001882/**
Mario Six78a88f72018-07-10 08:40:17 +02001883 * efi_set_watchdog_timer() - reset the watchdog timer
1884 * @timeout: seconds before reset by watchdog
1885 * @watchdog_code: code to be logged when resetting
1886 * @data_size: size of buffer in bytes
1887 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001888 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001889 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001890 *
Mario Six78a88f72018-07-10 08:40:17 +02001891 * See the Unified Extensible Firmware Interface (UEFI) specification for
1892 * details.
1893 *
1894 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001895 */
Alexander Grafbee91162016-03-04 01:09:59 +01001896static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1897 uint64_t watchdog_code,
1898 unsigned long data_size,
1899 uint16_t *watchdog_data)
1900{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09001901 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01001902 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001903 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01001904}
1905
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001906/**
Mario Six78a88f72018-07-10 08:40:17 +02001907 * efi_close_protocol() - close a protocol
1908 * @handle: handle on which the protocol shall be closed
1909 * @protocol: GUID of the protocol to close
1910 * @agent_handle: handle of the driver
1911 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001912 *
1913 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001914 *
Mario Six78a88f72018-07-10 08:40:17 +02001915 * See the Unified Extensible Firmware Interface (UEFI) specification for
1916 * details.
1917 *
1918 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001919 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001920static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001921 const efi_guid_t *protocol,
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001922 efi_handle_t agent_handle,
1923 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001924{
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001925 struct efi_handler *handler;
1926 struct efi_open_protocol_info_item *item;
1927 struct efi_open_protocol_info_item *pos;
1928 efi_status_t r;
1929
Rob Clark778e6af2017-09-13 18:05:41 -04001930 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01001931 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001932
1933 if (!agent_handle) {
1934 r = EFI_INVALID_PARAMETER;
1935 goto out;
1936 }
1937 r = efi_search_protocol(handle, protocol, &handler);
1938 if (r != EFI_SUCCESS)
1939 goto out;
1940
1941 r = EFI_NOT_FOUND;
1942 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1943 if (item->info.agent_handle == agent_handle &&
1944 item->info.controller_handle == controller_handle) {
1945 efi_delete_open_info(item);
1946 r = EFI_SUCCESS;
1947 break;
1948 }
1949 }
1950out:
1951 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001952}
1953
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001954/**
Mario Six78a88f72018-07-10 08:40:17 +02001955 * efi_open_protocol_information() - provide information about then open status
1956 * of a protocol on a handle
1957 * @handle: handle for which the information shall be retrieved
1958 * @protocol: GUID of the protocol
1959 * @entry_buffer: buffer to receive the open protocol information
1960 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001961 *
1962 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001963 *
Mario Six78a88f72018-07-10 08:40:17 +02001964 * See the Unified Extensible Firmware Interface (UEFI) specification for
1965 * details.
1966 *
1967 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001968 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001969static efi_status_t EFIAPI efi_open_protocol_information(
1970 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01001971 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001972 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01001973{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01001974 unsigned long buffer_size;
1975 unsigned long count;
1976 struct efi_handler *handler;
1977 struct efi_open_protocol_info_item *item;
1978 efi_status_t r;
1979
Rob Clark778e6af2017-09-13 18:05:41 -04001980 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01001981 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01001982
1983 /* Check parameters */
1984 if (!entry_buffer) {
1985 r = EFI_INVALID_PARAMETER;
1986 goto out;
1987 }
1988 r = efi_search_protocol(handle, protocol, &handler);
1989 if (r != EFI_SUCCESS)
1990 goto out;
1991
1992 /* Count entries */
1993 count = 0;
1994 list_for_each_entry(item, &handler->open_infos, link) {
1995 if (item->info.open_count)
1996 ++count;
1997 }
1998 *entry_count = count;
1999 *entry_buffer = NULL;
2000 if (!count) {
2001 r = EFI_SUCCESS;
2002 goto out;
2003 }
2004
2005 /* Copy entries */
2006 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002007 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002008 (void **)entry_buffer);
2009 if (r != EFI_SUCCESS)
2010 goto out;
2011 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2012 if (item->info.open_count)
2013 (*entry_buffer)[--count] = item->info;
2014 }
2015out:
2016 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002017}
2018
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002019/**
Mario Six78a88f72018-07-10 08:40:17 +02002020 * efi_protocols_per_handle() - get protocols installed on a handle
2021 * @handle: handle for which the information is retrieved
2022 * @protocol_buffer: buffer with protocol GUIDs
2023 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002024 *
2025 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002026 *
Mario Six78a88f72018-07-10 08:40:17 +02002027 * See the Unified Extensible Firmware Interface (UEFI) specification for
2028 * details.
2029 *
2030 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002031 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002032static efi_status_t EFIAPI efi_protocols_per_handle(
2033 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002034 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002035{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002036 unsigned long buffer_size;
2037 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002038 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002039 efi_status_t r;
2040
Alexander Grafbee91162016-03-04 01:09:59 +01002041 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2042 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002043
2044 if (!handle || !protocol_buffer || !protocol_buffer_count)
2045 return EFI_EXIT(EFI_INVALID_PARAMETER);
2046
2047 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002048 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002049
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002050 efiobj = efi_search_obj(handle);
2051 if (!efiobj)
2052 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002053
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002054 /* Count protocols */
2055 list_for_each(protocol_handle, &efiobj->protocols) {
2056 ++*protocol_buffer_count;
2057 }
2058
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002059 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002060 if (*protocol_buffer_count) {
2061 size_t j = 0;
2062
2063 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002064 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002065 (void **)protocol_buffer);
2066 if (r != EFI_SUCCESS)
2067 return EFI_EXIT(r);
2068 list_for_each(protocol_handle, &efiobj->protocols) {
2069 struct efi_handler *protocol;
2070
2071 protocol = list_entry(protocol_handle,
2072 struct efi_handler, link);
2073 (*protocol_buffer)[j] = (void *)protocol->guid;
2074 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002075 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002076 }
2077
2078 return EFI_EXIT(EFI_SUCCESS);
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_locate_handle_buffer() - locate handles implementing a protocol
2083 * @search_type: selection criterion
2084 * @protocol: GUID of the protocol
2085 * @search_key: registration key
2086 * @no_handles: number of returned handles
2087 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002088 *
2089 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002090 *
Mario Six78a88f72018-07-10 08:40:17 +02002091 * See the Unified Extensible Firmware Interface (UEFI) specification for
2092 * details.
2093 *
2094 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002095 */
Alexander Grafbee91162016-03-04 01:09:59 +01002096static efi_status_t EFIAPI efi_locate_handle_buffer(
2097 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002098 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002099 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002100{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002101 efi_status_t r;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002102 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002103
Rob Clark778e6af2017-09-13 18:05:41 -04002104 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002105 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002106
2107 if (!no_handles || !buffer) {
2108 r = EFI_INVALID_PARAMETER;
2109 goto out;
2110 }
2111 *no_handles = 0;
2112 *buffer = NULL;
2113 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2114 *buffer);
2115 if (r != EFI_BUFFER_TOO_SMALL)
2116 goto out;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002117 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002118 (void **)buffer);
2119 if (r != EFI_SUCCESS)
2120 goto out;
2121 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2122 *buffer);
2123 if (r == EFI_SUCCESS)
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002124 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002125out:
2126 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002127}
2128
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002129/**
Mario Six78a88f72018-07-10 08:40:17 +02002130 * efi_locate_protocol() - find an interface implementing a protocol
2131 * @protocol: GUID of the protocol
2132 * @registration: registration key passed to the notification function
2133 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002134 *
2135 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002136 *
Mario Six78a88f72018-07-10 08:40:17 +02002137 * See the Unified Extensible Firmware Interface (UEFI) specification for
2138 * details.
2139 *
2140 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002141 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002142static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002143 void *registration,
2144 void **protocol_interface)
2145{
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002146 struct list_head *lhandle;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002147 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01002148
Rob Clark778e6af2017-09-13 18:05:41 -04002149 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002150
2151 if (!protocol || !protocol_interface)
2152 return EFI_EXIT(EFI_INVALID_PARAMETER);
2153
2154 list_for_each(lhandle, &efi_obj_list) {
2155 struct efi_object *efiobj;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002156 struct efi_handler *handler;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002157
2158 efiobj = list_entry(lhandle, struct efi_object, link);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002159
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002160 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002161 if (ret == EFI_SUCCESS) {
2162 *protocol_interface = handler->protocol_interface;
2163 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002164 }
2165 }
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002166 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002167
2168 return EFI_EXIT(EFI_NOT_FOUND);
2169}
2170
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002171/**
Mario Six78a88f72018-07-10 08:40:17 +02002172 * efi_locate_device_path() - Get the device path and handle of an device
2173 * implementing a protocol
2174 * @protocol: GUID of the protocol
2175 * @device_path: device path
2176 * @device: handle of the device
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002177 *
2178 * This function implements the LocateDevicePath service.
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002179 *
Mario Six78a88f72018-07-10 08:40:17 +02002180 * See the Unified Extensible Firmware Interface (UEFI) specification for
2181 * details.
2182 *
2183 * Return: status code
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002184 */
2185static efi_status_t EFIAPI efi_locate_device_path(
2186 const efi_guid_t *protocol,
2187 struct efi_device_path **device_path,
2188 efi_handle_t *device)
2189{
2190 struct efi_device_path *dp;
2191 size_t i;
2192 struct efi_handler *handler;
2193 efi_handle_t *handles;
2194 size_t len, len_dp;
2195 size_t len_best = 0;
2196 efi_uintn_t no_handles;
2197 u8 *remainder;
2198 efi_status_t ret;
2199
2200 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2201
2202 if (!protocol || !device_path || !*device_path || !device) {
2203 ret = EFI_INVALID_PARAMETER;
2204 goto out;
2205 }
2206
2207 /* Find end of device path */
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002208 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002209
2210 /* Get all handles implementing the protocol */
2211 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2212 &no_handles, &handles));
2213 if (ret != EFI_SUCCESS)
2214 goto out;
2215
2216 for (i = 0; i < no_handles; ++i) {
2217 /* Find the device path protocol */
2218 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2219 &handler);
2220 if (ret != EFI_SUCCESS)
2221 continue;
2222 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002223 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002224 /*
2225 * This handle can only be a better fit
2226 * if its device path length is longer than the best fit and
2227 * if its device path length is shorter of equal the searched
2228 * device path.
2229 */
2230 if (len_dp <= len_best || len_dp > len)
2231 continue;
2232 /* Check if dp is a subpath of device_path */
2233 if (memcmp(*device_path, dp, len_dp))
2234 continue;
2235 *device = handles[i];
2236 len_best = len_dp;
2237 }
2238 if (len_best) {
2239 remainder = (u8 *)*device_path + len_best;
2240 *device_path = (struct efi_device_path *)remainder;
2241 ret = EFI_SUCCESS;
2242 } else {
2243 ret = EFI_NOT_FOUND;
2244 }
2245out:
2246 return EFI_EXIT(ret);
2247}
2248
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002249/**
Mario Six78a88f72018-07-10 08:40:17 +02002250 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2251 * interfaces
2252 * @handle: handle on which the protocol interfaces shall be installed
2253 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2254 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002255 *
2256 * This function implements the MultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002257 *
Mario Six78a88f72018-07-10 08:40:17 +02002258 * See the Unified Extensible Firmware Interface (UEFI) specification for
2259 * details.
2260 *
2261 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002262 */
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +02002263efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002264 (efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002265{
2266 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002267
Alexander Grafbeb077a2018-06-18 17:23:05 +02002268 efi_va_list argptr;
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002269 const efi_guid_t *protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002270 void *protocol_interface;
2271 efi_status_t r = EFI_SUCCESS;
2272 int i = 0;
2273
2274 if (!handle)
2275 return EFI_EXIT(EFI_INVALID_PARAMETER);
2276
Alexander Grafbeb077a2018-06-18 17:23:05 +02002277 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002278 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002279 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002280 if (!protocol)
2281 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002282 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01002283 r = EFI_CALL(efi_install_protocol_interface(
2284 handle, protocol,
2285 EFI_NATIVE_INTERFACE,
2286 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002287 if (r != EFI_SUCCESS)
2288 break;
2289 i++;
2290 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002291 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002292 if (r == EFI_SUCCESS)
2293 return EFI_EXIT(r);
2294
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002295 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002296 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002297 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002298 protocol = efi_va_arg(argptr, efi_guid_t*);
2299 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002300 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01002301 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002302 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002303 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002304
2305 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002306}
2307
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002308/**
Mario Six78a88f72018-07-10 08:40:17 +02002309 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2310 * interfaces
2311 * @handle: handle from which the protocol interfaces shall be removed
2312 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2313 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002314 *
2315 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002316 *
Mario Six78a88f72018-07-10 08:40:17 +02002317 * See the Unified Extensible Firmware Interface (UEFI) specification for
2318 * details.
2319 *
2320 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002321 */
Alexander Grafbee91162016-03-04 01:09:59 +01002322static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002323 efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002324{
2325 EFI_ENTRY("%p", handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002326
Alexander Grafbeb077a2018-06-18 17:23:05 +02002327 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002328 const efi_guid_t *protocol;
2329 void *protocol_interface;
2330 efi_status_t r = EFI_SUCCESS;
2331 size_t i = 0;
2332
2333 if (!handle)
2334 return EFI_EXIT(EFI_INVALID_PARAMETER);
2335
Alexander Grafbeb077a2018-06-18 17:23:05 +02002336 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002337 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002338 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002339 if (!protocol)
2340 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002341 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002342 r = efi_uninstall_protocol(handle, protocol,
2343 protocol_interface);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002344 if (r != EFI_SUCCESS)
2345 break;
2346 i++;
2347 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002348 efi_va_end(argptr);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002349 if (r == EFI_SUCCESS) {
2350 /* If the last protocol has been removed, delete the handle. */
2351 if (list_empty(&handle->protocols)) {
2352 list_del(&handle->link);
2353 free(handle);
2354 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002355 return EFI_EXIT(r);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002356 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002357
2358 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002359 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002360 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002361 protocol = efi_va_arg(argptr, efi_guid_t*);
2362 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002363 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2364 EFI_NATIVE_INTERFACE,
2365 protocol_interface));
2366 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002367 efi_va_end(argptr);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002368
Heinrich Schuchardte2373022018-09-24 19:57:27 +02002369 /* In case of an error always return EFI_INVALID_PARAMETER */
2370 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafbee91162016-03-04 01:09:59 +01002371}
2372
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002373/**
Mario Six78a88f72018-07-10 08:40:17 +02002374 * efi_calculate_crc32() - calculate cyclic redundancy code
2375 * @data: buffer with data
2376 * @data_size: size of buffer in bytes
2377 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002378 *
2379 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002380 *
Mario Six78a88f72018-07-10 08:40:17 +02002381 * See the Unified Extensible Firmware Interface (UEFI) specification for
2382 * details.
2383 *
2384 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002385 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002386static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2387 efi_uintn_t data_size,
2388 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002389{
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002390 EFI_ENTRY("%p, %zu", data, data_size);
Alexander Grafbee91162016-03-04 01:09:59 +01002391 *crc32_p = crc32(0, data, data_size);
2392 return EFI_EXIT(EFI_SUCCESS);
2393}
2394
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002395/**
Mario Six78a88f72018-07-10 08:40:17 +02002396 * efi_copy_mem() - copy memory
2397 * @destination: destination of the copy operation
2398 * @source: source of the copy operation
2399 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002400 *
2401 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002402 *
Mario Six78a88f72018-07-10 08:40:17 +02002403 * See the Unified Extensible Firmware Interface (UEFI) specification for
2404 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002405 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002406static void EFIAPI efi_copy_mem(void *destination, const void *source,
2407 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002408{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002409 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002410 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002411 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002412}
2413
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002414/**
Mario Six78a88f72018-07-10 08:40:17 +02002415 * efi_set_mem() - Fill memory with a byte value.
2416 * @buffer: buffer to fill
2417 * @size: size of buffer in bytes
2418 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002419 *
2420 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002421 *
Mario Six78a88f72018-07-10 08:40:17 +02002422 * See the Unified Extensible Firmware Interface (UEFI) specification for
2423 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002424 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002425static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002426{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002427 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002428 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002429 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002430}
2431
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002432/**
Mario Six78a88f72018-07-10 08:40:17 +02002433 * efi_protocol_open() - open protocol interface on a handle
2434 * @handler: handler of a protocol
2435 * @protocol_interface: interface implementing the protocol
2436 * @agent_handle: handle of the driver
2437 * @controller_handle: handle of the controller
2438 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002439 *
Mario Six78a88f72018-07-10 08:40:17 +02002440 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002441 */
2442static efi_status_t efi_protocol_open(
2443 struct efi_handler *handler,
2444 void **protocol_interface, void *agent_handle,
2445 void *controller_handle, uint32_t attributes)
2446{
2447 struct efi_open_protocol_info_item *item;
2448 struct efi_open_protocol_info_entry *match = NULL;
2449 bool opened_by_driver = false;
2450 bool opened_exclusive = false;
2451
2452 /* If there is no agent, only return the interface */
2453 if (!agent_handle)
2454 goto out;
2455
2456 /* For TEST_PROTOCOL ignore interface attribute */
2457 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2458 *protocol_interface = NULL;
2459
2460 /*
2461 * Check if the protocol is already opened by a driver with the same
2462 * attributes or opened exclusively
2463 */
2464 list_for_each_entry(item, &handler->open_infos, link) {
2465 if (item->info.agent_handle == agent_handle) {
2466 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2467 (item->info.attributes == attributes))
2468 return EFI_ALREADY_STARTED;
2469 }
2470 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2471 opened_exclusive = true;
2472 }
2473
2474 /* Only one controller can open the protocol exclusively */
2475 if (opened_exclusive && attributes &
2476 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2477 return EFI_ACCESS_DENIED;
2478
2479 /* Prepare exclusive opening */
2480 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2481 /* Try to disconnect controllers */
2482 list_for_each_entry(item, &handler->open_infos, link) {
2483 if (item->info.attributes ==
2484 EFI_OPEN_PROTOCOL_BY_DRIVER)
2485 EFI_CALL(efi_disconnect_controller(
2486 item->info.controller_handle,
2487 item->info.agent_handle,
2488 NULL));
2489 }
2490 opened_by_driver = false;
2491 /* Check if all controllers are disconnected */
2492 list_for_each_entry(item, &handler->open_infos, link) {
2493 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2494 opened_by_driver = true;
2495 }
Heinrich Schuchardt4f37fa42018-09-30 13:40:43 +02002496 /* Only one controller can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002497 if (opened_by_driver)
2498 return EFI_ACCESS_DENIED;
2499 }
2500
2501 /* Find existing entry */
2502 list_for_each_entry(item, &handler->open_infos, link) {
2503 if (item->info.agent_handle == agent_handle &&
2504 item->info.controller_handle == controller_handle)
2505 match = &item->info;
2506 }
2507 /* None found, create one */
2508 if (!match) {
2509 match = efi_create_open_info(handler);
2510 if (!match)
2511 return EFI_OUT_OF_RESOURCES;
2512 }
2513
2514 match->agent_handle = agent_handle;
2515 match->controller_handle = controller_handle;
2516 match->attributes = attributes;
2517 match->open_count++;
2518
2519out:
2520 /* For TEST_PROTOCOL ignore interface attribute. */
2521 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2522 *protocol_interface = handler->protocol_interface;
2523
2524 return EFI_SUCCESS;
2525}
2526
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002527/**
Mario Six78a88f72018-07-10 08:40:17 +02002528 * efi_open_protocol() - open protocol interface on a handle
2529 * @handle: handle on which the protocol shall be opened
2530 * @protocol: GUID of the protocol
2531 * @protocol_interface: interface implementing the protocol
2532 * @agent_handle: handle of the driver
2533 * @controller_handle: handle of the controller
2534 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002535 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002536 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002537 *
Mario Six78a88f72018-07-10 08:40:17 +02002538 * See the Unified Extensible Firmware Interface (UEFI) specification for
2539 * details.
2540 *
2541 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002542 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002543static efi_status_t EFIAPI efi_open_protocol
2544 (efi_handle_t handle, const efi_guid_t *protocol,
2545 void **protocol_interface, efi_handle_t agent_handle,
2546 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01002547{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002548 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002549 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01002550
Rob Clark778e6af2017-09-13 18:05:41 -04002551 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002552 protocol_interface, agent_handle, controller_handle,
2553 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002554
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002555 if (!handle || !protocol ||
2556 (!protocol_interface && attributes !=
2557 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2558 goto out;
2559 }
2560
2561 switch (attributes) {
2562 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2563 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2564 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2565 break;
2566 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2567 if (controller_handle == handle)
2568 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002569 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002570 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2571 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002572 /* Check that the controller handle is valid */
2573 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002574 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002575 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002576 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002577 /* Check that the agent handle is valid */
2578 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002579 goto out;
2580 break;
2581 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002582 goto out;
2583 }
2584
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002585 r = efi_search_protocol(handle, protocol, &handler);
2586 if (r != EFI_SUCCESS)
2587 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01002588
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002589 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2590 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01002591out:
2592 return EFI_EXIT(r);
2593}
2594
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002595/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002596 * efi_start_image() - call the entry point of an image
2597 * @image_handle: handle of the image
2598 * @exit_data_size: size of the buffer
2599 * @exit_data: buffer to receive the exit data of the called image
2600 *
2601 * This function implements the StartImage service.
2602 *
2603 * See the Unified Extensible Firmware Interface (UEFI) specification for
2604 * details.
2605 *
2606 * Return: status code
2607 */
2608efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2609 efi_uintn_t *exit_data_size,
2610 u16 **exit_data)
2611{
2612 struct efi_loaded_image_obj *image_obj =
2613 (struct efi_loaded_image_obj *)image_handle;
2614 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002615 void *info;
2616 efi_handle_t parent_image = current_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002617
2618 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2619
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002620 /* Check parameters */
2621 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2622 &info, NULL, NULL,
2623 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2624 if (ret != EFI_SUCCESS)
2625 return EFI_EXIT(EFI_INVALID_PARAMETER);
2626
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002627 efi_is_direct_boot = false;
2628
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002629 image_obj->exit_data_size = exit_data_size;
2630 image_obj->exit_data = exit_data;
2631
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002632 /* call the image! */
2633 if (setjmp(&image_obj->exit_jmp)) {
2634 /*
2635 * We called the entry point of the child image with EFI_CALL
2636 * in the lines below. The child image called the Exit() boot
2637 * service efi_exit() which executed the long jump that brought
2638 * us to the current line. This implies that the second half
2639 * of the EFI_CALL macro has not been executed.
2640 */
2641#ifdef CONFIG_ARM
2642 /*
2643 * efi_exit() called efi_restore_gd(). We have to undo this
2644 * otherwise __efi_entry_check() will put the wrong value into
2645 * app_gd.
2646 */
2647 gd = app_gd;
2648#endif
2649 /*
2650 * To get ready to call EFI_EXIT below we have to execute the
2651 * missed out steps of EFI_CALL.
2652 */
2653 assert(__efi_entry_check());
2654 debug("%sEFI: %lu returned by started image\n",
2655 __efi_nesting_dec(),
2656 (unsigned long)((uintptr_t)image_obj->exit_status &
2657 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002658 current_image = parent_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002659 return EFI_EXIT(image_obj->exit_status);
2660 }
2661
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002662 current_image = image_handle;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09002663 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002664 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2665
2666 /*
2667 * Usually UEFI applications call Exit() instead of returning.
2668 * But because the world doesn't consist of ponies and unicorns,
2669 * we're happy to emulate that behavior on behalf of a payload
2670 * that forgot.
2671 */
2672 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2673}
2674
2675/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002676 * efi_update_exit_data() - fill exit data parameters of StartImage()
2677 *
2678 * @image_obj image handle
2679 * @exit_data_size size of the exit data buffer
2680 * @exit_data buffer with data returned by UEFI payload
2681 * Return: status code
2682 */
2683static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2684 efi_uintn_t exit_data_size,
2685 u16 *exit_data)
2686{
2687 efi_status_t ret;
2688
2689 /*
2690 * If exit_data is not provided to StartImage(), exit_data_size must be
2691 * ignored.
2692 */
2693 if (!image_obj->exit_data)
2694 return EFI_SUCCESS;
2695 if (image_obj->exit_data_size)
2696 *image_obj->exit_data_size = exit_data_size;
2697 if (exit_data_size && exit_data) {
2698 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2699 exit_data_size,
2700 (void **)image_obj->exit_data);
2701 if (ret != EFI_SUCCESS)
2702 return ret;
2703 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2704 } else {
2705 image_obj->exit_data = NULL;
2706 }
2707 return EFI_SUCCESS;
2708}
2709
2710/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002711 * efi_exit() - leave an EFI application or driver
2712 * @image_handle: handle of the application or driver that is exiting
2713 * @exit_status: status code
2714 * @exit_data_size: size of the buffer in bytes
2715 * @exit_data: buffer with data describing an error
2716 *
2717 * This function implements the Exit service.
2718 *
2719 * See the Unified Extensible Firmware Interface (UEFI) specification for
2720 * details.
2721 *
2722 * Return: status code
2723 */
2724static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2725 efi_status_t exit_status,
2726 efi_uintn_t exit_data_size,
2727 u16 *exit_data)
2728{
2729 /*
2730 * TODO: We should call the unload procedure of the loaded
2731 * image protocol.
2732 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002733 efi_status_t ret;
2734 void *info;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002735 struct efi_loaded_image_obj *image_obj =
2736 (struct efi_loaded_image_obj *)image_handle;
2737
2738 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2739 exit_data_size, exit_data);
2740
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002741 /* Check parameters */
2742 if (image_handle != current_image)
2743 goto out;
2744 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2745 &info, NULL, NULL,
2746 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2747 if (ret != EFI_SUCCESS)
2748 goto out;
2749
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002750 /* Exit data is only foreseen in case of failure. */
2751 if (exit_status != EFI_SUCCESS) {
2752 ret = efi_update_exit_data(image_obj, exit_data_size,
2753 exit_data);
2754 /* Exiting has priority. Don't return error to caller. */
2755 if (ret != EFI_SUCCESS)
2756 EFI_PRINT("%s: out of memory\n", __func__);
2757 }
2758
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002759 /* Make sure entry/exit counts for EFI world cross-overs match */
2760 EFI_EXIT(exit_status);
2761
2762 /*
2763 * But longjmp out with the U-Boot gd, not the application's, as
2764 * the other end is a setjmp call inside EFI context.
2765 */
2766 efi_restore_gd();
2767
2768 image_obj->exit_status = exit_status;
2769 longjmp(&image_obj->exit_jmp, 1);
2770
2771 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002772out:
2773 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002774}
2775
2776/**
Mario Six78a88f72018-07-10 08:40:17 +02002777 * efi_handle_protocol() - get interface of a protocol on a handle
2778 * @handle: handle on which the protocol shall be opened
2779 * @protocol: GUID of the protocol
2780 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002781 *
2782 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002783 *
Mario Six78a88f72018-07-10 08:40:17 +02002784 * See the Unified Extensible Firmware Interface (UEFI) specification for
2785 * details.
2786 *
2787 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002788 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002789static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002790 const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002791 void **protocol_interface)
2792{
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02002793 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2794 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01002795}
2796
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002797/**
Mario Six78a88f72018-07-10 08:40:17 +02002798 * efi_bind_controller() - bind a single driver to a controller
2799 * @controller_handle: controller handle
2800 * @driver_image_handle: driver handle
2801 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002802 *
Mario Six78a88f72018-07-10 08:40:17 +02002803 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002804 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002805static efi_status_t efi_bind_controller(
2806 efi_handle_t controller_handle,
2807 efi_handle_t driver_image_handle,
2808 struct efi_device_path *remain_device_path)
2809{
2810 struct efi_driver_binding_protocol *binding_protocol;
2811 efi_status_t r;
2812
2813 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2814 &efi_guid_driver_binding_protocol,
2815 (void **)&binding_protocol,
2816 driver_image_handle, NULL,
2817 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2818 if (r != EFI_SUCCESS)
2819 return r;
2820 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2821 controller_handle,
2822 remain_device_path));
2823 if (r == EFI_SUCCESS)
2824 r = EFI_CALL(binding_protocol->start(binding_protocol,
2825 controller_handle,
2826 remain_device_path));
2827 EFI_CALL(efi_close_protocol(driver_image_handle,
2828 &efi_guid_driver_binding_protocol,
2829 driver_image_handle, NULL));
2830 return r;
2831}
2832
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002833/**
Mario Six78a88f72018-07-10 08:40:17 +02002834 * efi_connect_single_controller() - connect a single driver to a controller
2835 * @controller_handle: controller
2836 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002837 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002838 *
Mario Six78a88f72018-07-10 08:40:17 +02002839 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002840 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002841static efi_status_t efi_connect_single_controller(
2842 efi_handle_t controller_handle,
2843 efi_handle_t *driver_image_handle,
2844 struct efi_device_path *remain_device_path)
2845{
2846 efi_handle_t *buffer;
2847 size_t count;
2848 size_t i;
2849 efi_status_t r;
2850 size_t connected = 0;
2851
2852 /* Get buffer with all handles with driver binding protocol */
2853 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2854 &efi_guid_driver_binding_protocol,
2855 NULL, &count, &buffer));
2856 if (r != EFI_SUCCESS)
2857 return r;
2858
2859 /* Context Override */
2860 if (driver_image_handle) {
2861 for (; *driver_image_handle; ++driver_image_handle) {
2862 for (i = 0; i < count; ++i) {
2863 if (buffer[i] == *driver_image_handle) {
2864 buffer[i] = NULL;
2865 r = efi_bind_controller(
2866 controller_handle,
2867 *driver_image_handle,
2868 remain_device_path);
2869 /*
2870 * For drivers that do not support the
2871 * controller or are already connected
2872 * we receive an error code here.
2873 */
2874 if (r == EFI_SUCCESS)
2875 ++connected;
2876 }
2877 }
2878 }
2879 }
2880
2881 /*
2882 * TODO: Some overrides are not yet implemented:
2883 * - Platform Driver Override
2884 * - Driver Family Override Search
2885 * - Bus Specific Driver Override
2886 */
2887
2888 /* Driver Binding Search */
2889 for (i = 0; i < count; ++i) {
2890 if (buffer[i]) {
2891 r = efi_bind_controller(controller_handle,
2892 buffer[i],
2893 remain_device_path);
2894 if (r == EFI_SUCCESS)
2895 ++connected;
2896 }
2897 }
2898
2899 efi_free_pool(buffer);
2900 if (!connected)
2901 return EFI_NOT_FOUND;
2902 return EFI_SUCCESS;
2903}
2904
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002905/**
Mario Six78a88f72018-07-10 08:40:17 +02002906 * efi_connect_controller() - connect a controller to a driver
2907 * @controller_handle: handle of the controller
2908 * @driver_image_handle: handle of the driver
2909 * @remain_device_path: device path of a child controller
2910 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002911 *
2912 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02002913 *
2914 * See the Unified Extensible Firmware Interface (UEFI) specification for
2915 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002916 *
2917 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002918 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002919 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2920 *
Mario Six78a88f72018-07-10 08:40:17 +02002921 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002922 */
2923static efi_status_t EFIAPI efi_connect_controller(
2924 efi_handle_t controller_handle,
2925 efi_handle_t *driver_image_handle,
2926 struct efi_device_path *remain_device_path,
2927 bool recursive)
2928{
2929 efi_status_t r;
2930 efi_status_t ret = EFI_NOT_FOUND;
2931 struct efi_object *efiobj;
2932
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01002933 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002934 remain_device_path, recursive);
2935
2936 efiobj = efi_search_obj(controller_handle);
2937 if (!efiobj) {
2938 ret = EFI_INVALID_PARAMETER;
2939 goto out;
2940 }
2941
2942 r = efi_connect_single_controller(controller_handle,
2943 driver_image_handle,
2944 remain_device_path);
2945 if (r == EFI_SUCCESS)
2946 ret = EFI_SUCCESS;
2947 if (recursive) {
2948 struct efi_handler *handler;
2949 struct efi_open_protocol_info_item *item;
2950
2951 list_for_each_entry(handler, &efiobj->protocols, link) {
2952 list_for_each_entry(item, &handler->open_infos, link) {
2953 if (item->info.attributes &
2954 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2955 r = EFI_CALL(efi_connect_controller(
2956 item->info.controller_handle,
2957 driver_image_handle,
2958 remain_device_path,
2959 recursive));
2960 if (r == EFI_SUCCESS)
2961 ret = EFI_SUCCESS;
2962 }
2963 }
2964 }
2965 }
2966 /* Check for child controller specified by end node */
2967 if (ret != EFI_SUCCESS && remain_device_path &&
2968 remain_device_path->type == DEVICE_PATH_TYPE_END)
2969 ret = EFI_SUCCESS;
2970out:
2971 return EFI_EXIT(ret);
2972}
2973
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002974/**
Mario Six78a88f72018-07-10 08:40:17 +02002975 * efi_reinstall_protocol_interface() - reinstall protocol interface
2976 * @handle: handle on which the protocol shall be reinstalled
2977 * @protocol: GUID of the protocol to be installed
2978 * @old_interface: interface to be removed
2979 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02002980 *
2981 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02002982 *
2983 * See the Unified Extensible Firmware Interface (UEFI) specification for
2984 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02002985 *
2986 * The old interface is uninstalled. The new interface is installed.
2987 * Drivers are connected.
2988 *
Mario Six78a88f72018-07-10 08:40:17 +02002989 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02002990 */
2991static efi_status_t EFIAPI efi_reinstall_protocol_interface(
2992 efi_handle_t handle, const efi_guid_t *protocol,
2993 void *old_interface, void *new_interface)
2994{
2995 efi_status_t ret;
2996
2997 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
2998 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002999
3000 /* Uninstall protocol but do not delete handle */
3001 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003002 if (ret != EFI_SUCCESS)
3003 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003004
3005 /* Install the new protocol */
3006 ret = efi_add_protocol(handle, protocol, new_interface);
3007 /*
3008 * The UEFI spec does not specify what should happen to the handle
3009 * if in case of an error no protocol interface remains on the handle.
3010 * So let's do nothing here.
3011 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003012 if (ret != EFI_SUCCESS)
3013 goto out;
3014 /*
3015 * The returned status code has to be ignored.
3016 * Do not create an error if no suitable driver for the handle exists.
3017 */
3018 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3019out:
3020 return EFI_EXIT(ret);
3021}
3022
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003023/**
Mario Six78a88f72018-07-10 08:40:17 +02003024 * efi_get_child_controllers() - get all child controllers associated to a driver
3025 * @efiobj: handle of the controller
3026 * @driver_handle: handle of the driver
3027 * @number_of_children: number of child controllers
3028 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003029 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003030 * The allocated buffer has to be freed with free().
3031 *
Mario Six78a88f72018-07-10 08:40:17 +02003032 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003033 */
3034static efi_status_t efi_get_child_controllers(
3035 struct efi_object *efiobj,
3036 efi_handle_t driver_handle,
3037 efi_uintn_t *number_of_children,
3038 efi_handle_t **child_handle_buffer)
3039{
3040 struct efi_handler *handler;
3041 struct efi_open_protocol_info_item *item;
3042 efi_uintn_t count = 0, i;
3043 bool duplicate;
3044
3045 /* Count all child controller associations */
3046 list_for_each_entry(handler, &efiobj->protocols, link) {
3047 list_for_each_entry(item, &handler->open_infos, link) {
3048 if (item->info.agent_handle == driver_handle &&
3049 item->info.attributes &
3050 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3051 ++count;
3052 }
3053 }
3054 /*
3055 * Create buffer. In case of duplicate child controller assignments
3056 * the buffer will be too large. But that does not harm.
3057 */
3058 *number_of_children = 0;
3059 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3060 if (!*child_handle_buffer)
3061 return EFI_OUT_OF_RESOURCES;
3062 /* Copy unique child handles */
3063 list_for_each_entry(handler, &efiobj->protocols, link) {
3064 list_for_each_entry(item, &handler->open_infos, link) {
3065 if (item->info.agent_handle == driver_handle &&
3066 item->info.attributes &
3067 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3068 /* Check this is a new child controller */
3069 duplicate = false;
3070 for (i = 0; i < *number_of_children; ++i) {
3071 if ((*child_handle_buffer)[i] ==
3072 item->info.controller_handle)
3073 duplicate = true;
3074 }
3075 /* Copy handle to buffer */
3076 if (!duplicate) {
3077 i = (*number_of_children)++;
3078 (*child_handle_buffer)[i] =
3079 item->info.controller_handle;
3080 }
3081 }
3082 }
3083 }
3084 return EFI_SUCCESS;
3085}
3086
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003087/**
Mario Six78a88f72018-07-10 08:40:17 +02003088 * efi_disconnect_controller() - disconnect a controller from a driver
3089 * @controller_handle: handle of the controller
3090 * @driver_image_handle: handle of the driver
3091 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003092 *
3093 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003094 *
Mario Six78a88f72018-07-10 08:40:17 +02003095 * See the Unified Extensible Firmware Interface (UEFI) specification for
3096 * details.
3097 *
3098 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003099 */
3100static efi_status_t EFIAPI efi_disconnect_controller(
3101 efi_handle_t controller_handle,
3102 efi_handle_t driver_image_handle,
3103 efi_handle_t child_handle)
3104{
3105 struct efi_driver_binding_protocol *binding_protocol;
3106 efi_handle_t *child_handle_buffer = NULL;
3107 size_t number_of_children = 0;
3108 efi_status_t r;
3109 size_t stop_count = 0;
3110 struct efi_object *efiobj;
3111
3112 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3113 child_handle);
3114
3115 efiobj = efi_search_obj(controller_handle);
3116 if (!efiobj) {
3117 r = EFI_INVALID_PARAMETER;
3118 goto out;
3119 }
3120
3121 if (child_handle && !efi_search_obj(child_handle)) {
3122 r = EFI_INVALID_PARAMETER;
3123 goto out;
3124 }
3125
3126 /* If no driver handle is supplied, disconnect all drivers */
3127 if (!driver_image_handle) {
3128 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3129 goto out;
3130 }
3131
3132 /* Create list of child handles */
3133 if (child_handle) {
3134 number_of_children = 1;
3135 child_handle_buffer = &child_handle;
3136 } else {
3137 efi_get_child_controllers(efiobj,
3138 driver_image_handle,
3139 &number_of_children,
3140 &child_handle_buffer);
3141 }
3142
3143 /* Get the driver binding protocol */
3144 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3145 &efi_guid_driver_binding_protocol,
3146 (void **)&binding_protocol,
3147 driver_image_handle, NULL,
3148 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3149 if (r != EFI_SUCCESS)
3150 goto out;
3151 /* Remove the children */
3152 if (number_of_children) {
3153 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3154 controller_handle,
3155 number_of_children,
3156 child_handle_buffer));
3157 if (r == EFI_SUCCESS)
3158 ++stop_count;
3159 }
3160 /* Remove the driver */
3161 if (!child_handle)
3162 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3163 controller_handle,
3164 0, NULL));
3165 if (r == EFI_SUCCESS)
3166 ++stop_count;
3167 EFI_CALL(efi_close_protocol(driver_image_handle,
3168 &efi_guid_driver_binding_protocol,
3169 driver_image_handle, NULL));
3170
3171 if (stop_count)
3172 r = EFI_SUCCESS;
3173 else
3174 r = EFI_NOT_FOUND;
3175out:
3176 if (!child_handle)
3177 free(child_handle_buffer);
3178 return EFI_EXIT(r);
3179}
3180
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003181static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003182 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003183 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3184 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003185 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003186 },
3187 .raise_tpl = efi_raise_tpl,
3188 .restore_tpl = efi_restore_tpl,
3189 .allocate_pages = efi_allocate_pages_ext,
3190 .free_pages = efi_free_pages_ext,
3191 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003192 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003193 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003194 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003195 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003196 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003197 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003198 .close_event = efi_close_event,
3199 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003200 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003201 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003202 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003203 .handle_protocol = efi_handle_protocol,
3204 .reserved = NULL,
3205 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003206 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003207 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003208 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003209 .load_image = efi_load_image,
3210 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003211 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003212 .unload_image = efi_unload_image,
3213 .exit_boot_services = efi_exit_boot_services,
3214 .get_next_monotonic_count = efi_get_next_monotonic_count,
3215 .stall = efi_stall,
3216 .set_watchdog_timer = efi_set_watchdog_timer,
3217 .connect_controller = efi_connect_controller,
3218 .disconnect_controller = efi_disconnect_controller,
3219 .open_protocol = efi_open_protocol,
3220 .close_protocol = efi_close_protocol,
3221 .open_protocol_information = efi_open_protocol_information,
3222 .protocols_per_handle = efi_protocols_per_handle,
3223 .locate_handle_buffer = efi_locate_handle_buffer,
3224 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003225 .install_multiple_protocol_interfaces =
3226 efi_install_multiple_protocol_interfaces,
3227 .uninstall_multiple_protocol_interfaces =
3228 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafbee91162016-03-04 01:09:59 +01003229 .calculate_crc32 = efi_calculate_crc32,
3230 .copy_mem = efi_copy_mem,
3231 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003232 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003233};
3234
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003235static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01003236
Alexander Graf3c63db92016-10-14 13:45:30 +02003237struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01003238 .hdr = {
3239 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003240 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003241 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01003242 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003243 .fw_vendor = firmware_vendor,
3244 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003245 .con_in = (void *)&efi_con_in,
3246 .con_out = (void *)&efi_con_out,
3247 .std_err = (void *)&efi_con_out,
3248 .runtime = (void *)&efi_runtime_services,
3249 .boottime = (void *)&efi_boot_services,
Alexander Grafbee91162016-03-04 01:09:59 +01003250 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003251 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01003252};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003253
3254/**
3255 * efi_initialize_system_table() - Initialize system table
3256 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02003257 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003258 */
3259efi_status_t efi_initialize_system_table(void)
3260{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003261 efi_status_t ret;
3262
3263 /* Allocate configuration table array */
3264 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3265 EFI_MAX_CONFIGURATION_TABLES *
3266 sizeof(struct efi_configuration_table),
3267 (void **)&systab.tables);
3268
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003269 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003270 efi_update_table_header_crc32(&systab.hdr);
3271 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3272 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003273
3274 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003275}