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