blob: 194df5a180db14a0e532478ae3d21689e099bfe0 [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Grafbee91162016-03-04 01:09:59 +01002/*
3 * EFI application boot time services
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafbee91162016-03-04 01:09:59 +01006 */
7
Alexander Grafbee91162016-03-04 01:09:59 +01008#include <common.h>
Heinrich Schuchardt7d963322017-10-05 16:14:14 +02009#include <div64.h>
Alexander Grafbee91162016-03-04 01:09:59 +010010#include <efi_loader.h>
Rob Clarkad644e72017-09-13 18:05:37 -040011#include <environment.h>
Alexander Grafbee91162016-03-04 01:09:59 +010012#include <malloc.h>
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090013#include <linux/libfdt_env.h>
Alexander Grafbee91162016-03-04 01:09:59 +010014#include <u-boot/crc.h>
15#include <bootm.h>
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +020016#include <pe.h>
Alexander Grafbee91162016-03-04 01:09:59 +010017#include <watchdog.h>
18
19DECLARE_GLOBAL_DATA_PTR;
20
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020021/* Task priority level */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +010022static efi_uintn_t efi_tpl = TPL_APPLICATION;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +020023
Alexander Grafbee91162016-03-04 01:09:59 +010024/* This list contains all the EFI objects our payload has access to */
25LIST_HEAD(efi_obj_list);
26
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010027/* List of all events */
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +010028LIST_HEAD(efi_events);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +010029
Heinrich Schuchardtab15d412019-05-04 17:27:54 +020030/* List of all events registered by RegisterProtocolNotify() */
31LIST_HEAD(efi_register_notify_events);
32
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +010033/* Handle of the currently executing image */
34static efi_handle_t current_image;
35
Alexander Graff31239a2018-11-15 21:23:47 +010036/*
37 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
38 * we need to do trickery with caches. Since we don't want to break the EFI
39 * aware boot path, only apply hacks when loading exiting directly (breaking
40 * direct Linux EFI booting along the way - oh well).
41 */
42static bool efi_is_direct_boot = true;
43
Simon Glass65e4c0b2016-09-25 15:27:35 -060044#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +010045/*
46 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
47 * fixed when compiling U-Boot. However, the payload does not know about that
48 * restriction so we need to manually swap its and our view of that register on
49 * EFI callback entry/exit.
50 */
51static volatile void *efi_gd, *app_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -060052#endif
Alexander Grafbee91162016-03-04 01:09:59 +010053
Heinrich Schuchardt914df752019-02-09 14:10:39 +010054/* 1 if inside U-Boot code, 0 if inside EFI payload code */
55static int entry_count = 1;
Rob Clarkaf65db82017-07-27 08:04:19 -040056static int nesting_level;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +010057/* GUID of the device tree table */
58const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +010059/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60const efi_guid_t efi_guid_driver_binding_protocol =
61 EFI_DRIVER_BINDING_PROTOCOL_GUID;
Rob Clarkc160d2f2017-07-27 08:04:18 -040062
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +010063/* event group ExitBootServices() invoked */
64const efi_guid_t efi_guid_event_group_exit_boot_services =
65 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
66/* event group SetVirtualAddressMap() invoked */
67const efi_guid_t efi_guid_event_group_virtual_address_change =
68 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
69/* event group memory map changed */
70const efi_guid_t efi_guid_event_group_memory_map_change =
71 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
72/* event group boot manager about to boot */
73const efi_guid_t efi_guid_event_group_ready_to_boot =
74 EFI_EVENT_GROUP_READY_TO_BOOT;
75/* event group ResetSystem() invoked (before ExitBootServices) */
76const efi_guid_t efi_guid_event_group_reset_system =
77 EFI_EVENT_GROUP_RESET_SYSTEM;
78
Heinrich Schuchardt2074f702018-01-11 08:16:09 +010079static efi_status_t EFIAPI efi_disconnect_controller(
80 efi_handle_t controller_handle,
81 efi_handle_t driver_image_handle,
82 efi_handle_t child_handle);
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +010083
Rob Clarkc160d2f2017-07-27 08:04:18 -040084/* Called on every callback entry */
85int __efi_entry_check(void)
86{
87 int ret = entry_count++ == 0;
88#ifdef CONFIG_ARM
89 assert(efi_gd);
90 app_gd = gd;
91 gd = efi_gd;
92#endif
93 return ret;
94}
95
96/* Called on every callback exit */
97int __efi_exit_check(void)
98{
99 int ret = --entry_count == 0;
100#ifdef CONFIG_ARM
101 gd = app_gd;
102#endif
103 return ret;
104}
105
Alexander Grafbee91162016-03-04 01:09:59 +0100106/* Called from do_bootefi_exec() */
107void efi_save_gd(void)
108{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600109#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100110 efi_gd = gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600111#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100112}
113
Rob Clarkc160d2f2017-07-27 08:04:18 -0400114/*
Mario Six78a88f72018-07-10 08:40:17 +0200115 * Special case handler for error/abort that just forces things back to u-boot
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200116 * world so we can dump out an abort message, without any care about returning
117 * back to UEFI world.
Rob Clarkc160d2f2017-07-27 08:04:18 -0400118 */
Alexander Grafbee91162016-03-04 01:09:59 +0100119void efi_restore_gd(void)
120{
Simon Glass65e4c0b2016-09-25 15:27:35 -0600121#ifdef CONFIG_ARM
Alexander Grafbee91162016-03-04 01:09:59 +0100122 /* Only restore if we're already in EFI context */
123 if (!efi_gd)
124 return;
Alexander Grafbee91162016-03-04 01:09:59 +0100125 gd = efi_gd;
Simon Glass65e4c0b2016-09-25 15:27:35 -0600126#endif
Alexander Grafbee91162016-03-04 01:09:59 +0100127}
128
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200129/**
Mario Six78a88f72018-07-10 08:40:17 +0200130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
Heinrich Schuchardtc8df80c2018-01-24 19:21:36 +0100132 *
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200133 * A maximum of ten indent levels is supported. Higher indent levels will be
134 * truncated.
135 *
Mario Six78a88f72018-07-10 08:40:17 +0200136 * Return: A string for indenting with two spaces per level is
137 * returned.
Rob Clarkaf65db82017-07-27 08:04:19 -0400138 */
139static const char *indent_string(int level)
140{
141 const char *indent = " ";
142 const int max = strlen(indent);
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +0100143
Rob Clarkaf65db82017-07-27 08:04:19 -0400144 level = min(max, level * 2);
145 return &indent[max - level];
146}
147
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200148const char *__efi_nesting(void)
149{
150 return indent_string(nesting_level);
151}
152
Rob Clarkaf65db82017-07-27 08:04:19 -0400153const char *__efi_nesting_inc(void)
154{
155 return indent_string(nesting_level++);
156}
157
158const char *__efi_nesting_dec(void)
159{
160 return indent_string(--nesting_level);
161}
162
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200163/**
Mario Six78a88f72018-07-10 08:40:17 +0200164 * efi_queue_event() - queue an EFI event
165 * @event: event to signal
166 * @check_tpl: check the TPL level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200167 *
168 * This function queues the notification function of the event for future
169 * execution.
170 *
Mario Six78a88f72018-07-10 08:40:17 +0200171 * The notification function is called if the task priority level of the event
172 * is higher than the current task priority level.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200173 *
174 * For the SignalEvent service see efi_signal_event_ext.
175 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200176 */
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100177static void efi_queue_event(struct efi_event *event, bool check_tpl)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200178{
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200179 if (event->notify_function) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200180 event->is_queued = true;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200181 /* Check TPL */
Heinrich Schuchardt9bc96642018-01-19 20:24:51 +0100182 if (check_tpl && efi_tpl >= event->notify_tpl)
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200183 return;
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200184 EFI_CALL_VOID(event->notify_function(event,
185 event->notify_context));
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200186 }
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200187 event->is_queued = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200188}
189
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200190/**
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200191 * is_valid_tpl() - check if the task priority level is valid
192 *
193 * @tpl: TPL level to check
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200194 * Return: status code
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200195 */
196efi_status_t is_valid_tpl(efi_uintn_t tpl)
197{
198 switch (tpl) {
199 case TPL_APPLICATION:
200 case TPL_CALLBACK:
201 case TPL_NOTIFY:
202 case TPL_HIGH_LEVEL:
203 return EFI_SUCCESS;
204 default:
205 return EFI_INVALID_PARAMETER;
206 }
207}
208
209/**
Mario Six78a88f72018-07-10 08:40:17 +0200210 * efi_signal_event() - signal an EFI event
211 * @event: event to signal
212 * @check_tpl: check the TPL level
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100213 *
Mario Six78a88f72018-07-10 08:40:17 +0200214 * This function signals an event. If the event belongs to an event group all
215 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100216 * their notification function is queued.
217 *
218 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100219 */
220void efi_signal_event(struct efi_event *event, bool check_tpl)
221{
222 if (event->group) {
223 struct efi_event *evt;
224
225 /*
226 * The signaled state has to set before executing any
227 * notification function
228 */
229 list_for_each_entry(evt, &efi_events, link) {
230 if (!evt->group || guidcmp(evt->group, event->group))
231 continue;
232 if (evt->is_signaled)
233 continue;
234 evt->is_signaled = true;
235 if (evt->type & EVT_NOTIFY_SIGNAL &&
236 evt->notify_function)
237 evt->is_queued = true;
238 }
239 list_for_each_entry(evt, &efi_events, link) {
240 if (!evt->group || guidcmp(evt->group, event->group))
241 continue;
242 if (evt->is_queued)
243 efi_queue_event(evt, check_tpl);
244 }
Heinrich Schuchardt3626e532019-05-05 00:07:34 +0200245 } else {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100246 event->is_signaled = true;
247 if (event->type & EVT_NOTIFY_SIGNAL)
248 efi_queue_event(event, check_tpl);
249 }
250}
251
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200252/**
Mario Six78a88f72018-07-10 08:40:17 +0200253 * efi_raise_tpl() - raise the task priority level
254 * @new_tpl: new value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200255 *
256 * This function implements the RaiseTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200257 *
Mario Six78a88f72018-07-10 08:40:17 +0200258 * See the Unified Extensible Firmware Interface (UEFI) specification for
259 * details.
260 *
261 * Return: old value of the task priority level
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200262 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100263static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100264{
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100265 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200266
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200267 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200268
269 if (new_tpl < efi_tpl)
270 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
271 efi_tpl = new_tpl;
272 if (efi_tpl > TPL_HIGH_LEVEL)
273 efi_tpl = TPL_HIGH_LEVEL;
274
275 EFI_EXIT(EFI_SUCCESS);
276 return old_tpl;
Alexander Grafbee91162016-03-04 01:09:59 +0100277}
278
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200279/**
Mario Six78a88f72018-07-10 08:40:17 +0200280 * efi_restore_tpl() - lower the task priority level
281 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200282 *
283 * This function implements the RestoreTpl service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200284 *
Mario Six78a88f72018-07-10 08:40:17 +0200285 * See the Unified Extensible Firmware Interface (UEFI) specification for
286 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200287 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100288static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafbee91162016-03-04 01:09:59 +0100289{
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +0200290 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200291
292 if (old_tpl > efi_tpl)
293 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
294 efi_tpl = old_tpl;
295 if (efi_tpl > TPL_HIGH_LEVEL)
296 efi_tpl = TPL_HIGH_LEVEL;
297
Heinrich Schuchardt0f7fcc72018-03-24 18:40:21 +0100298 /*
299 * Lowering the TPL may have made queued events eligible for execution.
300 */
301 efi_timer_check();
302
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200303 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100304}
305
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200306/**
Mario Six78a88f72018-07-10 08:40:17 +0200307 * efi_allocate_pages_ext() - allocate memory pages
308 * @type: type of allocation to be performed
309 * @memory_type: usage type of the allocated memory
310 * @pages: number of pages to be allocated
311 * @memory: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200312 *
313 * This function implements the AllocatePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200314 *
Mario Six78a88f72018-07-10 08:40:17 +0200315 * See the Unified Extensible Firmware Interface (UEFI) specification for
316 * details.
317 *
318 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200319 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900320static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100321 efi_uintn_t pages,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900322 uint64_t *memory)
Alexander Grafbee91162016-03-04 01:09:59 +0100323{
324 efi_status_t r;
325
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100326 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafbee91162016-03-04 01:09:59 +0100327 r = efi_allocate_pages(type, memory_type, pages, memory);
328 return EFI_EXIT(r);
329}
330
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200331/**
Mario Six78a88f72018-07-10 08:40:17 +0200332 * efi_free_pages_ext() - Free memory pages.
333 * @memory: start of the memory area to be freed
334 * @pages: number of pages to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200335 *
336 * This function implements the FreePages service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200337 *
Mario Six78a88f72018-07-10 08:40:17 +0200338 * See the Unified Extensible Firmware Interface (UEFI) specification for
339 * details.
340 *
341 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200342 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900343static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100344 efi_uintn_t pages)
Alexander Grafbee91162016-03-04 01:09:59 +0100345{
346 efi_status_t r;
347
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900348 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafbee91162016-03-04 01:09:59 +0100349 r = efi_free_pages(memory, pages);
350 return EFI_EXIT(r);
351}
352
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200353/**
Mario Six78a88f72018-07-10 08:40:17 +0200354 * efi_get_memory_map_ext() - get map describing memory usage
355 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
356 * on exit the size of the copied memory map
357 * @memory_map: buffer to which the memory map is written
358 * @map_key: key for the memory map
359 * @descriptor_size: size of an individual memory descriptor
360 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200361 *
362 * This function implements the GetMemoryMap service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200363 *
Mario Six78a88f72018-07-10 08:40:17 +0200364 * See the Unified Extensible Firmware Interface (UEFI) specification for
365 * details.
366 *
367 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200368 */
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900369static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100370 efi_uintn_t *memory_map_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900371 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100372 efi_uintn_t *map_key,
373 efi_uintn_t *descriptor_size,
Masahiro Yamada6e0bf8d2017-06-22 17:49:03 +0900374 uint32_t *descriptor_version)
Alexander Grafbee91162016-03-04 01:09:59 +0100375{
376 efi_status_t r;
377
378 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
379 map_key, descriptor_size, descriptor_version);
380 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
381 descriptor_size, descriptor_version);
382 return EFI_EXIT(r);
383}
384
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200385/**
Mario Six78a88f72018-07-10 08:40:17 +0200386 * efi_allocate_pool_ext() - allocate memory from pool
387 * @pool_type: type of the pool from which memory is to be allocated
388 * @size: number of bytes to be allocated
389 * @buffer: allocated memory
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200390 *
391 * This function implements the AllocatePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200392 *
Mario Six78a88f72018-07-10 08:40:17 +0200393 * See the Unified Extensible Firmware Interface (UEFI) specification for
394 * details.
395 *
396 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200397 */
Stefan Brünsead12742016-10-09 22:17:18 +0200398static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100399 efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200400 void **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100401{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100402 efi_status_t r;
403
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100404 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
Stefan Brünsead12742016-10-09 22:17:18 +0200405 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100406 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100407}
408
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200409/**
Mario Six78a88f72018-07-10 08:40:17 +0200410 * efi_free_pool_ext() - free memory from pool
411 * @buffer: start of memory to be freed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200412 *
413 * This function implements the FreePool service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200414 *
Mario Six78a88f72018-07-10 08:40:17 +0200415 * See the Unified Extensible Firmware Interface (UEFI) specification for
416 * details.
417 *
418 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200419 */
Stefan Brüns42417bc2016-10-09 22:17:26 +0200420static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +0100421{
Alexander Graf1cd29f02016-03-24 01:37:37 +0100422 efi_status_t r;
423
424 EFI_ENTRY("%p", buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200425 r = efi_free_pool(buffer);
Alexander Graf1cd29f02016-03-24 01:37:37 +0100426 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +0100427}
428
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200429/**
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200430 * efi_add_handle() - add a new handle to the object list
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100431 *
Heinrich Schuchardte6023be2019-05-01 09:42:39 +0200432 * @handle: handle to be added
433 *
434 * The protocols list is initialized. The handle is added to the list of known
435 * UEFI objects.
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100436 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200437void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100438{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200439 if (!handle)
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100440 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200441 INIT_LIST_HEAD(&handle->protocols);
442 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100443}
444
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200445/**
Mario Six78a88f72018-07-10 08:40:17 +0200446 * efi_create_handle() - create handle
447 * @handle: new handle
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200448 *
Mario Six78a88f72018-07-10 08:40:17 +0200449 * Return: status code
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200450 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100451efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200452{
453 struct efi_object *obj;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200454
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200455 obj = calloc(1, sizeof(struct efi_object));
456 if (!obj)
457 return EFI_OUT_OF_RESOURCES;
458
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100459 efi_add_handle(obj);
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200460 *handle = obj;
Heinrich Schuchardtd29e7822018-05-27 16:47:21 +0200461
462 return EFI_SUCCESS;
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +0200463}
464
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200465/**
Mario Six78a88f72018-07-10 08:40:17 +0200466 * efi_search_protocol() - find a protocol on a handle.
467 * @handle: handle
468 * @protocol_guid: GUID of the protocol
469 * @handler: reference to the protocol
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100470 *
Mario Six78a88f72018-07-10 08:40:17 +0200471 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100472 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100473efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100474 const efi_guid_t *protocol_guid,
475 struct efi_handler **handler)
476{
477 struct efi_object *efiobj;
478 struct list_head *lhandle;
479
480 if (!handle || !protocol_guid)
481 return EFI_INVALID_PARAMETER;
482 efiobj = efi_search_obj(handle);
483 if (!efiobj)
484 return EFI_INVALID_PARAMETER;
485 list_for_each(lhandle, &efiobj->protocols) {
486 struct efi_handler *protocol;
487
488 protocol = list_entry(lhandle, struct efi_handler, link);
489 if (!guidcmp(protocol->guid, protocol_guid)) {
490 if (handler)
491 *handler = protocol;
492 return EFI_SUCCESS;
493 }
494 }
495 return EFI_NOT_FOUND;
496}
497
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200498/**
Mario Six78a88f72018-07-10 08:40:17 +0200499 * efi_remove_protocol() - delete protocol from a handle
500 * @handle: handle from which the protocol shall be deleted
501 * @protocol: GUID of the protocol to be deleted
502 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100503 *
Mario Six78a88f72018-07-10 08:40:17 +0200504 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100505 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100506efi_status_t efi_remove_protocol(const efi_handle_t handle,
507 const efi_guid_t *protocol,
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100508 void *protocol_interface)
509{
510 struct efi_handler *handler;
511 efi_status_t ret;
512
513 ret = efi_search_protocol(handle, protocol, &handler);
514 if (ret != EFI_SUCCESS)
515 return ret;
516 if (guidcmp(handler->guid, protocol))
517 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt1f470e12018-05-11 12:09:21 +0200518 if (handler->protocol_interface != protocol_interface)
519 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100520 list_del(&handler->link);
521 free(handler);
522 return EFI_SUCCESS;
523}
524
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200525/**
Mario Six78a88f72018-07-10 08:40:17 +0200526 * efi_remove_all_protocols() - delete all protocols from a handle
527 * @handle: handle from which the protocols shall be deleted
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100528 *
Mario Six78a88f72018-07-10 08:40:17 +0200529 * Return: status code
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100530 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100531efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100532{
533 struct efi_object *efiobj;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100534 struct efi_handler *protocol;
535 struct efi_handler *pos;
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100536
537 efiobj = efi_search_obj(handle);
538 if (!efiobj)
539 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt32e6fed2018-01-11 08:15:55 +0100540 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100541 efi_status_t ret;
542
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100543 ret = efi_remove_protocol(handle, protocol->guid,
544 protocol->protocol_interface);
545 if (ret != EFI_SUCCESS)
546 return ret;
547 }
548 return EFI_SUCCESS;
549}
550
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200551/**
Mario Six78a88f72018-07-10 08:40:17 +0200552 * efi_delete_handle() - delete handle
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100553 *
Mario Six78a88f72018-07-10 08:40:17 +0200554 * @obj: handle to delete
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100555 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200556void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100557{
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200558 if (!handle)
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100559 return;
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200560 efi_remove_all_protocols(handle);
561 list_del(&handle->link);
562 free(handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100563}
564
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200565/**
Mario Six78a88f72018-07-10 08:40:17 +0200566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100568 *
Mario Six78a88f72018-07-10 08:40:17 +0200569 * Return: status code
Alexander Grafbee91162016-03-04 01:09:59 +0100570 */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100571static efi_status_t efi_is_event(const struct efi_event *event)
572{
573 const struct efi_event *evt;
574
575 if (!event)
576 return EFI_INVALID_PARAMETER;
577 list_for_each_entry(evt, &efi_events, link) {
578 if (evt == event)
579 return EFI_SUCCESS;
580 }
581 return EFI_INVALID_PARAMETER;
582}
Alexander Grafbee91162016-03-04 01:09:59 +0100583
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200584/**
Mario Six78a88f72018-07-10 08:40:17 +0200585 * efi_create_event() - create an event
586 * @type: type of the event to create
587 * @notify_tpl: task priority level of the event
588 * @notify_function: notification function of the event
589 * @notify_context: pointer passed to the notification function
590 * @group: event group
591 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200592 *
593 * This function is used inside U-Boot code to create an event.
594 *
595 * For the API function implementing the CreateEvent service see
596 * efi_create_event_ext.
597 *
Mario Six78a88f72018-07-10 08:40:17 +0200598 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200599 */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100600efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200601 void (EFIAPI *notify_function) (
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200602 struct efi_event *event,
603 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100604 void *notify_context, efi_guid_t *group,
605 struct efi_event **event)
Alexander Grafbee91162016-03-04 01:09:59 +0100606{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100607 struct efi_event *evt;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200608
Jonathan Graya95343b2017-03-12 19:26:07 +1100609 if (event == NULL)
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200610 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100611
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200612 switch (type) {
613 case 0:
614 case EVT_TIMER:
615 case EVT_NOTIFY_SIGNAL:
616 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
617 case EVT_NOTIFY_WAIT:
618 case EVT_TIMER | EVT_NOTIFY_WAIT:
619 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
620 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
621 break;
622 default:
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200623 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt21b3edf2018-07-02 12:53:52 +0200624 }
Jonathan Graya95343b2017-03-12 19:26:07 +1100625
AKASHI Takahiro3748ed92018-08-10 15:36:32 +0900626 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardt751e9282019-04-25 07:30:41 +0200627 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200628 return EFI_INVALID_PARAMETER;
Jonathan Graya95343b2017-03-12 19:26:07 +1100629
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100630 evt = calloc(1, sizeof(struct efi_event));
631 if (!evt)
632 return EFI_OUT_OF_RESOURCES;
633 evt->type = type;
634 evt->notify_tpl = notify_tpl;
635 evt->notify_function = notify_function;
636 evt->notify_context = notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100637 evt->group = group;
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200638 /* Disable timers on boot up */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100639 evt->trigger_next = -1ULL;
640 evt->is_queued = false;
641 evt->is_signaled = false;
642 list_add_tail(&evt->link, &efi_events);
643 *event = evt;
644 return EFI_SUCCESS;
Alexander Grafbee91162016-03-04 01:09:59 +0100645}
646
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200647/*
Mario Six78a88f72018-07-10 08:40:17 +0200648 * efi_create_event_ex() - create an event in a group
649 * @type: type of the event to create
650 * @notify_tpl: task priority level of the event
651 * @notify_function: notification function of the event
652 * @notify_context: pointer passed to the notification function
653 * @event: created event
654 * @event_group: event group
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100655 *
656 * This function implements the CreateEventEx service.
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100657 *
Mario Six78a88f72018-07-10 08:40:17 +0200658 * See the Unified Extensible Firmware Interface (UEFI) specification for
659 * details.
660 *
661 * Return: status code
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100662 */
663efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
664 void (EFIAPI *notify_function) (
665 struct efi_event *event,
666 void *context),
667 void *notify_context,
668 efi_guid_t *event_group,
669 struct efi_event **event)
670{
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200671 efi_status_t ret;
672
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100673 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
674 notify_context, event_group);
Heinrich Schuchardt18845122019-05-04 10:12:50 +0200675
676 /*
677 * The allowable input parameters are the same as in CreateEvent()
678 * except for the following two disallowed event types.
679 */
680 switch (type) {
681 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
682 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
683 ret = EFI_INVALID_PARAMETER;
684 goto out;
685 }
686
687 ret = efi_create_event(type, notify_tpl, notify_function,
688 notify_context, event_group, event);
689out:
690 return EFI_EXIT(ret);
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100691}
692
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200693/**
Mario Six78a88f72018-07-10 08:40:17 +0200694 * efi_create_event_ext() - create an event
695 * @type: type of the event to create
696 * @notify_tpl: task priority level of the event
697 * @notify_function: notification function of the event
698 * @notify_context: pointer passed to the notification function
699 * @event: created event
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200700 *
701 * This function implements the CreateEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200702 *
Mario Six78a88f72018-07-10 08:40:17 +0200703 * See the Unified Extensible Firmware Interface (UEFI) specification for
704 * details.
705 *
706 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200707 */
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200708static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100709 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200710 void (EFIAPI *notify_function) (
711 struct efi_event *event,
712 void *context),
713 void *notify_context, struct efi_event **event)
714{
715 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
716 notify_context);
717 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100718 notify_context, NULL, event));
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200719}
720
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200721/**
Mario Six78a88f72018-07-10 08:40:17 +0200722 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200723 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200724 * Check if a timer event has occurred or a queued notification function should
725 * be called.
726 *
Alexander Grafbee91162016-03-04 01:09:59 +0100727 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200728 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafbee91162016-03-04 01:09:59 +0100729 */
730void efi_timer_check(void)
731{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100732 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +0100733 u64 now = timer_get_us();
734
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100735 list_for_each_entry(evt, &efi_events, link) {
736 if (evt->is_queued)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100737 efi_queue_event(evt, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100738 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200739 continue;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100740 switch (evt->trigger_type) {
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200741 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100742 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200743 break;
744 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100745 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardtca62a4f2017-09-15 10:06:13 +0200746 break;
747 default:
748 continue;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200749 }
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100750 evt->is_signaled = false;
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100751 efi_signal_event(evt, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100752 }
Alexander Grafbee91162016-03-04 01:09:59 +0100753 WATCHDOG_RESET();
754}
755
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200756/**
Mario Six78a88f72018-07-10 08:40:17 +0200757 * efi_set_timer() - set the trigger time for a timer event or stop the event
758 * @event: event for which the timer is set
759 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200760 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200761 *
762 * This is the function for internal usage in U-Boot. For the API function
763 * implementing the SetTimer service see efi_set_timer_ext.
764 *
Mario Six78a88f72018-07-10 08:40:17 +0200765 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200766 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200767efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200768 uint64_t trigger_time)
Alexander Grafbee91162016-03-04 01:09:59 +0100769{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100770 /* Check that the event is valid */
771 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
772 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100773
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200774 /*
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200775 * The parameter defines a multiple of 100 ns.
776 * We use multiples of 1000 ns. So divide by 10.
xypron.glpk@gmx.de8787b022017-07-18 20:17:23 +0200777 */
Heinrich Schuchardt7d963322017-10-05 16:14:14 +0200778 do_div(trigger_time, 10);
Alexander Grafbee91162016-03-04 01:09:59 +0100779
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100780 switch (type) {
781 case EFI_TIMER_STOP:
782 event->trigger_next = -1ULL;
783 break;
784 case EFI_TIMER_PERIODIC:
785 case EFI_TIMER_RELATIVE:
786 event->trigger_next = timer_get_us() + trigger_time;
787 break;
788 default:
789 return EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +0100790 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100791 event->trigger_type = type;
792 event->trigger_time = trigger_time;
793 event->is_signaled = false;
794 return EFI_SUCCESS;
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200795}
796
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200797/**
Mario Six78a88f72018-07-10 08:40:17 +0200798 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
799 * event
800 * @event: event for which the timer is set
801 * @type: type of the timer
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +0200802 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200803 *
804 * This function implements the SetTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200805 *
Mario Six78a88f72018-07-10 08:40:17 +0200806 * See the Unified Extensible Firmware Interface (UEFI) specification for
807 * details.
808 *
809 *
810 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200811 */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200812static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
813 enum efi_timer_delay type,
814 uint64_t trigger_time)
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200815{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +0900816 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200817 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
Alexander Grafbee91162016-03-04 01:09:59 +0100818}
819
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200820/**
Mario Six78a88f72018-07-10 08:40:17 +0200821 * efi_wait_for_event() - wait for events to be signaled
822 * @num_events: number of events to be waited for
823 * @event: events to be waited for
824 * @index: index of the event that was signaled
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200825 *
826 * This function implements the WaitForEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200827 *
Mario Six78a88f72018-07-10 08:40:17 +0200828 * See the Unified Extensible Firmware Interface (UEFI) specification for
829 * details.
830 *
831 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200832 */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100833static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200834 struct efi_event **event,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100835 efi_uintn_t *index)
Alexander Grafbee91162016-03-04 01:09:59 +0100836{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100837 int i;
Alexander Grafbee91162016-03-04 01:09:59 +0100838
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100839 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
Alexander Grafbee91162016-03-04 01:09:59 +0100840
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200841 /* Check parameters */
842 if (!num_events || !event)
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt32f4b2f2017-09-15 10:06:16 +0200844 /* Check TPL */
845 if (efi_tpl != TPL_APPLICATION)
846 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200847 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100848 if (efi_is_event(event[i]) != EFI_SUCCESS)
849 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200850 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
851 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200852 if (!event[i]->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100853 efi_queue_event(event[i], true);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200854 }
855
856 /* Wait for signal */
857 for (;;) {
858 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200859 if (event[i]->is_signaled)
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200860 goto out;
861 }
862 /* Allow events to occur. */
863 efi_timer_check();
864 }
865
866out:
867 /*
868 * Reset the signal which is passed to the caller to allow periodic
869 * events to occur.
870 */
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200871 event[i]->is_signaled = false;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200872 if (index)
873 *index = i;
Alexander Grafbee91162016-03-04 01:09:59 +0100874
875 return EFI_EXIT(EFI_SUCCESS);
876}
877
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200878/**
Mario Six78a88f72018-07-10 08:40:17 +0200879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200881 *
882 * This function implements the SignalEvent service.
Mario Six78a88f72018-07-10 08:40:17 +0200883 *
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
885 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200886 *
887 * This functions sets the signaled state of the event and queues the
888 * notification function for execution.
889 *
Mario Six78a88f72018-07-10 08:40:17 +0200890 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200891 */
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200892static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100893{
894 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100895 if (efi_is_event(event) != EFI_SUCCESS)
896 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100897 efi_signal_event(event, true);
Alexander Grafbee91162016-03-04 01:09:59 +0100898 return EFI_EXIT(EFI_SUCCESS);
899}
900
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200901/**
Mario Six78a88f72018-07-10 08:40:17 +0200902 * efi_close_event() - close an EFI event
903 * @event: event to close
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200904 *
905 * This function implements the CloseEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200906 *
Mario Six78a88f72018-07-10 08:40:17 +0200907 * See the Unified Extensible Firmware Interface (UEFI) specification for
908 * details.
909 *
910 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200911 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200912static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100913{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200914 struct efi_register_notify_event *item, *next;
915
Alexander Grafbee91162016-03-04 01:09:59 +0100916 EFI_ENTRY("%p", event);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100917 if (efi_is_event(event) != EFI_SUCCESS)
918 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200919
920 /* Remove protocol notify registrations for the event */
921 list_for_each_entry_safe(item, next, &efi_register_notify_events,
922 link) {
923 if (event == item->event) {
924 list_del(&item->link);
925 free(item);
926 }
927 }
928
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100929 list_del(&event->link);
930 free(event);
931 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +0100932}
933
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200934/**
Mario Six78a88f72018-07-10 08:40:17 +0200935 * efi_check_event() - check if an event is signaled
936 * @event: event to check
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200937 *
938 * This function implements the CheckEvent service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200939 *
Mario Six78a88f72018-07-10 08:40:17 +0200940 * See the Unified Extensible Firmware Interface (UEFI) specification for
941 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200942 *
Mario Six78a88f72018-07-10 08:40:17 +0200943 * If an event is not signaled yet, the notification function is queued. The
944 * signaled state is cleared.
945 *
946 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +0200947 */
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200948static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafbee91162016-03-04 01:09:59 +0100949{
950 EFI_ENTRY("%p", event);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200951 efi_timer_check();
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100952 if (efi_is_event(event) != EFI_SUCCESS ||
953 event->type & EVT_NOTIFY_SIGNAL)
954 return EFI_EXIT(EFI_INVALID_PARAMETER);
955 if (!event->is_signaled)
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100956 efi_queue_event(event, true);
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100957 if (event->is_signaled) {
958 event->is_signaled = false;
959 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200960 }
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100961 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafbee91162016-03-04 01:09:59 +0100962}
963
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200964/**
Mario Six78a88f72018-07-10 08:40:17 +0200965 * efi_search_obj() - find the internal EFI object for a handle
966 * @handle: handle to find
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200967 *
Mario Six78a88f72018-07-10 08:40:17 +0200968 * Return: EFI object
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200969 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100970struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200971{
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100972 struct efi_object *efiobj;
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200973
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100974 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200975 if (efiobj == handle)
Heinrich Schuchardt7b9f8ad2017-10-18 18:13:03 +0200976 return efiobj;
977 }
978
979 return NULL;
980}
981
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +0200982/**
Mario Six78a88f72018-07-10 08:40:17 +0200983 * efi_open_protocol_info_entry() - create open protocol info entry and add it
984 * to a protocol
985 * @handler: handler of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100986 *
Mario Six78a88f72018-07-10 08:40:17 +0200987 * Return: open protocol info entry
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100988 */
989static struct efi_open_protocol_info_entry *efi_create_open_info(
990 struct efi_handler *handler)
991{
992 struct efi_open_protocol_info_item *item;
993
994 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
995 if (!item)
996 return NULL;
997 /* Append the item to the open protocol info list. */
998 list_add_tail(&item->link, &handler->open_infos);
999
1000 return &item->info;
1001}
1002
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001003/**
Mario Six78a88f72018-07-10 08:40:17 +02001004 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1005 * @item: open protocol info entry to delete
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001006 *
Mario Six78a88f72018-07-10 08:40:17 +02001007 * Return: status code
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001008 */
1009static efi_status_t efi_delete_open_info(
1010 struct efi_open_protocol_info_item *item)
1011{
1012 list_del(&item->link);
1013 free(item);
1014 return EFI_SUCCESS;
1015}
1016
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001017/**
Mario Six78a88f72018-07-10 08:40:17 +02001018 * efi_add_protocol() - install new protocol on a handle
1019 * @handle: handle on which the protocol shall be installed
1020 * @protocol: GUID of the protocol to be installed
1021 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001022 *
Mario Six78a88f72018-07-10 08:40:17 +02001023 * Return: status code
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001024 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001025efi_status_t efi_add_protocol(const efi_handle_t handle,
1026 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001027 void *protocol_interface)
1028{
1029 struct efi_object *efiobj;
1030 struct efi_handler *handler;
1031 efi_status_t ret;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001032 struct efi_register_notify_event *event;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001033
1034 efiobj = efi_search_obj(handle);
1035 if (!efiobj)
1036 return EFI_INVALID_PARAMETER;
1037 ret = efi_search_protocol(handle, protocol, NULL);
1038 if (ret != EFI_NOT_FOUND)
1039 return EFI_INVALID_PARAMETER;
1040 handler = calloc(1, sizeof(struct efi_handler));
1041 if (!handler)
1042 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001043 handler->guid = protocol;
1044 handler->protocol_interface = protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +01001045 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001046 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001047
1048 /* Notify registered events */
1049 list_for_each_entry(event, &efi_register_notify_events, link) {
1050 if (!guidcmp(protocol, &event->protocol))
1051 efi_signal_event(event->event, true);
1052 }
1053
Heinrich Schuchardtd5504142018-01-11 08:16:01 +01001054 if (!guidcmp(&efi_guid_device_path, protocol))
1055 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01001056 return EFI_SUCCESS;
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +02001057}
1058
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001059/**
Mario Six78a88f72018-07-10 08:40:17 +02001060 * efi_install_protocol_interface() - install protocol interface
1061 * @handle: handle on which the protocol shall be installed
1062 * @protocol: GUID of the protocol to be installed
1063 * @protocol_interface_type: type of the interface to be installed,
1064 * always EFI_NATIVE_INTERFACE
1065 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001066 *
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001067 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001068 *
Mario Six78a88f72018-07-10 08:40:17 +02001069 * See the Unified Extensible Firmware Interface (UEFI) specification for
1070 * details.
1071 *
1072 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001073 */
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001074static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02001075 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001076 int protocol_interface_type, void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001077{
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001078 efi_status_t r;
1079
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001080 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1081 protocol_interface);
1082
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001083 if (!handle || !protocol ||
1084 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1085 r = EFI_INVALID_PARAMETER;
1086 goto out;
1087 }
1088
1089 /* Create new handle if requested. */
1090 if (!*handle) {
Heinrich Schuchardt3cc6e3f2017-08-27 00:51:09 +02001091 r = efi_create_handle(handle);
1092 if (r != EFI_SUCCESS)
1093 goto out;
Heinrich Schuchardtaf1408e2017-10-26 19:25:43 +02001094 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1095 *handle);
1096 } else {
1097 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1098 *handle);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001099 }
Heinrich Schuchardt12025302017-10-26 19:25:54 +02001100 /* Add new protocol */
1101 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001102out:
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01001103 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01001104}
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +02001105
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001106/**
Mario Six78a88f72018-07-10 08:40:17 +02001107 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001108 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001109 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001110 * @number_of_drivers: number of child controllers
1111 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001112 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001113 * The allocated buffer has to be freed with free().
1114 *
Mario Six78a88f72018-07-10 08:40:17 +02001115 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001116 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001117static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001118 const efi_guid_t *protocol,
1119 efi_uintn_t *number_of_drivers,
1120 efi_handle_t **driver_handle_buffer)
1121{
1122 struct efi_handler *handler;
1123 struct efi_open_protocol_info_item *item;
1124 efi_uintn_t count = 0, i;
1125 bool duplicate;
1126
1127 /* Count all driver associations */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001128 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001129 if (protocol && guidcmp(handler->guid, protocol))
1130 continue;
1131 list_for_each_entry(item, &handler->open_infos, link) {
1132 if (item->info.attributes &
1133 EFI_OPEN_PROTOCOL_BY_DRIVER)
1134 ++count;
1135 }
1136 }
1137 /*
1138 * Create buffer. In case of duplicate driver assignments the buffer
1139 * will be too large. But that does not harm.
1140 */
1141 *number_of_drivers = 0;
1142 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1143 if (!*driver_handle_buffer)
1144 return EFI_OUT_OF_RESOURCES;
1145 /* Collect unique driver handles */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001146 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001147 if (protocol && guidcmp(handler->guid, protocol))
1148 continue;
1149 list_for_each_entry(item, &handler->open_infos, link) {
1150 if (item->info.attributes &
1151 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1152 /* Check this is a new driver */
1153 duplicate = false;
1154 for (i = 0; i < *number_of_drivers; ++i) {
1155 if ((*driver_handle_buffer)[i] ==
1156 item->info.agent_handle)
1157 duplicate = true;
1158 }
1159 /* Copy handle to buffer */
1160 if (!duplicate) {
1161 i = (*number_of_drivers)++;
1162 (*driver_handle_buffer)[i] =
1163 item->info.agent_handle;
1164 }
1165 }
1166 }
1167 }
1168 return EFI_SUCCESS;
1169}
1170
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001171/**
Mario Six78a88f72018-07-10 08:40:17 +02001172 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001173 * @handle: handle of the controller
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001174 * @protocol: protocol GUID (optional)
Mario Six78a88f72018-07-10 08:40:17 +02001175 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001176 *
1177 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001178 *
Mario Six78a88f72018-07-10 08:40:17 +02001179 * See the Unified Extensible Firmware Interface (UEFI) specification for
1180 * details.
1181 *
1182 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001183 */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001184static efi_status_t efi_disconnect_all_drivers
1185 (efi_handle_t handle,
1186 const efi_guid_t *protocol,
1187 efi_handle_t child_handle)
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001188{
1189 efi_uintn_t number_of_drivers;
1190 efi_handle_t *driver_handle_buffer;
1191 efi_status_t r, ret;
1192
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001193 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001194 &driver_handle_buffer);
1195 if (ret != EFI_SUCCESS)
1196 return ret;
1197
1198 ret = EFI_NOT_FOUND;
1199 while (number_of_drivers) {
1200 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001201 handle,
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01001202 driver_handle_buffer[--number_of_drivers],
1203 child_handle));
1204 if (r == EFI_SUCCESS)
1205 ret = r;
1206 }
1207 free(driver_handle_buffer);
1208 return ret;
1209}
1210
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001211/**
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001212 * efi_uninstall_protocol() - uninstall protocol interface
1213 *
Mario Six78a88f72018-07-10 08:40:17 +02001214 * @handle: handle from which the protocol shall be removed
1215 * @protocol: GUID of the protocol to be removed
1216 * @protocol_interface: interface to be removed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001217 *
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001218 * This function DOES NOT delete a handle without installed protocol.
Mario Six78a88f72018-07-10 08:40:17 +02001219 *
1220 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001221 */
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001222static efi_status_t efi_uninstall_protocol
1223 (efi_handle_t handle, const efi_guid_t *protocol,
1224 void *protocol_interface)
Alexander Grafbee91162016-03-04 01:09:59 +01001225{
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001226 struct efi_object *efiobj;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001227 struct efi_handler *handler;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001228 struct efi_open_protocol_info_item *item;
1229 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001230 efi_status_t r;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001231
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001232 /* Check handle */
1233 efiobj = efi_search_obj(handle);
1234 if (!efiobj) {
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001235 r = EFI_INVALID_PARAMETER;
1236 goto out;
1237 }
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001238 /* Find the protocol on the handle */
1239 r = efi_search_protocol(handle, protocol, &handler);
1240 if (r != EFI_SUCCESS)
1241 goto out;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001242 /* Disconnect controllers */
1243 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1244 if (!list_empty(&handler->open_infos)) {
Heinrich Schuchardt58105112017-10-26 19:25:56 +02001245 r = EFI_ACCESS_DENIED;
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001246 goto out;
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001247 }
Heinrich Schuchardtad973732018-01-11 08:16:05 +01001248 /* Close protocol */
1249 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1250 if (item->info.attributes ==
1251 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1252 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1253 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1254 list_del(&item->link);
1255 }
1256 if (!list_empty(&handler->open_infos)) {
1257 r = EFI_ACCESS_DENIED;
1258 goto out;
1259 }
1260 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de4b6ed0d2017-07-11 22:06:17 +02001261out:
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02001262 return r;
1263}
1264
1265/**
1266 * efi_uninstall_protocol_interface() - uninstall protocol interface
1267 * @handle: handle from which the protocol shall be removed
1268 * @protocol: GUID of the protocol to be removed
1269 * @protocol_interface: interface to be removed
1270 *
1271 * This function implements the UninstallProtocolInterface service.
1272 *
1273 * See the Unified Extensible Firmware Interface (UEFI) specification for
1274 * details.
1275 *
1276 * Return: status code
1277 */
1278static efi_status_t EFIAPI efi_uninstall_protocol_interface
1279 (efi_handle_t handle, const efi_guid_t *protocol,
1280 void *protocol_interface)
1281{
1282 efi_status_t ret;
1283
1284 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1285
1286 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1287 if (ret != EFI_SUCCESS)
1288 goto out;
1289
1290 /* If the last protocol has been removed, delete the handle. */
1291 if (list_empty(&handle->protocols)) {
1292 list_del(&handle->link);
1293 free(handle);
1294 }
1295out:
1296 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001297}
1298
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001299/**
Mario Six78a88f72018-07-10 08:40:17 +02001300 * efi_register_protocol_notify() - register an event for notification when a
1301 * protocol is installed.
1302 * @protocol: GUID of the protocol whose installation shall be notified
1303 * @event: event to be signaled upon installation of the protocol
1304 * @registration: key for retrieving the registration information
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001305 *
1306 * This function implements the RegisterProtocolNotify service.
1307 * See the Unified Extensible Firmware Interface (UEFI) specification
1308 * for details.
1309 *
Mario Six78a88f72018-07-10 08:40:17 +02001310 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001311 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001312static efi_status_t EFIAPI efi_register_protocol_notify(
1313 const efi_guid_t *protocol,
1314 struct efi_event *event,
1315 void **registration)
Alexander Grafbee91162016-03-04 01:09:59 +01001316{
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001317 struct efi_register_notify_event *item;
1318 efi_status_t ret = EFI_SUCCESS;
1319
Rob Clark778e6af2017-09-13 18:05:41 -04001320 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001321
1322 if (!protocol || !event || !registration) {
1323 ret = EFI_INVALID_PARAMETER;
1324 goto out;
1325 }
1326
1327 item = calloc(1, sizeof(struct efi_register_notify_event));
1328 if (!item) {
1329 ret = EFI_OUT_OF_RESOURCES;
1330 goto out;
1331 }
1332
1333 item->event = event;
1334 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1335
1336 list_add_tail(&item->link, &efi_register_notify_events);
1337
1338 *registration = item;
1339out:
1340 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001341}
1342
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001343/**
Mario Six78a88f72018-07-10 08:40:17 +02001344 * efi_search() - determine if an EFI handle implements a protocol
1345 * @search_type: selection criterion
1346 * @protocol: GUID of the protocol
1347 * @search_key: registration key
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001348 * @handle: handle
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001349 *
1350 * See the documentation of the LocateHandle service in the UEFI specification.
1351 *
Mario Six78a88f72018-07-10 08:40:17 +02001352 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001353 */
Alexander Grafbee91162016-03-04 01:09:59 +01001354static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001355 const efi_guid_t *protocol, efi_handle_t handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001356{
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001357 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01001358
1359 switch (search_type) {
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001360 case ALL_HANDLES:
Alexander Grafbee91162016-03-04 01:09:59 +01001361 return 0;
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001362 case BY_REGISTER_NOTIFY:
Heinrich Schuchardt9f0770f2017-11-06 21:17:42 +01001363 case BY_PROTOCOL:
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001364 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt42cf1242017-10-26 19:25:55 +02001365 return (ret != EFI_SUCCESS);
1366 default:
1367 /* Invalid search type */
Alexander Grafbee91162016-03-04 01:09:59 +01001368 return -1;
1369 }
Alexander Grafbee91162016-03-04 01:09:59 +01001370}
1371
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001372/**
Mario Six78a88f72018-07-10 08:40:17 +02001373 * efi_locate_handle() - locate handles implementing a protocol
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001374 *
1375 * @search_type: selection criterion
1376 * @protocol: GUID of the protocol
1377 * @search_key: registration key
1378 * @buffer_size: size of the buffer to receive the handles in bytes
1379 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001380 *
1381 * This function is meant for U-Boot internal calls. For the API implementation
1382 * of the LocateHandle service see efi_locate_handle_ext.
1383 *
Mario Six78a88f72018-07-10 08:40:17 +02001384 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001385 */
xypron.glpk@gmx.deebf199b2017-08-09 20:55:00 +02001386static efi_status_t efi_locate_handle(
Alexander Grafbee91162016-03-04 01:09:59 +01001387 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001388 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001389 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01001390{
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001391 struct efi_object *efiobj;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001392 efi_uintn_t size = 0;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001393 struct efi_register_notify_event *item, *event = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01001394
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001395 /* Check parameters */
1396 switch (search_type) {
1397 case ALL_HANDLES:
1398 break;
1399 case BY_REGISTER_NOTIFY:
1400 if (!search_key)
1401 return EFI_INVALID_PARAMETER;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001402 /* Check that the registration key is valid */
1403 list_for_each_entry(item, &efi_register_notify_events, link) {
1404 if (item ==
1405 (struct efi_register_notify_event *)search_key) {
1406 event = item;
1407 break;
1408 }
1409 }
1410 if (!event)
1411 return EFI_INVALID_PARAMETER;
1412
1413 protocol = &event->protocol;
1414 break;
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001415 case BY_PROTOCOL:
1416 if (!protocol)
1417 return EFI_INVALID_PARAMETER;
1418 break;
1419 default:
1420 return EFI_INVALID_PARAMETER;
1421 }
1422
Alexander Grafbee91162016-03-04 01:09:59 +01001423 /* Count how much space we need */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001424 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001425 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001426 size += sizeof(void *);
Alexander Grafbee91162016-03-04 01:09:59 +01001427 }
1428
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001429 if (size == 0)
1430 return EFI_NOT_FOUND;
1431
1432 if (!buffer_size)
1433 return EFI_INVALID_PARAMETER;
1434
Alexander Grafbee91162016-03-04 01:09:59 +01001435 if (*buffer_size < size) {
1436 *buffer_size = size;
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001437 return EFI_BUFFER_TOO_SMALL;
Alexander Grafbee91162016-03-04 01:09:59 +01001438 }
1439
Rob Clark796a78c2017-08-06 14:10:07 -04001440 *buffer_size = size;
Heinrich Schuchardt8dfb5e62019-05-04 17:37:32 +02001441
1442 /* The buffer size is sufficient but there is not buffer */
1443 if (!buffer)
1444 return EFI_INVALID_PARAMETER;
Rob Clark796a78c2017-08-06 14:10:07 -04001445
Alexander Grafbee91162016-03-04 01:09:59 +01001446 /* Then fill the array */
Heinrich Schuchardtcaf864e2017-11-06 21:17:49 +01001447 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtab15d412019-05-04 17:27:54 +02001448 if (!efi_search(search_type, protocol, efiobj))
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02001449 *buffer++ = efiobj;
Alexander Grafbee91162016-03-04 01:09:59 +01001450 }
1451
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001452 return EFI_SUCCESS;
1453}
1454
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001455/**
Mario Six78a88f72018-07-10 08:40:17 +02001456 * efi_locate_handle_ext() - locate handles implementing a protocol.
1457 * @search_type: selection criterion
1458 * @protocol: GUID of the protocol
1459 * @search_key: registration key
1460 * @buffer_size: size of the buffer to receive the handles in bytes
1461 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001462 *
1463 * This function implements the LocateHandle service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001464 *
Mario Six78a88f72018-07-10 08:40:17 +02001465 * See the Unified Extensible Firmware Interface (UEFI) specification for
1466 * details.
1467 *
1468 * Return: 0 if the handle implements the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001469 */
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001470static efi_status_t EFIAPI efi_locate_handle_ext(
1471 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001472 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01001473 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001474{
Rob Clark778e6af2017-09-13 18:05:41 -04001475 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02001476 buffer_size, buffer);
1477
1478 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1479 buffer_size, buffer));
Alexander Grafbee91162016-03-04 01:09:59 +01001480}
1481
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001482/**
Mario Six78a88f72018-07-10 08:40:17 +02001483 * efi_remove_configuration_table() - collapses configuration table entries,
1484 * removing index i
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001485 *
Mario Six78a88f72018-07-10 08:40:17 +02001486 * @i: index of the table entry to be removed
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001487 */
Alexander Grafd98cdf62017-07-26 13:41:04 +02001488static void efi_remove_configuration_table(int i)
1489{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001490 struct efi_configuration_table *this = &systab.tables[i];
1491 struct efi_configuration_table *next = &systab.tables[i + 1];
1492 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Grafd98cdf62017-07-26 13:41:04 +02001493
1494 memmove(this, next, (ulong)end - (ulong)next);
1495 systab.nr_tables--;
1496}
1497
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001498/**
Mario Six78a88f72018-07-10 08:40:17 +02001499 * efi_install_configuration_table() - adds, updates, or removes a
1500 * configuration table
1501 * @guid: GUID of the installed table
1502 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001503 *
1504 * This function is used for internal calls. For the API implementation of the
1505 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1506 *
Mario Six78a88f72018-07-10 08:40:17 +02001507 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001508 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001509efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1510 void *table)
Alexander Grafbee91162016-03-04 01:09:59 +01001511{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001512 struct efi_event *evt;
Alexander Grafbee91162016-03-04 01:09:59 +01001513 int i;
1514
Heinrich Schuchardteb68b4e2018-02-18 00:08:00 +01001515 if (!guid)
1516 return EFI_INVALID_PARAMETER;
1517
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001518 /* Check for GUID override */
Alexander Grafbee91162016-03-04 01:09:59 +01001519 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001520 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Grafd98cdf62017-07-26 13:41:04 +02001521 if (table)
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001522 systab.tables[i].table = table;
Alexander Grafd98cdf62017-07-26 13:41:04 +02001523 else
1524 efi_remove_configuration_table(i);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001525 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01001526 }
1527 }
1528
Alexander Grafd98cdf62017-07-26 13:41:04 +02001529 if (!table)
1530 return EFI_NOT_FOUND;
1531
Alexander Grafbee91162016-03-04 01:09:59 +01001532 /* No override, check for overflow */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001533 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Graf488bf122016-08-19 01:23:24 +02001534 return EFI_OUT_OF_RESOURCES;
Alexander Grafbee91162016-03-04 01:09:59 +01001535
1536 /* Add a new entry */
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02001537 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1538 systab.tables[i].table = table;
Alexander Grafaba5e912016-08-19 01:23:30 +02001539 systab.nr_tables = i + 1;
Alexander Grafbee91162016-03-04 01:09:59 +01001540
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001541out:
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001542 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardt55d8ee32018-07-07 15:36:05 +02001543 efi_update_table_header_crc32(&systab.hdr);
1544
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001545 /* Notify that the configuration table was changed */
1546 list_for_each_entry(evt, &efi_events, link) {
1547 if (evt->group && !guidcmp(evt->group, guid)) {
1548 efi_signal_event(evt, false);
1549 break;
1550 }
1551 }
1552
Alexander Graf488bf122016-08-19 01:23:24 +02001553 return EFI_SUCCESS;
1554}
1555
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001556/**
Mario Six78a88f72018-07-10 08:40:17 +02001557 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1558 * configuration table.
1559 * @guid: GUID of the installed table
1560 * @table: table to be installed
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001561 *
1562 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001563 *
Mario Six78a88f72018-07-10 08:40:17 +02001564 * See the Unified Extensible Firmware Interface (UEFI) specification for
1565 * details.
1566 *
1567 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001568 */
Alexander Graf488bf122016-08-19 01:23:24 +02001569static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1570 void *table)
1571{
Rob Clark778e6af2017-09-13 18:05:41 -04001572 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Graf488bf122016-08-19 01:23:24 +02001573 return EFI_EXIT(efi_install_configuration_table(guid, table));
Alexander Grafbee91162016-03-04 01:09:59 +01001574}
1575
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001576/**
Mario Six78a88f72018-07-10 08:40:17 +02001577 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001578 *
1579 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clark95c55532017-09-13 18:05:33 -04001580 * protocols, boot-device, etc.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001581 *
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001582 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1583 * code is returned.
1584 *
1585 * @device_path: device path of the loaded image
1586 * @file_path: file path of the loaded image
1587 * @handle_ptr: handle of the loaded image
1588 * @info_ptr: loaded image protocol
1589 * Return: status code
Rob Clark95c55532017-09-13 18:05:33 -04001590 */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001591efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1592 struct efi_device_path *file_path,
1593 struct efi_loaded_image_obj **handle_ptr,
1594 struct efi_loaded_image **info_ptr)
Rob Clark95c55532017-09-13 18:05:33 -04001595{
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001596 efi_status_t ret;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001597 struct efi_loaded_image *info = NULL;
1598 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001599 struct efi_device_path *dp;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001600
1601 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1602 *handle_ptr = NULL;
1603 *info_ptr = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001604
1605 info = calloc(1, sizeof(*info));
1606 if (!info)
1607 return EFI_OUT_OF_RESOURCES;
1608 obj = calloc(1, sizeof(*obj));
1609 if (!obj) {
1610 free(info);
1611 return EFI_OUT_OF_RESOURCES;
1612 }
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02001613 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001614
Heinrich Schuchardt44549d62017-11-26 14:05:23 +01001615 /* Add internal object to object list */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001616 efi_add_handle(&obj->header);
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001617
Heinrich Schuchardt95147312018-07-05 08:17:58 +02001618 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Rob Clark95c55532017-09-13 18:05:33 -04001619 info->file_path = file_path;
Heinrich Schuchardt7e1effc2018-08-26 15:31:52 +02001620 info->system_table = &systab;
Rob Clark95c55532017-09-13 18:05:33 -04001621
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001622 if (device_path) {
1623 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001624
1625 dp = efi_dp_append(device_path, file_path);
1626 if (!dp) {
1627 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001628 goto failure;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001629 }
1630 } else {
1631 dp = NULL;
Heinrich Schuchardt7df5af62018-01-26 06:50:54 +01001632 }
AKASHI Takahirobc8fc322019-03-27 13:40:32 +09001633 ret = efi_add_protocol(&obj->header,
1634 &efi_guid_loaded_image_device_path, dp);
1635 if (ret != EFI_SUCCESS)
1636 goto failure;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001637
1638 /*
1639 * When asking for the loaded_image interface, just
1640 * return handle which points to loaded_image_info
1641 */
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +02001642 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001643 &efi_guid_loaded_image, info);
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001644 if (ret != EFI_SUCCESS)
1645 goto failure;
1646
Heinrich Schuchardtd5974af2019-03-19 18:58:58 +01001647 *info_ptr = info;
1648 *handle_ptr = obj;
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001649
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001650 return ret;
Heinrich Schuchardt48b66232017-10-26 19:25:58 +02001651failure:
1652 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt16112f92019-02-06 19:41:29 +01001653 efi_delete_handle(&obj->header);
1654 free(info);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +01001655 return ret;
Rob Clark95c55532017-09-13 18:05:33 -04001656}
1657
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001658/**
Mario Six78a88f72018-07-10 08:40:17 +02001659 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001660 *
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001661 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1662 * callers obligation to update the memory type as needed.
1663 *
1664 * @file_path: the path of the image to load
1665 * @buffer: buffer containing the loaded image
1666 * @size: size of the loaded image
1667 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001668 */
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09001669static
Rob Clark9975fe92017-09-13 18:05:38 -04001670efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001671 void **buffer, efi_uintn_t *size)
Rob Clark838ee4b2017-09-13 18:05:35 -04001672{
1673 struct efi_file_info *info = NULL;
1674 struct efi_file_handle *f;
1675 static efi_status_t ret;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001676 u64 addr;
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001677 efi_uintn_t bs;
Rob Clark838ee4b2017-09-13 18:05:35 -04001678
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001679 /* In case of failure nothing is returned */
1680 *buffer = NULL;
1681 *size = 0;
1682
1683 /* Open file */
Rob Clark838ee4b2017-09-13 18:05:35 -04001684 f = efi_file_from_path(file_path);
1685 if (!f)
1686 return EFI_DEVICE_ERROR;
1687
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001688 /* Get file size */
Rob Clark838ee4b2017-09-13 18:05:35 -04001689 bs = 0;
1690 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1691 &bs, info));
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001692 if (ret != EFI_BUFFER_TOO_SMALL) {
1693 ret = EFI_DEVICE_ERROR;
1694 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001695 }
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001696
1697 info = malloc(bs);
1698 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1699 info));
Rob Clark838ee4b2017-09-13 18:05:35 -04001700 if (ret != EFI_SUCCESS)
1701 goto error;
1702
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001703 /*
1704 * When reading the file we do not yet know if it contains an
1705 * application, a boottime driver, or a runtime driver. So here we
1706 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1707 * update the reservation according to the image type.
1708 */
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001709 bs = info->file_size;
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001710 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1711 EFI_BOOT_SERVICES_DATA,
1712 efi_size_in_pages(bs), &addr);
Rob Clark838ee4b2017-09-13 18:05:35 -04001713 if (ret != EFI_SUCCESS) {
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001714 ret = EFI_OUT_OF_RESOURCES;
1715 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001716 }
1717
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001718 /* Read file */
1719 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1720 if (ret != EFI_SUCCESS)
1721 efi_free_pages(addr, efi_size_in_pages(bs));
1722 *buffer = (void *)(uintptr_t)addr;
1723 *size = bs;
1724error:
1725 EFI_CALL(f->close(f));
1726 free(info);
Rob Clark838ee4b2017-09-13 18:05:35 -04001727 return ret;
1728}
1729
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001730/**
Mario Six78a88f72018-07-10 08:40:17 +02001731 * efi_load_image() - load an EFI image into memory
1732 * @boot_policy: true for request originating from the boot manager
1733 * @parent_image: the caller's image handle
1734 * @file_path: the path of the image to load
1735 * @source_buffer: memory location from which the image is installed
1736 * @source_size: size of the memory area from which the image is installed
1737 * @image_handle: handle for the newly installed image
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001738 *
1739 * This function implements the LoadImage service.
Mario Six78a88f72018-07-10 08:40:17 +02001740 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001741 * See the Unified Extensible Firmware Interface (UEFI) specification
1742 * for details.
1743 *
Mario Six78a88f72018-07-10 08:40:17 +02001744 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001745 */
AKASHI Takahirod7e0b012019-03-05 14:53:31 +09001746efi_status_t EFIAPI efi_load_image(bool boot_policy,
1747 efi_handle_t parent_image,
1748 struct efi_device_path *file_path,
1749 void *source_buffer,
1750 efi_uintn_t source_size,
1751 efi_handle_t *image_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001752{
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001753 struct efi_device_path *dp, *fp;
Tom Rini1c3b2f42018-09-30 10:38:15 -04001754 struct efi_loaded_image *info = NULL;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +02001755 struct efi_loaded_image_obj **image_obj =
1756 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001757 efi_status_t ret;
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001758 void *dest_buffer;
Alexander Grafbee91162016-03-04 01:09:59 +01001759
Heinrich Schuchardt7fb96a12018-04-03 22:29:30 +02001760 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafbee91162016-03-04 01:09:59 +01001761 file_path, source_buffer, source_size, image_handle);
Rob Clark838ee4b2017-09-13 18:05:35 -04001762
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001763 if (!image_handle || !parent_image) {
1764 ret = EFI_INVALID_PARAMETER;
1765 goto error;
1766 }
1767
1768 if (!source_buffer && !file_path) {
1769 ret = EFI_NOT_FOUND;
1770 goto error;
1771 }
1772
Rob Clark838ee4b2017-09-13 18:05:35 -04001773 if (!source_buffer) {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001774 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001775 &source_size);
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001776 if (ret != EFI_SUCCESS)
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001777 goto error;
Rob Clark838ee4b2017-09-13 18:05:35 -04001778 } else {
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001779 dest_buffer = source_buffer;
Rob Clark838ee4b2017-09-13 18:05:35 -04001780 }
Heinrich Schuchardt1e15a9c2019-04-20 19:24:43 +00001781 /* split file_path which contains both the device and file parts */
1782 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardt0e18f582018-12-24 09:19:07 +01001783 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardtb0c3c342019-03-04 17:50:05 +01001784 if (ret == EFI_SUCCESS)
1785 ret = efi_load_pe(*image_obj, dest_buffer, info);
1786 if (!source_buffer)
1787 /* Release buffer to which file was loaded */
1788 efi_free_pages((uintptr_t)dest_buffer,
1789 efi_size_in_pages(source_size));
1790 if (ret == EFI_SUCCESS) {
1791 info->system_table = &systab;
1792 info->parent_handle = parent_image;
1793 } else {
1794 /* The image is invalid. Release all associated resources. */
1795 efi_delete_handle(*image_handle);
1796 *image_handle = NULL;
1797 free(info);
1798 }
Heinrich Schuchardt28a4fd42018-03-07 02:40:51 +01001799error:
Heinrich Schuchardtb9b17592017-12-04 18:03:03 +01001800 return EFI_EXIT(ret);
Alexander Grafbee91162016-03-04 01:09:59 +01001801}
1802
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001803/**
Alexander Graff31239a2018-11-15 21:23:47 +01001804 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1805 */
1806static void efi_exit_caches(void)
1807{
1808#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1809 /*
1810 * Grub on 32bit ARM needs to have caches disabled before jumping into
1811 * a zImage, but does not know of all cache layers. Give it a hand.
1812 */
1813 if (efi_is_direct_boot)
1814 cleanup_before_linux();
1815#endif
1816}
1817
1818/**
Mario Six78a88f72018-07-10 08:40:17 +02001819 * efi_exit_boot_services() - stop all boot services
1820 * @image_handle: handle of the loaded image
1821 * @map_key: key of the memory map
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001822 *
1823 * This function implements the ExitBootServices service.
Mario Six78a88f72018-07-10 08:40:17 +02001824 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001825 * See the Unified Extensible Firmware Interface (UEFI) specification
1826 * for details.
1827 *
Mario Six78a88f72018-07-10 08:40:17 +02001828 * All timer events are disabled. For exit boot services events the
1829 * notification function is called. The boot services are disabled in the
1830 * system table.
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001831 *
Mario Six78a88f72018-07-10 08:40:17 +02001832 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001833 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001834static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01001835 unsigned long map_key)
1836{
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001837 struct efi_event *evt;
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001838
Alexander Grafbee91162016-03-04 01:09:59 +01001839 EFI_ENTRY("%p, %ld", image_handle, map_key);
1840
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +02001841 /* Check that the caller has read the current memory map */
1842 if (map_key != efi_memory_map_key)
1843 return EFI_INVALID_PARAMETER;
1844
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001845 /* Make sure that notification functions are not called anymore */
1846 efi_tpl = TPL_HIGH_LEVEL;
1847
1848 /* Check if ExitBootServices has already been called */
1849 if (!systab.boottime)
1850 return EFI_EXIT(EFI_SUCCESS);
1851
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001852 /* Add related events to the event group */
1853 list_for_each_entry(evt, &efi_events, link) {
1854 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1855 evt->group = &efi_guid_event_group_exit_boot_services;
1856 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001857 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt43bce442018-02-18 15:17:50 +01001858 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +01001859 if (evt->group &&
1860 !guidcmp(evt->group,
1861 &efi_guid_event_group_exit_boot_services)) {
1862 efi_signal_event(evt, false);
1863 break;
1864 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001865 }
Heinrich Schuchardt152a2632017-09-15 10:06:18 +02001866
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001867 /* TODO: Should persist EFI variables here */
Rob Clarkad644e72017-09-13 18:05:37 -04001868
Alexander Grafb7b84102016-11-17 01:02:57 +01001869 board_quiesce_devices();
1870
Alexander Graff31239a2018-11-15 21:23:47 +01001871 /* Fix up caches for EFI payloads if necessary */
1872 efi_exit_caches();
1873
Alexander Grafbee91162016-03-04 01:09:59 +01001874 /* This stops all lingering devices */
1875 bootm_disable_interrupts();
1876
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02001877 /* Disable boot time services */
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001878 systab.con_in_handle = NULL;
1879 systab.con_in = NULL;
1880 systab.con_out_handle = NULL;
1881 systab.con_out = NULL;
1882 systab.stderr_handle = NULL;
1883 systab.std_err = NULL;
1884 systab.boottime = NULL;
1885
1886 /* Recalculate CRC32 */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02001887 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +01001888
Alexander Grafbee91162016-03-04 01:09:59 +01001889 /* Give the payload some time to boot */
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001890 efi_set_watchdog(0);
Alexander Grafbee91162016-03-04 01:09:59 +01001891 WATCHDOG_RESET();
1892
1893 return EFI_EXIT(EFI_SUCCESS);
1894}
1895
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001896/**
Mario Six78a88f72018-07-10 08:40:17 +02001897 * efi_get_next_monotonic_count() - get next value of the counter
1898 * @count: returned value of the counter
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001899 *
1900 * This function implements the NextMonotonicCount service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001901 *
Mario Six78a88f72018-07-10 08:40:17 +02001902 * See the Unified Extensible Firmware Interface (UEFI) specification for
1903 * details.
1904 *
1905 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001906 */
Alexander Grafbee91162016-03-04 01:09:59 +01001907static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1908{
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01001909 static uint64_t mono;
1910
Alexander Grafbee91162016-03-04 01:09:59 +01001911 EFI_ENTRY("%p", count);
1912 *count = mono++;
1913 return EFI_EXIT(EFI_SUCCESS);
1914}
1915
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001916/**
Mario Six78a88f72018-07-10 08:40:17 +02001917 * efi_stall() - sleep
1918 * @microseconds: period to sleep in microseconds
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001919 *
Mario Six78a88f72018-07-10 08:40:17 +02001920 * This function implements the Stall service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001921 *
Mario Six78a88f72018-07-10 08:40:17 +02001922 * See the Unified Extensible Firmware Interface (UEFI) specification for
1923 * details.
1924 *
1925 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001926 */
Alexander Grafbee91162016-03-04 01:09:59 +01001927static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1928{
1929 EFI_ENTRY("%ld", microseconds);
1930 udelay(microseconds);
1931 return EFI_EXIT(EFI_SUCCESS);
1932}
1933
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001934/**
Mario Six78a88f72018-07-10 08:40:17 +02001935 * efi_set_watchdog_timer() - reset the watchdog timer
1936 * @timeout: seconds before reset by watchdog
1937 * @watchdog_code: code to be logged when resetting
1938 * @data_size: size of buffer in bytes
1939 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001940 *
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001941 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001942 *
Mario Six78a88f72018-07-10 08:40:17 +02001943 * See the Unified Extensible Firmware Interface (UEFI) specification for
1944 * details.
1945 *
1946 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001947 */
Alexander Grafbee91162016-03-04 01:09:59 +01001948static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1949 uint64_t watchdog_code,
1950 unsigned long data_size,
1951 uint16_t *watchdog_data)
1952{
Masahiro Yamadadee37fc2018-08-06 20:47:40 +09001953 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafbee91162016-03-04 01:09:59 +01001954 data_size, watchdog_data);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +02001955 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafbee91162016-03-04 01:09:59 +01001956}
1957
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02001958/**
Mario Six78a88f72018-07-10 08:40:17 +02001959 * efi_close_protocol() - close a protocol
1960 * @handle: handle on which the protocol shall be closed
1961 * @protocol: GUID of the protocol to close
1962 * @agent_handle: handle of the driver
1963 * @controller_handle: handle of the controller
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001964 *
1965 * This function implements the CloseProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001966 *
Mario Six78a88f72018-07-10 08:40:17 +02001967 * See the Unified Extensible Firmware Interface (UEFI) specification for
1968 * details.
1969 *
1970 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02001971 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001972static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02001973 const efi_guid_t *protocol,
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01001974 efi_handle_t agent_handle,
1975 efi_handle_t controller_handle)
Alexander Grafbee91162016-03-04 01:09:59 +01001976{
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001977 struct efi_handler *handler;
1978 struct efi_open_protocol_info_item *item;
1979 struct efi_open_protocol_info_item *pos;
1980 efi_status_t r;
1981
Rob Clark778e6af2017-09-13 18:05:41 -04001982 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafbee91162016-03-04 01:09:59 +01001983 controller_handle);
Heinrich Schuchardt3b8a4892018-01-11 08:15:59 +01001984
1985 if (!agent_handle) {
1986 r = EFI_INVALID_PARAMETER;
1987 goto out;
1988 }
1989 r = efi_search_protocol(handle, protocol, &handler);
1990 if (r != EFI_SUCCESS)
1991 goto out;
1992
1993 r = EFI_NOT_FOUND;
1994 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1995 if (item->info.agent_handle == agent_handle &&
1996 item->info.controller_handle == controller_handle) {
1997 efi_delete_open_info(item);
1998 r = EFI_SUCCESS;
1999 break;
2000 }
2001 }
2002out:
2003 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002004}
2005
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002006/**
Mario Six78a88f72018-07-10 08:40:17 +02002007 * efi_open_protocol_information() - provide information about then open status
2008 * of a protocol on a handle
2009 * @handle: handle for which the information shall be retrieved
2010 * @protocol: GUID of the protocol
2011 * @entry_buffer: buffer to receive the open protocol information
2012 * @entry_count: number of entries available in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002013 *
2014 * This function implements the OpenProtocolInformation service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002015 *
Mario Six78a88f72018-07-10 08:40:17 +02002016 * See the Unified Extensible Firmware Interface (UEFI) specification for
2017 * details.
2018 *
2019 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002020 */
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01002021static efi_status_t EFIAPI efi_open_protocol_information(
2022 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002023 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002024 efi_uintn_t *entry_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002025{
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002026 unsigned long buffer_size;
2027 unsigned long count;
2028 struct efi_handler *handler;
2029 struct efi_open_protocol_info_item *item;
2030 efi_status_t r;
2031
Rob Clark778e6af2017-09-13 18:05:41 -04002032 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafbee91162016-03-04 01:09:59 +01002033 entry_count);
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002034
2035 /* Check parameters */
2036 if (!entry_buffer) {
2037 r = EFI_INVALID_PARAMETER;
2038 goto out;
2039 }
2040 r = efi_search_protocol(handle, protocol, &handler);
2041 if (r != EFI_SUCCESS)
2042 goto out;
2043
2044 /* Count entries */
2045 count = 0;
2046 list_for_each_entry(item, &handler->open_infos, link) {
2047 if (item->info.open_count)
2048 ++count;
2049 }
2050 *entry_count = count;
2051 *entry_buffer = NULL;
2052 if (!count) {
2053 r = EFI_SUCCESS;
2054 goto out;
2055 }
2056
2057 /* Copy entries */
2058 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002059 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardte3fbbc32018-01-11 08:16:00 +01002060 (void **)entry_buffer);
2061 if (r != EFI_SUCCESS)
2062 goto out;
2063 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2064 if (item->info.open_count)
2065 (*entry_buffer)[--count] = item->info;
2066 }
2067out:
2068 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002069}
2070
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002071/**
Mario Six78a88f72018-07-10 08:40:17 +02002072 * efi_protocols_per_handle() - get protocols installed on a handle
2073 * @handle: handle for which the information is retrieved
2074 * @protocol_buffer: buffer with protocol GUIDs
2075 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002076 *
2077 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002078 *
Mario Six78a88f72018-07-10 08:40:17 +02002079 * See the Unified Extensible Firmware Interface (UEFI) specification for
2080 * details.
2081 *
2082 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002083 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002084static efi_status_t EFIAPI efi_protocols_per_handle(
2085 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002086 efi_uintn_t *protocol_buffer_count)
Alexander Grafbee91162016-03-04 01:09:59 +01002087{
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002088 unsigned long buffer_size;
2089 struct efi_object *efiobj;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002090 struct list_head *protocol_handle;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002091 efi_status_t r;
2092
Alexander Grafbee91162016-03-04 01:09:59 +01002093 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2094 protocol_buffer_count);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002095
2096 if (!handle || !protocol_buffer || !protocol_buffer_count)
2097 return EFI_EXIT(EFI_INVALID_PARAMETER);
2098
2099 *protocol_buffer = NULL;
Rob Clark661c8322017-07-20 07:59:39 -04002100 *protocol_buffer_count = 0;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002101
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002102 efiobj = efi_search_obj(handle);
2103 if (!efiobj)
2104 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002105
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002106 /* Count protocols */
2107 list_for_each(protocol_handle, &efiobj->protocols) {
2108 ++*protocol_buffer_count;
2109 }
2110
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002111 /* Copy GUIDs */
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002112 if (*protocol_buffer_count) {
2113 size_t j = 0;
2114
2115 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002116 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +01002117 (void **)protocol_buffer);
2118 if (r != EFI_SUCCESS)
2119 return EFI_EXIT(r);
2120 list_for_each(protocol_handle, &efiobj->protocols) {
2121 struct efi_handler *protocol;
2122
2123 protocol = list_entry(protocol_handle,
2124 struct efi_handler, link);
2125 (*protocol_buffer)[j] = (void *)protocol->guid;
2126 ++j;
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002127 }
xypron.glpk@gmx.dec0ebfc82017-07-13 23:24:32 +02002128 }
2129
2130 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002131}
2132
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002133/**
Mario Six78a88f72018-07-10 08:40:17 +02002134 * efi_locate_handle_buffer() - locate handles implementing a protocol
2135 * @search_type: selection criterion
2136 * @protocol: GUID of the protocol
2137 * @search_key: registration key
2138 * @no_handles: number of returned handles
2139 * @buffer: buffer with the returned handles
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002140 *
2141 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002142 *
Mario Six78a88f72018-07-10 08:40:17 +02002143 * See the Unified Extensible Firmware Interface (UEFI) specification for
2144 * details.
2145 *
2146 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002147 */
Alexander Grafbee91162016-03-04 01:09:59 +01002148static efi_status_t EFIAPI efi_locate_handle_buffer(
2149 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002150 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002151 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafbee91162016-03-04 01:09:59 +01002152{
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002153 efi_status_t r;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +01002154 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002155
Rob Clark778e6af2017-09-13 18:05:41 -04002156 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafbee91162016-03-04 01:09:59 +01002157 no_handles, buffer);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002158
2159 if (!no_handles || !buffer) {
2160 r = EFI_INVALID_PARAMETER;
2161 goto out;
2162 }
2163 *no_handles = 0;
2164 *buffer = NULL;
2165 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2166 *buffer);
2167 if (r != EFI_BUFFER_TOO_SMALL)
2168 goto out;
Heinrich Schuchardteee65302018-10-03 20:02:29 +02002169 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002170 (void **)buffer);
2171 if (r != EFI_SUCCESS)
2172 goto out;
2173 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2174 *buffer);
2175 if (r == EFI_SUCCESS)
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002176 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.dec2e703f2017-07-11 22:06:22 +02002177out:
2178 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002179}
2180
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002181/**
Mario Six78a88f72018-07-10 08:40:17 +02002182 * efi_locate_protocol() - find an interface implementing a protocol
2183 * @protocol: GUID of the protocol
2184 * @registration: registration key passed to the notification function
2185 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002186 *
2187 * This function implements the LocateProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002188 *
Mario Six78a88f72018-07-10 08:40:17 +02002189 * See the Unified Extensible Firmware Interface (UEFI) specification for
2190 * details.
2191 *
2192 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002193 */
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002194static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002195 void *registration,
2196 void **protocol_interface)
2197{
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002198 struct list_head *lhandle;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002199 efi_status_t ret;
Alexander Grafbee91162016-03-04 01:09:59 +01002200
Rob Clark778e6af2017-09-13 18:05:41 -04002201 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002202
2203 if (!protocol || !protocol_interface)
2204 return EFI_EXIT(EFI_INVALID_PARAMETER);
2205
2206 list_for_each(lhandle, &efi_obj_list) {
2207 struct efi_object *efiobj;
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002208 struct efi_handler *handler;
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002209
2210 efiobj = list_entry(lhandle, struct efi_object, link);
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002211
Heinrich Schuchardtfae01182018-09-26 05:27:55 +02002212 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardt9172cd92017-10-26 19:25:57 +02002213 if (ret == EFI_SUCCESS) {
2214 *protocol_interface = handler->protocol_interface;
2215 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002216 }
2217 }
xypron.glpk@gmx.de88adae52017-07-11 22:06:24 +02002218 *protocol_interface = NULL;
Alexander Grafbee91162016-03-04 01:09:59 +01002219
2220 return EFI_EXIT(EFI_NOT_FOUND);
2221}
2222
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002223/**
Mario Six78a88f72018-07-10 08:40:17 +02002224 * efi_locate_device_path() - Get the device path and handle of an device
2225 * implementing a protocol
2226 * @protocol: GUID of the protocol
2227 * @device_path: device path
2228 * @device: handle of the device
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002229 *
2230 * This function implements the LocateDevicePath service.
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002231 *
Mario Six78a88f72018-07-10 08:40:17 +02002232 * See the Unified Extensible Firmware Interface (UEFI) specification for
2233 * details.
2234 *
2235 * Return: status code
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002236 */
2237static efi_status_t EFIAPI efi_locate_device_path(
2238 const efi_guid_t *protocol,
2239 struct efi_device_path **device_path,
2240 efi_handle_t *device)
2241{
2242 struct efi_device_path *dp;
2243 size_t i;
2244 struct efi_handler *handler;
2245 efi_handle_t *handles;
2246 size_t len, len_dp;
2247 size_t len_best = 0;
2248 efi_uintn_t no_handles;
2249 u8 *remainder;
2250 efi_status_t ret;
2251
2252 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2253
2254 if (!protocol || !device_path || !*device_path || !device) {
2255 ret = EFI_INVALID_PARAMETER;
2256 goto out;
2257 }
2258
2259 /* Find end of device path */
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002260 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002261
2262 /* Get all handles implementing the protocol */
2263 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2264 &no_handles, &handles));
2265 if (ret != EFI_SUCCESS)
2266 goto out;
2267
2268 for (i = 0; i < no_handles; ++i) {
2269 /* Find the device path protocol */
2270 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2271 &handler);
2272 if (ret != EFI_SUCCESS)
2273 continue;
2274 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +02002275 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardtae2c85c2017-11-26 14:05:10 +01002276 /*
2277 * This handle can only be a better fit
2278 * if its device path length is longer than the best fit and
2279 * if its device path length is shorter of equal the searched
2280 * device path.
2281 */
2282 if (len_dp <= len_best || len_dp > len)
2283 continue;
2284 /* Check if dp is a subpath of device_path */
2285 if (memcmp(*device_path, dp, len_dp))
2286 continue;
2287 *device = handles[i];
2288 len_best = len_dp;
2289 }
2290 if (len_best) {
2291 remainder = (u8 *)*device_path + len_best;
2292 *device_path = (struct efi_device_path *)remainder;
2293 ret = EFI_SUCCESS;
2294 } else {
2295 ret = EFI_NOT_FOUND;
2296 }
2297out:
2298 return EFI_EXIT(ret);
2299}
2300
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002301/**
Mario Six78a88f72018-07-10 08:40:17 +02002302 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2303 * interfaces
2304 * @handle: handle on which the protocol interfaces shall be installed
2305 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2306 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002307 *
2308 * This function implements the MultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002309 *
Mario Six78a88f72018-07-10 08:40:17 +02002310 * See the Unified Extensible Firmware Interface (UEFI) specification for
2311 * details.
2312 *
2313 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002314 */
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +02002315efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002316 (efi_handle_t *handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002317{
2318 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002319
Alexander Grafbeb077a2018-06-18 17:23:05 +02002320 efi_va_list argptr;
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002321 const efi_guid_t *protocol;
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002322 void *protocol_interface;
2323 efi_status_t r = EFI_SUCCESS;
2324 int i = 0;
2325
2326 if (!handle)
2327 return EFI_EXIT(EFI_INVALID_PARAMETER);
2328
Alexander Grafbeb077a2018-06-18 17:23:05 +02002329 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002330 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002331 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002332 if (!protocol)
2333 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002334 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01002335 r = EFI_CALL(efi_install_protocol_interface(
2336 handle, protocol,
2337 EFI_NATIVE_INTERFACE,
2338 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002339 if (r != EFI_SUCCESS)
2340 break;
2341 i++;
2342 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002343 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002344 if (r == EFI_SUCCESS)
2345 return EFI_EXIT(r);
2346
Heinrich Schuchardt62471e42017-10-26 19:25:42 +02002347 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002348 efi_va_start(argptr, handle);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002349 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002350 protocol = efi_va_arg(argptr, efi_guid_t*);
2351 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002352 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01002353 protocol_interface));
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002354 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002355 efi_va_end(argptr);
xypron.glpk@gmx.de58b83582017-07-11 22:06:20 +02002356
2357 return EFI_EXIT(r);
Alexander Grafbee91162016-03-04 01:09:59 +01002358}
2359
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002360/**
Mario Six78a88f72018-07-10 08:40:17 +02002361 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2362 * interfaces
2363 * @handle: handle from which the protocol interfaces shall be removed
2364 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2365 * interfaces
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002366 *
2367 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002368 *
Mario Six78a88f72018-07-10 08:40:17 +02002369 * See the Unified Extensible Firmware Interface (UEFI) specification for
2370 * details.
2371 *
2372 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002373 */
Alexander Grafbee91162016-03-04 01:09:59 +01002374static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002375 efi_handle_t handle, ...)
Alexander Grafbee91162016-03-04 01:09:59 +01002376{
2377 EFI_ENTRY("%p", handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002378
Alexander Grafbeb077a2018-06-18 17:23:05 +02002379 efi_va_list argptr;
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002380 const efi_guid_t *protocol;
2381 void *protocol_interface;
2382 efi_status_t r = EFI_SUCCESS;
2383 size_t i = 0;
2384
2385 if (!handle)
2386 return EFI_EXIT(EFI_INVALID_PARAMETER);
2387
Alexander Grafbeb077a2018-06-18 17:23:05 +02002388 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002389 for (;;) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002390 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002391 if (!protocol)
2392 break;
Alexander Grafbeb077a2018-06-18 17:23:05 +02002393 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002394 r = efi_uninstall_protocol(handle, protocol,
2395 protocol_interface);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002396 if (r != EFI_SUCCESS)
2397 break;
2398 i++;
2399 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002400 efi_va_end(argptr);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002401 if (r == EFI_SUCCESS) {
2402 /* If the last protocol has been removed, delete the handle. */
2403 if (list_empty(&handle->protocols)) {
2404 list_del(&handle->link);
2405 free(handle);
2406 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002407 return EFI_EXIT(r);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02002408 }
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002409
2410 /* If an error occurred undo all changes. */
Alexander Grafbeb077a2018-06-18 17:23:05 +02002411 efi_va_start(argptr, handle);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002412 for (; i; --i) {
Alexander Grafbeb077a2018-06-18 17:23:05 +02002413 protocol = efi_va_arg(argptr, efi_guid_t*);
2414 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002415 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2416 EFI_NATIVE_INTERFACE,
2417 protocol_interface));
2418 }
Alexander Grafbeb077a2018-06-18 17:23:05 +02002419 efi_va_end(argptr);
Heinrich Schuchardt843ce542017-10-26 19:25:44 +02002420
Heinrich Schuchardte2373022018-09-24 19:57:27 +02002421 /* In case of an error always return EFI_INVALID_PARAMETER */
2422 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafbee91162016-03-04 01:09:59 +01002423}
2424
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002425/**
Mario Six78a88f72018-07-10 08:40:17 +02002426 * efi_calculate_crc32() - calculate cyclic redundancy code
2427 * @data: buffer with data
2428 * @data_size: size of buffer in bytes
2429 * @crc32_p: cyclic redundancy code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002430 *
2431 * This function implements the CalculateCrc32 service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002432 *
Mario Six78a88f72018-07-10 08:40:17 +02002433 * See the Unified Extensible Firmware Interface (UEFI) specification for
2434 * details.
2435 *
2436 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002437 */
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002438static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2439 efi_uintn_t data_size,
2440 u32 *crc32_p)
Alexander Grafbee91162016-03-04 01:09:59 +01002441{
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +02002442 EFI_ENTRY("%p, %zu", data, data_size);
Alexander Grafbee91162016-03-04 01:09:59 +01002443 *crc32_p = crc32(0, data, data_size);
2444 return EFI_EXIT(EFI_SUCCESS);
2445}
2446
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002447/**
Mario Six78a88f72018-07-10 08:40:17 +02002448 * efi_copy_mem() - copy memory
2449 * @destination: destination of the copy operation
2450 * @source: source of the copy operation
2451 * @length: number of bytes to copy
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002452 *
2453 * This function implements the CopyMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002454 *
Mario Six78a88f72018-07-10 08:40:17 +02002455 * See the Unified Extensible Firmware Interface (UEFI) specification for
2456 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002457 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002458static void EFIAPI efi_copy_mem(void *destination, const void *source,
2459 size_t length)
Alexander Grafbee91162016-03-04 01:09:59 +01002460{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002461 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardt0bc81a72019-01-09 21:41:13 +01002462 memmove(destination, source, length);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002463 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002464}
2465
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002466/**
Mario Six78a88f72018-07-10 08:40:17 +02002467 * efi_set_mem() - Fill memory with a byte value.
2468 * @buffer: buffer to fill
2469 * @size: size of buffer in bytes
2470 * @value: byte to copy to the buffer
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002471 *
2472 * This function implements the SetMem service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002473 *
Mario Six78a88f72018-07-10 08:40:17 +02002474 * See the Unified Extensible Firmware Interface (UEFI) specification for
2475 * details.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002476 */
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002477static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafbee91162016-03-04 01:09:59 +01002478{
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +02002479 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafbee91162016-03-04 01:09:59 +01002480 memset(buffer, value, size);
Heinrich Schuchardtf7c78172017-10-05 16:35:51 +02002481 EFI_EXIT(EFI_SUCCESS);
Alexander Grafbee91162016-03-04 01:09:59 +01002482}
2483
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002484/**
Mario Six78a88f72018-07-10 08:40:17 +02002485 * efi_protocol_open() - open protocol interface on a handle
2486 * @handler: handler of a protocol
2487 * @protocol_interface: interface implementing the protocol
2488 * @agent_handle: handle of the driver
2489 * @controller_handle: handle of the controller
2490 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002491 *
Mario Six78a88f72018-07-10 08:40:17 +02002492 * Return: status code
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002493 */
2494static efi_status_t efi_protocol_open(
2495 struct efi_handler *handler,
2496 void **protocol_interface, void *agent_handle,
2497 void *controller_handle, uint32_t attributes)
2498{
2499 struct efi_open_protocol_info_item *item;
2500 struct efi_open_protocol_info_entry *match = NULL;
2501 bool opened_by_driver = false;
2502 bool opened_exclusive = false;
2503
2504 /* If there is no agent, only return the interface */
2505 if (!agent_handle)
2506 goto out;
2507
2508 /* For TEST_PROTOCOL ignore interface attribute */
2509 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2510 *protocol_interface = NULL;
2511
2512 /*
2513 * Check if the protocol is already opened by a driver with the same
2514 * attributes or opened exclusively
2515 */
2516 list_for_each_entry(item, &handler->open_infos, link) {
2517 if (item->info.agent_handle == agent_handle) {
2518 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2519 (item->info.attributes == attributes))
2520 return EFI_ALREADY_STARTED;
2521 }
2522 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2523 opened_exclusive = true;
2524 }
2525
2526 /* Only one controller can open the protocol exclusively */
2527 if (opened_exclusive && attributes &
2528 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2529 return EFI_ACCESS_DENIED;
2530
2531 /* Prepare exclusive opening */
2532 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2533 /* Try to disconnect controllers */
2534 list_for_each_entry(item, &handler->open_infos, link) {
2535 if (item->info.attributes ==
2536 EFI_OPEN_PROTOCOL_BY_DRIVER)
2537 EFI_CALL(efi_disconnect_controller(
2538 item->info.controller_handle,
2539 item->info.agent_handle,
2540 NULL));
2541 }
2542 opened_by_driver = false;
2543 /* Check if all controllers are disconnected */
2544 list_for_each_entry(item, &handler->open_infos, link) {
2545 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2546 opened_by_driver = true;
2547 }
Heinrich Schuchardt4f37fa42018-09-30 13:40:43 +02002548 /* Only one controller can be connected */
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002549 if (opened_by_driver)
2550 return EFI_ACCESS_DENIED;
2551 }
2552
2553 /* Find existing entry */
2554 list_for_each_entry(item, &handler->open_infos, link) {
2555 if (item->info.agent_handle == agent_handle &&
2556 item->info.controller_handle == controller_handle)
2557 match = &item->info;
2558 }
2559 /* None found, create one */
2560 if (!match) {
2561 match = efi_create_open_info(handler);
2562 if (!match)
2563 return EFI_OUT_OF_RESOURCES;
2564 }
2565
2566 match->agent_handle = agent_handle;
2567 match->controller_handle = controller_handle;
2568 match->attributes = attributes;
2569 match->open_count++;
2570
2571out:
2572 /* For TEST_PROTOCOL ignore interface attribute. */
2573 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2574 *protocol_interface = handler->protocol_interface;
2575
2576 return EFI_SUCCESS;
2577}
2578
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002579/**
Mario Six78a88f72018-07-10 08:40:17 +02002580 * efi_open_protocol() - open protocol interface on a handle
2581 * @handle: handle on which the protocol shall be opened
2582 * @protocol: GUID of the protocol
2583 * @protocol_interface: interface implementing the protocol
2584 * @agent_handle: handle of the driver
2585 * @controller_handle: handle of the controller
2586 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002587 *
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002588 * This function implements the OpenProtocol interface.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002589 *
Mario Six78a88f72018-07-10 08:40:17 +02002590 * See the Unified Extensible Firmware Interface (UEFI) specification for
2591 * details.
2592 *
2593 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002594 */
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +02002595static efi_status_t EFIAPI efi_open_protocol
2596 (efi_handle_t handle, const efi_guid_t *protocol,
2597 void **protocol_interface, efi_handle_t agent_handle,
2598 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafbee91162016-03-04 01:09:59 +01002599{
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002600 struct efi_handler *handler;
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002601 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafbee91162016-03-04 01:09:59 +01002602
Rob Clark778e6af2017-09-13 18:05:41 -04002603 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002604 protocol_interface, agent_handle, controller_handle,
2605 attributes);
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002606
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002607 if (!handle || !protocol ||
2608 (!protocol_interface && attributes !=
2609 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2610 goto out;
2611 }
2612
2613 switch (attributes) {
2614 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2615 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2616 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2617 break;
2618 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2619 if (controller_handle == handle)
2620 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002621 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002622 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2623 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002624 /* Check that the controller handle is valid */
2625 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002626 goto out;
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002627 /* fall-through */
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002628 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002629 /* Check that the agent handle is valid */
2630 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.de69baec62017-07-11 22:06:15 +02002631 goto out;
2632 break;
2633 default:
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +02002634 goto out;
2635 }
2636
Heinrich Schuchardt80286e82017-11-26 14:05:15 +01002637 r = efi_search_protocol(handle, protocol, &handler);
2638 if (r != EFI_SUCCESS)
2639 goto out;
Alexander Grafbee91162016-03-04 01:09:59 +01002640
Heinrich Schuchardt191a41c2018-01-11 08:15:58 +01002641 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2642 controller_handle, attributes);
Alexander Grafbee91162016-03-04 01:09:59 +01002643out:
2644 return EFI_EXIT(r);
2645}
2646
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002647/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002648 * efi_start_image() - call the entry point of an image
2649 * @image_handle: handle of the image
2650 * @exit_data_size: size of the buffer
2651 * @exit_data: buffer to receive the exit data of the called image
2652 *
2653 * This function implements the StartImage service.
2654 *
2655 * See the Unified Extensible Firmware Interface (UEFI) specification for
2656 * details.
2657 *
2658 * Return: status code
2659 */
2660efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2661 efi_uintn_t *exit_data_size,
2662 u16 **exit_data)
2663{
2664 struct efi_loaded_image_obj *image_obj =
2665 (struct efi_loaded_image_obj *)image_handle;
2666 efi_status_t ret;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002667 void *info;
2668 efi_handle_t parent_image = current_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002669
2670 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2671
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002672 /* Check parameters */
2673 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2674 &info, NULL, NULL,
2675 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2676 if (ret != EFI_SUCCESS)
2677 return EFI_EXIT(EFI_INVALID_PARAMETER);
2678
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002679 efi_is_direct_boot = false;
2680
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002681 image_obj->exit_data_size = exit_data_size;
2682 image_obj->exit_data = exit_data;
2683
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002684 /* call the image! */
2685 if (setjmp(&image_obj->exit_jmp)) {
2686 /*
2687 * We called the entry point of the child image with EFI_CALL
2688 * in the lines below. The child image called the Exit() boot
2689 * service efi_exit() which executed the long jump that brought
2690 * us to the current line. This implies that the second half
2691 * of the EFI_CALL macro has not been executed.
2692 */
2693#ifdef CONFIG_ARM
2694 /*
2695 * efi_exit() called efi_restore_gd(). We have to undo this
2696 * otherwise __efi_entry_check() will put the wrong value into
2697 * app_gd.
2698 */
2699 gd = app_gd;
2700#endif
2701 /*
2702 * To get ready to call EFI_EXIT below we have to execute the
2703 * missed out steps of EFI_CALL.
2704 */
2705 assert(__efi_entry_check());
2706 debug("%sEFI: %lu returned by started image\n",
2707 __efi_nesting_dec(),
2708 (unsigned long)((uintptr_t)image_obj->exit_status &
2709 ~EFI_ERROR_MASK));
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002710 current_image = parent_image;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002711 return EFI_EXIT(image_obj->exit_status);
2712 }
2713
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002714 current_image = image_handle;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +02002715 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro6b95b382019-04-19 12:22:35 +09002716 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002717 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2718
2719 /*
2720 * Usually UEFI applications call Exit() instead of returning.
2721 * But because the world doesn't consist of ponies and unicorns,
2722 * we're happy to emulate that behavior on behalf of a payload
2723 * that forgot.
2724 */
2725 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2726}
2727
2728/**
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002729 * efi_delete_image() - delete loaded image from memory)
2730 *
2731 * @image_obj: handle of the loaded image
2732 * @loaded_image_protocol: loaded image protocol
2733 */
2734static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2735 struct efi_loaded_image *loaded_image_protocol)
2736{
2737 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2738 efi_size_in_pages(loaded_image_protocol->image_size));
2739 efi_delete_handle(&image_obj->header);
2740}
2741
2742/**
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002743 * efi_unload_image() - unload an EFI image
2744 * @image_handle: handle of the image to be unloaded
2745 *
2746 * This function implements the UnloadImage service.
2747 *
2748 * See the Unified Extensible Firmware Interface (UEFI) specification for
2749 * details.
2750 *
2751 * Return: status code
2752 */
2753efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2754{
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002755 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002756 struct efi_object *efiobj;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002757 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002758
2759 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002760
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +02002761 efiobj = efi_search_obj(image_handle);
2762 if (!efiobj) {
2763 ret = EFI_INVALID_PARAMETER;
2764 goto out;
2765 }
2766 /* Find the loaded image protocol */
2767 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2768 (void **)&loaded_image_protocol,
2769 NULL, NULL,
2770 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2771 if (ret != EFI_SUCCESS) {
2772 ret = EFI_INVALID_PARAMETER;
2773 goto out;
2774 }
2775 switch (efiobj->type) {
2776 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2777 /* Call the unload function */
2778 if (!loaded_image_protocol->unload) {
2779 ret = EFI_UNSUPPORTED;
2780 goto out;
2781 }
2782 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2783 if (ret != EFI_SUCCESS)
2784 goto out;
2785 break;
2786 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2787 break;
2788 default:
2789 ret = EFI_INVALID_PARAMETER;
2790 goto out;
2791 }
2792 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2793 loaded_image_protocol);
2794out:
2795 return EFI_EXIT(ret);
Heinrich Schuchardt46e99a92019-05-01 19:04:32 +02002796}
2797
2798/**
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002799 * efi_update_exit_data() - fill exit data parameters of StartImage()
2800 *
2801 * @image_obj image handle
2802 * @exit_data_size size of the exit data buffer
2803 * @exit_data buffer with data returned by UEFI payload
2804 * Return: status code
2805 */
2806static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2807 efi_uintn_t exit_data_size,
2808 u16 *exit_data)
2809{
2810 efi_status_t ret;
2811
2812 /*
2813 * If exit_data is not provided to StartImage(), exit_data_size must be
2814 * ignored.
2815 */
2816 if (!image_obj->exit_data)
2817 return EFI_SUCCESS;
2818 if (image_obj->exit_data_size)
2819 *image_obj->exit_data_size = exit_data_size;
2820 if (exit_data_size && exit_data) {
2821 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2822 exit_data_size,
2823 (void **)image_obj->exit_data);
2824 if (ret != EFI_SUCCESS)
2825 return ret;
2826 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2827 } else {
2828 image_obj->exit_data = NULL;
2829 }
2830 return EFI_SUCCESS;
2831}
2832
2833/**
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002834 * efi_exit() - leave an EFI application or driver
2835 * @image_handle: handle of the application or driver that is exiting
2836 * @exit_status: status code
2837 * @exit_data_size: size of the buffer in bytes
2838 * @exit_data: buffer with data describing an error
2839 *
2840 * This function implements the Exit service.
2841 *
2842 * See the Unified Extensible Firmware Interface (UEFI) specification for
2843 * details.
2844 *
2845 * Return: status code
2846 */
2847static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2848 efi_status_t exit_status,
2849 efi_uintn_t exit_data_size,
2850 u16 *exit_data)
2851{
2852 /*
2853 * TODO: We should call the unload procedure of the loaded
2854 * image protocol.
2855 */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002856 efi_status_t ret;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002857 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002858 struct efi_loaded_image_obj *image_obj =
2859 (struct efi_loaded_image_obj *)image_handle;
2860
2861 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2862 exit_data_size, exit_data);
2863
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002864 /* Check parameters */
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002865 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002866 (void **)&loaded_image_protocol,
2867 NULL, NULL,
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002868 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002869 if (ret != EFI_SUCCESS) {
2870 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002871 goto out;
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002872 }
2873
2874 /* Unloading of unstarted images */
2875 switch (image_obj->header.type) {
2876 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2877 break;
2878 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2879 efi_delete_image(image_obj, loaded_image_protocol);
2880 ret = EFI_SUCCESS;
2881 goto out;
2882 default:
2883 /* Handle does not refer to loaded image */
2884 ret = EFI_INVALID_PARAMETER;
2885 goto out;
2886 }
2887 /* A started image can only be unloaded it is the last one started. */
2888 if (image_handle != current_image) {
2889 ret = EFI_INVALID_PARAMETER;
2890 goto out;
2891 }
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002892
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002893 /* Exit data is only foreseen in case of failure. */
2894 if (exit_status != EFI_SUCCESS) {
2895 ret = efi_update_exit_data(image_obj, exit_data_size,
2896 exit_data);
2897 /* Exiting has priority. Don't return error to caller. */
2898 if (ret != EFI_SUCCESS)
2899 EFI_PRINT("%s: out of memory\n", __func__);
2900 }
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002901 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2902 exit_status != EFI_SUCCESS)
2903 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +02002904
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002905 /* Make sure entry/exit counts for EFI world cross-overs match */
2906 EFI_EXIT(exit_status);
2907
2908 /*
2909 * But longjmp out with the U-Boot gd, not the application's, as
2910 * the other end is a setjmp call inside EFI context.
2911 */
2912 efi_restore_gd();
2913
2914 image_obj->exit_status = exit_status;
2915 longjmp(&image_obj->exit_jmp, 1);
2916
2917 panic("EFI application exited");
Heinrich Schuchardtbb31c3f2019-03-26 19:03:17 +01002918out:
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +02002919 return EFI_EXIT(ret);
Heinrich Schuchardta115d562019-03-26 19:02:05 +01002920}
2921
2922/**
Mario Six78a88f72018-07-10 08:40:17 +02002923 * efi_handle_protocol() - get interface of a protocol on a handle
2924 * @handle: handle on which the protocol shall be opened
2925 * @protocol: GUID of the protocol
2926 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002927 *
2928 * This function implements the HandleProtocol service.
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002929 *
Mario Six78a88f72018-07-10 08:40:17 +02002930 * See the Unified Extensible Firmware Interface (UEFI) specification for
2931 * details.
2932 *
2933 * Return: status code
Heinrich Schuchardt332468f2017-09-21 18:30:11 +02002934 */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +01002935static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +02002936 const efi_guid_t *protocol,
Alexander Grafbee91162016-03-04 01:09:59 +01002937 void **protocol_interface)
2938{
xypron.glpk@gmx.de8e1d3292017-06-29 21:16:19 +02002939 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2940 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafbee91162016-03-04 01:09:59 +01002941}
2942
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002943/**
Mario Six78a88f72018-07-10 08:40:17 +02002944 * efi_bind_controller() - bind a single driver to a controller
2945 * @controller_handle: controller handle
2946 * @driver_image_handle: driver handle
2947 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002948 *
Mario Six78a88f72018-07-10 08:40:17 +02002949 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002950 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002951static efi_status_t efi_bind_controller(
2952 efi_handle_t controller_handle,
2953 efi_handle_t driver_image_handle,
2954 struct efi_device_path *remain_device_path)
2955{
2956 struct efi_driver_binding_protocol *binding_protocol;
2957 efi_status_t r;
2958
2959 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2960 &efi_guid_driver_binding_protocol,
2961 (void **)&binding_protocol,
2962 driver_image_handle, NULL,
2963 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2964 if (r != EFI_SUCCESS)
2965 return r;
2966 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2967 controller_handle,
2968 remain_device_path));
2969 if (r == EFI_SUCCESS)
2970 r = EFI_CALL(binding_protocol->start(binding_protocol,
2971 controller_handle,
2972 remain_device_path));
2973 EFI_CALL(efi_close_protocol(driver_image_handle,
2974 &efi_guid_driver_binding_protocol,
2975 driver_image_handle, NULL));
2976 return r;
2977}
2978
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002979/**
Mario Six78a88f72018-07-10 08:40:17 +02002980 * efi_connect_single_controller() - connect a single driver to a controller
2981 * @controller_handle: controller
2982 * @driver_image_handle: driver
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02002983 * @remain_device_path: remaining path
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002984 *
Mario Six78a88f72018-07-10 08:40:17 +02002985 * Return: status code
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02002986 */
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01002987static efi_status_t efi_connect_single_controller(
2988 efi_handle_t controller_handle,
2989 efi_handle_t *driver_image_handle,
2990 struct efi_device_path *remain_device_path)
2991{
2992 efi_handle_t *buffer;
2993 size_t count;
2994 size_t i;
2995 efi_status_t r;
2996 size_t connected = 0;
2997
2998 /* Get buffer with all handles with driver binding protocol */
2999 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3000 &efi_guid_driver_binding_protocol,
3001 NULL, &count, &buffer));
3002 if (r != EFI_SUCCESS)
3003 return r;
3004
3005 /* Context Override */
3006 if (driver_image_handle) {
3007 for (; *driver_image_handle; ++driver_image_handle) {
3008 for (i = 0; i < count; ++i) {
3009 if (buffer[i] == *driver_image_handle) {
3010 buffer[i] = NULL;
3011 r = efi_bind_controller(
3012 controller_handle,
3013 *driver_image_handle,
3014 remain_device_path);
3015 /*
3016 * For drivers that do not support the
3017 * controller or are already connected
3018 * we receive an error code here.
3019 */
3020 if (r == EFI_SUCCESS)
3021 ++connected;
3022 }
3023 }
3024 }
3025 }
3026
3027 /*
3028 * TODO: Some overrides are not yet implemented:
3029 * - Platform Driver Override
3030 * - Driver Family Override Search
3031 * - Bus Specific Driver Override
3032 */
3033
3034 /* Driver Binding Search */
3035 for (i = 0; i < count; ++i) {
3036 if (buffer[i]) {
3037 r = efi_bind_controller(controller_handle,
3038 buffer[i],
3039 remain_device_path);
3040 if (r == EFI_SUCCESS)
3041 ++connected;
3042 }
3043 }
3044
3045 efi_free_pool(buffer);
3046 if (!connected)
3047 return EFI_NOT_FOUND;
3048 return EFI_SUCCESS;
3049}
3050
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003051/**
Mario Six78a88f72018-07-10 08:40:17 +02003052 * efi_connect_controller() - connect a controller to a driver
3053 * @controller_handle: handle of the controller
3054 * @driver_image_handle: handle of the driver
3055 * @remain_device_path: device path of a child controller
3056 * @recursive: true to connect all child controllers
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003057 *
3058 * This function implements the ConnectController service.
Mario Six78a88f72018-07-10 08:40:17 +02003059 *
3060 * See the Unified Extensible Firmware Interface (UEFI) specification for
3061 * details.
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003062 *
3063 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003064 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003065 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3066 *
Mario Six78a88f72018-07-10 08:40:17 +02003067 * Return: status code
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003068 */
3069static efi_status_t EFIAPI efi_connect_controller(
3070 efi_handle_t controller_handle,
3071 efi_handle_t *driver_image_handle,
3072 struct efi_device_path *remain_device_path,
3073 bool recursive)
3074{
3075 efi_status_t r;
3076 efi_status_t ret = EFI_NOT_FOUND;
3077 struct efi_object *efiobj;
3078
Heinrich Schuchardtd1788362018-12-09 16:39:20 +01003079 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01003080 remain_device_path, recursive);
3081
3082 efiobj = efi_search_obj(controller_handle);
3083 if (!efiobj) {
3084 ret = EFI_INVALID_PARAMETER;
3085 goto out;
3086 }
3087
3088 r = efi_connect_single_controller(controller_handle,
3089 driver_image_handle,
3090 remain_device_path);
3091 if (r == EFI_SUCCESS)
3092 ret = EFI_SUCCESS;
3093 if (recursive) {
3094 struct efi_handler *handler;
3095 struct efi_open_protocol_info_item *item;
3096
3097 list_for_each_entry(handler, &efiobj->protocols, link) {
3098 list_for_each_entry(item, &handler->open_infos, link) {
3099 if (item->info.attributes &
3100 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3101 r = EFI_CALL(efi_connect_controller(
3102 item->info.controller_handle,
3103 driver_image_handle,
3104 remain_device_path,
3105 recursive));
3106 if (r == EFI_SUCCESS)
3107 ret = EFI_SUCCESS;
3108 }
3109 }
3110 }
3111 }
3112 /* Check for child controller specified by end node */
3113 if (ret != EFI_SUCCESS && remain_device_path &&
3114 remain_device_path->type == DEVICE_PATH_TYPE_END)
3115 ret = EFI_SUCCESS;
3116out:
3117 return EFI_EXIT(ret);
3118}
3119
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003120/**
Mario Six78a88f72018-07-10 08:40:17 +02003121 * efi_reinstall_protocol_interface() - reinstall protocol interface
3122 * @handle: handle on which the protocol shall be reinstalled
3123 * @protocol: GUID of the protocol to be installed
3124 * @old_interface: interface to be removed
3125 * @new_interface: interface to be installed
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003126 *
3127 * This function implements the ReinstallProtocolInterface service.
Mario Six78a88f72018-07-10 08:40:17 +02003128 *
3129 * See the Unified Extensible Firmware Interface (UEFI) specification for
3130 * details.
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003131 *
3132 * The old interface is uninstalled. The new interface is installed.
3133 * Drivers are connected.
3134 *
Mario Six78a88f72018-07-10 08:40:17 +02003135 * Return: status code
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003136 */
3137static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3138 efi_handle_t handle, const efi_guid_t *protocol,
3139 void *old_interface, void *new_interface)
3140{
3141 efi_status_t ret;
3142
3143 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3144 new_interface);
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003145
3146 /* Uninstall protocol but do not delete handle */
3147 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003148 if (ret != EFI_SUCCESS)
3149 goto out;
Heinrich Schuchardt9b47f132018-09-28 22:14:17 +02003150
3151 /* Install the new protocol */
3152 ret = efi_add_protocol(handle, protocol, new_interface);
3153 /*
3154 * The UEFI spec does not specify what should happen to the handle
3155 * if in case of an error no protocol interface remains on the handle.
3156 * So let's do nothing here.
3157 */
Heinrich Schuchardte861a122018-05-11 12:09:22 +02003158 if (ret != EFI_SUCCESS)
3159 goto out;
3160 /*
3161 * The returned status code has to be ignored.
3162 * Do not create an error if no suitable driver for the handle exists.
3163 */
3164 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3165out:
3166 return EFI_EXIT(ret);
3167}
3168
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003169/**
Mario Six78a88f72018-07-10 08:40:17 +02003170 * efi_get_child_controllers() - get all child controllers associated to a driver
3171 * @efiobj: handle of the controller
3172 * @driver_handle: handle of the driver
3173 * @number_of_children: number of child controllers
3174 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003175 *
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003176 * The allocated buffer has to be freed with free().
3177 *
Mario Six78a88f72018-07-10 08:40:17 +02003178 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003179 */
3180static efi_status_t efi_get_child_controllers(
3181 struct efi_object *efiobj,
3182 efi_handle_t driver_handle,
3183 efi_uintn_t *number_of_children,
3184 efi_handle_t **child_handle_buffer)
3185{
3186 struct efi_handler *handler;
3187 struct efi_open_protocol_info_item *item;
3188 efi_uintn_t count = 0, i;
3189 bool duplicate;
3190
3191 /* Count all child controller associations */
3192 list_for_each_entry(handler, &efiobj->protocols, link) {
3193 list_for_each_entry(item, &handler->open_infos, link) {
3194 if (item->info.agent_handle == driver_handle &&
3195 item->info.attributes &
3196 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3197 ++count;
3198 }
3199 }
3200 /*
3201 * Create buffer. In case of duplicate child controller assignments
3202 * the buffer will be too large. But that does not harm.
3203 */
3204 *number_of_children = 0;
3205 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3206 if (!*child_handle_buffer)
3207 return EFI_OUT_OF_RESOURCES;
3208 /* Copy unique child handles */
3209 list_for_each_entry(handler, &efiobj->protocols, link) {
3210 list_for_each_entry(item, &handler->open_infos, link) {
3211 if (item->info.agent_handle == driver_handle &&
3212 item->info.attributes &
3213 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3214 /* Check this is a new child controller */
3215 duplicate = false;
3216 for (i = 0; i < *number_of_children; ++i) {
3217 if ((*child_handle_buffer)[i] ==
3218 item->info.controller_handle)
3219 duplicate = true;
3220 }
3221 /* Copy handle to buffer */
3222 if (!duplicate) {
3223 i = (*number_of_children)++;
3224 (*child_handle_buffer)[i] =
3225 item->info.controller_handle;
3226 }
3227 }
3228 }
3229 }
3230 return EFI_SUCCESS;
3231}
3232
Heinrich Schuchardt6b03cd12018-05-11 18:15:41 +02003233/**
Mario Six78a88f72018-07-10 08:40:17 +02003234 * efi_disconnect_controller() - disconnect a controller from a driver
3235 * @controller_handle: handle of the controller
3236 * @driver_image_handle: handle of the driver
3237 * @child_handle: handle of the child to destroy
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003238 *
3239 * This function implements the DisconnectController service.
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003240 *
Mario Six78a88f72018-07-10 08:40:17 +02003241 * See the Unified Extensible Firmware Interface (UEFI) specification for
3242 * details.
3243 *
3244 * Return: status code
Heinrich Schuchardt3f9b0042018-01-11 08:16:04 +01003245 */
3246static efi_status_t EFIAPI efi_disconnect_controller(
3247 efi_handle_t controller_handle,
3248 efi_handle_t driver_image_handle,
3249 efi_handle_t child_handle)
3250{
3251 struct efi_driver_binding_protocol *binding_protocol;
3252 efi_handle_t *child_handle_buffer = NULL;
3253 size_t number_of_children = 0;
3254 efi_status_t r;
3255 size_t stop_count = 0;
3256 struct efi_object *efiobj;
3257
3258 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3259 child_handle);
3260
3261 efiobj = efi_search_obj(controller_handle);
3262 if (!efiobj) {
3263 r = EFI_INVALID_PARAMETER;
3264 goto out;
3265 }
3266
3267 if (child_handle && !efi_search_obj(child_handle)) {
3268 r = EFI_INVALID_PARAMETER;
3269 goto out;
3270 }
3271
3272 /* If no driver handle is supplied, disconnect all drivers */
3273 if (!driver_image_handle) {
3274 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3275 goto out;
3276 }
3277
3278 /* Create list of child handles */
3279 if (child_handle) {
3280 number_of_children = 1;
3281 child_handle_buffer = &child_handle;
3282 } else {
3283 efi_get_child_controllers(efiobj,
3284 driver_image_handle,
3285 &number_of_children,
3286 &child_handle_buffer);
3287 }
3288
3289 /* Get the driver binding protocol */
3290 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3291 &efi_guid_driver_binding_protocol,
3292 (void **)&binding_protocol,
3293 driver_image_handle, NULL,
3294 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3295 if (r != EFI_SUCCESS)
3296 goto out;
3297 /* Remove the children */
3298 if (number_of_children) {
3299 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3300 controller_handle,
3301 number_of_children,
3302 child_handle_buffer));
3303 if (r == EFI_SUCCESS)
3304 ++stop_count;
3305 }
3306 /* Remove the driver */
3307 if (!child_handle)
3308 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3309 controller_handle,
3310 0, NULL));
3311 if (r == EFI_SUCCESS)
3312 ++stop_count;
3313 EFI_CALL(efi_close_protocol(driver_image_handle,
3314 &efi_guid_driver_binding_protocol,
3315 driver_image_handle, NULL));
3316
3317 if (stop_count)
3318 r = EFI_SUCCESS;
3319 else
3320 r = EFI_NOT_FOUND;
3321out:
3322 if (!child_handle)
3323 free(child_handle_buffer);
3324 return EFI_EXIT(r);
3325}
3326
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003327static struct efi_boot_services efi_boot_services = {
Alexander Grafbee91162016-03-04 01:09:59 +01003328 .hdr = {
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003329 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3330 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003331 .headersize = sizeof(struct efi_boot_services),
Alexander Grafbee91162016-03-04 01:09:59 +01003332 },
3333 .raise_tpl = efi_raise_tpl,
3334 .restore_tpl = efi_restore_tpl,
3335 .allocate_pages = efi_allocate_pages_ext,
3336 .free_pages = efi_free_pages_ext,
3337 .get_memory_map = efi_get_memory_map_ext,
Stefan Brünsead12742016-10-09 22:17:18 +02003338 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns42417bc2016-10-09 22:17:26 +02003339 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +02003340 .create_event = efi_create_event_ext,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +02003341 .set_timer = efi_set_timer_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003342 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +02003343 .signal_event = efi_signal_event_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003344 .close_event = efi_close_event,
3345 .check_event = efi_check_event,
Heinrich Schuchardt1760ef52017-11-06 21:17:44 +01003346 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003347 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardtcd534082017-11-06 21:17:45 +01003348 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafbee91162016-03-04 01:09:59 +01003349 .handle_protocol = efi_handle_protocol,
3350 .reserved = NULL,
3351 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de26329582017-07-11 22:06:21 +02003352 .locate_handle = efi_locate_handle_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003353 .locate_device_path = efi_locate_device_path,
Alexander Graf488bf122016-08-19 01:23:24 +02003354 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafbee91162016-03-04 01:09:59 +01003355 .load_image = efi_load_image,
3356 .start_image = efi_start_image,
Alexander Grafa86aeaf2016-05-20 23:28:23 +02003357 .exit = efi_exit,
Alexander Grafbee91162016-03-04 01:09:59 +01003358 .unload_image = efi_unload_image,
3359 .exit_boot_services = efi_exit_boot_services,
3360 .get_next_monotonic_count = efi_get_next_monotonic_count,
3361 .stall = efi_stall,
3362 .set_watchdog_timer = efi_set_watchdog_timer,
3363 .connect_controller = efi_connect_controller,
3364 .disconnect_controller = efi_disconnect_controller,
3365 .open_protocol = efi_open_protocol,
3366 .close_protocol = efi_close_protocol,
3367 .open_protocol_information = efi_open_protocol_information,
3368 .protocols_per_handle = efi_protocols_per_handle,
3369 .locate_handle_buffer = efi_locate_handle_buffer,
3370 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003371 .install_multiple_protocol_interfaces =
3372 efi_install_multiple_protocol_interfaces,
3373 .uninstall_multiple_protocol_interfaces =
3374 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafbee91162016-03-04 01:09:59 +01003375 .calculate_crc32 = efi_calculate_crc32,
3376 .copy_mem = efi_copy_mem,
3377 .set_mem = efi_set_mem,
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +01003378 .create_event_ex = efi_create_event_ex,
Alexander Grafbee91162016-03-04 01:09:59 +01003379};
3380
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003381static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafbee91162016-03-04 01:09:59 +01003382
Alexander Graf3c63db92016-10-14 13:45:30 +02003383struct efi_system_table __efi_runtime_data systab = {
Alexander Grafbee91162016-03-04 01:09:59 +01003384 .hdr = {
3385 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +02003386 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +02003387 .headersize = sizeof(struct efi_system_table),
Alexander Grafbee91162016-03-04 01:09:59 +01003388 },
Heinrich Schuchardt0b386532018-06-28 12:45:30 +02003389 .fw_vendor = firmware_vendor,
3390 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardtab9efa92018-02-18 15:17:49 +01003391 .con_in = (void *)&efi_con_in,
3392 .con_out = (void *)&efi_con_out,
3393 .std_err = (void *)&efi_con_out,
3394 .runtime = (void *)&efi_runtime_services,
3395 .boottime = (void *)&efi_boot_services,
Alexander Grafbee91162016-03-04 01:09:59 +01003396 .nr_tables = 0,
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003397 .tables = NULL,
Alexander Grafbee91162016-03-04 01:09:59 +01003398};
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003399
3400/**
3401 * efi_initialize_system_table() - Initialize system table
3402 *
Heinrich Schuchardt04143592018-09-03 05:00:43 +02003403 * Return: status code
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003404 */
3405efi_status_t efi_initialize_system_table(void)
3406{
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003407 efi_status_t ret;
3408
3409 /* Allocate configuration table array */
3410 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3411 EFI_MAX_CONFIGURATION_TABLES *
3412 sizeof(struct efi_configuration_table),
3413 (void **)&systab.tables);
3414
Heinrich Schuchardtb72aaa82018-09-03 19:12:24 +02003415 /* Set CRC32 field in table headers */
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003416 efi_update_table_header_crc32(&systab.hdr);
3417 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3418 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt4182a122018-06-28 12:45:32 +02003419
3420 return ret;
Heinrich Schuchardt640adad2018-06-28 12:45:31 +02003421}