lib/efi_loader/efi_runtime.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  EFI application runtime services
   4  *
   5  *  Copyright (c) 2016 Alexander Graf
   6  */
   7
   8 #include <common.h>
   9 #include <command.h>
  10 #include <dm.h>
  11 #include <elf.h>
  12 #include <efi_loader.h>
  13 #include <rtc.h>
  14
  15 /* For manual relocation support */
  16 DECLARE_GLOBAL_DATA_PTR;
  17
  18 struct efi_runtime_mmio_list {
  19         struct list_head link;
  20         void **ptr;
  21         u64 paddr;
  22         u64 len;
  23 };
  24
  25 /* This list contains all runtime available mmio regions */
  26 LIST_HEAD(efi_runtime_mmio);
  27
  28 static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void);
  29
  30 /*
  31  * TODO(sjg@chromium.org): These defines and structures should come from the ELF
  32  * header for each architecture (or a generic header) rather than being repeated
  33  * here.
  34  */
  35 #if defined(__aarch64__)
  36 #define R_RELATIVE      R_AARCH64_RELATIVE
  37 #define R_MASK          0xffffffffULL
  38 #define IS_RELA         1
  39 #elif defined(__arm__)
  40 #define R_RELATIVE      R_ARM_RELATIVE
  41 #define R_MASK          0xffULL
  42 #elif defined(__i386__)
  43 #define R_RELATIVE      R_386_RELATIVE
  44 #define R_MASK          0xffULL
  45 #elif defined(__x86_64__)
  46 #define R_RELATIVE      R_X86_64_RELATIVE
  47 #define R_MASK          0xffffffffULL
  48 #define IS_RELA         1
  49 #elif defined(__riscv)
  50 #define R_RELATIVE      R_RISCV_RELATIVE
  51 #define R_MASK          0xffULL
  52 #define IS_RELA         1
  53
  54 struct dyn_sym {
  55         ulong foo1;
  56         ulong addr;
  57         u32 foo2;
  58         u32 foo3;
  59 };
  60 #if (__riscv_xlen == 32)
  61 #define R_ABSOLUTE      R_RISCV_32
  62 #define SYM_INDEX       8
  63 #elif (__riscv_xlen == 64)
  64 #define R_ABSOLUTE      R_RISCV_64
  65 #define SYM_INDEX       32
  66 #else
  67 #error unknown riscv target
  68 #endif
  69 #else
  70 #error Need to add relocation awareness
  71 #endif
  72
  73 struct elf_rel {
  74         ulong *offset;
  75         ulong info;
  76 };
  77
  78 struct elf_rela {
  79         ulong *offset;
  80         ulong info;
  81         long addend;
  82 };
  83
  84 static __efi_runtime_data struct efi_mem_desc *efi_virtmap;
  85 static __efi_runtime_data efi_uintn_t efi_descriptor_count;
  86 static __efi_runtime_data efi_uintn_t efi_descriptor_size;
  87
  88 /*
  89  * EFI runtime code lives in two stages. In the first stage, U-Boot and an EFI
  90  * payload are running concurrently at the same time. In this mode, we can
  91  * handle a good number of runtime callbacks
  92  */
  93
  94 efi_status_t efi_init_runtime_supported(void)
  95 {
  96         u16 efi_runtime_services_supported =
  97                                 EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP |
  98                                 EFI_RT_SUPPORTED_CONVERT_POINTER;
  99
 100         /*
 101          * This value must be synced with efi_runtime_detach_list
 102          * as well as efi_runtime_services.
 103          */
 104 #ifdef CONFIG_EFI_HAVE_RUNTIME_RESET
 105         efi_runtime_services_supported |= EFI_RT_SUPPORTED_RESET_SYSTEM;
 106 #endif
 107
 108         return EFI_CALL(efi_set_variable(L"RuntimeServicesSupported",
 109                                          &efi_global_variable_guid,
 110                                          EFI_VARIABLE_BOOTSERVICE_ACCESS |
 111                                          EFI_VARIABLE_RUNTIME_ACCESS,
 112                                          sizeof(efi_runtime_services_supported),
 113                                          &efi_runtime_services_supported));
 114 }
 115
 116 /**
 117  * efi_update_table_header_crc32() - Update crc32 in table header
 118  *
 119  * @table:      EFI table
 120  */
 121 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table)
 122 {
 123         table->crc32 = 0;
 124         table->crc32 = crc32(0, (const unsigned char *)table,
 125                              table->headersize);
 126 }
 127
 128 /**
 129  * efi_reset_system_boottime() - reset system at boot time
 130  *
 131  * This function implements the ResetSystem() runtime service before
 132  * SetVirtualAddressMap() is called.
 133  *
 134  * See the Unified Extensible Firmware Interface (UEFI) specification for
 135  * details.
 136  *
 137  * @reset_type:         type of reset to perform
 138  * @reset_status:       status code for the reset
 139  * @data_size:          size of reset_data
 140  * @reset_data:         information about the reset
 141  */
 142 static void EFIAPI efi_reset_system_boottime(
 143                         enum efi_reset_type reset_type,
 144                         efi_status_t reset_status,
 145                         unsigned long data_size, void *reset_data)
 146 {
 147         struct efi_event *evt;
 148
 149         EFI_ENTRY("%d %lx %lx %p", reset_type, reset_status, data_size,
 150                   reset_data);
 151
 152         /* Notify reset */
 153         list_for_each_entry(evt, &efi_events, link) {
 154                 if (evt->group &&
 155                     !guidcmp(evt->group,
 156                              &efi_guid_event_group_reset_system)) {
 157                         efi_signal_event(evt);
 158                         break;
 159                 }
 160         }
 161         switch (reset_type) {
 162         case EFI_RESET_COLD:
 163         case EFI_RESET_WARM:
 164         case EFI_RESET_PLATFORM_SPECIFIC:
 165                 do_reset(NULL, 0, 0, NULL);
 166                 break;
 167         case EFI_RESET_SHUTDOWN:
 168 #ifdef CONFIG_CMD_POWEROFF
 169                 do_poweroff(NULL, 0, 0, NULL);
 170 #endif
 171                 break;
 172         }
 173
 174         while (1) { }
 175 }
 176
 177 /**
 178  * efi_get_time_boottime() - get current time at boot time
 179  *
 180  * This function implements the GetTime runtime service before
 181  * SetVirtualAddressMap() is called.
 182  *
 183  * See the Unified Extensible Firmware Interface (UEFI) specification
 184  * for details.
 185  *
 186  * @time:               pointer to structure to receive current time
 187  * @capabilities:       pointer to structure to receive RTC properties
 188  * Returns:             status code
 189  */
 190 static efi_status_t EFIAPI efi_get_time_boottime(
 191                         struct efi_time *time,
 192                         struct efi_time_cap *capabilities)
 193 {
 194 #ifdef CONFIG_EFI_GET_TIME
 195         efi_status_t ret = EFI_SUCCESS;
 196         struct rtc_time tm;
 197         struct udevice *dev;
 198
 199         EFI_ENTRY("%p %p", time, capabilities);
 200
 201         if (!time) {
 202                 ret = EFI_INVALID_PARAMETER;
 203                 goto out;
 204         }
 205         if (uclass_get_device(UCLASS_RTC, 0, &dev) ||
 206             dm_rtc_get(dev, &tm)) {
 207                 ret = EFI_UNSUPPORTED;
 208                 goto out;
 209         }
 210         if (dm_rtc_get(dev, &tm)) {
 211                 ret = EFI_DEVICE_ERROR;
 212                 goto out;
 213         }
 214
 215         memset(time, 0, sizeof(*time));
 216         time->year = tm.tm_year;
 217         time->month = tm.tm_mon;
 218         time->day = tm.tm_mday;
 219         time->hour = tm.tm_hour;
 220         time->minute = tm.tm_min;
 221         time->second = tm.tm_sec;
 222         if (tm.tm_isdst)
 223                 time->daylight =
 224                         EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT;
 225         time->timezone = EFI_UNSPECIFIED_TIMEZONE;
 226
 227         if (capabilities) {
 228                 /* Set reasonable dummy values */
 229                 capabilities->resolution = 1;           /* 1 Hz */
 230                 capabilities->accuracy = 100000000;     /* 100 ppm */
 231                 capabilities->sets_to_zero = false;
 232         }
 233 out:
 234         return EFI_EXIT(ret);
 235 #else
 236         EFI_ENTRY("%p %p", time, capabilities);
 237         return EFI_EXIT(EFI_UNSUPPORTED);
 238 #endif
 239 }
 240
 241 #ifdef CONFIG_EFI_SET_TIME
 242
 243 /**
 244  * efi_validate_time() - checks if timestamp is valid
 245  *
 246  * @time:       timestamp to validate
 247  * Returns:     0 if timestamp is valid, 1 otherwise
 248  */
 249 static int efi_validate_time(struct efi_time *time)
 250 {
 251         return (!time ||
 252                 time->year < 1900 || time->year > 9999 ||
 253                 !time->month || time->month > 12 || !time->day ||
 254                 time->day > rtc_month_days(time->month - 1, time->year) ||
 255                 time->hour > 23 || time->minute > 59 || time->second > 59 ||
 256                 time->nanosecond > 999999999 ||
 257                 time->daylight &
 258                 ~(EFI_TIME_IN_DAYLIGHT | EFI_TIME_ADJUST_DAYLIGHT) ||
 259                 ((time->timezone < -1440 || time->timezone > 1440) &&
 260                 time->timezone != EFI_UNSPECIFIED_TIMEZONE));
 261 }
 262
 263 #endif
 264
 265 /**
 266  * efi_set_time_boottime() - set current time
 267  *
 268  * This function implements the SetTime() runtime service before
 269  * SetVirtualAddressMap() is called.
 270  *
 271  * See the Unified Extensible Firmware Interface (UEFI) specification
 272  * for details.
 273  *
 274  * @time:               pointer to structure to with current time
 275  * Returns:             status code
 276  */
 277 static efi_status_t EFIAPI efi_set_time_boottime(struct efi_time *time)
 278 {
 279 #ifdef CONFIG_EFI_SET_TIME
 280         efi_status_t ret = EFI_SUCCESS;
 281         struct rtc_time tm;
 282         struct udevice *dev;
 283
 284         EFI_ENTRY("%p", time);
 285
 286         if (efi_validate_time(time)) {
 287                 ret = EFI_INVALID_PARAMETER;
 288                 goto out;
 289         }
 290
 291         if (uclass_get_device(UCLASS_RTC, 0, &dev)) {
 292                 ret = EFI_UNSUPPORTED;
 293                 goto out;
 294         }
 295
 296         memset(&tm, 0, sizeof(tm));
 297         tm.tm_year = time->year;
 298         tm.tm_mon = time->month;
 299         tm.tm_mday = time->day;
 300         tm.tm_hour = time->hour;
 301         tm.tm_min = time->minute;
 302         tm.tm_sec = time->second;
 303         tm.tm_isdst = time->daylight ==
 304                       (EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT);
 305         /* Calculate day of week */
 306         rtc_calc_weekday(&tm);
 307
 308         if (dm_rtc_set(dev, &tm))
 309                 ret = EFI_DEVICE_ERROR;
 310 out:
 311         return EFI_EXIT(ret);
 312 #else
 313         EFI_ENTRY("%p", time);
 314         return EFI_EXIT(EFI_UNSUPPORTED);
 315 #endif
 316 }
 317 /**
 318  * efi_reset_system() - reset system
 319  *
 320  * This function implements the ResetSystem() runtime service after
 321  * SetVirtualAddressMap() is called. It only executes an endless loop.
 322  * Boards may override the helpers below to implement reset functionality.
 323  *
 324  * See the Unified Extensible Firmware Interface (UEFI) specification for
 325  * details.
 326  *
 327  * @reset_type:         type of reset to perform
 328  * @reset_status:       status code for the reset
 329  * @data_size:          size of reset_data
 330  * @reset_data:         information about the reset
 331  */
 332 void __weak __efi_runtime EFIAPI efi_reset_system(
 333                         enum efi_reset_type reset_type,
 334                         efi_status_t reset_status,
 335                         unsigned long data_size, void *reset_data)
 336 {
 337         /* Nothing we can do */
 338         while (1) { }
 339 }
 340
 341 /**
 342  * efi_reset_system_init() - initialize the reset driver
 343  *
 344  * Boards may override this function to initialize the reset driver.
 345  */
 346 efi_status_t __weak efi_reset_system_init(void)
 347 {
 348         return EFI_SUCCESS;
 349 }
 350
 351 /**
 352  * efi_get_time() - get current time
 353  *
 354  * This function implements the GetTime runtime service after
 355  * SetVirtualAddressMap() is called. As the U-Boot driver are not available
 356  * anymore only an error code is returned.
 357  *
 358  * See the Unified Extensible Firmware Interface (UEFI) specification
 359  * for details.
 360  *
 361  * @time:               pointer to structure to receive current time
 362  * @capabilities:       pointer to structure to receive RTC properties
 363  * Returns:             status code
 364  */
 365 efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
 366                         struct efi_time *time,
 367                         struct efi_time_cap *capabilities)
 368 {
 369         return EFI_UNSUPPORTED;
 370 }
 371
 372 /**
 373  * efi_set_time() - set current time
 374  *
 375  * This function implements the SetTime runtime service after
 376  * SetVirtualAddressMap() is called. As the U-Boot driver are not available
 377  * anymore only an error code is returned.
 378  *
 379  * See the Unified Extensible Firmware Interface (UEFI) specification
 380  * for details.
 381  *
 382  * @time:               pointer to structure to with current time
 383  * Returns:             status code
 384  */
 385 efi_status_t __weak __efi_runtime EFIAPI efi_set_time(struct efi_time *time)
 386 {
 387         return EFI_UNSUPPORTED;
 388 }
 389
 390 /**
 391  * efi_is_runtime_service_pointer() - check if pointer points to runtime table
 392  *
 393  * @p:          pointer to check
 394  * Return:      true if the pointer points to a service function pointer in the
 395  *              runtime table
 396  */
 397 static bool efi_is_runtime_service_pointer(void *p)
 398 {
 399         return (p >= (void *)&efi_runtime_services.get_time &&
 400                 p <= (void *)&efi_runtime_services.query_variable_info) ||
 401                p == (void *)&efi_events.prev ||
 402                p == (void *)&efi_events.next;
 403 }
 404
 405 /**
 406  * efi_runtime_detach() - detach unimplemented runtime functions
 407  */
 408 void efi_runtime_detach(void)
 409 {
 410         efi_runtime_services.reset_system = efi_reset_system;
 411         efi_runtime_services.get_time = efi_get_time;
 412         efi_runtime_services.set_time = efi_set_time;
 413
 414         /* Update CRC32 */
 415         efi_update_table_header_crc32(&efi_runtime_services.hdr);
 416 }
 417
 418 /**
 419  * efi_set_virtual_address_map_runtime() - change from physical to virtual
 420  *                                         mapping
 421  *
 422  * This function implements the SetVirtualAddressMap() runtime service after
 423  * it is first called.
 424  *
 425  * See the Unified Extensible Firmware Interface (UEFI) specification for
 426  * details.
 427  *
 428  * @memory_map_size:    size of the virtual map
 429  * @descriptor_size:    size of an entry in the map
 430  * @descriptor_version: version of the map entries
 431  * @virtmap:            virtual address mapping information
 432  * Return:              status code EFI_UNSUPPORTED
 433  */
 434 static __efi_runtime efi_status_t EFIAPI efi_set_virtual_address_map_runtime(
 435                         efi_uintn_t memory_map_size,
 436                         efi_uintn_t descriptor_size,
 437                         uint32_t descriptor_version,
 438                         struct efi_mem_desc *virtmap)
 439 {
 440         return EFI_UNSUPPORTED;
 441 }
 442
 443 /**
 444  * efi_convert_pointer_runtime() - convert from physical to virtual pointer
 445  *
 446  * This function implements the ConvertPointer() runtime service after
 447  * the first call to SetVirtualAddressMap().
 448  *
 449  * See the Unified Extensible Firmware Interface (UEFI) specification for
 450  * details.
 451  *
 452  * @debug_disposition:  indicates if pointer may be converted to NULL
 453  * @address:            pointer to be converted
 454  * Return:              status code EFI_UNSUPPORTED
 455  */
 456 static __efi_runtime efi_status_t EFIAPI efi_convert_pointer_runtime(
 457                         efi_uintn_t debug_disposition, void **address)
 458 {
 459         return EFI_UNSUPPORTED;
 460 }
 461
 462 /**
 463  * efi_convert_pointer_runtime() - convert from physical to virtual pointer
 464  *
 465  * This function implements the ConvertPointer() runtime service until
 466  * the first call to SetVirtualAddressMap().
 467  *
 468  * See the Unified Extensible Firmware Interface (UEFI) specification for
 469  * details.
 470  *
 471  * @debug_disposition:  indicates if pointer may be converted to NULL
 472  * @address:            pointer to be converted
 473  * Return:              status code EFI_UNSUPPORTED
 474  */
 475 static __efi_runtime efi_status_t EFIAPI efi_convert_pointer(
 476                         efi_uintn_t debug_disposition, void **address)
 477 {
 478         efi_physical_addr_t addr = (uintptr_t)*address;
 479         efi_uintn_t i;
 480         efi_status_t ret = EFI_NOT_FOUND;
 481
 482         EFI_ENTRY("%zu %p", debug_disposition, address);
 483
 484         if (!efi_virtmap) {
 485                 ret = EFI_UNSUPPORTED;
 486                 goto out;
 487         }
 488
 489         if (!address) {
 490                 ret = EFI_INVALID_PARAMETER;
 491                 goto out;
 492         }
 493
 494         for (i = 0; i < efi_descriptor_count; i++) {
 495                 struct efi_mem_desc *map = (void *)efi_virtmap +
 496                                            (efi_descriptor_size * i);
 497
 498                 if (addr >= map->physical_start &&
 499                     (addr < map->physical_start
 500                             + (map->num_pages << EFI_PAGE_SHIFT))) {
 501                         *address = (void *)(uintptr_t)
 502                                    (addr + map->virtual_start -
 503                                     map->physical_start);
 504
 505                         ret = EFI_SUCCESS;
 506                         break;
 507                 }
 508         }
 509
 510 out:
 511         return EFI_EXIT(ret);
 512 }
 513
 514 static __efi_runtime void efi_relocate_runtime_table(ulong offset)
 515 {
 516         ulong patchoff;
 517         void **pos;
 518
 519         /* Relocate the runtime services pointers */
 520         patchoff = offset - gd->relocaddr;
 521         for (pos = (void **)&efi_runtime_services.get_time;
 522              pos <= (void **)&efi_runtime_services.query_variable_info; ++pos) {
 523                 if (*pos)
 524                         *pos += patchoff;
 525         }
 526
 527         /*
 528          * The entry for SetVirtualAddress() must point to a physical address.
 529          * After the first execution the service must return EFI_UNSUPPORTED.
 530          */
 531         efi_runtime_services.set_virtual_address_map =
 532                         &efi_set_virtual_address_map_runtime;
 533
 534         /*
 535          * The entry for ConvertPointer() must point to a physical address.
 536          * The service is not usable after SetVirtualAddress().
 537          */
 538         efi_runtime_services.convert_pointer = &efi_convert_pointer_runtime;
 539
 540         /*
 541          * TODO: Update UEFI variable RuntimeServicesSupported removing flags
 542          * EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP and
 543          * EFI_RT_SUPPORTED_CONVERT_POINTER as required by the UEFI spec 2.8.
 544          */
 545
 546         /* Update CRC32 */
 547         efi_update_table_header_crc32(&efi_runtime_services.hdr);
 548 }
 549
 550 /* Relocate EFI runtime to uboot_reloc_base = offset */
 551 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
 552 {
 553 #ifdef IS_RELA
 554         struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
 555 #else
 556         struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
 557         static ulong lastoff = CONFIG_SYS_TEXT_BASE;
 558 #endif
 559
 560         debug("%s: Relocating to offset=%lx\n", __func__, offset);
 561         for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
 562                 ulong base = CONFIG_SYS_TEXT_BASE;
 563                 ulong *p;
 564                 ulong newaddr;
 565
 566                 p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
 567
 568                 /*
 569                  * The runtime services table is updated in
 570                  * efi_relocate_runtime_table()
 571                  */
 572                 if (map && efi_is_runtime_service_pointer(p))
 573                         continue;
 574
 575                 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__,
 576                       rel->info, *p, rel->offset);
 577
 578                 switch (rel->info & R_MASK) {
 579                 case R_RELATIVE:
 580 #ifdef IS_RELA
 581                 newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
 582 #else
 583                 newaddr = *p - lastoff + offset;
 584 #endif
 585                         break;
 586 #ifdef R_ABSOLUTE
 587                 case R_ABSOLUTE: {
 588                         ulong symidx = rel->info >> SYM_INDEX;
 589                         extern struct dyn_sym __dyn_sym_start[];
 590                         newaddr = __dyn_sym_start[symidx].addr + offset;
 591 #ifdef IS_RELA
 592                         newaddr -= CONFIG_SYS_TEXT_BASE;
 593 #endif
 594                         break;
 595                 }
 596 #endif
 597                 default:
 598                         printf("%s: Unknown relocation type %llx\n",
 599                                __func__, rel->info & R_MASK);
 600                         continue;
 601                 }
 602
 603                 /* Check if the relocation is inside bounds */
 604                 if (map && ((newaddr < map->virtual_start) ||
 605                     newaddr > (map->virtual_start +
 606                               (map->num_pages << EFI_PAGE_SHIFT)))) {
 607                         printf("%s: Relocation at %p is out of range (%lx)\n",
 608                                __func__, p, newaddr);
 609                         continue;
 610                 }
 611
 612                 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
 613                 *p = newaddr;
 614                 flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
 615                         ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
 616         }
 617
 618 #ifndef IS_RELA
 619         lastoff = offset;
 620 #endif
 621
 622         invalidate_icache_all();
 623 }
 624
 625 /**
 626  * efi_set_virtual_address_map() - change from physical to virtual mapping
 627  *
 628  * This function implements the SetVirtualAddressMap() runtime service.
 629  *
 630  * See the Unified Extensible Firmware Interface (UEFI) specification for
 631  * details.
 632  *
 633  * @memory_map_size:    size of the virtual map
 634  * @descriptor_size:    size of an entry in the map
 635  * @descriptor_version: version of the map entries
 636  * @virtmap:            virtual address mapping information
 637  * Return:              status code
 638  */
 639 static efi_status_t EFIAPI efi_set_virtual_address_map(
 640                         efi_uintn_t memory_map_size,
 641                         efi_uintn_t descriptor_size,
 642                         uint32_t descriptor_version,
 643                         struct efi_mem_desc *virtmap)
 644 {
 645         efi_uintn_t n = memory_map_size / descriptor_size;
 646         efi_uintn_t i;
 647         efi_status_t ret = EFI_INVALID_PARAMETER;
 648         int rt_code_sections = 0;
 649         struct efi_event *event;
 650
 651         EFI_ENTRY("%zx %zx %x %p", memory_map_size, descriptor_size,
 652                   descriptor_version, virtmap);
 653
 654         if (descriptor_version != EFI_MEMORY_DESCRIPTOR_VERSION ||
 655             descriptor_size < sizeof(struct efi_mem_desc))
 656                 goto out;
 657
 658         efi_virtmap = virtmap;
 659         efi_descriptor_size = descriptor_size;
 660         efi_descriptor_count = n;
 661
 662         /*
 663          * TODO:
 664          * Further down we are cheating. While really we should implement
 665          * SetVirtualAddressMap() events and ConvertPointer() to allow
 666          * dynamically loaded drivers to expose runtime services, we don't
 667          * today.
 668          *
 669          * So let's ensure we see exactly one single runtime section, as
 670          * that is the built-in one. If we see more (or less), someone must
 671          * have tried adding or removing to that which we don't support yet.
 672          * In that case, let's better fail rather than expose broken runtime
 673          * services.
 674          */
 675         for (i = 0; i < n; i++) {
 676                 struct efi_mem_desc *map = (void*)virtmap +
 677                                            (descriptor_size * i);
 678
 679                 if (map->type == EFI_RUNTIME_SERVICES_CODE)
 680                         rt_code_sections++;
 681         }
 682
 683         if (rt_code_sections != 1) {
 684                 /*
 685                  * We expose exactly one single runtime code section, so
 686                  * something is definitely going wrong.
 687                  */
 688                 goto out;
 689         }
 690
 691         /* Notify EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
 692         list_for_each_entry(event, &efi_events, link) {
 693                 if (event->notify_function)
 694                         EFI_CALL_VOID(event->notify_function(
 695                                         event, event->notify_context));
 696         }
 697
 698         /* Rebind mmio pointers */
 699         for (i = 0; i < n; i++) {
 700                 struct efi_mem_desc *map = (void*)virtmap +
 701                                            (descriptor_size * i);
 702                 struct list_head *lhandle;
 703                 efi_physical_addr_t map_start = map->physical_start;
 704                 efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
 705                 efi_physical_addr_t map_end = map_start + map_len;
 706                 u64 off = map->virtual_start - map_start;
 707
 708                 /* Adjust all mmio pointers in this region */
 709                 list_for_each(lhandle, &efi_runtime_mmio) {
 710                         struct efi_runtime_mmio_list *lmmio;
 711
 712                         lmmio = list_entry(lhandle,
 713                                            struct efi_runtime_mmio_list,
 714                                            link);
 715                         if ((map_start <= lmmio->paddr) &&
 716                             (map_end >= lmmio->paddr)) {
 717                                 uintptr_t new_addr = lmmio->paddr + off;
 718                                 *lmmio->ptr = (void *)new_addr;
 719                         }
 720                 }
 721                 if ((map_start <= (uintptr_t)systab.tables) &&
 722                     (map_end >= (uintptr_t)systab.tables)) {
 723                         char *ptr = (char *)systab.tables;
 724
 725                         ptr += off;
 726                         systab.tables = (struct efi_configuration_table *)ptr;
 727                 }
 728         }
 729
 730         /* Relocate the runtime. See TODO above */
 731         for (i = 0; i < n; i++) {
 732                 struct efi_mem_desc *map;
 733
 734                 map = (void*)virtmap + (descriptor_size * i);
 735                 if (map->type == EFI_RUNTIME_SERVICES_CODE) {
 736                         ulong new_offset = map->virtual_start -
 737                                            map->physical_start + gd->relocaddr;
 738
 739                         efi_relocate_runtime_table(new_offset);
 740                         efi_runtime_relocate(new_offset, map);
 741                         ret = EFI_SUCCESS;
 742                         goto out;
 743                 }
 744         }
 745
 746 out:
 747         return EFI_EXIT(ret);
 748 }
 749
 750 /**
 751  * efi_add_runtime_mmio() - add memory-mapped IO region
 752  *
 753  * This function adds a memory-mapped IO region to the memory map to make it
 754  * available at runtime.
 755  *
 756  * @mmio_ptr:           pointer to a pointer to the start of the memory-mapped
 757  *                      IO region
 758  * @len:                size of the memory-mapped IO region
 759  * Returns:             status code
 760  */
 761 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
 762 {
 763         struct efi_runtime_mmio_list *newmmio;
 764         u64 pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
 765         uint64_t addr = *(uintptr_t *)mmio_ptr;
 766         efi_status_t ret;
 767
 768         ret = efi_add_memory_map(addr, pages, EFI_MMAP_IO, false);
 769         if (ret != EFI_SUCCESS)
 770                 return EFI_OUT_OF_RESOURCES;
 771
 772         newmmio = calloc(1, sizeof(*newmmio));
 773         if (!newmmio)
 774                 return EFI_OUT_OF_RESOURCES;
 775         newmmio->ptr = mmio_ptr;
 776         newmmio->paddr = *(uintptr_t *)mmio_ptr;
 777         newmmio->len = len;
 778         list_add_tail(&newmmio->link, &efi_runtime_mmio);
 779
 780         return EFI_SUCCESS;
 781 }
 782
 783 /*
 784  * In the second stage, U-Boot has disappeared. To isolate our runtime code
 785  * that at this point still exists from the rest, we put it into a special
 786  * section.
 787  *
 788  *        !!WARNING!!
 789  *
 790  * This means that we can not rely on any code outside of this file in any
 791  * function or variable below this line.
 792  *
 793  * Please keep everything fully self-contained and annotated with
 794  * __efi_runtime and __efi_runtime_data markers.
 795  */
 796
 797 /*
 798  * Relocate the EFI runtime stub to a different place. We need to call this
 799  * the first time we expose the runtime interface to a user and on set virtual
 800  * address map calls.
 801  */
 802
 803 /**
 804  * efi_unimplemented() - replacement function, returns EFI_UNSUPPORTED
 805  *
 806  * This function is used after SetVirtualAddressMap() is called as replacement
 807  * for services that are not available anymore due to constraints of the U-Boot
 808  * implementation.
 809  *
 810  * Return:      EFI_UNSUPPORTED
 811  */
 812 static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
 813 {
 814         return EFI_UNSUPPORTED;
 815 }
 816
 817 /**
 818  * efi_update_capsule() - process information from operating system
 819  *
 820  * This function implements the UpdateCapsule() runtime service.
 821  *
 822  * See the Unified Extensible Firmware Interface (UEFI) specification for
 823  * details.
 824  *
 825  * @capsule_header_array:       pointer to array of virtual pointers
 826  * @capsule_count:              number of pointers in capsule_header_array
 827  * @scatter_gather_list:        pointer to arry of physical pointers
 828  * Returns:                     status code
 829  */
 830 efi_status_t __efi_runtime EFIAPI efi_update_capsule(
 831                         struct efi_capsule_header **capsule_header_array,
 832                         efi_uintn_t capsule_count,
 833                         u64 scatter_gather_list)
 834 {
 835         return EFI_UNSUPPORTED;
 836 }
 837
 838 /**
 839  * efi_query_capsule_caps() - check if capsule is supported
 840  *
 841  * This function implements the QueryCapsuleCapabilities() runtime service.
 842  *
 843  * See the Unified Extensible Firmware Interface (UEFI) specification for
 844  * details.
 845  *
 846  * @capsule_header_array:       pointer to array of virtual pointers
 847  * @capsule_count:              number of pointers in capsule_header_array
 848  * @maximum_capsule_size:       maximum capsule size
 849  * @reset_type:                 type of reset needed for capsule update
 850  * Returns:                     status code
 851  */
 852 efi_status_t __efi_runtime EFIAPI efi_query_capsule_caps(
 853                         struct efi_capsule_header **capsule_header_array,
 854                         efi_uintn_t capsule_count,
 855                         u64 *maximum_capsule_size,
 856                         u32 *reset_type)
 857 {
 858         return EFI_UNSUPPORTED;
 859 }
 860
 861 struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
 862         .hdr = {
 863                 .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
 864                 .revision = EFI_SPECIFICATION_VERSION,
 865                 .headersize = sizeof(struct efi_runtime_services),
 866         },
 867         .get_time = &efi_get_time_boottime,
 868         .set_time = &efi_set_time_boottime,
 869         .get_wakeup_time = (void *)&efi_unimplemented,
 870         .set_wakeup_time = (void *)&efi_unimplemented,
 871         .set_virtual_address_map = &efi_set_virtual_address_map,
 872         .convert_pointer = efi_convert_pointer,
 873         .get_variable = efi_get_variable,
 874         .get_next_variable_name = efi_get_next_variable_name,
 875         .set_variable = efi_set_variable,
 876         .get_next_high_mono_count = (void *)&efi_unimplemented,
 877         .reset_system = &efi_reset_system_boottime,
 878         .update_capsule = efi_update_capsule,
 879         .query_capsule_caps = efi_query_capsule_caps,
 880         .query_variable_info = efi_query_variable_info,
 881 };