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

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