blob: dd5f706af76170520a96068b0aebdafdc2dfa959 [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Grafc15d9212016-03-04 01:09:59 +01002/*
3 * EFI application boot time services
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafc15d9212016-03-04 01:09:59 +01006 */
7
Alexander Grafc15d9212016-03-04 01:09:59 +01008#include <common.h>
Heinrich Schuchardt368ca642017-10-05 16:14:14 +02009#include <div64.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010010#include <efi_loader.h>
Rob Clark15f3d742017-09-13 18:05:37 -040011#include <environment.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010012#include <malloc.h>
Masahiro Yamada75f82d02018-03-05 01:20:11 +090013#include <linux/libfdt_env.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010014#include <u-boot/crc.h>
15#include <bootm.h>
Heinrich Schuchardt37587522019-05-01 20:07:04 +020016#include <pe.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010017#include <watchdog.h>
18
19DECLARE_GLOBAL_DATA_PTR;
20
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +020021/* Task priority level */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +010022static efi_uintn_t efi_tpl = TPL_APPLICATION;
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +020023
Alexander Grafc15d9212016-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 Schuchardt370c7a82018-02-18 15:17:50 +010027/* List of all events */
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +010028LIST_HEAD(efi_events);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +010029
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +020030/* List of all events registered by RegisterProtocolNotify() */
31LIST_HEAD(efi_register_notify_events);
32
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +010033/* Handle of the currently executing image */
34static efi_handle_t current_image;
35
Alexander Graffa5246b2018-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 Glasscdfe6962016-09-25 15:27:35 -060044#ifdef CONFIG_ARM
Alexander Grafc15d9212016-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 Glasscdfe6962016-09-25 15:27:35 -060052#endif
Alexander Grafc15d9212016-03-04 01:09:59 +010053
Heinrich Schuchardt72506232019-02-09 14:10:39 +010054/* 1 if inside U-Boot code, 0 if inside EFI payload code */
55static int entry_count = 1;
Rob Clarke7896c32017-07-27 08:04:19 -040056static int nesting_level;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +010057/* GUID of the device tree table */
58const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
Heinrich Schuchardt760255f2018-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 Clark86789d52017-07-27 08:04:18 -040062
Heinrich Schuchardt672d99e2018-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 Schuchardtb7cb8b42018-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 Schuchardte9943282018-01-11 08:16:04 +010083
Rob Clark86789d52017-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 Grafc15d9212016-03-04 01:09:59 +0100106/* Called from do_bootefi_exec() */
107void efi_save_gd(void)
108{
Simon Glasscdfe6962016-09-25 15:27:35 -0600109#ifdef CONFIG_ARM
Alexander Grafc15d9212016-03-04 01:09:59 +0100110 efi_gd = gd;
Simon Glasscdfe6962016-09-25 15:27:35 -0600111#endif
Alexander Grafc15d9212016-03-04 01:09:59 +0100112}
113
Rob Clark86789d52017-07-27 08:04:18 -0400114/*
Mario Six8fac2912018-07-10 08:40:17 +0200115 * Special case handler for error/abort that just forces things back to u-boot
Heinrich Schuchardtcf70a732018-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 Clark86789d52017-07-27 08:04:18 -0400118 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100119void efi_restore_gd(void)
120{
Simon Glasscdfe6962016-09-25 15:27:35 -0600121#ifdef CONFIG_ARM
Alexander Grafc15d9212016-03-04 01:09:59 +0100122 /* Only restore if we're already in EFI context */
123 if (!efi_gd)
124 return;
Alexander Grafc15d9212016-03-04 01:09:59 +0100125 gd = efi_gd;
Simon Glasscdfe6962016-09-25 15:27:35 -0600126#endif
Alexander Grafc15d9212016-03-04 01:09:59 +0100127}
128
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200129/**
Mario Six8fac2912018-07-10 08:40:17 +0200130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
Heinrich Schuchardt091cf432018-01-24 19:21:36 +0100132 *
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200133 * A maximum of ten indent levels is supported. Higher indent levels will be
134 * truncated.
135 *
Mario Six8fac2912018-07-10 08:40:17 +0200136 * Return: A string for indenting with two spaces per level is
137 * returned.
Rob Clarke7896c32017-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 Schuchardt91064592018-02-18 15:17:49 +0100143
Rob Clarke7896c32017-07-27 08:04:19 -0400144 level = min(max, level * 2);
145 return &indent[max - level];
146}
147
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200148const char *__efi_nesting(void)
149{
150 return indent_string(nesting_level);
151}
152
Rob Clarke7896c32017-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 Schuchardt59999172018-05-11 18:15:41 +0200163/**
Mario Six8fac2912018-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 Schuchardta40db6e2017-09-21 18:30:11 +0200167 *
168 * This function queues the notification function of the event for future
169 * execution.
170 *
Mario Six8fac2912018-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 Schuchardta40db6e2017-09-21 18:30:11 +0200173 *
174 * For the SignalEvent service see efi_signal_event_ext.
175 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200176 */
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100177static void efi_queue_event(struct efi_event *event, bool check_tpl)
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200178{
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200179 if (event->notify_function) {
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200180 event->is_queued = true;
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200181 /* Check TPL */
Heinrich Schuchardtd8b878a2018-01-19 20:24:51 +0100182 if (check_tpl && efi_tpl >= event->notify_tpl)
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200183 return;
Heinrich Schuchardtad559972019-05-11 21:44:59 +0200184 event->is_queued = false;
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200185 EFI_CALL_VOID(event->notify_function(event,
186 event->notify_context));
Heinrich Schuchardtad559972019-05-11 21:44:59 +0200187 } else {
188 event->is_queued = false;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200189 }
190}
191
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200192/**
Heinrich Schuchardt7f0f0052018-07-02 12:53:52 +0200193 * is_valid_tpl() - check if the task priority level is valid
194 *
195 * @tpl: TPL level to check
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200196 * Return: status code
Heinrich Schuchardt7f0f0052018-07-02 12:53:52 +0200197 */
198efi_status_t is_valid_tpl(efi_uintn_t tpl)
199{
200 switch (tpl) {
201 case TPL_APPLICATION:
202 case TPL_CALLBACK:
203 case TPL_NOTIFY:
204 case TPL_HIGH_LEVEL:
205 return EFI_SUCCESS;
206 default:
207 return EFI_INVALID_PARAMETER;
208 }
209}
210
211/**
Mario Six8fac2912018-07-10 08:40:17 +0200212 * efi_signal_event() - signal an EFI event
213 * @event: event to signal
214 * @check_tpl: check the TPL level
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100215 *
Mario Six8fac2912018-07-10 08:40:17 +0200216 * This function signals an event. If the event belongs to an event group all
217 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100218 * their notification function is queued.
219 *
220 * For the SignalEvent service see efi_signal_event_ext.
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100221 */
222void efi_signal_event(struct efi_event *event, bool check_tpl)
223{
224 if (event->group) {
225 struct efi_event *evt;
226
227 /*
228 * The signaled state has to set before executing any
229 * notification function
230 */
231 list_for_each_entry(evt, &efi_events, link) {
232 if (!evt->group || guidcmp(evt->group, event->group))
233 continue;
234 if (evt->is_signaled)
235 continue;
236 evt->is_signaled = true;
237 if (evt->type & EVT_NOTIFY_SIGNAL &&
238 evt->notify_function)
239 evt->is_queued = true;
240 }
241 list_for_each_entry(evt, &efi_events, link) {
242 if (!evt->group || guidcmp(evt->group, event->group))
243 continue;
244 if (evt->is_queued)
245 efi_queue_event(evt, check_tpl);
246 }
Heinrich Schuchardt66ddc2e2019-05-05 00:07:34 +0200247 } else {
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100248 event->is_signaled = true;
249 if (event->type & EVT_NOTIFY_SIGNAL)
250 efi_queue_event(event, check_tpl);
251 }
252}
253
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200254/**
Mario Six8fac2912018-07-10 08:40:17 +0200255 * efi_raise_tpl() - raise the task priority level
256 * @new_tpl: new value of the task priority level
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200257 *
258 * This function implements the RaiseTpl service.
Mario Six8fac2912018-07-10 08:40:17 +0200259 *
260 * See the Unified Extensible Firmware Interface (UEFI) specification for
261 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200262 *
Mario Six8fac2912018-07-10 08:40:17 +0200263 * Return: old value of the task priority level
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200264 */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100265static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
Alexander Grafc15d9212016-03-04 01:09:59 +0100266{
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100267 efi_uintn_t old_tpl = efi_tpl;
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200268
xypron.glpk@gmx.de48df2092017-07-18 20:17:19 +0200269 EFI_ENTRY("0x%zx", new_tpl);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200270
271 if (new_tpl < efi_tpl)
Heinrich Schuchardt952e2062019-05-05 11:56:23 +0200272 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200273 efi_tpl = new_tpl;
274 if (efi_tpl > TPL_HIGH_LEVEL)
275 efi_tpl = TPL_HIGH_LEVEL;
276
277 EFI_EXIT(EFI_SUCCESS);
278 return old_tpl;
Alexander Grafc15d9212016-03-04 01:09:59 +0100279}
280
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200281/**
Mario Six8fac2912018-07-10 08:40:17 +0200282 * efi_restore_tpl() - lower the task priority level
283 * @old_tpl: value of the task priority level to be restored
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200284 *
285 * This function implements the RestoreTpl service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200286 *
Mario Six8fac2912018-07-10 08:40:17 +0200287 * See the Unified Extensible Firmware Interface (UEFI) specification for
288 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200289 */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100290static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
Alexander Grafc15d9212016-03-04 01:09:59 +0100291{
xypron.glpk@gmx.de48df2092017-07-18 20:17:19 +0200292 EFI_ENTRY("0x%zx", old_tpl);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200293
294 if (old_tpl > efi_tpl)
Heinrich Schuchardt952e2062019-05-05 11:56:23 +0200295 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200296 efi_tpl = old_tpl;
297 if (efi_tpl > TPL_HIGH_LEVEL)
298 efi_tpl = TPL_HIGH_LEVEL;
299
Heinrich Schuchardt59b20952018-03-24 18:40:21 +0100300 /*
301 * Lowering the TPL may have made queued events eligible for execution.
302 */
303 efi_timer_check();
304
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200305 EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +0100306}
307
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200308/**
Mario Six8fac2912018-07-10 08:40:17 +0200309 * efi_allocate_pages_ext() - allocate memory pages
310 * @type: type of allocation to be performed
311 * @memory_type: usage type of the allocated memory
312 * @pages: number of pages to be allocated
313 * @memory: allocated memory
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200314 *
315 * This function implements the AllocatePages service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200316 *
Mario Six8fac2912018-07-10 08:40:17 +0200317 * See the Unified Extensible Firmware Interface (UEFI) specification for
318 * details.
319 *
320 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200321 */
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900322static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100323 efi_uintn_t pages,
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900324 uint64_t *memory)
Alexander Grafc15d9212016-03-04 01:09:59 +0100325{
326 efi_status_t r;
327
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100328 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
Alexander Grafc15d9212016-03-04 01:09:59 +0100329 r = efi_allocate_pages(type, memory_type, pages, memory);
330 return EFI_EXIT(r);
331}
332
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200333/**
Mario Six8fac2912018-07-10 08:40:17 +0200334 * efi_free_pages_ext() - Free memory pages.
335 * @memory: start of the memory area to be freed
336 * @pages: number of pages to be freed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200337 *
338 * This function implements the FreePages service.
Mario Six8fac2912018-07-10 08:40:17 +0200339 *
340 * See the Unified Extensible Firmware Interface (UEFI) specification for
341 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200342 *
Mario Six8fac2912018-07-10 08:40:17 +0200343 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200344 */
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900345static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100346 efi_uintn_t pages)
Alexander Grafc15d9212016-03-04 01:09:59 +0100347{
348 efi_status_t r;
349
Masahiro Yamadac7570a32018-08-06 20:47:40 +0900350 EFI_ENTRY("%llx, 0x%zx", memory, pages);
Alexander Grafc15d9212016-03-04 01:09:59 +0100351 r = efi_free_pages(memory, pages);
352 return EFI_EXIT(r);
353}
354
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200355/**
Mario Six8fac2912018-07-10 08:40:17 +0200356 * efi_get_memory_map_ext() - get map describing memory usage
357 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
358 * on exit the size of the copied memory map
359 * @memory_map: buffer to which the memory map is written
360 * @map_key: key for the memory map
361 * @descriptor_size: size of an individual memory descriptor
362 * @descriptor_version: version number of the memory descriptor structure
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200363 *
364 * This function implements the GetMemoryMap service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200365 *
Mario Six8fac2912018-07-10 08:40:17 +0200366 * See the Unified Extensible Firmware Interface (UEFI) specification for
367 * details.
368 *
369 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200370 */
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900371static efi_status_t EFIAPI efi_get_memory_map_ext(
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100372 efi_uintn_t *memory_map_size,
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900373 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100374 efi_uintn_t *map_key,
375 efi_uintn_t *descriptor_size,
Masahiro Yamadab2a05c12017-06-22 17:49:03 +0900376 uint32_t *descriptor_version)
Alexander Grafc15d9212016-03-04 01:09:59 +0100377{
378 efi_status_t r;
379
380 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
381 map_key, descriptor_size, descriptor_version);
382 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
383 descriptor_size, descriptor_version);
384 return EFI_EXIT(r);
385}
386
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200387/**
Mario Six8fac2912018-07-10 08:40:17 +0200388 * efi_allocate_pool_ext() - allocate memory from pool
389 * @pool_type: type of the pool from which memory is to be allocated
390 * @size: number of bytes to be allocated
391 * @buffer: allocated memory
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200392 *
393 * This function implements the AllocatePool service.
Mario Six8fac2912018-07-10 08:40:17 +0200394 *
395 * See the Unified Extensible Firmware Interface (UEFI) specification for
396 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200397 *
Mario Six8fac2912018-07-10 08:40:17 +0200398 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200399 */
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200400static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100401 efi_uintn_t size,
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200402 void **buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +0100403{
Alexander Graf1c34fa82016-03-24 01:37:37 +0100404 efi_status_t r;
405
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100406 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200407 r = efi_allocate_pool(pool_type, size, buffer);
Alexander Graf1c34fa82016-03-24 01:37:37 +0100408 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +0100409}
410
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200411/**
Mario Six8fac2912018-07-10 08:40:17 +0200412 * efi_free_pool_ext() - free memory from pool
413 * @buffer: start of memory to be freed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200414 *
415 * This function implements the FreePool service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200416 *
Mario Six8fac2912018-07-10 08:40:17 +0200417 * See the Unified Extensible Firmware Interface (UEFI) specification for
418 * details.
419 *
420 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200421 */
Stefan Brüns67b67d92016-10-09 22:17:26 +0200422static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +0100423{
Alexander Graf1c34fa82016-03-24 01:37:37 +0100424 efi_status_t r;
425
426 EFI_ENTRY("%p", buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200427 r = efi_free_pool(buffer);
Alexander Graf1c34fa82016-03-24 01:37:37 +0100428 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +0100429}
430
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200431/**
Heinrich Schuchardt30cd0462019-05-01 09:42:39 +0200432 * efi_add_handle() - add a new handle to the object list
433 *
434 * @handle: handle to be added
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100435 *
Heinrich Schuchardt30cd0462019-05-01 09:42:39 +0200436 * The protocols list is initialized. The handle is added to the list of known
437 * UEFI objects.
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100438 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200439void efi_add_handle(efi_handle_t handle)
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100440{
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200441 if (!handle)
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100442 return;
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200443 INIT_LIST_HEAD(&handle->protocols);
444 list_add_tail(&handle->link, &efi_obj_list);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100445}
446
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200447/**
Mario Six8fac2912018-07-10 08:40:17 +0200448 * efi_create_handle() - create handle
449 * @handle: new handle
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200450 *
Mario Six8fac2912018-07-10 08:40:17 +0200451 * Return: status code
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200452 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100453efi_status_t efi_create_handle(efi_handle_t *handle)
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +0200454{
455 struct efi_object *obj;
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +0200456
Heinrich Schuchardtae1d2062018-05-27 16:47:21 +0200457 obj = calloc(1, sizeof(struct efi_object));
458 if (!obj)
459 return EFI_OUT_OF_RESOURCES;
460
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100461 efi_add_handle(obj);
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200462 *handle = obj;
Heinrich Schuchardtae1d2062018-05-27 16:47:21 +0200463
464 return EFI_SUCCESS;
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +0200465}
466
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200467/**
Mario Six8fac2912018-07-10 08:40:17 +0200468 * efi_search_protocol() - find a protocol on a handle.
469 * @handle: handle
470 * @protocol_guid: GUID of the protocol
471 * @handler: reference to the protocol
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100472 *
Mario Six8fac2912018-07-10 08:40:17 +0200473 * Return: status code
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100474 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100475efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100476 const efi_guid_t *protocol_guid,
477 struct efi_handler **handler)
478{
479 struct efi_object *efiobj;
480 struct list_head *lhandle;
481
482 if (!handle || !protocol_guid)
483 return EFI_INVALID_PARAMETER;
484 efiobj = efi_search_obj(handle);
485 if (!efiobj)
486 return EFI_INVALID_PARAMETER;
487 list_for_each(lhandle, &efiobj->protocols) {
488 struct efi_handler *protocol;
489
490 protocol = list_entry(lhandle, struct efi_handler, link);
491 if (!guidcmp(protocol->guid, protocol_guid)) {
492 if (handler)
493 *handler = protocol;
494 return EFI_SUCCESS;
495 }
496 }
497 return EFI_NOT_FOUND;
498}
499
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200500/**
Mario Six8fac2912018-07-10 08:40:17 +0200501 * efi_remove_protocol() - delete protocol from a handle
502 * @handle: handle from which the protocol shall be deleted
503 * @protocol: GUID of the protocol to be deleted
504 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100505 *
Mario Six8fac2912018-07-10 08:40:17 +0200506 * Return: status code
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100507 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100508efi_status_t efi_remove_protocol(const efi_handle_t handle,
509 const efi_guid_t *protocol,
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100510 void *protocol_interface)
511{
512 struct efi_handler *handler;
513 efi_status_t ret;
514
515 ret = efi_search_protocol(handle, protocol, &handler);
516 if (ret != EFI_SUCCESS)
517 return ret;
Heinrich Schuchardtb27594d2018-05-11 12:09:21 +0200518 if (handler->protocol_interface != protocol_interface)
Heinrich Schuchardtfdeb1f02019-05-10 20:06:48 +0200519 return EFI_NOT_FOUND;
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100520 list_del(&handler->link);
521 free(handler);
522 return EFI_SUCCESS;
523}
524
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200525/**
Mario Six8fac2912018-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 Schuchardt7d135462017-12-04 18:03:02 +0100528 *
Mario Six8fac2912018-07-10 08:40:17 +0200529 * Return: status code
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100530 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100531efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100532{
533 struct efi_object *efiobj;
Heinrich Schuchardta84731d2018-01-11 08:15:55 +0100534 struct efi_handler *protocol;
535 struct efi_handler *pos;
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100536
537 efiobj = efi_search_obj(handle);
538 if (!efiobj)
539 return EFI_INVALID_PARAMETER;
Heinrich Schuchardta84731d2018-01-11 08:15:55 +0100540 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100541 efi_status_t ret;
542
Heinrich Schuchardt7d135462017-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 Schuchardt59999172018-05-11 18:15:41 +0200551/**
Mario Six8fac2912018-07-10 08:40:17 +0200552 * efi_delete_handle() - delete handle
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100553 *
Mario Six8fac2912018-07-10 08:40:17 +0200554 * @obj: handle to delete
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100555 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200556void efi_delete_handle(efi_handle_t handle)
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100557{
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200558 if (!handle)
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100559 return;
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200560 efi_remove_all_protocols(handle);
561 list_del(&handle->link);
562 free(handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100563}
564
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200565/**
Mario Six8fac2912018-07-10 08:40:17 +0200566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100568 *
Mario Six8fac2912018-07-10 08:40:17 +0200569 * Return: status code
Alexander Grafc15d9212016-03-04 01:09:59 +0100570 */
Heinrich Schuchardt370c7a82018-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 Grafc15d9212016-03-04 01:09:59 +0100583
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200584/**
Mario Six8fac2912018-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 Schuchardta40db6e2017-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 Six8fac2912018-07-10 08:40:17 +0200598 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200599 */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100600efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200601 void (EFIAPI *notify_function) (
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200602 struct efi_event *event,
603 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100604 void *notify_context, efi_guid_t *group,
605 struct efi_event **event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100606{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100607 struct efi_event *evt;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200608
Jonathan Gray7758b212017-03-12 19:26:07 +1100609 if (event == NULL)
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200610 return EFI_INVALID_PARAMETER;
Jonathan Gray7758b212017-03-12 19:26:07 +1100611
Heinrich Schuchardt7f0f0052018-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.de852a0e1772017-07-18 20:17:20 +0200623 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt7f0f0052018-07-02 12:53:52 +0200624 }
Jonathan Gray7758b212017-03-12 19:26:07 +1100625
AKASHI Takahiro3f3835d2018-08-10 15:36:32 +0900626 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
Heinrich Schuchardtad7a2152019-04-25 07:30:41 +0200627 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200628 return EFI_INVALID_PARAMETER;
Jonathan Gray7758b212017-03-12 19:26:07 +1100629
Heinrich Schuchardt370c7a82018-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 Schuchardtbf7f1692018-02-18 15:17:52 +0100637 evt->group = group;
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +0200638 /* Disable timers on boot up */
Heinrich Schuchardt370c7a82018-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 Grafc15d9212016-03-04 01:09:59 +0100645}
646
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200647/*
Mario Six8fac2912018-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 Schuchardt717c4582018-02-04 23:05:13 +0100655 *
656 * This function implements the CreateEventEx service.
Heinrich Schuchardt717c4582018-02-04 23:05:13 +0100657 *
Mario Six8fac2912018-07-10 08:40:17 +0200658 * See the Unified Extensible Firmware Interface (UEFI) specification for
659 * details.
660 *
661 * Return: status code
Heinrich Schuchardt717c4582018-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 Schuchardtce664992019-05-04 10:12:50 +0200671 efi_status_t ret;
672
Heinrich Schuchardt717c4582018-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 Schuchardtce664992019-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 Schuchardt717c4582018-02-04 23:05:13 +0100691}
692
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200693/**
Mario Six8fac2912018-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 Schuchardta40db6e2017-09-21 18:30:11 +0200700 *
701 * This function implements the CreateEvent service.
Mario Six8fac2912018-07-10 08:40:17 +0200702 *
703 * See the Unified Extensible Firmware Interface (UEFI) specification for
704 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200705 *
Mario Six8fac2912018-07-10 08:40:17 +0200706 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200707 */
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200708static efi_status_t EFIAPI efi_create_event_ext(
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100709 uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-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 Schuchardtbf7f1692018-02-18 15:17:52 +0100718 notify_context, NULL, event));
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200719}
720
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200721/**
Mario Six8fac2912018-07-10 08:40:17 +0200722 * efi_timer_check() - check if a timer event has occurred
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200723 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200724 * Check if a timer event has occurred or a queued notification function should
725 * be called.
726 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100727 * Our timers have to work without interrupts, so we check whenever keyboard
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200728 * input or disk accesses happen if enough time elapsed for them to fire.
Alexander Grafc15d9212016-03-04 01:09:59 +0100729 */
730void efi_timer_check(void)
731{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100732 struct efi_event *evt;
Alexander Grafc15d9212016-03-04 01:09:59 +0100733 u64 now = timer_get_us();
734
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100735 list_for_each_entry(evt, &efi_events, link) {
736 if (evt->is_queued)
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100737 efi_queue_event(evt, true);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100738 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200739 continue;
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100740 switch (evt->trigger_type) {
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200741 case EFI_TIMER_RELATIVE:
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100742 evt->trigger_type = EFI_TIMER_STOP;
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200743 break;
744 case EFI_TIMER_PERIODIC:
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100745 evt->trigger_next += evt->trigger_time;
Heinrich Schuchardt8b11a8a2017-09-15 10:06:13 +0200746 break;
747 default:
748 continue;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200749 }
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100750 evt->is_signaled = false;
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100751 efi_signal_event(evt, true);
Alexander Grafc15d9212016-03-04 01:09:59 +0100752 }
Alexander Grafc15d9212016-03-04 01:09:59 +0100753 WATCHDOG_RESET();
754}
755
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200756/**
Mario Six8fac2912018-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 Schuchardtcf70a732018-09-03 19:12:24 +0200760 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardta40db6e2017-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 Six8fac2912018-07-10 08:40:17 +0200765 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200766 */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200767efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200768 uint64_t trigger_time)
Alexander Grafc15d9212016-03-04 01:09:59 +0100769{
Heinrich Schuchardt370c7a82018-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 Grafc15d9212016-03-04 01:09:59 +0100773
xypron.glpk@gmx.de44c4be02017-07-18 20:17:23 +0200774 /*
Heinrich Schuchardtcf70a732018-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.de44c4be02017-07-18 20:17:23 +0200777 */
Heinrich Schuchardt368ca642017-10-05 16:14:14 +0200778 do_div(trigger_time, 10);
Alexander Grafc15d9212016-03-04 01:09:59 +0100779
Heinrich Schuchardt370c7a82018-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 Grafc15d9212016-03-04 01:09:59 +0100790 }
Heinrich Schuchardt370c7a82018-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;
Alexander Grafc15d9212016-03-04 01:09:59 +0100795}
796
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200797/**
Mario Six8fac2912018-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 Schuchardtcf70a732018-09-03 19:12:24 +0200802 * @trigger_time: trigger period in multiples of 100 ns
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200803 *
804 * This function implements the SetTimer service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200805 *
Mario Six8fac2912018-07-10 08:40:17 +0200806 * See the Unified Extensible Firmware Interface (UEFI) specification for
807 * details.
808 *
809 *
810 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200811 */
xypron.glpk@gmx.de3ecc6bd2017-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.dea587fd12017-07-18 20:17:21 +0200815{
Masahiro Yamadac7570a32018-08-06 20:47:40 +0900816 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200817 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
818}
819
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200820/**
Mario Six8fac2912018-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 Schuchardta40db6e2017-09-21 18:30:11 +0200825 *
826 * This function implements the WaitForEvent service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200827 *
Mario Six8fac2912018-07-10 08:40:17 +0200828 * See the Unified Extensible Firmware Interface (UEFI) specification for
829 * details.
830 *
831 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200832 */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100833static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200834 struct efi_event **event,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100835 efi_uintn_t *index)
Alexander Grafc15d9212016-03-04 01:09:59 +0100836{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100837 int i;
Alexander Grafc15d9212016-03-04 01:09:59 +0100838
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100839 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
Alexander Grafc15d9212016-03-04 01:09:59 +0100840
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200841 /* Check parameters */
842 if (!num_events || !event)
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt0c150ca2017-09-15 10:06:16 +0200844 /* Check TPL */
845 if (efi_tpl != TPL_APPLICATION)
846 return EFI_EXIT(EFI_UNSUPPORTED);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200847 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100848 if (efi_is_event(event[i]) != EFI_SUCCESS)
849 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200850 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
851 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200852 if (!event[i]->is_signaled)
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100853 efi_queue_event(event[i], true);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200854 }
855
856 /* Wait for signal */
857 for (;;) {
858 for (i = 0; i < num_events; ++i) {
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200859 if (event[i]->is_signaled)
xypron.glpk@gmx.de30708232017-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 Schuchardt1bbee392017-10-04 15:03:24 +0200871 event[i]->is_signaled = false;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200872 if (index)
873 *index = i;
Alexander Grafc15d9212016-03-04 01:09:59 +0100874
875 return EFI_EXIT(EFI_SUCCESS);
876}
877
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200878/**
Mario Six8fac2912018-07-10 08:40:17 +0200879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200881 *
882 * This function implements the SignalEvent service.
Mario Six8fac2912018-07-10 08:40:17 +0200883 *
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
885 * details.
Heinrich Schuchardta40db6e2017-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 Six8fac2912018-07-10 08:40:17 +0200890 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200891 */
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200892static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100893{
894 EFI_ENTRY("%p", event);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100895 if (efi_is_event(event) != EFI_SUCCESS)
896 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100897 efi_signal_event(event, true);
Alexander Grafc15d9212016-03-04 01:09:59 +0100898 return EFI_EXIT(EFI_SUCCESS);
899}
900
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200901/**
Mario Six8fac2912018-07-10 08:40:17 +0200902 * efi_close_event() - close an EFI event
903 * @event: event to close
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200904 *
905 * This function implements the CloseEvent service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200906 *
Mario Six8fac2912018-07-10 08:40:17 +0200907 * See the Unified Extensible Firmware Interface (UEFI) specification for
908 * details.
909 *
910 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200911 */
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200912static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100913{
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200914 struct efi_register_notify_event *item, *next;
915
Alexander Grafc15d9212016-03-04 01:09:59 +0100916 EFI_ENTRY("%p", event);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100917 if (efi_is_event(event) != EFI_SUCCESS)
918 return EFI_EXIT(EFI_INVALID_PARAMETER);
Heinrich Schuchardt6eec42d2019-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) {
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200924 struct efi_protocol_notification *hitem, *hnext;
925
926 /* Remove signaled handles */
927 list_for_each_entry_safe(hitem, hnext, &item->handles,
928 link) {
929 list_del(&hitem->link);
930 free(hitem);
931 }
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200932 list_del(&item->link);
933 free(item);
934 }
935 }
936
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100937 list_del(&event->link);
938 free(event);
939 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +0100940}
941
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200942/**
Mario Six8fac2912018-07-10 08:40:17 +0200943 * efi_check_event() - check if an event is signaled
944 * @event: event to check
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200945 *
946 * This function implements the CheckEvent service.
Mario Six8fac2912018-07-10 08:40:17 +0200947 *
948 * See the Unified Extensible Firmware Interface (UEFI) specification for
949 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200950 *
Mario Six8fac2912018-07-10 08:40:17 +0200951 * If an event is not signaled yet, the notification function is queued. The
952 * signaled state is cleared.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200953 *
Mario Six8fac2912018-07-10 08:40:17 +0200954 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +0200955 */
xypron.glpk@gmx.decdbf3ac2017-07-18 20:17:17 +0200956static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
Alexander Grafc15d9212016-03-04 01:09:59 +0100957{
958 EFI_ENTRY("%p", event);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200959 efi_timer_check();
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100960 if (efi_is_event(event) != EFI_SUCCESS ||
961 event->type & EVT_NOTIFY_SIGNAL)
962 return EFI_EXIT(EFI_INVALID_PARAMETER);
963 if (!event->is_signaled)
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100964 efi_queue_event(event, true);
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100965 if (event->is_signaled) {
966 event->is_signaled = false;
967 return EFI_EXIT(EFI_SUCCESS);
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200968 }
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100969 return EFI_EXIT(EFI_NOT_READY);
Alexander Grafc15d9212016-03-04 01:09:59 +0100970}
971
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200972/**
Mario Six8fac2912018-07-10 08:40:17 +0200973 * efi_search_obj() - find the internal EFI object for a handle
974 * @handle: handle to find
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200975 *
Mario Six8fac2912018-07-10 08:40:17 +0200976 * Return: EFI object
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200977 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100978struct efi_object *efi_search_obj(const efi_handle_t handle)
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200979{
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100980 struct efi_object *efiobj;
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200981
Heinrich Schuchardt5d8231b2019-05-05 10:37:51 +0200982 if (!handle)
983 return NULL;
984
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100985 list_for_each_entry(efiobj, &efi_obj_list, link) {
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200986 if (efiobj == handle)
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200987 return efiobj;
988 }
Heinrich Schuchardt37ebcba2017-10-18 18:13:03 +0200989 return NULL;
990}
991
Heinrich Schuchardt59999172018-05-11 18:15:41 +0200992/**
Mario Six8fac2912018-07-10 08:40:17 +0200993 * efi_open_protocol_info_entry() - create open protocol info entry and add it
994 * to a protocol
995 * @handler: handler of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100996 *
Mario Six8fac2912018-07-10 08:40:17 +0200997 * Return: open protocol info entry
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100998 */
999static struct efi_open_protocol_info_entry *efi_create_open_info(
1000 struct efi_handler *handler)
1001{
1002 struct efi_open_protocol_info_item *item;
1003
1004 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
1005 if (!item)
1006 return NULL;
1007 /* Append the item to the open protocol info list. */
1008 list_add_tail(&item->link, &handler->open_infos);
1009
1010 return &item->info;
1011}
1012
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001013/**
Mario Six8fac2912018-07-10 08:40:17 +02001014 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1015 * @item: open protocol info entry to delete
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +01001016 *
Mario Six8fac2912018-07-10 08:40:17 +02001017 * Return: status code
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +01001018 */
1019static efi_status_t efi_delete_open_info(
1020 struct efi_open_protocol_info_item *item)
1021{
1022 list_del(&item->link);
1023 free(item);
1024 return EFI_SUCCESS;
1025}
1026
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001027/**
Mario Six8fac2912018-07-10 08:40:17 +02001028 * efi_add_protocol() - install new protocol on a handle
1029 * @handle: handle on which the protocol shall be installed
1030 * @protocol: GUID of the protocol to be installed
1031 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001032 *
Mario Six8fac2912018-07-10 08:40:17 +02001033 * Return: status code
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001034 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01001035efi_status_t efi_add_protocol(const efi_handle_t handle,
1036 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001037 void *protocol_interface)
1038{
1039 struct efi_object *efiobj;
1040 struct efi_handler *handler;
1041 efi_status_t ret;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001042 struct efi_register_notify_event *event;
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001043
1044 efiobj = efi_search_obj(handle);
1045 if (!efiobj)
1046 return EFI_INVALID_PARAMETER;
1047 ret = efi_search_protocol(handle, protocol, NULL);
1048 if (ret != EFI_NOT_FOUND)
1049 return EFI_INVALID_PARAMETER;
1050 handler = calloc(1, sizeof(struct efi_handler));
1051 if (!handler)
1052 return EFI_OUT_OF_RESOURCES;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01001053 handler->guid = protocol;
1054 handler->protocol_interface = protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +01001055 INIT_LIST_HEAD(&handler->open_infos);
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01001056 list_add_tail(&handler->link, &efiobj->protocols);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001057
1058 /* Notify registered events */
1059 list_for_each_entry(event, &efi_register_notify_events, link) {
Heinrich Schuchardtd375e752019-05-21 18:19:01 +02001060 if (!guidcmp(protocol, &event->protocol)) {
1061 struct efi_protocol_notification *notif;
1062
1063 notif = calloc(1, sizeof(*notif));
1064 if (!notif) {
1065 list_del(&handler->link);
1066 free(handler);
1067 return EFI_OUT_OF_RESOURCES;
1068 }
1069 notif->handle = handle;
1070 list_add_tail(&notif->link, &event->handles);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001071 efi_signal_event(event->event, true);
Heinrich Schuchardtd375e752019-05-21 18:19:01 +02001072 }
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001073 }
1074
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +01001075 if (!guidcmp(&efi_guid_device_path, protocol))
1076 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01001077 return EFI_SUCCESS;
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +02001078}
1079
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001080/**
Mario Six8fac2912018-07-10 08:40:17 +02001081 * efi_install_protocol_interface() - install protocol interface
1082 * @handle: handle on which the protocol shall be installed
1083 * @protocol: GUID of the protocol to be installed
1084 * @protocol_interface_type: type of the interface to be installed,
1085 * always EFI_NATIVE_INTERFACE
1086 * @protocol_interface: interface of the protocol implementation
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001087 *
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001088 * This function implements the InstallProtocolInterface service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001089 *
Mario Six8fac2912018-07-10 08:40:17 +02001090 * See the Unified Extensible Firmware Interface (UEFI) specification for
1091 * details.
1092 *
1093 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001094 */
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001095static efi_status_t EFIAPI efi_install_protocol_interface(
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02001096 efi_handle_t *handle, const efi_guid_t *protocol,
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001097 int protocol_interface_type, void *protocol_interface)
Alexander Grafc15d9212016-03-04 01:09:59 +01001098{
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001099 efi_status_t r;
1100
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001101 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1102 protocol_interface);
1103
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001104 if (!handle || !protocol ||
1105 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1106 r = EFI_INVALID_PARAMETER;
1107 goto out;
1108 }
1109
1110 /* Create new handle if requested. */
1111 if (!*handle) {
Heinrich Schuchardtcd522cb2017-08-27 00:51:09 +02001112 r = efi_create_handle(handle);
1113 if (r != EFI_SUCCESS)
1114 goto out;
Heinrich Schuchardt952e2062019-05-05 11:56:23 +02001115 EFI_PRINT("new handle %p\n", *handle);
Heinrich Schuchardt50f02102017-10-26 19:25:43 +02001116 } else {
Heinrich Schuchardt952e2062019-05-05 11:56:23 +02001117 EFI_PRINT("handle %p\n", *handle);
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001118 }
Heinrich Schuchardt865d5f32017-10-26 19:25:54 +02001119 /* Add new protocol */
1120 r = efi_add_protocol(*handle, protocol, protocol_interface);
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001121out:
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01001122 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01001123}
xypron.glpk@gmx.de0581fa82017-07-11 22:06:16 +02001124
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001125/**
Mario Six8fac2912018-07-10 08:40:17 +02001126 * efi_get_drivers() - get all drivers associated to a controller
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001127 * @handle: handle of the controller
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001128 * @protocol: protocol GUID (optional)
Mario Six8fac2912018-07-10 08:40:17 +02001129 * @number_of_drivers: number of child controllers
1130 * @driver_handle_buffer: handles of the the drivers
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001131 *
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001132 * The allocated buffer has to be freed with free().
1133 *
Mario Six8fac2912018-07-10 08:40:17 +02001134 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001135 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001136static efi_status_t efi_get_drivers(efi_handle_t handle,
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001137 const efi_guid_t *protocol,
1138 efi_uintn_t *number_of_drivers,
1139 efi_handle_t **driver_handle_buffer)
1140{
1141 struct efi_handler *handler;
1142 struct efi_open_protocol_info_item *item;
1143 efi_uintn_t count = 0, i;
1144 bool duplicate;
1145
1146 /* Count all driver associations */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001147 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001148 if (protocol && guidcmp(handler->guid, protocol))
1149 continue;
1150 list_for_each_entry(item, &handler->open_infos, link) {
1151 if (item->info.attributes &
1152 EFI_OPEN_PROTOCOL_BY_DRIVER)
1153 ++count;
1154 }
1155 }
1156 /*
1157 * Create buffer. In case of duplicate driver assignments the buffer
1158 * will be too large. But that does not harm.
1159 */
1160 *number_of_drivers = 0;
1161 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1162 if (!*driver_handle_buffer)
1163 return EFI_OUT_OF_RESOURCES;
1164 /* Collect unique driver handles */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001165 list_for_each_entry(handler, &handle->protocols, link) {
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001166 if (protocol && guidcmp(handler->guid, protocol))
1167 continue;
1168 list_for_each_entry(item, &handler->open_infos, link) {
1169 if (item->info.attributes &
1170 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1171 /* Check this is a new driver */
1172 duplicate = false;
1173 for (i = 0; i < *number_of_drivers; ++i) {
1174 if ((*driver_handle_buffer)[i] ==
1175 item->info.agent_handle)
1176 duplicate = true;
1177 }
1178 /* Copy handle to buffer */
1179 if (!duplicate) {
1180 i = (*number_of_drivers)++;
1181 (*driver_handle_buffer)[i] =
1182 item->info.agent_handle;
1183 }
1184 }
1185 }
1186 }
1187 return EFI_SUCCESS;
1188}
1189
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001190/**
Mario Six8fac2912018-07-10 08:40:17 +02001191 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001192 * @handle: handle of the controller
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001193 * @protocol: protocol GUID (optional)
Mario Six8fac2912018-07-10 08:40:17 +02001194 * @child_handle: handle of the child to destroy
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001195 *
1196 * This function implements the DisconnectController service.
Mario Six8fac2912018-07-10 08:40:17 +02001197 *
1198 * See the Unified Extensible Firmware Interface (UEFI) specification for
1199 * details.
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001200 *
Mario Six8fac2912018-07-10 08:40:17 +02001201 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001202 */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001203static efi_status_t efi_disconnect_all_drivers
1204 (efi_handle_t handle,
1205 const efi_guid_t *protocol,
1206 efi_handle_t child_handle)
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001207{
1208 efi_uintn_t number_of_drivers;
1209 efi_handle_t *driver_handle_buffer;
1210 efi_status_t r, ret;
1211
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001212 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001213 &driver_handle_buffer);
1214 if (ret != EFI_SUCCESS)
1215 return ret;
1216
1217 ret = EFI_NOT_FOUND;
1218 while (number_of_drivers) {
1219 r = EFI_CALL(efi_disconnect_controller(
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001220 handle,
Heinrich Schuchardte9943282018-01-11 08:16:04 +01001221 driver_handle_buffer[--number_of_drivers],
1222 child_handle));
1223 if (r == EFI_SUCCESS)
1224 ret = r;
1225 }
1226 free(driver_handle_buffer);
1227 return ret;
1228}
1229
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001230/**
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001231 * efi_uninstall_protocol() - uninstall protocol interface
1232 *
Mario Six8fac2912018-07-10 08:40:17 +02001233 * @handle: handle from which the protocol shall be removed
1234 * @protocol: GUID of the protocol to be removed
1235 * @protocol_interface: interface to be removed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001236 *
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001237 * This function DOES NOT delete a handle without installed protocol.
Mario Six8fac2912018-07-10 08:40:17 +02001238 *
1239 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001240 */
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001241static efi_status_t efi_uninstall_protocol
1242 (efi_handle_t handle, const efi_guid_t *protocol,
1243 void *protocol_interface)
Alexander Grafc15d9212016-03-04 01:09:59 +01001244{
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001245 struct efi_object *efiobj;
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001246 struct efi_handler *handler;
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001247 struct efi_open_protocol_info_item *item;
1248 struct efi_open_protocol_info_item *pos;
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001249 efi_status_t r;
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001250
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001251 /* Check handle */
1252 efiobj = efi_search_obj(handle);
1253 if (!efiobj) {
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001254 r = EFI_INVALID_PARAMETER;
1255 goto out;
1256 }
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001257 /* Find the protocol on the handle */
1258 r = efi_search_protocol(handle, protocol, &handler);
1259 if (r != EFI_SUCCESS)
1260 goto out;
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001261 /* Disconnect controllers */
1262 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1263 if (!list_empty(&handler->open_infos)) {
1264 r = EFI_ACCESS_DENIED;
1265 goto out;
1266 }
1267 /* Close protocol */
1268 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1269 if (item->info.attributes ==
1270 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1271 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1272 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1273 list_del(&item->link);
1274 }
1275 if (!list_empty(&handler->open_infos)) {
Heinrich Schuchardt7538c272017-10-26 19:25:56 +02001276 r = EFI_ACCESS_DENIED;
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001277 goto out;
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001278 }
Heinrich Schuchardt86637f32018-01-11 08:16:05 +01001279 r = efi_remove_protocol(handle, protocol, protocol_interface);
xypron.glpk@gmx.de2cfad482017-07-11 22:06:17 +02001280out:
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001281 return r;
Alexander Grafc15d9212016-03-04 01:09:59 +01001282}
1283
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001284/**
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02001285 * efi_uninstall_protocol_interface() - uninstall protocol interface
1286 * @handle: handle from which the protocol shall be removed
1287 * @protocol: GUID of the protocol to be removed
1288 * @protocol_interface: interface to be removed
1289 *
1290 * This function implements the UninstallProtocolInterface service.
1291 *
1292 * See the Unified Extensible Firmware Interface (UEFI) specification for
1293 * details.
1294 *
1295 * Return: status code
1296 */
1297static efi_status_t EFIAPI efi_uninstall_protocol_interface
1298 (efi_handle_t handle, const efi_guid_t *protocol,
1299 void *protocol_interface)
1300{
1301 efi_status_t ret;
1302
1303 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1304
1305 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1306 if (ret != EFI_SUCCESS)
1307 goto out;
1308
1309 /* If the last protocol has been removed, delete the handle. */
1310 if (list_empty(&handle->protocols)) {
1311 list_del(&handle->link);
1312 free(handle);
1313 }
1314out:
1315 return EFI_EXIT(ret);
1316}
1317
1318/**
Mario Six8fac2912018-07-10 08:40:17 +02001319 * efi_register_protocol_notify() - register an event for notification when a
1320 * protocol is installed.
1321 * @protocol: GUID of the protocol whose installation shall be notified
1322 * @event: event to be signaled upon installation of the protocol
1323 * @registration: key for retrieving the registration information
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001324 *
1325 * This function implements the RegisterProtocolNotify service.
1326 * See the Unified Extensible Firmware Interface (UEFI) specification
1327 * for details.
1328 *
Mario Six8fac2912018-07-10 08:40:17 +02001329 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001330 */
Heinrich Schuchardte547c662017-10-05 16:35:53 +02001331static efi_status_t EFIAPI efi_register_protocol_notify(
1332 const efi_guid_t *protocol,
1333 struct efi_event *event,
1334 void **registration)
Alexander Grafc15d9212016-03-04 01:09:59 +01001335{
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001336 struct efi_register_notify_event *item;
1337 efi_status_t ret = EFI_SUCCESS;
1338
Rob Clark238f88c2017-09-13 18:05:41 -04001339 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001340
1341 if (!protocol || !event || !registration) {
1342 ret = EFI_INVALID_PARAMETER;
1343 goto out;
1344 }
1345
1346 item = calloc(1, sizeof(struct efi_register_notify_event));
1347 if (!item) {
1348 ret = EFI_OUT_OF_RESOURCES;
1349 goto out;
1350 }
1351
1352 item->event = event;
1353 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
Heinrich Schuchardtd375e752019-05-21 18:19:01 +02001354 INIT_LIST_HEAD(&item->handles);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001355
1356 list_add_tail(&item->link, &efi_register_notify_events);
1357
1358 *registration = item;
1359out:
1360 return EFI_EXIT(ret);
Alexander Grafc15d9212016-03-04 01:09:59 +01001361}
1362
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001363/**
Mario Six8fac2912018-07-10 08:40:17 +02001364 * efi_search() - determine if an EFI handle implements a protocol
1365 * @search_type: selection criterion
1366 * @protocol: GUID of the protocol
1367 * @search_key: registration key
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001368 * @handle: handle
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001369 *
1370 * See the documentation of the LocateHandle service in the UEFI specification.
1371 *
Mario Six8fac2912018-07-10 08:40:17 +02001372 * Return: 0 if the handle implements the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001373 */
Alexander Grafc15d9212016-03-04 01:09:59 +01001374static int efi_search(enum efi_locate_search_type search_type,
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001375 const efi_guid_t *protocol, efi_handle_t handle)
Alexander Grafc15d9212016-03-04 01:09:59 +01001376{
Heinrich Schuchardt6a430752017-10-26 19:25:55 +02001377 efi_status_t ret;
Alexander Grafc15d9212016-03-04 01:09:59 +01001378
1379 switch (search_type) {
Heinrich Schuchardt68845f02017-11-06 21:17:42 +01001380 case ALL_HANDLES:
Alexander Grafc15d9212016-03-04 01:09:59 +01001381 return 0;
Heinrich Schuchardt68845f02017-11-06 21:17:42 +01001382 case BY_PROTOCOL:
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02001383 ret = efi_search_protocol(handle, protocol, NULL);
Heinrich Schuchardt6a430752017-10-26 19:25:55 +02001384 return (ret != EFI_SUCCESS);
1385 default:
1386 /* Invalid search type */
Alexander Grafc15d9212016-03-04 01:09:59 +01001387 return -1;
1388 }
Alexander Grafc15d9212016-03-04 01:09:59 +01001389}
1390
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001391/**
Heinrich Schuchardteb616522019-05-29 07:46:33 +02001392 * efi_check_register_notify_event() - check if registration key is valid
1393 *
1394 * Check that a pointer is a valid registration key as returned by
1395 * RegisterProtocolNotify().
1396 *
1397 * @key: registration key
1398 * Return: valid registration key or NULL
1399 */
1400static struct efi_register_notify_event *efi_check_register_notify_event
1401 (void *key)
1402{
1403 struct efi_register_notify_event *event;
1404
1405 list_for_each_entry(event, &efi_register_notify_events, link) {
1406 if (event == (struct efi_register_notify_event *)key)
1407 return event;
1408 }
1409 return NULL;
1410}
1411
1412/**
Mario Six8fac2912018-07-10 08:40:17 +02001413 * efi_locate_handle() - locate handles implementing a protocol
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001414 *
1415 * @search_type: selection criterion
1416 * @protocol: GUID of the protocol
1417 * @search_key: registration key
1418 * @buffer_size: size of the buffer to receive the handles in bytes
1419 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001420 *
1421 * This function is meant for U-Boot internal calls. For the API implementation
1422 * of the LocateHandle service see efi_locate_handle_ext.
1423 *
Mario Six8fac2912018-07-10 08:40:17 +02001424 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001425 */
xypron.glpk@gmx.decab4dd52017-08-09 20:55:00 +02001426static efi_status_t efi_locate_handle(
Alexander Grafc15d9212016-03-04 01:09:59 +01001427 enum efi_locate_search_type search_type,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02001428 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01001429 efi_uintn_t *buffer_size, efi_handle_t *buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +01001430{
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001431 struct efi_object *efiobj;
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01001432 efi_uintn_t size = 0;
Heinrich Schuchardteb616522019-05-29 07:46:33 +02001433 struct efi_register_notify_event *event;
Heinrich Schuchardtd375e752019-05-21 18:19:01 +02001434 struct efi_protocol_notification *handle = NULL;
Alexander Grafc15d9212016-03-04 01:09:59 +01001435
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001436 /* Check parameters */
1437 switch (search_type) {
1438 case ALL_HANDLES:
1439 break;
1440 case BY_REGISTER_NOTIFY:
1441 if (!search_key)
1442 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001443 /* Check that the registration key is valid */
Heinrich Schuchardteb616522019-05-29 07:46:33 +02001444 event = efi_check_register_notify_event(search_key);
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001445 if (!event)
1446 return EFI_INVALID_PARAMETER;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +02001447 break;
Heinrich Schuchardtec66fc82017-11-06 21:17:49 +01001448 case BY_PROTOCOL:
1449 if (!protocol)
1450 return EFI_INVALID_PARAMETER;
1451 break;
1452 default:
1453 return EFI_INVALID_PARAMETER;
1454 }
1455
Alexander Grafc15d9212016-03-04 01:09:59 +01001456 /* Count how much space we need */
Heinrich Schuchardtd375e752019-05-21 18:19:01 +02001457 if (search_type == BY_REGISTER_NOTIFY) {
1458 if (list_empty(&event->handles))
1459 return EFI_NOT_FOUND;
1460 handle = list_first_entry(&event->handles,
1461 struct efi_protocol_notification,
1462 link);
1463 efiobj = handle->handle;
1464 size += sizeof(void *);
1465 } else {
1466 list_for_each_entry(efiobj, &efi_obj_list, link) {
1467 if (!efi_search(search_type, protocol, efiobj))
1468 size += sizeof(void *);
1469 }
1470 if (size == 0)
1471 return EFI_NOT_FOUND;
Alexander Grafc15d9212016-03-04 01:09:59 +01001472 }
1473
Heinrich Schuchardtc0ee5f32019-05-04 17:37:32 +02001474 if (!buffer_size)
1475 return EFI_INVALID_PARAMETER;
1476
Alexander Grafc15d9212016-03-04 01:09:59 +01001477 if (*buffer_size < size) {
1478 *buffer_size = size;
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001479 return EFI_BUFFER_TOO_SMALL;
Alexander Grafc15d9212016-03-04 01:09:59 +01001480 }
1481
Rob Clarkcdee3372017-08-06 14:10:07 -04001482 *buffer_size = size;
Heinrich Schuchardtc0ee5f32019-05-04 17:37:32 +02001483
Heinrich Schuchardtc97f9472019-05-10 19:03:49 +02001484 /* The buffer size is sufficient but there is no buffer */
Heinrich Schuchardtc0ee5f32019-05-04 17:37:32 +02001485 if (!buffer)
1486 return EFI_INVALID_PARAMETER;
Rob Clarkcdee3372017-08-06 14:10:07 -04001487
Alexander Grafc15d9212016-03-04 01:09:59 +01001488 /* Then fill the array */
Heinrich Schuchardtd375e752019-05-21 18:19:01 +02001489 if (search_type == BY_REGISTER_NOTIFY) {
1490 *buffer = efiobj;
1491 list_del(&handle->link);
1492 } else {
1493 list_for_each_entry(efiobj, &efi_obj_list, link) {
1494 if (!efi_search(search_type, protocol, efiobj))
1495 *buffer++ = efiobj;
1496 }
Alexander Grafc15d9212016-03-04 01:09:59 +01001497 }
1498
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001499 return EFI_SUCCESS;
1500}
1501
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001502/**
Mario Six8fac2912018-07-10 08:40:17 +02001503 * efi_locate_handle_ext() - locate handles implementing a protocol.
1504 * @search_type: selection criterion
1505 * @protocol: GUID of the protocol
1506 * @search_key: registration key
1507 * @buffer_size: size of the buffer to receive the handles in bytes
1508 * @buffer: buffer to receive the relevant handles
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001509 *
1510 * This function implements the LocateHandle service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001511 *
Mario Six8fac2912018-07-10 08:40:17 +02001512 * See the Unified Extensible Firmware Interface (UEFI) specification for
1513 * details.
1514 *
1515 * Return: 0 if the handle implements the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001516 */
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001517static efi_status_t EFIAPI efi_locate_handle_ext(
1518 enum efi_locate_search_type search_type,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02001519 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01001520 efi_uintn_t *buffer_size, efi_handle_t *buffer)
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001521{
Rob Clark238f88c2017-09-13 18:05:41 -04001522 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02001523 buffer_size, buffer);
1524
1525 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1526 buffer_size, buffer));
Alexander Grafc15d9212016-03-04 01:09:59 +01001527}
1528
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001529/**
Mario Six8fac2912018-07-10 08:40:17 +02001530 * efi_remove_configuration_table() - collapses configuration table entries,
1531 * removing index i
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001532 *
Mario Six8fac2912018-07-10 08:40:17 +02001533 * @i: index of the table entry to be removed
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001534 */
Alexander Graffe3366f2017-07-26 13:41:04 +02001535static void efi_remove_configuration_table(int i)
1536{
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001537 struct efi_configuration_table *this = &systab.tables[i];
1538 struct efi_configuration_table *next = &systab.tables[i + 1];
1539 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
Alexander Graffe3366f2017-07-26 13:41:04 +02001540
1541 memmove(this, next, (ulong)end - (ulong)next);
1542 systab.nr_tables--;
1543}
1544
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001545/**
Mario Six8fac2912018-07-10 08:40:17 +02001546 * efi_install_configuration_table() - adds, updates, or removes a
1547 * configuration table
1548 * @guid: GUID of the installed table
1549 * @table: table to be installed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001550 *
1551 * This function is used for internal calls. For the API implementation of the
1552 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1553 *
Mario Six8fac2912018-07-10 08:40:17 +02001554 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001555 */
Heinrich Schuchardt91064592018-02-18 15:17:49 +01001556efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1557 void *table)
Alexander Grafc15d9212016-03-04 01:09:59 +01001558{
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001559 struct efi_event *evt;
Alexander Grafc15d9212016-03-04 01:09:59 +01001560 int i;
1561
Heinrich Schuchardt754ce102018-02-18 00:08:00 +01001562 if (!guid)
1563 return EFI_INVALID_PARAMETER;
1564
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001565 /* Check for GUID override */
Alexander Grafc15d9212016-03-04 01:09:59 +01001566 for (i = 0; i < systab.nr_tables; i++) {
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001567 if (!guidcmp(guid, &systab.tables[i].guid)) {
Alexander Graffe3366f2017-07-26 13:41:04 +02001568 if (table)
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001569 systab.tables[i].table = table;
Alexander Graffe3366f2017-07-26 13:41:04 +02001570 else
1571 efi_remove_configuration_table(i);
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001572 goto out;
Alexander Grafc15d9212016-03-04 01:09:59 +01001573 }
1574 }
1575
Alexander Graffe3366f2017-07-26 13:41:04 +02001576 if (!table)
1577 return EFI_NOT_FOUND;
1578
Alexander Grafc15d9212016-03-04 01:09:59 +01001579 /* No override, check for overflow */
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001580 if (i >= EFI_MAX_CONFIGURATION_TABLES)
Alexander Grafc5c11632016-08-19 01:23:24 +02001581 return EFI_OUT_OF_RESOURCES;
Alexander Grafc15d9212016-03-04 01:09:59 +01001582
1583 /* Add a new entry */
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02001584 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1585 systab.tables[i].table = table;
Alexander Graf9982e672016-08-19 01:23:30 +02001586 systab.nr_tables = i + 1;
Alexander Grafc15d9212016-03-04 01:09:59 +01001587
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001588out:
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001589 /* systab.nr_tables may have changed. So we need to update the CRC32 */
Heinrich Schuchardtac2d4da2018-07-07 15:36:05 +02001590 efi_update_table_header_crc32(&systab.hdr);
1591
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001592 /* Notify that the configuration table was changed */
1593 list_for_each_entry(evt, &efi_events, link) {
1594 if (evt->group && !guidcmp(evt->group, guid)) {
1595 efi_signal_event(evt, false);
1596 break;
1597 }
1598 }
1599
Alexander Grafc5c11632016-08-19 01:23:24 +02001600 return EFI_SUCCESS;
Alexander Grafc15d9212016-03-04 01:09:59 +01001601}
1602
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001603/**
Mario Six8fac2912018-07-10 08:40:17 +02001604 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1605 * configuration table.
1606 * @guid: GUID of the installed table
1607 * @table: table to be installed
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001608 *
1609 * This function implements the InstallConfigurationTable service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001610 *
Mario Six8fac2912018-07-10 08:40:17 +02001611 * See the Unified Extensible Firmware Interface (UEFI) specification for
1612 * details.
1613 *
1614 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001615 */
Alexander Grafc5c11632016-08-19 01:23:24 +02001616static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1617 void *table)
1618{
Rob Clark238f88c2017-09-13 18:05:41 -04001619 EFI_ENTRY("%pUl, %p", guid, table);
Alexander Grafc5c11632016-08-19 01:23:24 +02001620 return EFI_EXIT(efi_install_configuration_table(guid, table));
1621}
1622
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001623/**
Mario Six8fac2912018-07-10 08:40:17 +02001624 * efi_setup_loaded_image() - initialize a loaded image
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001625 *
1626 * Initialize a loaded_image_info and loaded_image_info object with correct
Rob Clarkf8db9222017-09-13 18:05:33 -04001627 * protocols, boot-device, etc.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001628 *
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001629 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1630 * code is returned.
1631 *
1632 * @device_path: device path of the loaded image
1633 * @file_path: file path of the loaded image
1634 * @handle_ptr: handle of the loaded image
1635 * @info_ptr: loaded image protocol
1636 * Return: status code
Rob Clarkf8db9222017-09-13 18:05:33 -04001637 */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001638efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1639 struct efi_device_path *file_path,
1640 struct efi_loaded_image_obj **handle_ptr,
1641 struct efi_loaded_image **info_ptr)
Rob Clarkf8db9222017-09-13 18:05:33 -04001642{
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001643 efi_status_t ret;
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001644 struct efi_loaded_image *info = NULL;
1645 struct efi_loaded_image_obj *obj = NULL;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001646 struct efi_device_path *dp;
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001647
1648 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1649 *handle_ptr = NULL;
1650 *info_ptr = NULL;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001651
1652 info = calloc(1, sizeof(*info));
1653 if (!info)
1654 return EFI_OUT_OF_RESOURCES;
1655 obj = calloc(1, sizeof(*obj));
1656 if (!obj) {
1657 free(info);
1658 return EFI_OUT_OF_RESOURCES;
1659 }
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +02001660 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001661
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +01001662 /* Add internal object to object list */
Heinrich Schuchardt72928722018-09-26 05:27:56 +02001663 efi_add_handle(&obj->header);
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001664
Heinrich Schuchardtc47f8702018-07-05 08:17:58 +02001665 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001666 info->file_path = file_path;
Heinrich Schuchardt8a7e09d2018-08-26 15:31:52 +02001667 info->system_table = &systab;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001668
Heinrich Schuchardtf3996be2018-01-26 06:50:54 +01001669 if (device_path) {
1670 info->device_handle = efi_dp_find_obj(device_path, NULL);
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001671
1672 dp = efi_dp_append(device_path, file_path);
1673 if (!dp) {
1674 ret = EFI_OUT_OF_RESOURCES;
Heinrich Schuchardtf3996be2018-01-26 06:50:54 +01001675 goto failure;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001676 }
1677 } else {
1678 dp = NULL;
Heinrich Schuchardtf3996be2018-01-26 06:50:54 +01001679 }
AKASHI Takahirobbe13da2019-03-27 13:40:32 +09001680 ret = efi_add_protocol(&obj->header,
1681 &efi_guid_loaded_image_device_path, dp);
1682 if (ret != EFI_SUCCESS)
1683 goto failure;
Rob Clarkf8db9222017-09-13 18:05:33 -04001684
1685 /*
1686 * When asking for the loaded_image interface, just
1687 * return handle which points to loaded_image_info
1688 */
Heinrich Schuchardt72928722018-09-26 05:27:56 +02001689 ret = efi_add_protocol(&obj->header,
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001690 &efi_guid_loaded_image, info);
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001691 if (ret != EFI_SUCCESS)
1692 goto failure;
Rob Clarkf8db9222017-09-13 18:05:33 -04001693
Heinrich Schuchardtd20f5122019-03-19 18:58:58 +01001694 *info_ptr = info;
1695 *handle_ptr = obj;
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001696
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +01001697 return ret;
Heinrich Schuchardt24d3a662017-10-26 19:25:58 +02001698failure:
1699 printf("ERROR: Failure to install protocols for loaded image\n");
Heinrich Schuchardt6346a902019-02-06 19:41:29 +01001700 efi_delete_handle(&obj->header);
1701 free(info);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +01001702 return ret;
Rob Clarkf8db9222017-09-13 18:05:33 -04001703}
1704
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001705/**
Mario Six8fac2912018-07-10 08:40:17 +02001706 * efi_load_image_from_path() - load an image using a file path
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001707 *
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001708 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1709 * callers obligation to update the memory type as needed.
1710 *
1711 * @file_path: the path of the image to load
1712 * @buffer: buffer containing the loaded image
1713 * @size: size of the loaded image
1714 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001715 */
AKASHI Takahiro14ff23b2019-04-19 12:22:35 +09001716static
Rob Clarkc84c1102017-09-13 18:05:38 -04001717efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001718 void **buffer, efi_uintn_t *size)
Rob Clark857a1222017-09-13 18:05:35 -04001719{
1720 struct efi_file_info *info = NULL;
1721 struct efi_file_handle *f;
1722 static efi_status_t ret;
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001723 u64 addr;
Heinrich Schuchardt6b06e0d2018-04-03 22:37:11 +02001724 efi_uintn_t bs;
Rob Clark857a1222017-09-13 18:05:35 -04001725
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001726 /* In case of failure nothing is returned */
1727 *buffer = NULL;
1728 *size = 0;
1729
1730 /* Open file */
Rob Clark857a1222017-09-13 18:05:35 -04001731 f = efi_file_from_path(file_path);
1732 if (!f)
1733 return EFI_DEVICE_ERROR;
1734
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001735 /* Get file size */
Rob Clark857a1222017-09-13 18:05:35 -04001736 bs = 0;
1737 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1738 &bs, info));
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001739 if (ret != EFI_BUFFER_TOO_SMALL) {
1740 ret = EFI_DEVICE_ERROR;
Rob Clark857a1222017-09-13 18:05:35 -04001741 goto error;
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001742 }
Rob Clark857a1222017-09-13 18:05:35 -04001743
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001744 info = malloc(bs);
1745 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1746 info));
1747 if (ret != EFI_SUCCESS)
Rob Clark857a1222017-09-13 18:05:35 -04001748 goto error;
1749
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001750 /*
1751 * When reading the file we do not yet know if it contains an
1752 * application, a boottime driver, or a runtime driver. So here we
1753 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1754 * update the reservation according to the image type.
1755 */
Heinrich Schuchardt6b06e0d2018-04-03 22:37:11 +02001756 bs = info->file_size;
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001757 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1758 EFI_BOOT_SERVICES_DATA,
1759 efi_size_in_pages(bs), &addr);
Rob Clark857a1222017-09-13 18:05:35 -04001760 if (ret != EFI_SUCCESS) {
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001761 ret = EFI_OUT_OF_RESOURCES;
1762 goto error;
Rob Clark857a1222017-09-13 18:05:35 -04001763 }
1764
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001765 /* Read file */
1766 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1767 if (ret != EFI_SUCCESS)
1768 efi_free_pages(addr, efi_size_in_pages(bs));
1769 *buffer = (void *)(uintptr_t)addr;
1770 *size = bs;
1771error:
1772 EFI_CALL(f->close(f));
1773 free(info);
Rob Clark857a1222017-09-13 18:05:35 -04001774 return ret;
1775}
1776
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001777/**
Mario Six8fac2912018-07-10 08:40:17 +02001778 * efi_load_image() - load an EFI image into memory
1779 * @boot_policy: true for request originating from the boot manager
1780 * @parent_image: the caller's image handle
1781 * @file_path: the path of the image to load
1782 * @source_buffer: memory location from which the image is installed
1783 * @source_size: size of the memory area from which the image is installed
1784 * @image_handle: handle for the newly installed image
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001785 *
1786 * This function implements the LoadImage service.
Mario Six8fac2912018-07-10 08:40:17 +02001787 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001788 * See the Unified Extensible Firmware Interface (UEFI) specification
1789 * for details.
1790 *
Mario Six8fac2912018-07-10 08:40:17 +02001791 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001792 */
AKASHI Takahirob0ad9052019-03-05 14:53:31 +09001793efi_status_t EFIAPI efi_load_image(bool boot_policy,
1794 efi_handle_t parent_image,
1795 struct efi_device_path *file_path,
1796 void *source_buffer,
1797 efi_uintn_t source_size,
1798 efi_handle_t *image_handle)
Alexander Grafc15d9212016-03-04 01:09:59 +01001799{
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001800 struct efi_device_path *dp, *fp;
Tom Rini04c49062018-09-30 10:38:15 -04001801 struct efi_loaded_image *info = NULL;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +02001802 struct efi_loaded_image_obj **image_obj =
1803 (struct efi_loaded_image_obj **)image_handle;
Heinrich Schuchardtd4d7ca92017-12-04 18:03:03 +01001804 efi_status_t ret;
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001805 void *dest_buffer;
Alexander Grafc15d9212016-03-04 01:09:59 +01001806
Heinrich Schuchardt4cde1fa2018-04-03 22:29:30 +02001807 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
Alexander Grafc15d9212016-03-04 01:09:59 +01001808 file_path, source_buffer, source_size, image_handle);
Rob Clark857a1222017-09-13 18:05:35 -04001809
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +02001810 if (!image_handle || !efi_search_obj(parent_image)) {
Heinrich Schuchardtc935c2f2018-03-07 02:40:51 +01001811 ret = EFI_INVALID_PARAMETER;
1812 goto error;
1813 }
1814
1815 if (!source_buffer && !file_path) {
1816 ret = EFI_NOT_FOUND;
1817 goto error;
1818 }
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +02001819 /* The parent image handle must refer to a loaded image */
1820 if (!parent_image->type) {
1821 ret = EFI_INVALID_PARAMETER;
1822 goto error;
1823 }
Rob Clark857a1222017-09-13 18:05:35 -04001824
1825 if (!source_buffer) {
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001826 ret = efi_load_image_from_path(file_path, &dest_buffer,
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001827 &source_size);
Heinrich Schuchardtd4d7ca92017-12-04 18:03:03 +01001828 if (ret != EFI_SUCCESS)
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001829 goto error;
Rob Clark857a1222017-09-13 18:05:35 -04001830 } else {
Heinrich Schuchardt78a23b52019-05-05 16:55:06 +02001831 if (!source_size) {
1832 ret = EFI_LOAD_ERROR;
1833 goto error;
1834 }
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001835 dest_buffer = source_buffer;
Rob Clark857a1222017-09-13 18:05:35 -04001836 }
Heinrich Schuchardt28b39172019-04-20 19:24:43 +00001837 /* split file_path which contains both the device and file parts */
1838 efi_dp_split_file_path(file_path, &dp, &fp);
Heinrich Schuchardte3d3a0c2018-12-24 09:19:07 +01001839 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
Heinrich Schuchardt47e35a92019-03-04 17:50:05 +01001840 if (ret == EFI_SUCCESS)
1841 ret = efi_load_pe(*image_obj, dest_buffer, info);
1842 if (!source_buffer)
1843 /* Release buffer to which file was loaded */
1844 efi_free_pages((uintptr_t)dest_buffer,
1845 efi_size_in_pages(source_size));
1846 if (ret == EFI_SUCCESS) {
1847 info->system_table = &systab;
1848 info->parent_handle = parent_image;
1849 } else {
1850 /* The image is invalid. Release all associated resources. */
1851 efi_delete_handle(*image_handle);
1852 *image_handle = NULL;
1853 free(info);
1854 }
Heinrich Schuchardtc935c2f2018-03-07 02:40:51 +01001855error:
Heinrich Schuchardtd4d7ca92017-12-04 18:03:03 +01001856 return EFI_EXIT(ret);
Alexander Grafc15d9212016-03-04 01:09:59 +01001857}
1858
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001859/**
Alexander Graffa5246b2018-11-15 21:23:47 +01001860 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1861 */
1862static void efi_exit_caches(void)
1863{
1864#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1865 /*
1866 * Grub on 32bit ARM needs to have caches disabled before jumping into
1867 * a zImage, but does not know of all cache layers. Give it a hand.
1868 */
1869 if (efi_is_direct_boot)
1870 cleanup_before_linux();
1871#endif
1872}
1873
1874/**
Mario Six8fac2912018-07-10 08:40:17 +02001875 * efi_exit_boot_services() - stop all boot services
1876 * @image_handle: handle of the loaded image
1877 * @map_key: key of the memory map
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001878 *
1879 * This function implements the ExitBootServices service.
Mario Six8fac2912018-07-10 08:40:17 +02001880 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001881 * See the Unified Extensible Firmware Interface (UEFI) specification
1882 * for details.
1883 *
Mario Six8fac2912018-07-10 08:40:17 +02001884 * All timer events are disabled. For exit boot services events the
1885 * notification function is called. The boot services are disabled in the
1886 * system table.
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001887 *
Mario Six8fac2912018-07-10 08:40:17 +02001888 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001889 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01001890static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
Heinrich Schuchardt8bd4f412019-05-05 21:58:35 +02001891 efi_uintn_t map_key)
Alexander Grafc15d9212016-03-04 01:09:59 +01001892{
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +01001893 struct efi_event *evt;
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001894
Heinrich Schuchardt8bd4f412019-05-05 21:58:35 +02001895 EFI_ENTRY("%p, %zx", image_handle, map_key);
Alexander Grafc15d9212016-03-04 01:09:59 +01001896
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +02001897 /* Check that the caller has read the current memory map */
1898 if (map_key != efi_memory_map_key)
1899 return EFI_INVALID_PARAMETER;
1900
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001901 /* Make sure that notification functions are not called anymore */
1902 efi_tpl = TPL_HIGH_LEVEL;
1903
1904 /* Check if ExitBootServices has already been called */
1905 if (!systab.boottime)
1906 return EFI_EXIT(EFI_SUCCESS);
1907
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001908 /* Add related events to the event group */
1909 list_for_each_entry(evt, &efi_events, link) {
1910 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1911 evt->group = &efi_guid_event_group_exit_boot_services;
1912 }
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001913 /* Notify that ExitBootServices is invoked. */
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +01001914 list_for_each_entry(evt, &efi_events, link) {
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +01001915 if (evt->group &&
1916 !guidcmp(evt->group,
1917 &efi_guid_event_group_exit_boot_services)) {
1918 efi_signal_event(evt, false);
1919 break;
1920 }
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001921 }
Heinrich Schuchardt2d4c7382017-09-15 10:06:18 +02001922
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001923 /* TODO: Should persist EFI variables here */
Rob Clark15f3d742017-09-13 18:05:37 -04001924
Alexander Graf2ebeb442016-11-17 01:02:57 +01001925 board_quiesce_devices();
1926
Alexander Graffa5246b2018-11-15 21:23:47 +01001927 /* Fix up caches for EFI payloads if necessary */
1928 efi_exit_caches();
1929
Alexander Grafc15d9212016-03-04 01:09:59 +01001930 /* This stops all lingering devices */
1931 bootm_disable_interrupts();
1932
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02001933 /* Disable boot time services */
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001934 systab.con_in_handle = NULL;
1935 systab.con_in = NULL;
1936 systab.con_out_handle = NULL;
1937 systab.con_out = NULL;
1938 systab.stderr_handle = NULL;
1939 systab.std_err = NULL;
1940 systab.boottime = NULL;
1941
1942 /* Recalculate CRC32 */
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02001943 efi_update_table_header_crc32(&systab.hdr);
Heinrich Schuchardtb1fbb212018-01-19 20:24:52 +01001944
Alexander Grafc15d9212016-03-04 01:09:59 +01001945 /* Give the payload some time to boot */
Heinrich Schuchardt18081d42017-10-18 18:13:04 +02001946 efi_set_watchdog(0);
Alexander Grafc15d9212016-03-04 01:09:59 +01001947 WATCHDOG_RESET();
1948
1949 return EFI_EXIT(EFI_SUCCESS);
1950}
1951
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001952/**
Mario Six8fac2912018-07-10 08:40:17 +02001953 * efi_get_next_monotonic_count() - get next value of the counter
1954 * @count: returned value of the counter
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001955 *
1956 * This function implements the NextMonotonicCount service.
Mario Six8fac2912018-07-10 08:40:17 +02001957 *
1958 * See the Unified Extensible Firmware Interface (UEFI) specification for
1959 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001960 *
Mario Six8fac2912018-07-10 08:40:17 +02001961 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001962 */
Alexander Grafc15d9212016-03-04 01:09:59 +01001963static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1964{
Heinrich Schuchardt91064592018-02-18 15:17:49 +01001965 static uint64_t mono;
Heinrich Schuchardtddc787d2019-05-17 12:47:17 +02001966 efi_status_t ret;
Heinrich Schuchardt91064592018-02-18 15:17:49 +01001967
Alexander Grafc15d9212016-03-04 01:09:59 +01001968 EFI_ENTRY("%p", count);
Heinrich Schuchardtddc787d2019-05-17 12:47:17 +02001969 if (!count) {
1970 ret = EFI_INVALID_PARAMETER;
1971 goto out;
1972 }
Alexander Grafc15d9212016-03-04 01:09:59 +01001973 *count = mono++;
Heinrich Schuchardtddc787d2019-05-17 12:47:17 +02001974 ret = EFI_SUCCESS;
1975out:
1976 return EFI_EXIT(ret);
Alexander Grafc15d9212016-03-04 01:09:59 +01001977}
1978
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001979/**
Mario Six8fac2912018-07-10 08:40:17 +02001980 * efi_stall() - sleep
1981 * @microseconds: period to sleep in microseconds
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001982 *
Mario Six8fac2912018-07-10 08:40:17 +02001983 * This function implements the Stall service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001984 *
Mario Six8fac2912018-07-10 08:40:17 +02001985 * See the Unified Extensible Firmware Interface (UEFI) specification for
1986 * details.
1987 *
1988 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02001989 */
Alexander Grafc15d9212016-03-04 01:09:59 +01001990static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1991{
1992 EFI_ENTRY("%ld", microseconds);
1993 udelay(microseconds);
1994 return EFI_EXIT(EFI_SUCCESS);
1995}
1996
Heinrich Schuchardt59999172018-05-11 18:15:41 +02001997/**
Mario Six8fac2912018-07-10 08:40:17 +02001998 * efi_set_watchdog_timer() - reset the watchdog timer
1999 * @timeout: seconds before reset by watchdog
2000 * @watchdog_code: code to be logged when resetting
2001 * @data_size: size of buffer in bytes
2002 * @watchdog_data: buffer with data describing the reset reason
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002003 *
Heinrich Schuchardt18081d42017-10-18 18:13:04 +02002004 * This function implements the SetWatchdogTimer service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002005 *
Mario Six8fac2912018-07-10 08:40:17 +02002006 * See the Unified Extensible Firmware Interface (UEFI) specification for
2007 * details.
2008 *
2009 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002010 */
Alexander Grafc15d9212016-03-04 01:09:59 +01002011static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2012 uint64_t watchdog_code,
2013 unsigned long data_size,
2014 uint16_t *watchdog_data)
2015{
Masahiro Yamadac7570a32018-08-06 20:47:40 +09002016 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
Alexander Grafc15d9212016-03-04 01:09:59 +01002017 data_size, watchdog_data);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +02002018 return EFI_EXIT(efi_set_watchdog(timeout));
Alexander Grafc15d9212016-03-04 01:09:59 +01002019}
2020
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002021/**
Mario Six8fac2912018-07-10 08:40:17 +02002022 * efi_close_protocol() - close a protocol
2023 * @handle: handle on which the protocol shall be closed
2024 * @protocol: GUID of the protocol to close
2025 * @agent_handle: handle of the driver
2026 * @controller_handle: handle of the controller
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002027 *
2028 * This function implements the CloseProtocol service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002029 *
Mario Six8fac2912018-07-10 08:40:17 +02002030 * See the Unified Extensible Firmware Interface (UEFI) specification for
2031 * details.
2032 *
2033 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002034 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01002035static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002036 const efi_guid_t *protocol,
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01002037 efi_handle_t agent_handle,
2038 efi_handle_t controller_handle)
Alexander Grafc15d9212016-03-04 01:09:59 +01002039{
Heinrich Schuchardt4fd1ee22018-01-11 08:15:59 +01002040 struct efi_handler *handler;
2041 struct efi_open_protocol_info_item *item;
2042 struct efi_open_protocol_info_item *pos;
2043 efi_status_t r;
2044
Rob Clark238f88c2017-09-13 18:05:41 -04002045 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
Alexander Grafc15d9212016-03-04 01:09:59 +01002046 controller_handle);
Heinrich Schuchardt4fd1ee22018-01-11 08:15:59 +01002047
Heinrich Schuchardt5d8231b2019-05-05 10:37:51 +02002048 if (!efi_search_obj(agent_handle) ||
2049 (controller_handle && !efi_search_obj(controller_handle))) {
Heinrich Schuchardt4fd1ee22018-01-11 08:15:59 +01002050 r = EFI_INVALID_PARAMETER;
2051 goto out;
2052 }
2053 r = efi_search_protocol(handle, protocol, &handler);
2054 if (r != EFI_SUCCESS)
2055 goto out;
2056
2057 r = EFI_NOT_FOUND;
2058 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2059 if (item->info.agent_handle == agent_handle &&
2060 item->info.controller_handle == controller_handle) {
2061 efi_delete_open_info(item);
2062 r = EFI_SUCCESS;
2063 break;
2064 }
2065 }
2066out:
2067 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002068}
2069
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002070/**
Mario Six8fac2912018-07-10 08:40:17 +02002071 * efi_open_protocol_information() - provide information about then open status
2072 * of a protocol on a handle
2073 * @handle: handle for which the information shall be retrieved
2074 * @protocol: GUID of the protocol
2075 * @entry_buffer: buffer to receive the open protocol information
2076 * @entry_count: number of entries available in the buffer
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002077 *
2078 * This function implements the OpenProtocolInformation service.
Mario Six8fac2912018-07-10 08:40:17 +02002079 *
2080 * See the Unified Extensible Firmware Interface (UEFI) specification for
2081 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002082 *
Mario Six8fac2912018-07-10 08:40:17 +02002083 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002084 */
Heinrich Schuchardt91064592018-02-18 15:17:49 +01002085static efi_status_t EFIAPI efi_open_protocol_information(
2086 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01002087 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002088 efi_uintn_t *entry_count)
Alexander Grafc15d9212016-03-04 01:09:59 +01002089{
Heinrich Schuchardtf2ef22e2018-01-11 08:16:00 +01002090 unsigned long buffer_size;
2091 unsigned long count;
2092 struct efi_handler *handler;
2093 struct efi_open_protocol_info_item *item;
2094 efi_status_t r;
2095
Rob Clark238f88c2017-09-13 18:05:41 -04002096 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
Alexander Grafc15d9212016-03-04 01:09:59 +01002097 entry_count);
Heinrich Schuchardtf2ef22e2018-01-11 08:16:00 +01002098
2099 /* Check parameters */
2100 if (!entry_buffer) {
2101 r = EFI_INVALID_PARAMETER;
2102 goto out;
2103 }
2104 r = efi_search_protocol(handle, protocol, &handler);
2105 if (r != EFI_SUCCESS)
2106 goto out;
2107
2108 /* Count entries */
2109 count = 0;
2110 list_for_each_entry(item, &handler->open_infos, link) {
2111 if (item->info.open_count)
2112 ++count;
2113 }
2114 *entry_count = count;
2115 *entry_buffer = NULL;
2116 if (!count) {
2117 r = EFI_SUCCESS;
2118 goto out;
2119 }
2120
2121 /* Copy entries */
2122 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
Heinrich Schuchardtabb43872018-10-03 20:02:29 +02002123 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardtf2ef22e2018-01-11 08:16:00 +01002124 (void **)entry_buffer);
2125 if (r != EFI_SUCCESS)
2126 goto out;
2127 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2128 if (item->info.open_count)
2129 (*entry_buffer)[--count] = item->info;
2130 }
2131out:
2132 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002133}
2134
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002135/**
Mario Six8fac2912018-07-10 08:40:17 +02002136 * efi_protocols_per_handle() - get protocols installed on a handle
2137 * @handle: handle for which the information is retrieved
2138 * @protocol_buffer: buffer with protocol GUIDs
2139 * @protocol_buffer_count: number of entries in the buffer
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002140 *
2141 * This function implements the ProtocolsPerHandleService.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002142 *
Mario Six8fac2912018-07-10 08:40:17 +02002143 * See the Unified Extensible Firmware Interface (UEFI) specification for
2144 * details.
2145 *
2146 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002147 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01002148static efi_status_t EFIAPI efi_protocols_per_handle(
2149 efi_handle_t handle, efi_guid_t ***protocol_buffer,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002150 efi_uintn_t *protocol_buffer_count)
Alexander Grafc15d9212016-03-04 01:09:59 +01002151{
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002152 unsigned long buffer_size;
2153 struct efi_object *efiobj;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002154 struct list_head *protocol_handle;
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002155 efi_status_t r;
2156
Alexander Grafc15d9212016-03-04 01:09:59 +01002157 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2158 protocol_buffer_count);
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002159
2160 if (!handle || !protocol_buffer || !protocol_buffer_count)
2161 return EFI_EXIT(EFI_INVALID_PARAMETER);
2162
2163 *protocol_buffer = NULL;
Rob Clarkd51b8ca2017-07-20 07:59:39 -04002164 *protocol_buffer_count = 0;
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002165
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002166 efiobj = efi_search_obj(handle);
2167 if (!efiobj)
2168 return EFI_EXIT(EFI_INVALID_PARAMETER);
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002169
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002170 /* Count protocols */
2171 list_for_each(protocol_handle, &efiobj->protocols) {
2172 ++*protocol_buffer_count;
2173 }
2174
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02002175 /* Copy GUIDs */
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002176 if (*protocol_buffer_count) {
2177 size_t j = 0;
2178
2179 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
Heinrich Schuchardtabb43872018-10-03 20:02:29 +02002180 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +01002181 (void **)protocol_buffer);
2182 if (r != EFI_SUCCESS)
2183 return EFI_EXIT(r);
2184 list_for_each(protocol_handle, &efiobj->protocols) {
2185 struct efi_handler *protocol;
2186
2187 protocol = list_entry(protocol_handle,
2188 struct efi_handler, link);
2189 (*protocol_buffer)[j] = (void *)protocol->guid;
2190 ++j;
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002191 }
xypron.glpk@gmx.de8960c972017-07-13 23:24:32 +02002192 }
2193
2194 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002195}
2196
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002197/**
Mario Six8fac2912018-07-10 08:40:17 +02002198 * efi_locate_handle_buffer() - locate handles implementing a protocol
2199 * @search_type: selection criterion
2200 * @protocol: GUID of the protocol
2201 * @search_key: registration key
2202 * @no_handles: number of returned handles
2203 * @buffer: buffer with the returned handles
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002204 *
2205 * This function implements the LocateHandleBuffer service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002206 *
Mario Six8fac2912018-07-10 08:40:17 +02002207 * See the Unified Extensible Firmware Interface (UEFI) specification for
2208 * details.
2209 *
2210 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002211 */
Alexander Grafc15d9212016-03-04 01:09:59 +01002212static efi_status_t EFIAPI efi_locate_handle_buffer(
2213 enum efi_locate_search_type search_type,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002214 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002215 efi_uintn_t *no_handles, efi_handle_t **buffer)
Alexander Grafc15d9212016-03-04 01:09:59 +01002216{
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002217 efi_status_t r;
Heinrich Schuchardt798a4412017-11-06 21:17:48 +01002218 efi_uintn_t buffer_size = 0;
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002219
Rob Clark238f88c2017-09-13 18:05:41 -04002220 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
Alexander Grafc15d9212016-03-04 01:09:59 +01002221 no_handles, buffer);
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002222
2223 if (!no_handles || !buffer) {
2224 r = EFI_INVALID_PARAMETER;
2225 goto out;
2226 }
2227 *no_handles = 0;
2228 *buffer = NULL;
2229 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2230 *buffer);
2231 if (r != EFI_BUFFER_TOO_SMALL)
2232 goto out;
Heinrich Schuchardtabb43872018-10-03 20:02:29 +02002233 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002234 (void **)buffer);
2235 if (r != EFI_SUCCESS)
2236 goto out;
2237 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2238 *buffer);
2239 if (r == EFI_SUCCESS)
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01002240 *no_handles = buffer_size / sizeof(efi_handle_t);
xypron.glpk@gmx.de550a68a2017-07-11 22:06:22 +02002241out:
2242 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002243}
2244
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002245/**
Mario Six8fac2912018-07-10 08:40:17 +02002246 * efi_locate_protocol() - find an interface implementing a protocol
2247 * @protocol: GUID of the protocol
2248 * @registration: registration key passed to the notification function
2249 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002250 *
2251 * This function implements the LocateProtocol service.
Mario Six8fac2912018-07-10 08:40:17 +02002252 *
2253 * See the Unified Extensible Firmware Interface (UEFI) specification for
2254 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002255 *
Mario Six8fac2912018-07-10 08:40:17 +02002256 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002257 */
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002258static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01002259 void *registration,
2260 void **protocol_interface)
2261{
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002262 struct list_head *lhandle;
Heinrich Schuchardt57505e92017-10-26 19:25:57 +02002263 efi_status_t ret;
Alexander Grafc15d9212016-03-04 01:09:59 +01002264
Rob Clark238f88c2017-09-13 18:05:41 -04002265 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002266
2267 if (!protocol || !protocol_interface)
2268 return EFI_EXIT(EFI_INVALID_PARAMETER);
2269
2270 list_for_each(lhandle, &efi_obj_list) {
2271 struct efi_object *efiobj;
Heinrich Schuchardt57505e92017-10-26 19:25:57 +02002272 struct efi_handler *handler;
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002273
2274 efiobj = list_entry(lhandle, struct efi_object, link);
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002275
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +02002276 ret = efi_search_protocol(efiobj, protocol, &handler);
Heinrich Schuchardt57505e92017-10-26 19:25:57 +02002277 if (ret == EFI_SUCCESS) {
2278 *protocol_interface = handler->protocol_interface;
2279 return EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002280 }
2281 }
xypron.glpk@gmx.de4534ad62017-07-11 22:06:24 +02002282 *protocol_interface = NULL;
Alexander Grafc15d9212016-03-04 01:09:59 +01002283
2284 return EFI_EXIT(EFI_NOT_FOUND);
2285}
2286
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002287/**
Mario Six8fac2912018-07-10 08:40:17 +02002288 * efi_locate_device_path() - Get the device path and handle of an device
2289 * implementing a protocol
2290 * @protocol: GUID of the protocol
2291 * @device_path: device path
2292 * @device: handle of the device
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002293 *
2294 * This function implements the LocateDevicePath service.
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002295 *
Mario Six8fac2912018-07-10 08:40:17 +02002296 * See the Unified Extensible Firmware Interface (UEFI) specification for
2297 * details.
2298 *
2299 * Return: status code
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002300 */
2301static efi_status_t EFIAPI efi_locate_device_path(
2302 const efi_guid_t *protocol,
2303 struct efi_device_path **device_path,
2304 efi_handle_t *device)
2305{
2306 struct efi_device_path *dp;
2307 size_t i;
2308 struct efi_handler *handler;
2309 efi_handle_t *handles;
2310 size_t len, len_dp;
2311 size_t len_best = 0;
2312 efi_uintn_t no_handles;
2313 u8 *remainder;
2314 efi_status_t ret;
2315
2316 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2317
Heinrich Schuchardt6db1e5c2019-05-10 19:21:41 +02002318 if (!protocol || !device_path || !*device_path) {
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002319 ret = EFI_INVALID_PARAMETER;
2320 goto out;
2321 }
2322
2323 /* Find end of device path */
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +02002324 len = efi_dp_instance_size(*device_path);
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002325
2326 /* Get all handles implementing the protocol */
2327 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2328 &no_handles, &handles));
2329 if (ret != EFI_SUCCESS)
2330 goto out;
2331
2332 for (i = 0; i < no_handles; ++i) {
2333 /* Find the device path protocol */
2334 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2335 &handler);
2336 if (ret != EFI_SUCCESS)
2337 continue;
2338 dp = (struct efi_device_path *)handler->protocol_interface;
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +02002339 len_dp = efi_dp_instance_size(dp);
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002340 /*
2341 * This handle can only be a better fit
2342 * if its device path length is longer than the best fit and
2343 * if its device path length is shorter of equal the searched
2344 * device path.
2345 */
2346 if (len_dp <= len_best || len_dp > len)
2347 continue;
2348 /* Check if dp is a subpath of device_path */
2349 if (memcmp(*device_path, dp, len_dp))
2350 continue;
Heinrich Schuchardt6db1e5c2019-05-10 19:21:41 +02002351 if (!device) {
2352 ret = EFI_INVALID_PARAMETER;
2353 goto out;
2354 }
Heinrich Schuchardt06ec6892017-11-26 14:05:10 +01002355 *device = handles[i];
2356 len_best = len_dp;
2357 }
2358 if (len_best) {
2359 remainder = (u8 *)*device_path + len_best;
2360 *device_path = (struct efi_device_path *)remainder;
2361 ret = EFI_SUCCESS;
2362 } else {
2363 ret = EFI_NOT_FOUND;
2364 }
2365out:
2366 return EFI_EXIT(ret);
2367}
2368
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002369/**
Mario Six8fac2912018-07-10 08:40:17 +02002370 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2371 * interfaces
2372 * @handle: handle on which the protocol interfaces shall be installed
2373 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2374 * interfaces
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002375 *
2376 * This function implements the MultipleProtocolInterfaces service.
Mario Six8fac2912018-07-10 08:40:17 +02002377 *
2378 * See the Unified Extensible Firmware Interface (UEFI) specification for
2379 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002380 *
Mario Six8fac2912018-07-10 08:40:17 +02002381 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002382 */
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +02002383efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002384 (efi_handle_t *handle, ...)
Alexander Grafc15d9212016-03-04 01:09:59 +01002385{
2386 EFI_ENTRY("%p", handle);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002387
Alexander Graf404a7c82018-06-18 17:23:05 +02002388 efi_va_list argptr;
Heinrich Schuchardte547c662017-10-05 16:35:53 +02002389 const efi_guid_t *protocol;
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002390 void *protocol_interface;
Heinrich Schuchardt61ba10d2019-05-16 21:54:04 +02002391 efi_handle_t old_handle;
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002392 efi_status_t r = EFI_SUCCESS;
2393 int i = 0;
2394
2395 if (!handle)
2396 return EFI_EXIT(EFI_INVALID_PARAMETER);
2397
Alexander Graf404a7c82018-06-18 17:23:05 +02002398 efi_va_start(argptr, handle);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002399 for (;;) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002400 protocol = efi_va_arg(argptr, efi_guid_t*);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002401 if (!protocol)
2402 break;
Alexander Graf404a7c82018-06-18 17:23:05 +02002403 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt61ba10d2019-05-16 21:54:04 +02002404 /* Check that a device path has not been installed before */
2405 if (!guidcmp(protocol, &efi_guid_device_path)) {
2406 struct efi_device_path *dp = protocol_interface;
2407
2408 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2409 &old_handle));
Heinrich Schuchardt29344972019-05-20 19:55:18 +00002410 if (r == EFI_SUCCESS &&
2411 dp->type == DEVICE_PATH_TYPE_END) {
2412 EFI_PRINT("Path %pD already installed\n",
2413 protocol_interface);
Heinrich Schuchardt61ba10d2019-05-16 21:54:04 +02002414 r = EFI_ALREADY_STARTED;
2415 break;
2416 }
2417 }
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01002418 r = EFI_CALL(efi_install_protocol_interface(
2419 handle, protocol,
2420 EFI_NATIVE_INTERFACE,
2421 protocol_interface));
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002422 if (r != EFI_SUCCESS)
2423 break;
2424 i++;
2425 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002426 efi_va_end(argptr);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002427 if (r == EFI_SUCCESS)
2428 return EFI_EXIT(r);
2429
Heinrich Schuchardtec47f3e2017-10-26 19:25:42 +02002430 /* If an error occurred undo all changes. */
Alexander Graf404a7c82018-06-18 17:23:05 +02002431 efi_va_start(argptr, handle);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002432 for (; i; --i) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002433 protocol = efi_va_arg(argptr, efi_guid_t*);
2434 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002435 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
Heinrich Schuchardt7cdc17f2017-11-06 21:17:45 +01002436 protocol_interface));
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002437 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002438 efi_va_end(argptr);
xypron.glpk@gmx.de83eebc72017-07-11 22:06:20 +02002439
2440 return EFI_EXIT(r);
Alexander Grafc15d9212016-03-04 01:09:59 +01002441}
2442
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002443/**
Mario Six8fac2912018-07-10 08:40:17 +02002444 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2445 * interfaces
2446 * @handle: handle from which the protocol interfaces shall be removed
2447 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2448 * interfaces
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002449 *
2450 * This function implements the UninstallMultipleProtocolInterfaces service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002451 *
Mario Six8fac2912018-07-10 08:40:17 +02002452 * See the Unified Extensible Firmware Interface (UEFI) specification for
2453 * details.
2454 *
2455 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002456 */
Alexander Grafc15d9212016-03-04 01:09:59 +01002457static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002458 efi_handle_t handle, ...)
Alexander Grafc15d9212016-03-04 01:09:59 +01002459{
2460 EFI_ENTRY("%p", handle);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002461
Alexander Graf404a7c82018-06-18 17:23:05 +02002462 efi_va_list argptr;
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002463 const efi_guid_t *protocol;
2464 void *protocol_interface;
2465 efi_status_t r = EFI_SUCCESS;
2466 size_t i = 0;
2467
2468 if (!handle)
2469 return EFI_EXIT(EFI_INVALID_PARAMETER);
2470
Alexander Graf404a7c82018-06-18 17:23:05 +02002471 efi_va_start(argptr, handle);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002472 for (;;) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002473 protocol = efi_va_arg(argptr, efi_guid_t*);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002474 if (!protocol)
2475 break;
Alexander Graf404a7c82018-06-18 17:23:05 +02002476 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02002477 r = efi_uninstall_protocol(handle, protocol,
2478 protocol_interface);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002479 if (r != EFI_SUCCESS)
2480 break;
2481 i++;
2482 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002483 efi_va_end(argptr);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02002484 if (r == EFI_SUCCESS) {
2485 /* If the last protocol has been removed, delete the handle. */
2486 if (list_empty(&handle->protocols)) {
2487 list_del(&handle->link);
2488 free(handle);
2489 }
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002490 return EFI_EXIT(r);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02002491 }
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002492
2493 /* If an error occurred undo all changes. */
Alexander Graf404a7c82018-06-18 17:23:05 +02002494 efi_va_start(argptr, handle);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002495 for (; i; --i) {
Alexander Graf404a7c82018-06-18 17:23:05 +02002496 protocol = efi_va_arg(argptr, efi_guid_t*);
2497 protocol_interface = efi_va_arg(argptr, void*);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002498 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2499 EFI_NATIVE_INTERFACE,
2500 protocol_interface));
2501 }
Alexander Graf404a7c82018-06-18 17:23:05 +02002502 efi_va_end(argptr);
Heinrich Schuchardta616dcf2017-10-26 19:25:44 +02002503
Heinrich Schuchardt1c76eda2018-09-24 19:57:27 +02002504 /* In case of an error always return EFI_INVALID_PARAMETER */
2505 return EFI_EXIT(EFI_INVALID_PARAMETER);
Alexander Grafc15d9212016-03-04 01:09:59 +01002506}
2507
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002508/**
Mario Six8fac2912018-07-10 08:40:17 +02002509 * efi_calculate_crc32() - calculate cyclic redundancy code
2510 * @data: buffer with data
2511 * @data_size: size of buffer in bytes
2512 * @crc32_p: cyclic redundancy code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002513 *
2514 * This function implements the CalculateCrc32 service.
Mario Six8fac2912018-07-10 08:40:17 +02002515 *
2516 * See the Unified Extensible Firmware Interface (UEFI) specification for
2517 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002518 *
Mario Six8fac2912018-07-10 08:40:17 +02002519 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002520 */
Heinrich Schuchardtf2725582018-07-07 15:36:04 +02002521static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2522 efi_uintn_t data_size,
2523 u32 *crc32_p)
Alexander Grafc15d9212016-03-04 01:09:59 +01002524{
Heinrich Schuchardt3f0282c2019-05-16 23:31:29 +02002525 efi_status_t ret = EFI_SUCCESS;
2526
Heinrich Schuchardtf2725582018-07-07 15:36:04 +02002527 EFI_ENTRY("%p, %zu", data, data_size);
Heinrich Schuchardt3f0282c2019-05-16 23:31:29 +02002528 if (!data || !data_size || !crc32_p) {
2529 ret = EFI_INVALID_PARAMETER;
2530 goto out;
2531 }
Alexander Grafc15d9212016-03-04 01:09:59 +01002532 *crc32_p = crc32(0, data, data_size);
Heinrich Schuchardt3f0282c2019-05-16 23:31:29 +02002533out:
2534 return EFI_EXIT(ret);
Alexander Grafc15d9212016-03-04 01:09:59 +01002535}
2536
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002537/**
Mario Six8fac2912018-07-10 08:40:17 +02002538 * efi_copy_mem() - copy memory
2539 * @destination: destination of the copy operation
2540 * @source: source of the copy operation
2541 * @length: number of bytes to copy
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002542 *
2543 * This function implements the CopyMem service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002544 *
Mario Six8fac2912018-07-10 08:40:17 +02002545 * See the Unified Extensible Firmware Interface (UEFI) specification for
2546 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002547 */
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002548static void EFIAPI efi_copy_mem(void *destination, const void *source,
2549 size_t length)
Alexander Grafc15d9212016-03-04 01:09:59 +01002550{
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002551 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
Heinrich Schuchardtefba6ba2019-01-09 21:41:13 +01002552 memmove(destination, source, length);
Heinrich Schuchardta5270e02017-10-05 16:35:51 +02002553 EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002554}
2555
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002556/**
Mario Six8fac2912018-07-10 08:40:17 +02002557 * efi_set_mem() - Fill memory with a byte value.
2558 * @buffer: buffer to fill
2559 * @size: size of buffer in bytes
2560 * @value: byte to copy to the buffer
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002561 *
2562 * This function implements the SetMem service.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002563 *
Mario Six8fac2912018-07-10 08:40:17 +02002564 * See the Unified Extensible Firmware Interface (UEFI) specification for
2565 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002566 */
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002567static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
Alexander Grafc15d9212016-03-04 01:09:59 +01002568{
Heinrich Schuchardtd0a349e2017-10-05 16:35:52 +02002569 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
Alexander Grafc15d9212016-03-04 01:09:59 +01002570 memset(buffer, value, size);
Heinrich Schuchardta5270e02017-10-05 16:35:51 +02002571 EFI_EXIT(EFI_SUCCESS);
Alexander Grafc15d9212016-03-04 01:09:59 +01002572}
2573
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002574/**
Mario Six8fac2912018-07-10 08:40:17 +02002575 * efi_protocol_open() - open protocol interface on a handle
2576 * @handler: handler of a protocol
2577 * @protocol_interface: interface implementing the protocol
2578 * @agent_handle: handle of the driver
2579 * @controller_handle: handle of the controller
2580 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002581 *
Mario Six8fac2912018-07-10 08:40:17 +02002582 * Return: status code
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002583 */
2584static efi_status_t efi_protocol_open(
2585 struct efi_handler *handler,
2586 void **protocol_interface, void *agent_handle,
2587 void *controller_handle, uint32_t attributes)
2588{
2589 struct efi_open_protocol_info_item *item;
2590 struct efi_open_protocol_info_entry *match = NULL;
2591 bool opened_by_driver = false;
2592 bool opened_exclusive = false;
2593
2594 /* If there is no agent, only return the interface */
2595 if (!agent_handle)
2596 goto out;
2597
2598 /* For TEST_PROTOCOL ignore interface attribute */
2599 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2600 *protocol_interface = NULL;
2601
2602 /*
2603 * Check if the protocol is already opened by a driver with the same
2604 * attributes or opened exclusively
2605 */
2606 list_for_each_entry(item, &handler->open_infos, link) {
2607 if (item->info.agent_handle == agent_handle) {
2608 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2609 (item->info.attributes == attributes))
2610 return EFI_ALREADY_STARTED;
2611 }
2612 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2613 opened_exclusive = true;
2614 }
2615
2616 /* Only one controller can open the protocol exclusively */
2617 if (opened_exclusive && attributes &
2618 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2619 return EFI_ACCESS_DENIED;
2620
2621 /* Prepare exclusive opening */
2622 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2623 /* Try to disconnect controllers */
2624 list_for_each_entry(item, &handler->open_infos, link) {
2625 if (item->info.attributes ==
2626 EFI_OPEN_PROTOCOL_BY_DRIVER)
2627 EFI_CALL(efi_disconnect_controller(
2628 item->info.controller_handle,
2629 item->info.agent_handle,
2630 NULL));
2631 }
2632 opened_by_driver = false;
2633 /* Check if all controllers are disconnected */
2634 list_for_each_entry(item, &handler->open_infos, link) {
2635 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2636 opened_by_driver = true;
2637 }
Heinrich Schuchardt8d0b45d2018-09-30 13:40:43 +02002638 /* Only one controller can be connected */
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002639 if (opened_by_driver)
2640 return EFI_ACCESS_DENIED;
2641 }
2642
2643 /* Find existing entry */
2644 list_for_each_entry(item, &handler->open_infos, link) {
2645 if (item->info.agent_handle == agent_handle &&
2646 item->info.controller_handle == controller_handle)
2647 match = &item->info;
2648 }
2649 /* None found, create one */
2650 if (!match) {
2651 match = efi_create_open_info(handler);
2652 if (!match)
2653 return EFI_OUT_OF_RESOURCES;
2654 }
2655
2656 match->agent_handle = agent_handle;
2657 match->controller_handle = controller_handle;
2658 match->attributes = attributes;
2659 match->open_count++;
2660
2661out:
2662 /* For TEST_PROTOCOL ignore interface attribute. */
2663 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2664 *protocol_interface = handler->protocol_interface;
2665
2666 return EFI_SUCCESS;
2667}
2668
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002669/**
Mario Six8fac2912018-07-10 08:40:17 +02002670 * efi_open_protocol() - open protocol interface on a handle
2671 * @handle: handle on which the protocol shall be opened
2672 * @protocol: GUID of the protocol
2673 * @protocol_interface: interface implementing the protocol
2674 * @agent_handle: handle of the driver
2675 * @controller_handle: handle of the controller
2676 * @attributes: attributes indicating how to open the protocol
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002677 *
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002678 * This function implements the OpenProtocol interface.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002679 *
Mario Six8fac2912018-07-10 08:40:17 +02002680 * See the Unified Extensible Firmware Interface (UEFI) specification for
2681 * details.
2682 *
2683 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02002684 */
Heinrich Schuchardt4f94ec52018-09-26 05:27:54 +02002685static efi_status_t EFIAPI efi_open_protocol
2686 (efi_handle_t handle, const efi_guid_t *protocol,
2687 void **protocol_interface, efi_handle_t agent_handle,
2688 efi_handle_t controller_handle, uint32_t attributes)
Alexander Grafc15d9212016-03-04 01:09:59 +01002689{
Heinrich Schuchardte5e78a32017-11-26 14:05:15 +01002690 struct efi_handler *handler;
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002691 efi_status_t r = EFI_INVALID_PARAMETER;
Alexander Grafc15d9212016-03-04 01:09:59 +01002692
Rob Clark238f88c2017-09-13 18:05:41 -04002693 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01002694 protocol_interface, agent_handle, controller_handle,
2695 attributes);
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +02002696
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002697 if (!handle || !protocol ||
2698 (!protocol_interface && attributes !=
2699 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +02002700 goto out;
2701 }
2702
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002703 switch (attributes) {
2704 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2705 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2706 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2707 break;
2708 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2709 if (controller_handle == handle)
2710 goto out;
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002711 /* fall-through */
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002712 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2713 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002714 /* Check that the controller handle is valid */
2715 if (!efi_search_obj(controller_handle))
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002716 goto out;
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002717 /* fall-through */
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002718 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002719 /* Check that the agent handle is valid */
2720 if (!efi_search_obj(agent_handle))
xypron.glpk@gmx.def097c842017-07-11 22:06:15 +02002721 goto out;
2722 break;
2723 default:
2724 goto out;
2725 }
2726
Heinrich Schuchardte5e78a32017-11-26 14:05:15 +01002727 r = efi_search_protocol(handle, protocol, &handler);
Heinrich Schuchardtb673e4b2019-05-05 11:24:53 +02002728 switch (r) {
2729 case EFI_SUCCESS:
2730 break;
2731 case EFI_NOT_FOUND:
2732 r = EFI_UNSUPPORTED;
2733 goto out;
2734 default:
Heinrich Schuchardte5e78a32017-11-26 14:05:15 +01002735 goto out;
Heinrich Schuchardtb673e4b2019-05-05 11:24:53 +02002736 }
Alexander Grafc15d9212016-03-04 01:09:59 +01002737
Heinrich Schuchardt8cb38c02018-01-11 08:15:58 +01002738 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2739 controller_handle, attributes);
Alexander Grafc15d9212016-03-04 01:09:59 +01002740out:
2741 return EFI_EXIT(r);
2742}
2743
Heinrich Schuchardt59999172018-05-11 18:15:41 +02002744/**
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002745 * efi_start_image() - call the entry point of an image
2746 * @image_handle: handle of the image
2747 * @exit_data_size: size of the buffer
2748 * @exit_data: buffer to receive the exit data of the called image
2749 *
2750 * This function implements the StartImage service.
2751 *
2752 * See the Unified Extensible Firmware Interface (UEFI) specification for
2753 * details.
2754 *
2755 * Return: status code
2756 */
2757efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2758 efi_uintn_t *exit_data_size,
2759 u16 **exit_data)
2760{
2761 struct efi_loaded_image_obj *image_obj =
2762 (struct efi_loaded_image_obj *)image_handle;
2763 efi_status_t ret;
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002764 void *info;
2765 efi_handle_t parent_image = current_image;
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002766
2767 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2768
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002769 /* Check parameters */
2770 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2771 &info, NULL, NULL,
2772 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2773 if (ret != EFI_SUCCESS)
2774 return EFI_EXIT(EFI_INVALID_PARAMETER);
2775
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002776 efi_is_direct_boot = false;
2777
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02002778 image_obj->exit_data_size = exit_data_size;
2779 image_obj->exit_data = exit_data;
2780
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002781 /* call the image! */
2782 if (setjmp(&image_obj->exit_jmp)) {
2783 /*
2784 * We called the entry point of the child image with EFI_CALL
2785 * in the lines below. The child image called the Exit() boot
2786 * service efi_exit() which executed the long jump that brought
2787 * us to the current line. This implies that the second half
2788 * of the EFI_CALL macro has not been executed.
2789 */
2790#ifdef CONFIG_ARM
2791 /*
2792 * efi_exit() called efi_restore_gd(). We have to undo this
2793 * otherwise __efi_entry_check() will put the wrong value into
2794 * app_gd.
2795 */
2796 gd = app_gd;
2797#endif
2798 /*
2799 * To get ready to call EFI_EXIT below we have to execute the
2800 * missed out steps of EFI_CALL.
2801 */
2802 assert(__efi_entry_check());
Heinrich Schuchardt952e2062019-05-05 11:56:23 +02002803 EFI_PRINT("%lu returned by started image\n",
2804 (unsigned long)((uintptr_t)image_obj->exit_status &
2805 ~EFI_ERROR_MASK));
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002806 current_image = parent_image;
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002807 return EFI_EXIT(image_obj->exit_status);
2808 }
2809
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002810 current_image = image_handle;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +02002811 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
AKASHI Takahiro14ff23b2019-04-19 12:22:35 +09002812 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002813 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2814
2815 /*
2816 * Usually UEFI applications call Exit() instead of returning.
2817 * But because the world doesn't consist of ponies and unicorns,
2818 * we're happy to emulate that behavior on behalf of a payload
2819 * that forgot.
2820 */
2821 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2822}
2823
2824/**
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002825 * efi_delete_image() - delete loaded image from memory)
2826 *
2827 * @image_obj: handle of the loaded image
2828 * @loaded_image_protocol: loaded image protocol
2829 */
2830static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2831 struct efi_loaded_image *loaded_image_protocol)
2832{
2833 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2834 efi_size_in_pages(loaded_image_protocol->image_size));
2835 efi_delete_handle(&image_obj->header);
2836}
2837
2838/**
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002839 * efi_unload_image() - unload an EFI image
2840 * @image_handle: handle of the image to be unloaded
2841 *
2842 * This function implements the UnloadImage service.
2843 *
2844 * See the Unified Extensible Firmware Interface (UEFI) specification for
2845 * details.
2846 *
2847 * Return: status code
2848 */
2849efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2850{
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002851 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002852 struct efi_object *efiobj;
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002853 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002854
2855 EFI_ENTRY("%p", image_handle);
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002856
Heinrich Schuchardt4ed66e52019-05-01 18:25:45 +02002857 efiobj = efi_search_obj(image_handle);
2858 if (!efiobj) {
2859 ret = EFI_INVALID_PARAMETER;
2860 goto out;
2861 }
2862 /* Find the loaded image protocol */
2863 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2864 (void **)&loaded_image_protocol,
2865 NULL, NULL,
2866 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2867 if (ret != EFI_SUCCESS) {
2868 ret = EFI_INVALID_PARAMETER;
2869 goto out;
2870 }
2871 switch (efiobj->type) {
2872 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2873 /* Call the unload function */
2874 if (!loaded_image_protocol->unload) {
2875 ret = EFI_UNSUPPORTED;
2876 goto out;
2877 }
2878 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2879 if (ret != EFI_SUCCESS)
2880 goto out;
2881 break;
2882 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2883 break;
2884 default:
2885 ret = EFI_INVALID_PARAMETER;
2886 goto out;
2887 }
2888 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2889 loaded_image_protocol);
2890out:
2891 return EFI_EXIT(ret);
Heinrich Schuchardt6b3581a2019-05-01 19:04:32 +02002892}
2893
2894/**
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02002895 * efi_update_exit_data() - fill exit data parameters of StartImage()
2896 *
2897 * @image_obj image handle
2898 * @exit_data_size size of the exit data buffer
2899 * @exit_data buffer with data returned by UEFI payload
2900 * Return: status code
2901 */
2902static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2903 efi_uintn_t exit_data_size,
2904 u16 *exit_data)
2905{
2906 efi_status_t ret;
2907
2908 /*
2909 * If exit_data is not provided to StartImage(), exit_data_size must be
2910 * ignored.
2911 */
2912 if (!image_obj->exit_data)
2913 return EFI_SUCCESS;
2914 if (image_obj->exit_data_size)
2915 *image_obj->exit_data_size = exit_data_size;
2916 if (exit_data_size && exit_data) {
2917 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2918 exit_data_size,
2919 (void **)image_obj->exit_data);
2920 if (ret != EFI_SUCCESS)
2921 return ret;
2922 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2923 } else {
2924 image_obj->exit_data = NULL;
2925 }
2926 return EFI_SUCCESS;
2927}
2928
2929/**
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002930 * efi_exit() - leave an EFI application or driver
2931 * @image_handle: handle of the application or driver that is exiting
2932 * @exit_status: status code
2933 * @exit_data_size: size of the buffer in bytes
2934 * @exit_data: buffer with data describing an error
2935 *
2936 * This function implements the Exit service.
2937 *
2938 * See the Unified Extensible Firmware Interface (UEFI) specification for
2939 * details.
2940 *
2941 * Return: status code
2942 */
2943static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2944 efi_status_t exit_status,
2945 efi_uintn_t exit_data_size,
2946 u16 *exit_data)
2947{
2948 /*
2949 * TODO: We should call the unload procedure of the loaded
2950 * image protocol.
2951 */
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002952 efi_status_t ret;
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002953 struct efi_loaded_image *loaded_image_protocol;
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01002954 struct efi_loaded_image_obj *image_obj =
2955 (struct efi_loaded_image_obj *)image_handle;
2956
2957 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2958 exit_data_size, exit_data);
2959
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002960 /* Check parameters */
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002961 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002962 (void **)&loaded_image_protocol,
2963 NULL, NULL,
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002964 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002965 if (ret != EFI_SUCCESS) {
2966 ret = EFI_INVALID_PARAMETER;
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002967 goto out;
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002968 }
2969
2970 /* Unloading of unstarted images */
2971 switch (image_obj->header.type) {
2972 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2973 break;
2974 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2975 efi_delete_image(image_obj, loaded_image_protocol);
2976 ret = EFI_SUCCESS;
2977 goto out;
2978 default:
2979 /* Handle does not refer to loaded image */
2980 ret = EFI_INVALID_PARAMETER;
2981 goto out;
2982 }
2983 /* A started image can only be unloaded it is the last one started. */
2984 if (image_handle != current_image) {
2985 ret = EFI_INVALID_PARAMETER;
2986 goto out;
2987 }
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01002988
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02002989 /* Exit data is only foreseen in case of failure. */
2990 if (exit_status != EFI_SUCCESS) {
2991 ret = efi_update_exit_data(image_obj, exit_data_size,
2992 exit_data);
2993 /* Exiting has priority. Don't return error to caller. */
2994 if (ret != EFI_SUCCESS)
2995 EFI_PRINT("%s: out of memory\n", __func__);
2996 }
Heinrich Schuchardt37587522019-05-01 20:07:04 +02002997 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2998 exit_status != EFI_SUCCESS)
2999 efi_delete_image(image_obj, loaded_image_protocol);
Heinrich Schuchardt3d445122019-04-30 17:57:30 +02003000
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01003001 /* Make sure entry/exit counts for EFI world cross-overs match */
3002 EFI_EXIT(exit_status);
3003
3004 /*
3005 * But longjmp out with the U-Boot gd, not the application's, as
3006 * the other end is a setjmp call inside EFI context.
3007 */
3008 efi_restore_gd();
3009
3010 image_obj->exit_status = exit_status;
3011 longjmp(&image_obj->exit_jmp, 1);
3012
3013 panic("EFI application exited");
Heinrich Schuchardt8efe0792019-03-26 19:03:17 +01003014out:
Heinrich Schuchardt37587522019-05-01 20:07:04 +02003015 return EFI_EXIT(ret);
Heinrich Schuchardt2650a4d2019-03-26 19:02:05 +01003016}
3017
3018/**
Mario Six8fac2912018-07-10 08:40:17 +02003019 * efi_handle_protocol() - get interface of a protocol on a handle
3020 * @handle: handle on which the protocol shall be opened
3021 * @protocol: GUID of the protocol
3022 * @protocol_interface: interface implementing the protocol
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02003023 *
3024 * This function implements the HandleProtocol service.
Mario Six8fac2912018-07-10 08:40:17 +02003025 *
3026 * See the Unified Extensible Firmware Interface (UEFI) specification for
3027 * details.
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02003028 *
Mario Six8fac2912018-07-10 08:40:17 +02003029 * Return: status code
Heinrich Schuchardta40db6e2017-09-21 18:30:11 +02003030 */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +01003031static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
Heinrich Schuchardte547c662017-10-05 16:35:53 +02003032 const efi_guid_t *protocol,
Alexander Grafc15d9212016-03-04 01:09:59 +01003033 void **protocol_interface)
3034{
xypron.glpk@gmx.de1bf5d872017-06-29 21:16:19 +02003035 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
3036 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
Alexander Grafc15d9212016-03-04 01:09:59 +01003037}
3038
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003039/**
Mario Six8fac2912018-07-10 08:40:17 +02003040 * efi_bind_controller() - bind a single driver to a controller
3041 * @controller_handle: controller handle
3042 * @driver_image_handle: driver handle
3043 * @remain_device_path: remaining path
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003044 *
Mario Six8fac2912018-07-10 08:40:17 +02003045 * Return: status code
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003046 */
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003047static efi_status_t efi_bind_controller(
3048 efi_handle_t controller_handle,
3049 efi_handle_t driver_image_handle,
3050 struct efi_device_path *remain_device_path)
3051{
3052 struct efi_driver_binding_protocol *binding_protocol;
3053 efi_status_t r;
3054
3055 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3056 &efi_guid_driver_binding_protocol,
3057 (void **)&binding_protocol,
3058 driver_image_handle, NULL,
3059 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3060 if (r != EFI_SUCCESS)
3061 return r;
3062 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3063 controller_handle,
3064 remain_device_path));
3065 if (r == EFI_SUCCESS)
3066 r = EFI_CALL(binding_protocol->start(binding_protocol,
3067 controller_handle,
3068 remain_device_path));
3069 EFI_CALL(efi_close_protocol(driver_image_handle,
3070 &efi_guid_driver_binding_protocol,
3071 driver_image_handle, NULL));
3072 return r;
3073}
3074
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003075/**
Mario Six8fac2912018-07-10 08:40:17 +02003076 * efi_connect_single_controller() - connect a single driver to a controller
3077 * @controller_handle: controller
3078 * @driver_image_handle: driver
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02003079 * @remain_device_path: remaining path
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003080 *
Mario Six8fac2912018-07-10 08:40:17 +02003081 * Return: status code
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003082 */
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003083static efi_status_t efi_connect_single_controller(
3084 efi_handle_t controller_handle,
3085 efi_handle_t *driver_image_handle,
3086 struct efi_device_path *remain_device_path)
3087{
3088 efi_handle_t *buffer;
3089 size_t count;
3090 size_t i;
3091 efi_status_t r;
3092 size_t connected = 0;
3093
3094 /* Get buffer with all handles with driver binding protocol */
3095 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3096 &efi_guid_driver_binding_protocol,
3097 NULL, &count, &buffer));
3098 if (r != EFI_SUCCESS)
3099 return r;
3100
3101 /* Context Override */
3102 if (driver_image_handle) {
3103 for (; *driver_image_handle; ++driver_image_handle) {
3104 for (i = 0; i < count; ++i) {
3105 if (buffer[i] == *driver_image_handle) {
3106 buffer[i] = NULL;
3107 r = efi_bind_controller(
3108 controller_handle,
3109 *driver_image_handle,
3110 remain_device_path);
3111 /*
3112 * For drivers that do not support the
3113 * controller or are already connected
3114 * we receive an error code here.
3115 */
3116 if (r == EFI_SUCCESS)
3117 ++connected;
3118 }
3119 }
3120 }
3121 }
3122
3123 /*
3124 * TODO: Some overrides are not yet implemented:
3125 * - Platform Driver Override
3126 * - Driver Family Override Search
3127 * - Bus Specific Driver Override
3128 */
3129
3130 /* Driver Binding Search */
3131 for (i = 0; i < count; ++i) {
3132 if (buffer[i]) {
3133 r = efi_bind_controller(controller_handle,
3134 buffer[i],
3135 remain_device_path);
3136 if (r == EFI_SUCCESS)
3137 ++connected;
3138 }
3139 }
3140
3141 efi_free_pool(buffer);
3142 if (!connected)
3143 return EFI_NOT_FOUND;
3144 return EFI_SUCCESS;
3145}
3146
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003147/**
Mario Six8fac2912018-07-10 08:40:17 +02003148 * efi_connect_controller() - connect a controller to a driver
3149 * @controller_handle: handle of the controller
3150 * @driver_image_handle: handle of the driver
3151 * @remain_device_path: device path of a child controller
3152 * @recursive: true to connect all child controllers
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003153 *
3154 * This function implements the ConnectController service.
Mario Six8fac2912018-07-10 08:40:17 +02003155 *
3156 * See the Unified Extensible Firmware Interface (UEFI) specification for
3157 * details.
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003158 *
3159 * First all driver binding protocol handles are tried for binding drivers.
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02003160 * Afterwards all handles that have opened a protocol of the controller
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003161 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3162 *
Mario Six8fac2912018-07-10 08:40:17 +02003163 * Return: status code
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003164 */
3165static efi_status_t EFIAPI efi_connect_controller(
3166 efi_handle_t controller_handle,
3167 efi_handle_t *driver_image_handle,
3168 struct efi_device_path *remain_device_path,
3169 bool recursive)
3170{
3171 efi_status_t r;
3172 efi_status_t ret = EFI_NOT_FOUND;
3173 struct efi_object *efiobj;
3174
Heinrich Schuchardt7c89fb02018-12-09 16:39:20 +01003175 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
Heinrich Schuchardt760255f2018-01-11 08:16:02 +01003176 remain_device_path, recursive);
3177
3178 efiobj = efi_search_obj(controller_handle);
3179 if (!efiobj) {
3180 ret = EFI_INVALID_PARAMETER;
3181 goto out;
3182 }
3183
3184 r = efi_connect_single_controller(controller_handle,
3185 driver_image_handle,
3186 remain_device_path);
3187 if (r == EFI_SUCCESS)
3188 ret = EFI_SUCCESS;
3189 if (recursive) {
3190 struct efi_handler *handler;
3191 struct efi_open_protocol_info_item *item;
3192
3193 list_for_each_entry(handler, &efiobj->protocols, link) {
3194 list_for_each_entry(item, &handler->open_infos, link) {
3195 if (item->info.attributes &
3196 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3197 r = EFI_CALL(efi_connect_controller(
3198 item->info.controller_handle,
3199 driver_image_handle,
3200 remain_device_path,
3201 recursive));
3202 if (r == EFI_SUCCESS)
3203 ret = EFI_SUCCESS;
3204 }
3205 }
3206 }
3207 }
3208 /* Check for child controller specified by end node */
3209 if (ret != EFI_SUCCESS && remain_device_path &&
3210 remain_device_path->type == DEVICE_PATH_TYPE_END)
3211 ret = EFI_SUCCESS;
3212out:
3213 return EFI_EXIT(ret);
3214}
3215
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003216/**
Mario Six8fac2912018-07-10 08:40:17 +02003217 * efi_reinstall_protocol_interface() - reinstall protocol interface
3218 * @handle: handle on which the protocol shall be reinstalled
3219 * @protocol: GUID of the protocol to be installed
3220 * @old_interface: interface to be removed
3221 * @new_interface: interface to be installed
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003222 *
3223 * This function implements the ReinstallProtocolInterface service.
Mario Six8fac2912018-07-10 08:40:17 +02003224 *
3225 * See the Unified Extensible Firmware Interface (UEFI) specification for
3226 * details.
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003227 *
3228 * The old interface is uninstalled. The new interface is installed.
3229 * Drivers are connected.
3230 *
Mario Six8fac2912018-07-10 08:40:17 +02003231 * Return: status code
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003232 */
3233static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3234 efi_handle_t handle, const efi_guid_t *protocol,
3235 void *old_interface, void *new_interface)
3236{
3237 efi_status_t ret;
3238
3239 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3240 new_interface);
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02003241
3242 /* Uninstall protocol but do not delete handle */
3243 ret = efi_uninstall_protocol(handle, protocol, old_interface);
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003244 if (ret != EFI_SUCCESS)
3245 goto out;
Heinrich Schuchardt1b451342018-09-28 22:14:17 +02003246
3247 /* Install the new protocol */
3248 ret = efi_add_protocol(handle, protocol, new_interface);
3249 /*
3250 * The UEFI spec does not specify what should happen to the handle
3251 * if in case of an error no protocol interface remains on the handle.
3252 * So let's do nothing here.
3253 */
Heinrich Schuchardt90761b82018-05-11 12:09:22 +02003254 if (ret != EFI_SUCCESS)
3255 goto out;
3256 /*
3257 * The returned status code has to be ignored.
3258 * Do not create an error if no suitable driver for the handle exists.
3259 */
3260 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3261out:
3262 return EFI_EXIT(ret);
3263}
3264
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003265/**
Mario Six8fac2912018-07-10 08:40:17 +02003266 * efi_get_child_controllers() - get all child controllers associated to a driver
3267 * @efiobj: handle of the controller
3268 * @driver_handle: handle of the driver
3269 * @number_of_children: number of child controllers
3270 * @child_handle_buffer: handles of the the child controllers
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003271 *
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003272 * The allocated buffer has to be freed with free().
3273 *
Mario Six8fac2912018-07-10 08:40:17 +02003274 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003275 */
3276static efi_status_t efi_get_child_controllers(
3277 struct efi_object *efiobj,
3278 efi_handle_t driver_handle,
3279 efi_uintn_t *number_of_children,
3280 efi_handle_t **child_handle_buffer)
3281{
3282 struct efi_handler *handler;
3283 struct efi_open_protocol_info_item *item;
3284 efi_uintn_t count = 0, i;
3285 bool duplicate;
3286
3287 /* Count all child controller associations */
3288 list_for_each_entry(handler, &efiobj->protocols, link) {
3289 list_for_each_entry(item, &handler->open_infos, link) {
3290 if (item->info.agent_handle == driver_handle &&
3291 item->info.attributes &
3292 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3293 ++count;
3294 }
3295 }
3296 /*
3297 * Create buffer. In case of duplicate child controller assignments
3298 * the buffer will be too large. But that does not harm.
3299 */
3300 *number_of_children = 0;
3301 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3302 if (!*child_handle_buffer)
3303 return EFI_OUT_OF_RESOURCES;
3304 /* Copy unique child handles */
3305 list_for_each_entry(handler, &efiobj->protocols, link) {
3306 list_for_each_entry(item, &handler->open_infos, link) {
3307 if (item->info.agent_handle == driver_handle &&
3308 item->info.attributes &
3309 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3310 /* Check this is a new child controller */
3311 duplicate = false;
3312 for (i = 0; i < *number_of_children; ++i) {
3313 if ((*child_handle_buffer)[i] ==
3314 item->info.controller_handle)
3315 duplicate = true;
3316 }
3317 /* Copy handle to buffer */
3318 if (!duplicate) {
3319 i = (*number_of_children)++;
3320 (*child_handle_buffer)[i] =
3321 item->info.controller_handle;
3322 }
3323 }
3324 }
3325 }
3326 return EFI_SUCCESS;
3327}
3328
Heinrich Schuchardt59999172018-05-11 18:15:41 +02003329/**
Mario Six8fac2912018-07-10 08:40:17 +02003330 * efi_disconnect_controller() - disconnect a controller from a driver
3331 * @controller_handle: handle of the controller
3332 * @driver_image_handle: handle of the driver
3333 * @child_handle: handle of the child to destroy
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003334 *
3335 * This function implements the DisconnectController service.
Mario Six8fac2912018-07-10 08:40:17 +02003336 *
3337 * See the Unified Extensible Firmware Interface (UEFI) specification for
3338 * details.
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003339 *
Mario Six8fac2912018-07-10 08:40:17 +02003340 * Return: status code
Heinrich Schuchardte9943282018-01-11 08:16:04 +01003341 */
3342static efi_status_t EFIAPI efi_disconnect_controller(
3343 efi_handle_t controller_handle,
3344 efi_handle_t driver_image_handle,
3345 efi_handle_t child_handle)
3346{
3347 struct efi_driver_binding_protocol *binding_protocol;
3348 efi_handle_t *child_handle_buffer = NULL;
3349 size_t number_of_children = 0;
3350 efi_status_t r;
3351 size_t stop_count = 0;
3352 struct efi_object *efiobj;
3353
3354 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3355 child_handle);
3356
3357 efiobj = efi_search_obj(controller_handle);
3358 if (!efiobj) {
3359 r = EFI_INVALID_PARAMETER;
3360 goto out;
3361 }
3362
3363 if (child_handle && !efi_search_obj(child_handle)) {
3364 r = EFI_INVALID_PARAMETER;
3365 goto out;
3366 }
3367
3368 /* If no driver handle is supplied, disconnect all drivers */
3369 if (!driver_image_handle) {
3370 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3371 goto out;
3372 }
3373
3374 /* Create list of child handles */
3375 if (child_handle) {
3376 number_of_children = 1;
3377 child_handle_buffer = &child_handle;
3378 } else {
3379 efi_get_child_controllers(efiobj,
3380 driver_image_handle,
3381 &number_of_children,
3382 &child_handle_buffer);
3383 }
3384
3385 /* Get the driver binding protocol */
3386 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3387 &efi_guid_driver_binding_protocol,
3388 (void **)&binding_protocol,
3389 driver_image_handle, NULL,
3390 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3391 if (r != EFI_SUCCESS)
3392 goto out;
3393 /* Remove the children */
3394 if (number_of_children) {
3395 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3396 controller_handle,
3397 number_of_children,
3398 child_handle_buffer));
3399 if (r == EFI_SUCCESS)
3400 ++stop_count;
3401 }
3402 /* Remove the driver */
3403 if (!child_handle)
3404 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3405 controller_handle,
3406 0, NULL));
3407 if (r == EFI_SUCCESS)
3408 ++stop_count;
3409 EFI_CALL(efi_close_protocol(driver_image_handle,
3410 &efi_guid_driver_binding_protocol,
3411 driver_image_handle, NULL));
3412
3413 if (stop_count)
3414 r = EFI_SUCCESS;
3415 else
3416 r = EFI_NOT_FOUND;
3417out:
3418 if (!child_handle)
3419 free(child_handle_buffer);
3420 return EFI_EXIT(r);
3421}
3422
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003423static struct efi_boot_services efi_boot_services = {
Alexander Grafc15d9212016-03-04 01:09:59 +01003424 .hdr = {
Heinrich Schuchardte75b3cb2018-06-28 12:45:27 +02003425 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3426 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt10204252018-06-28 12:45:29 +02003427 .headersize = sizeof(struct efi_boot_services),
Alexander Grafc15d9212016-03-04 01:09:59 +01003428 },
3429 .raise_tpl = efi_raise_tpl,
3430 .restore_tpl = efi_restore_tpl,
3431 .allocate_pages = efi_allocate_pages_ext,
3432 .free_pages = efi_free_pages_ext,
3433 .get_memory_map = efi_get_memory_map_ext,
Stefan Brüns5a09aef2016-10-09 22:17:18 +02003434 .allocate_pool = efi_allocate_pool_ext,
Stefan Brüns67b67d92016-10-09 22:17:26 +02003435 .free_pool = efi_free_pool_ext,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +02003436 .create_event = efi_create_event_ext,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +02003437 .set_timer = efi_set_timer_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003438 .wait_for_event = efi_wait_for_event,
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +02003439 .signal_event = efi_signal_event_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003440 .close_event = efi_close_event,
3441 .check_event = efi_check_event,
Heinrich Schuchardt0a27ac82017-11-06 21:17:44 +01003442 .install_protocol_interface = efi_install_protocol_interface,
Alexander Grafc15d9212016-03-04 01:09:59 +01003443 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
Heinrich Schuchardt7cdc17f2017-11-06 21:17:45 +01003444 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
Alexander Grafc15d9212016-03-04 01:09:59 +01003445 .handle_protocol = efi_handle_protocol,
3446 .reserved = NULL,
3447 .register_protocol_notify = efi_register_protocol_notify,
xypron.glpk@gmx.de69f94032017-07-11 22:06:21 +02003448 .locate_handle = efi_locate_handle_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003449 .locate_device_path = efi_locate_device_path,
Alexander Grafc5c11632016-08-19 01:23:24 +02003450 .install_configuration_table = efi_install_configuration_table_ext,
Alexander Grafc15d9212016-03-04 01:09:59 +01003451 .load_image = efi_load_image,
3452 .start_image = efi_start_image,
Alexander Graf988c0662016-05-20 23:28:23 +02003453 .exit = efi_exit,
Alexander Grafc15d9212016-03-04 01:09:59 +01003454 .unload_image = efi_unload_image,
3455 .exit_boot_services = efi_exit_boot_services,
3456 .get_next_monotonic_count = efi_get_next_monotonic_count,
3457 .stall = efi_stall,
3458 .set_watchdog_timer = efi_set_watchdog_timer,
3459 .connect_controller = efi_connect_controller,
3460 .disconnect_controller = efi_disconnect_controller,
3461 .open_protocol = efi_open_protocol,
3462 .close_protocol = efi_close_protocol,
3463 .open_protocol_information = efi_open_protocol_information,
3464 .protocols_per_handle = efi_protocols_per_handle,
3465 .locate_handle_buffer = efi_locate_handle_buffer,
3466 .locate_protocol = efi_locate_protocol,
Heinrich Schuchardt91064592018-02-18 15:17:49 +01003467 .install_multiple_protocol_interfaces =
3468 efi_install_multiple_protocol_interfaces,
3469 .uninstall_multiple_protocol_interfaces =
3470 efi_uninstall_multiple_protocol_interfaces,
Alexander Grafc15d9212016-03-04 01:09:59 +01003471 .calculate_crc32 = efi_calculate_crc32,
3472 .copy_mem = efi_copy_mem,
3473 .set_mem = efi_set_mem,
Heinrich Schuchardt717c4582018-02-04 23:05:13 +01003474 .create_event_ex = efi_create_event_ex,
Alexander Grafc15d9212016-03-04 01:09:59 +01003475};
3476
Heinrich Schuchardt27685f72018-06-28 12:45:30 +02003477static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
Alexander Grafc15d9212016-03-04 01:09:59 +01003478
Alexander Graf393dd912016-10-14 13:45:30 +02003479struct efi_system_table __efi_runtime_data systab = {
Alexander Grafc15d9212016-03-04 01:09:59 +01003480 .hdr = {
3481 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
Heinrich Schuchardte75b3cb2018-06-28 12:45:27 +02003482 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt10204252018-06-28 12:45:29 +02003483 .headersize = sizeof(struct efi_system_table),
Alexander Grafc15d9212016-03-04 01:09:59 +01003484 },
Heinrich Schuchardt27685f72018-06-28 12:45:30 +02003485 .fw_vendor = firmware_vendor,
3486 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
Heinrich Schuchardt91064592018-02-18 15:17:49 +01003487 .con_in = (void *)&efi_con_in,
3488 .con_out = (void *)&efi_con_out,
3489 .std_err = (void *)&efi_con_out,
3490 .runtime = (void *)&efi_runtime_services,
3491 .boottime = (void *)&efi_boot_services,
Alexander Grafc15d9212016-03-04 01:09:59 +01003492 .nr_tables = 0,
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02003493 .tables = NULL,
Alexander Grafc15d9212016-03-04 01:09:59 +01003494};
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003495
3496/**
3497 * efi_initialize_system_table() - Initialize system table
3498 *
Heinrich Schuchardt7b4b2a22018-09-03 05:00:43 +02003499 * Return: status code
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003500 */
3501efi_status_t efi_initialize_system_table(void)
3502{
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02003503 efi_status_t ret;
3504
3505 /* Allocate configuration table array */
3506 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3507 EFI_MAX_CONFIGURATION_TABLES *
3508 sizeof(struct efi_configuration_table),
3509 (void **)&systab.tables);
3510
Heinrich Schuchardtcf70a732018-09-03 19:12:24 +02003511 /* Set CRC32 field in table headers */
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003512 efi_update_table_header_crc32(&systab.hdr);
3513 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3514 efi_update_table_header_crc32(&efi_boot_services.hdr);
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +02003515
3516 return ret;
Heinrich Schuchardt15070db2018-06-28 12:45:31 +02003517}