git.sur5r.net Git - u-boot/blob - lib/efi_loader/efi_boottime.c

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