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