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

   1 /*
   2  *  EFI application boot time services
   3  *
   4  *  Copyright (c) 2016 Alexander Graf
   5  *
   6  *  SPDX-License-Identifier:     GPL-2.0+
   7  */
   8
   9 #include <common.h>
  10 #include <div64.h>
  11 #include <efi_loader.h>
  12 #include <environment.h>
  13 #include <malloc.h>
  14 #include <asm/global_data.h>
  15 #include <libfdt_env.h>
  16 #include <u-boot/crc.h>
  17 #include <bootm.h>
  18 #include <inttypes.h>
  19 #include <watchdog.h>
  20
  21 DECLARE_GLOBAL_DATA_PTR;
  22
  23 /* Task priority level */
  24 static UINTN efi_tpl = TPL_APPLICATION;
  25
  26 /* This list contains all the EFI objects our payload has access to */
  27 LIST_HEAD(efi_obj_list);
  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 /*
  38  * EFI can pass arbitrary additional "tables" containing vendor specific
  39  * information to the payload. One such table is the FDT table which contains
  40  * a pointer to a flattened device tree blob.
  41  *
  42  * In most cases we want to pass an FDT to the payload, so reserve one slot of
  43  * config table space for it. The pointer gets populated by do_bootefi_exec().
  44  */
  45 static struct efi_configuration_table __efi_runtime_data efi_conf_table[2];
  46
  47 #ifdef CONFIG_ARM
  48 /*
  49  * The "gd" pointer lives in a register on ARM and AArch64 that we declare
  50  * fixed when compiling U-Boot. However, the payload does not know about that
  51  * restriction so we need to manually swap its and our view of that register on
  52  * EFI callback entry/exit.
  53  */
  54 static volatile void *efi_gd, *app_gd;
  55 #endif
  56
  57 static int entry_count;
  58 static int nesting_level;
  59
  60 /* Called on every callback entry */
  61 int __efi_entry_check(void)
  62 {
  63         int ret = entry_count++ == 0;
  64 #ifdef CONFIG_ARM
  65         assert(efi_gd);
  66         app_gd = gd;
  67         gd = efi_gd;
  68 #endif
  69         return ret;
  70 }
  71
  72 /* Called on every callback exit */
  73 int __efi_exit_check(void)
  74 {
  75         int ret = --entry_count == 0;
  76 #ifdef CONFIG_ARM
  77         gd = app_gd;
  78 #endif
  79         return ret;
  80 }
  81
  82 /* Called from do_bootefi_exec() */
  83 void efi_save_gd(void)
  84 {
  85 #ifdef CONFIG_ARM
  86         efi_gd = gd;
  87 #endif
  88 }
  89
  90 /*
  91  * Special case handler for error/abort that just forces things back
  92  * to u-boot world so we can dump out an abort msg, without any care
  93  * about returning back to UEFI world.
  94  */
  95 void efi_restore_gd(void)
  96 {
  97 #ifdef CONFIG_ARM
  98         /* Only restore if we're already in EFI context */
  99         if (!efi_gd)
 100                 return;
 101         gd = efi_gd;
 102 #endif
 103 }
 104
 105 /*
 106  * Two spaces per indent level, maxing out at 10.. which ought to be
 107  * enough for anyone ;-)
 108  */
 109 static const char *indent_string(int level)
 110 {
 111         const char *indent = "                    ";
 112         const int max = strlen(indent);
 113         level = min(max, level * 2);
 114         return &indent[max - level];
 115 }
 116
 117 const char *__efi_nesting(void)
 118 {
 119         return indent_string(nesting_level);
 120 }
 121
 122 const char *__efi_nesting_inc(void)
 123 {
 124         return indent_string(nesting_level++);
 125 }
 126
 127 const char *__efi_nesting_dec(void)
 128 {
 129         return indent_string(--nesting_level);
 130 }
 131
 132 /*
 133  * Queue an EFI event.
 134  *
 135  * This function queues the notification function of the event for future
 136  * execution.
 137  *
 138  * The notification function is called if the task priority level of the
 139  * event is higher than the current task priority level.
 140  *
 141  * For the SignalEvent service see efi_signal_event_ext.
 142  *
 143  * @event       event to signal
 144  */
 145 void efi_signal_event(struct efi_event *event)
 146 {
 147         if (event->notify_function) {
 148                 event->is_queued = true;
 149                 /* Check TPL */
 150                 if (efi_tpl >= event->notify_tpl)
 151                         return;
 152                 EFI_CALL_VOID(event->notify_function(event,
 153                                                      event->notify_context));
 154         }
 155         event->is_queued = false;
 156 }
 157
 158 /*
 159  * Raise the task priority level.
 160  *
 161  * This function implements the RaiseTpl service.
 162  * See the Unified Extensible Firmware Interface (UEFI) specification
 163  * for details.
 164  *
 165  * @new_tpl     new value of the task priority level
 166  * @return      old value of the task priority level
 167  */
 168 static unsigned long EFIAPI efi_raise_tpl(UINTN new_tpl)
 169 {
 170         UINTN old_tpl = efi_tpl;
 171
 172         EFI_ENTRY("0x%zx", new_tpl);
 173
 174         if (new_tpl < efi_tpl)
 175                 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
 176         efi_tpl = new_tpl;
 177         if (efi_tpl > TPL_HIGH_LEVEL)
 178                 efi_tpl = TPL_HIGH_LEVEL;
 179
 180         EFI_EXIT(EFI_SUCCESS);
 181         return old_tpl;
 182 }
 183
 184 /*
 185  * Lower the task priority level.
 186  *
 187  * This function implements the RestoreTpl service.
 188  * See the Unified Extensible Firmware Interface (UEFI) specification
 189  * for details.
 190  *
 191  * @old_tpl     value of the task priority level to be restored
 192  */
 193 static void EFIAPI efi_restore_tpl(UINTN old_tpl)
 194 {
 195         EFI_ENTRY("0x%zx", old_tpl);
 196
 197         if (old_tpl > efi_tpl)
 198                 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
 199         efi_tpl = old_tpl;
 200         if (efi_tpl > TPL_HIGH_LEVEL)
 201                 efi_tpl = TPL_HIGH_LEVEL;
 202
 203         EFI_EXIT(EFI_SUCCESS);
 204 }
 205
 206 /*
 207  * Allocate memory pages.
 208  *
 209  * This function implements the AllocatePages service.
 210  * See the Unified Extensible Firmware Interface (UEFI) specification
 211  * for details.
 212  *
 213  * @type                type of allocation to be performed
 214  * @memory_type         usage type of the allocated memory
 215  * @pages               number of pages to be allocated
 216  * @memory              allocated memory
 217  * @return              status code
 218  */
 219 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
 220                                                   unsigned long pages,
 221                                                   uint64_t *memory)
 222 {
 223         efi_status_t r;
 224
 225         EFI_ENTRY("%d, %d, 0x%lx, %p", type, memory_type, pages, memory);
 226         r = efi_allocate_pages(type, memory_type, pages, memory);
 227         return EFI_EXIT(r);
 228 }
 229
 230 /*
 231  * Free memory pages.
 232  *
 233  * This function implements the FreePages service.
 234  * See the Unified Extensible Firmware Interface (UEFI) specification
 235  * for details.
 236  *
 237  * @memory      start of the memory area to be freed
 238  * @pages       number of pages to be freed
 239  * @return      status code
 240  */
 241 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
 242                                               unsigned long pages)
 243 {
 244         efi_status_t r;
 245
 246         EFI_ENTRY("%"PRIx64", 0x%lx", memory, pages);
 247         r = efi_free_pages(memory, pages);
 248         return EFI_EXIT(r);
 249 }
 250
 251 /*
 252  * Get map describing memory usage.
 253  *
 254  * This function implements the GetMemoryMap service.
 255  * See the Unified Extensible Firmware Interface (UEFI) specification
 256  * for details.
 257  *
 258  * @memory_map_size     on entry the size, in bytes, of the memory map buffer,
 259  *                      on exit the size of the copied memory map
 260  * @memory_map          buffer to which the memory map is written
 261  * @map_key             key for the memory map
 262  * @descriptor_size     size of an individual memory descriptor
 263  * @descriptor_version  version number of the memory descriptor structure
 264  * @return              status code
 265  */
 266 static efi_status_t EFIAPI efi_get_memory_map_ext(
 267                                         unsigned long *memory_map_size,
 268                                         struct efi_mem_desc *memory_map,
 269                                         unsigned long *map_key,
 270                                         unsigned long *descriptor_size,
 271                                         uint32_t *descriptor_version)
 272 {
 273         efi_status_t r;
 274
 275         EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
 276                   map_key, descriptor_size, descriptor_version);
 277         r = efi_get_memory_map(memory_map_size, memory_map, map_key,
 278                                descriptor_size, descriptor_version);
 279         return EFI_EXIT(r);
 280 }
 281
 282 /*
 283  * Allocate memory from pool.
 284  *
 285  * This function implements the AllocatePool service.
 286  * See the Unified Extensible Firmware Interface (UEFI) specification
 287  * for details.
 288  *
 289  * @pool_type   type of the pool from which memory is to be allocated
 290  * @size        number of bytes to be allocated
 291  * @buffer      allocated memory
 292  * @return      status code
 293  */
 294 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
 295                                                  unsigned long size,
 296                                                  void **buffer)
 297 {
 298         efi_status_t r;
 299
 300         EFI_ENTRY("%d, %ld, %p", pool_type, size, buffer);
 301         r = efi_allocate_pool(pool_type, size, buffer);
 302         return EFI_EXIT(r);
 303 }
 304
 305 /*
 306  * Free memory from pool.
 307  *
 308  * This function implements the FreePool service.
 309  * See the Unified Extensible Firmware Interface (UEFI) specification
 310  * for details.
 311  *
 312  * @buffer      start of memory to be freed
 313  * @return      status code
 314  */
 315 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
 316 {
 317         efi_status_t r;
 318
 319         EFI_ENTRY("%p", buffer);
 320         r = efi_free_pool(buffer);
 321         return EFI_EXIT(r);
 322 }
 323
 324 static efi_status_t efi_create_handle(void **handle)
 325 {
 326         struct efi_object *obj;
 327         efi_status_t r;
 328
 329         r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
 330                               sizeof(struct efi_object),
 331                               (void **)&obj);
 332         if (r != EFI_SUCCESS)
 333                 return r;
 334         memset(obj, 0, sizeof(struct efi_object));
 335         obj->handle = obj;
 336         list_add_tail(&obj->link, &efi_obj_list);
 337         *handle = obj;
 338         return r;
 339 }
 340
 341 /*
 342  * Our event capabilities are very limited. Only a small limited
 343  * number of events is allowed to coexist.
 344  */
 345 static struct efi_event efi_events[16];
 346
 347 /*
 348  * Create an event.
 349  *
 350  * This function is used inside U-Boot code to create an event.
 351  *
 352  * For the API function implementing the CreateEvent service see
 353  * efi_create_event_ext.
 354  *
 355  * @type                type of the event to create
 356  * @notify_tpl          task priority level of the event
 357  * @notify_function     notification function of the event
 358  * @notify_context      pointer passed to the notification function
 359  * @event               created event
 360  * @return              status code
 361  */
 362 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl,
 363                               void (EFIAPI *notify_function) (
 364                                         struct efi_event *event,
 365                                         void *context),
 366                               void *notify_context, struct efi_event **event)
 367 {
 368         int i;
 369
 370         if (event == NULL)
 371                 return EFI_INVALID_PARAMETER;
 372
 373         if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
 374                 return EFI_INVALID_PARAMETER;
 375
 376         if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
 377             notify_function == NULL)
 378                 return EFI_INVALID_PARAMETER;
 379
 380         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
 381                 if (efi_events[i].type)
 382                         continue;
 383                 efi_events[i].type = type;
 384                 efi_events[i].notify_tpl = notify_tpl;
 385                 efi_events[i].notify_function = notify_function;
 386                 efi_events[i].notify_context = notify_context;
 387                 /* Disable timers on bootup */
 388                 efi_events[i].trigger_next = -1ULL;
 389                 efi_events[i].is_queued = false;
 390                 efi_events[i].is_signaled = false;
 391                 *event = &efi_events[i];
 392                 return EFI_SUCCESS;
 393         }
 394         return EFI_OUT_OF_RESOURCES;
 395 }
 396
 397 /*
 398  * Create an event.
 399  *
 400  * This function implements the CreateEvent service.
 401  * See the Unified Extensible Firmware Interface (UEFI) specification
 402  * for details.
 403  *
 404  * @type                type of the event to create
 405  * @notify_tpl          task priority level of the event
 406  * @notify_function     notification function of the event
 407  * @notify_context      pointer passed to the notification function
 408  * @event               created event
 409  * @return              status code
 410  */
 411 static efi_status_t EFIAPI efi_create_event_ext(
 412                         uint32_t type, UINTN notify_tpl,
 413                         void (EFIAPI *notify_function) (
 414                                         struct efi_event *event,
 415                                         void *context),
 416                         void *notify_context, struct efi_event **event)
 417 {
 418         EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
 419                   notify_context);
 420         return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
 421                                          notify_context, event));
 422 }
 423
 424
 425 /*
 426  * Check if a timer event has occurred or a queued notification function should
 427  * be called.
 428  *
 429  * Our timers have to work without interrupts, so we check whenever keyboard
 430  * input or disk accesses happen if enough time elapsed for them to fire.
 431  */
 432 void efi_timer_check(void)
 433 {
 434         int i;
 435         u64 now = timer_get_us();
 436
 437         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
 438                 if (!efi_events[i].type)
 439                         continue;
 440                 if (efi_events[i].is_queued)
 441                         efi_signal_event(&efi_events[i]);
 442                 if (!(efi_events[i].type & EVT_TIMER) ||
 443                     now < efi_events[i].trigger_next)
 444                         continue;
 445                 switch (efi_events[i].trigger_type) {
 446                 case EFI_TIMER_RELATIVE:
 447                         efi_events[i].trigger_type = EFI_TIMER_STOP;
 448                         break;
 449                 case EFI_TIMER_PERIODIC:
 450                         efi_events[i].trigger_next +=
 451                                 efi_events[i].trigger_time;
 452                         break;
 453                 default:
 454                         continue;
 455                 }
 456                 efi_events[i].is_signaled = true;
 457                 efi_signal_event(&efi_events[i]);
 458         }
 459         WATCHDOG_RESET();
 460 }
 461
 462 /*
 463  * Set the trigger time for a timer event or stop the event.
 464  *
 465  * This is the function for internal usage in U-Boot. For the API function
 466  * implementing the SetTimer service see efi_set_timer_ext.
 467  *
 468  * @event               event for which the timer is set
 469  * @type                type of the timer
 470  * @trigger_time        trigger period in multiples of 100ns
 471  * @return              status code
 472  */
 473 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
 474                            uint64_t trigger_time)
 475 {
 476         int i;
 477
 478         /*
 479          * The parameter defines a multiple of 100ns.
 480          * We use multiples of 1000ns. So divide by 10.
 481          */
 482         do_div(trigger_time, 10);
 483
 484         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
 485                 if (event != &efi_events[i])
 486                         continue;
 487
 488                 if (!(event->type & EVT_TIMER))
 489                         break;
 490                 switch (type) {
 491                 case EFI_TIMER_STOP:
 492                         event->trigger_next = -1ULL;
 493                         break;
 494                 case EFI_TIMER_PERIODIC:
 495                 case EFI_TIMER_RELATIVE:
 496                         event->trigger_next =
 497                                 timer_get_us() + trigger_time;
 498                         break;
 499                 default:
 500                         return EFI_INVALID_PARAMETER;
 501                 }
 502                 event->trigger_type = type;
 503                 event->trigger_time = trigger_time;
 504                 event->is_signaled = false;
 505                 return EFI_SUCCESS;
 506         }
 507         return EFI_INVALID_PARAMETER;
 508 }
 509
 510 /*
 511  * Set the trigger time for a timer event or stop the event.
 512  *
 513  * This function implements the SetTimer service.
 514  * See the Unified Extensible Firmware Interface (UEFI) specification
 515  * for details.
 516  *
 517  * @event               event for which the timer is set
 518  * @type                type of the timer
 519  * @trigger_time        trigger period in multiples of 100ns
 520  * @return              status code
 521  */
 522 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
 523                                              enum efi_timer_delay type,
 524                                              uint64_t trigger_time)
 525 {
 526         EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
 527         return EFI_EXIT(efi_set_timer(event, type, trigger_time));
 528 }
 529
 530 /*
 531  * Wait for events to be signaled.
 532  *
 533  * This function implements the WaitForEvent service.
 534  * See the Unified Extensible Firmware Interface (UEFI) specification
 535  * for details.
 536  *
 537  * @num_events  number of events to be waited for
 538  * @events      events to be waited for
 539  * @index       index of the event that was signaled
 540  * @return      status code
 541  */
 542 static efi_status_t EFIAPI efi_wait_for_event(unsigned long num_events,
 543                                               struct efi_event **event,
 544                                               size_t *index)
 545 {
 546         int i, j;
 547
 548         EFI_ENTRY("%ld, %p, %p", num_events, event, index);
 549
 550         /* Check parameters */
 551         if (!num_events || !event)
 552                 return EFI_EXIT(EFI_INVALID_PARAMETER);
 553         /* Check TPL */
 554         if (efi_tpl != TPL_APPLICATION)
 555                 return EFI_EXIT(EFI_UNSUPPORTED);
 556         for (i = 0; i < num_events; ++i) {
 557                 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
 558                         if (event[i] == &efi_events[j])
 559                                 goto known_event;
 560                 }
 561                 return EFI_EXIT(EFI_INVALID_PARAMETER);
 562 known_event:
 563                 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
 564                         return EFI_EXIT(EFI_INVALID_PARAMETER);
 565                 if (!event[i]->is_signaled)
 566                         efi_signal_event(event[i]);
 567         }
 568
 569         /* Wait for signal */
 570         for (;;) {
 571                 for (i = 0; i < num_events; ++i) {
 572                         if (event[i]->is_signaled)
 573                                 goto out;
 574                 }
 575                 /* Allow events to occur. */
 576                 efi_timer_check();
 577         }
 578
 579 out:
 580         /*
 581          * Reset the signal which is passed to the caller to allow periodic
 582          * events to occur.
 583          */
 584         event[i]->is_signaled = false;
 585         if (index)
 586                 *index = i;
 587
 588         return EFI_EXIT(EFI_SUCCESS);
 589 }
 590
 591 /*
 592  * Signal an EFI event.
 593  *
 594  * This function implements the SignalEvent service.
 595  * See the Unified Extensible Firmware Interface (UEFI) specification
 596  * for details.
 597  *
 598  * This functions sets the signaled state of the event and queues the
 599  * notification function for execution.
 600  *
 601  * @event       event to signal
 602  * @return      status code
 603  */
 604 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
 605 {
 606         int i;
 607
 608         EFI_ENTRY("%p", event);
 609         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
 610                 if (event != &efi_events[i])
 611                         continue;
 612                 if (event->is_signaled)
 613                         break;
 614                 event->is_signaled = true;
 615                 if (event->type & EVT_NOTIFY_SIGNAL)
 616                         efi_signal_event(event);
 617                 break;
 618         }
 619         return EFI_EXIT(EFI_SUCCESS);
 620 }
 621
 622 /*
 623  * Close an EFI event.
 624  *
 625  * This function implements the CloseEvent service.
 626  * See the Unified Extensible Firmware Interface (UEFI) specification
 627  * for details.
 628  *
 629  * @event       event to close
 630  * @return      status code
 631  */
 632 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
 633 {
 634         int i;
 635
 636         EFI_ENTRY("%p", event);
 637         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
 638                 if (event == &efi_events[i]) {
 639                         event->type = 0;
 640                         event->trigger_next = -1ULL;
 641                         event->is_queued = false;
 642                         event->is_signaled = false;
 643                         return EFI_EXIT(EFI_SUCCESS);
 644                 }
 645         }
 646         return EFI_EXIT(EFI_INVALID_PARAMETER);
 647 }
 648
 649 /*
 650  * Check if an event is signaled.
 651  *
 652  * This function implements the CheckEvent service.
 653  * See the Unified Extensible Firmware Interface (UEFI) specification
 654  * for details.
 655  *
 656  * If an event is not signaled yet the notification function is queued.
 657  *
 658  * @event       event to check
 659  * @return      status code
 660  */
 661 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
 662 {
 663         int i;
 664
 665         EFI_ENTRY("%p", event);
 666         efi_timer_check();
 667         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
 668                 if (event != &efi_events[i])
 669                         continue;
 670                 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
 671                         break;
 672                 if (!event->is_signaled)
 673                         efi_signal_event(event);
 674                 if (event->is_signaled)
 675                         return EFI_EXIT(EFI_SUCCESS);
 676                 return EFI_EXIT(EFI_NOT_READY);
 677         }
 678         return EFI_EXIT(EFI_INVALID_PARAMETER);
 679 }
 680
 681 /*
 682  * Find the internal EFI object for a handle.
 683  *
 684  * @handle      handle to find
 685  * @return      EFI object
 686  */
 687 static struct efi_object *efi_search_obj(void *handle)
 688 {
 689         struct list_head *lhandle;
 690
 691         list_for_each(lhandle, &efi_obj_list) {
 692                 struct efi_object *efiobj;
 693
 694                 efiobj = list_entry(lhandle, struct efi_object, link);
 695                 if (efiobj->handle == handle)
 696                         return efiobj;
 697         }
 698
 699         return NULL;
 700 }
 701
 702 /*
 703  * Install protocol interface.
 704  *
 705  * This function implements the InstallProtocolInterface service.
 706  * See the Unified Extensible Firmware Interface (UEFI) specification
 707  * for details.
 708  *
 709  * @handle                      handle on which the protocol shall be installed
 710  * @protocol                    GUID of the protocol to be installed
 711  * @protocol_interface_type     type of the interface to be installed,
 712  *                              always EFI_NATIVE_INTERFACE
 713  * @protocol_interface          interface of the protocol implementation
 714  * @return                      status code
 715  */
 716 static efi_status_t EFIAPI efi_install_protocol_interface(
 717                         void **handle, const efi_guid_t *protocol,
 718                         int protocol_interface_type, void *protocol_interface)
 719 {
 720         struct list_head *lhandle;
 721         int i;
 722         efi_status_t r;
 723
 724         EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
 725                   protocol_interface);
 726
 727         if (!handle || !protocol ||
 728             protocol_interface_type != EFI_NATIVE_INTERFACE) {
 729                 r = EFI_INVALID_PARAMETER;
 730                 goto out;
 731         }
 732
 733         /* Create new handle if requested. */
 734         if (!*handle) {
 735                 r = efi_create_handle(handle);
 736                 if (r != EFI_SUCCESS)
 737                         goto out;
 738         }
 739         /* Find object. */
 740         list_for_each(lhandle, &efi_obj_list) {
 741                 struct efi_object *efiobj;
 742                 efiobj = list_entry(lhandle, struct efi_object, link);
 743
 744                 if (efiobj->handle != *handle)
 745                         continue;
 746                 /* Check if protocol is already installed on the handle. */
 747                 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
 748                         struct efi_handler *handler = &efiobj->protocols[i];
 749
 750                         if (!handler->guid)
 751                                 continue;
 752                         if (!guidcmp(handler->guid, protocol)) {
 753                                 r = EFI_INVALID_PARAMETER;
 754                                 goto out;
 755                         }
 756                 }
 757                 /* Install protocol in first empty slot. */
 758                 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
 759                         struct efi_handler *handler = &efiobj->protocols[i];
 760
 761                         if (handler->guid)
 762                                 continue;
 763
 764                         handler->guid = protocol;
 765                         handler->protocol_interface = protocol_interface;
 766                         r = EFI_SUCCESS;
 767                         goto out;
 768                 }
 769                 r = EFI_OUT_OF_RESOURCES;
 770                 goto out;
 771         }
 772         r = EFI_INVALID_PARAMETER;
 773 out:
 774         return EFI_EXIT(r);
 775 }
 776
 777 /*
 778  * Reinstall protocol interface.
 779  *
 780  * This function implements the ReinstallProtocolInterface service.
 781  * See the Unified Extensible Firmware Interface (UEFI) specification
 782  * for details.
 783  *
 784  * @handle                      handle on which the protocol shall be
 785  *                              reinstalled
 786  * @protocol                    GUID of the protocol to be installed
 787  * @old_interface               interface to be removed
 788  * @new_interface               interface to be installed
 789  * @return                      status code
 790  */
 791 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
 792                         const efi_guid_t *protocol, void *old_interface,
 793                         void *new_interface)
 794 {
 795         EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
 796                   new_interface);
 797         return EFI_EXIT(EFI_ACCESS_DENIED);
 798 }
 799
 800 /*
 801  * Uninstall protocol interface.
 802  *
 803  * This is the function for internal calls. For the API implementation of the
 804  * UninstallProtocolInterface service see function
 805  * efi_uninstall_protocol_interface_ext.
 806  *
 807  * @handle                      handle from which the protocol shall be removed
 808  * @protocol                    GUID of the protocol to be removed
 809  * @protocol_interface          interface to be removed
 810  * @return                      status code
 811  */
 812 static efi_status_t EFIAPI efi_uninstall_protocol_interface(void *handle,
 813                         const efi_guid_t *protocol, void *protocol_interface)
 814 {
 815         struct list_head *lhandle;
 816         int i;
 817         efi_status_t r = EFI_NOT_FOUND;
 818
 819         if (!handle || !protocol) {
 820                 r = EFI_INVALID_PARAMETER;
 821                 goto out;
 822         }
 823
 824         list_for_each(lhandle, &efi_obj_list) {
 825                 struct efi_object *efiobj;
 826                 efiobj = list_entry(lhandle, struct efi_object, link);
 827
 828                 if (efiobj->handle != handle)
 829                         continue;
 830
 831                 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
 832                         struct efi_handler *handler = &efiobj->protocols[i];
 833                         const efi_guid_t *hprotocol = handler->guid;
 834
 835                         if (!hprotocol)
 836                                 continue;
 837                         if (!guidcmp(hprotocol, protocol)) {
 838                                 if (handler->protocol_interface) {
 839                                         r = EFI_ACCESS_DENIED;
 840                                 } else {
 841                                         handler->guid = 0;
 842                                         r = EFI_SUCCESS;
 843                                 }
 844                                 goto out;
 845                         }
 846                 }
 847         }
 848
 849 out:
 850         return r;
 851 }
 852
 853 /*
 854  * Uninstall protocol interface.
 855  *
 856  * This function implements the UninstallProtocolInterface service.
 857  * See the Unified Extensible Firmware Interface (UEFI) specification
 858  * for details.
 859  *
 860  * @handle                      handle from which the protocol shall be removed
 861  * @protocol                    GUID of the protocol to be removed
 862  * @protocol_interface          interface to be removed
 863  * @return                      status code
 864  */
 865 static efi_status_t EFIAPI efi_uninstall_protocol_interface_ext(void *handle,
 866                         const efi_guid_t *protocol, void *protocol_interface)
 867 {
 868         EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
 869
 870         return EFI_EXIT(efi_uninstall_protocol_interface(handle, protocol,
 871                                                          protocol_interface));
 872 }
 873
 874 /*
 875  * Register an event for notification when a protocol is installed.
 876  *
 877  * This function implements the RegisterProtocolNotify service.
 878  * See the Unified Extensible Firmware Interface (UEFI) specification
 879  * for details.
 880  *
 881  * @protocol            GUID of the protocol whose installation shall be
 882  *                      notified
 883  * @event               event to be signaled upon installation of the protocol
 884  * @registration        key for retrieving the registration information
 885  * @return              status code
 886  */
 887 static efi_status_t EFIAPI efi_register_protocol_notify(
 888                                                 const efi_guid_t *protocol,
 889                                                 struct efi_event *event,
 890                                                 void **registration)
 891 {
 892         EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
 893         return EFI_EXIT(EFI_OUT_OF_RESOURCES);
 894 }
 895
 896 /*
 897  * Determine if an EFI handle implements a protocol.
 898  *
 899  * See the documentation of the LocateHandle service in the UEFI specification.
 900  *
 901  * @search_type         selection criterion
 902  * @protocol            GUID of the protocol
 903  * @search_key          registration key
 904  * @efiobj              handle
 905  * @return              0 if the handle implements the protocol
 906  */
 907 static int efi_search(enum efi_locate_search_type search_type,
 908                       const efi_guid_t *protocol, void *search_key,
 909                       struct efi_object *efiobj)
 910 {
 911         int i;
 912
 913         switch (search_type) {
 914         case ALL_HANDLES:
 915                 return 0;
 916         case BY_REGISTER_NOTIFY:
 917                 return -1;
 918         case BY_PROTOCOL:
 919                 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
 920                         const efi_guid_t *guid = efiobj->protocols[i].guid;
 921                         if (guid && !guidcmp(guid, protocol))
 922                                 return 0;
 923                 }
 924                 return -1;
 925         }
 926
 927         return -1;
 928 }
 929
 930 /*
 931  * Locate handles implementing a protocol.
 932  *
 933  * This function is meant for U-Boot internal calls. For the API implementation
 934  * of the LocateHandle service see efi_locate_handle_ext.
 935  *
 936  * @search_type         selection criterion
 937  * @protocol            GUID of the protocol
 938  * @search_key          registration key
 939  * @buffer_size         size of the buffer to receive the handles in bytes
 940  * @buffer              buffer to receive the relevant handles
 941  * @return              status code
 942  */
 943 static efi_status_t efi_locate_handle(
 944                         enum efi_locate_search_type search_type,
 945                         const efi_guid_t *protocol, void *search_key,
 946                         unsigned long *buffer_size, efi_handle_t *buffer)
 947 {
 948         struct list_head *lhandle;
 949         unsigned long size = 0;
 950
 951         /* Count how much space we need */
 952         list_for_each(lhandle, &efi_obj_list) {
 953                 struct efi_object *efiobj;
 954                 efiobj = list_entry(lhandle, struct efi_object, link);
 955                 if (!efi_search(search_type, protocol, search_key, efiobj)) {
 956                         size += sizeof(void*);
 957                 }
 958         }
 959
 960         if (*buffer_size < size) {
 961                 *buffer_size = size;
 962                 return EFI_BUFFER_TOO_SMALL;
 963         }
 964
 965         *buffer_size = size;
 966         if (size == 0)
 967                 return EFI_NOT_FOUND;
 968
 969         /* Then fill the array */
 970         list_for_each(lhandle, &efi_obj_list) {
 971                 struct efi_object *efiobj;
 972                 efiobj = list_entry(lhandle, struct efi_object, link);
 973                 if (!efi_search(search_type, protocol, search_key, efiobj)) {
 974                         *(buffer++) = efiobj->handle;
 975                 }
 976         }
 977
 978         return EFI_SUCCESS;
 979 }
 980
 981 /*
 982  * Locate handles implementing a protocol.
 983  *
 984  * This function implements the LocateHandle service.
 985  * See the Unified Extensible Firmware Interface (UEFI) specification
 986  * for details.
 987  *
 988  * @search_type         selection criterion
 989  * @protocol            GUID of the protocol
 990  * @search_key          registration key
 991  * @buffer_size         size of the buffer to receive the handles in bytes
 992  * @buffer              buffer to receive the relevant handles
 993  * @return              0 if the handle implements the protocol
 994  */
 995 static efi_status_t EFIAPI efi_locate_handle_ext(
 996                         enum efi_locate_search_type search_type,
 997                         const efi_guid_t *protocol, void *search_key,
 998                         unsigned long *buffer_size, efi_handle_t *buffer)
 999 {
1000         EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1001                   buffer_size, buffer);
1002
1003         return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1004                         buffer_size, buffer));
1005 }
1006
1007 /*
1008  * Get the device path and handle of an device implementing a protocol.
1009  *
1010  * This function implements the LocateDevicePath service.
1011  * See the Unified Extensible Firmware Interface (UEFI) specification
1012  * for details.
1013  *
1014  * @protocol            GUID of the protocol
1015  * @device_path         device path
1016  * @device              handle of the device
1017  * @return              status code
1018  */
1019 static efi_status_t EFIAPI efi_locate_device_path(
1020                         const efi_guid_t *protocol,
1021                         struct efi_device_path **device_path,
1022                         efi_handle_t *device)
1023 {
1024         struct efi_object *efiobj;
1025
1026         EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1027
1028         efiobj = efi_dp_find_obj(*device_path, device_path);
1029         if (!efiobj)
1030                 return EFI_EXIT(EFI_NOT_FOUND);
1031
1032         *device = efiobj->handle;
1033
1034         return EFI_EXIT(EFI_SUCCESS);
1035 }
1036
1037 /* Collapses configuration table entries, removing index i */
1038 static void efi_remove_configuration_table(int i)
1039 {
1040         struct efi_configuration_table *this = &efi_conf_table[i];
1041         struct efi_configuration_table *next = &efi_conf_table[i+1];
1042         struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1043
1044         memmove(this, next, (ulong)end - (ulong)next);
1045         systab.nr_tables--;
1046 }
1047
1048 /*
1049  * Adds, updates, or removes a configuration table.
1050  *
1051  * This function is used for internal calls. For the API implementation of the
1052  * InstallConfigurationTable service see efi_install_configuration_table_ext.
1053  *
1054  * @guid                GUID of the installed table
1055  * @table               table to be installed
1056  * @return              status code
1057  */
1058 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1059 {
1060         int i;
1061
1062         /* Check for guid override */
1063         for (i = 0; i < systab.nr_tables; i++) {
1064                 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1065                         if (table)
1066                                 efi_conf_table[i].table = table;
1067                         else
1068                                 efi_remove_configuration_table(i);
1069                         return EFI_SUCCESS;
1070                 }
1071         }
1072
1073         if (!table)
1074                 return EFI_NOT_FOUND;
1075
1076         /* No override, check for overflow */
1077         if (i >= ARRAY_SIZE(efi_conf_table))
1078                 return EFI_OUT_OF_RESOURCES;
1079
1080         /* Add a new entry */
1081         memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1082         efi_conf_table[i].table = table;
1083         systab.nr_tables = i + 1;
1084
1085         return EFI_SUCCESS;
1086 }
1087
1088 /*
1089  * Adds, updates, or removes a configuration table.
1090  *
1091  * This function implements the InstallConfigurationTable service.
1092  * See the Unified Extensible Firmware Interface (UEFI) specification
1093  * for details.
1094  *
1095  * @guid                GUID of the installed table
1096  * @table               table to be installed
1097  * @return              status code
1098  */
1099 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1100                                                                void *table)
1101 {
1102         EFI_ENTRY("%pUl, %p", guid, table);
1103         return EFI_EXIT(efi_install_configuration_table(guid, table));
1104 }
1105
1106 /*
1107  * Initialize a loaded_image_info + loaded_image_info object with correct
1108  * protocols, boot-device, etc.
1109  *
1110  * @info                loaded image info to be passed to the entry point of the
1111  *                      image
1112  * @obj                 internal object associated with the loaded image
1113  * @device_path         device path of the loaded image
1114  * @file_path           file path of the loaded image
1115  */
1116 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
1117                             struct efi_device_path *device_path,
1118                             struct efi_device_path *file_path)
1119 {
1120         obj->handle = info;
1121
1122         /*
1123          * When asking for the device path interface, return
1124          * bootefi_device_path
1125          */
1126         obj->protocols[0].guid = &efi_guid_device_path;
1127         obj->protocols[0].protocol_interface = device_path;
1128
1129         /*
1130          * When asking for the loaded_image interface, just
1131          * return handle which points to loaded_image_info
1132          */
1133         obj->protocols[1].guid = &efi_guid_loaded_image;
1134         obj->protocols[1].protocol_interface = info;
1135
1136         obj->protocols[2].guid = &efi_guid_console_control;
1137         obj->protocols[2].protocol_interface = (void *)&efi_console_control;
1138
1139         obj->protocols[3].guid = &efi_guid_device_path_to_text_protocol;
1140         obj->protocols[3].protocol_interface =
1141                 (void *)&efi_device_path_to_text;
1142
1143         info->file_path = file_path;
1144         if (device_path)
1145                 info->device_handle = efi_dp_find_obj(device_path, NULL);
1146
1147         list_add_tail(&obj->link, &efi_obj_list);
1148 }
1149
1150 /*
1151  * Load an image using a file path.
1152  *
1153  * @file_path           the path of the image to load
1154  * @buffer              buffer containing the loaded image
1155  * @return              status code
1156  */
1157 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1158                                       void **buffer)
1159 {
1160         struct efi_file_info *info = NULL;
1161         struct efi_file_handle *f;
1162         static efi_status_t ret;
1163         uint64_t bs;
1164
1165         f = efi_file_from_path(file_path);
1166         if (!f)
1167                 return EFI_DEVICE_ERROR;
1168
1169         bs = 0;
1170         EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1171                                   &bs, info));
1172         if (ret == EFI_BUFFER_TOO_SMALL) {
1173                 info = malloc(bs);
1174                 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1175                                           &bs, info));
1176         }
1177         if (ret != EFI_SUCCESS)
1178                 goto error;
1179
1180         ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1181         if (ret)
1182                 goto error;
1183
1184         EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1185
1186 error:
1187         free(info);
1188         EFI_CALL(f->close(f));
1189
1190         if (ret != EFI_SUCCESS) {
1191                 efi_free_pool(*buffer);
1192                 *buffer = NULL;
1193         }
1194
1195         return ret;
1196 }
1197
1198 /*
1199  * Load an EFI image into memory.
1200  *
1201  * This function implements the LoadImage service.
1202  * See the Unified Extensible Firmware Interface (UEFI) specification
1203  * for details.
1204  *
1205  * @boot_policy         true for request originating from the boot manager
1206  * @parent_image        the calles's image handle
1207  * @file_path           the path of the image to load
1208  * @source_buffer       memory location from which the image is installed
1209  * @source_size         size of the memory area from which the image is
1210  *                      installed
1211  * @image_handle        handle for the newly installed image
1212  * @return              status code
1213  */
1214 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1215                                           efi_handle_t parent_image,
1216                                           struct efi_device_path *file_path,
1217                                           void *source_buffer,
1218                                           unsigned long source_size,
1219                                           efi_handle_t *image_handle)
1220 {
1221         struct efi_loaded_image *info;
1222         struct efi_object *obj;
1223
1224         EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1225                   file_path, source_buffer, source_size, image_handle);
1226
1227         info = calloc(1, sizeof(*info));
1228         obj = calloc(1, sizeof(*obj));
1229
1230         if (!source_buffer) {
1231                 struct efi_device_path *dp, *fp;
1232                 efi_status_t ret;
1233
1234                 ret = efi_load_image_from_path(file_path, &source_buffer);
1235                 if (ret != EFI_SUCCESS) {
1236                         free(info);
1237                         free(obj);
1238                         return EFI_EXIT(ret);
1239                 }
1240
1241                 /*
1242                  * split file_path which contains both the device and
1243                  * file parts:
1244                  */
1245                 efi_dp_split_file_path(file_path, &dp, &fp);
1246
1247                 efi_setup_loaded_image(info, obj, dp, fp);
1248         } else {
1249                 /* In this case, file_path is the "device" path, ie.
1250                  * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1251                  */
1252                 efi_setup_loaded_image(info, obj, file_path, NULL);
1253         }
1254
1255         info->reserved = efi_load_pe(source_buffer, info);
1256         if (!info->reserved) {
1257                 free(info);
1258                 free(obj);
1259                 return EFI_EXIT(EFI_UNSUPPORTED);
1260         }
1261
1262         info->system_table = &systab;
1263         info->parent_handle = parent_image;
1264         *image_handle = info;
1265
1266         return EFI_EXIT(EFI_SUCCESS);
1267 }
1268
1269 /*
1270  * Call the entry point of an image.
1271  *
1272  * This function implements the StartImage service.
1273  * See the Unified Extensible Firmware Interface (UEFI) specification
1274  * for details.
1275  *
1276  * @image_handle        handle of the image
1277  * @exit_data_size      size of the buffer
1278  * @exit_data           buffer to receive the exit data of the called image
1279  * @return              status code
1280  */
1281 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1282                                            unsigned long *exit_data_size,
1283                                            s16 **exit_data)
1284 {
1285         ulong (*entry)(void *image_handle, struct efi_system_table *st);
1286         struct efi_loaded_image *info = image_handle;
1287
1288         EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1289         entry = info->reserved;
1290
1291         efi_is_direct_boot = false;
1292
1293         /* call the image! */
1294         if (setjmp(&info->exit_jmp)) {
1295                 /* We returned from the child image */
1296                 return EFI_EXIT(info->exit_status);
1297         }
1298
1299         __efi_nesting_dec();
1300         __efi_exit_check();
1301         entry(image_handle, &systab);
1302         __efi_entry_check();
1303         __efi_nesting_inc();
1304
1305         /* Should usually never get here */
1306         return EFI_EXIT(EFI_SUCCESS);
1307 }
1308
1309 /*
1310  * Leave an EFI application or driver.
1311  *
1312  * This function implements the Exit service.
1313  * See the Unified Extensible Firmware Interface (UEFI) specification
1314  * for details.
1315  *
1316  * @image_handle        handle of the application or driver that is exiting
1317  * @exit_status         status code
1318  * @exit_data_size      size of the buffer in bytes
1319  * @exit_data           buffer with data describing an error
1320  * @return              status code
1321  */
1322 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1323                         efi_status_t exit_status, unsigned long exit_data_size,
1324                         int16_t *exit_data)
1325 {
1326         struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1327
1328         EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1329                   exit_data_size, exit_data);
1330
1331         /* Make sure entry/exit counts for EFI world cross-overs match */
1332         __efi_exit_check();
1333
1334         /*
1335          * But longjmp out with the U-Boot gd, not the application's, as
1336          * the other end is a setjmp call inside EFI context.
1337          */
1338         efi_restore_gd();
1339
1340         loaded_image_info->exit_status = exit_status;
1341         longjmp(&loaded_image_info->exit_jmp, 1);
1342
1343         panic("EFI application exited");
1344 }
1345
1346 /*
1347  * Unload an EFI image.
1348  *
1349  * This function implements the UnloadImage service.
1350  * See the Unified Extensible Firmware Interface (UEFI) specification
1351  * for details.
1352  *
1353  * @image_handle        handle of the image to be unloaded
1354  * @return              status code
1355  */
1356 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1357 {
1358         struct efi_object *efiobj;
1359
1360         EFI_ENTRY("%p", image_handle);
1361         efiobj = efi_search_obj(image_handle);
1362         if (efiobj)
1363                 list_del(&efiobj->link);
1364
1365         return EFI_EXIT(EFI_SUCCESS);
1366 }
1367
1368 /*
1369  * Fix up caches for EFI payloads if necessary.
1370  */
1371 static void efi_exit_caches(void)
1372 {
1373 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1374         /*
1375          * Grub on 32bit ARM needs to have caches disabled before jumping into
1376          * a zImage, but does not know of all cache layers. Give it a hand.
1377          */
1378         if (efi_is_direct_boot)
1379                 cleanup_before_linux();
1380 #endif
1381 }
1382
1383 /*
1384  * Stop boot services.
1385  *
1386  * This function implements the ExitBootServices service.
1387  * See the Unified Extensible Firmware Interface (UEFI) specification
1388  * for details.
1389  *
1390  * @image_handle        handle of the loaded image
1391  * @map_key             key of the memory map
1392  * @return              status code
1393  */
1394 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1395                                                   unsigned long map_key)
1396 {
1397         int i;
1398
1399         EFI_ENTRY("%p, %ld", image_handle, map_key);
1400
1401         /* Notify that ExitBootServices is invoked. */
1402         for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1403                 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1404                         continue;
1405                 efi_signal_event(&efi_events[i]);
1406         }
1407         /* Make sure that notification functions are not called anymore */
1408         efi_tpl = TPL_HIGH_LEVEL;
1409
1410         /* XXX Should persist EFI variables here */
1411
1412         board_quiesce_devices();
1413
1414         /* Fix up caches for EFI payloads if necessary */
1415         efi_exit_caches();
1416
1417         /* This stops all lingering devices */
1418         bootm_disable_interrupts();
1419
1420         /* Give the payload some time to boot */
1421         efi_set_watchdog(0);
1422         WATCHDOG_RESET();
1423
1424         return EFI_EXIT(EFI_SUCCESS);
1425 }
1426
1427 /*
1428  * Get next value of the counter.
1429  *
1430  * This function implements the NextMonotonicCount service.
1431  * See the Unified Extensible Firmware Interface (UEFI) specification
1432  * for details.
1433  *
1434  * @count       returned value of the counter
1435  * @return      status code
1436  */
1437 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1438 {
1439         static uint64_t mono = 0;
1440         EFI_ENTRY("%p", count);
1441         *count = mono++;
1442         return EFI_EXIT(EFI_SUCCESS);
1443 }
1444
1445 /*
1446  * Sleep.
1447  *
1448  * This function implements the Stall sercive.
1449  * See the Unified Extensible Firmware Interface (UEFI) specification
1450  * for details.
1451  *
1452  * @microseconds        period to sleep in microseconds
1453  * @return              status code
1454  */
1455 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1456 {
1457         EFI_ENTRY("%ld", microseconds);
1458         udelay(microseconds);
1459         return EFI_EXIT(EFI_SUCCESS);
1460 }
1461
1462 /*
1463  * Reset the watchdog timer.
1464  *
1465  * This function implements the SetWatchdogTimer service.
1466  * See the Unified Extensible Firmware Interface (UEFI) specification
1467  * for details.
1468  *
1469  * @timeout             seconds before reset by watchdog
1470  * @watchdog_code       code to be logged when resetting
1471  * @data_size           size of buffer in bytes
1472  * @watchdog_data       buffer with data describing the reset reason
1473  * @return              status code
1474  */
1475 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1476                                                   uint64_t watchdog_code,
1477                                                   unsigned long data_size,
1478                                                   uint16_t *watchdog_data)
1479 {
1480         EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1481                   data_size, watchdog_data);
1482         return EFI_EXIT(efi_set_watchdog(timeout));
1483 }
1484
1485 /*
1486  * Connect a controller to a driver.
1487  *
1488  * This function implements the ConnectController service.
1489  * See the Unified Extensible Firmware Interface (UEFI) specification
1490  * for details.
1491  *
1492  * @controller_handle   handle of the controller
1493  * @driver_image_handle handle of the driver
1494  * @remain_device_path  device path of a child controller
1495  * @recursive           true to connect all child controllers
1496  * @return              status code
1497  */
1498 static efi_status_t EFIAPI efi_connect_controller(
1499                         efi_handle_t controller_handle,
1500                         efi_handle_t *driver_image_handle,
1501                         struct efi_device_path *remain_device_path,
1502                         bool recursive)
1503 {
1504         EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1505                   remain_device_path, recursive);
1506         return EFI_EXIT(EFI_NOT_FOUND);
1507 }
1508
1509 /*
1510  * Disconnect a controller from a driver.
1511  *
1512  * This function implements the DisconnectController service.
1513  * See the Unified Extensible Firmware Interface (UEFI) specification
1514  * for details.
1515  *
1516  * @controller_handle   handle of the controller
1517  * @driver_image_handle handle of the driver
1518  * @child_handle        handle of the child to destroy
1519  * @return              status code
1520  */
1521 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1522                                                      void *driver_image_handle,
1523                                                      void *child_handle)
1524 {
1525         EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1526                   child_handle);
1527         return EFI_EXIT(EFI_INVALID_PARAMETER);
1528 }
1529
1530 /*
1531  * Close a protocol.
1532  *
1533  * This function implements the CloseProtocol service.
1534  * See the Unified Extensible Firmware Interface (UEFI) specification
1535  * for details.
1536  *
1537  * @handle              handle on which the protocol shall be closed
1538  * @protocol            GUID of the protocol to close
1539  * @agent_handle        handle of the driver
1540  * @controller_handle   handle of the controller
1541  * @return              status code
1542  */
1543 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1544                                               const efi_guid_t *protocol,
1545                                               void *agent_handle,
1546                                               void *controller_handle)
1547 {
1548         EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1549                   controller_handle);
1550         return EFI_EXIT(EFI_NOT_FOUND);
1551 }
1552
1553 /*
1554  * Provide information about then open status of a protocol on a handle
1555  *
1556  * This function implements the OpenProtocolInformation service.
1557  * See the Unified Extensible Firmware Interface (UEFI) specification
1558  * for details.
1559  *
1560  * @handle              handle for which the information shall be retrieved
1561  * @protocol            GUID of the protocol
1562  * @entry_buffer        buffer to receive the open protocol information
1563  * @entry_count         number of entries available in the buffer
1564  * @return              status code
1565  */
1566 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1567                         const efi_guid_t *protocol,
1568                         struct efi_open_protocol_info_entry **entry_buffer,
1569                         unsigned long *entry_count)
1570 {
1571         EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1572                   entry_count);
1573         return EFI_EXIT(EFI_NOT_FOUND);
1574 }
1575
1576 /*
1577  * Get protocols installed on a handle.
1578  *
1579  * This function implements the ProtocolsPerHandleService.
1580  * See the Unified Extensible Firmware Interface (UEFI) specification
1581  * for details.
1582  *
1583  * @handle                      handle for which the information is retrieved
1584  * @protocol_buffer             buffer with protocol GUIDs
1585  * @protocol_buffer_count       number of entries in the buffer
1586  * @return                      status code
1587  */
1588 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1589                         efi_guid_t ***protocol_buffer,
1590                         unsigned long *protocol_buffer_count)
1591 {
1592         unsigned long buffer_size;
1593         struct efi_object *efiobj;
1594         unsigned long i, j;
1595         struct list_head *lhandle;
1596         efi_status_t r;
1597
1598         EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1599                   protocol_buffer_count);
1600
1601         if (!handle || !protocol_buffer || !protocol_buffer_count)
1602                 return EFI_EXIT(EFI_INVALID_PARAMETER);
1603
1604         *protocol_buffer = NULL;
1605         *protocol_buffer_count = 0;
1606         list_for_each(lhandle, &efi_obj_list) {
1607                 efiobj = list_entry(lhandle, struct efi_object, link);
1608
1609                 if (efiobj->handle != handle)
1610                         continue;
1611
1612                 /* Count protocols */
1613                 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1614                         if (efiobj->protocols[i].guid)
1615                                 ++*protocol_buffer_count;
1616                 }
1617                 /* Copy guids */
1618                 if (*protocol_buffer_count) {
1619                         buffer_size = sizeof(efi_guid_t *) *
1620                                         *protocol_buffer_count;
1621                         r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
1622                                               buffer_size,
1623                                               (void **)protocol_buffer);
1624                         if (r != EFI_SUCCESS)
1625                                 return EFI_EXIT(r);
1626                         j = 0;
1627                         for (i = 0; i < ARRAY_SIZE(efiobj->protocols); ++i) {
1628                                 if (efiobj->protocols[i].guid) {
1629                                         (*protocol_buffer)[j] = (void *)
1630                                                 efiobj->protocols[i].guid;
1631                                         ++j;
1632                                 }
1633                         }
1634                 }
1635                 break;
1636         }
1637
1638         return EFI_EXIT(EFI_SUCCESS);
1639 }
1640
1641 /*
1642  * Locate handles implementing a protocol.
1643  *
1644  * This function implements the LocateHandleBuffer service.
1645  * See the Unified Extensible Firmware Interface (UEFI) specification
1646  * for details.
1647  *
1648  * @search_type         selection criterion
1649  * @protocol            GUID of the protocol
1650  * @search_key          registration key
1651  * @no_handles          number of returned handles
1652  * @buffer              buffer with the returned handles
1653  * @return              status code
1654  */
1655 static efi_status_t EFIAPI efi_locate_handle_buffer(
1656                         enum efi_locate_search_type search_type,
1657                         const efi_guid_t *protocol, void *search_key,
1658                         unsigned long *no_handles, efi_handle_t **buffer)
1659 {
1660         efi_status_t r;
1661         unsigned long buffer_size = 0;
1662
1663         EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1664                   no_handles, buffer);
1665
1666         if (!no_handles || !buffer) {
1667                 r = EFI_INVALID_PARAMETER;
1668                 goto out;
1669         }
1670         *no_handles = 0;
1671         *buffer = NULL;
1672         r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1673                               *buffer);
1674         if (r != EFI_BUFFER_TOO_SMALL)
1675                 goto out;
1676         r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1677                               (void **)buffer);
1678         if (r != EFI_SUCCESS)
1679                 goto out;
1680         r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1681                               *buffer);
1682         if (r == EFI_SUCCESS)
1683                 *no_handles = buffer_size / sizeof(void *);
1684 out:
1685         return EFI_EXIT(r);
1686 }
1687
1688 /*
1689  * Find an interface implementing a protocol.
1690  *
1691  * This function implements the LocateProtocol service.
1692  * See the Unified Extensible Firmware Interface (UEFI) specification
1693  * for details.
1694  *
1695  * @protocol            GUID of the protocol
1696  * @registration        registration key passed to the notification function
1697  * @protocol_interface  interface implementing the protocol
1698  * @return              status code
1699  */
1700 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1701                                                void *registration,
1702                                                void **protocol_interface)
1703 {
1704         struct list_head *lhandle;
1705         int i;
1706
1707         EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1708
1709         if (!protocol || !protocol_interface)
1710                 return EFI_EXIT(EFI_INVALID_PARAMETER);
1711
1712         EFI_PRINT_GUID("protocol", protocol);
1713
1714         list_for_each(lhandle, &efi_obj_list) {
1715                 struct efi_object *efiobj;
1716
1717                 efiobj = list_entry(lhandle, struct efi_object, link);
1718                 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1719                         struct efi_handler *handler = &efiobj->protocols[i];
1720
1721                         if (!handler->guid)
1722                                 continue;
1723                         if (!guidcmp(handler->guid, protocol)) {
1724                                 *protocol_interface =
1725                                         handler->protocol_interface;
1726                                 return EFI_EXIT(EFI_SUCCESS);
1727                         }
1728                 }
1729         }
1730         *protocol_interface = NULL;
1731
1732         return EFI_EXIT(EFI_NOT_FOUND);
1733 }
1734
1735 /*
1736  * Install multiple protocol interfaces.
1737  *
1738  * This function implements the MultipleProtocolInterfaces service.
1739  * See the Unified Extensible Firmware Interface (UEFI) specification
1740  * for details.
1741  *
1742  * @handle      handle on which the protocol interfaces shall be installed
1743  * @...         NULL terminated argument list with pairs of protocol GUIDS and
1744  *              interfaces
1745  * @return      status code
1746  */
1747 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
1748                         void **handle, ...)
1749 {
1750         EFI_ENTRY("%p", handle);
1751
1752         va_list argptr;
1753         const efi_guid_t *protocol;
1754         void *protocol_interface;
1755         efi_status_t r = EFI_SUCCESS;
1756         int i = 0;
1757
1758         if (!handle)
1759                 return EFI_EXIT(EFI_INVALID_PARAMETER);
1760
1761         va_start(argptr, handle);
1762         for (;;) {
1763                 protocol = va_arg(argptr, efi_guid_t*);
1764                 if (!protocol)
1765                         break;
1766                 protocol_interface = va_arg(argptr, void*);
1767                 r = EFI_CALL(efi_install_protocol_interface(
1768                                                 handle, protocol,
1769                                                 EFI_NATIVE_INTERFACE,
1770                                                 protocol_interface));
1771                 if (r != EFI_SUCCESS)
1772                         break;
1773                 i++;
1774         }
1775         va_end(argptr);
1776         if (r == EFI_SUCCESS)
1777                 return EFI_EXIT(r);
1778
1779         /* If an error occured undo all changes. */
1780         va_start(argptr, handle);
1781         for (; i; --i) {
1782                 protocol = va_arg(argptr, efi_guid_t*);
1783                 protocol_interface = va_arg(argptr, void*);
1784                 efi_uninstall_protocol_interface(handle, protocol,
1785                                                  protocol_interface);
1786         }
1787         va_end(argptr);
1788
1789         return EFI_EXIT(r);
1790 }
1791
1792 /*
1793  * Uninstall multiple protocol interfaces.
1794  *
1795  * This function implements the UninstallMultipleProtocolInterfaces service.
1796  * See the Unified Extensible Firmware Interface (UEFI) specification
1797  * for details.
1798  *
1799  * @handle      handle from which the protocol interfaces shall be removed
1800  * @...         NULL terminated argument list with pairs of protocol GUIDS and
1801  *              interfaces
1802  * @return      status code
1803  */
1804 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
1805                         void *handle, ...)
1806 {
1807         EFI_ENTRY("%p", handle);
1808         return EFI_EXIT(EFI_INVALID_PARAMETER);
1809 }
1810
1811 /*
1812  * Calculate cyclic redundancy code.
1813  *
1814  * This function implements the CalculateCrc32 service.
1815  * See the Unified Extensible Firmware Interface (UEFI) specification
1816  * for details.
1817  *
1818  * @data        buffer with data
1819  * @data_size   size of buffer in bytes
1820  * @crc32_p     cyclic redundancy code
1821  * @return      status code
1822  */
1823 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
1824                                                unsigned long data_size,
1825                                                uint32_t *crc32_p)
1826 {
1827         EFI_ENTRY("%p, %ld", data, data_size);
1828         *crc32_p = crc32(0, data, data_size);
1829         return EFI_EXIT(EFI_SUCCESS);
1830 }
1831
1832 /*
1833  * Copy memory.
1834  *
1835  * This function implements the CopyMem service.
1836  * See the Unified Extensible Firmware Interface (UEFI) specification
1837  * for details.
1838  *
1839  * @destination         destination of the copy operation
1840  * @source              source of the copy operation
1841  * @length              number of bytes to copy
1842  */
1843 static void EFIAPI efi_copy_mem(void *destination, const void *source,
1844                                 size_t length)
1845 {
1846         EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
1847         memcpy(destination, source, length);
1848         EFI_EXIT(EFI_SUCCESS);
1849 }
1850
1851 /*
1852  * Fill memory with a byte value.
1853  *
1854  * This function implements the SetMem service.
1855  * See the Unified Extensible Firmware Interface (UEFI) specification
1856  * for details.
1857  *
1858  * @buffer              buffer to fill
1859  * @size                size of buffer in bytes
1860  * @value               byte to copy to the buffer
1861  */
1862 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
1863 {
1864         EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
1865         memset(buffer, value, size);
1866         EFI_EXIT(EFI_SUCCESS);
1867 }
1868
1869 /*
1870  * Open protocol interface on a handle.
1871  *
1872  * This function implements the OpenProtocol interface.
1873  * See the Unified Extensible Firmware Interface (UEFI) specification
1874  * for details.
1875  *
1876  * @handle              handle on which the protocol shall be opened
1877  * @protocol            GUID of the protocol
1878  * @protocol_interface  interface implementing the protocol
1879  * @agent_handle        handle of the driver
1880  * @controller_handle   handle of the controller
1881  * @attributes          attributes indicating how to open the protocol
1882  * @return              status code
1883  */
1884 static efi_status_t EFIAPI efi_open_protocol(
1885                         void *handle, const efi_guid_t *protocol,
1886                         void **protocol_interface, void *agent_handle,
1887                         void *controller_handle, uint32_t attributes)
1888 {
1889         struct list_head *lhandle;
1890         int i;
1891         efi_status_t r = EFI_INVALID_PARAMETER;
1892
1893         EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
1894                   protocol_interface, agent_handle, controller_handle,
1895                   attributes);
1896
1897         if (!handle || !protocol ||
1898             (!protocol_interface && attributes !=
1899              EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
1900                 goto out;
1901         }
1902
1903         EFI_PRINT_GUID("protocol", protocol);
1904
1905         switch (attributes) {
1906         case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
1907         case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
1908         case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
1909                 break;
1910         case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
1911                 if (controller_handle == handle)
1912                         goto out;
1913         case EFI_OPEN_PROTOCOL_BY_DRIVER:
1914         case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
1915                 if (controller_handle == NULL)
1916                         goto out;
1917         case EFI_OPEN_PROTOCOL_EXCLUSIVE:
1918                 if (agent_handle == NULL)
1919                         goto out;
1920                 break;
1921         default:
1922                 goto out;
1923         }
1924
1925         list_for_each(lhandle, &efi_obj_list) {
1926                 struct efi_object *efiobj;
1927                 efiobj = list_entry(lhandle, struct efi_object, link);
1928
1929                 if (efiobj->handle != handle)
1930                         continue;
1931
1932                 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1933                         struct efi_handler *handler = &efiobj->protocols[i];
1934                         const efi_guid_t *hprotocol = handler->guid;
1935                         if (!hprotocol)
1936                                 continue;
1937                         if (!guidcmp(hprotocol, protocol)) {
1938                                 if (attributes !=
1939                                     EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {
1940                                         *protocol_interface =
1941                                                 handler->protocol_interface;
1942                                 }
1943                                 r = EFI_SUCCESS;
1944                                 goto out;
1945                         }
1946                 }
1947                 goto unsupported;
1948         }
1949
1950 unsupported:
1951         r = EFI_UNSUPPORTED;
1952 out:
1953         return EFI_EXIT(r);
1954 }
1955
1956 /*
1957  * Get interface of a protocol on a handle.
1958  *
1959  * This function implements the HandleProtocol service.
1960  * See the Unified Extensible Firmware Interface (UEFI) specification
1961  * for details.
1962  *
1963  * @handle              handle on which the protocol shall be opened
1964  * @protocol            GUID of the protocol
1965  * @protocol_interface  interface implementing the protocol
1966  * @return              status code
1967  */
1968 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
1969                                                const efi_guid_t *protocol,
1970                                                void **protocol_interface)
1971 {
1972         return efi_open_protocol(handle, protocol, protocol_interface, NULL,
1973                                  NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
1974 }
1975
1976 static const struct efi_boot_services efi_boot_services = {
1977         .hdr = {
1978                 .headersize = sizeof(struct efi_table_hdr),
1979         },
1980         .raise_tpl = efi_raise_tpl,
1981         .restore_tpl = efi_restore_tpl,
1982         .allocate_pages = efi_allocate_pages_ext,
1983         .free_pages = efi_free_pages_ext,
1984         .get_memory_map = efi_get_memory_map_ext,
1985         .allocate_pool = efi_allocate_pool_ext,
1986         .free_pool = efi_free_pool_ext,
1987         .create_event = efi_create_event_ext,
1988         .set_timer = efi_set_timer_ext,
1989         .wait_for_event = efi_wait_for_event,
1990         .signal_event = efi_signal_event_ext,
1991         .close_event = efi_close_event,
1992         .check_event = efi_check_event,
1993         .install_protocol_interface = efi_install_protocol_interface,
1994         .reinstall_protocol_interface = efi_reinstall_protocol_interface,
1995         .uninstall_protocol_interface = efi_uninstall_protocol_interface_ext,
1996         .handle_protocol = efi_handle_protocol,
1997         .reserved = NULL,
1998         .register_protocol_notify = efi_register_protocol_notify,
1999         .locate_handle = efi_locate_handle_ext,
2000         .locate_device_path = efi_locate_device_path,
2001         .install_configuration_table = efi_install_configuration_table_ext,
2002         .load_image = efi_load_image,
2003         .start_image = efi_start_image,
2004         .exit = efi_exit,
2005         .unload_image = efi_unload_image,
2006         .exit_boot_services = efi_exit_boot_services,
2007         .get_next_monotonic_count = efi_get_next_monotonic_count,
2008         .stall = efi_stall,
2009         .set_watchdog_timer = efi_set_watchdog_timer,
2010         .connect_controller = efi_connect_controller,
2011         .disconnect_controller = efi_disconnect_controller,
2012         .open_protocol = efi_open_protocol,
2013         .close_protocol = efi_close_protocol,
2014         .open_protocol_information = efi_open_protocol_information,
2015         .protocols_per_handle = efi_protocols_per_handle,
2016         .locate_handle_buffer = efi_locate_handle_buffer,
2017         .locate_protocol = efi_locate_protocol,
2018         .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2019         .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2020         .calculate_crc32 = efi_calculate_crc32,
2021         .copy_mem = efi_copy_mem,
2022         .set_mem = efi_set_mem,
2023 };
2024
2025
2026 static uint16_t __efi_runtime_data firmware_vendor[] =
2027         { 'D','a','s',' ','U','-','b','o','o','t',0 };
2028
2029 struct efi_system_table __efi_runtime_data systab = {
2030         .hdr = {
2031                 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2032                 .revision = 0x20005, /* 2.5 */
2033                 .headersize = sizeof(struct efi_table_hdr),
2034         },
2035         .fw_vendor = (long)firmware_vendor,
2036         .con_in = (void*)&efi_con_in,
2037         .con_out = (void*)&efi_con_out,
2038         .std_err = (void*)&efi_con_out,
2039         .runtime = (void*)&efi_runtime_services,
2040         .boottime = (void*)&efi_boot_services,
2041         .nr_tables = 0,
2042         .tables = (void*)efi_conf_table,
2043 };