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