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