]> git.sur5r.net Git - u-boot/blob - lib/efi_loader/efi_boottime.c
efi_loader: fix signature of efi_disconnect_controller
[u-boot] / lib / efi_loader / efi_boottime.c
1 /*
2  *  EFI application boot time services
3  *
4  *  Copyright (c) 2016 Alexander Graf
5  *
6  *  SPDX-License-Identifier:     GPL-2.0+
7  */
8
9 #include <common.h>
10 #include <div64.h>
11 #include <efi_loader.h>
12 #include <environment.h>
13 #include <malloc.h>
14 #include <asm/global_data.h>
15 #include <libfdt_env.h>
16 #include <u-boot/crc.h>
17 #include <bootm.h>
18 #include <inttypes.h>
19 #include <watchdog.h>
20
21 DECLARE_GLOBAL_DATA_PTR;
22
23 /* Task priority level */
24 static efi_uintn_t efi_tpl = TPL_APPLICATION;
25
26 /* This list contains all the EFI objects our payload has access to */
27 LIST_HEAD(efi_obj_list);
28
29 /*
30  * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
31  * we need to do trickery with caches. Since we don't want to break the EFI
32  * aware boot path, only apply hacks when loading exiting directly (breaking
33  * direct Linux EFI booting along the way - oh well).
34  */
35 static bool efi_is_direct_boot = true;
36
37 /*
38  * EFI can pass arbitrary additional "tables" containing vendor specific
39  * information to the payload. One such table is the FDT table which contains
40  * a pointer to a flattened device tree blob.
41  *
42  * In most cases we want to pass an FDT to the payload, so reserve one slot of
43  * config table space for it. The pointer gets populated by do_bootefi_exec().
44  */
45 static struct efi_configuration_table __efi_runtime_data efi_conf_table[2];
46
47 #ifdef CONFIG_ARM
48 /*
49  * The "gd" pointer lives in a register on ARM and AArch64 that we declare
50  * fixed when compiling U-Boot. However, the payload does not know about that
51  * restriction so we need to manually swap its and our view of that register on
52  * EFI callback entry/exit.
53  */
54 static volatile void *efi_gd, *app_gd;
55 #endif
56
57 static int entry_count;
58 static int nesting_level;
59 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60 const efi_guid_t efi_guid_driver_binding_protocol =
61                         EFI_DRIVER_BINDING_PROTOCOL_GUID;
62
63 /* Called on every callback entry */
64 int __efi_entry_check(void)
65 {
66         int ret = entry_count++ == 0;
67 #ifdef CONFIG_ARM
68         assert(efi_gd);
69         app_gd = gd;
70         gd = efi_gd;
71 #endif
72         return ret;
73 }
74
75 /* Called on every callback exit */
76 int __efi_exit_check(void)
77 {
78         int ret = --entry_count == 0;
79 #ifdef CONFIG_ARM
80         gd = app_gd;
81 #endif
82         return ret;
83 }
84
85 /* Called from do_bootefi_exec() */
86 void efi_save_gd(void)
87 {
88 #ifdef CONFIG_ARM
89         efi_gd = gd;
90 #endif
91 }
92
93 /*
94  * Special case handler for error/abort that just forces things back
95  * to u-boot world so we can dump out an abort msg, without any care
96  * about returning back to UEFI world.
97  */
98 void efi_restore_gd(void)
99 {
100 #ifdef CONFIG_ARM
101         /* Only restore if we're already in EFI context */
102         if (!efi_gd)
103                 return;
104         gd = efi_gd;
105 #endif
106 }
107
108 /*
109  * Two spaces per indent level, maxing out at 10.. which ought to be
110  * enough for anyone ;-)
111  */
112 static const char *indent_string(int level)
113 {
114         const char *indent = "                    ";
115         const int max = strlen(indent);
116         level = min(max, level * 2);
117         return &indent[max - level];
118 }
119
120 const char *__efi_nesting(void)
121 {
122         return indent_string(nesting_level);
123 }
124
125 const char *__efi_nesting_inc(void)
126 {
127         return indent_string(nesting_level++);
128 }
129
130 const char *__efi_nesting_dec(void)
131 {
132         return indent_string(--nesting_level);
133 }
134
135 /*
136  * Queue an EFI event.
137  *
138  * This function queues the notification function of the event for future
139  * execution.
140  *
141  * The notification function is called if the task priority level of the
142  * event is higher than the current task priority level.
143  *
144  * For the SignalEvent service see efi_signal_event_ext.
145  *
146  * @event       event to signal
147  */
148 void efi_signal_event(struct efi_event *event)
149 {
150         if (event->notify_function) {
151                 event->is_queued = true;
152                 /* Check TPL */
153                 if (efi_tpl >= event->notify_tpl)
154                         return;
155                 EFI_CALL_VOID(event->notify_function(event,
156                                                      event->notify_context));
157         }
158         event->is_queued = false;
159 }
160
161 /*
162  * Raise the task priority level.
163  *
164  * This function implements the RaiseTpl service.
165  * See the Unified Extensible Firmware Interface (UEFI) specification
166  * for details.
167  *
168  * @new_tpl     new value of the task priority level
169  * @return      old value of the task priority level
170  */
171 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
172 {
173         efi_uintn_t old_tpl = efi_tpl;
174
175         EFI_ENTRY("0x%zx", new_tpl);
176
177         if (new_tpl < efi_tpl)
178                 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
179         efi_tpl = new_tpl;
180         if (efi_tpl > TPL_HIGH_LEVEL)
181                 efi_tpl = TPL_HIGH_LEVEL;
182
183         EFI_EXIT(EFI_SUCCESS);
184         return old_tpl;
185 }
186
187 /*
188  * Lower the task priority level.
189  *
190  * This function implements the RestoreTpl service.
191  * See the Unified Extensible Firmware Interface (UEFI) specification
192  * for details.
193  *
194  * @old_tpl     value of the task priority level to be restored
195  */
196 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
197 {
198         EFI_ENTRY("0x%zx", old_tpl);
199
200         if (old_tpl > efi_tpl)
201                 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
202         efi_tpl = old_tpl;
203         if (efi_tpl > TPL_HIGH_LEVEL)
204                 efi_tpl = TPL_HIGH_LEVEL;
205
206         EFI_EXIT(EFI_SUCCESS);
207 }
208
209 /*
210  * Allocate memory pages.
211  *
212  * This function implements the AllocatePages service.
213  * See the Unified Extensible Firmware Interface (UEFI) specification
214  * for details.
215  *
216  * @type                type of allocation to be performed
217  * @memory_type         usage type of the allocated memory
218  * @pages               number of pages to be allocated
219  * @memory              allocated memory
220  * @return              status code
221  */
222 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
223                                                   efi_uintn_t pages,
224                                                   uint64_t *memory)
225 {
226         efi_status_t r;
227
228         EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
229         r = efi_allocate_pages(type, memory_type, pages, memory);
230         return EFI_EXIT(r);
231 }
232
233 /*
234  * Free memory pages.
235  *
236  * This function implements the FreePages service.
237  * See the Unified Extensible Firmware Interface (UEFI) specification
238  * for details.
239  *
240  * @memory      start of the memory area to be freed
241  * @pages       number of pages to be freed
242  * @return      status code
243  */
244 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
245                                               efi_uintn_t pages)
246 {
247         efi_status_t r;
248
249         EFI_ENTRY("%"PRIx64", 0x%zx", memory, pages);
250         r = efi_free_pages(memory, pages);
251         return EFI_EXIT(r);
252 }
253
254 /*
255  * Get map describing memory usage.
256  *
257  * This function implements the GetMemoryMap service.
258  * See the Unified Extensible Firmware Interface (UEFI) specification
259  * for details.
260  *
261  * @memory_map_size     on entry the size, in bytes, of the memory map buffer,
262  *                      on exit the size of the copied memory map
263  * @memory_map          buffer to which the memory map is written
264  * @map_key             key for the memory map
265  * @descriptor_size     size of an individual memory descriptor
266  * @descriptor_version  version number of the memory descriptor structure
267  * @return              status code
268  */
269 static efi_status_t EFIAPI efi_get_memory_map_ext(
270                                         efi_uintn_t *memory_map_size,
271                                         struct efi_mem_desc *memory_map,
272                                         efi_uintn_t *map_key,
273                                         efi_uintn_t *descriptor_size,
274                                         uint32_t *descriptor_version)
275 {
276         efi_status_t r;
277
278         EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
279                   map_key, descriptor_size, descriptor_version);
280         r = efi_get_memory_map(memory_map_size, memory_map, map_key,
281                                descriptor_size, descriptor_version);
282         return EFI_EXIT(r);
283 }
284
285 /*
286  * Allocate memory from pool.
287  *
288  * This function implements the AllocatePool service.
289  * See the Unified Extensible Firmware Interface (UEFI) specification
290  * for details.
291  *
292  * @pool_type   type of the pool from which memory is to be allocated
293  * @size        number of bytes to be allocated
294  * @buffer      allocated memory
295  * @return      status code
296  */
297 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
298                                                  efi_uintn_t size,
299                                                  void **buffer)
300 {
301         efi_status_t r;
302
303         EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
304         r = efi_allocate_pool(pool_type, size, buffer);
305         return EFI_EXIT(r);
306 }
307
308 /*
309  * Free memory from pool.
310  *
311  * This function implements the FreePool service.
312  * See the Unified Extensible Firmware Interface (UEFI) specification
313  * for details.
314  *
315  * @buffer      start of memory to be freed
316  * @return      status code
317  */
318 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
319 {
320         efi_status_t r;
321
322         EFI_ENTRY("%p", buffer);
323         r = efi_free_pool(buffer);
324         return EFI_EXIT(r);
325 }
326
327 /*
328  * Add a new object to the object list.
329  *
330  * The protocols list is initialized.
331  * The object handle is set.
332  *
333  * @obj object to be added
334  */
335 void efi_add_handle(struct efi_object *obj)
336 {
337         if (!obj)
338                 return;
339         INIT_LIST_HEAD(&obj->protocols);
340         obj->handle = obj;
341         list_add_tail(&obj->link, &efi_obj_list);
342 }
343
344 /*
345  * Create handle.
346  *
347  * @handle      new handle
348  * @return      status code
349  */
350 efi_status_t efi_create_handle(void **handle)
351 {
352         struct efi_object *obj;
353         efi_status_t r;
354
355         r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
356                               sizeof(struct efi_object),
357                               (void **)&obj);
358         if (r != EFI_SUCCESS)
359                 return r;
360         efi_add_handle(obj);
361         *handle = obj->handle;
362         return r;
363 }
364
365 /*
366  * Find a protocol on a handle.
367  *
368  * @handle              handle
369  * @protocol_guid       GUID of the protocol
370  * @handler             reference to the protocol
371  * @return              status code
372  */
373 efi_status_t efi_search_protocol(const void *handle,
374                                  const efi_guid_t *protocol_guid,
375                                  struct efi_handler **handler)
376 {
377         struct efi_object *efiobj;
378         struct list_head *lhandle;
379
380         if (!handle || !protocol_guid)
381                 return EFI_INVALID_PARAMETER;
382         efiobj = efi_search_obj(handle);
383         if (!efiobj)
384                 return EFI_INVALID_PARAMETER;
385         list_for_each(lhandle, &efiobj->protocols) {
386                 struct efi_handler *protocol;
387
388                 protocol = list_entry(lhandle, struct efi_handler, link);
389                 if (!guidcmp(protocol->guid, protocol_guid)) {
390                         if (handler)
391                                 *handler = protocol;
392                         return EFI_SUCCESS;
393                 }
394         }
395         return EFI_NOT_FOUND;
396 }
397
398 /*
399  * Delete protocol from a handle.
400  *
401  * @handle                      handle from which the protocol shall be deleted
402  * @protocol                    GUID of the protocol to be deleted
403  * @protocol_interface          interface of the protocol implementation
404  * @return                      status code
405  */
406 efi_status_t efi_remove_protocol(const void *handle, const efi_guid_t *protocol,
407                                  void *protocol_interface)
408 {
409         struct efi_handler *handler;
410         efi_status_t ret;
411
412         ret = efi_search_protocol(handle, protocol, &handler);
413         if (ret != EFI_SUCCESS)
414                 return ret;
415         if (guidcmp(handler->guid, protocol))
416                 return EFI_INVALID_PARAMETER;
417         list_del(&handler->link);
418         free(handler);
419         return EFI_SUCCESS;
420 }
421
422 /*
423  * Delete all protocols from a handle.
424  *
425  * @handle      handle from which the protocols shall be deleted
426  * @return      status code
427  */
428 efi_status_t efi_remove_all_protocols(const void *handle)
429 {
430         struct efi_object *efiobj;
431         struct efi_handler *protocol;
432         struct efi_handler *pos;
433
434         efiobj = efi_search_obj(handle);
435         if (!efiobj)
436                 return EFI_INVALID_PARAMETER;
437         list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
438                 efi_status_t ret;
439
440                 ret = efi_remove_protocol(handle, protocol->guid,
441                                           protocol->protocol_interface);
442                 if (ret != EFI_SUCCESS)
443                         return ret;
444         }
445         return EFI_SUCCESS;
446 }
447
448 /*
449  * Delete handle.
450  *
451  * @handle      handle to delete
452  */
453 void efi_delete_handle(struct efi_object *obj)
454 {
455         if (!obj)
456                 return;
457         efi_remove_all_protocols(obj->handle);
458         list_del(&obj->link);
459         free(obj);
460 }
461
462 /*
463  * Our event capabilities are very limited. Only a small limited
464  * number of events is allowed to coexist.
465  */
466 static struct efi_event efi_events[16];
467
468 /*
469  * Create an event.
470  *
471  * This function is used inside U-Boot code to create an event.
472  *
473  * For the API function implementing the CreateEvent service see
474  * efi_create_event_ext.
475  *
476  * @type                type of the event to create
477  * @notify_tpl          task priority level of the event
478  * @notify_function     notification function of the event
479  * @notify_context      pointer passed to the notification function
480  * @event               created event
481  * @return              status code
482  */
483 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
484                               void (EFIAPI *notify_function) (
485                                         struct efi_event *event,
486                                         void *context),
487                               void *notify_context, struct efi_event **event)
488 {
489         int i;
490
491         if (event == NULL)
492                 return EFI_INVALID_PARAMETER;
493
494         if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
495                 return EFI_INVALID_PARAMETER;
496
497         if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
498             notify_function == NULL)
499                 return EFI_INVALID_PARAMETER;
500
501         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
502                 if (efi_events[i].type)
503                         continue;
504                 efi_events[i].type = type;
505                 efi_events[i].notify_tpl = notify_tpl;
506                 efi_events[i].notify_function = notify_function;
507                 efi_events[i].notify_context = notify_context;
508                 /* Disable timers on bootup */
509                 efi_events[i].trigger_next = -1ULL;
510                 efi_events[i].is_queued = false;
511                 efi_events[i].is_signaled = false;
512                 *event = &efi_events[i];
513                 return EFI_SUCCESS;
514         }
515         return EFI_OUT_OF_RESOURCES;
516 }
517
518 /*
519  * Create an event.
520  *
521  * This function implements the CreateEvent service.
522  * See the Unified Extensible Firmware Interface (UEFI) specification
523  * for details.
524  *
525  * @type                type of the event to create
526  * @notify_tpl          task priority level of the event
527  * @notify_function     notification function of the event
528  * @notify_context      pointer passed to the notification function
529  * @event               created event
530  * @return              status code
531  */
532 static efi_status_t EFIAPI efi_create_event_ext(
533                         uint32_t type, efi_uintn_t notify_tpl,
534                         void (EFIAPI *notify_function) (
535                                         struct efi_event *event,
536                                         void *context),
537                         void *notify_context, struct efi_event **event)
538 {
539         EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
540                   notify_context);
541         return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
542                                          notify_context, event));
543 }
544
545
546 /*
547  * Check if a timer event has occurred or a queued notification function should
548  * be called.
549  *
550  * Our timers have to work without interrupts, so we check whenever keyboard
551  * input or disk accesses happen if enough time elapsed for them to fire.
552  */
553 void efi_timer_check(void)
554 {
555         int i;
556         u64 now = timer_get_us();
557
558         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
559                 if (!efi_events[i].type)
560                         continue;
561                 if (efi_events[i].is_queued)
562                         efi_signal_event(&efi_events[i]);
563                 if (!(efi_events[i].type & EVT_TIMER) ||
564                     now < efi_events[i].trigger_next)
565                         continue;
566                 switch (efi_events[i].trigger_type) {
567                 case EFI_TIMER_RELATIVE:
568                         efi_events[i].trigger_type = EFI_TIMER_STOP;
569                         break;
570                 case EFI_TIMER_PERIODIC:
571                         efi_events[i].trigger_next +=
572                                 efi_events[i].trigger_time;
573                         break;
574                 default:
575                         continue;
576                 }
577                 efi_events[i].is_signaled = true;
578                 efi_signal_event(&efi_events[i]);
579         }
580         WATCHDOG_RESET();
581 }
582
583 /*
584  * Set the trigger time for a timer event or stop the event.
585  *
586  * This is the function for internal usage in U-Boot. For the API function
587  * implementing the SetTimer service see efi_set_timer_ext.
588  *
589  * @event               event for which the timer is set
590  * @type                type of the timer
591  * @trigger_time        trigger period in multiples of 100ns
592  * @return              status code
593  */
594 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
595                            uint64_t trigger_time)
596 {
597         int i;
598
599         /*
600          * The parameter defines a multiple of 100ns.
601          * We use multiples of 1000ns. So divide by 10.
602          */
603         do_div(trigger_time, 10);
604
605         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
606                 if (event != &efi_events[i])
607                         continue;
608
609                 if (!(event->type & EVT_TIMER))
610                         break;
611                 switch (type) {
612                 case EFI_TIMER_STOP:
613                         event->trigger_next = -1ULL;
614                         break;
615                 case EFI_TIMER_PERIODIC:
616                 case EFI_TIMER_RELATIVE:
617                         event->trigger_next =
618                                 timer_get_us() + trigger_time;
619                         break;
620                 default:
621                         return EFI_INVALID_PARAMETER;
622                 }
623                 event->trigger_type = type;
624                 event->trigger_time = trigger_time;
625                 event->is_signaled = false;
626                 return EFI_SUCCESS;
627         }
628         return EFI_INVALID_PARAMETER;
629 }
630
631 /*
632  * Set the trigger time for a timer event or stop the event.
633  *
634  * This function implements the SetTimer service.
635  * See the Unified Extensible Firmware Interface (UEFI) specification
636  * for details.
637  *
638  * @event               event for which the timer is set
639  * @type                type of the timer
640  * @trigger_time        trigger period in multiples of 100ns
641  * @return              status code
642  */
643 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
644                                              enum efi_timer_delay type,
645                                              uint64_t trigger_time)
646 {
647         EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
648         return EFI_EXIT(efi_set_timer(event, type, trigger_time));
649 }
650
651 /*
652  * Wait for events to be signaled.
653  *
654  * This function implements the WaitForEvent service.
655  * See the Unified Extensible Firmware Interface (UEFI) specification
656  * for details.
657  *
658  * @num_events  number of events to be waited for
659  * @events      events to be waited for
660  * @index       index of the event that was signaled
661  * @return      status code
662  */
663 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
664                                               struct efi_event **event,
665                                               efi_uintn_t *index)
666 {
667         int i, j;
668
669         EFI_ENTRY("%zd, %p, %p", num_events, event, index);
670
671         /* Check parameters */
672         if (!num_events || !event)
673                 return EFI_EXIT(EFI_INVALID_PARAMETER);
674         /* Check TPL */
675         if (efi_tpl != TPL_APPLICATION)
676                 return EFI_EXIT(EFI_UNSUPPORTED);
677         for (i = 0; i < num_events; ++i) {
678                 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
679                         if (event[i] == &efi_events[j])
680                                 goto known_event;
681                 }
682                 return EFI_EXIT(EFI_INVALID_PARAMETER);
683 known_event:
684                 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
685                         return EFI_EXIT(EFI_INVALID_PARAMETER);
686                 if (!event[i]->is_signaled)
687                         efi_signal_event(event[i]);
688         }
689
690         /* Wait for signal */
691         for (;;) {
692                 for (i = 0; i < num_events; ++i) {
693                         if (event[i]->is_signaled)
694                                 goto out;
695                 }
696                 /* Allow events to occur. */
697                 efi_timer_check();
698         }
699
700 out:
701         /*
702          * Reset the signal which is passed to the caller to allow periodic
703          * events to occur.
704          */
705         event[i]->is_signaled = false;
706         if (index)
707                 *index = i;
708
709         return EFI_EXIT(EFI_SUCCESS);
710 }
711
712 /*
713  * Signal an EFI event.
714  *
715  * This function implements the SignalEvent service.
716  * See the Unified Extensible Firmware Interface (UEFI) specification
717  * for details.
718  *
719  * This functions sets the signaled state of the event and queues the
720  * notification function for execution.
721  *
722  * @event       event to signal
723  * @return      status code
724  */
725 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
726 {
727         int i;
728
729         EFI_ENTRY("%p", event);
730         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
731                 if (event != &efi_events[i])
732                         continue;
733                 if (event->is_signaled)
734                         break;
735                 event->is_signaled = true;
736                 if (event->type & EVT_NOTIFY_SIGNAL)
737                         efi_signal_event(event);
738                 break;
739         }
740         return EFI_EXIT(EFI_SUCCESS);
741 }
742
743 /*
744  * Close an EFI event.
745  *
746  * This function implements the CloseEvent service.
747  * See the Unified Extensible Firmware Interface (UEFI) specification
748  * for details.
749  *
750  * @event       event to close
751  * @return      status code
752  */
753 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
754 {
755         int i;
756
757         EFI_ENTRY("%p", event);
758         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
759                 if (event == &efi_events[i]) {
760                         event->type = 0;
761                         event->trigger_next = -1ULL;
762                         event->is_queued = false;
763                         event->is_signaled = false;
764                         return EFI_EXIT(EFI_SUCCESS);
765                 }
766         }
767         return EFI_EXIT(EFI_INVALID_PARAMETER);
768 }
769
770 /*
771  * Check if an event is signaled.
772  *
773  * This function implements the CheckEvent service.
774  * See the Unified Extensible Firmware Interface (UEFI) specification
775  * for details.
776  *
777  * If an event is not signaled yet the notification function is queued.
778  *
779  * @event       event to check
780  * @return      status code
781  */
782 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
783 {
784         int i;
785
786         EFI_ENTRY("%p", event);
787         efi_timer_check();
788         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
789                 if (event != &efi_events[i])
790                         continue;
791                 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
792                         break;
793                 if (!event->is_signaled)
794                         efi_signal_event(event);
795                 if (event->is_signaled)
796                         return EFI_EXIT(EFI_SUCCESS);
797                 return EFI_EXIT(EFI_NOT_READY);
798         }
799         return EFI_EXIT(EFI_INVALID_PARAMETER);
800 }
801
802 /*
803  * Find the internal EFI object for a handle.
804  *
805  * @handle      handle to find
806  * @return      EFI object
807  */
808 struct efi_object *efi_search_obj(const void *handle)
809 {
810         struct efi_object *efiobj;
811
812         list_for_each_entry(efiobj, &efi_obj_list, link) {
813                 if (efiobj->handle == handle)
814                         return efiobj;
815         }
816
817         return NULL;
818 }
819
820 /*
821  * Create open protocol info entry and add it to a protocol.
822  *
823  * @handler     handler of a protocol
824  * @return      open protocol info entry
825  */
826 static struct efi_open_protocol_info_entry *efi_create_open_info(
827                         struct efi_handler *handler)
828 {
829         struct efi_open_protocol_info_item *item;
830
831         item = calloc(1, sizeof(struct efi_open_protocol_info_item));
832         if (!item)
833                 return NULL;
834         /* Append the item to the open protocol info list. */
835         list_add_tail(&item->link, &handler->open_infos);
836
837         return &item->info;
838 }
839
840 /*
841  * Remove an open protocol info entry from a protocol.
842  *
843  * @handler     handler of a protocol
844  * @return      status code
845  */
846 static efi_status_t efi_delete_open_info(
847                         struct efi_open_protocol_info_item *item)
848 {
849         list_del(&item->link);
850         free(item);
851         return EFI_SUCCESS;
852 }
853
854 /*
855  * Install new protocol on a handle.
856  *
857  * @handle                      handle on which the protocol shall be installed
858  * @protocol                    GUID of the protocol to be installed
859  * @protocol_interface          interface of the protocol implementation
860  * @return                      status code
861  */
862 efi_status_t efi_add_protocol(const void *handle, const efi_guid_t *protocol,
863                               void *protocol_interface)
864 {
865         struct efi_object *efiobj;
866         struct efi_handler *handler;
867         efi_status_t ret;
868
869         efiobj = efi_search_obj(handle);
870         if (!efiobj)
871                 return EFI_INVALID_PARAMETER;
872         ret = efi_search_protocol(handle, protocol, NULL);
873         if (ret != EFI_NOT_FOUND)
874                 return EFI_INVALID_PARAMETER;
875         handler = calloc(1, sizeof(struct efi_handler));
876         if (!handler)
877                 return EFI_OUT_OF_RESOURCES;
878         handler->guid = protocol;
879         handler->protocol_interface = protocol_interface;
880         INIT_LIST_HEAD(&handler->open_infos);
881         list_add_tail(&handler->link, &efiobj->protocols);
882         if (!guidcmp(&efi_guid_device_path, protocol))
883                 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
884         return EFI_SUCCESS;
885 }
886
887 /*
888  * Install protocol interface.
889  *
890  * This function implements the InstallProtocolInterface service.
891  * See the Unified Extensible Firmware Interface (UEFI) specification
892  * for details.
893  *
894  * @handle                      handle on which the protocol shall be installed
895  * @protocol                    GUID of the protocol to be installed
896  * @protocol_interface_type     type of the interface to be installed,
897  *                              always EFI_NATIVE_INTERFACE
898  * @protocol_interface          interface of the protocol implementation
899  * @return                      status code
900  */
901 static efi_status_t EFIAPI efi_install_protocol_interface(
902                         void **handle, const efi_guid_t *protocol,
903                         int protocol_interface_type, void *protocol_interface)
904 {
905         efi_status_t r;
906
907         EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
908                   protocol_interface);
909
910         if (!handle || !protocol ||
911             protocol_interface_type != EFI_NATIVE_INTERFACE) {
912                 r = EFI_INVALID_PARAMETER;
913                 goto out;
914         }
915
916         /* Create new handle if requested. */
917         if (!*handle) {
918                 r = efi_create_handle(handle);
919                 if (r != EFI_SUCCESS)
920                         goto out;
921                 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
922                       *handle);
923         } else {
924                 debug("%sEFI: handle %p\n", indent_string(nesting_level),
925                       *handle);
926         }
927         /* Add new protocol */
928         r = efi_add_protocol(*handle, protocol, protocol_interface);
929 out:
930         return EFI_EXIT(r);
931 }
932
933 /*
934  * Reinstall protocol interface.
935  *
936  * This function implements the ReinstallProtocolInterface service.
937  * See the Unified Extensible Firmware Interface (UEFI) specification
938  * for details.
939  *
940  * @handle                      handle on which the protocol shall be
941  *                              reinstalled
942  * @protocol                    GUID of the protocol to be installed
943  * @old_interface               interface to be removed
944  * @new_interface               interface to be installed
945  * @return                      status code
946  */
947 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
948                         const efi_guid_t *protocol, void *old_interface,
949                         void *new_interface)
950 {
951         EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
952                   new_interface);
953         return EFI_EXIT(EFI_ACCESS_DENIED);
954 }
955
956 /*
957  * Uninstall protocol interface.
958  *
959  * This function implements the UninstallProtocolInterface service.
960  * See the Unified Extensible Firmware Interface (UEFI) specification
961  * for details.
962  *
963  * @handle                      handle from which the protocol shall be removed
964  * @protocol                    GUID of the protocol to be removed
965  * @protocol_interface          interface to be removed
966  * @return                      status code
967  */
968 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
969                                 void *handle, const efi_guid_t *protocol,
970                                 void *protocol_interface)
971 {
972         struct efi_handler *handler;
973         efi_status_t r;
974
975         EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
976
977         if (!handle || !protocol) {
978                 r = EFI_INVALID_PARAMETER;
979                 goto out;
980         }
981
982         /* Find the protocol on the handle */
983         r = efi_search_protocol(handle, protocol, &handler);
984         if (r != EFI_SUCCESS)
985                 goto out;
986         if (handler->protocol_interface) {
987                 /* TODO disconnect controllers */
988                 r =  EFI_ACCESS_DENIED;
989         } else {
990                 r = efi_remove_protocol(handle, protocol, protocol_interface);
991         }
992 out:
993         return EFI_EXIT(r);
994 }
995
996 /*
997  * Register an event for notification when a protocol is installed.
998  *
999  * This function implements the RegisterProtocolNotify service.
1000  * See the Unified Extensible Firmware Interface (UEFI) specification
1001  * for details.
1002  *
1003  * @protocol            GUID of the protocol whose installation shall be
1004  *                      notified
1005  * @event               event to be signaled upon installation of the protocol
1006  * @registration        key for retrieving the registration information
1007  * @return              status code
1008  */
1009 static efi_status_t EFIAPI efi_register_protocol_notify(
1010                                                 const efi_guid_t *protocol,
1011                                                 struct efi_event *event,
1012                                                 void **registration)
1013 {
1014         EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1015         return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1016 }
1017
1018 /*
1019  * Determine if an EFI handle implements a protocol.
1020  *
1021  * See the documentation of the LocateHandle service in the UEFI specification.
1022  *
1023  * @search_type         selection criterion
1024  * @protocol            GUID of the protocol
1025  * @search_key          registration key
1026  * @efiobj              handle
1027  * @return              0 if the handle implements the protocol
1028  */
1029 static int efi_search(enum efi_locate_search_type search_type,
1030                       const efi_guid_t *protocol, void *search_key,
1031                       struct efi_object *efiobj)
1032 {
1033         efi_status_t ret;
1034
1035         switch (search_type) {
1036         case ALL_HANDLES:
1037                 return 0;
1038         case BY_REGISTER_NOTIFY:
1039                 /* TODO: RegisterProtocolNotify is not implemented yet */
1040                 return -1;
1041         case BY_PROTOCOL:
1042                 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1043                 return (ret != EFI_SUCCESS);
1044         default:
1045                 /* Invalid search type */
1046                 return -1;
1047         }
1048 }
1049
1050 /*
1051  * Locate handles implementing a protocol.
1052  *
1053  * This function is meant for U-Boot internal calls. For the API implementation
1054  * of the LocateHandle service see efi_locate_handle_ext.
1055  *
1056  * @search_type         selection criterion
1057  * @protocol            GUID of the protocol
1058  * @search_key          registration key
1059  * @buffer_size         size of the buffer to receive the handles in bytes
1060  * @buffer              buffer to receive the relevant handles
1061  * @return              status code
1062  */
1063 static efi_status_t efi_locate_handle(
1064                         enum efi_locate_search_type search_type,
1065                         const efi_guid_t *protocol, void *search_key,
1066                         efi_uintn_t *buffer_size, efi_handle_t *buffer)
1067 {
1068         struct efi_object *efiobj;
1069         efi_uintn_t size = 0;
1070
1071         /* Check parameters */
1072         switch (search_type) {
1073         case ALL_HANDLES:
1074                 break;
1075         case BY_REGISTER_NOTIFY:
1076                 if (!search_key)
1077                         return EFI_INVALID_PARAMETER;
1078                 /* RegisterProtocolNotify is not implemented yet */
1079                 return EFI_UNSUPPORTED;
1080         case BY_PROTOCOL:
1081                 if (!protocol)
1082                         return EFI_INVALID_PARAMETER;
1083                 break;
1084         default:
1085                 return EFI_INVALID_PARAMETER;
1086         }
1087
1088         /*
1089          * efi_locate_handle_buffer uses this function for
1090          * the calculation of the necessary buffer size.
1091          * So do not require a buffer for buffersize == 0.
1092          */
1093         if (!buffer_size || (*buffer_size && !buffer))
1094                 return EFI_INVALID_PARAMETER;
1095
1096         /* Count how much space we need */
1097         list_for_each_entry(efiobj, &efi_obj_list, link) {
1098                 if (!efi_search(search_type, protocol, search_key, efiobj))
1099                         size += sizeof(void*);
1100         }
1101
1102         if (*buffer_size < size) {
1103                 *buffer_size = size;
1104                 return EFI_BUFFER_TOO_SMALL;
1105         }
1106
1107         *buffer_size = size;
1108         if (size == 0)
1109                 return EFI_NOT_FOUND;
1110
1111         /* Then fill the array */
1112         list_for_each_entry(efiobj, &efi_obj_list, link) {
1113                 if (!efi_search(search_type, protocol, search_key, efiobj))
1114                         *buffer++ = efiobj->handle;
1115         }
1116
1117         return EFI_SUCCESS;
1118 }
1119
1120 /*
1121  * Locate handles implementing a protocol.
1122  *
1123  * This function implements the LocateHandle service.
1124  * See the Unified Extensible Firmware Interface (UEFI) specification
1125  * for details.
1126  *
1127  * @search_type         selection criterion
1128  * @protocol            GUID of the protocol
1129  * @search_key          registration key
1130  * @buffer_size         size of the buffer to receive the handles in bytes
1131  * @buffer              buffer to receive the relevant handles
1132  * @return              0 if the handle implements the protocol
1133  */
1134 static efi_status_t EFIAPI efi_locate_handle_ext(
1135                         enum efi_locate_search_type search_type,
1136                         const efi_guid_t *protocol, void *search_key,
1137                         efi_uintn_t *buffer_size, efi_handle_t *buffer)
1138 {
1139         EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1140                   buffer_size, buffer);
1141
1142         return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1143                         buffer_size, buffer));
1144 }
1145
1146 /* Collapses configuration table entries, removing index i */
1147 static void efi_remove_configuration_table(int i)
1148 {
1149         struct efi_configuration_table *this = &efi_conf_table[i];
1150         struct efi_configuration_table *next = &efi_conf_table[i+1];
1151         struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1152
1153         memmove(this, next, (ulong)end - (ulong)next);
1154         systab.nr_tables--;
1155 }
1156
1157 /*
1158  * Adds, updates, or removes a configuration table.
1159  *
1160  * This function is used for internal calls. For the API implementation of the
1161  * InstallConfigurationTable service see efi_install_configuration_table_ext.
1162  *
1163  * @guid                GUID of the installed table
1164  * @table               table to be installed
1165  * @return              status code
1166  */
1167 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1168 {
1169         int i;
1170
1171         /* Check for guid override */
1172         for (i = 0; i < systab.nr_tables; i++) {
1173                 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1174                         if (table)
1175                                 efi_conf_table[i].table = table;
1176                         else
1177                                 efi_remove_configuration_table(i);
1178                         return EFI_SUCCESS;
1179                 }
1180         }
1181
1182         if (!table)
1183                 return EFI_NOT_FOUND;
1184
1185         /* No override, check for overflow */
1186         if (i >= ARRAY_SIZE(efi_conf_table))
1187                 return EFI_OUT_OF_RESOURCES;
1188
1189         /* Add a new entry */
1190         memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1191         efi_conf_table[i].table = table;
1192         systab.nr_tables = i + 1;
1193
1194         return EFI_SUCCESS;
1195 }
1196
1197 /*
1198  * Adds, updates, or removes a configuration table.
1199  *
1200  * This function implements the InstallConfigurationTable service.
1201  * See the Unified Extensible Firmware Interface (UEFI) specification
1202  * for details.
1203  *
1204  * @guid                GUID of the installed table
1205  * @table               table to be installed
1206  * @return              status code
1207  */
1208 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1209                                                                void *table)
1210 {
1211         EFI_ENTRY("%pUl, %p", guid, table);
1212         return EFI_EXIT(efi_install_configuration_table(guid, table));
1213 }
1214
1215 /*
1216  * Initialize a loaded_image_info + loaded_image_info object with correct
1217  * protocols, boot-device, etc.
1218  *
1219  * @info                loaded image info to be passed to the entry point of the
1220  *                      image
1221  * @obj                 internal object associated with the loaded image
1222  * @device_path         device path of the loaded image
1223  * @file_path           file path of the loaded image
1224  * @return              status code
1225  */
1226 efi_status_t efi_setup_loaded_image(
1227                         struct efi_loaded_image *info, struct efi_object *obj,
1228                         struct efi_device_path *device_path,
1229                         struct efi_device_path *file_path)
1230 {
1231         efi_status_t ret;
1232
1233         /* Add internal object to object list */
1234         efi_add_handle(obj);
1235         /* efi_exit() assumes that the handle points to the info */
1236         obj->handle = info;
1237
1238         info->file_path = file_path;
1239         if (device_path)
1240                 info->device_handle = efi_dp_find_obj(device_path, NULL);
1241
1242         /*
1243          * When asking for the device path interface, return
1244          * bootefi_device_path
1245          */
1246         ret = efi_add_protocol(obj->handle, &efi_guid_device_path, device_path);
1247         if (ret != EFI_SUCCESS)
1248                 goto failure;
1249
1250         /*
1251          * When asking for the loaded_image interface, just
1252          * return handle which points to loaded_image_info
1253          */
1254         ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1255         if (ret != EFI_SUCCESS)
1256                 goto failure;
1257
1258         ret = efi_add_protocol(obj->handle, &efi_guid_console_control,
1259                                (void *)&efi_console_control);
1260         if (ret != EFI_SUCCESS)
1261                 goto failure;
1262
1263         ret = efi_add_protocol(obj->handle,
1264                                &efi_guid_device_path_to_text_protocol,
1265                                (void *)&efi_device_path_to_text);
1266         if (ret != EFI_SUCCESS)
1267                 goto failure;
1268
1269         return ret;
1270 failure:
1271         printf("ERROR: Failure to install protocols for loaded image\n");
1272         return ret;
1273 }
1274
1275 /*
1276  * Load an image using a file path.
1277  *
1278  * @file_path           the path of the image to load
1279  * @buffer              buffer containing the loaded image
1280  * @return              status code
1281  */
1282 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1283                                       void **buffer)
1284 {
1285         struct efi_file_info *info = NULL;
1286         struct efi_file_handle *f;
1287         static efi_status_t ret;
1288         uint64_t bs;
1289
1290         f = efi_file_from_path(file_path);
1291         if (!f)
1292                 return EFI_DEVICE_ERROR;
1293
1294         bs = 0;
1295         EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1296                                   &bs, info));
1297         if (ret == EFI_BUFFER_TOO_SMALL) {
1298                 info = malloc(bs);
1299                 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1300                                           &bs, info));
1301         }
1302         if (ret != EFI_SUCCESS)
1303                 goto error;
1304
1305         ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1306         if (ret)
1307                 goto error;
1308
1309         EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1310
1311 error:
1312         free(info);
1313         EFI_CALL(f->close(f));
1314
1315         if (ret != EFI_SUCCESS) {
1316                 efi_free_pool(*buffer);
1317                 *buffer = NULL;
1318         }
1319
1320         return ret;
1321 }
1322
1323 /*
1324  * Load an EFI image into memory.
1325  *
1326  * This function implements the LoadImage service.
1327  * See the Unified Extensible Firmware Interface (UEFI) specification
1328  * for details.
1329  *
1330  * @boot_policy         true for request originating from the boot manager
1331  * @parent_image        the calles's image handle
1332  * @file_path           the path of the image to load
1333  * @source_buffer       memory location from which the image is installed
1334  * @source_size         size of the memory area from which the image is
1335  *                      installed
1336  * @image_handle        handle for the newly installed image
1337  * @return              status code
1338  */
1339 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1340                                           efi_handle_t parent_image,
1341                                           struct efi_device_path *file_path,
1342                                           void *source_buffer,
1343                                           unsigned long source_size,
1344                                           efi_handle_t *image_handle)
1345 {
1346         struct efi_loaded_image *info;
1347         struct efi_object *obj;
1348         efi_status_t ret;
1349
1350         EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1351                   file_path, source_buffer, source_size, image_handle);
1352
1353         info = calloc(1, sizeof(*info));
1354         obj = calloc(1, sizeof(*obj));
1355
1356         if (!source_buffer) {
1357                 struct efi_device_path *dp, *fp;
1358
1359                 ret = efi_load_image_from_path(file_path, &source_buffer);
1360                 if (ret != EFI_SUCCESS)
1361                         goto failure;
1362                 /*
1363                  * split file_path which contains both the device and
1364                  * file parts:
1365                  */
1366                 efi_dp_split_file_path(file_path, &dp, &fp);
1367                 ret = efi_setup_loaded_image(info, obj, dp, fp);
1368                 if (ret != EFI_SUCCESS)
1369                         goto failure;
1370         } else {
1371                 /* In this case, file_path is the "device" path, ie.
1372                  * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1373                  */
1374                 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1375                 if (ret != EFI_SUCCESS)
1376                         goto failure;
1377         }
1378         info->reserved = efi_load_pe(source_buffer, info);
1379         if (!info->reserved) {
1380                 ret = EFI_UNSUPPORTED;
1381                 goto failure;
1382         }
1383         info->system_table = &systab;
1384         info->parent_handle = parent_image;
1385         *image_handle = obj->handle;
1386         return EFI_EXIT(EFI_SUCCESS);
1387 failure:
1388         free(info);
1389         efi_delete_handle(obj);
1390         return EFI_EXIT(ret);
1391 }
1392
1393 /*
1394  * Call the entry point of an image.
1395  *
1396  * This function implements the StartImage service.
1397  * See the Unified Extensible Firmware Interface (UEFI) specification
1398  * for details.
1399  *
1400  * @image_handle        handle of the image
1401  * @exit_data_size      size of the buffer
1402  * @exit_data           buffer to receive the exit data of the called image
1403  * @return              status code
1404  */
1405 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1406                                            unsigned long *exit_data_size,
1407                                            s16 **exit_data)
1408 {
1409         ulong (*entry)(void *image_handle, struct efi_system_table *st);
1410         struct efi_loaded_image *info = image_handle;
1411         efi_status_t ret;
1412
1413         EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1414         entry = info->reserved;
1415
1416         efi_is_direct_boot = false;
1417
1418         /* call the image! */
1419         if (setjmp(&info->exit_jmp)) {
1420                 /*
1421                  * We called the entry point of the child image with EFI_CALL
1422                  * in the lines below. The child image called the Exit() boot
1423                  * service efi_exit() which executed the long jump that brought
1424                  * us to the current line. This implies that the second half
1425                  * of the EFI_CALL macro has not been executed.
1426                  */
1427 #ifdef CONFIG_ARM
1428                 /*
1429                  * efi_exit() called efi_restore_gd(). We have to undo this
1430                  * otherwise __efi_entry_check() will put the wrong value into
1431                  * app_gd.
1432                  */
1433                 gd = app_gd;
1434 #endif
1435                 /*
1436                  * To get ready to call EFI_EXIT below we have to execute the
1437                  * missed out steps of EFI_CALL.
1438                  */
1439                 assert(__efi_entry_check());
1440                 debug("%sEFI: %lu returned by started image\n",
1441                       __efi_nesting_dec(),
1442                       (unsigned long)((uintptr_t)info->exit_status &
1443                                       ~EFI_ERROR_MASK));
1444                 return EFI_EXIT(info->exit_status);
1445         }
1446
1447         ret = EFI_CALL(entry(image_handle, &systab));
1448
1449         /* Should usually never get here */
1450         return EFI_EXIT(ret);
1451 }
1452
1453 /*
1454  * Leave an EFI application or driver.
1455  *
1456  * This function implements the Exit service.
1457  * See the Unified Extensible Firmware Interface (UEFI) specification
1458  * for details.
1459  *
1460  * @image_handle        handle of the application or driver that is exiting
1461  * @exit_status         status code
1462  * @exit_data_size      size of the buffer in bytes
1463  * @exit_data           buffer with data describing an error
1464  * @return              status code
1465  */
1466 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1467                         efi_status_t exit_status, unsigned long exit_data_size,
1468                         int16_t *exit_data)
1469 {
1470         /*
1471          * We require that the handle points to the original loaded
1472          * image protocol interface.
1473          *
1474          * For getting the longjmp address this is safer than locating
1475          * the protocol because the protocol may have been reinstalled
1476          * pointing to another memory location.
1477          *
1478          * TODO: We should call the unload procedure of the loaded
1479          *       image protocol.
1480          */
1481         struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1482
1483         EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1484                   exit_data_size, exit_data);
1485
1486         /* Make sure entry/exit counts for EFI world cross-overs match */
1487         EFI_EXIT(exit_status);
1488
1489         /*
1490          * But longjmp out with the U-Boot gd, not the application's, as
1491          * the other end is a setjmp call inside EFI context.
1492          */
1493         efi_restore_gd();
1494
1495         loaded_image_info->exit_status = exit_status;
1496         longjmp(&loaded_image_info->exit_jmp, 1);
1497
1498         panic("EFI application exited");
1499 }
1500
1501 /*
1502  * Unload an EFI image.
1503  *
1504  * This function implements the UnloadImage service.
1505  * See the Unified Extensible Firmware Interface (UEFI) specification
1506  * for details.
1507  *
1508  * @image_handle        handle of the image to be unloaded
1509  * @return              status code
1510  */
1511 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1512 {
1513         struct efi_object *efiobj;
1514
1515         EFI_ENTRY("%p", image_handle);
1516         efiobj = efi_search_obj(image_handle);
1517         if (efiobj)
1518                 list_del(&efiobj->link);
1519
1520         return EFI_EXIT(EFI_SUCCESS);
1521 }
1522
1523 /*
1524  * Fix up caches for EFI payloads if necessary.
1525  */
1526 static void efi_exit_caches(void)
1527 {
1528 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1529         /*
1530          * Grub on 32bit ARM needs to have caches disabled before jumping into
1531          * a zImage, but does not know of all cache layers. Give it a hand.
1532          */
1533         if (efi_is_direct_boot)
1534                 cleanup_before_linux();
1535 #endif
1536 }
1537
1538 /*
1539  * Stop boot services.
1540  *
1541  * This function implements the ExitBootServices service.
1542  * See the Unified Extensible Firmware Interface (UEFI) specification
1543  * for details.
1544  *
1545  * @image_handle        handle of the loaded image
1546  * @map_key             key of the memory map
1547  * @return              status code
1548  */
1549 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1550                                                   unsigned long map_key)
1551 {
1552         int i;
1553
1554         EFI_ENTRY("%p, %ld", image_handle, map_key);
1555
1556         /* Notify that ExitBootServices is invoked. */
1557         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1558                 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1559                         continue;
1560                 efi_signal_event(&efi_events[i]);
1561         }
1562         /* Make sure that notification functions are not called anymore */
1563         efi_tpl = TPL_HIGH_LEVEL;
1564
1565         /* XXX Should persist EFI variables here */
1566
1567         board_quiesce_devices();
1568
1569         /* Fix up caches for EFI payloads if necessary */
1570         efi_exit_caches();
1571
1572         /* This stops all lingering devices */
1573         bootm_disable_interrupts();
1574
1575         /* Give the payload some time to boot */
1576         efi_set_watchdog(0);
1577         WATCHDOG_RESET();
1578
1579         return EFI_EXIT(EFI_SUCCESS);
1580 }
1581
1582 /*
1583  * Get next value of the counter.
1584  *
1585  * This function implements the NextMonotonicCount service.
1586  * See the Unified Extensible Firmware Interface (UEFI) specification
1587  * for details.
1588  *
1589  * @count       returned value of the counter
1590  * @return      status code
1591  */
1592 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1593 {
1594         static uint64_t mono = 0;
1595         EFI_ENTRY("%p", count);
1596         *count = mono++;
1597         return EFI_EXIT(EFI_SUCCESS);
1598 }
1599
1600 /*
1601  * Sleep.
1602  *
1603  * This function implements the Stall sercive.
1604  * See the Unified Extensible Firmware Interface (UEFI) specification
1605  * for details.
1606  *
1607  * @microseconds        period to sleep in microseconds
1608  * @return              status code
1609  */
1610 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1611 {
1612         EFI_ENTRY("%ld", microseconds);
1613         udelay(microseconds);
1614         return EFI_EXIT(EFI_SUCCESS);
1615 }
1616
1617 /*
1618  * Reset the watchdog timer.
1619  *
1620  * This function implements the SetWatchdogTimer service.
1621  * See the Unified Extensible Firmware Interface (UEFI) specification
1622  * for details.
1623  *
1624  * @timeout             seconds before reset by watchdog
1625  * @watchdog_code       code to be logged when resetting
1626  * @data_size           size of buffer in bytes
1627  * @watchdog_data       buffer with data describing the reset reason
1628  * @return              status code
1629  */
1630 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1631                                                   uint64_t watchdog_code,
1632                                                   unsigned long data_size,
1633                                                   uint16_t *watchdog_data)
1634 {
1635         EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1636                   data_size, watchdog_data);
1637         return EFI_EXIT(efi_set_watchdog(timeout));
1638 }
1639
1640 /*
1641  * Disconnect a controller from a driver.
1642  *
1643  * This function implements the DisconnectController service.
1644  * See the Unified Extensible Firmware Interface (UEFI) specification
1645  * for details.
1646  *
1647  * @controller_handle   handle of the controller
1648  * @driver_image_handle handle of the driver
1649  * @child_handle        handle of the child to destroy
1650  * @return              status code
1651  */
1652 static efi_status_t EFIAPI efi_disconnect_controller(
1653                                 efi_handle_t controller_handle,
1654                                 efi_handle_t driver_image_handle,
1655                                 efi_handle_t child_handle)
1656 {
1657         EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1658                   child_handle);
1659         return EFI_EXIT(EFI_INVALID_PARAMETER);
1660 }
1661
1662 /*
1663  * Close a protocol.
1664  *
1665  * This function implements the CloseProtocol service.
1666  * See the Unified Extensible Firmware Interface (UEFI) specification
1667  * for details.
1668  *
1669  * @handle              handle on which the protocol shall be closed
1670  * @protocol            GUID of the protocol to close
1671  * @agent_handle        handle of the driver
1672  * @controller_handle   handle of the controller
1673  * @return              status code
1674  */
1675 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1676                                               const efi_guid_t *protocol,
1677                                               void *agent_handle,
1678                                               void *controller_handle)
1679 {
1680         struct efi_handler *handler;
1681         struct efi_open_protocol_info_item *item;
1682         struct efi_open_protocol_info_item *pos;
1683         efi_status_t r;
1684
1685         EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1686                   controller_handle);
1687
1688         if (!agent_handle) {
1689                 r = EFI_INVALID_PARAMETER;
1690                 goto out;
1691         }
1692         r = efi_search_protocol(handle, protocol, &handler);
1693         if (r != EFI_SUCCESS)
1694                 goto out;
1695
1696         r = EFI_NOT_FOUND;
1697         list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1698                 if (item->info.agent_handle == agent_handle &&
1699                     item->info.controller_handle == controller_handle) {
1700                         efi_delete_open_info(item);
1701                         r = EFI_SUCCESS;
1702                         break;
1703                 }
1704         }
1705 out:
1706         return EFI_EXIT(r);
1707 }
1708
1709 /*
1710  * Provide information about then open status of a protocol on a handle
1711  *
1712  * This function implements the OpenProtocolInformation service.
1713  * See the Unified Extensible Firmware Interface (UEFI) specification
1714  * for details.
1715  *
1716  * @handle              handle for which the information shall be retrieved
1717  * @protocol            GUID of the protocol
1718  * @entry_buffer        buffer to receive the open protocol information
1719  * @entry_count         number of entries available in the buffer
1720  * @return              status code
1721  */
1722 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1723                         const efi_guid_t *protocol,
1724                         struct efi_open_protocol_info_entry **entry_buffer,
1725                         efi_uintn_t *entry_count)
1726 {
1727         unsigned long buffer_size;
1728         unsigned long count;
1729         struct efi_handler *handler;
1730         struct efi_open_protocol_info_item *item;
1731         efi_status_t r;
1732
1733         EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1734                   entry_count);
1735
1736         /* Check parameters */
1737         if (!entry_buffer) {
1738                 r = EFI_INVALID_PARAMETER;
1739                 goto out;
1740         }
1741         r = efi_search_protocol(handle, protocol, &handler);
1742         if (r != EFI_SUCCESS)
1743                 goto out;
1744
1745         /* Count entries */
1746         count = 0;
1747         list_for_each_entry(item, &handler->open_infos, link) {
1748                 if (item->info.open_count)
1749                         ++count;
1750         }
1751         *entry_count = count;
1752         *entry_buffer = NULL;
1753         if (!count) {
1754                 r = EFI_SUCCESS;
1755                 goto out;
1756         }
1757
1758         /* Copy entries */
1759         buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
1760         r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1761                               (void **)entry_buffer);
1762         if (r != EFI_SUCCESS)
1763                 goto out;
1764         list_for_each_entry_reverse(item, &handler->open_infos, link) {
1765                 if (item->info.open_count)
1766                         (*entry_buffer)[--count] = item->info;
1767         }
1768 out:
1769         return EFI_EXIT(r);
1770 }
1771
1772 /*
1773  * Get protocols installed on a handle.
1774  *
1775  * This function implements the ProtocolsPerHandleService.
1776  * See the Unified Extensible Firmware Interface (UEFI) specification
1777  * for details.
1778  *
1779  * @handle                      handle for which the information is retrieved
1780  * @protocol_buffer             buffer with protocol GUIDs
1781  * @protocol_buffer_count       number of entries in the buffer
1782  * @return                      status code
1783  */
1784 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1785                         efi_guid_t ***protocol_buffer,
1786                         efi_uintn_t *protocol_buffer_count)
1787 {
1788         unsigned long buffer_size;
1789         struct efi_object *efiobj;
1790         struct list_head *protocol_handle;
1791         efi_status_t r;
1792
1793         EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1794                   protocol_buffer_count);
1795
1796         if (!handle || !protocol_buffer || !protocol_buffer_count)
1797                 return EFI_EXIT(EFI_INVALID_PARAMETER);
1798
1799         *protocol_buffer = NULL;
1800         *protocol_buffer_count = 0;
1801
1802         efiobj = efi_search_obj(handle);
1803         if (!efiobj)
1804                 return EFI_EXIT(EFI_INVALID_PARAMETER);
1805
1806         /* Count protocols */
1807         list_for_each(protocol_handle, &efiobj->protocols) {
1808                 ++*protocol_buffer_count;
1809         }
1810
1811         /* Copy guids */
1812         if (*protocol_buffer_count) {
1813                 size_t j = 0;
1814
1815                 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
1816                 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1817                                       (void **)protocol_buffer);
1818                 if (r != EFI_SUCCESS)
1819                         return EFI_EXIT(r);
1820                 list_for_each(protocol_handle, &efiobj->protocols) {
1821                         struct efi_handler *protocol;
1822
1823                         protocol = list_entry(protocol_handle,
1824                                               struct efi_handler, link);
1825                         (*protocol_buffer)[j] = (void *)protocol->guid;
1826                         ++j;
1827                 }
1828         }
1829
1830         return EFI_EXIT(EFI_SUCCESS);
1831 }
1832
1833 /*
1834  * Locate handles implementing a protocol.
1835  *
1836  * This function implements the LocateHandleBuffer service.
1837  * See the Unified Extensible Firmware Interface (UEFI) specification
1838  * for details.
1839  *
1840  * @search_type         selection criterion
1841  * @protocol            GUID of the protocol
1842  * @search_key          registration key
1843  * @no_handles          number of returned handles
1844  * @buffer              buffer with the returned handles
1845  * @return              status code
1846  */
1847 static efi_status_t EFIAPI efi_locate_handle_buffer(
1848                         enum efi_locate_search_type search_type,
1849                         const efi_guid_t *protocol, void *search_key,
1850                         efi_uintn_t *no_handles, efi_handle_t **buffer)
1851 {
1852         efi_status_t r;
1853         efi_uintn_t buffer_size = 0;
1854
1855         EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1856                   no_handles, buffer);
1857
1858         if (!no_handles || !buffer) {
1859                 r = EFI_INVALID_PARAMETER;
1860                 goto out;
1861         }
1862         *no_handles = 0;
1863         *buffer = NULL;
1864         r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1865                               *buffer);
1866         if (r != EFI_BUFFER_TOO_SMALL)
1867                 goto out;
1868         r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1869                               (void **)buffer);
1870         if (r != EFI_SUCCESS)
1871                 goto out;
1872         r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1873                               *buffer);
1874         if (r == EFI_SUCCESS)
1875                 *no_handles = buffer_size / sizeof(void *);
1876 out:
1877         return EFI_EXIT(r);
1878 }
1879
1880 /*
1881  * Find an interface implementing a protocol.
1882  *
1883  * This function implements the LocateProtocol service.
1884  * See the Unified Extensible Firmware Interface (UEFI) specification
1885  * for details.
1886  *
1887  * @protocol            GUID of the protocol
1888  * @registration        registration key passed to the notification function
1889  * @protocol_interface  interface implementing the protocol
1890  * @return              status code
1891  */
1892 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1893                                                void *registration,
1894                                                void **protocol_interface)
1895 {
1896         struct list_head *lhandle;
1897         efi_status_t ret;
1898
1899         EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1900
1901         if (!protocol || !protocol_interface)
1902                 return EFI_EXIT(EFI_INVALID_PARAMETER);
1903
1904         list_for_each(lhandle, &efi_obj_list) {
1905                 struct efi_object *efiobj;
1906                 struct efi_handler *handler;
1907
1908                 efiobj = list_entry(lhandle, struct efi_object, link);
1909
1910                 ret = efi_search_protocol(efiobj->handle, protocol, &handler);
1911                 if (ret == EFI_SUCCESS) {
1912                         *protocol_interface = handler->protocol_interface;
1913                         return EFI_EXIT(EFI_SUCCESS);
1914                 }
1915         }
1916         *protocol_interface = NULL;
1917
1918         return EFI_EXIT(EFI_NOT_FOUND);
1919 }
1920
1921 /*
1922  * Get the device path and handle of an device implementing a protocol.
1923  *
1924  * This function implements the LocateDevicePath service.
1925  * See the Unified Extensible Firmware Interface (UEFI) specification
1926  * for details.
1927  *
1928  * @protocol            GUID of the protocol
1929  * @device_path         device path
1930  * @device              handle of the device
1931  * @return              status code
1932  */
1933 static efi_status_t EFIAPI efi_locate_device_path(
1934                         const efi_guid_t *protocol,
1935                         struct efi_device_path **device_path,
1936                         efi_handle_t *device)
1937 {
1938         struct efi_device_path *dp;
1939         size_t i;
1940         struct efi_handler *handler;
1941         efi_handle_t *handles;
1942         size_t len, len_dp;
1943         size_t len_best = 0;
1944         efi_uintn_t no_handles;
1945         u8 *remainder;
1946         efi_status_t ret;
1947
1948         EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1949
1950         if (!protocol || !device_path || !*device_path || !device) {
1951                 ret = EFI_INVALID_PARAMETER;
1952                 goto out;
1953         }
1954
1955         /* Find end of device path */
1956         len = efi_dp_size(*device_path);
1957
1958         /* Get all handles implementing the protocol */
1959         ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
1960                                                 &no_handles, &handles));
1961         if (ret != EFI_SUCCESS)
1962                 goto out;
1963
1964         for (i = 0; i < no_handles; ++i) {
1965                 /* Find the device path protocol */
1966                 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
1967                                           &handler);
1968                 if (ret != EFI_SUCCESS)
1969                         continue;
1970                 dp = (struct efi_device_path *)handler->protocol_interface;
1971                 len_dp = efi_dp_size(dp);
1972                 /*
1973                  * This handle can only be a better fit
1974                  * if its device path length is longer than the best fit and
1975                  * if its device path length is shorter of equal the searched
1976                  * device path.
1977                  */
1978                 if (len_dp <= len_best || len_dp > len)
1979                         continue;
1980                 /* Check if dp is a subpath of device_path */
1981                 if (memcmp(*device_path, dp, len_dp))
1982                         continue;
1983                 *device = handles[i];
1984                 len_best = len_dp;
1985         }
1986         if (len_best) {
1987                 remainder = (u8 *)*device_path + len_best;
1988                 *device_path = (struct efi_device_path *)remainder;
1989                 ret = EFI_SUCCESS;
1990         } else {
1991                 ret = EFI_NOT_FOUND;
1992         }
1993 out:
1994         return EFI_EXIT(ret);
1995 }
1996
1997 /*
1998  * Install multiple protocol interfaces.
1999  *
2000  * This function implements the MultipleProtocolInterfaces service.
2001  * See the Unified Extensible Firmware Interface (UEFI) specification
2002  * for details.
2003  *
2004  * @handle      handle on which the protocol interfaces shall be installed
2005  * @...         NULL terminated argument list with pairs of protocol GUIDS and
2006  *              interfaces
2007  * @return      status code
2008  */
2009 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
2010                         void **handle, ...)
2011 {
2012         EFI_ENTRY("%p", handle);
2013
2014         va_list argptr;
2015         const efi_guid_t *protocol;
2016         void *protocol_interface;
2017         efi_status_t r = EFI_SUCCESS;
2018         int i = 0;
2019
2020         if (!handle)
2021                 return EFI_EXIT(EFI_INVALID_PARAMETER);
2022
2023         va_start(argptr, handle);
2024         for (;;) {
2025                 protocol = va_arg(argptr, efi_guid_t*);
2026                 if (!protocol)
2027                         break;
2028                 protocol_interface = va_arg(argptr, void*);
2029                 r = EFI_CALL(efi_install_protocol_interface(
2030                                                 handle, protocol,
2031                                                 EFI_NATIVE_INTERFACE,
2032                                                 protocol_interface));
2033                 if (r != EFI_SUCCESS)
2034                         break;
2035                 i++;
2036         }
2037         va_end(argptr);
2038         if (r == EFI_SUCCESS)
2039                 return EFI_EXIT(r);
2040
2041         /* If an error occurred undo all changes. */
2042         va_start(argptr, handle);
2043         for (; i; --i) {
2044                 protocol = va_arg(argptr, efi_guid_t*);
2045                 protocol_interface = va_arg(argptr, void*);
2046                 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2047                                                           protocol_interface));
2048         }
2049         va_end(argptr);
2050
2051         return EFI_EXIT(r);
2052 }
2053
2054 /*
2055  * Uninstall multiple protocol interfaces.
2056  *
2057  * This function implements the UninstallMultipleProtocolInterfaces service.
2058  * See the Unified Extensible Firmware Interface (UEFI) specification
2059  * for details.
2060  *
2061  * @handle      handle from which the protocol interfaces shall be removed
2062  * @...         NULL terminated argument list with pairs of protocol GUIDS and
2063  *              interfaces
2064  * @return      status code
2065  */
2066 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2067                         void *handle, ...)
2068 {
2069         EFI_ENTRY("%p", handle);
2070
2071         va_list argptr;
2072         const efi_guid_t *protocol;
2073         void *protocol_interface;
2074         efi_status_t r = EFI_SUCCESS;
2075         size_t i = 0;
2076
2077         if (!handle)
2078                 return EFI_EXIT(EFI_INVALID_PARAMETER);
2079
2080         va_start(argptr, handle);
2081         for (;;) {
2082                 protocol = va_arg(argptr, efi_guid_t*);
2083                 if (!protocol)
2084                         break;
2085                 protocol_interface = va_arg(argptr, void*);
2086                 r = EFI_CALL(efi_uninstall_protocol_interface(
2087                                                 handle, protocol,
2088                                                 protocol_interface));
2089                 if (r != EFI_SUCCESS)
2090                         break;
2091                 i++;
2092         }
2093         va_end(argptr);
2094         if (r == EFI_SUCCESS)
2095                 return EFI_EXIT(r);
2096
2097         /* If an error occurred undo all changes. */
2098         va_start(argptr, handle);
2099         for (; i; --i) {
2100                 protocol = va_arg(argptr, efi_guid_t*);
2101                 protocol_interface = va_arg(argptr, void*);
2102                 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2103                                                         EFI_NATIVE_INTERFACE,
2104                                                         protocol_interface));
2105         }
2106         va_end(argptr);
2107
2108         return EFI_EXIT(r);
2109 }
2110
2111 /*
2112  * Calculate cyclic redundancy code.
2113  *
2114  * This function implements the CalculateCrc32 service.
2115  * See the Unified Extensible Firmware Interface (UEFI) specification
2116  * for details.
2117  *
2118  * @data        buffer with data
2119  * @data_size   size of buffer in bytes
2120  * @crc32_p     cyclic redundancy code
2121  * @return      status code
2122  */
2123 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
2124                                                unsigned long data_size,
2125                                                uint32_t *crc32_p)
2126 {
2127         EFI_ENTRY("%p, %ld", data, data_size);
2128         *crc32_p = crc32(0, data, data_size);
2129         return EFI_EXIT(EFI_SUCCESS);
2130 }
2131
2132 /*
2133  * Copy memory.
2134  *
2135  * This function implements the CopyMem service.
2136  * See the Unified Extensible Firmware Interface (UEFI) specification
2137  * for details.
2138  *
2139  * @destination         destination of the copy operation
2140  * @source              source of the copy operation
2141  * @length              number of bytes to copy
2142  */
2143 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2144                                 size_t length)
2145 {
2146         EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2147         memcpy(destination, source, length);
2148         EFI_EXIT(EFI_SUCCESS);
2149 }
2150
2151 /*
2152  * Fill memory with a byte value.
2153  *
2154  * This function implements the SetMem service.
2155  * See the Unified Extensible Firmware Interface (UEFI) specification
2156  * for details.
2157  *
2158  * @buffer              buffer to fill
2159  * @size                size of buffer in bytes
2160  * @value               byte to copy to the buffer
2161  */
2162 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2163 {
2164         EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2165         memset(buffer, value, size);
2166         EFI_EXIT(EFI_SUCCESS);
2167 }
2168
2169 /*
2170  * Open protocol interface on a handle.
2171  *
2172  * @handler             handler of a protocol
2173  * @protocol_interface  interface implementing the protocol
2174  * @agent_handle        handle of the driver
2175  * @controller_handle   handle of the controller
2176  * @attributes          attributes indicating how to open the protocol
2177  * @return              status code
2178  */
2179 static efi_status_t efi_protocol_open(
2180                         struct efi_handler *handler,
2181                         void **protocol_interface, void *agent_handle,
2182                         void *controller_handle, uint32_t attributes)
2183 {
2184         struct efi_open_protocol_info_item *item;
2185         struct efi_open_protocol_info_entry *match = NULL;
2186         bool opened_by_driver = false;
2187         bool opened_exclusive = false;
2188
2189         /* If there is no agent, only return the interface */
2190         if (!agent_handle)
2191                 goto out;
2192
2193         /* For TEST_PROTOCOL ignore interface attribute */
2194         if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2195                 *protocol_interface = NULL;
2196
2197         /*
2198          * Check if the protocol is already opened by a driver with the same
2199          * attributes or opened exclusively
2200          */
2201         list_for_each_entry(item, &handler->open_infos, link) {
2202                 if (item->info.agent_handle == agent_handle) {
2203                         if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2204                             (item->info.attributes == attributes))
2205                                 return EFI_ALREADY_STARTED;
2206                 }
2207                 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2208                         opened_exclusive = true;
2209         }
2210
2211         /* Only one controller can open the protocol exclusively */
2212         if (opened_exclusive && attributes &
2213             (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2214                 return EFI_ACCESS_DENIED;
2215
2216         /* Prepare exclusive opening */
2217         if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2218                 /* Try to disconnect controllers */
2219                 list_for_each_entry(item, &handler->open_infos, link) {
2220                         if (item->info.attributes ==
2221                                         EFI_OPEN_PROTOCOL_BY_DRIVER)
2222                                 EFI_CALL(efi_disconnect_controller(
2223                                                 item->info.controller_handle,
2224                                                 item->info.agent_handle,
2225                                                 NULL));
2226                 }
2227                 opened_by_driver = false;
2228                 /* Check if all controllers are disconnected */
2229                 list_for_each_entry(item, &handler->open_infos, link) {
2230                         if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2231                                 opened_by_driver = true;
2232                 }
2233                 /* Only one controller can be conncected */
2234                 if (opened_by_driver)
2235                         return EFI_ACCESS_DENIED;
2236         }
2237
2238         /* Find existing entry */
2239         list_for_each_entry(item, &handler->open_infos, link) {
2240                 if (item->info.agent_handle == agent_handle &&
2241                     item->info.controller_handle == controller_handle)
2242                         match = &item->info;
2243         }
2244         /* None found, create one */
2245         if (!match) {
2246                 match = efi_create_open_info(handler);
2247                 if (!match)
2248                         return EFI_OUT_OF_RESOURCES;
2249         }
2250
2251         match->agent_handle = agent_handle;
2252         match->controller_handle = controller_handle;
2253         match->attributes = attributes;
2254         match->open_count++;
2255
2256 out:
2257         /* For TEST_PROTOCOL ignore interface attribute. */
2258         if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2259                 *protocol_interface = handler->protocol_interface;
2260
2261         return EFI_SUCCESS;
2262 }
2263
2264 /*
2265  * Open protocol interface on a handle.
2266  *
2267  * This function implements the OpenProtocol interface.
2268  * See the Unified Extensible Firmware Interface (UEFI) specification
2269  * for details.
2270  *
2271  * @handle              handle on which the protocol shall be opened
2272  * @protocol            GUID of the protocol
2273  * @protocol_interface  interface implementing the protocol
2274  * @agent_handle        handle of the driver
2275  * @controller_handle   handle of the controller
2276  * @attributes          attributes indicating how to open the protocol
2277  * @return              status code
2278  */
2279 static efi_status_t EFIAPI efi_open_protocol(
2280                         void *handle, const efi_guid_t *protocol,
2281                         void **protocol_interface, void *agent_handle,
2282                         void *controller_handle, uint32_t attributes)
2283 {
2284         struct efi_handler *handler;
2285         efi_status_t r = EFI_INVALID_PARAMETER;
2286
2287         EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2288                   protocol_interface, agent_handle, controller_handle,
2289                   attributes);
2290
2291         if (!handle || !protocol ||
2292             (!protocol_interface && attributes !=
2293              EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2294                 goto out;
2295         }
2296
2297         switch (attributes) {
2298         case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2299         case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2300         case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2301                 break;
2302         case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2303                 if (controller_handle == handle)
2304                         goto out;
2305                 /* fall-through */
2306         case EFI_OPEN_PROTOCOL_BY_DRIVER:
2307         case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2308                 /* Check that the controller handle is valid */
2309                 if (!efi_search_obj(controller_handle))
2310                         goto out;
2311                 /* fall-through */
2312         case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2313                 /* Check that the agent handle is valid */
2314                 if (!efi_search_obj(agent_handle))
2315                         goto out;
2316                 break;
2317         default:
2318                 goto out;
2319         }
2320
2321         r = efi_search_protocol(handle, protocol, &handler);
2322         if (r != EFI_SUCCESS)
2323                 goto out;
2324
2325         r = efi_protocol_open(handler, protocol_interface, agent_handle,
2326                               controller_handle, attributes);
2327 out:
2328         return EFI_EXIT(r);
2329 }
2330
2331 /*
2332  * Get interface of a protocol on a handle.
2333  *
2334  * This function implements the HandleProtocol service.
2335  * See the Unified Extensible Firmware Interface (UEFI) specification
2336  * for details.
2337  *
2338  * @handle              handle on which the protocol shall be opened
2339  * @protocol            GUID of the protocol
2340  * @protocol_interface  interface implementing the protocol
2341  * @return              status code
2342  */
2343 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
2344                                                const efi_guid_t *protocol,
2345                                                void **protocol_interface)
2346 {
2347         return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2348                                  NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2349 }
2350
2351 static efi_status_t efi_bind_controller(
2352                         efi_handle_t controller_handle,
2353                         efi_handle_t driver_image_handle,
2354                         struct efi_device_path *remain_device_path)
2355 {
2356         struct efi_driver_binding_protocol *binding_protocol;
2357         efi_status_t r;
2358
2359         r = EFI_CALL(efi_open_protocol(driver_image_handle,
2360                                        &efi_guid_driver_binding_protocol,
2361                                        (void **)&binding_protocol,
2362                                        driver_image_handle, NULL,
2363                                        EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2364         if (r != EFI_SUCCESS)
2365                 return r;
2366         r = EFI_CALL(binding_protocol->supported(binding_protocol,
2367                                                  controller_handle,
2368                                                  remain_device_path));
2369         if (r == EFI_SUCCESS)
2370                 r = EFI_CALL(binding_protocol->start(binding_protocol,
2371                                                      controller_handle,
2372                                                      remain_device_path));
2373         EFI_CALL(efi_close_protocol(driver_image_handle,
2374                                     &efi_guid_driver_binding_protocol,
2375                                     driver_image_handle, NULL));
2376         return r;
2377 }
2378
2379 static efi_status_t efi_connect_single_controller(
2380                         efi_handle_t controller_handle,
2381                         efi_handle_t *driver_image_handle,
2382                         struct efi_device_path *remain_device_path)
2383 {
2384         efi_handle_t *buffer;
2385         size_t count;
2386         size_t i;
2387         efi_status_t r;
2388         size_t connected = 0;
2389
2390         /* Get buffer with all handles with driver binding protocol */
2391         r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2392                                               &efi_guid_driver_binding_protocol,
2393                                               NULL, &count, &buffer));
2394         if (r != EFI_SUCCESS)
2395                 return r;
2396
2397         /*  Context Override */
2398         if (driver_image_handle) {
2399                 for (; *driver_image_handle; ++driver_image_handle) {
2400                         for (i = 0; i < count; ++i) {
2401                                 if (buffer[i] == *driver_image_handle) {
2402                                         buffer[i] = NULL;
2403                                         r = efi_bind_controller(
2404                                                         controller_handle,
2405                                                         *driver_image_handle,
2406                                                         remain_device_path);
2407                                         /*
2408                                          * For drivers that do not support the
2409                                          * controller or are already connected
2410                                          * we receive an error code here.
2411                                          */
2412                                         if (r == EFI_SUCCESS)
2413                                                 ++connected;
2414                                 }
2415                         }
2416                 }
2417         }
2418
2419         /*
2420          * TODO: Some overrides are not yet implemented:
2421          * - Platform Driver Override
2422          * - Driver Family Override Search
2423          * - Bus Specific Driver Override
2424          */
2425
2426         /* Driver Binding Search */
2427         for (i = 0; i < count; ++i) {
2428                 if (buffer[i]) {
2429                         r = efi_bind_controller(controller_handle,
2430                                                 buffer[i],
2431                                                 remain_device_path);
2432                         if (r == EFI_SUCCESS)
2433                                 ++connected;
2434                 }
2435         }
2436
2437         efi_free_pool(buffer);
2438         if (!connected)
2439                 return EFI_NOT_FOUND;
2440         return EFI_SUCCESS;
2441 }
2442
2443 /*
2444  * Connect a controller to a driver.
2445  *
2446  * This function implements the ConnectController service.
2447  * See the Unified Extensible Firmware Interface (UEFI) specification
2448  * for details.
2449  *
2450  * First all driver binding protocol handles are tried for binding drivers.
2451  * Afterwards all handles that have openened a protocol of the controller
2452  * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2453  *
2454  * @controller_handle   handle of the controller
2455  * @driver_image_handle handle of the driver
2456  * @remain_device_path  device path of a child controller
2457  * @recursive           true to connect all child controllers
2458  * @return              status code
2459  */
2460 static efi_status_t EFIAPI efi_connect_controller(
2461                         efi_handle_t controller_handle,
2462                         efi_handle_t *driver_image_handle,
2463                         struct efi_device_path *remain_device_path,
2464                         bool recursive)
2465 {
2466         efi_status_t r;
2467         efi_status_t ret = EFI_NOT_FOUND;
2468         struct efi_object *efiobj;
2469
2470         EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
2471                   remain_device_path, recursive);
2472
2473         efiobj = efi_search_obj(controller_handle);
2474         if (!efiobj) {
2475                 ret = EFI_INVALID_PARAMETER;
2476                 goto out;
2477         }
2478
2479         r = efi_connect_single_controller(controller_handle,
2480                                           driver_image_handle,
2481                                           remain_device_path);
2482         if (r == EFI_SUCCESS)
2483                 ret = EFI_SUCCESS;
2484         if (recursive) {
2485                 struct efi_handler *handler;
2486                 struct efi_open_protocol_info_item *item;
2487
2488                 list_for_each_entry(handler, &efiobj->protocols, link) {
2489                         list_for_each_entry(item, &handler->open_infos, link) {
2490                                 if (item->info.attributes &
2491                                     EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2492                                         r = EFI_CALL(efi_connect_controller(
2493                                                 item->info.controller_handle,
2494                                                 driver_image_handle,
2495                                                 remain_device_path,
2496                                                 recursive));
2497                                         if (r == EFI_SUCCESS)
2498                                                 ret = EFI_SUCCESS;
2499                                 }
2500                         }
2501                 }
2502         }
2503         /*  Check for child controller specified by end node */
2504         if (ret != EFI_SUCCESS && remain_device_path &&
2505             remain_device_path->type == DEVICE_PATH_TYPE_END)
2506                 ret = EFI_SUCCESS;
2507 out:
2508         return EFI_EXIT(ret);
2509 }
2510
2511 static const struct efi_boot_services efi_boot_services = {
2512         .hdr = {
2513                 .headersize = sizeof(struct efi_table_hdr),
2514         },
2515         .raise_tpl = efi_raise_tpl,
2516         .restore_tpl = efi_restore_tpl,
2517         .allocate_pages = efi_allocate_pages_ext,
2518         .free_pages = efi_free_pages_ext,
2519         .get_memory_map = efi_get_memory_map_ext,
2520         .allocate_pool = efi_allocate_pool_ext,
2521         .free_pool = efi_free_pool_ext,
2522         .create_event = efi_create_event_ext,
2523         .set_timer = efi_set_timer_ext,
2524         .wait_for_event = efi_wait_for_event,
2525         .signal_event = efi_signal_event_ext,
2526         .close_event = efi_close_event,
2527         .check_event = efi_check_event,
2528         .install_protocol_interface = efi_install_protocol_interface,
2529         .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2530         .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2531         .handle_protocol = efi_handle_protocol,
2532         .reserved = NULL,
2533         .register_protocol_notify = efi_register_protocol_notify,
2534         .locate_handle = efi_locate_handle_ext,
2535         .locate_device_path = efi_locate_device_path,
2536         .install_configuration_table = efi_install_configuration_table_ext,
2537         .load_image = efi_load_image,
2538         .start_image = efi_start_image,
2539         .exit = efi_exit,
2540         .unload_image = efi_unload_image,
2541         .exit_boot_services = efi_exit_boot_services,
2542         .get_next_monotonic_count = efi_get_next_monotonic_count,
2543         .stall = efi_stall,
2544         .set_watchdog_timer = efi_set_watchdog_timer,
2545         .connect_controller = efi_connect_controller,
2546         .disconnect_controller = efi_disconnect_controller,
2547         .open_protocol = efi_open_protocol,
2548         .close_protocol = efi_close_protocol,
2549         .open_protocol_information = efi_open_protocol_information,
2550         .protocols_per_handle = efi_protocols_per_handle,
2551         .locate_handle_buffer = efi_locate_handle_buffer,
2552         .locate_protocol = efi_locate_protocol,
2553         .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2554         .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2555         .calculate_crc32 = efi_calculate_crc32,
2556         .copy_mem = efi_copy_mem,
2557         .set_mem = efi_set_mem,
2558 };
2559
2560
2561 static uint16_t __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
2562
2563 struct efi_system_table __efi_runtime_data systab = {
2564         .hdr = {
2565                 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2566                 .revision = 0x20005, /* 2.5 */
2567                 .headersize = sizeof(struct efi_table_hdr),
2568         },
2569         .fw_vendor = (long)firmware_vendor,
2570         .con_in = (void*)&efi_con_in,
2571         .con_out = (void*)&efi_con_out,
2572         .std_err = (void*)&efi_con_out,
2573         .runtime = (void*)&efi_runtime_services,
2574         .boottime = (void*)&efi_boot_services,
2575         .nr_tables = 0,
2576         .tables = (void*)efi_conf_table,
2577 };