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