]> git.ipfire.org Git - thirdparty/u-boot.git/blame_incremental - lib/efi_loader/efi_boottime.c
efi_loader: LoadImage() check source size
[thirdparty/u-boot.git] / lib / efi_loader / efi_boottime.c
... / ...
CommitLineData
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * EFI application boot time services
4 *
5 * Copyright (c) 2016 Alexander Graf
6 */
7
8#include <common.h>
9#include <div64.h>
10#include <efi_loader.h>
11#include <environment.h>
12#include <malloc.h>
13#include <linux/libfdt_env.h>
14#include <u-boot/crc.h>
15#include <bootm.h>
16#include <pe.h>
17#include <watchdog.h>
18
19DECLARE_GLOBAL_DATA_PTR;
20
21/* Task priority level */
22static efi_uintn_t efi_tpl = TPL_APPLICATION;
23
24/* This list contains all the EFI objects our payload has access to */
25LIST_HEAD(efi_obj_list);
26
27/* List of all events */
28LIST_HEAD(efi_events);
29
30/* List of all events registered by RegisterProtocolNotify() */
31LIST_HEAD(efi_register_notify_events);
32
33/* Handle of the currently executing image */
34static efi_handle_t current_image;
35
36/*
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
44#ifdef CONFIG_ARM
45/*
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;
52#endif
53
54/* 1 if inside U-Boot code, 0 if inside EFI payload code */
55static int entry_count = 1;
56static int nesting_level;
57/* GUID of the device tree table */
58const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
59/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60const efi_guid_t efi_guid_driver_binding_protocol =
61 EFI_DRIVER_BINDING_PROTOCOL_GUID;
62
63/* 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
79static 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);
83
84/* 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
106/* Called from do_bootefi_exec() */
107void efi_save_gd(void)
108{
109#ifdef CONFIG_ARM
110 efi_gd = gd;
111#endif
112}
113
114/*
115 * Special case handler for error/abort that just forces things back to u-boot
116 * world so we can dump out an abort message, without any care about returning
117 * back to UEFI world.
118 */
119void efi_restore_gd(void)
120{
121#ifdef CONFIG_ARM
122 /* Only restore if we're already in EFI context */
123 if (!efi_gd)
124 return;
125 gd = efi_gd;
126#endif
127}
128
129/**
130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
132 *
133 * A maximum of ten indent levels is supported. Higher indent levels will be
134 * truncated.
135 *
136 * Return: A string for indenting with two spaces per level is
137 * returned.
138 */
139static const char *indent_string(int level)
140{
141 const char *indent = " ";
142 const int max = strlen(indent);
143
144 level = min(max, level * 2);
145 return &indent[max - level];
146}
147
148const char *__efi_nesting(void)
149{
150 return indent_string(nesting_level);
151}
152
153const 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
163/**
164 * efi_queue_event() - queue an EFI event
165 * @event: event to signal
166 * @check_tpl: check the TPL level
167 *
168 * This function queues the notification function of the event for future
169 * execution.
170 *
171 * The notification function is called if the task priority level of the event
172 * is higher than the current task priority level.
173 *
174 * For the SignalEvent service see efi_signal_event_ext.
175 *
176 */
177static void efi_queue_event(struct efi_event *event, bool check_tpl)
178{
179 if (event->notify_function) {
180 event->is_queued = true;
181 /* Check TPL */
182 if (check_tpl && efi_tpl >= event->notify_tpl)
183 return;
184 EFI_CALL_VOID(event->notify_function(event,
185 event->notify_context));
186 }
187 event->is_queued = false;
188}
189
190/**
191 * is_valid_tpl() - check if the task priority level is valid
192 *
193 * @tpl: TPL level to check
194 * Return: status code
195 */
196efi_status_t is_valid_tpl(efi_uintn_t tpl)
197{
198 switch (tpl) {
199 case TPL_APPLICATION:
200 case TPL_CALLBACK:
201 case TPL_NOTIFY:
202 case TPL_HIGH_LEVEL:
203 return EFI_SUCCESS;
204 default:
205 return EFI_INVALID_PARAMETER;
206 }
207}
208
209/**
210 * efi_signal_event() - signal an EFI event
211 * @event: event to signal
212 * @check_tpl: check the TPL level
213 *
214 * This function signals an event. If the event belongs to an event group all
215 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
216 * their notification function is queued.
217 *
218 * For the SignalEvent service see efi_signal_event_ext.
219 */
220void efi_signal_event(struct efi_event *event, bool check_tpl)
221{
222 if (event->group) {
223 struct efi_event *evt;
224
225 /*
226 * The signaled state has to set before executing any
227 * notification function
228 */
229 list_for_each_entry(evt, &efi_events, link) {
230 if (!evt->group || guidcmp(evt->group, event->group))
231 continue;
232 if (evt->is_signaled)
233 continue;
234 evt->is_signaled = true;
235 if (evt->type & EVT_NOTIFY_SIGNAL &&
236 evt->notify_function)
237 evt->is_queued = true;
238 }
239 list_for_each_entry(evt, &efi_events, link) {
240 if (!evt->group || guidcmp(evt->group, event->group))
241 continue;
242 if (evt->is_queued)
243 efi_queue_event(evt, check_tpl);
244 }
245 } else {
246 event->is_signaled = true;
247 if (event->type & EVT_NOTIFY_SIGNAL)
248 efi_queue_event(event, check_tpl);
249 }
250}
251
252/**
253 * efi_raise_tpl() - raise the task priority level
254 * @new_tpl: new value of the task priority level
255 *
256 * This function implements the RaiseTpl service.
257 *
258 * See the Unified Extensible Firmware Interface (UEFI) specification for
259 * details.
260 *
261 * Return: old value of the task priority level
262 */
263static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
264{
265 efi_uintn_t old_tpl = efi_tpl;
266
267 EFI_ENTRY("0x%zx", new_tpl);
268
269 if (new_tpl < efi_tpl)
270 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
271 efi_tpl = new_tpl;
272 if (efi_tpl > TPL_HIGH_LEVEL)
273 efi_tpl = TPL_HIGH_LEVEL;
274
275 EFI_EXIT(EFI_SUCCESS);
276 return old_tpl;
277}
278
279/**
280 * efi_restore_tpl() - lower the task priority level
281 * @old_tpl: value of the task priority level to be restored
282 *
283 * This function implements the RestoreTpl service.
284 *
285 * See the Unified Extensible Firmware Interface (UEFI) specification for
286 * details.
287 */
288static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
289{
290 EFI_ENTRY("0x%zx", old_tpl);
291
292 if (old_tpl > efi_tpl)
293 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
294 efi_tpl = old_tpl;
295 if (efi_tpl > TPL_HIGH_LEVEL)
296 efi_tpl = TPL_HIGH_LEVEL;
297
298 /*
299 * Lowering the TPL may have made queued events eligible for execution.
300 */
301 efi_timer_check();
302
303 EFI_EXIT(EFI_SUCCESS);
304}
305
306/**
307 * efi_allocate_pages_ext() - allocate memory pages
308 * @type: type of allocation to be performed
309 * @memory_type: usage type of the allocated memory
310 * @pages: number of pages to be allocated
311 * @memory: allocated memory
312 *
313 * This function implements the AllocatePages service.
314 *
315 * See the Unified Extensible Firmware Interface (UEFI) specification for
316 * details.
317 *
318 * Return: status code
319 */
320static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
321 efi_uintn_t pages,
322 uint64_t *memory)
323{
324 efi_status_t r;
325
326 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
327 r = efi_allocate_pages(type, memory_type, pages, memory);
328 return EFI_EXIT(r);
329}
330
331/**
332 * efi_free_pages_ext() - Free memory pages.
333 * @memory: start of the memory area to be freed
334 * @pages: number of pages to be freed
335 *
336 * This function implements the FreePages service.
337 *
338 * See the Unified Extensible Firmware Interface (UEFI) specification for
339 * details.
340 *
341 * Return: status code
342 */
343static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
344 efi_uintn_t pages)
345{
346 efi_status_t r;
347
348 EFI_ENTRY("%llx, 0x%zx", memory, pages);
349 r = efi_free_pages(memory, pages);
350 return EFI_EXIT(r);
351}
352
353/**
354 * efi_get_memory_map_ext() - get map describing memory usage
355 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
356 * on exit the size of the copied memory map
357 * @memory_map: buffer to which the memory map is written
358 * @map_key: key for the memory map
359 * @descriptor_size: size of an individual memory descriptor
360 * @descriptor_version: version number of the memory descriptor structure
361 *
362 * This function implements the GetMemoryMap service.
363 *
364 * See the Unified Extensible Firmware Interface (UEFI) specification for
365 * details.
366 *
367 * Return: status code
368 */
369static efi_status_t EFIAPI efi_get_memory_map_ext(
370 efi_uintn_t *memory_map_size,
371 struct efi_mem_desc *memory_map,
372 efi_uintn_t *map_key,
373 efi_uintn_t *descriptor_size,
374 uint32_t *descriptor_version)
375{
376 efi_status_t r;
377
378 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
379 map_key, descriptor_size, descriptor_version);
380 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
381 descriptor_size, descriptor_version);
382 return EFI_EXIT(r);
383}
384
385/**
386 * efi_allocate_pool_ext() - allocate memory from pool
387 * @pool_type: type of the pool from which memory is to be allocated
388 * @size: number of bytes to be allocated
389 * @buffer: allocated memory
390 *
391 * This function implements the AllocatePool service.
392 *
393 * See the Unified Extensible Firmware Interface (UEFI) specification for
394 * details.
395 *
396 * Return: status code
397 */
398static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
399 efi_uintn_t size,
400 void **buffer)
401{
402 efi_status_t r;
403
404 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
405 r = efi_allocate_pool(pool_type, size, buffer);
406 return EFI_EXIT(r);
407}
408
409/**
410 * efi_free_pool_ext() - free memory from pool
411 * @buffer: start of memory to be freed
412 *
413 * This function implements the FreePool service.
414 *
415 * See the Unified Extensible Firmware Interface (UEFI) specification for
416 * details.
417 *
418 * Return: status code
419 */
420static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
421{
422 efi_status_t r;
423
424 EFI_ENTRY("%p", buffer);
425 r = efi_free_pool(buffer);
426 return EFI_EXIT(r);
427}
428
429/**
430 * efi_add_handle() - add a new handle to the object list
431 *
432 * @handle: handle to be added
433 *
434 * The protocols list is initialized. The handle is added to the list of known
435 * UEFI objects.
436 */
437void efi_add_handle(efi_handle_t handle)
438{
439 if (!handle)
440 return;
441 INIT_LIST_HEAD(&handle->protocols);
442 list_add_tail(&handle->link, &efi_obj_list);
443}
444
445/**
446 * efi_create_handle() - create handle
447 * @handle: new handle
448 *
449 * Return: status code
450 */
451efi_status_t efi_create_handle(efi_handle_t *handle)
452{
453 struct efi_object *obj;
454
455 obj = calloc(1, sizeof(struct efi_object));
456 if (!obj)
457 return EFI_OUT_OF_RESOURCES;
458
459 efi_add_handle(obj);
460 *handle = obj;
461
462 return EFI_SUCCESS;
463}
464
465/**
466 * efi_search_protocol() - find a protocol on a handle.
467 * @handle: handle
468 * @protocol_guid: GUID of the protocol
469 * @handler: reference to the protocol
470 *
471 * Return: status code
472 */
473efi_status_t efi_search_protocol(const efi_handle_t handle,
474 const efi_guid_t *protocol_guid,
475 struct efi_handler **handler)
476{
477 struct efi_object *efiobj;
478 struct list_head *lhandle;
479
480 if (!handle || !protocol_guid)
481 return EFI_INVALID_PARAMETER;
482 efiobj = efi_search_obj(handle);
483 if (!efiobj)
484 return EFI_INVALID_PARAMETER;
485 list_for_each(lhandle, &efiobj->protocols) {
486 struct efi_handler *protocol;
487
488 protocol = list_entry(lhandle, struct efi_handler, link);
489 if (!guidcmp(protocol->guid, protocol_guid)) {
490 if (handler)
491 *handler = protocol;
492 return EFI_SUCCESS;
493 }
494 }
495 return EFI_NOT_FOUND;
496}
497
498/**
499 * efi_remove_protocol() - delete protocol from a handle
500 * @handle: handle from which the protocol shall be deleted
501 * @protocol: GUID of the protocol to be deleted
502 * @protocol_interface: interface of the protocol implementation
503 *
504 * Return: status code
505 */
506efi_status_t efi_remove_protocol(const efi_handle_t handle,
507 const efi_guid_t *protocol,
508 void *protocol_interface)
509{
510 struct efi_handler *handler;
511 efi_status_t ret;
512
513 ret = efi_search_protocol(handle, protocol, &handler);
514 if (ret != EFI_SUCCESS)
515 return ret;
516 if (guidcmp(handler->guid, protocol))
517 return EFI_INVALID_PARAMETER;
518 if (handler->protocol_interface != protocol_interface)
519 return EFI_INVALID_PARAMETER;
520 list_del(&handler->link);
521 free(handler);
522 return EFI_SUCCESS;
523}
524
525/**
526 * efi_remove_all_protocols() - delete all protocols from a handle
527 * @handle: handle from which the protocols shall be deleted
528 *
529 * Return: status code
530 */
531efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
532{
533 struct efi_object *efiobj;
534 struct efi_handler *protocol;
535 struct efi_handler *pos;
536
537 efiobj = efi_search_obj(handle);
538 if (!efiobj)
539 return EFI_INVALID_PARAMETER;
540 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
541 efi_status_t ret;
542
543 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
551/**
552 * efi_delete_handle() - delete handle
553 *
554 * @obj: handle to delete
555 */
556void efi_delete_handle(efi_handle_t handle)
557{
558 if (!handle)
559 return;
560 efi_remove_all_protocols(handle);
561 list_del(&handle->link);
562 free(handle);
563}
564
565/**
566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
568 *
569 * Return: status code
570 */
571static 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}
583
584/**
585 * 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
592 *
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 *
598 * Return: status code
599 */
600efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
601 void (EFIAPI *notify_function) (
602 struct efi_event *event,
603 void *context),
604 void *notify_context, efi_guid_t *group,
605 struct efi_event **event)
606{
607 struct efi_event *evt;
608
609 if (event == NULL)
610 return EFI_INVALID_PARAMETER;
611
612 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:
623 return EFI_INVALID_PARAMETER;
624 }
625
626 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
627 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
628 return EFI_INVALID_PARAMETER;
629
630 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;
637 evt->group = group;
638 /* Disable timers on boot up */
639 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;
645}
646
647/*
648 * 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
655 *
656 * This function implements the CreateEventEx service.
657 *
658 * See the Unified Extensible Firmware Interface (UEFI) specification for
659 * details.
660 *
661 * Return: status code
662 */
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{
671 efi_status_t ret;
672
673 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
674 notify_context, event_group);
675
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);
691}
692
693/**
694 * 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
700 *
701 * This function implements the CreateEvent service.
702 *
703 * See the Unified Extensible Firmware Interface (UEFI) specification for
704 * details.
705 *
706 * Return: status code
707 */
708static efi_status_t EFIAPI efi_create_event_ext(
709 uint32_t type, efi_uintn_t notify_tpl,
710 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,
718 notify_context, NULL, event));
719}
720
721/**
722 * efi_timer_check() - check if a timer event has occurred
723 *
724 * Check if a timer event has occurred or a queued notification function should
725 * be called.
726 *
727 * Our timers have to work without interrupts, so we check whenever keyboard
728 * input or disk accesses happen if enough time elapsed for them to fire.
729 */
730void efi_timer_check(void)
731{
732 struct efi_event *evt;
733 u64 now = timer_get_us();
734
735 list_for_each_entry(evt, &efi_events, link) {
736 if (evt->is_queued)
737 efi_queue_event(evt, true);
738 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
739 continue;
740 switch (evt->trigger_type) {
741 case EFI_TIMER_RELATIVE:
742 evt->trigger_type = EFI_TIMER_STOP;
743 break;
744 case EFI_TIMER_PERIODIC:
745 evt->trigger_next += evt->trigger_time;
746 break;
747 default:
748 continue;
749 }
750 evt->is_signaled = false;
751 efi_signal_event(evt, true);
752 }
753 WATCHDOG_RESET();
754}
755
756/**
757 * 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
760 * @trigger_time: trigger period in multiples of 100 ns
761 *
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 *
765 * Return: status code
766 */
767efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
768 uint64_t trigger_time)
769{
770 /* Check that the event is valid */
771 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
772 return EFI_INVALID_PARAMETER;
773
774 /*
775 * The parameter defines a multiple of 100 ns.
776 * We use multiples of 1000 ns. So divide by 10.
777 */
778 do_div(trigger_time, 10);
779
780 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;
790 }
791 event->trigger_type = type;
792 event->trigger_time = trigger_time;
793 event->is_signaled = false;
794 return EFI_SUCCESS;
795}
796
797/**
798 * 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
802 * @trigger_time: trigger period in multiples of 100 ns
803 *
804 * This function implements the SetTimer service.
805 *
806 * See the Unified Extensible Firmware Interface (UEFI) specification for
807 * details.
808 *
809 *
810 * Return: status code
811 */
812static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
813 enum efi_timer_delay type,
814 uint64_t trigger_time)
815{
816 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
817 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
818}
819
820/**
821 * 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
825 *
826 * This function implements the WaitForEvent service.
827 *
828 * See the Unified Extensible Firmware Interface (UEFI) specification for
829 * details.
830 *
831 * Return: status code
832 */
833static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
834 struct efi_event **event,
835 efi_uintn_t *index)
836{
837 int i;
838
839 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
840
841 /* Check parameters */
842 if (!num_events || !event)
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
844 /* Check TPL */
845 if (efi_tpl != TPL_APPLICATION)
846 return EFI_EXIT(EFI_UNSUPPORTED);
847 for (i = 0; i < num_events; ++i) {
848 if (efi_is_event(event[i]) != EFI_SUCCESS)
849 return EFI_EXIT(EFI_INVALID_PARAMETER);
850 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
851 return EFI_EXIT(EFI_INVALID_PARAMETER);
852 if (!event[i]->is_signaled)
853 efi_queue_event(event[i], true);
854 }
855
856 /* Wait for signal */
857 for (;;) {
858 for (i = 0; i < num_events; ++i) {
859 if (event[i]->is_signaled)
860 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 */
871 event[i]->is_signaled = false;
872 if (index)
873 *index = i;
874
875 return EFI_EXIT(EFI_SUCCESS);
876}
877
878/**
879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
881 *
882 * This function implements the SignalEvent service.
883 *
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
885 * details.
886 *
887 * This functions sets the signaled state of the event and queues the
888 * notification function for execution.
889 *
890 * Return: status code
891 */
892static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
893{
894 EFI_ENTRY("%p", event);
895 if (efi_is_event(event) != EFI_SUCCESS)
896 return EFI_EXIT(EFI_INVALID_PARAMETER);
897 efi_signal_event(event, true);
898 return EFI_EXIT(EFI_SUCCESS);
899}
900
901/**
902 * efi_close_event() - close an EFI event
903 * @event: event to close
904 *
905 * This function implements the CloseEvent service.
906 *
907 * See the Unified Extensible Firmware Interface (UEFI) specification for
908 * details.
909 *
910 * Return: status code
911 */
912static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
913{
914 struct efi_register_notify_event *item, *next;
915
916 EFI_ENTRY("%p", event);
917 if (efi_is_event(event) != EFI_SUCCESS)
918 return EFI_EXIT(EFI_INVALID_PARAMETER);
919
920 /* Remove protocol notify registrations for the event */
921 list_for_each_entry_safe(item, next, &efi_register_notify_events,
922 link) {
923 if (event == item->event) {
924 list_del(&item->link);
925 free(item);
926 }
927 }
928
929 list_del(&event->link);
930 free(event);
931 return EFI_EXIT(EFI_SUCCESS);
932}
933
934/**
935 * efi_check_event() - check if an event is signaled
936 * @event: event to check
937 *
938 * This function implements the CheckEvent service.
939 *
940 * See the Unified Extensible Firmware Interface (UEFI) specification for
941 * details.
942 *
943 * If an event is not signaled yet, the notification function is queued. The
944 * signaled state is cleared.
945 *
946 * Return: status code
947 */
948static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
949{
950 EFI_ENTRY("%p", event);
951 efi_timer_check();
952 if (efi_is_event(event) != EFI_SUCCESS ||
953 event->type & EVT_NOTIFY_SIGNAL)
954 return EFI_EXIT(EFI_INVALID_PARAMETER);
955 if (!event->is_signaled)
956 efi_queue_event(event, true);
957 if (event->is_signaled) {
958 event->is_signaled = false;
959 return EFI_EXIT(EFI_SUCCESS);
960 }
961 return EFI_EXIT(EFI_NOT_READY);
962}
963
964/**
965 * efi_search_obj() - find the internal EFI object for a handle
966 * @handle: handle to find
967 *
968 * Return: EFI object
969 */
970struct efi_object *efi_search_obj(const efi_handle_t handle)
971{
972 struct efi_object *efiobj;
973
974 if (!handle)
975 return NULL;
976
977 list_for_each_entry(efiobj, &efi_obj_list, link) {
978 if (efiobj == handle)
979 return efiobj;
980 }
981 return NULL;
982}
983
984/**
985 * efi_open_protocol_info_entry() - create open protocol info entry and add it
986 * to a protocol
987 * @handler: handler of a protocol
988 *
989 * Return: open protocol info entry
990 */
991static struct efi_open_protocol_info_entry *efi_create_open_info(
992 struct efi_handler *handler)
993{
994 struct efi_open_protocol_info_item *item;
995
996 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
997 if (!item)
998 return NULL;
999 /* Append the item to the open protocol info list. */
1000 list_add_tail(&item->link, &handler->open_infos);
1001
1002 return &item->info;
1003}
1004
1005/**
1006 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1007 * @item: open protocol info entry to delete
1008 *
1009 * Return: status code
1010 */
1011static efi_status_t efi_delete_open_info(
1012 struct efi_open_protocol_info_item *item)
1013{
1014 list_del(&item->link);
1015 free(item);
1016 return EFI_SUCCESS;
1017}
1018
1019/**
1020 * efi_add_protocol() - install new protocol on a handle
1021 * @handle: handle on which the protocol shall be installed
1022 * @protocol: GUID of the protocol to be installed
1023 * @protocol_interface: interface of the protocol implementation
1024 *
1025 * Return: status code
1026 */
1027efi_status_t efi_add_protocol(const efi_handle_t handle,
1028 const efi_guid_t *protocol,
1029 void *protocol_interface)
1030{
1031 struct efi_object *efiobj;
1032 struct efi_handler *handler;
1033 efi_status_t ret;
1034 struct efi_register_notify_event *event;
1035
1036 efiobj = efi_search_obj(handle);
1037 if (!efiobj)
1038 return EFI_INVALID_PARAMETER;
1039 ret = efi_search_protocol(handle, protocol, NULL);
1040 if (ret != EFI_NOT_FOUND)
1041 return EFI_INVALID_PARAMETER;
1042 handler = calloc(1, sizeof(struct efi_handler));
1043 if (!handler)
1044 return EFI_OUT_OF_RESOURCES;
1045 handler->guid = protocol;
1046 handler->protocol_interface = protocol_interface;
1047 INIT_LIST_HEAD(&handler->open_infos);
1048 list_add_tail(&handler->link, &efiobj->protocols);
1049
1050 /* Notify registered events */
1051 list_for_each_entry(event, &efi_register_notify_events, link) {
1052 if (!guidcmp(protocol, &event->protocol))
1053 efi_signal_event(event->event, true);
1054 }
1055
1056 if (!guidcmp(&efi_guid_device_path, protocol))
1057 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1058 return EFI_SUCCESS;
1059}
1060
1061/**
1062 * efi_install_protocol_interface() - install protocol interface
1063 * @handle: handle on which the protocol shall be installed
1064 * @protocol: GUID of the protocol to be installed
1065 * @protocol_interface_type: type of the interface to be installed,
1066 * always EFI_NATIVE_INTERFACE
1067 * @protocol_interface: interface of the protocol implementation
1068 *
1069 * This function implements the InstallProtocolInterface service.
1070 *
1071 * See the Unified Extensible Firmware Interface (UEFI) specification for
1072 * details.
1073 *
1074 * Return: status code
1075 */
1076static efi_status_t EFIAPI efi_install_protocol_interface(
1077 efi_handle_t *handle, const efi_guid_t *protocol,
1078 int protocol_interface_type, void *protocol_interface)
1079{
1080 efi_status_t r;
1081
1082 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1083 protocol_interface);
1084
1085 if (!handle || !protocol ||
1086 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1087 r = EFI_INVALID_PARAMETER;
1088 goto out;
1089 }
1090
1091 /* Create new handle if requested. */
1092 if (!*handle) {
1093 r = efi_create_handle(handle);
1094 if (r != EFI_SUCCESS)
1095 goto out;
1096 EFI_PRINT("new handle %p\n", *handle);
1097 } else {
1098 EFI_PRINT("handle %p\n", *handle);
1099 }
1100 /* Add new protocol */
1101 r = efi_add_protocol(*handle, protocol, protocol_interface);
1102out:
1103 return EFI_EXIT(r);
1104}
1105
1106/**
1107 * efi_get_drivers() - get all drivers associated to a controller
1108 * @handle: handle of the controller
1109 * @protocol: protocol GUID (optional)
1110 * @number_of_drivers: number of child controllers
1111 * @driver_handle_buffer: handles of the the drivers
1112 *
1113 * The allocated buffer has to be freed with free().
1114 *
1115 * Return: status code
1116 */
1117static efi_status_t efi_get_drivers(efi_handle_t handle,
1118 const efi_guid_t *protocol,
1119 efi_uintn_t *number_of_drivers,
1120 efi_handle_t **driver_handle_buffer)
1121{
1122 struct efi_handler *handler;
1123 struct efi_open_protocol_info_item *item;
1124 efi_uintn_t count = 0, i;
1125 bool duplicate;
1126
1127 /* Count all driver associations */
1128 list_for_each_entry(handler, &handle->protocols, link) {
1129 if (protocol && guidcmp(handler->guid, protocol))
1130 continue;
1131 list_for_each_entry(item, &handler->open_infos, link) {
1132 if (item->info.attributes &
1133 EFI_OPEN_PROTOCOL_BY_DRIVER)
1134 ++count;
1135 }
1136 }
1137 /*
1138 * Create buffer. In case of duplicate driver assignments the buffer
1139 * will be too large. But that does not harm.
1140 */
1141 *number_of_drivers = 0;
1142 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1143 if (!*driver_handle_buffer)
1144 return EFI_OUT_OF_RESOURCES;
1145 /* Collect unique driver handles */
1146 list_for_each_entry(handler, &handle->protocols, link) {
1147 if (protocol && guidcmp(handler->guid, protocol))
1148 continue;
1149 list_for_each_entry(item, &handler->open_infos, link) {
1150 if (item->info.attributes &
1151 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1152 /* Check this is a new driver */
1153 duplicate = false;
1154 for (i = 0; i < *number_of_drivers; ++i) {
1155 if ((*driver_handle_buffer)[i] ==
1156 item->info.agent_handle)
1157 duplicate = true;
1158 }
1159 /* Copy handle to buffer */
1160 if (!duplicate) {
1161 i = (*number_of_drivers)++;
1162 (*driver_handle_buffer)[i] =
1163 item->info.agent_handle;
1164 }
1165 }
1166 }
1167 }
1168 return EFI_SUCCESS;
1169}
1170
1171/**
1172 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1173 * @handle: handle of the controller
1174 * @protocol: protocol GUID (optional)
1175 * @child_handle: handle of the child to destroy
1176 *
1177 * This function implements the DisconnectController service.
1178 *
1179 * See the Unified Extensible Firmware Interface (UEFI) specification for
1180 * details.
1181 *
1182 * Return: status code
1183 */
1184static efi_status_t efi_disconnect_all_drivers
1185 (efi_handle_t handle,
1186 const efi_guid_t *protocol,
1187 efi_handle_t child_handle)
1188{
1189 efi_uintn_t number_of_drivers;
1190 efi_handle_t *driver_handle_buffer;
1191 efi_status_t r, ret;
1192
1193 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1194 &driver_handle_buffer);
1195 if (ret != EFI_SUCCESS)
1196 return ret;
1197
1198 ret = EFI_NOT_FOUND;
1199 while (number_of_drivers) {
1200 r = EFI_CALL(efi_disconnect_controller(
1201 handle,
1202 driver_handle_buffer[--number_of_drivers],
1203 child_handle));
1204 if (r == EFI_SUCCESS)
1205 ret = r;
1206 }
1207 free(driver_handle_buffer);
1208 return ret;
1209}
1210
1211/**
1212 * efi_uninstall_protocol() - uninstall protocol interface
1213 *
1214 * @handle: handle from which the protocol shall be removed
1215 * @protocol: GUID of the protocol to be removed
1216 * @protocol_interface: interface to be removed
1217 *
1218 * This function DOES NOT delete a handle without installed protocol.
1219 *
1220 * Return: status code
1221 */
1222static efi_status_t efi_uninstall_protocol
1223 (efi_handle_t handle, const efi_guid_t *protocol,
1224 void *protocol_interface)
1225{
1226 struct efi_object *efiobj;
1227 struct efi_handler *handler;
1228 struct efi_open_protocol_info_item *item;
1229 struct efi_open_protocol_info_item *pos;
1230 efi_status_t r;
1231
1232 /* Check handle */
1233 efiobj = efi_search_obj(handle);
1234 if (!efiobj) {
1235 r = EFI_INVALID_PARAMETER;
1236 goto out;
1237 }
1238 /* Find the protocol on the handle */
1239 r = efi_search_protocol(handle, protocol, &handler);
1240 if (r != EFI_SUCCESS)
1241 goto out;
1242 /* Disconnect controllers */
1243 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1244 if (!list_empty(&handler->open_infos)) {
1245 r = EFI_ACCESS_DENIED;
1246 goto out;
1247 }
1248 /* Close protocol */
1249 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1250 if (item->info.attributes ==
1251 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1252 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1253 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1254 list_del(&item->link);
1255 }
1256 if (!list_empty(&handler->open_infos)) {
1257 r = EFI_ACCESS_DENIED;
1258 goto out;
1259 }
1260 r = efi_remove_protocol(handle, protocol, protocol_interface);
1261out:
1262 return r;
1263}
1264
1265/**
1266 * efi_uninstall_protocol_interface() - uninstall protocol interface
1267 * @handle: handle from which the protocol shall be removed
1268 * @protocol: GUID of the protocol to be removed
1269 * @protocol_interface: interface to be removed
1270 *
1271 * This function implements the UninstallProtocolInterface service.
1272 *
1273 * See the Unified Extensible Firmware Interface (UEFI) specification for
1274 * details.
1275 *
1276 * Return: status code
1277 */
1278static efi_status_t EFIAPI efi_uninstall_protocol_interface
1279 (efi_handle_t handle, const efi_guid_t *protocol,
1280 void *protocol_interface)
1281{
1282 efi_status_t ret;
1283
1284 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1285
1286 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1287 if (ret != EFI_SUCCESS)
1288 goto out;
1289
1290 /* If the last protocol has been removed, delete the handle. */
1291 if (list_empty(&handle->protocols)) {
1292 list_del(&handle->link);
1293 free(handle);
1294 }
1295out:
1296 return EFI_EXIT(ret);
1297}
1298
1299/**
1300 * efi_register_protocol_notify() - register an event for notification when a
1301 * protocol is installed.
1302 * @protocol: GUID of the protocol whose installation shall be notified
1303 * @event: event to be signaled upon installation of the protocol
1304 * @registration: key for retrieving the registration information
1305 *
1306 * This function implements the RegisterProtocolNotify service.
1307 * See the Unified Extensible Firmware Interface (UEFI) specification
1308 * for details.
1309 *
1310 * Return: status code
1311 */
1312static efi_status_t EFIAPI efi_register_protocol_notify(
1313 const efi_guid_t *protocol,
1314 struct efi_event *event,
1315 void **registration)
1316{
1317 struct efi_register_notify_event *item;
1318 efi_status_t ret = EFI_SUCCESS;
1319
1320 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1321
1322 if (!protocol || !event || !registration) {
1323 ret = EFI_INVALID_PARAMETER;
1324 goto out;
1325 }
1326
1327 item = calloc(1, sizeof(struct efi_register_notify_event));
1328 if (!item) {
1329 ret = EFI_OUT_OF_RESOURCES;
1330 goto out;
1331 }
1332
1333 item->event = event;
1334 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1335
1336 list_add_tail(&item->link, &efi_register_notify_events);
1337
1338 *registration = item;
1339out:
1340 return EFI_EXIT(ret);
1341}
1342
1343/**
1344 * efi_search() - determine if an EFI handle implements a protocol
1345 * @search_type: selection criterion
1346 * @protocol: GUID of the protocol
1347 * @search_key: registration key
1348 * @handle: handle
1349 *
1350 * See the documentation of the LocateHandle service in the UEFI specification.
1351 *
1352 * Return: 0 if the handle implements the protocol
1353 */
1354static int efi_search(enum efi_locate_search_type search_type,
1355 const efi_guid_t *protocol, efi_handle_t handle)
1356{
1357 efi_status_t ret;
1358
1359 switch (search_type) {
1360 case ALL_HANDLES:
1361 return 0;
1362 case BY_REGISTER_NOTIFY:
1363 case BY_PROTOCOL:
1364 ret = efi_search_protocol(handle, protocol, NULL);
1365 return (ret != EFI_SUCCESS);
1366 default:
1367 /* Invalid search type */
1368 return -1;
1369 }
1370}
1371
1372/**
1373 * efi_locate_handle() - locate handles implementing a protocol
1374 *
1375 * @search_type: selection criterion
1376 * @protocol: GUID of the protocol
1377 * @search_key: registration key
1378 * @buffer_size: size of the buffer to receive the handles in bytes
1379 * @buffer: buffer to receive the relevant handles
1380 *
1381 * This function is meant for U-Boot internal calls. For the API implementation
1382 * of the LocateHandle service see efi_locate_handle_ext.
1383 *
1384 * Return: status code
1385 */
1386static efi_status_t efi_locate_handle(
1387 enum efi_locate_search_type search_type,
1388 const efi_guid_t *protocol, void *search_key,
1389 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1390{
1391 struct efi_object *efiobj;
1392 efi_uintn_t size = 0;
1393 struct efi_register_notify_event *item, *event = NULL;
1394
1395 /* Check parameters */
1396 switch (search_type) {
1397 case ALL_HANDLES:
1398 break;
1399 case BY_REGISTER_NOTIFY:
1400 if (!search_key)
1401 return EFI_INVALID_PARAMETER;
1402 /* Check that the registration key is valid */
1403 list_for_each_entry(item, &efi_register_notify_events, link) {
1404 if (item ==
1405 (struct efi_register_notify_event *)search_key) {
1406 event = item;
1407 break;
1408 }
1409 }
1410 if (!event)
1411 return EFI_INVALID_PARAMETER;
1412
1413 protocol = &event->protocol;
1414 break;
1415 case BY_PROTOCOL:
1416 if (!protocol)
1417 return EFI_INVALID_PARAMETER;
1418 break;
1419 default:
1420 return EFI_INVALID_PARAMETER;
1421 }
1422
1423 /* Count how much space we need */
1424 list_for_each_entry(efiobj, &efi_obj_list, link) {
1425 if (!efi_search(search_type, protocol, efiobj))
1426 size += sizeof(void *);
1427 }
1428
1429 if (size == 0)
1430 return EFI_NOT_FOUND;
1431
1432 if (!buffer_size)
1433 return EFI_INVALID_PARAMETER;
1434
1435 if (*buffer_size < size) {
1436 *buffer_size = size;
1437 return EFI_BUFFER_TOO_SMALL;
1438 }
1439
1440 *buffer_size = size;
1441
1442 /* The buffer size is sufficient but there is not buffer */
1443 if (!buffer)
1444 return EFI_INVALID_PARAMETER;
1445
1446 /* Then fill the array */
1447 list_for_each_entry(efiobj, &efi_obj_list, link) {
1448 if (!efi_search(search_type, protocol, efiobj))
1449 *buffer++ = efiobj;
1450 }
1451
1452 return EFI_SUCCESS;
1453}
1454
1455/**
1456 * efi_locate_handle_ext() - locate handles implementing a protocol.
1457 * @search_type: selection criterion
1458 * @protocol: GUID of the protocol
1459 * @search_key: registration key
1460 * @buffer_size: size of the buffer to receive the handles in bytes
1461 * @buffer: buffer to receive the relevant handles
1462 *
1463 * This function implements the LocateHandle service.
1464 *
1465 * See the Unified Extensible Firmware Interface (UEFI) specification for
1466 * details.
1467 *
1468 * Return: 0 if the handle implements the protocol
1469 */
1470static efi_status_t EFIAPI efi_locate_handle_ext(
1471 enum efi_locate_search_type search_type,
1472 const efi_guid_t *protocol, void *search_key,
1473 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1474{
1475 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1476 buffer_size, buffer);
1477
1478 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1479 buffer_size, buffer));
1480}
1481
1482/**
1483 * efi_remove_configuration_table() - collapses configuration table entries,
1484 * removing index i
1485 *
1486 * @i: index of the table entry to be removed
1487 */
1488static void efi_remove_configuration_table(int i)
1489{
1490 struct efi_configuration_table *this = &systab.tables[i];
1491 struct efi_configuration_table *next = &systab.tables[i + 1];
1492 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1493
1494 memmove(this, next, (ulong)end - (ulong)next);
1495 systab.nr_tables--;
1496}
1497
1498/**
1499 * efi_install_configuration_table() - adds, updates, or removes a
1500 * configuration table
1501 * @guid: GUID of the installed table
1502 * @table: table to be installed
1503 *
1504 * This function is used for internal calls. For the API implementation of the
1505 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1506 *
1507 * Return: status code
1508 */
1509efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1510 void *table)
1511{
1512 struct efi_event *evt;
1513 int i;
1514
1515 if (!guid)
1516 return EFI_INVALID_PARAMETER;
1517
1518 /* Check for GUID override */
1519 for (i = 0; i < systab.nr_tables; i++) {
1520 if (!guidcmp(guid, &systab.tables[i].guid)) {
1521 if (table)
1522 systab.tables[i].table = table;
1523 else
1524 efi_remove_configuration_table(i);
1525 goto out;
1526 }
1527 }
1528
1529 if (!table)
1530 return EFI_NOT_FOUND;
1531
1532 /* No override, check for overflow */
1533 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1534 return EFI_OUT_OF_RESOURCES;
1535
1536 /* Add a new entry */
1537 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1538 systab.tables[i].table = table;
1539 systab.nr_tables = i + 1;
1540
1541out:
1542 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1543 efi_update_table_header_crc32(&systab.hdr);
1544
1545 /* Notify that the configuration table was changed */
1546 list_for_each_entry(evt, &efi_events, link) {
1547 if (evt->group && !guidcmp(evt->group, guid)) {
1548 efi_signal_event(evt, false);
1549 break;
1550 }
1551 }
1552
1553 return EFI_SUCCESS;
1554}
1555
1556/**
1557 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1558 * configuration table.
1559 * @guid: GUID of the installed table
1560 * @table: table to be installed
1561 *
1562 * This function implements the InstallConfigurationTable service.
1563 *
1564 * See the Unified Extensible Firmware Interface (UEFI) specification for
1565 * details.
1566 *
1567 * Return: status code
1568 */
1569static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1570 void *table)
1571{
1572 EFI_ENTRY("%pUl, %p", guid, table);
1573 return EFI_EXIT(efi_install_configuration_table(guid, table));
1574}
1575
1576/**
1577 * efi_setup_loaded_image() - initialize a loaded image
1578 *
1579 * Initialize a loaded_image_info and loaded_image_info object with correct
1580 * protocols, boot-device, etc.
1581 *
1582 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1583 * code is returned.
1584 *
1585 * @device_path: device path of the loaded image
1586 * @file_path: file path of the loaded image
1587 * @handle_ptr: handle of the loaded image
1588 * @info_ptr: loaded image protocol
1589 * Return: status code
1590 */
1591efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1592 struct efi_device_path *file_path,
1593 struct efi_loaded_image_obj **handle_ptr,
1594 struct efi_loaded_image **info_ptr)
1595{
1596 efi_status_t ret;
1597 struct efi_loaded_image *info = NULL;
1598 struct efi_loaded_image_obj *obj = NULL;
1599 struct efi_device_path *dp;
1600
1601 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1602 *handle_ptr = NULL;
1603 *info_ptr = NULL;
1604
1605 info = calloc(1, sizeof(*info));
1606 if (!info)
1607 return EFI_OUT_OF_RESOURCES;
1608 obj = calloc(1, sizeof(*obj));
1609 if (!obj) {
1610 free(info);
1611 return EFI_OUT_OF_RESOURCES;
1612 }
1613 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1614
1615 /* Add internal object to object list */
1616 efi_add_handle(&obj->header);
1617
1618 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1619 info->file_path = file_path;
1620 info->system_table = &systab;
1621
1622 if (device_path) {
1623 info->device_handle = efi_dp_find_obj(device_path, NULL);
1624
1625 dp = efi_dp_append(device_path, file_path);
1626 if (!dp) {
1627 ret = EFI_OUT_OF_RESOURCES;
1628 goto failure;
1629 }
1630 } else {
1631 dp = NULL;
1632 }
1633 ret = efi_add_protocol(&obj->header,
1634 &efi_guid_loaded_image_device_path, dp);
1635 if (ret != EFI_SUCCESS)
1636 goto failure;
1637
1638 /*
1639 * When asking for the loaded_image interface, just
1640 * return handle which points to loaded_image_info
1641 */
1642 ret = efi_add_protocol(&obj->header,
1643 &efi_guid_loaded_image, info);
1644 if (ret != EFI_SUCCESS)
1645 goto failure;
1646
1647 *info_ptr = info;
1648 *handle_ptr = obj;
1649
1650 return ret;
1651failure:
1652 printf("ERROR: Failure to install protocols for loaded image\n");
1653 efi_delete_handle(&obj->header);
1654 free(info);
1655 return ret;
1656}
1657
1658/**
1659 * efi_load_image_from_path() - load an image using a file path
1660 *
1661 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1662 * callers obligation to update the memory type as needed.
1663 *
1664 * @file_path: the path of the image to load
1665 * @buffer: buffer containing the loaded image
1666 * @size: size of the loaded image
1667 * Return: status code
1668 */
1669static
1670efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1671 void **buffer, efi_uintn_t *size)
1672{
1673 struct efi_file_info *info = NULL;
1674 struct efi_file_handle *f;
1675 static efi_status_t ret;
1676 u64 addr;
1677 efi_uintn_t bs;
1678
1679 /* In case of failure nothing is returned */
1680 *buffer = NULL;
1681 *size = 0;
1682
1683 /* Open file */
1684 f = efi_file_from_path(file_path);
1685 if (!f)
1686 return EFI_DEVICE_ERROR;
1687
1688 /* Get file size */
1689 bs = 0;
1690 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1691 &bs, info));
1692 if (ret != EFI_BUFFER_TOO_SMALL) {
1693 ret = EFI_DEVICE_ERROR;
1694 goto error;
1695 }
1696
1697 info = malloc(bs);
1698 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1699 info));
1700 if (ret != EFI_SUCCESS)
1701 goto error;
1702
1703 /*
1704 * When reading the file we do not yet know if it contains an
1705 * application, a boottime driver, or a runtime driver. So here we
1706 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1707 * update the reservation according to the image type.
1708 */
1709 bs = info->file_size;
1710 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1711 EFI_BOOT_SERVICES_DATA,
1712 efi_size_in_pages(bs), &addr);
1713 if (ret != EFI_SUCCESS) {
1714 ret = EFI_OUT_OF_RESOURCES;
1715 goto error;
1716 }
1717
1718 /* Read file */
1719 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1720 if (ret != EFI_SUCCESS)
1721 efi_free_pages(addr, efi_size_in_pages(bs));
1722 *buffer = (void *)(uintptr_t)addr;
1723 *size = bs;
1724error:
1725 EFI_CALL(f->close(f));
1726 free(info);
1727 return ret;
1728}
1729
1730/**
1731 * efi_load_image() - load an EFI image into memory
1732 * @boot_policy: true for request originating from the boot manager
1733 * @parent_image: the caller's image handle
1734 * @file_path: the path of the image to load
1735 * @source_buffer: memory location from which the image is installed
1736 * @source_size: size of the memory area from which the image is installed
1737 * @image_handle: handle for the newly installed image
1738 *
1739 * This function implements the LoadImage service.
1740 *
1741 * See the Unified Extensible Firmware Interface (UEFI) specification
1742 * for details.
1743 *
1744 * Return: status code
1745 */
1746efi_status_t EFIAPI efi_load_image(bool boot_policy,
1747 efi_handle_t parent_image,
1748 struct efi_device_path *file_path,
1749 void *source_buffer,
1750 efi_uintn_t source_size,
1751 efi_handle_t *image_handle)
1752{
1753 struct efi_device_path *dp, *fp;
1754 struct efi_loaded_image *info = NULL;
1755 struct efi_loaded_image_obj **image_obj =
1756 (struct efi_loaded_image_obj **)image_handle;
1757 efi_status_t ret;
1758 void *dest_buffer;
1759
1760 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1761 file_path, source_buffer, source_size, image_handle);
1762
1763 if (!image_handle || !efi_search_obj(parent_image)) {
1764 ret = EFI_INVALID_PARAMETER;
1765 goto error;
1766 }
1767
1768 if (!source_buffer && !file_path) {
1769 ret = EFI_NOT_FOUND;
1770 goto error;
1771 }
1772 /* The parent image handle must refer to a loaded image */
1773 if (!parent_image->type) {
1774 ret = EFI_INVALID_PARAMETER;
1775 goto error;
1776 }
1777
1778 if (!source_buffer) {
1779 ret = efi_load_image_from_path(file_path, &dest_buffer,
1780 &source_size);
1781 if (ret != EFI_SUCCESS)
1782 goto error;
1783 } else {
1784 if (!source_size) {
1785 ret = EFI_LOAD_ERROR;
1786 goto error;
1787 }
1788 dest_buffer = source_buffer;
1789 }
1790 /* split file_path which contains both the device and file parts */
1791 efi_dp_split_file_path(file_path, &dp, &fp);
1792 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
1793 if (ret == EFI_SUCCESS)
1794 ret = efi_load_pe(*image_obj, dest_buffer, info);
1795 if (!source_buffer)
1796 /* Release buffer to which file was loaded */
1797 efi_free_pages((uintptr_t)dest_buffer,
1798 efi_size_in_pages(source_size));
1799 if (ret == EFI_SUCCESS) {
1800 info->system_table = &systab;
1801 info->parent_handle = parent_image;
1802 } else {
1803 /* The image is invalid. Release all associated resources. */
1804 efi_delete_handle(*image_handle);
1805 *image_handle = NULL;
1806 free(info);
1807 }
1808error:
1809 return EFI_EXIT(ret);
1810}
1811
1812/**
1813 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1814 */
1815static void efi_exit_caches(void)
1816{
1817#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1818 /*
1819 * Grub on 32bit ARM needs to have caches disabled before jumping into
1820 * a zImage, but does not know of all cache layers. Give it a hand.
1821 */
1822 if (efi_is_direct_boot)
1823 cleanup_before_linux();
1824#endif
1825}
1826
1827/**
1828 * efi_exit_boot_services() - stop all boot services
1829 * @image_handle: handle of the loaded image
1830 * @map_key: key of the memory map
1831 *
1832 * This function implements the ExitBootServices service.
1833 *
1834 * See the Unified Extensible Firmware Interface (UEFI) specification
1835 * for details.
1836 *
1837 * All timer events are disabled. For exit boot services events the
1838 * notification function is called. The boot services are disabled in the
1839 * system table.
1840 *
1841 * Return: status code
1842 */
1843static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1844 unsigned long map_key)
1845{
1846 struct efi_event *evt;
1847
1848 EFI_ENTRY("%p, %ld", image_handle, map_key);
1849
1850 /* Check that the caller has read the current memory map */
1851 if (map_key != efi_memory_map_key)
1852 return EFI_INVALID_PARAMETER;
1853
1854 /* Make sure that notification functions are not called anymore */
1855 efi_tpl = TPL_HIGH_LEVEL;
1856
1857 /* Check if ExitBootServices has already been called */
1858 if (!systab.boottime)
1859 return EFI_EXIT(EFI_SUCCESS);
1860
1861 /* Add related events to the event group */
1862 list_for_each_entry(evt, &efi_events, link) {
1863 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1864 evt->group = &efi_guid_event_group_exit_boot_services;
1865 }
1866 /* Notify that ExitBootServices is invoked. */
1867 list_for_each_entry(evt, &efi_events, link) {
1868 if (evt->group &&
1869 !guidcmp(evt->group,
1870 &efi_guid_event_group_exit_boot_services)) {
1871 efi_signal_event(evt, false);
1872 break;
1873 }
1874 }
1875
1876 /* TODO: Should persist EFI variables here */
1877
1878 board_quiesce_devices();
1879
1880 /* Fix up caches for EFI payloads if necessary */
1881 efi_exit_caches();
1882
1883 /* This stops all lingering devices */
1884 bootm_disable_interrupts();
1885
1886 /* Disable boot time services */
1887 systab.con_in_handle = NULL;
1888 systab.con_in = NULL;
1889 systab.con_out_handle = NULL;
1890 systab.con_out = NULL;
1891 systab.stderr_handle = NULL;
1892 systab.std_err = NULL;
1893 systab.boottime = NULL;
1894
1895 /* Recalculate CRC32 */
1896 efi_update_table_header_crc32(&systab.hdr);
1897
1898 /* Give the payload some time to boot */
1899 efi_set_watchdog(0);
1900 WATCHDOG_RESET();
1901
1902 return EFI_EXIT(EFI_SUCCESS);
1903}
1904
1905/**
1906 * efi_get_next_monotonic_count() - get next value of the counter
1907 * @count: returned value of the counter
1908 *
1909 * This function implements the NextMonotonicCount service.
1910 *
1911 * See the Unified Extensible Firmware Interface (UEFI) specification for
1912 * details.
1913 *
1914 * Return: status code
1915 */
1916static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1917{
1918 static uint64_t mono;
1919
1920 EFI_ENTRY("%p", count);
1921 *count = mono++;
1922 return EFI_EXIT(EFI_SUCCESS);
1923}
1924
1925/**
1926 * efi_stall() - sleep
1927 * @microseconds: period to sleep in microseconds
1928 *
1929 * This function implements the Stall service.
1930 *
1931 * See the Unified Extensible Firmware Interface (UEFI) specification for
1932 * details.
1933 *
1934 * Return: status code
1935 */
1936static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1937{
1938 EFI_ENTRY("%ld", microseconds);
1939 udelay(microseconds);
1940 return EFI_EXIT(EFI_SUCCESS);
1941}
1942
1943/**
1944 * efi_set_watchdog_timer() - reset the watchdog timer
1945 * @timeout: seconds before reset by watchdog
1946 * @watchdog_code: code to be logged when resetting
1947 * @data_size: size of buffer in bytes
1948 * @watchdog_data: buffer with data describing the reset reason
1949 *
1950 * This function implements the SetWatchdogTimer service.
1951 *
1952 * See the Unified Extensible Firmware Interface (UEFI) specification for
1953 * details.
1954 *
1955 * Return: status code
1956 */
1957static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1958 uint64_t watchdog_code,
1959 unsigned long data_size,
1960 uint16_t *watchdog_data)
1961{
1962 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
1963 data_size, watchdog_data);
1964 return EFI_EXIT(efi_set_watchdog(timeout));
1965}
1966
1967/**
1968 * efi_close_protocol() - close a protocol
1969 * @handle: handle on which the protocol shall be closed
1970 * @protocol: GUID of the protocol to close
1971 * @agent_handle: handle of the driver
1972 * @controller_handle: handle of the controller
1973 *
1974 * This function implements the CloseProtocol service.
1975 *
1976 * See the Unified Extensible Firmware Interface (UEFI) specification for
1977 * details.
1978 *
1979 * Return: status code
1980 */
1981static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1982 const efi_guid_t *protocol,
1983 efi_handle_t agent_handle,
1984 efi_handle_t controller_handle)
1985{
1986 struct efi_handler *handler;
1987 struct efi_open_protocol_info_item *item;
1988 struct efi_open_protocol_info_item *pos;
1989 efi_status_t r;
1990
1991 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1992 controller_handle);
1993
1994 if (!efi_search_obj(agent_handle) ||
1995 (controller_handle && !efi_search_obj(controller_handle))) {
1996 r = EFI_INVALID_PARAMETER;
1997 goto out;
1998 }
1999 r = efi_search_protocol(handle, protocol, &handler);
2000 if (r != EFI_SUCCESS)
2001 goto out;
2002
2003 r = EFI_NOT_FOUND;
2004 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2005 if (item->info.agent_handle == agent_handle &&
2006 item->info.controller_handle == controller_handle) {
2007 efi_delete_open_info(item);
2008 r = EFI_SUCCESS;
2009 break;
2010 }
2011 }
2012out:
2013 return EFI_EXIT(r);
2014}
2015
2016/**
2017 * efi_open_protocol_information() - provide information about then open status
2018 * of a protocol on a handle
2019 * @handle: handle for which the information shall be retrieved
2020 * @protocol: GUID of the protocol
2021 * @entry_buffer: buffer to receive the open protocol information
2022 * @entry_count: number of entries available in the buffer
2023 *
2024 * This function implements the OpenProtocolInformation service.
2025 *
2026 * See the Unified Extensible Firmware Interface (UEFI) specification for
2027 * details.
2028 *
2029 * Return: status code
2030 */
2031static efi_status_t EFIAPI efi_open_protocol_information(
2032 efi_handle_t handle, const efi_guid_t *protocol,
2033 struct efi_open_protocol_info_entry **entry_buffer,
2034 efi_uintn_t *entry_count)
2035{
2036 unsigned long buffer_size;
2037 unsigned long count;
2038 struct efi_handler *handler;
2039 struct efi_open_protocol_info_item *item;
2040 efi_status_t r;
2041
2042 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2043 entry_count);
2044
2045 /* Check parameters */
2046 if (!entry_buffer) {
2047 r = EFI_INVALID_PARAMETER;
2048 goto out;
2049 }
2050 r = efi_search_protocol(handle, protocol, &handler);
2051 if (r != EFI_SUCCESS)
2052 goto out;
2053
2054 /* Count entries */
2055 count = 0;
2056 list_for_each_entry(item, &handler->open_infos, link) {
2057 if (item->info.open_count)
2058 ++count;
2059 }
2060 *entry_count = count;
2061 *entry_buffer = NULL;
2062 if (!count) {
2063 r = EFI_SUCCESS;
2064 goto out;
2065 }
2066
2067 /* Copy entries */
2068 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2069 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2070 (void **)entry_buffer);
2071 if (r != EFI_SUCCESS)
2072 goto out;
2073 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2074 if (item->info.open_count)
2075 (*entry_buffer)[--count] = item->info;
2076 }
2077out:
2078 return EFI_EXIT(r);
2079}
2080
2081/**
2082 * efi_protocols_per_handle() - get protocols installed on a handle
2083 * @handle: handle for which the information is retrieved
2084 * @protocol_buffer: buffer with protocol GUIDs
2085 * @protocol_buffer_count: number of entries in the buffer
2086 *
2087 * This function implements the ProtocolsPerHandleService.
2088 *
2089 * See the Unified Extensible Firmware Interface (UEFI) specification for
2090 * details.
2091 *
2092 * Return: status code
2093 */
2094static efi_status_t EFIAPI efi_protocols_per_handle(
2095 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2096 efi_uintn_t *protocol_buffer_count)
2097{
2098 unsigned long buffer_size;
2099 struct efi_object *efiobj;
2100 struct list_head *protocol_handle;
2101 efi_status_t r;
2102
2103 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2104 protocol_buffer_count);
2105
2106 if (!handle || !protocol_buffer || !protocol_buffer_count)
2107 return EFI_EXIT(EFI_INVALID_PARAMETER);
2108
2109 *protocol_buffer = NULL;
2110 *protocol_buffer_count = 0;
2111
2112 efiobj = efi_search_obj(handle);
2113 if (!efiobj)
2114 return EFI_EXIT(EFI_INVALID_PARAMETER);
2115
2116 /* Count protocols */
2117 list_for_each(protocol_handle, &efiobj->protocols) {
2118 ++*protocol_buffer_count;
2119 }
2120
2121 /* Copy GUIDs */
2122 if (*protocol_buffer_count) {
2123 size_t j = 0;
2124
2125 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2126 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2127 (void **)protocol_buffer);
2128 if (r != EFI_SUCCESS)
2129 return EFI_EXIT(r);
2130 list_for_each(protocol_handle, &efiobj->protocols) {
2131 struct efi_handler *protocol;
2132
2133 protocol = list_entry(protocol_handle,
2134 struct efi_handler, link);
2135 (*protocol_buffer)[j] = (void *)protocol->guid;
2136 ++j;
2137 }
2138 }
2139
2140 return EFI_EXIT(EFI_SUCCESS);
2141}
2142
2143/**
2144 * efi_locate_handle_buffer() - locate handles implementing a protocol
2145 * @search_type: selection criterion
2146 * @protocol: GUID of the protocol
2147 * @search_key: registration key
2148 * @no_handles: number of returned handles
2149 * @buffer: buffer with the returned handles
2150 *
2151 * This function implements the LocateHandleBuffer service.
2152 *
2153 * See the Unified Extensible Firmware Interface (UEFI) specification for
2154 * details.
2155 *
2156 * Return: status code
2157 */
2158static efi_status_t EFIAPI efi_locate_handle_buffer(
2159 enum efi_locate_search_type search_type,
2160 const efi_guid_t *protocol, void *search_key,
2161 efi_uintn_t *no_handles, efi_handle_t **buffer)
2162{
2163 efi_status_t r;
2164 efi_uintn_t buffer_size = 0;
2165
2166 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2167 no_handles, buffer);
2168
2169 if (!no_handles || !buffer) {
2170 r = EFI_INVALID_PARAMETER;
2171 goto out;
2172 }
2173 *no_handles = 0;
2174 *buffer = NULL;
2175 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2176 *buffer);
2177 if (r != EFI_BUFFER_TOO_SMALL)
2178 goto out;
2179 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2180 (void **)buffer);
2181 if (r != EFI_SUCCESS)
2182 goto out;
2183 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2184 *buffer);
2185 if (r == EFI_SUCCESS)
2186 *no_handles = buffer_size / sizeof(efi_handle_t);
2187out:
2188 return EFI_EXIT(r);
2189}
2190
2191/**
2192 * efi_locate_protocol() - find an interface implementing a protocol
2193 * @protocol: GUID of the protocol
2194 * @registration: registration key passed to the notification function
2195 * @protocol_interface: interface implementing the protocol
2196 *
2197 * This function implements the LocateProtocol service.
2198 *
2199 * See the Unified Extensible Firmware Interface (UEFI) specification for
2200 * details.
2201 *
2202 * Return: status code
2203 */
2204static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2205 void *registration,
2206 void **protocol_interface)
2207{
2208 struct list_head *lhandle;
2209 efi_status_t ret;
2210
2211 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2212
2213 if (!protocol || !protocol_interface)
2214 return EFI_EXIT(EFI_INVALID_PARAMETER);
2215
2216 list_for_each(lhandle, &efi_obj_list) {
2217 struct efi_object *efiobj;
2218 struct efi_handler *handler;
2219
2220 efiobj = list_entry(lhandle, struct efi_object, link);
2221
2222 ret = efi_search_protocol(efiobj, protocol, &handler);
2223 if (ret == EFI_SUCCESS) {
2224 *protocol_interface = handler->protocol_interface;
2225 return EFI_EXIT(EFI_SUCCESS);
2226 }
2227 }
2228 *protocol_interface = NULL;
2229
2230 return EFI_EXIT(EFI_NOT_FOUND);
2231}
2232
2233/**
2234 * efi_locate_device_path() - Get the device path and handle of an device
2235 * implementing a protocol
2236 * @protocol: GUID of the protocol
2237 * @device_path: device path
2238 * @device: handle of the device
2239 *
2240 * This function implements the LocateDevicePath service.
2241 *
2242 * See the Unified Extensible Firmware Interface (UEFI) specification for
2243 * details.
2244 *
2245 * Return: status code
2246 */
2247static efi_status_t EFIAPI efi_locate_device_path(
2248 const efi_guid_t *protocol,
2249 struct efi_device_path **device_path,
2250 efi_handle_t *device)
2251{
2252 struct efi_device_path *dp;
2253 size_t i;
2254 struct efi_handler *handler;
2255 efi_handle_t *handles;
2256 size_t len, len_dp;
2257 size_t len_best = 0;
2258 efi_uintn_t no_handles;
2259 u8 *remainder;
2260 efi_status_t ret;
2261
2262 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2263
2264 if (!protocol || !device_path || !*device_path || !device) {
2265 ret = EFI_INVALID_PARAMETER;
2266 goto out;
2267 }
2268
2269 /* Find end of device path */
2270 len = efi_dp_instance_size(*device_path);
2271
2272 /* Get all handles implementing the protocol */
2273 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2274 &no_handles, &handles));
2275 if (ret != EFI_SUCCESS)
2276 goto out;
2277
2278 for (i = 0; i < no_handles; ++i) {
2279 /* Find the device path protocol */
2280 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2281 &handler);
2282 if (ret != EFI_SUCCESS)
2283 continue;
2284 dp = (struct efi_device_path *)handler->protocol_interface;
2285 len_dp = efi_dp_instance_size(dp);
2286 /*
2287 * This handle can only be a better fit
2288 * if its device path length is longer than the best fit and
2289 * if its device path length is shorter of equal the searched
2290 * device path.
2291 */
2292 if (len_dp <= len_best || len_dp > len)
2293 continue;
2294 /* Check if dp is a subpath of device_path */
2295 if (memcmp(*device_path, dp, len_dp))
2296 continue;
2297 *device = handles[i];
2298 len_best = len_dp;
2299 }
2300 if (len_best) {
2301 remainder = (u8 *)*device_path + len_best;
2302 *device_path = (struct efi_device_path *)remainder;
2303 ret = EFI_SUCCESS;
2304 } else {
2305 ret = EFI_NOT_FOUND;
2306 }
2307out:
2308 return EFI_EXIT(ret);
2309}
2310
2311/**
2312 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2313 * interfaces
2314 * @handle: handle on which the protocol interfaces shall be installed
2315 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2316 * interfaces
2317 *
2318 * This function implements the MultipleProtocolInterfaces service.
2319 *
2320 * See the Unified Extensible Firmware Interface (UEFI) specification for
2321 * details.
2322 *
2323 * Return: status code
2324 */
2325efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2326 (efi_handle_t *handle, ...)
2327{
2328 EFI_ENTRY("%p", handle);
2329
2330 efi_va_list argptr;
2331 const efi_guid_t *protocol;
2332 void *protocol_interface;
2333 efi_status_t r = EFI_SUCCESS;
2334 int i = 0;
2335
2336 if (!handle)
2337 return EFI_EXIT(EFI_INVALID_PARAMETER);
2338
2339 efi_va_start(argptr, handle);
2340 for (;;) {
2341 protocol = efi_va_arg(argptr, efi_guid_t*);
2342 if (!protocol)
2343 break;
2344 protocol_interface = efi_va_arg(argptr, void*);
2345 r = EFI_CALL(efi_install_protocol_interface(
2346 handle, protocol,
2347 EFI_NATIVE_INTERFACE,
2348 protocol_interface));
2349 if (r != EFI_SUCCESS)
2350 break;
2351 i++;
2352 }
2353 efi_va_end(argptr);
2354 if (r == EFI_SUCCESS)
2355 return EFI_EXIT(r);
2356
2357 /* If an error occurred undo all changes. */
2358 efi_va_start(argptr, handle);
2359 for (; i; --i) {
2360 protocol = efi_va_arg(argptr, efi_guid_t*);
2361 protocol_interface = efi_va_arg(argptr, void*);
2362 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2363 protocol_interface));
2364 }
2365 efi_va_end(argptr);
2366
2367 return EFI_EXIT(r);
2368}
2369
2370/**
2371 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2372 * interfaces
2373 * @handle: handle from which the protocol interfaces shall be removed
2374 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2375 * interfaces
2376 *
2377 * This function implements the UninstallMultipleProtocolInterfaces service.
2378 *
2379 * See the Unified Extensible Firmware Interface (UEFI) specification for
2380 * details.
2381 *
2382 * Return: status code
2383 */
2384static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2385 efi_handle_t handle, ...)
2386{
2387 EFI_ENTRY("%p", handle);
2388
2389 efi_va_list argptr;
2390 const efi_guid_t *protocol;
2391 void *protocol_interface;
2392 efi_status_t r = EFI_SUCCESS;
2393 size_t i = 0;
2394
2395 if (!handle)
2396 return EFI_EXIT(EFI_INVALID_PARAMETER);
2397
2398 efi_va_start(argptr, handle);
2399 for (;;) {
2400 protocol = efi_va_arg(argptr, efi_guid_t*);
2401 if (!protocol)
2402 break;
2403 protocol_interface = efi_va_arg(argptr, void*);
2404 r = efi_uninstall_protocol(handle, protocol,
2405 protocol_interface);
2406 if (r != EFI_SUCCESS)
2407 break;
2408 i++;
2409 }
2410 efi_va_end(argptr);
2411 if (r == EFI_SUCCESS) {
2412 /* If the last protocol has been removed, delete the handle. */
2413 if (list_empty(&handle->protocols)) {
2414 list_del(&handle->link);
2415 free(handle);
2416 }
2417 return EFI_EXIT(r);
2418 }
2419
2420 /* If an error occurred undo all changes. */
2421 efi_va_start(argptr, handle);
2422 for (; i; --i) {
2423 protocol = efi_va_arg(argptr, efi_guid_t*);
2424 protocol_interface = efi_va_arg(argptr, void*);
2425 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2426 EFI_NATIVE_INTERFACE,
2427 protocol_interface));
2428 }
2429 efi_va_end(argptr);
2430
2431 /* In case of an error always return EFI_INVALID_PARAMETER */
2432 return EFI_EXIT(EFI_INVALID_PARAMETER);
2433}
2434
2435/**
2436 * efi_calculate_crc32() - calculate cyclic redundancy code
2437 * @data: buffer with data
2438 * @data_size: size of buffer in bytes
2439 * @crc32_p: cyclic redundancy code
2440 *
2441 * This function implements the CalculateCrc32 service.
2442 *
2443 * See the Unified Extensible Firmware Interface (UEFI) specification for
2444 * details.
2445 *
2446 * Return: status code
2447 */
2448static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2449 efi_uintn_t data_size,
2450 u32 *crc32_p)
2451{
2452 EFI_ENTRY("%p, %zu", data, data_size);
2453 *crc32_p = crc32(0, data, data_size);
2454 return EFI_EXIT(EFI_SUCCESS);
2455}
2456
2457/**
2458 * efi_copy_mem() - copy memory
2459 * @destination: destination of the copy operation
2460 * @source: source of the copy operation
2461 * @length: number of bytes to copy
2462 *
2463 * This function implements the CopyMem service.
2464 *
2465 * See the Unified Extensible Firmware Interface (UEFI) specification for
2466 * details.
2467 */
2468static void EFIAPI efi_copy_mem(void *destination, const void *source,
2469 size_t length)
2470{
2471 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2472 memmove(destination, source, length);
2473 EFI_EXIT(EFI_SUCCESS);
2474}
2475
2476/**
2477 * efi_set_mem() - Fill memory with a byte value.
2478 * @buffer: buffer to fill
2479 * @size: size of buffer in bytes
2480 * @value: byte to copy to the buffer
2481 *
2482 * This function implements the SetMem service.
2483 *
2484 * See the Unified Extensible Firmware Interface (UEFI) specification for
2485 * details.
2486 */
2487static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2488{
2489 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2490 memset(buffer, value, size);
2491 EFI_EXIT(EFI_SUCCESS);
2492}
2493
2494/**
2495 * efi_protocol_open() - open protocol interface on a handle
2496 * @handler: handler of a protocol
2497 * @protocol_interface: interface implementing the protocol
2498 * @agent_handle: handle of the driver
2499 * @controller_handle: handle of the controller
2500 * @attributes: attributes indicating how to open the protocol
2501 *
2502 * Return: status code
2503 */
2504static efi_status_t efi_protocol_open(
2505 struct efi_handler *handler,
2506 void **protocol_interface, void *agent_handle,
2507 void *controller_handle, uint32_t attributes)
2508{
2509 struct efi_open_protocol_info_item *item;
2510 struct efi_open_protocol_info_entry *match = NULL;
2511 bool opened_by_driver = false;
2512 bool opened_exclusive = false;
2513
2514 /* If there is no agent, only return the interface */
2515 if (!agent_handle)
2516 goto out;
2517
2518 /* For TEST_PROTOCOL ignore interface attribute */
2519 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2520 *protocol_interface = NULL;
2521
2522 /*
2523 * Check if the protocol is already opened by a driver with the same
2524 * attributes or opened exclusively
2525 */
2526 list_for_each_entry(item, &handler->open_infos, link) {
2527 if (item->info.agent_handle == agent_handle) {
2528 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2529 (item->info.attributes == attributes))
2530 return EFI_ALREADY_STARTED;
2531 }
2532 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2533 opened_exclusive = true;
2534 }
2535
2536 /* Only one controller can open the protocol exclusively */
2537 if (opened_exclusive && attributes &
2538 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2539 return EFI_ACCESS_DENIED;
2540
2541 /* Prepare exclusive opening */
2542 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2543 /* Try to disconnect controllers */
2544 list_for_each_entry(item, &handler->open_infos, link) {
2545 if (item->info.attributes ==
2546 EFI_OPEN_PROTOCOL_BY_DRIVER)
2547 EFI_CALL(efi_disconnect_controller(
2548 item->info.controller_handle,
2549 item->info.agent_handle,
2550 NULL));
2551 }
2552 opened_by_driver = false;
2553 /* Check if all controllers are disconnected */
2554 list_for_each_entry(item, &handler->open_infos, link) {
2555 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2556 opened_by_driver = true;
2557 }
2558 /* Only one controller can be connected */
2559 if (opened_by_driver)
2560 return EFI_ACCESS_DENIED;
2561 }
2562
2563 /* Find existing entry */
2564 list_for_each_entry(item, &handler->open_infos, link) {
2565 if (item->info.agent_handle == agent_handle &&
2566 item->info.controller_handle == controller_handle)
2567 match = &item->info;
2568 }
2569 /* None found, create one */
2570 if (!match) {
2571 match = efi_create_open_info(handler);
2572 if (!match)
2573 return EFI_OUT_OF_RESOURCES;
2574 }
2575
2576 match->agent_handle = agent_handle;
2577 match->controller_handle = controller_handle;
2578 match->attributes = attributes;
2579 match->open_count++;
2580
2581out:
2582 /* For TEST_PROTOCOL ignore interface attribute. */
2583 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2584 *protocol_interface = handler->protocol_interface;
2585
2586 return EFI_SUCCESS;
2587}
2588
2589/**
2590 * efi_open_protocol() - open protocol interface on a handle
2591 * @handle: handle on which the protocol shall be opened
2592 * @protocol: GUID of the protocol
2593 * @protocol_interface: interface implementing the protocol
2594 * @agent_handle: handle of the driver
2595 * @controller_handle: handle of the controller
2596 * @attributes: attributes indicating how to open the protocol
2597 *
2598 * This function implements the OpenProtocol interface.
2599 *
2600 * See the Unified Extensible Firmware Interface (UEFI) specification for
2601 * details.
2602 *
2603 * Return: status code
2604 */
2605static efi_status_t EFIAPI efi_open_protocol
2606 (efi_handle_t handle, const efi_guid_t *protocol,
2607 void **protocol_interface, efi_handle_t agent_handle,
2608 efi_handle_t controller_handle, uint32_t attributes)
2609{
2610 struct efi_handler *handler;
2611 efi_status_t r = EFI_INVALID_PARAMETER;
2612
2613 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2614 protocol_interface, agent_handle, controller_handle,
2615 attributes);
2616
2617 if (!handle || !protocol ||
2618 (!protocol_interface && attributes !=
2619 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2620 goto out;
2621 }
2622
2623 switch (attributes) {
2624 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2625 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2626 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2627 break;
2628 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2629 if (controller_handle == handle)
2630 goto out;
2631 /* fall-through */
2632 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2633 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2634 /* Check that the controller handle is valid */
2635 if (!efi_search_obj(controller_handle))
2636 goto out;
2637 /* fall-through */
2638 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2639 /* Check that the agent handle is valid */
2640 if (!efi_search_obj(agent_handle))
2641 goto out;
2642 break;
2643 default:
2644 goto out;
2645 }
2646
2647 r = efi_search_protocol(handle, protocol, &handler);
2648 switch (r) {
2649 case EFI_SUCCESS:
2650 break;
2651 case EFI_NOT_FOUND:
2652 r = EFI_UNSUPPORTED;
2653 goto out;
2654 default:
2655 goto out;
2656 }
2657
2658 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2659 controller_handle, attributes);
2660out:
2661 return EFI_EXIT(r);
2662}
2663
2664/**
2665 * efi_start_image() - call the entry point of an image
2666 * @image_handle: handle of the image
2667 * @exit_data_size: size of the buffer
2668 * @exit_data: buffer to receive the exit data of the called image
2669 *
2670 * This function implements the StartImage service.
2671 *
2672 * See the Unified Extensible Firmware Interface (UEFI) specification for
2673 * details.
2674 *
2675 * Return: status code
2676 */
2677efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2678 efi_uintn_t *exit_data_size,
2679 u16 **exit_data)
2680{
2681 struct efi_loaded_image_obj *image_obj =
2682 (struct efi_loaded_image_obj *)image_handle;
2683 efi_status_t ret;
2684 void *info;
2685 efi_handle_t parent_image = current_image;
2686
2687 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2688
2689 /* Check parameters */
2690 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2691 &info, NULL, NULL,
2692 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2693 if (ret != EFI_SUCCESS)
2694 return EFI_EXIT(EFI_INVALID_PARAMETER);
2695
2696 efi_is_direct_boot = false;
2697
2698 image_obj->exit_data_size = exit_data_size;
2699 image_obj->exit_data = exit_data;
2700
2701 /* call the image! */
2702 if (setjmp(&image_obj->exit_jmp)) {
2703 /*
2704 * We called the entry point of the child image with EFI_CALL
2705 * in the lines below. The child image called the Exit() boot
2706 * service efi_exit() which executed the long jump that brought
2707 * us to the current line. This implies that the second half
2708 * of the EFI_CALL macro has not been executed.
2709 */
2710#ifdef CONFIG_ARM
2711 /*
2712 * efi_exit() called efi_restore_gd(). We have to undo this
2713 * otherwise __efi_entry_check() will put the wrong value into
2714 * app_gd.
2715 */
2716 gd = app_gd;
2717#endif
2718 /*
2719 * To get ready to call EFI_EXIT below we have to execute the
2720 * missed out steps of EFI_CALL.
2721 */
2722 assert(__efi_entry_check());
2723 EFI_PRINT("%lu returned by started image\n",
2724 (unsigned long)((uintptr_t)image_obj->exit_status &
2725 ~EFI_ERROR_MASK));
2726 current_image = parent_image;
2727 return EFI_EXIT(image_obj->exit_status);
2728 }
2729
2730 current_image = image_handle;
2731 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
2732 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
2733 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2734
2735 /*
2736 * Usually UEFI applications call Exit() instead of returning.
2737 * But because the world doesn't consist of ponies and unicorns,
2738 * we're happy to emulate that behavior on behalf of a payload
2739 * that forgot.
2740 */
2741 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2742}
2743
2744/**
2745 * efi_delete_image() - delete loaded image from memory)
2746 *
2747 * @image_obj: handle of the loaded image
2748 * @loaded_image_protocol: loaded image protocol
2749 */
2750static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2751 struct efi_loaded_image *loaded_image_protocol)
2752{
2753 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2754 efi_size_in_pages(loaded_image_protocol->image_size));
2755 efi_delete_handle(&image_obj->header);
2756}
2757
2758/**
2759 * efi_unload_image() - unload an EFI image
2760 * @image_handle: handle of the image to be unloaded
2761 *
2762 * This function implements the UnloadImage service.
2763 *
2764 * See the Unified Extensible Firmware Interface (UEFI) specification for
2765 * details.
2766 *
2767 * Return: status code
2768 */
2769efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2770{
2771 efi_status_t ret = EFI_SUCCESS;
2772 struct efi_object *efiobj;
2773 struct efi_loaded_image *loaded_image_protocol;
2774
2775 EFI_ENTRY("%p", image_handle);
2776
2777 efiobj = efi_search_obj(image_handle);
2778 if (!efiobj) {
2779 ret = EFI_INVALID_PARAMETER;
2780 goto out;
2781 }
2782 /* Find the loaded image protocol */
2783 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2784 (void **)&loaded_image_protocol,
2785 NULL, NULL,
2786 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2787 if (ret != EFI_SUCCESS) {
2788 ret = EFI_INVALID_PARAMETER;
2789 goto out;
2790 }
2791 switch (efiobj->type) {
2792 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2793 /* Call the unload function */
2794 if (!loaded_image_protocol->unload) {
2795 ret = EFI_UNSUPPORTED;
2796 goto out;
2797 }
2798 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2799 if (ret != EFI_SUCCESS)
2800 goto out;
2801 break;
2802 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2803 break;
2804 default:
2805 ret = EFI_INVALID_PARAMETER;
2806 goto out;
2807 }
2808 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2809 loaded_image_protocol);
2810out:
2811 return EFI_EXIT(ret);
2812}
2813
2814/**
2815 * efi_update_exit_data() - fill exit data parameters of StartImage()
2816 *
2817 * @image_obj image handle
2818 * @exit_data_size size of the exit data buffer
2819 * @exit_data buffer with data returned by UEFI payload
2820 * Return: status code
2821 */
2822static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2823 efi_uintn_t exit_data_size,
2824 u16 *exit_data)
2825{
2826 efi_status_t ret;
2827
2828 /*
2829 * If exit_data is not provided to StartImage(), exit_data_size must be
2830 * ignored.
2831 */
2832 if (!image_obj->exit_data)
2833 return EFI_SUCCESS;
2834 if (image_obj->exit_data_size)
2835 *image_obj->exit_data_size = exit_data_size;
2836 if (exit_data_size && exit_data) {
2837 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2838 exit_data_size,
2839 (void **)image_obj->exit_data);
2840 if (ret != EFI_SUCCESS)
2841 return ret;
2842 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2843 } else {
2844 image_obj->exit_data = NULL;
2845 }
2846 return EFI_SUCCESS;
2847}
2848
2849/**
2850 * efi_exit() - leave an EFI application or driver
2851 * @image_handle: handle of the application or driver that is exiting
2852 * @exit_status: status code
2853 * @exit_data_size: size of the buffer in bytes
2854 * @exit_data: buffer with data describing an error
2855 *
2856 * This function implements the Exit service.
2857 *
2858 * See the Unified Extensible Firmware Interface (UEFI) specification for
2859 * details.
2860 *
2861 * Return: status code
2862 */
2863static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2864 efi_status_t exit_status,
2865 efi_uintn_t exit_data_size,
2866 u16 *exit_data)
2867{
2868 /*
2869 * TODO: We should call the unload procedure of the loaded
2870 * image protocol.
2871 */
2872 efi_status_t ret;
2873 struct efi_loaded_image *loaded_image_protocol;
2874 struct efi_loaded_image_obj *image_obj =
2875 (struct efi_loaded_image_obj *)image_handle;
2876
2877 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2878 exit_data_size, exit_data);
2879
2880 /* Check parameters */
2881 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2882 (void **)&loaded_image_protocol,
2883 NULL, NULL,
2884 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2885 if (ret != EFI_SUCCESS) {
2886 ret = EFI_INVALID_PARAMETER;
2887 goto out;
2888 }
2889
2890 /* Unloading of unstarted images */
2891 switch (image_obj->header.type) {
2892 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2893 break;
2894 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2895 efi_delete_image(image_obj, loaded_image_protocol);
2896 ret = EFI_SUCCESS;
2897 goto out;
2898 default:
2899 /* Handle does not refer to loaded image */
2900 ret = EFI_INVALID_PARAMETER;
2901 goto out;
2902 }
2903 /* A started image can only be unloaded it is the last one started. */
2904 if (image_handle != current_image) {
2905 ret = EFI_INVALID_PARAMETER;
2906 goto out;
2907 }
2908
2909 /* Exit data is only foreseen in case of failure. */
2910 if (exit_status != EFI_SUCCESS) {
2911 ret = efi_update_exit_data(image_obj, exit_data_size,
2912 exit_data);
2913 /* Exiting has priority. Don't return error to caller. */
2914 if (ret != EFI_SUCCESS)
2915 EFI_PRINT("%s: out of memory\n", __func__);
2916 }
2917 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2918 exit_status != EFI_SUCCESS)
2919 efi_delete_image(image_obj, loaded_image_protocol);
2920
2921 /* Make sure entry/exit counts for EFI world cross-overs match */
2922 EFI_EXIT(exit_status);
2923
2924 /*
2925 * But longjmp out with the U-Boot gd, not the application's, as
2926 * the other end is a setjmp call inside EFI context.
2927 */
2928 efi_restore_gd();
2929
2930 image_obj->exit_status = exit_status;
2931 longjmp(&image_obj->exit_jmp, 1);
2932
2933 panic("EFI application exited");
2934out:
2935 return EFI_EXIT(ret);
2936}
2937
2938/**
2939 * efi_handle_protocol() - get interface of a protocol on a handle
2940 * @handle: handle on which the protocol shall be opened
2941 * @protocol: GUID of the protocol
2942 * @protocol_interface: interface implementing the protocol
2943 *
2944 * This function implements the HandleProtocol service.
2945 *
2946 * See the Unified Extensible Firmware Interface (UEFI) specification for
2947 * details.
2948 *
2949 * Return: status code
2950 */
2951static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2952 const efi_guid_t *protocol,
2953 void **protocol_interface)
2954{
2955 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2956 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2957}
2958
2959/**
2960 * efi_bind_controller() - bind a single driver to a controller
2961 * @controller_handle: controller handle
2962 * @driver_image_handle: driver handle
2963 * @remain_device_path: remaining path
2964 *
2965 * Return: status code
2966 */
2967static efi_status_t efi_bind_controller(
2968 efi_handle_t controller_handle,
2969 efi_handle_t driver_image_handle,
2970 struct efi_device_path *remain_device_path)
2971{
2972 struct efi_driver_binding_protocol *binding_protocol;
2973 efi_status_t r;
2974
2975 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2976 &efi_guid_driver_binding_protocol,
2977 (void **)&binding_protocol,
2978 driver_image_handle, NULL,
2979 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2980 if (r != EFI_SUCCESS)
2981 return r;
2982 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2983 controller_handle,
2984 remain_device_path));
2985 if (r == EFI_SUCCESS)
2986 r = EFI_CALL(binding_protocol->start(binding_protocol,
2987 controller_handle,
2988 remain_device_path));
2989 EFI_CALL(efi_close_protocol(driver_image_handle,
2990 &efi_guid_driver_binding_protocol,
2991 driver_image_handle, NULL));
2992 return r;
2993}
2994
2995/**
2996 * efi_connect_single_controller() - connect a single driver to a controller
2997 * @controller_handle: controller
2998 * @driver_image_handle: driver
2999 * @remain_device_path: remaining path
3000 *
3001 * Return: status code
3002 */
3003static efi_status_t efi_connect_single_controller(
3004 efi_handle_t controller_handle,
3005 efi_handle_t *driver_image_handle,
3006 struct efi_device_path *remain_device_path)
3007{
3008 efi_handle_t *buffer;
3009 size_t count;
3010 size_t i;
3011 efi_status_t r;
3012 size_t connected = 0;
3013
3014 /* Get buffer with all handles with driver binding protocol */
3015 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3016 &efi_guid_driver_binding_protocol,
3017 NULL, &count, &buffer));
3018 if (r != EFI_SUCCESS)
3019 return r;
3020
3021 /* Context Override */
3022 if (driver_image_handle) {
3023 for (; *driver_image_handle; ++driver_image_handle) {
3024 for (i = 0; i < count; ++i) {
3025 if (buffer[i] == *driver_image_handle) {
3026 buffer[i] = NULL;
3027 r = efi_bind_controller(
3028 controller_handle,
3029 *driver_image_handle,
3030 remain_device_path);
3031 /*
3032 * For drivers that do not support the
3033 * controller or are already connected
3034 * we receive an error code here.
3035 */
3036 if (r == EFI_SUCCESS)
3037 ++connected;
3038 }
3039 }
3040 }
3041 }
3042
3043 /*
3044 * TODO: Some overrides are not yet implemented:
3045 * - Platform Driver Override
3046 * - Driver Family Override Search
3047 * - Bus Specific Driver Override
3048 */
3049
3050 /* Driver Binding Search */
3051 for (i = 0; i < count; ++i) {
3052 if (buffer[i]) {
3053 r = efi_bind_controller(controller_handle,
3054 buffer[i],
3055 remain_device_path);
3056 if (r == EFI_SUCCESS)
3057 ++connected;
3058 }
3059 }
3060
3061 efi_free_pool(buffer);
3062 if (!connected)
3063 return EFI_NOT_FOUND;
3064 return EFI_SUCCESS;
3065}
3066
3067/**
3068 * efi_connect_controller() - connect a controller to a driver
3069 * @controller_handle: handle of the controller
3070 * @driver_image_handle: handle of the driver
3071 * @remain_device_path: device path of a child controller
3072 * @recursive: true to connect all child controllers
3073 *
3074 * This function implements the ConnectController service.
3075 *
3076 * See the Unified Extensible Firmware Interface (UEFI) specification for
3077 * details.
3078 *
3079 * First all driver binding protocol handles are tried for binding drivers.
3080 * Afterwards all handles that have opened a protocol of the controller
3081 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3082 *
3083 * Return: status code
3084 */
3085static efi_status_t EFIAPI efi_connect_controller(
3086 efi_handle_t controller_handle,
3087 efi_handle_t *driver_image_handle,
3088 struct efi_device_path *remain_device_path,
3089 bool recursive)
3090{
3091 efi_status_t r;
3092 efi_status_t ret = EFI_NOT_FOUND;
3093 struct efi_object *efiobj;
3094
3095 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3096 remain_device_path, recursive);
3097
3098 efiobj = efi_search_obj(controller_handle);
3099 if (!efiobj) {
3100 ret = EFI_INVALID_PARAMETER;
3101 goto out;
3102 }
3103
3104 r = efi_connect_single_controller(controller_handle,
3105 driver_image_handle,
3106 remain_device_path);
3107 if (r == EFI_SUCCESS)
3108 ret = EFI_SUCCESS;
3109 if (recursive) {
3110 struct efi_handler *handler;
3111 struct efi_open_protocol_info_item *item;
3112
3113 list_for_each_entry(handler, &efiobj->protocols, link) {
3114 list_for_each_entry(item, &handler->open_infos, link) {
3115 if (item->info.attributes &
3116 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3117 r = EFI_CALL(efi_connect_controller(
3118 item->info.controller_handle,
3119 driver_image_handle,
3120 remain_device_path,
3121 recursive));
3122 if (r == EFI_SUCCESS)
3123 ret = EFI_SUCCESS;
3124 }
3125 }
3126 }
3127 }
3128 /* Check for child controller specified by end node */
3129 if (ret != EFI_SUCCESS && remain_device_path &&
3130 remain_device_path->type == DEVICE_PATH_TYPE_END)
3131 ret = EFI_SUCCESS;
3132out:
3133 return EFI_EXIT(ret);
3134}
3135
3136/**
3137 * efi_reinstall_protocol_interface() - reinstall protocol interface
3138 * @handle: handle on which the protocol shall be reinstalled
3139 * @protocol: GUID of the protocol to be installed
3140 * @old_interface: interface to be removed
3141 * @new_interface: interface to be installed
3142 *
3143 * This function implements the ReinstallProtocolInterface service.
3144 *
3145 * See the Unified Extensible Firmware Interface (UEFI) specification for
3146 * details.
3147 *
3148 * The old interface is uninstalled. The new interface is installed.
3149 * Drivers are connected.
3150 *
3151 * Return: status code
3152 */
3153static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3154 efi_handle_t handle, const efi_guid_t *protocol,
3155 void *old_interface, void *new_interface)
3156{
3157 efi_status_t ret;
3158
3159 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3160 new_interface);
3161
3162 /* Uninstall protocol but do not delete handle */
3163 ret = efi_uninstall_protocol(handle, protocol, old_interface);
3164 if (ret != EFI_SUCCESS)
3165 goto out;
3166
3167 /* Install the new protocol */
3168 ret = efi_add_protocol(handle, protocol, new_interface);
3169 /*
3170 * The UEFI spec does not specify what should happen to the handle
3171 * if in case of an error no protocol interface remains on the handle.
3172 * So let's do nothing here.
3173 */
3174 if (ret != EFI_SUCCESS)
3175 goto out;
3176 /*
3177 * The returned status code has to be ignored.
3178 * Do not create an error if no suitable driver for the handle exists.
3179 */
3180 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3181out:
3182 return EFI_EXIT(ret);
3183}
3184
3185/**
3186 * efi_get_child_controllers() - get all child controllers associated to a driver
3187 * @efiobj: handle of the controller
3188 * @driver_handle: handle of the driver
3189 * @number_of_children: number of child controllers
3190 * @child_handle_buffer: handles of the the child controllers
3191 *
3192 * The allocated buffer has to be freed with free().
3193 *
3194 * Return: status code
3195 */
3196static efi_status_t efi_get_child_controllers(
3197 struct efi_object *efiobj,
3198 efi_handle_t driver_handle,
3199 efi_uintn_t *number_of_children,
3200 efi_handle_t **child_handle_buffer)
3201{
3202 struct efi_handler *handler;
3203 struct efi_open_protocol_info_item *item;
3204 efi_uintn_t count = 0, i;
3205 bool duplicate;
3206
3207 /* Count all child controller associations */
3208 list_for_each_entry(handler, &efiobj->protocols, link) {
3209 list_for_each_entry(item, &handler->open_infos, link) {
3210 if (item->info.agent_handle == driver_handle &&
3211 item->info.attributes &
3212 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3213 ++count;
3214 }
3215 }
3216 /*
3217 * Create buffer. In case of duplicate child controller assignments
3218 * the buffer will be too large. But that does not harm.
3219 */
3220 *number_of_children = 0;
3221 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3222 if (!*child_handle_buffer)
3223 return EFI_OUT_OF_RESOURCES;
3224 /* Copy unique child handles */
3225 list_for_each_entry(handler, &efiobj->protocols, link) {
3226 list_for_each_entry(item, &handler->open_infos, link) {
3227 if (item->info.agent_handle == driver_handle &&
3228 item->info.attributes &
3229 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3230 /* Check this is a new child controller */
3231 duplicate = false;
3232 for (i = 0; i < *number_of_children; ++i) {
3233 if ((*child_handle_buffer)[i] ==
3234 item->info.controller_handle)
3235 duplicate = true;
3236 }
3237 /* Copy handle to buffer */
3238 if (!duplicate) {
3239 i = (*number_of_children)++;
3240 (*child_handle_buffer)[i] =
3241 item->info.controller_handle;
3242 }
3243 }
3244 }
3245 }
3246 return EFI_SUCCESS;
3247}
3248
3249/**
3250 * efi_disconnect_controller() - disconnect a controller from a driver
3251 * @controller_handle: handle of the controller
3252 * @driver_image_handle: handle of the driver
3253 * @child_handle: handle of the child to destroy
3254 *
3255 * This function implements the DisconnectController service.
3256 *
3257 * See the Unified Extensible Firmware Interface (UEFI) specification for
3258 * details.
3259 *
3260 * Return: status code
3261 */
3262static efi_status_t EFIAPI efi_disconnect_controller(
3263 efi_handle_t controller_handle,
3264 efi_handle_t driver_image_handle,
3265 efi_handle_t child_handle)
3266{
3267 struct efi_driver_binding_protocol *binding_protocol;
3268 efi_handle_t *child_handle_buffer = NULL;
3269 size_t number_of_children = 0;
3270 efi_status_t r;
3271 size_t stop_count = 0;
3272 struct efi_object *efiobj;
3273
3274 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3275 child_handle);
3276
3277 efiobj = efi_search_obj(controller_handle);
3278 if (!efiobj) {
3279 r = EFI_INVALID_PARAMETER;
3280 goto out;
3281 }
3282
3283 if (child_handle && !efi_search_obj(child_handle)) {
3284 r = EFI_INVALID_PARAMETER;
3285 goto out;
3286 }
3287
3288 /* If no driver handle is supplied, disconnect all drivers */
3289 if (!driver_image_handle) {
3290 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3291 goto out;
3292 }
3293
3294 /* Create list of child handles */
3295 if (child_handle) {
3296 number_of_children = 1;
3297 child_handle_buffer = &child_handle;
3298 } else {
3299 efi_get_child_controllers(efiobj,
3300 driver_image_handle,
3301 &number_of_children,
3302 &child_handle_buffer);
3303 }
3304
3305 /* Get the driver binding protocol */
3306 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3307 &efi_guid_driver_binding_protocol,
3308 (void **)&binding_protocol,
3309 driver_image_handle, NULL,
3310 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3311 if (r != EFI_SUCCESS)
3312 goto out;
3313 /* Remove the children */
3314 if (number_of_children) {
3315 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3316 controller_handle,
3317 number_of_children,
3318 child_handle_buffer));
3319 if (r == EFI_SUCCESS)
3320 ++stop_count;
3321 }
3322 /* Remove the driver */
3323 if (!child_handle)
3324 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3325 controller_handle,
3326 0, NULL));
3327 if (r == EFI_SUCCESS)
3328 ++stop_count;
3329 EFI_CALL(efi_close_protocol(driver_image_handle,
3330 &efi_guid_driver_binding_protocol,
3331 driver_image_handle, NULL));
3332
3333 if (stop_count)
3334 r = EFI_SUCCESS;
3335 else
3336 r = EFI_NOT_FOUND;
3337out:
3338 if (!child_handle)
3339 free(child_handle_buffer);
3340 return EFI_EXIT(r);
3341}
3342
3343static struct efi_boot_services efi_boot_services = {
3344 .hdr = {
3345 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3346 .revision = EFI_SPECIFICATION_VERSION,
3347 .headersize = sizeof(struct efi_boot_services),
3348 },
3349 .raise_tpl = efi_raise_tpl,
3350 .restore_tpl = efi_restore_tpl,
3351 .allocate_pages = efi_allocate_pages_ext,
3352 .free_pages = efi_free_pages_ext,
3353 .get_memory_map = efi_get_memory_map_ext,
3354 .allocate_pool = efi_allocate_pool_ext,
3355 .free_pool = efi_free_pool_ext,
3356 .create_event = efi_create_event_ext,
3357 .set_timer = efi_set_timer_ext,
3358 .wait_for_event = efi_wait_for_event,
3359 .signal_event = efi_signal_event_ext,
3360 .close_event = efi_close_event,
3361 .check_event = efi_check_event,
3362 .install_protocol_interface = efi_install_protocol_interface,
3363 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3364 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3365 .handle_protocol = efi_handle_protocol,
3366 .reserved = NULL,
3367 .register_protocol_notify = efi_register_protocol_notify,
3368 .locate_handle = efi_locate_handle_ext,
3369 .locate_device_path = efi_locate_device_path,
3370 .install_configuration_table = efi_install_configuration_table_ext,
3371 .load_image = efi_load_image,
3372 .start_image = efi_start_image,
3373 .exit = efi_exit,
3374 .unload_image = efi_unload_image,
3375 .exit_boot_services = efi_exit_boot_services,
3376 .get_next_monotonic_count = efi_get_next_monotonic_count,
3377 .stall = efi_stall,
3378 .set_watchdog_timer = efi_set_watchdog_timer,
3379 .connect_controller = efi_connect_controller,
3380 .disconnect_controller = efi_disconnect_controller,
3381 .open_protocol = efi_open_protocol,
3382 .close_protocol = efi_close_protocol,
3383 .open_protocol_information = efi_open_protocol_information,
3384 .protocols_per_handle = efi_protocols_per_handle,
3385 .locate_handle_buffer = efi_locate_handle_buffer,
3386 .locate_protocol = efi_locate_protocol,
3387 .install_multiple_protocol_interfaces =
3388 efi_install_multiple_protocol_interfaces,
3389 .uninstall_multiple_protocol_interfaces =
3390 efi_uninstall_multiple_protocol_interfaces,
3391 .calculate_crc32 = efi_calculate_crc32,
3392 .copy_mem = efi_copy_mem,
3393 .set_mem = efi_set_mem,
3394 .create_event_ex = efi_create_event_ex,
3395};
3396
3397static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3398
3399struct efi_system_table __efi_runtime_data systab = {
3400 .hdr = {
3401 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3402 .revision = EFI_SPECIFICATION_VERSION,
3403 .headersize = sizeof(struct efi_system_table),
3404 },
3405 .fw_vendor = firmware_vendor,
3406 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3407 .con_in = (void *)&efi_con_in,
3408 .con_out = (void *)&efi_con_out,
3409 .std_err = (void *)&efi_con_out,
3410 .runtime = (void *)&efi_runtime_services,
3411 .boottime = (void *)&efi_boot_services,
3412 .nr_tables = 0,
3413 .tables = NULL,
3414};
3415
3416/**
3417 * efi_initialize_system_table() - Initialize system table
3418 *
3419 * Return: status code
3420 */
3421efi_status_t efi_initialize_system_table(void)
3422{
3423 efi_status_t ret;
3424
3425 /* Allocate configuration table array */
3426 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3427 EFI_MAX_CONFIGURATION_TABLES *
3428 sizeof(struct efi_configuration_table),
3429 (void **)&systab.tables);
3430
3431 /* Set CRC32 field in table headers */
3432 efi_update_table_header_crc32(&systab.hdr);
3433 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3434 efi_update_table_header_crc32(&efi_boot_services.hdr);
3435
3436 return ret;
3437}