lib/efi_loader/efi_boottime.c

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