blob: 8f2c610b860011acd306a022c7b3bc1c8a6d6890 [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/**
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200426 * efi_add_handle() - add a new handle to the object list
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100427 *
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200428 * @handle: handle to be added
429 *
430 * The protocols list is initialized. The handle is added to the list of known
431 * UEFI objects.
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100432 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200433void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100434{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200435 if (!handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100436 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200437 INIT_LIST_HEAD(&handle->protocols);
438 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100439}
440
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200441/**
Mario Six78a88f72018-07-10 08:40:17 +0200442 * efi_create_handle() - create handle
443 * @handle: new handle
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200444 *
Mario Six78a88f72018-07-10 08:40:17 +0200445 * Return: status code
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200446 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100447efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200448{
449 struct efi_object *obj;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200450
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200451 obj = calloc(1, sizeof(struct efi_object));
452 if (!obj)
453 return EFI_OUT_OF_RESOURCES;
454
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100455 efi_add_handle(obj);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200456 *handle = obj;
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200457
458 return EFI_SUCCESS;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200459}
460
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200461/**
Mario Six78a88f72018-07-10 08:40:17 +0200462 * efi_search_protocol() - find a protocol on a handle.
463 * @handle: handle
464 * @protocol_guid: GUID of the protocol
465 * @handler: reference to the protocol
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100466 *
Mario Six78a88f72018-07-10 08:40:17 +0200467 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100468 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100469efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100470 const efi_guid_t *protocol_guid,
471 struct efi_handler **handler)
472{
473 struct efi_object *efiobj;
474 struct list_head *lhandle;
475
476 if (!handle || !protocol_guid)
477 return EFI_INVALID_PARAMETER;
478 efiobj = efi_search_obj(handle);
479 if (!efiobj)
480 return EFI_INVALID_PARAMETER;
481 list_for_each(lhandle, &efiobj->protocols) {
482 struct efi_handler *protocol;
483
484 protocol = list_entry(lhandle, struct efi_handler, link);
485 if (!guidcmp(protocol->guid, protocol_guid)) {
486 if (handler)
487 *handler = protocol;
488 return EFI_SUCCESS;
489 }
490 }
491 return EFI_NOT_FOUND;
492}
493
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200494/**
Mario Six78a88f72018-07-10 08:40:17 +0200495 * efi_remove_protocol() - delete protocol from a handle
496 * @handle: handle from which the protocol shall be deleted
497 * @protocol: GUID of the protocol to be deleted
498 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100499 *
Mario Six78a88f72018-07-10 08:40:17 +0200500 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100501 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100502efi_status_t efi_remove_protocol(const efi_handle_t handle,
503 const efi_guid_t *protocol,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100504 void *protocol_interface)
505{
506 struct efi_handler *handler;
507 efi_status_t ret;
508
509 ret = efi_search_protocol(handle, protocol, &handler);
510 if (ret != EFI_SUCCESS)
511 return ret;
512 if (guidcmp(handler->guid, protocol))
513 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt1f470e12018-05-11 12:09:21 +0200514 if (handler->protocol_interface != protocol_interface)
515 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100516 list_del(&handler->link);
517 free(handler);
518 return EFI_SUCCESS;
519}
520
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200521/**
Mario Six78a88f72018-07-10 08:40:17 +0200522 * efi_remove_all_protocols() - delete all protocols from a handle
523 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100524 *
Mario Six78a88f72018-07-10 08:40:17 +0200525 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100526 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100527efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100528{
529 struct efi_object *efiobj;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100530 struct efi_handler *protocol;
531 struct efi_handler *pos;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100532
533 efiobj = efi_search_obj(handle);
534 if (!efiobj)
535 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100536 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100537 efi_status_t ret;
538
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100539 ret = efi_remove_protocol(handle, protocol->guid,
540 protocol->protocol_interface);
541 if (ret != EFI_SUCCESS)
542 return ret;
543 }
544 return EFI_SUCCESS;
545}
546
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200547/**
Mario Six78a88f72018-07-10 08:40:17 +0200548 * efi_delete_handle() - delete handle
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100549 *
Mario Six78a88f72018-07-10 08:40:17 +0200550 * @obj: handle to delete
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100551 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200552void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100553{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200554 if (!handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100555 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200556 efi_remove_all_protocols(handle);
557 list_del(&handle->link);
558 free(handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100559}
560
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200561/**
Mario Six78a88f72018-07-10 08:40:17 +0200562 * efi_is_event() - check if a pointer is a valid event
563 * @event: pointer to check
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100564 *
Mario Six78a88f72018-07-10 08:40:17 +0200565 * Return: status code
Alexander Grafbee91162016-03-04 01:09:59 +0100566 */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100567static efi_status_t efi_is_event(const struct efi_event *event)
568{
569 const struct efi_event *evt;
570
571 if (!event)
572 return EFI_INVALID_PARAMETER;
573 list_for_each_entry(evt, &efi_events, link) {
574 if (evt == event)
575 return EFI_SUCCESS;
576 }
577 return EFI_INVALID_PARAMETER;
578}
Alexander Grafbee91162016-03-04 01:09:59 +0100579
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200580/**
Mario Six78a88f72018-07-10 08:40:17 +0200581 * efi_create_event() - create an event
582 * @type: type of the event to create
583 * @notify_tpl: task priority level of the event
584 * @notify_function: notification function of the event
585 * @notify_context: pointer passed to the notification function
586 * @group: event group
587 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200588 *
589 * This function is used inside U-Boot code to create an event.
590 *
591 * For the API function implementing the CreateEvent service see
592 * efi_create_event_ext.
593 *
Mario Six78a88f72018-07-10 08:40:17 +0200594 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200595 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100596efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200597 void (EFIAPI *notify_function) (
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200598 struct efi_event *event,
599 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100600 void *notify_context, efi_guid_t *group,
601 struct efi_event **event)
Alexander Grafbee91162016-03-04 01:09:59 +0100602{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100603 struct efi_event *evt;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200604
Jonathan Graya95343b2017-03-12 19:26:07 +1100605 if (event == NULL)
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200606 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100607
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200608 switch (type) {
609 case 0:
610 case EVT_TIMER:
611 case EVT_NOTIFY_SIGNAL:
612 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
613 case EVT_NOTIFY_WAIT:
614 case EVT_TIMER | EVT_NOTIFY_WAIT:
615 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
616 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
617 break;
618 default:
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200619 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200620 }
Jonathan Graya95343b2017-03-12 19:26:07 +1100621
AKASHI Takahiro3748ed92018-08-10 15:36:32 +0900622 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardt751e9282019-04-25 07:30:41 +0200623 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200624 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100625
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100626 evt = calloc(1, sizeof(struct efi_event));
627 if (!evt)
628 return EFI_OUT_OF_RESOURCES;
629 evt->type = type;
630 evt->notify_tpl = notify_tpl;
631 evt->notify_function = notify_function;
632 evt->notify_context = notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100633 evt->group = group;
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200634 /* Disable timers on boot up */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100635 evt->trigger_next = -1ULL;
636 evt->is_queued = false;
637 evt->is_signaled = false;
638 list_add_tail(&evt->link, &efi_events);
639 *event = evt;
640 return EFI_SUCCESS;
Alexander Grafbee91162016-03-04 01:09:59 +0100641}
642
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200643/*
Mario Six78a88f72018-07-10 08:40:17 +0200644 * efi_create_event_ex() - create an event in a group
645 * @type: type of the event to create
646 * @notify_tpl: task priority level of the event
647 * @notify_function: notification function of the event
648 * @notify_context: pointer passed to the notification function
649 * @event: created event
650 * @event_group: event group
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100651 *
652 * This function implements the CreateEventEx service.
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100653 *
Mario Six78a88f72018-07-10 08:40:17 +0200654 * See the Unified Extensible Firmware Interface (UEFI) specification for
655 * details.
656 *
657 * Return: status code
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100658 */
659efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
660 void (EFIAPI *notify_function) (
661 struct efi_event *event,
662 void *context),
663 void *notify_context,
664 efi_guid_t *event_group,
665 struct efi_event **event)
666{
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200667 efi_status_t ret;
668
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100669 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
670 notify_context, event_group);
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200671
672 /*
673 * The allowable input parameters are the same as in CreateEvent()
674 * except for the following two disallowed event types.
675 */
676 switch (type) {
677 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
678 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
679 ret = EFI_INVALID_PARAMETER;
680 goto out;
681 }
682
683 ret = efi_create_event(type, notify_tpl, notify_function,
684 notify_context, event_group, event);
685out:
686 return EFI_EXIT(ret);
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100687}
688
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200689/**
Mario Six78a88f72018-07-10 08:40:17 +0200690 * efi_create_event_ext() - create an event
691 * @type: type of the event to create
692 * @notify_tpl: task priority level of the event
693 * @notify_function: notification function of the event
694 * @notify_context: pointer passed to the notification function
695 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200696 *
697 * This function implements the CreateEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200698 *
Mario Six78a88f72018-07-10 08:40:17 +0200699 * See the Unified Extensible Firmware Interface (UEFI) specification for
700 * details.
701 *
702 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200703 */
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200704static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100705 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200706 void (EFIAPI *notify_function) (
707 struct efi_event *event,
708 void *context),
709 void *notify_context, struct efi_event **event)
710{
711 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
712 notify_context);
713 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100714 notify_context, NULL, event));
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200715}
716
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200717/**
Mario Six78a88f72018-07-10 08:40:17 +0200718 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200719 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200720 * Check if a timer event has occurred or a queued notification function should
721 * be called.
722 *
Alexander Grafbee91162016-03-04 01:09:59 +0100723 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200724 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafbee91162016-03-04 01:09:59 +0100725 */
726void efi_timer_check(void)
727{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100728 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +0100729 u64 now = timer_get_us();
730
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100731 list_for_each_entry(evt, &efi_events, link) {
732 if (evt->is_queued)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100733 efi_queue_event(evt, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100734 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200735 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100736 switch (evt->trigger_type) {
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200737 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100738 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200739 break;
740 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100741 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200742 break;
743 default:
744 continue;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200745 }
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100746 evt->is_signaled = false;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100747 efi_signal_event(evt, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100748 }
Alexander Grafbee91162016-03-04 01:09:59 +0100749 WATCHDOG_RESET();
750}
751
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200752/**
Mario Six78a88f72018-07-10 08:40:17 +0200753 * efi_set_timer() - set the trigger time for a timer event or stop the event
754 * @event: event for which the timer is set
755 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200756 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200757 *
758 * This is the function for internal usage in U-Boot. For the API function
759 * implementing the SetTimer service see efi_set_timer_ext.
760 *
Mario Six78a88f72018-07-10 08:40:17 +0200761 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200762 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200763efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200764 uint64_t trigger_time)
Alexander Grafbee91162016-03-04 01:09:59 +0100765{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100766 /* Check that the event is valid */
767 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
768 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100769
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200770 /*
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200771 * The parameter defines a multiple of 100 ns.
772 * We use multiples of 1000 ns. So divide by 10.
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200773 */
Heinrich Schuchardt7d963322017-10-05 16:14:14 +0200774 do_div(trigger_time, 10);
Alexander Grafbee91162016-03-04 01:09:59 +0100775
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100776 switch (type) {
777 case EFI_TIMER_STOP:
778 event->trigger_next = -1ULL;
779 break;
780 case EFI_TIMER_PERIODIC:
781 case EFI_TIMER_RELATIVE:
782 event->trigger_next = timer_get_us() + trigger_time;
783 break;
784 default:
785 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100786 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100787 event->trigger_type = type;
788 event->trigger_time = trigger_time;
789 event->is_signaled = false;
790 return EFI_SUCCESS;
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200791}
792
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200793/**
Mario Six78a88f72018-07-10 08:40:17 +0200794 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
795 * event
796 * @event: event for which the timer is set
797 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200798 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200799 *
800 * This function implements the SetTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200801 *
Mario Six78a88f72018-07-10 08:40:17 +0200802 * See the Unified Extensible Firmware Interface (UEFI) specification for
803 * details.
804 *
805 *
806 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200807 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200808static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
809 enum efi_timer_delay type,
810 uint64_t trigger_time)
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200811{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900812 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200813 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
Alexander Grafbee91162016-03-04 01:09:59 +0100814}
815
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200816/**
Mario Six78a88f72018-07-10 08:40:17 +0200817 * efi_wait_for_event() - wait for events to be signaled
818 * @num_events: number of events to be waited for
819 * @event: events to be waited for
820 * @index: index of the event that was signaled
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200821 *
822 * This function implements the WaitForEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200823 *
Mario Six78a88f72018-07-10 08:40:17 +0200824 * See the Unified Extensible Firmware Interface (UEFI) specification for
825 * details.
826 *
827 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200828 */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100829static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200830 struct efi_event **event,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100831 efi_uintn_t *index)
Alexander Grafbee91162016-03-04 01:09:59 +0100832{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100833 int i;
Alexander Grafbee91162016-03-04 01:09:59 +0100834
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100835 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
Alexander Grafbee91162016-03-04 01:09:59 +0100836
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200837 /* Check parameters */
838 if (!num_events || !event)
839 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200840 /* Check TPL */
841 if (efi_tpl != TPL_APPLICATION)
842 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200843 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100844 if (efi_is_event(event[i]) != EFI_SUCCESS)
845 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200846 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
847 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200848 if (!event[i]->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100849 efi_queue_event(event[i], true);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200850 }
851
852 /* Wait for signal */
853 for (;;) {
854 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200855 if (event[i]->is_signaled)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200856 goto out;
857 }
858 /* Allow events to occur. */
859 efi_timer_check();
860 }
861
862out:
863 /*
864 * Reset the signal which is passed to the caller to allow periodic
865 * events to occur.
866 */
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200867 event[i]->is_signaled = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200868 if (index)
869 *index = i;
Alexander Grafbee91162016-03-04 01:09:59 +0100870
871 return EFI_EXIT(EFI_SUCCESS);
872}
873
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200874/**
Mario Six78a88f72018-07-10 08:40:17 +0200875 * efi_signal_event_ext() - signal an EFI event
876 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200877 *
878 * This function implements the SignalEvent service.
Mario Six78a88f72018-07-10 08:40:17 +0200879 *
880 * See the Unified Extensible Firmware Interface (UEFI) specification for
881 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200882 *
883 * This functions sets the signaled state of the event and queues the
884 * notification function for execution.
885 *
Mario Six78a88f72018-07-10 08:40:17 +0200886 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200887 */
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200888static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100889{
890 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100891 if (efi_is_event(event) != EFI_SUCCESS)
892 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100893 efi_signal_event(event, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100894 return EFI_EXIT(EFI_SUCCESS);
895}
896
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200897/**
Mario Six78a88f72018-07-10 08:40:17 +0200898 * efi_close_event() - close an EFI event
899 * @event: event to close
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200900 *
901 * This function implements the CloseEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200902 *
Mario Six78a88f72018-07-10 08:40:17 +0200903 * See the Unified Extensible Firmware Interface (UEFI) specification for
904 * details.
905 *
906 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200907 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200908static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100909{
910 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100911 if (efi_is_event(event) != EFI_SUCCESS)
912 return EFI_EXIT(EFI_INVALID_PARAMETER);
913 list_del(&event->link);
914 free(event);
915 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100916}
917
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200918/**
Mario Six78a88f72018-07-10 08:40:17 +0200919 * efi_check_event() - check if an event is signaled
920 * @event: event to check
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200921 *
922 * This function implements the CheckEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200923 *
Mario Six78a88f72018-07-10 08:40:17 +0200924 * See the Unified Extensible Firmware Interface (UEFI) specification for
925 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200926 *
Mario Six78a88f72018-07-10 08:40:17 +0200927 * If an event is not signaled yet, the notification function is queued. The
928 * signaled state is cleared.
929 *
930 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200931 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200932static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100933{
934 EFI_ENTRY("%p", event);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200935 efi_timer_check();
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100936 if (efi_is_event(event) != EFI_SUCCESS ||
937 event->type & EVT_NOTIFY_SIGNAL)
938 return EFI_EXIT(EFI_INVALID_PARAMETER);
939 if (!event->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100940 efi_queue_event(event, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100941 if (event->is_signaled) {
942 event->is_signaled = false;
943 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200944 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100945 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafbee91162016-03-04 01:09:59 +0100946}
947
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200948/**
Mario Six78a88f72018-07-10 08:40:17 +0200949 * efi_search_obj() - find the internal EFI object for a handle
950 * @handle: handle to find
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200951 *
Mario Six78a88f72018-07-10 08:40:17 +0200952 * Return: EFI object
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200953 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100954struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200955{
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100956 struct efi_object *efiobj;
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200957
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100958 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200959 if (efiobj == handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200960 return efiobj;
961 }
962
963 return NULL;
964}
965
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200966/**
Mario Six78a88f72018-07-10 08:40:17 +0200967 * efi_open_protocol_info_entry() - create open protocol info entry and add it
968 * to a protocol
969 * @handler: handler of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100970 *
Mario Six78a88f72018-07-10 08:40:17 +0200971 * Return: open protocol info entry
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100972 */
973static struct efi_open_protocol_info_entry *efi_create_open_info(
974 struct efi_handler *handler)
975{
976 struct efi_open_protocol_info_item *item;
977
978 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
979 if (!item)
980 return NULL;
981 /* Append the item to the open protocol info list. */
982 list_add_tail(&item->link, &handler->open_infos);
983
984 return &item->info;
985}
986
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200987/**
Mario Six78a88f72018-07-10 08:40:17 +0200988 * efi_delete_open_info() - remove an open protocol info entry from a protocol
989 * @item: open protocol info entry to delete
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100990 *
Mario Six78a88f72018-07-10 08:40:17 +0200991 * Return: status code
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100992 */
993static efi_status_t efi_delete_open_info(
994 struct efi_open_protocol_info_item *item)
995{
996 list_del(&item->link);
997 free(item);
998 return EFI_SUCCESS;
999}
1000
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001001/**
Mario Six78a88f72018-07-10 08:40:17 +02001002 * efi_add_protocol() - install new protocol on a handle
1003 * @handle: handle on which the protocol shall be installed
1004 * @protocol: GUID of the protocol to be installed
1005 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001006 *
Mario Six78a88f72018-07-10 08:40:17 +02001007 * Return: status code
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001008 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001009efi_status_t efi_add_protocol(const efi_handle_t handle,
1010 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001011 void *protocol_interface)
1012{
1013 struct efi_object *efiobj;
1014 struct efi_handler *handler;
1015 efi_status_t ret;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001016
1017 efiobj = efi_search_obj(handle);
1018 if (!efiobj)
1019 return EFI_INVALID_PARAMETER;
1020 ret = efi_search_protocol(handle, protocol, NULL);
1021 if (ret != EFI_NOT_FOUND)
1022 return EFI_INVALID_PARAMETER;
1023 handler = calloc(1, sizeof(struct efi_handler));
1024 if (!handler)
1025 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001026 handler->guid = protocol;
1027 handler->protocol_interface = protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001028 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001029 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardtd5504142018-01-11 08:16:01 +01001030 if (!guidcmp(&efi_guid_device_path, protocol))
1031 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001032 return EFI_SUCCESS;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001033}
1034
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001035/**
Mario Six78a88f72018-07-10 08:40:17 +02001036 * efi_install_protocol_interface() - install protocol interface
1037 * @handle: handle on which the protocol shall be installed
1038 * @protocol: GUID of the protocol to be installed
1039 * @protocol_interface_type: type of the interface to be installed,
1040 * always EFI_NATIVE_INTERFACE
1041 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001042 *
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001043 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001044 *
Mario Six78a88f72018-07-10 08:40:17 +02001045 * See the Unified Extensible Firmware Interface (UEFI) specification for
1046 * details.
1047 *
1048 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001049 */
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001050static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02001051 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001052 int protocol_interface_type, void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001053{
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001054 efi_status_t r;
1055
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001056 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1057 protocol_interface);
1058
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001059 if (!handle || !protocol ||
1060 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1061 r = EFI_INVALID_PARAMETER;
1062 goto out;
1063 }
1064
1065 /* Create new handle if requested. */
1066 if (!*handle) {
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +02001067 r = efi_create_handle(handle);
1068 if (r != EFI_SUCCESS)
1069 goto out;
Heinrich Schuchardtaf1408e2017-10-26 19:25:43 +02001070 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1071 *handle);
1072 } else {
1073 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1074 *handle);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001075 }
Heinrich Schuchardt12025302017-10-26 19:25:54 +02001076 /* Add new protocol */
1077 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001078out:
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001079 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001080}
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001081
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001082/**
Mario Six78a88f72018-07-10 08:40:17 +02001083 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001084 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001085 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001086 * @number_of_drivers: number of child controllers
1087 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001088 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001089 * The allocated buffer has to be freed with free().
1090 *
Mario Six78a88f72018-07-10 08:40:17 +02001091 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001092 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001093static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001094 const efi_guid_t *protocol,
1095 efi_uintn_t *number_of_drivers,
1096 efi_handle_t **driver_handle_buffer)
1097{
1098 struct efi_handler *handler;
1099 struct efi_open_protocol_info_item *item;
1100 efi_uintn_t count = 0, i;
1101 bool duplicate;
1102
1103 /* Count all driver associations */
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 ++count;
1111 }
1112 }
1113 /*
1114 * Create buffer. In case of duplicate driver assignments the buffer
1115 * will be too large. But that does not harm.
1116 */
1117 *number_of_drivers = 0;
1118 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1119 if (!*driver_handle_buffer)
1120 return EFI_OUT_OF_RESOURCES;
1121 /* Collect unique driver handles */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001122 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001123 if (protocol && guidcmp(handler->guid, protocol))
1124 continue;
1125 list_for_each_entry(item, &handler->open_infos, link) {
1126 if (item->info.attributes &
1127 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1128 /* Check this is a new driver */
1129 duplicate = false;
1130 for (i = 0; i < *number_of_drivers; ++i) {
1131 if ((*driver_handle_buffer)[i] ==
1132 item->info.agent_handle)
1133 duplicate = true;
1134 }
1135 /* Copy handle to buffer */
1136 if (!duplicate) {
1137 i = (*number_of_drivers)++;
1138 (*driver_handle_buffer)[i] =
1139 item->info.agent_handle;
1140 }
1141 }
1142 }
1143 }
1144 return EFI_SUCCESS;
1145}
1146
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001147/**
Mario Six78a88f72018-07-10 08:40:17 +02001148 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001149 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001150 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001151 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001152 *
1153 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001154 *
Mario Six78a88f72018-07-10 08:40:17 +02001155 * See the Unified Extensible Firmware Interface (UEFI) specification for
1156 * details.
1157 *
1158 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001159 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001160static efi_status_t efi_disconnect_all_drivers
1161 (efi_handle_t handle,
1162 const efi_guid_t *protocol,
1163 efi_handle_t child_handle)
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001164{
1165 efi_uintn_t number_of_drivers;
1166 efi_handle_t *driver_handle_buffer;
1167 efi_status_t r, ret;
1168
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001169 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001170 &driver_handle_buffer);
1171 if (ret != EFI_SUCCESS)
1172 return ret;
1173
1174 ret = EFI_NOT_FOUND;
1175 while (number_of_drivers) {
1176 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001177 handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001178 driver_handle_buffer[--number_of_drivers],
1179 child_handle));
1180 if (r == EFI_SUCCESS)
1181 ret = r;
1182 }
1183 free(driver_handle_buffer);
1184 return ret;
1185}
1186
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001187/**
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001188 * efi_uninstall_protocol() - uninstall protocol interface
1189 *
Mario Six78a88f72018-07-10 08:40:17 +02001190 * @handle: handle from which the protocol shall be removed
1191 * @protocol: GUID of the protocol to be removed
1192 * @protocol_interface: interface to be removed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001193 *
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001194 * This function DOES NOT delete a handle without installed protocol.
Mario Six78a88f72018-07-10 08:40:17 +02001195 *
1196 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001197 */
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001198static efi_status_t efi_uninstall_protocol
1199 (efi_handle_t handle, const efi_guid_t *protocol,
1200 void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001201{
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001202 struct efi_object *efiobj;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001203 struct efi_handler *handler;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001204 struct efi_open_protocol_info_item *item;
1205 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001206 efi_status_t r;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001207
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001208 /* Check handle */
1209 efiobj = efi_search_obj(handle);
1210 if (!efiobj) {
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001211 r = EFI_INVALID_PARAMETER;
1212 goto out;
1213 }
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001214 /* Find the protocol on the handle */
1215 r = efi_search_protocol(handle, protocol, &handler);
1216 if (r != EFI_SUCCESS)
1217 goto out;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001218 /* Disconnect controllers */
1219 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1220 if (!list_empty(&handler->open_infos)) {
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001221 r = EFI_ACCESS_DENIED;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001222 goto out;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001223 }
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001224 /* Close protocol */
1225 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1226 if (item->info.attributes ==
1227 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1228 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1229 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1230 list_del(&item->link);
1231 }
1232 if (!list_empty(&handler->open_infos)) {
1233 r = EFI_ACCESS_DENIED;
1234 goto out;
1235 }
1236 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001237out:
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001238 return r;
1239}
1240
1241/**
1242 * efi_uninstall_protocol_interface() - uninstall protocol interface
1243 * @handle: handle from which the protocol shall be removed
1244 * @protocol: GUID of the protocol to be removed
1245 * @protocol_interface: interface to be removed
1246 *
1247 * This function implements the UninstallProtocolInterface service.
1248 *
1249 * See the Unified Extensible Firmware Interface (UEFI) specification for
1250 * details.
1251 *
1252 * Return: status code
1253 */
1254static efi_status_t EFIAPI efi_uninstall_protocol_interface
1255 (efi_handle_t handle, const efi_guid_t *protocol,
1256 void *protocol_interface)
1257{
1258 efi_status_t ret;
1259
1260 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1261
1262 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1263 if (ret != EFI_SUCCESS)
1264 goto out;
1265
1266 /* If the last protocol has been removed, delete the handle. */
1267 if (list_empty(&handle->protocols)) {
1268 list_del(&handle->link);
1269 free(handle);
1270 }
1271out:
1272 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001273}
1274
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001275/**
Mario Six78a88f72018-07-10 08:40:17 +02001276 * efi_register_protocol_notify() - register an event for notification when a
1277 * protocol is installed.
1278 * @protocol: GUID of the protocol whose installation shall be notified
1279 * @event: event to be signaled upon installation of the protocol
1280 * @registration: key for retrieving the registration information
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001281 *
1282 * This function implements the RegisterProtocolNotify service.
1283 * See the Unified Extensible Firmware Interface (UEFI) specification
1284 * for details.
1285 *
Mario Six78a88f72018-07-10 08:40:17 +02001286 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001287 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001288static efi_status_t EFIAPI efi_register_protocol_notify(
1289 const efi_guid_t *protocol,
1290 struct efi_event *event,
1291 void **registration)
Alexander Grafbee91162016-03-04 01:09:59 +01001292{
Rob Clark778e6af2017-09-13 18:05:41 -04001293 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Alexander Grafbee91162016-03-04 01:09:59 +01001294 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1295}
1296
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001297/**
Mario Six78a88f72018-07-10 08:40:17 +02001298 * efi_search() - determine if an EFI handle implements a protocol
1299 * @search_type: selection criterion
1300 * @protocol: GUID of the protocol
1301 * @search_key: registration key
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001302 * @handle: handle
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001303 *
1304 * See the documentation of the LocateHandle service in the UEFI specification.
1305 *
Mario Six78a88f72018-07-10 08:40:17 +02001306 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001307 */
Alexander Grafbee91162016-03-04 01:09:59 +01001308static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001309 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001310 efi_handle_t handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001311{
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001312 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01001313
1314 switch (search_type) {
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001315 case ALL_HANDLES:
Alexander Grafbee91162016-03-04 01:09:59 +01001316 return 0;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001317 case BY_REGISTER_NOTIFY:
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001318 /* TODO: RegisterProtocolNotify is not implemented yet */
Alexander Grafbee91162016-03-04 01:09:59 +01001319 return -1;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001320 case BY_PROTOCOL:
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001321 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001322 return (ret != EFI_SUCCESS);
1323 default:
1324 /* Invalid search type */
Alexander Grafbee91162016-03-04 01:09:59 +01001325 return -1;
1326 }
Alexander Grafbee91162016-03-04 01:09:59 +01001327}
1328
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001329/**
Mario Six78a88f72018-07-10 08:40:17 +02001330 * efi_locate_handle() - locate handles implementing a protocol
1331 * @search_type: selection criterion
1332 * @protocol: GUID of the protocol
1333 * @search_key: registration key
1334 * @buffer_size: size of the buffer to receive the handles in bytes
1335 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001336 *
1337 * This function is meant for U-Boot internal calls. For the API implementation
1338 * of the LocateHandle service see efi_locate_handle_ext.
1339 *
Mario Six78a88f72018-07-10 08:40:17 +02001340 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001341 */
xypron.glpk@gmx.deebf199b2017-08-09 20:55:00 +02001342static efi_status_t efi_locate_handle(
Alexander Grafbee91162016-03-04 01:09:59 +01001343 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001344 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001345 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01001346{
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001347 struct efi_object *efiobj;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001348 efi_uintn_t size = 0;
Alexander Grafbee91162016-03-04 01:09:59 +01001349
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001350 /* Check parameters */
1351 switch (search_type) {
1352 case ALL_HANDLES:
1353 break;
1354 case BY_REGISTER_NOTIFY:
1355 if (!search_key)
1356 return EFI_INVALID_PARAMETER;
1357 /* RegisterProtocolNotify is not implemented yet */
1358 return EFI_UNSUPPORTED;
1359 case BY_PROTOCOL:
1360 if (!protocol)
1361 return EFI_INVALID_PARAMETER;
1362 break;
1363 default:
1364 return EFI_INVALID_PARAMETER;
1365 }
1366
Alexander Grafbee91162016-03-04 01:09:59 +01001367 /* Count how much space we need */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001368 list_for_each_entry(efiobj, &efi_obj_list, link) {
1369 if (!efi_search(search_type, protocol, search_key, efiobj))
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001370 size += sizeof(void *);
Alexander Grafbee91162016-03-04 01:09:59 +01001371 }
1372
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001373 if (size == 0)
1374 return EFI_NOT_FOUND;
1375
1376 if (!buffer_size)
1377 return EFI_INVALID_PARAMETER;
1378
Alexander Grafbee91162016-03-04 01:09:59 +01001379 if (*buffer_size < size) {
1380 *buffer_size = size;
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001381 return EFI_BUFFER_TOO_SMALL;
Alexander Grafbee91162016-03-04 01:09:59 +01001382 }
1383
Rob Clark796a78c2017-08-06 14:10:07 -04001384 *buffer_size = size;
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001385
1386 /* The buffer size is sufficient but there is not buffer */
1387 if (!buffer)
1388 return EFI_INVALID_PARAMETER;
Rob Clark796a78c2017-08-06 14:10:07 -04001389
Alexander Grafbee91162016-03-04 01:09:59 +01001390 /* Then fill the array */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001391 list_for_each_entry(efiobj, &efi_obj_list, link) {
1392 if (!efi_search(search_type, protocol, search_key, efiobj))
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001393 *buffer++ = efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01001394 }
1395
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001396 return EFI_SUCCESS;
1397}
1398
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001399/**
Mario Six78a88f72018-07-10 08:40:17 +02001400 * efi_locate_handle_ext() - locate handles implementing a protocol.
1401 * @search_type: selection criterion
1402 * @protocol: GUID of the protocol
1403 * @search_key: registration key
1404 * @buffer_size: size of the buffer to receive the handles in bytes
1405 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001406 *
1407 * This function implements the LocateHandle service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001408 *
Mario Six78a88f72018-07-10 08:40:17 +02001409 * See the Unified Extensible Firmware Interface (UEFI) specification for
1410 * details.
1411 *
1412 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001413 */
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001414static efi_status_t EFIAPI efi_locate_handle_ext(
1415 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001416 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001417 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001418{
Rob Clark778e6af2017-09-13 18:05:41 -04001419 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001420 buffer_size, buffer);
1421
1422 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1423 buffer_size, buffer));
Alexander Grafbee91162016-03-04 01:09:59 +01001424}
1425
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001426/**
Mario Six78a88f72018-07-10 08:40:17 +02001427 * efi_remove_configuration_table() - collapses configuration table entries,
1428 * removing index i
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001429 *
Mario Six78a88f72018-07-10 08:40:17 +02001430 * @i: index of the table entry to be removed
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001431 */
Alexander Grafd98cdf62017-07-26 13:41:04 +02001432static void efi_remove_configuration_table(int i)
1433{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001434 struct efi_configuration_table *this = &systab.tables[i];
1435 struct efi_configuration_table *next = &systab.tables[i + 1];
1436 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Grafd98cdf62017-07-26 13:41:04 +02001437
1438 memmove(this, next, (ulong)end - (ulong)next);
1439 systab.nr_tables--;
1440}
1441
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001442/**
Mario Six78a88f72018-07-10 08:40:17 +02001443 * efi_install_configuration_table() - adds, updates, or removes a
1444 * configuration table
1445 * @guid: GUID of the installed table
1446 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001447 *
1448 * This function is used for internal calls. For the API implementation of the
1449 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1450 *
Mario Six78a88f72018-07-10 08:40:17 +02001451 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001452 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001453efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1454 void *table)
Alexander Grafbee91162016-03-04 01:09:59 +01001455{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001456 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +01001457 int i;
1458
Heinrich Schuchardteb68b4e2018-02-18 00:08:00 +01001459 if (!guid)
1460 return EFI_INVALID_PARAMETER;
1461
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001462 /* Check for GUID override */
Alexander Grafbee91162016-03-04 01:09:59 +01001463 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001464 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Grafd98cdf62017-07-26 13:41:04 +02001465 if (table)
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001466 systab.tables[i].table = table;
Alexander Grafd98cdf62017-07-26 13:41:04 +02001467 else
1468 efi_remove_configuration_table(i);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001469 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01001470 }
1471 }
1472
Alexander Grafd98cdf62017-07-26 13:41:04 +02001473 if (!table)
1474 return EFI_NOT_FOUND;
1475
Alexander Grafbee91162016-03-04 01:09:59 +01001476 /* No override, check for overflow */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001477 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Graf488bf122016-08-19 01:23:24 +02001478 return EFI_OUT_OF_RESOURCES;
Alexander Grafbee91162016-03-04 01:09:59 +01001479
1480 /* Add a new entry */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001481 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1482 systab.tables[i].table = table;
Alexander Grafaba5e912016-08-19 01:23:30 +02001483 systab.nr_tables = i + 1;
Alexander Grafbee91162016-03-04 01:09:59 +01001484
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001485out:
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001486 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardt55d8ee32018-07-07 15:36:05 +02001487 efi_update_table_header_crc32(&systab.hdr);
1488
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001489 /* Notify that the configuration table was changed */
1490 list_for_each_entry(evt, &efi_events, link) {
1491 if (evt->group && !guidcmp(evt->group, guid)) {
1492 efi_signal_event(evt, false);
1493 break;
1494 }
1495 }
1496
Alexander Graf488bf122016-08-19 01:23:24 +02001497 return EFI_SUCCESS;
1498}
1499
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001500/**
Mario Six78a88f72018-07-10 08:40:17 +02001501 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1502 * configuration table.
1503 * @guid: GUID of the installed table
1504 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001505 *
1506 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001507 *
Mario Six78a88f72018-07-10 08:40:17 +02001508 * See the Unified Extensible Firmware Interface (UEFI) specification for
1509 * details.
1510 *
1511 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001512 */
Alexander Graf488bf122016-08-19 01:23:24 +02001513static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1514 void *table)
1515{
Rob Clark778e6af2017-09-13 18:05:41 -04001516 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Graf488bf122016-08-19 01:23:24 +02001517 return EFI_EXIT(efi_install_configuration_table(guid, table));
Alexander Grafbee91162016-03-04 01:09:59 +01001518}
1519
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001520/**
Mario Six78a88f72018-07-10 08:40:17 +02001521 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001522 *
1523 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clark95c55532017-09-13 18:05:33 -04001524 * protocols, boot-device, etc.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001525 *
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001526 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1527 * code is returned.
1528 *
1529 * @device_path: device path of the loaded image
1530 * @file_path: file path of the loaded image
1531 * @handle_ptr: handle of the loaded image
1532 * @info_ptr: loaded image protocol
1533 * Return: status code
Rob Clark95c55532017-09-13 18:05:33 -04001534 */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001535efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1536 struct efi_device_path *file_path,
1537 struct efi_loaded_image_obj **handle_ptr,
1538 struct efi_loaded_image **info_ptr)
Rob Clark95c55532017-09-13 18:05:33 -04001539{
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001540 efi_status_t ret;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001541 struct efi_loaded_image *info = NULL;
1542 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001543 struct efi_device_path *dp;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001544
1545 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1546 *handle_ptr = NULL;
1547 *info_ptr = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001548
1549 info = calloc(1, sizeof(*info));
1550 if (!info)
1551 return EFI_OUT_OF_RESOURCES;
1552 obj = calloc(1, sizeof(*obj));
1553 if (!obj) {
1554 free(info);
1555 return EFI_OUT_OF_RESOURCES;
1556 }
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02001557 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001558
Heinrich Schuchardt44549d62017-11-26 14:05:23 +01001559 /* Add internal object to object list */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001560 efi_add_handle(&obj->header);
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001561
Heinrich Schuchardt95147312018-07-05 08:17:58 +02001562 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Rob Clark95c55532017-09-13 18:05:33 -04001563 info->file_path = file_path;
Heinrich Schuchardt7e1effc2018-08-26 15:31:52 +02001564 info->system_table = &systab;
Rob Clark95c55532017-09-13 18:05:33 -04001565
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001566 if (device_path) {
1567 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001568
1569 dp = efi_dp_append(device_path, file_path);
1570 if (!dp) {
1571 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001572 goto failure;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001573 }
1574 } else {
1575 dp = NULL;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001576 }
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001577 ret = efi_add_protocol(&obj->header,
1578 &efi_guid_loaded_image_device_path, dp);
1579 if (ret != EFI_SUCCESS)
1580 goto failure;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001581
1582 /*
1583 * When asking for the loaded_image interface, just
1584 * return handle which points to loaded_image_info
1585 */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001586 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001587 &efi_guid_loaded_image, info);
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001588 if (ret != EFI_SUCCESS)
1589 goto failure;
1590
Heinrich Schuchardtd5974af2019-03-19 18:58:58 +01001591 *info_ptr = info;
1592 *handle_ptr = obj;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001593
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001594 return ret;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001595failure:
1596 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001597 efi_delete_handle(&obj->header);
1598 free(info);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001599 return ret;
Rob Clark95c55532017-09-13 18:05:33 -04001600}
1601
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001602/**
Mario Six78a88f72018-07-10 08:40:17 +02001603 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001604 *
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001605 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1606 * callers obligation to update the memory type as needed.
1607 *
1608 * @file_path: the path of the image to load
1609 * @buffer: buffer containing the loaded image
1610 * @size: size of the loaded image
1611 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001612 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09001613static
Rob Clark9975fe92017-09-13 18:05:38 -04001614efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001615 void **buffer, efi_uintn_t *size)
Rob Clark838ee4b2017-09-13 18:05:35 -04001616{
1617 struct efi_file_info *info = NULL;
1618 struct efi_file_handle *f;
1619 static efi_status_t ret;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001620 u64 addr;
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001621 efi_uintn_t bs;
Rob Clark838ee4b2017-09-13 18:05:35 -04001622
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001623 /* In case of failure nothing is returned */
1624 *buffer = NULL;
1625 *size = 0;
1626
1627 /* Open file */
Rob Clark838ee4b2017-09-13 18:05:35 -04001628 f = efi_file_from_path(file_path);
1629 if (!f)
1630 return EFI_DEVICE_ERROR;
1631
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001632 /* Get file size */
Rob Clark838ee4b2017-09-13 18:05:35 -04001633 bs = 0;
1634 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1635 &bs, info));
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001636 if (ret != EFI_BUFFER_TOO_SMALL) {
1637 ret = EFI_DEVICE_ERROR;
1638 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001639 }
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001640
1641 info = malloc(bs);
1642 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1643 info));
Rob Clark838ee4b2017-09-13 18:05:35 -04001644 if (ret != EFI_SUCCESS)
1645 goto error;
1646
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001647 /*
1648 * When reading the file we do not yet know if it contains an
1649 * application, a boottime driver, or a runtime driver. So here we
1650 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1651 * update the reservation according to the image type.
1652 */
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001653 bs = info->file_size;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001654 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1655 EFI_BOOT_SERVICES_DATA,
1656 efi_size_in_pages(bs), &addr);
Rob Clark838ee4b2017-09-13 18:05:35 -04001657 if (ret != EFI_SUCCESS) {
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001658 ret = EFI_OUT_OF_RESOURCES;
1659 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001660 }
1661
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001662 /* Read file */
1663 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1664 if (ret != EFI_SUCCESS)
1665 efi_free_pages(addr, efi_size_in_pages(bs));
1666 *buffer = (void *)(uintptr_t)addr;
1667 *size = bs;
1668error:
1669 EFI_CALL(f->close(f));
1670 free(info);
Rob Clark838ee4b2017-09-13 18:05:35 -04001671 return ret;
1672}
1673
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001674/**
Mario Six78a88f72018-07-10 08:40:17 +02001675 * efi_load_image() - load an EFI image into memory
1676 * @boot_policy: true for request originating from the boot manager
1677 * @parent_image: the caller's image handle
1678 * @file_path: the path of the image to load
1679 * @source_buffer: memory location from which the image is installed
1680 * @source_size: size of the memory area from which the image is installed
1681 * @image_handle: handle for the newly installed image
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001682 *
1683 * This function implements the LoadImage service.
Mario Six78a88f72018-07-10 08:40:17 +02001684 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001685 * See the Unified Extensible Firmware Interface (UEFI) specification
1686 * for details.
1687 *
Mario Six78a88f72018-07-10 08:40:17 +02001688 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001689 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09001690efi_status_t EFIAPI efi_load_image(bool boot_policy,
1691 efi_handle_t parent_image,
1692 struct efi_device_path *file_path,
1693 void *source_buffer,
1694 efi_uintn_t source_size,
1695 efi_handle_t *image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001696{
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001697 struct efi_device_path *dp, *fp;
Tom Rini1c3b2f42018-09-30 10:38:15 -04001698 struct efi_loaded_image *info = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001699 struct efi_loaded_image_obj **image_obj =
1700 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001701 efi_status_t ret;
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001702 void *dest_buffer;
Alexander Grafbee91162016-03-04 01:09:59 +01001703
Heinrich Schuchardt7fb96a12018-04-03 22:29:30 +02001704 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafbee91162016-03-04 01:09:59 +01001705 file_path, source_buffer, source_size, image_handle);
Rob Clark838ee4b2017-09-13 18:05:35 -04001706
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001707 if (!image_handle || !parent_image) {
1708 ret = EFI_INVALID_PARAMETER;
1709 goto error;
1710 }
1711
1712 if (!source_buffer && !file_path) {
1713 ret = EFI_NOT_FOUND;
1714 goto error;
1715 }
1716
Rob Clark838ee4b2017-09-13 18:05:35 -04001717 if (!source_buffer) {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001718 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001719 &source_size);
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001720 if (ret != EFI_SUCCESS)
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001721 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001722 } else {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001723 dest_buffer = source_buffer;
Rob Clark838ee4b2017-09-13 18:05:35 -04001724 }
Heinrich Schuchardt1e15a9c2019-04-20 19:24:43 +00001725 /* split file_path which contains both the device and file parts */
1726 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001727 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001728 if (ret == EFI_SUCCESS)
1729 ret = efi_load_pe(*image_obj, dest_buffer, info);
1730 if (!source_buffer)
1731 /* Release buffer to which file was loaded */
1732 efi_free_pages((uintptr_t)dest_buffer,
1733 efi_size_in_pages(source_size));
1734 if (ret == EFI_SUCCESS) {
1735 info->system_table = &systab;
1736 info->parent_handle = parent_image;
1737 } else {
1738 /* The image is invalid. Release all associated resources. */
1739 efi_delete_handle(*image_handle);
1740 *image_handle = NULL;
1741 free(info);
1742 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001743error:
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001744 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001745}
1746
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001747/**
Alexander Graff31239a2018-11-15 21:23:47 +01001748 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1749 */
1750static void efi_exit_caches(void)
1751{
1752#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1753 /*
1754 * Grub on 32bit ARM needs to have caches disabled before jumping into
1755 * a zImage, but does not know of all cache layers. Give it a hand.
1756 */
1757 if (efi_is_direct_boot)
1758 cleanup_before_linux();
1759#endif
1760}
1761
1762/**
Mario Six78a88f72018-07-10 08:40:17 +02001763 * efi_exit_boot_services() - stop all boot services
1764 * @image_handle: handle of the loaded image
1765 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001766 *
1767 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02001768 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001769 * See the Unified Extensible Firmware Interface (UEFI) specification
1770 * for details.
1771 *
Mario Six78a88f72018-07-10 08:40:17 +02001772 * All timer events are disabled. For exit boot services events the
1773 * notification function is called. The boot services are disabled in the
1774 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001775 *
Mario Six78a88f72018-07-10 08:40:17 +02001776 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001777 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001778static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01001779 unsigned long map_key)
1780{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001781 struct efi_event *evt;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001782
Alexander Grafbee91162016-03-04 01:09:59 +01001783 EFI_ENTRY("%p, %ld", image_handle, map_key);
1784
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001785 /* Check that the caller has read the current memory map */
1786 if (map_key != efi_memory_map_key)
1787 return EFI_INVALID_PARAMETER;
1788
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001789 /* Make sure that notification functions are not called anymore */
1790 efi_tpl = TPL_HIGH_LEVEL;
1791
1792 /* Check if ExitBootServices has already been called */
1793 if (!systab.boottime)
1794 return EFI_EXIT(EFI_SUCCESS);
1795
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001796 /* Add related events to the event group */
1797 list_for_each_entry(evt, &efi_events, link) {
1798 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1799 evt->group = &efi_guid_event_group_exit_boot_services;
1800 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001801 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001802 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001803 if (evt->group &&
1804 !guidcmp(evt->group,
1805 &efi_guid_event_group_exit_boot_services)) {
1806 efi_signal_event(evt, false);
1807 break;
1808 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001809 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001810
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001811 /* TODO: Should persist EFI variables here */
Rob Clarkad644e72017-09-13 18:05:37 -04001812
Alexander Grafb7b84102016-11-17 01:02:57 +01001813 board_quiesce_devices();
1814
Alexander Graff31239a2018-11-15 21:23:47 +01001815 /* Fix up caches for EFI payloads if necessary */
1816 efi_exit_caches();
1817
Alexander Grafbee91162016-03-04 01:09:59 +01001818 /* This stops all lingering devices */
1819 bootm_disable_interrupts();
1820
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001821 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001822 systab.con_in_handle = NULL;
1823 systab.con_in = NULL;
1824 systab.con_out_handle = NULL;
1825 systab.con_out = NULL;
1826 systab.stderr_handle = NULL;
1827 systab.std_err = NULL;
1828 systab.boottime = NULL;
1829
1830 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02001831 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001832
Alexander Grafbee91162016-03-04 01:09:59 +01001833 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001834 efi_set_watchdog(0);
Alexander Grafbee91162016-03-04 01:09:59 +01001835 WATCHDOG_RESET();
1836
1837 return EFI_EXIT(EFI_SUCCESS);
1838}
1839
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001840/**
Mario Six78a88f72018-07-10 08:40:17 +02001841 * efi_get_next_monotonic_count() - get next value of the counter
1842 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001843 *
1844 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001845 *
Mario Six78a88f72018-07-10 08:40:17 +02001846 * See the Unified Extensible Firmware Interface (UEFI) specification for
1847 * details.
1848 *
1849 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001850 */
Alexander Grafbee91162016-03-04 01:09:59 +01001851static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1852{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001853 static uint64_t mono;
1854
Alexander Grafbee91162016-03-04 01:09:59 +01001855 EFI_ENTRY("%p", count);
1856 *count = mono++;
1857 return EFI_EXIT(EFI_SUCCESS);
1858}
1859
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001860/**
Mario Six78a88f72018-07-10 08:40:17 +02001861 * efi_stall() - sleep
1862 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001863 *
Mario Six78a88f72018-07-10 08:40:17 +02001864 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001865 *
Mario Six78a88f72018-07-10 08:40:17 +02001866 * See the Unified Extensible Firmware Interface (UEFI) specification for
1867 * details.
1868 *
1869 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001870 */
Alexander Grafbee91162016-03-04 01:09:59 +01001871static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1872{
1873 EFI_ENTRY("%ld", microseconds);
1874 udelay(microseconds);
1875 return EFI_EXIT(EFI_SUCCESS);
1876}
1877
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001878/**
Mario Six78a88f72018-07-10 08:40:17 +02001879 * efi_set_watchdog_timer() - reset the watchdog timer
1880 * @timeout: seconds before reset by watchdog
1881 * @watchdog_code: code to be logged when resetting
1882 * @data_size: size of buffer in bytes
1883 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001884 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001885 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001886 *
Mario Six78a88f72018-07-10 08:40:17 +02001887 * See the Unified Extensible Firmware Interface (UEFI) specification for
1888 * details.
1889 *
1890 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001891 */
Alexander Grafbee91162016-03-04 01:09:59 +01001892static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1893 uint64_t watchdog_code,
1894 unsigned long data_size,
1895 uint16_t *watchdog_data)
1896{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09001897 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01001898 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001899 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01001900}
1901
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001902/**
Mario Six78a88f72018-07-10 08:40:17 +02001903 * efi_close_protocol() - close a protocol
1904 * @handle: handle on which the protocol shall be closed
1905 * @protocol: GUID of the protocol to close
1906 * @agent_handle: handle of the driver
1907 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001908 *
1909 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001910 *
Mario Six78a88f72018-07-10 08:40:17 +02001911 * See the Unified Extensible Firmware Interface (UEFI) specification for
1912 * details.
1913 *
1914 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001915 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001916static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001917 const efi_guid_t *protocol,
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001918 efi_handle_t agent_handle,
1919 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001920{
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001921 struct efi_handler *handler;
1922 struct efi_open_protocol_info_item *item;
1923 struct efi_open_protocol_info_item *pos;
1924 efi_status_t r;
1925
Rob Clark778e6af2017-09-13 18:05:41 -04001926 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01001927 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001928
1929 if (!agent_handle) {
1930 r = EFI_INVALID_PARAMETER;
1931 goto out;
1932 }
1933 r = efi_search_protocol(handle, protocol, &handler);
1934 if (r != EFI_SUCCESS)
1935 goto out;
1936
1937 r = EFI_NOT_FOUND;
1938 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1939 if (item->info.agent_handle == agent_handle &&
1940 item->info.controller_handle == controller_handle) {
1941 efi_delete_open_info(item);
1942 r = EFI_SUCCESS;
1943 break;
1944 }
1945 }
1946out:
1947 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001948}
1949
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001950/**
Mario Six78a88f72018-07-10 08:40:17 +02001951 * efi_open_protocol_information() - provide information about then open status
1952 * of a protocol on a handle
1953 * @handle: handle for which the information shall be retrieved
1954 * @protocol: GUID of the protocol
1955 * @entry_buffer: buffer to receive the open protocol information
1956 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001957 *
1958 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001959 *
Mario Six78a88f72018-07-10 08:40:17 +02001960 * See the Unified Extensible Firmware Interface (UEFI) specification for
1961 * details.
1962 *
1963 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001964 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001965static efi_status_t EFIAPI efi_open_protocol_information(
1966 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01001967 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001968 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01001969{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01001970 unsigned long buffer_size;
1971 unsigned long count;
1972 struct efi_handler *handler;
1973 struct efi_open_protocol_info_item *item;
1974 efi_status_t r;
1975
Rob Clark778e6af2017-09-13 18:05:41 -04001976 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01001977 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01001978
1979 /* Check parameters */
1980 if (!entry_buffer) {
1981 r = EFI_INVALID_PARAMETER;
1982 goto out;
1983 }
1984 r = efi_search_protocol(handle, protocol, &handler);
1985 if (r != EFI_SUCCESS)
1986 goto out;
1987
1988 /* Count entries */
1989 count = 0;
1990 list_for_each_entry(item, &handler->open_infos, link) {
1991 if (item->info.open_count)
1992 ++count;
1993 }
1994 *entry_count = count;
1995 *entry_buffer = NULL;
1996 if (!count) {
1997 r = EFI_SUCCESS;
1998 goto out;
1999 }
2000
2001 /* Copy entries */
2002 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002003 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002004 (void **)entry_buffer);
2005 if (r != EFI_SUCCESS)
2006 goto out;
2007 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2008 if (item->info.open_count)
2009 (*entry_buffer)[--count] = item->info;
2010 }
2011out:
2012 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002013}
2014
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002015/**
Mario Six78a88f72018-07-10 08:40:17 +02002016 * efi_protocols_per_handle() - get protocols installed on a handle
2017 * @handle: handle for which the information is retrieved
2018 * @protocol_buffer: buffer with protocol GUIDs
2019 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002020 *
2021 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002022 *
Mario Six78a88f72018-07-10 08:40:17 +02002023 * See the Unified Extensible Firmware Interface (UEFI) specification for
2024 * details.
2025 *
2026 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002027 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002028static efi_status_t EFIAPI efi_protocols_per_handle(
2029 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002030 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002031{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002032 unsigned long buffer_size;
2033 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002034 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002035 efi_status_t r;
2036
Alexander Grafbee91162016-03-04 01:09:59 +01002037 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2038 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002039
2040 if (!handle || !protocol_buffer || !protocol_buffer_count)
2041 return EFI_EXIT(EFI_INVALID_PARAMETER);
2042
2043 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002044 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002045
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002046 efiobj = efi_search_obj(handle);
2047 if (!efiobj)
2048 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002049
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002050 /* Count protocols */
2051 list_for_each(protocol_handle, &efiobj->protocols) {
2052 ++*protocol_buffer_count;
2053 }
2054
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002055 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002056 if (*protocol_buffer_count) {
2057 size_t j = 0;
2058
2059 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002060 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002061 (void **)protocol_buffer);
2062 if (r != EFI_SUCCESS)
2063 return EFI_EXIT(r);
2064 list_for_each(protocol_handle, &efiobj->protocols) {
2065 struct efi_handler *protocol;
2066
2067 protocol = list_entry(protocol_handle,
2068 struct efi_handler, link);
2069 (*protocol_buffer)[j] = (void *)protocol->guid;
2070 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002071 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002072 }
2073
2074 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002075}
2076
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002077/**
Mario Six78a88f72018-07-10 08:40:17 +02002078 * efi_locate_handle_buffer() - locate handles implementing a protocol
2079 * @search_type: selection criterion
2080 * @protocol: GUID of the protocol
2081 * @search_key: registration key
2082 * @no_handles: number of returned handles
2083 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002084 *
2085 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002086 *
Mario Six78a88f72018-07-10 08:40:17 +02002087 * See the Unified Extensible Firmware Interface (UEFI) specification for
2088 * details.
2089 *
2090 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002091 */
Alexander Grafbee91162016-03-04 01:09:59 +01002092static efi_status_t EFIAPI efi_locate_handle_buffer(
2093 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002094 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002095 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002096{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002097 efi_status_t r;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002098 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002099
Rob Clark778e6af2017-09-13 18:05:41 -04002100 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002101 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002102
2103 if (!no_handles || !buffer) {
2104 r = EFI_INVALID_PARAMETER;
2105 goto out;
2106 }
2107 *no_handles = 0;
2108 *buffer = NULL;
2109 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2110 *buffer);
2111 if (r != EFI_BUFFER_TOO_SMALL)
2112 goto out;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002113 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002114 (void **)buffer);
2115 if (r != EFI_SUCCESS)
2116 goto out;
2117 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2118 *buffer);
2119 if (r == EFI_SUCCESS)
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002120 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002121out:
2122 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002123}
2124
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002125/**
Mario Six78a88f72018-07-10 08:40:17 +02002126 * efi_locate_protocol() - find an interface implementing a protocol
2127 * @protocol: GUID of the protocol
2128 * @registration: registration key passed to the notification function
2129 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002130 *
2131 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002132 *
Mario Six78a88f72018-07-10 08:40:17 +02002133 * See the Unified Extensible Firmware Interface (UEFI) specification for
2134 * details.
2135 *
2136 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002137 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002138static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002139 void *registration,
2140 void **protocol_interface)
2141{
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002142 struct list_head *lhandle;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002143 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01002144
Rob Clark778e6af2017-09-13 18:05:41 -04002145 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002146
2147 if (!protocol || !protocol_interface)
2148 return EFI_EXIT(EFI_INVALID_PARAMETER);
2149
2150 list_for_each(lhandle, &efi_obj_list) {
2151 struct efi_object *efiobj;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002152 struct efi_handler *handler;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002153
2154 efiobj = list_entry(lhandle, struct efi_object, link);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002155
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002156 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002157 if (ret == EFI_SUCCESS) {
2158 *protocol_interface = handler->protocol_interface;
2159 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002160 }
2161 }
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002162 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002163
2164 return EFI_EXIT(EFI_NOT_FOUND);
2165}
2166
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002167/**
Mario Six78a88f72018-07-10 08:40:17 +02002168 * efi_locate_device_path() - Get the device path and handle of an device
2169 * implementing a protocol
2170 * @protocol: GUID of the protocol
2171 * @device_path: device path
2172 * @device: handle of the device
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002173 *
2174 * This function implements the LocateDevicePath service.
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002175 *
Mario Six78a88f72018-07-10 08:40:17 +02002176 * See the Unified Extensible Firmware Interface (UEFI) specification for
2177 * details.
2178 *
2179 * Return: status code
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002180 */
2181static efi_status_t EFIAPI efi_locate_device_path(
2182 const efi_guid_t *protocol,
2183 struct efi_device_path **device_path,
2184 efi_handle_t *device)
2185{
2186 struct efi_device_path *dp;
2187 size_t i;
2188 struct efi_handler *handler;
2189 efi_handle_t *handles;
2190 size_t len, len_dp;
2191 size_t len_best = 0;
2192 efi_uintn_t no_handles;
2193 u8 *remainder;
2194 efi_status_t ret;
2195
2196 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2197
2198 if (!protocol || !device_path || !*device_path || !device) {
2199 ret = EFI_INVALID_PARAMETER;
2200 goto out;
2201 }
2202
2203 /* Find end of device path */
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002204 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002205
2206 /* Get all handles implementing the protocol */
2207 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2208 &no_handles, &handles));
2209 if (ret != EFI_SUCCESS)
2210 goto out;
2211
2212 for (i = 0; i < no_handles; ++i) {
2213 /* Find the device path protocol */
2214 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2215 &handler);
2216 if (ret != EFI_SUCCESS)
2217 continue;
2218 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002219 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002220 /*
2221 * This handle can only be a better fit
2222 * if its device path length is longer than the best fit and
2223 * if its device path length is shorter of equal the searched
2224 * device path.
2225 */
2226 if (len_dp <= len_best || len_dp > len)
2227 continue;
2228 /* Check if dp is a subpath of device_path */
2229 if (memcmp(*device_path, dp, len_dp))
2230 continue;
2231 *device = handles[i];
2232 len_best = len_dp;
2233 }
2234 if (len_best) {
2235 remainder = (u8 *)*device_path + len_best;
2236 *device_path = (struct efi_device_path *)remainder;
2237 ret = EFI_SUCCESS;
2238 } else {
2239 ret = EFI_NOT_FOUND;
2240 }
2241out:
2242 return EFI_EXIT(ret);
2243}
2244
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002245/**
Mario Six78a88f72018-07-10 08:40:17 +02002246 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2247 * interfaces
2248 * @handle: handle on which the protocol interfaces shall be installed
2249 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2250 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002251 *
2252 * This function implements the MultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002253 *
Mario Six78a88f72018-07-10 08:40:17 +02002254 * See the Unified Extensible Firmware Interface (UEFI) specification for
2255 * details.
2256 *
2257 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002258 */
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +02002259efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002260 (efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002261{
2262 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002263
Alexander Grafbeb077a2018-06-18 17:23:05 +02002264 efi_va_list argptr;
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002265 const efi_guid_t *protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002266 void *protocol_interface;
2267 efi_status_t r = EFI_SUCCESS;
2268 int i = 0;
2269
2270 if (!handle)
2271 return EFI_EXIT(EFI_INVALID_PARAMETER);
2272
Alexander Grafbeb077a2018-06-18 17:23:05 +02002273 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002274 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002275 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002276 if (!protocol)
2277 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002278 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01002279 r = EFI_CALL(efi_install_protocol_interface(
2280 handle, protocol,
2281 EFI_NATIVE_INTERFACE,
2282 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002283 if (r != EFI_SUCCESS)
2284 break;
2285 i++;
2286 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002287 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002288 if (r == EFI_SUCCESS)
2289 return EFI_EXIT(r);
2290
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002291 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002292 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002293 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002294 protocol = efi_va_arg(argptr, efi_guid_t*);
2295 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002296 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01002297 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002298 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002299 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002300
2301 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002302}
2303
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002304/**
Mario Six78a88f72018-07-10 08:40:17 +02002305 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2306 * interfaces
2307 * @handle: handle from which the protocol interfaces shall be removed
2308 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2309 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002310 *
2311 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002312 *
Mario Six78a88f72018-07-10 08:40:17 +02002313 * See the Unified Extensible Firmware Interface (UEFI) specification for
2314 * details.
2315 *
2316 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002317 */
Alexander Grafbee91162016-03-04 01:09:59 +01002318static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002319 efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002320{
2321 EFI_ENTRY("%p", handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002322
Alexander Grafbeb077a2018-06-18 17:23:05 +02002323 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002324 const efi_guid_t *protocol;
2325 void *protocol_interface;
2326 efi_status_t r = EFI_SUCCESS;
2327 size_t i = 0;
2328
2329 if (!handle)
2330 return EFI_EXIT(EFI_INVALID_PARAMETER);
2331
Alexander Grafbeb077a2018-06-18 17:23:05 +02002332 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002333 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002334 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002335 if (!protocol)
2336 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002337 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002338 r = efi_uninstall_protocol(handle, protocol,
2339 protocol_interface);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002340 if (r != EFI_SUCCESS)
2341 break;
2342 i++;
2343 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002344 efi_va_end(argptr);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002345 if (r == EFI_SUCCESS) {
2346 /* If the last protocol has been removed, delete the handle. */
2347 if (list_empty(&handle->protocols)) {
2348 list_del(&handle->link);
2349 free(handle);
2350 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002351 return EFI_EXIT(r);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002352 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002353
2354 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002355 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002356 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002357 protocol = efi_va_arg(argptr, efi_guid_t*);
2358 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002359 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2360 EFI_NATIVE_INTERFACE,
2361 protocol_interface));
2362 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002363 efi_va_end(argptr);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002364
Heinrich Schuchardte2373022018-09-24 19:57:27 +02002365 /* In case of an error always return EFI_INVALID_PARAMETER */
2366 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafbee91162016-03-04 01:09:59 +01002367}
2368
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002369/**
Mario Six78a88f72018-07-10 08:40:17 +02002370 * efi_calculate_crc32() - calculate cyclic redundancy code
2371 * @data: buffer with data
2372 * @data_size: size of buffer in bytes
2373 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002374 *
2375 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002376 *
Mario Six78a88f72018-07-10 08:40:17 +02002377 * See the Unified Extensible Firmware Interface (UEFI) specification for
2378 * details.
2379 *
2380 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002381 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002382static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2383 efi_uintn_t data_size,
2384 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002385{
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002386 EFI_ENTRY("%p, %zu", data, data_size);
Alexander Grafbee91162016-03-04 01:09:59 +01002387 *crc32_p = crc32(0, data, data_size);
2388 return EFI_EXIT(EFI_SUCCESS);
2389}
2390
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002391/**
Mario Six78a88f72018-07-10 08:40:17 +02002392 * efi_copy_mem() - copy memory
2393 * @destination: destination of the copy operation
2394 * @source: source of the copy operation
2395 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002396 *
2397 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002398 *
Mario Six78a88f72018-07-10 08:40:17 +02002399 * See the Unified Extensible Firmware Interface (UEFI) specification for
2400 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002401 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002402static void EFIAPI efi_copy_mem(void *destination, const void *source,
2403 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002404{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002405 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002406 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002407 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002408}
2409
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002410/**
Mario Six78a88f72018-07-10 08:40:17 +02002411 * efi_set_mem() - Fill memory with a byte value.
2412 * @buffer: buffer to fill
2413 * @size: size of buffer in bytes
2414 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002415 *
2416 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002417 *
Mario Six78a88f72018-07-10 08:40:17 +02002418 * See the Unified Extensible Firmware Interface (UEFI) specification for
2419 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002420 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002421static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002422{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002423 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002424 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002425 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002426}
2427
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002428/**
Mario Six78a88f72018-07-10 08:40:17 +02002429 * efi_protocol_open() - open protocol interface on a handle
2430 * @handler: handler of a protocol
2431 * @protocol_interface: interface implementing the protocol
2432 * @agent_handle: handle of the driver
2433 * @controller_handle: handle of the controller
2434 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002435 *
Mario Six78a88f72018-07-10 08:40:17 +02002436 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002437 */
2438static efi_status_t efi_protocol_open(
2439 struct efi_handler *handler,
2440 void **protocol_interface, void *agent_handle,
2441 void *controller_handle, uint32_t attributes)
2442{
2443 struct efi_open_protocol_info_item *item;
2444 struct efi_open_protocol_info_entry *match = NULL;
2445 bool opened_by_driver = false;
2446 bool opened_exclusive = false;
2447
2448 /* If there is no agent, only return the interface */
2449 if (!agent_handle)
2450 goto out;
2451
2452 /* For TEST_PROTOCOL ignore interface attribute */
2453 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2454 *protocol_interface = NULL;
2455
2456 /*
2457 * Check if the protocol is already opened by a driver with the same
2458 * attributes or opened exclusively
2459 */
2460 list_for_each_entry(item, &handler->open_infos, link) {
2461 if (item->info.agent_handle == agent_handle) {
2462 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2463 (item->info.attributes == attributes))
2464 return EFI_ALREADY_STARTED;
2465 }
2466 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2467 opened_exclusive = true;
2468 }
2469
2470 /* Only one controller can open the protocol exclusively */
2471 if (opened_exclusive && attributes &
2472 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2473 return EFI_ACCESS_DENIED;
2474
2475 /* Prepare exclusive opening */
2476 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2477 /* Try to disconnect controllers */
2478 list_for_each_entry(item, &handler->open_infos, link) {
2479 if (item->info.attributes ==
2480 EFI_OPEN_PROTOCOL_BY_DRIVER)
2481 EFI_CALL(efi_disconnect_controller(
2482 item->info.controller_handle,
2483 item->info.agent_handle,
2484 NULL));
2485 }
2486 opened_by_driver = false;
2487 /* Check if all controllers are disconnected */
2488 list_for_each_entry(item, &handler->open_infos, link) {
2489 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2490 opened_by_driver = true;
2491 }
Heinrich Schuchardt4f37fa42018-09-30 13:40:43 +02002492 /* Only one controller can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002493 if (opened_by_driver)
2494 return EFI_ACCESS_DENIED;
2495 }
2496
2497 /* Find existing entry */
2498 list_for_each_entry(item, &handler->open_infos, link) {
2499 if (item->info.agent_handle == agent_handle &&
2500 item->info.controller_handle == controller_handle)
2501 match = &item->info;
2502 }
2503 /* None found, create one */
2504 if (!match) {
2505 match = efi_create_open_info(handler);
2506 if (!match)
2507 return EFI_OUT_OF_RESOURCES;
2508 }
2509
2510 match->agent_handle = agent_handle;
2511 match->controller_handle = controller_handle;
2512 match->attributes = attributes;
2513 match->open_count++;
2514
2515out:
2516 /* For TEST_PROTOCOL ignore interface attribute. */
2517 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2518 *protocol_interface = handler->protocol_interface;
2519
2520 return EFI_SUCCESS;
2521}
2522
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002523/**
Mario Six78a88f72018-07-10 08:40:17 +02002524 * efi_open_protocol() - open protocol interface on a handle
2525 * @handle: handle on which the protocol shall be opened
2526 * @protocol: GUID of the protocol
2527 * @protocol_interface: interface implementing the protocol
2528 * @agent_handle: handle of the driver
2529 * @controller_handle: handle of the controller
2530 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002531 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002532 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002533 *
Mario Six78a88f72018-07-10 08:40:17 +02002534 * See the Unified Extensible Firmware Interface (UEFI) specification for
2535 * details.
2536 *
2537 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002538 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002539static efi_status_t EFIAPI efi_open_protocol
2540 (efi_handle_t handle, const efi_guid_t *protocol,
2541 void **protocol_interface, efi_handle_t agent_handle,
2542 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01002543{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002544 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002545 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01002546
Rob Clark778e6af2017-09-13 18:05:41 -04002547 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002548 protocol_interface, agent_handle, controller_handle,
2549 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002550
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002551 if (!handle || !protocol ||
2552 (!protocol_interface && attributes !=
2553 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2554 goto out;
2555 }
2556
2557 switch (attributes) {
2558 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2559 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2560 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2561 break;
2562 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2563 if (controller_handle == handle)
2564 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002565 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002566 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2567 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002568 /* Check that the controller handle is valid */
2569 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002570 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002571 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002572 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002573 /* Check that the agent handle is valid */
2574 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002575 goto out;
2576 break;
2577 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002578 goto out;
2579 }
2580
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002581 r = efi_search_protocol(handle, protocol, &handler);
2582 if (r != EFI_SUCCESS)
2583 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01002584
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002585 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2586 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01002587out:
2588 return EFI_EXIT(r);
2589}
2590
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002591/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002592 * efi_start_image() - call the entry point of an image
2593 * @image_handle: handle of the image
2594 * @exit_data_size: size of the buffer
2595 * @exit_data: buffer to receive the exit data of the called image
2596 *
2597 * This function implements the StartImage service.
2598 *
2599 * See the Unified Extensible Firmware Interface (UEFI) specification for
2600 * details.
2601 *
2602 * Return: status code
2603 */
2604efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2605 efi_uintn_t *exit_data_size,
2606 u16 **exit_data)
2607{
2608 struct efi_loaded_image_obj *image_obj =
2609 (struct efi_loaded_image_obj *)image_handle;
2610 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002611 void *info;
2612 efi_handle_t parent_image = current_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002613
2614 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2615
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002616 /* Check parameters */
2617 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2618 &info, NULL, NULL,
2619 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2620 if (ret != EFI_SUCCESS)
2621 return EFI_EXIT(EFI_INVALID_PARAMETER);
2622
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002623 efi_is_direct_boot = false;
2624
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002625 image_obj->exit_data_size = exit_data_size;
2626 image_obj->exit_data = exit_data;
2627
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002628 /* call the image! */
2629 if (setjmp(&image_obj->exit_jmp)) {
2630 /*
2631 * We called the entry point of the child image with EFI_CALL
2632 * in the lines below. The child image called the Exit() boot
2633 * service efi_exit() which executed the long jump that brought
2634 * us to the current line. This implies that the second half
2635 * of the EFI_CALL macro has not been executed.
2636 */
2637#ifdef CONFIG_ARM
2638 /*
2639 * efi_exit() called efi_restore_gd(). We have to undo this
2640 * otherwise __efi_entry_check() will put the wrong value into
2641 * app_gd.
2642 */
2643 gd = app_gd;
2644#endif
2645 /*
2646 * To get ready to call EFI_EXIT below we have to execute the
2647 * missed out steps of EFI_CALL.
2648 */
2649 assert(__efi_entry_check());
2650 debug("%sEFI: %lu returned by started image\n",
2651 __efi_nesting_dec(),
2652 (unsigned long)((uintptr_t)image_obj->exit_status &
2653 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002654 current_image = parent_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002655 return EFI_EXIT(image_obj->exit_status);
2656 }
2657
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002658 current_image = image_handle;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02002659 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09002660 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002661 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2662
2663 /*
2664 * Usually UEFI applications call Exit() instead of returning.
2665 * But because the world doesn't consist of ponies and unicorns,
2666 * we're happy to emulate that behavior on behalf of a payload
2667 * that forgot.
2668 */
2669 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2670}
2671
2672/**
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002673 * efi_unload_image() - unload an EFI image
2674 * @image_handle: handle of the image to be unloaded
2675 *
2676 * This function implements the UnloadImage service.
2677 *
2678 * See the Unified Extensible Firmware Interface (UEFI) specification for
2679 * details.
2680 *
2681 * Return: status code
2682 */
2683efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2684{
2685 struct efi_object *efiobj;
2686
2687 EFI_ENTRY("%p", image_handle);
2688 efiobj = efi_search_obj(image_handle);
2689 if (efiobj)
2690 list_del(&efiobj->link);
2691
2692 return EFI_EXIT(EFI_SUCCESS);
2693}
2694
2695/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002696 * efi_update_exit_data() - fill exit data parameters of StartImage()
2697 *
2698 * @image_obj image handle
2699 * @exit_data_size size of the exit data buffer
2700 * @exit_data buffer with data returned by UEFI payload
2701 * Return: status code
2702 */
2703static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2704 efi_uintn_t exit_data_size,
2705 u16 *exit_data)
2706{
2707 efi_status_t ret;
2708
2709 /*
2710 * If exit_data is not provided to StartImage(), exit_data_size must be
2711 * ignored.
2712 */
2713 if (!image_obj->exit_data)
2714 return EFI_SUCCESS;
2715 if (image_obj->exit_data_size)
2716 *image_obj->exit_data_size = exit_data_size;
2717 if (exit_data_size && exit_data) {
2718 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2719 exit_data_size,
2720 (void **)image_obj->exit_data);
2721 if (ret != EFI_SUCCESS)
2722 return ret;
2723 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2724 } else {
2725 image_obj->exit_data = NULL;
2726 }
2727 return EFI_SUCCESS;
2728}
2729
2730/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002731 * efi_exit() - leave an EFI application or driver
2732 * @image_handle: handle of the application or driver that is exiting
2733 * @exit_status: status code
2734 * @exit_data_size: size of the buffer in bytes
2735 * @exit_data: buffer with data describing an error
2736 *
2737 * This function implements the Exit service.
2738 *
2739 * See the Unified Extensible Firmware Interface (UEFI) specification for
2740 * details.
2741 *
2742 * Return: status code
2743 */
2744static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2745 efi_status_t exit_status,
2746 efi_uintn_t exit_data_size,
2747 u16 *exit_data)
2748{
2749 /*
2750 * TODO: We should call the unload procedure of the loaded
2751 * image protocol.
2752 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002753 efi_status_t ret;
2754 void *info;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002755 struct efi_loaded_image_obj *image_obj =
2756 (struct efi_loaded_image_obj *)image_handle;
2757
2758 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2759 exit_data_size, exit_data);
2760
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002761 /* Check parameters */
2762 if (image_handle != current_image)
2763 goto out;
2764 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2765 &info, NULL, NULL,
2766 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2767 if (ret != EFI_SUCCESS)
2768 goto out;
2769
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002770 /* Exit data is only foreseen in case of failure. */
2771 if (exit_status != EFI_SUCCESS) {
2772 ret = efi_update_exit_data(image_obj, exit_data_size,
2773 exit_data);
2774 /* Exiting has priority. Don't return error to caller. */
2775 if (ret != EFI_SUCCESS)
2776 EFI_PRINT("%s: out of memory\n", __func__);
2777 }
2778
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002779 /* Make sure entry/exit counts for EFI world cross-overs match */
2780 EFI_EXIT(exit_status);
2781
2782 /*
2783 * But longjmp out with the U-Boot gd, not the application's, as
2784 * the other end is a setjmp call inside EFI context.
2785 */
2786 efi_restore_gd();
2787
2788 image_obj->exit_status = exit_status;
2789 longjmp(&image_obj->exit_jmp, 1);
2790
2791 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002792out:
2793 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002794}
2795
2796/**
Mario Six78a88f72018-07-10 08:40:17 +02002797 * efi_handle_protocol() - get interface of a protocol on a handle
2798 * @handle: handle on which the protocol shall be opened
2799 * @protocol: GUID of the protocol
2800 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002801 *
2802 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002803 *
Mario Six78a88f72018-07-10 08:40:17 +02002804 * See the Unified Extensible Firmware Interface (UEFI) specification for
2805 * details.
2806 *
2807 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002808 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002809static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002810 const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002811 void **protocol_interface)
2812{
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02002813 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2814 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01002815}
2816
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002817/**
Mario Six78a88f72018-07-10 08:40:17 +02002818 * efi_bind_controller() - bind a single driver to a controller
2819 * @controller_handle: controller handle
2820 * @driver_image_handle: driver handle
2821 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002822 *
Mario Six78a88f72018-07-10 08:40:17 +02002823 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002824 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002825static efi_status_t efi_bind_controller(
2826 efi_handle_t controller_handle,
2827 efi_handle_t driver_image_handle,
2828 struct efi_device_path *remain_device_path)
2829{
2830 struct efi_driver_binding_protocol *binding_protocol;
2831 efi_status_t r;
2832
2833 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2834 &efi_guid_driver_binding_protocol,
2835 (void **)&binding_protocol,
2836 driver_image_handle, NULL,
2837 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2838 if (r != EFI_SUCCESS)
2839 return r;
2840 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2841 controller_handle,
2842 remain_device_path));
2843 if (r == EFI_SUCCESS)
2844 r = EFI_CALL(binding_protocol->start(binding_protocol,
2845 controller_handle,
2846 remain_device_path));
2847 EFI_CALL(efi_close_protocol(driver_image_handle,
2848 &efi_guid_driver_binding_protocol,
2849 driver_image_handle, NULL));
2850 return r;
2851}
2852
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002853/**
Mario Six78a88f72018-07-10 08:40:17 +02002854 * efi_connect_single_controller() - connect a single driver to a controller
2855 * @controller_handle: controller
2856 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002857 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002858 *
Mario Six78a88f72018-07-10 08:40:17 +02002859 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002860 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002861static efi_status_t efi_connect_single_controller(
2862 efi_handle_t controller_handle,
2863 efi_handle_t *driver_image_handle,
2864 struct efi_device_path *remain_device_path)
2865{
2866 efi_handle_t *buffer;
2867 size_t count;
2868 size_t i;
2869 efi_status_t r;
2870 size_t connected = 0;
2871
2872 /* Get buffer with all handles with driver binding protocol */
2873 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2874 &efi_guid_driver_binding_protocol,
2875 NULL, &count, &buffer));
2876 if (r != EFI_SUCCESS)
2877 return r;
2878
2879 /* Context Override */
2880 if (driver_image_handle) {
2881 for (; *driver_image_handle; ++driver_image_handle) {
2882 for (i = 0; i < count; ++i) {
2883 if (buffer[i] == *driver_image_handle) {
2884 buffer[i] = NULL;
2885 r = efi_bind_controller(
2886 controller_handle,
2887 *driver_image_handle,
2888 remain_device_path);
2889 /*
2890 * For drivers that do not support the
2891 * controller or are already connected
2892 * we receive an error code here.
2893 */
2894 if (r == EFI_SUCCESS)
2895 ++connected;
2896 }
2897 }
2898 }
2899 }
2900
2901 /*
2902 * TODO: Some overrides are not yet implemented:
2903 * - Platform Driver Override
2904 * - Driver Family Override Search
2905 * - Bus Specific Driver Override
2906 */
2907
2908 /* Driver Binding Search */
2909 for (i = 0; i < count; ++i) {
2910 if (buffer[i]) {
2911 r = efi_bind_controller(controller_handle,
2912 buffer[i],
2913 remain_device_path);
2914 if (r == EFI_SUCCESS)
2915 ++connected;
2916 }
2917 }
2918
2919 efi_free_pool(buffer);
2920 if (!connected)
2921 return EFI_NOT_FOUND;
2922 return EFI_SUCCESS;
2923}
2924
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002925/**
Mario Six78a88f72018-07-10 08:40:17 +02002926 * efi_connect_controller() - connect a controller to a driver
2927 * @controller_handle: handle of the controller
2928 * @driver_image_handle: handle of the driver
2929 * @remain_device_path: device path of a child controller
2930 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002931 *
2932 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02002933 *
2934 * See the Unified Extensible Firmware Interface (UEFI) specification for
2935 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002936 *
2937 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002938 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002939 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2940 *
Mario Six78a88f72018-07-10 08:40:17 +02002941 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002942 */
2943static efi_status_t EFIAPI efi_connect_controller(
2944 efi_handle_t controller_handle,
2945 efi_handle_t *driver_image_handle,
2946 struct efi_device_path *remain_device_path,
2947 bool recursive)
2948{
2949 efi_status_t r;
2950 efi_status_t ret = EFI_NOT_FOUND;
2951 struct efi_object *efiobj;
2952
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01002953 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002954 remain_device_path, recursive);
2955
2956 efiobj = efi_search_obj(controller_handle);
2957 if (!efiobj) {
2958 ret = EFI_INVALID_PARAMETER;
2959 goto out;
2960 }
2961
2962 r = efi_connect_single_controller(controller_handle,
2963 driver_image_handle,
2964 remain_device_path);
2965 if (r == EFI_SUCCESS)
2966 ret = EFI_SUCCESS;
2967 if (recursive) {
2968 struct efi_handler *handler;
2969 struct efi_open_protocol_info_item *item;
2970
2971 list_for_each_entry(handler, &efiobj->protocols, link) {
2972 list_for_each_entry(item, &handler->open_infos, link) {
2973 if (item->info.attributes &
2974 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2975 r = EFI_CALL(efi_connect_controller(
2976 item->info.controller_handle,
2977 driver_image_handle,
2978 remain_device_path,
2979 recursive));
2980 if (r == EFI_SUCCESS)
2981 ret = EFI_SUCCESS;
2982 }
2983 }
2984 }
2985 }
2986 /* Check for child controller specified by end node */
2987 if (ret != EFI_SUCCESS && remain_device_path &&
2988 remain_device_path->type == DEVICE_PATH_TYPE_END)
2989 ret = EFI_SUCCESS;
2990out:
2991 return EFI_EXIT(ret);
2992}
2993
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002994/**
Mario Six78a88f72018-07-10 08:40:17 +02002995 * efi_reinstall_protocol_interface() - reinstall protocol interface
2996 * @handle: handle on which the protocol shall be reinstalled
2997 * @protocol: GUID of the protocol to be installed
2998 * @old_interface: interface to be removed
2999 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003000 *
3001 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02003002 *
3003 * See the Unified Extensible Firmware Interface (UEFI) specification for
3004 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003005 *
3006 * The old interface is uninstalled. The new interface is installed.
3007 * Drivers are connected.
3008 *
Mario Six78a88f72018-07-10 08:40:17 +02003009 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003010 */
3011static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3012 efi_handle_t handle, const efi_guid_t *protocol,
3013 void *old_interface, void *new_interface)
3014{
3015 efi_status_t ret;
3016
3017 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3018 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003019
3020 /* Uninstall protocol but do not delete handle */
3021 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003022 if (ret != EFI_SUCCESS)
3023 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003024
3025 /* Install the new protocol */
3026 ret = efi_add_protocol(handle, protocol, new_interface);
3027 /*
3028 * The UEFI spec does not specify what should happen to the handle
3029 * if in case of an error no protocol interface remains on the handle.
3030 * So let's do nothing here.
3031 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003032 if (ret != EFI_SUCCESS)
3033 goto out;
3034 /*
3035 * The returned status code has to be ignored.
3036 * Do not create an error if no suitable driver for the handle exists.
3037 */
3038 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3039out:
3040 return EFI_EXIT(ret);
3041}
3042
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003043/**
Mario Six78a88f72018-07-10 08:40:17 +02003044 * efi_get_child_controllers() - get all child controllers associated to a driver
3045 * @efiobj: handle of the controller
3046 * @driver_handle: handle of the driver
3047 * @number_of_children: number of child controllers
3048 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003049 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003050 * The allocated buffer has to be freed with free().
3051 *
Mario Six78a88f72018-07-10 08:40:17 +02003052 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003053 */
3054static efi_status_t efi_get_child_controllers(
3055 struct efi_object *efiobj,
3056 efi_handle_t driver_handle,
3057 efi_uintn_t *number_of_children,
3058 efi_handle_t **child_handle_buffer)
3059{
3060 struct efi_handler *handler;
3061 struct efi_open_protocol_info_item *item;
3062 efi_uintn_t count = 0, i;
3063 bool duplicate;
3064
3065 /* Count all child controller associations */
3066 list_for_each_entry(handler, &efiobj->protocols, link) {
3067 list_for_each_entry(item, &handler->open_infos, link) {
3068 if (item->info.agent_handle == driver_handle &&
3069 item->info.attributes &
3070 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3071 ++count;
3072 }
3073 }
3074 /*
3075 * Create buffer. In case of duplicate child controller assignments
3076 * the buffer will be too large. But that does not harm.
3077 */
3078 *number_of_children = 0;
3079 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3080 if (!*child_handle_buffer)
3081 return EFI_OUT_OF_RESOURCES;
3082 /* Copy unique child handles */
3083 list_for_each_entry(handler, &efiobj->protocols, link) {
3084 list_for_each_entry(item, &handler->open_infos, link) {
3085 if (item->info.agent_handle == driver_handle &&
3086 item->info.attributes &
3087 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3088 /* Check this is a new child controller */
3089 duplicate = false;
3090 for (i = 0; i < *number_of_children; ++i) {
3091 if ((*child_handle_buffer)[i] ==
3092 item->info.controller_handle)
3093 duplicate = true;
3094 }
3095 /* Copy handle to buffer */
3096 if (!duplicate) {
3097 i = (*number_of_children)++;
3098 (*child_handle_buffer)[i] =
3099 item->info.controller_handle;
3100 }
3101 }
3102 }
3103 }
3104 return EFI_SUCCESS;
3105}
3106
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003107/**
Mario Six78a88f72018-07-10 08:40:17 +02003108 * efi_disconnect_controller() - disconnect a controller from a driver
3109 * @controller_handle: handle of the controller
3110 * @driver_image_handle: handle of the driver
3111 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003112 *
3113 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003114 *
Mario Six78a88f72018-07-10 08:40:17 +02003115 * See the Unified Extensible Firmware Interface (UEFI) specification for
3116 * details.
3117 *
3118 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003119 */
3120static efi_status_t EFIAPI efi_disconnect_controller(
3121 efi_handle_t controller_handle,
3122 efi_handle_t driver_image_handle,
3123 efi_handle_t child_handle)
3124{
3125 struct efi_driver_binding_protocol *binding_protocol;
3126 efi_handle_t *child_handle_buffer = NULL;
3127 size_t number_of_children = 0;
3128 efi_status_t r;
3129 size_t stop_count = 0;
3130 struct efi_object *efiobj;
3131
3132 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3133 child_handle);
3134
3135 efiobj = efi_search_obj(controller_handle);
3136 if (!efiobj) {
3137 r = EFI_INVALID_PARAMETER;
3138 goto out;
3139 }
3140
3141 if (child_handle && !efi_search_obj(child_handle)) {
3142 r = EFI_INVALID_PARAMETER;
3143 goto out;
3144 }
3145
3146 /* If no driver handle is supplied, disconnect all drivers */
3147 if (!driver_image_handle) {
3148 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3149 goto out;
3150 }
3151
3152 /* Create list of child handles */
3153 if (child_handle) {
3154 number_of_children = 1;
3155 child_handle_buffer = &child_handle;
3156 } else {
3157 efi_get_child_controllers(efiobj,
3158 driver_image_handle,
3159 &number_of_children,
3160 &child_handle_buffer);
3161 }
3162
3163 /* Get the driver binding protocol */
3164 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3165 &efi_guid_driver_binding_protocol,
3166 (void **)&binding_protocol,
3167 driver_image_handle, NULL,
3168 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3169 if (r != EFI_SUCCESS)
3170 goto out;
3171 /* Remove the children */
3172 if (number_of_children) {
3173 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3174 controller_handle,
3175 number_of_children,
3176 child_handle_buffer));
3177 if (r == EFI_SUCCESS)
3178 ++stop_count;
3179 }
3180 /* Remove the driver */
3181 if (!child_handle)
3182 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3183 controller_handle,
3184 0, NULL));
3185 if (r == EFI_SUCCESS)
3186 ++stop_count;
3187 EFI_CALL(efi_close_protocol(driver_image_handle,
3188 &efi_guid_driver_binding_protocol,
3189 driver_image_handle, NULL));
3190
3191 if (stop_count)
3192 r = EFI_SUCCESS;
3193 else
3194 r = EFI_NOT_FOUND;
3195out:
3196 if (!child_handle)
3197 free(child_handle_buffer);
3198 return EFI_EXIT(r);
3199}
3200
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003201static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003202 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003203 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3204 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003205 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003206 },
3207 .raise_tpl = efi_raise_tpl,
3208 .restore_tpl = efi_restore_tpl,
3209 .allocate_pages = efi_allocate_pages_ext,
3210 .free_pages = efi_free_pages_ext,
3211 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003212 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003213 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003214 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003215 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003216 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003217 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003218 .close_event = efi_close_event,
3219 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003220 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003221 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003222 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003223 .handle_protocol = efi_handle_protocol,
3224 .reserved = NULL,
3225 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003226 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003227 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003228 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003229 .load_image = efi_load_image,
3230 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003231 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003232 .unload_image = efi_unload_image,
3233 .exit_boot_services = efi_exit_boot_services,
3234 .get_next_monotonic_count = efi_get_next_monotonic_count,
3235 .stall = efi_stall,
3236 .set_watchdog_timer = efi_set_watchdog_timer,
3237 .connect_controller = efi_connect_controller,
3238 .disconnect_controller = efi_disconnect_controller,
3239 .open_protocol = efi_open_protocol,
3240 .close_protocol = efi_close_protocol,
3241 .open_protocol_information = efi_open_protocol_information,
3242 .protocols_per_handle = efi_protocols_per_handle,
3243 .locate_handle_buffer = efi_locate_handle_buffer,
3244 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003245 .install_multiple_protocol_interfaces =
3246 efi_install_multiple_protocol_interfaces,
3247 .uninstall_multiple_protocol_interfaces =
3248 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafbee91162016-03-04 01:09:59 +01003249 .calculate_crc32 = efi_calculate_crc32,
3250 .copy_mem = efi_copy_mem,
3251 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003252 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003253};
3254
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003255static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01003256
Alexander Graf3c63db92016-10-14 13:45:30 +02003257struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01003258 .hdr = {
3259 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003260 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003261 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01003262 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003263 .fw_vendor = firmware_vendor,
3264 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003265 .con_in = (void *)&efi_con_in,
3266 .con_out = (void *)&efi_con_out,
3267 .std_err = (void *)&efi_con_out,
3268 .runtime = (void *)&efi_runtime_services,
3269 .boottime = (void *)&efi_boot_services,
Alexander Grafbee91162016-03-04 01:09:59 +01003270 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003271 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01003272};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003273
3274/**
3275 * efi_initialize_system_table() - Initialize system table
3276 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02003277 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003278 */
3279efi_status_t efi_initialize_system_table(void)
3280{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003281 efi_status_t ret;
3282
3283 /* Allocate configuration table array */
3284 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3285 EFI_MAX_CONFIGURATION_TABLES *
3286 sizeof(struct efi_configuration_table),
3287 (void **)&systab.tables);
3288
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003289 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003290 efi_update_table_header_crc32(&systab.hdr);
3291 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3292 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003293
3294 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003295}