drivers/firmware/efi/libstub/efi-stub-helper.c

   1 /*
   2  * Helper functions used by the EFI stub on multiple
   3  * architectures. This should be #included by the EFI stub
   4  * implementation files.
   5  *
   6  * Copyright 2011 Intel Corporation; author Matt Fleming
   7  *
   8  * This file is part of the Linux kernel, and is made available
   9  * under the terms of the GNU General Public License version 2.
  10  *
  11  */
  12
  13 #include <linux/efi.h>
  14 #include <asm/efi.h>
  15
  16 #include "efistub.h"
  17
  18 /*
  19  * Some firmware implementations have problems reading files in one go.
  20  * A read chunk size of 1MB seems to work for most platforms.
  21  *
  22  * Unfortunately, reading files in chunks triggers *other* bugs on some
  23  * platforms, so we provide a way to disable this workaround, which can
  24  * be done by passing "efi=nochunk" on the EFI boot stub command line.
  25  *
  26  * If you experience issues with initrd images being corrupt it's worth
  27  * trying efi=nochunk, but chunking is enabled by default because there
  28  * are far more machines that require the workaround than those that
  29  * break with it enabled.
  30  */
  31 #define EFI_READ_CHUNK_SIZE     (1024 * 1024)
  32
  33 static unsigned long __chunk_size = EFI_READ_CHUNK_SIZE;
  34
  35 static int __section(.data) __nokaslr;
  36
  37 int __pure nokaslr(void)
  38 {
  39         return __nokaslr;
  40 }
  41
  42 /*
  43  * Allow the platform to override the allocation granularity: this allows
  44  * systems that have the capability to run with a larger page size to deal
  45  * with the allocations for initrd and fdt more efficiently.
  46  */
  47 #ifndef EFI_ALLOC_ALIGN
  48 #define EFI_ALLOC_ALIGN         EFI_PAGE_SIZE
  49 #endif
  50
  51 #define EFI_MMAP_NR_SLACK_SLOTS 8
  52
  53 struct file_info {
  54         efi_file_handle_t *handle;
  55         u64 size;
  56 };
  57
  58 void efi_printk(efi_system_table_t *sys_table_arg, char *str)
  59 {
  60         char *s8;
  61
  62         for (s8 = str; *s8; s8++) {
  63                 efi_char16_t ch[2] = { 0 };
  64
  65                 ch[0] = *s8;
  66                 if (*s8 == '\n') {
  67                         efi_char16_t nl[2] = { '\r', 0 };
  68                         efi_char16_printk(sys_table_arg, nl);
  69                 }
  70
  71                 efi_char16_printk(sys_table_arg, ch);
  72         }
  73 }
  74
  75 static inline bool mmap_has_headroom(unsigned long buff_size,
  76                                      unsigned long map_size,
  77                                      unsigned long desc_size)
  78 {
  79         unsigned long slack = buff_size - map_size;
  80
  81         return slack / desc_size >= EFI_MMAP_NR_SLACK_SLOTS;
  82 }
  83
  84 efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
  85                                 struct efi_boot_memmap *map)
  86 {
  87         efi_memory_desc_t *m = NULL;
  88         efi_status_t status;
  89         unsigned long key;
  90         u32 desc_version;
  91
  92         *map->desc_size =       sizeof(*m);
  93         *map->map_size =        *map->desc_size * 32;
  94         *map->buff_size =       *map->map_size;
  95 again:
  96         status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
  97                                 *map->map_size, (void **)&m);
  98         if (status != EFI_SUCCESS)
  99                 goto fail;
 100
 101         *map->desc_size = 0;
 102         key = 0;
 103         status = efi_call_early(get_memory_map, map->map_size, m,
 104                                 &key, map->desc_size, &desc_version);
 105         if (status == EFI_BUFFER_TOO_SMALL ||
 106             !mmap_has_headroom(*map->buff_size, *map->map_size,
 107                                *map->desc_size)) {
 108                 efi_call_early(free_pool, m);
 109                 /*
 110                  * Make sure there is some entries of headroom so that the
 111                  * buffer can be reused for a new map after allocations are
 112                  * no longer permitted.  Its unlikely that the map will grow to
 113                  * exceed this headroom once we are ready to trigger
 114                  * ExitBootServices()
 115                  */
 116                 *map->map_size += *map->desc_size * EFI_MMAP_NR_SLACK_SLOTS;
 117                 *map->buff_size = *map->map_size;
 118                 goto again;
 119         }
 120
 121         if (status != EFI_SUCCESS)
 122                 efi_call_early(free_pool, m);
 123
 124         if (map->key_ptr && status == EFI_SUCCESS)
 125                 *map->key_ptr = key;
 126         if (map->desc_ver && status == EFI_SUCCESS)
 127                 *map->desc_ver = desc_version;
 128
 129 fail:
 130         *map->map = m;
 131         return status;
 132 }
 133
 134
 135 unsigned long get_dram_base(efi_system_table_t *sys_table_arg)
 136 {
 137         efi_status_t status;
 138         unsigned long map_size, buff_size;
 139         unsigned long membase  = EFI_ERROR;
 140         struct efi_memory_map map;
 141         efi_memory_desc_t *md;
 142         struct efi_boot_memmap boot_map;
 143
 144         boot_map.map =          (efi_memory_desc_t **)&map.map;
 145         boot_map.map_size =     &map_size;
 146         boot_map.desc_size =    &map.desc_size;
 147         boot_map.desc_ver =     NULL;
 148         boot_map.key_ptr =      NULL;
 149         boot_map.buff_size =    &buff_size;
 150
 151         status = efi_get_memory_map(sys_table_arg, &boot_map);
 152         if (status != EFI_SUCCESS)
 153                 return membase;
 154
 155         map.map_end = map.map + map_size;
 156
 157         for_each_efi_memory_desc_in_map(&map, md) {
 158                 if (md->attribute & EFI_MEMORY_WB) {
 159                         if (membase > md->phys_addr)
 160                                 membase = md->phys_addr;
 161                 }
 162         }
 163
 164         efi_call_early(free_pool, map.map);
 165
 166         return membase;
 167 }
 168
 169 /*
 170  * Allocate at the highest possible address that is not above 'max'.
 171  */
 172 efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
 173                             unsigned long size, unsigned long align,
 174                             unsigned long *addr, unsigned long max)
 175 {
 176         unsigned long map_size, desc_size, buff_size;
 177         efi_memory_desc_t *map;
 178         efi_status_t status;
 179         unsigned long nr_pages;
 180         u64 max_addr = 0;
 181         int i;
 182         struct efi_boot_memmap boot_map;
 183
 184         boot_map.map =          &map;
 185         boot_map.map_size =     &map_size;
 186         boot_map.desc_size =    &desc_size;
 187         boot_map.desc_ver =     NULL;
 188         boot_map.key_ptr =      NULL;
 189         boot_map.buff_size =    &buff_size;
 190
 191         status = efi_get_memory_map(sys_table_arg, &boot_map);
 192         if (status != EFI_SUCCESS)
 193                 goto fail;
 194
 195         /*
 196          * Enforce minimum alignment that EFI requires when requesting
 197          * a specific address.  We are doing page-based allocations,
 198          * so we must be aligned to a page.
 199          */
 200         if (align < EFI_ALLOC_ALIGN)
 201                 align = EFI_ALLOC_ALIGN;
 202
 203         nr_pages = round_up(size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
 204 again:
 205         for (i = 0; i < map_size / desc_size; i++) {
 206                 efi_memory_desc_t *desc;
 207                 unsigned long m = (unsigned long)map;
 208                 u64 start, end;
 209
 210                 desc = (efi_memory_desc_t *)(m + (i * desc_size));
 211                 if (desc->type != EFI_CONVENTIONAL_MEMORY)
 212                         continue;
 213
 214                 if (desc->num_pages < nr_pages)
 215                         continue;
 216
 217                 start = desc->phys_addr;
 218                 end = start + desc->num_pages * (1UL << EFI_PAGE_SHIFT);
 219
 220                 if (end > max)
 221                         end = max;
 222
 223                 if ((start + size) > end)
 224                         continue;
 225
 226                 if (round_down(end - size, align) < start)
 227                         continue;
 228
 229                 start = round_down(end - size, align);
 230
 231                 /*
 232                  * Don't allocate at 0x0. It will confuse code that
 233                  * checks pointers against NULL.
 234                  */
 235                 if (start == 0x0)
 236                         continue;
 237
 238                 if (start > max_addr)
 239                         max_addr = start;
 240         }
 241
 242         if (!max_addr)
 243                 status = EFI_NOT_FOUND;
 244         else {
 245                 status = efi_call_early(allocate_pages,
 246                                         EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
 247                                         nr_pages, &max_addr);
 248                 if (status != EFI_SUCCESS) {
 249                         max = max_addr;
 250                         max_addr = 0;
 251                         goto again;
 252                 }
 253
 254                 *addr = max_addr;
 255         }
 256
 257         efi_call_early(free_pool, map);
 258 fail:
 259         return status;
 260 }
 261
 262 /*
 263  * Allocate at the lowest possible address.
 264  */
 265 efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
 266                            unsigned long size, unsigned long align,
 267                            unsigned long *addr)
 268 {
 269         unsigned long map_size, desc_size, buff_size;
 270         efi_memory_desc_t *map;
 271         efi_status_t status;
 272         unsigned long nr_pages;
 273         int i;
 274         struct efi_boot_memmap boot_map;
 275
 276         boot_map.map =          &map;
 277         boot_map.map_size =     &map_size;
 278         boot_map.desc_size =    &desc_size;
 279         boot_map.desc_ver =     NULL;
 280         boot_map.key_ptr =      NULL;
 281         boot_map.buff_size =    &buff_size;
 282
 283         status = efi_get_memory_map(sys_table_arg, &boot_map);
 284         if (status != EFI_SUCCESS)
 285                 goto fail;
 286
 287         /*
 288          * Enforce minimum alignment that EFI requires when requesting
 289          * a specific address.  We are doing page-based allocations,
 290          * so we must be aligned to a page.
 291          */
 292         if (align < EFI_ALLOC_ALIGN)
 293                 align = EFI_ALLOC_ALIGN;
 294
 295         nr_pages = round_up(size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
 296         for (i = 0; i < map_size / desc_size; i++) {
 297                 efi_memory_desc_t *desc;
 298                 unsigned long m = (unsigned long)map;
 299                 u64 start, end;
 300
 301                 desc = (efi_memory_desc_t *)(m + (i * desc_size));
 302
 303                 if (desc->type != EFI_CONVENTIONAL_MEMORY)
 304                         continue;
 305
 306                 if (desc->num_pages < nr_pages)
 307                         continue;
 308
 309                 start = desc->phys_addr;
 310                 end = start + desc->num_pages * (1UL << EFI_PAGE_SHIFT);
 311
 312                 /*
 313                  * Don't allocate at 0x0. It will confuse code that
 314                  * checks pointers against NULL. Skip the first 8
 315                  * bytes so we start at a nice even number.
 316                  */
 317                 if (start == 0x0)
 318                         start += 8;
 319
 320                 start = round_up(start, align);
 321                 if ((start + size) > end)
 322                         continue;
 323
 324                 status = efi_call_early(allocate_pages,
 325                                         EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
 326                                         nr_pages, &start);
 327                 if (status == EFI_SUCCESS) {
 328                         *addr = start;
 329                         break;
 330                 }
 331         }
 332
 333         if (i == map_size / desc_size)
 334                 status = EFI_NOT_FOUND;
 335
 336         efi_call_early(free_pool, map);
 337 fail:
 338         return status;
 339 }
 340
 341 void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
 342               unsigned long addr)
 343 {
 344         unsigned long nr_pages;
 345
 346         if (!size)
 347                 return;
 348
 349         nr_pages = round_up(size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
 350         efi_call_early(free_pages, addr, nr_pages);
 351 }
 352
 353 /*
 354  * Parse the ASCII string 'cmdline' for EFI options, denoted by the efi=
 355  * option, e.g. efi=nochunk.
 356  *
 357  * It should be noted that efi= is parsed in two very different
 358  * environments, first in the early boot environment of the EFI boot
 359  * stub, and subsequently during the kernel boot.
 360  */
 361 efi_status_t efi_parse_options(char const *cmdline)
 362 {
 363         char *str;
 364
 365         str = strstr(cmdline, "nokaslr");
 366         if (str == cmdline || (str && str > cmdline && *(str - 1) == ' '))
 367                 __nokaslr = 1;
 368
 369         /*
 370          * If no EFI parameters were specified on the cmdline we've got
 371          * nothing to do.
 372          */
 373         str = strstr(cmdline, "efi=");
 374         if (!str)
 375                 return EFI_SUCCESS;
 376
 377         /* Skip ahead to first argument */
 378         str += strlen("efi=");
 379
 380         /*
 381          * Remember, because efi= is also used by the kernel we need to
 382          * skip over arguments we don't understand.
 383          */
 384         while (*str) {
 385                 if (!strncmp(str, "nochunk", 7)) {
 386                         str += strlen("nochunk");
 387                         __chunk_size = -1UL;
 388                 }
 389
 390                 /* Group words together, delimited by "," */
 391                 while (*str && *str != ',')
 392                         str++;
 393
 394                 if (*str == ',')
 395                         str++;
 396         }
 397
 398         return EFI_SUCCESS;
 399 }
 400
 401 /*
 402  * Check the cmdline for a LILO-style file= arguments.
 403  *
 404  * We only support loading a file from the same filesystem as
 405  * the kernel image.
 406  */
 407 efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
 408                                   efi_loaded_image_t *image,
 409                                   char *cmd_line, char *option_string,
 410                                   unsigned long max_addr,
 411                                   unsigned long *load_addr,
 412                                   unsigned long *load_size)
 413 {
 414         struct file_info *files;
 415         unsigned long file_addr;
 416         u64 file_size_total;
 417         efi_file_handle_t *fh = NULL;
 418         efi_status_t status;
 419         int nr_files;
 420         char *str;
 421         int i, j, k;
 422
 423         file_addr = 0;
 424         file_size_total = 0;
 425
 426         str = cmd_line;
 427
 428         j = 0;                  /* See close_handles */
 429
 430         if (!load_addr || !load_size)
 431                 return EFI_INVALID_PARAMETER;
 432
 433         *load_addr = 0;
 434         *load_size = 0;
 435
 436         if (!str || !*str)
 437                 return EFI_SUCCESS;
 438
 439         for (nr_files = 0; *str; nr_files++) {
 440                 str = strstr(str, option_string);
 441                 if (!str)
 442                         break;
 443
 444                 str += strlen(option_string);
 445
 446                 /* Skip any leading slashes */
 447                 while (*str == '/' || *str == '\\')
 448                         str++;
 449
 450                 while (*str && *str != ' ' && *str != '\n')
 451                         str++;
 452         }
 453
 454         if (!nr_files)
 455                 return EFI_SUCCESS;
 456
 457         status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
 458                                 nr_files * sizeof(*files), (void **)&files);
 459         if (status != EFI_SUCCESS) {
 460                 pr_efi_err(sys_table_arg, "Failed to alloc mem for file handle list\n");
 461                 goto fail;
 462         }
 463
 464         str = cmd_line;
 465         for (i = 0; i < nr_files; i++) {
 466                 struct file_info *file;
 467                 efi_char16_t filename_16[256];
 468                 efi_char16_t *p;
 469
 470                 str = strstr(str, option_string);
 471                 if (!str)
 472                         break;
 473
 474                 str += strlen(option_string);
 475
 476                 file = &files[i];
 477                 p = filename_16;
 478
 479                 /* Skip any leading slashes */
 480                 while (*str == '/' || *str == '\\')
 481                         str++;
 482
 483                 while (*str && *str != ' ' && *str != '\n') {
 484                         if ((u8 *)p >= (u8 *)filename_16 + sizeof(filename_16))
 485                                 break;
 486
 487                         if (*str == '/') {
 488                                 *p++ = '\\';
 489                                 str++;
 490                         } else {
 491                                 *p++ = *str++;
 492                         }
 493                 }
 494
 495                 *p = '\0';
 496
 497                 /* Only open the volume once. */
 498                 if (!i) {
 499                         status = efi_open_volume(sys_table_arg, image,
 500                                                  (void **)&fh);
 501                         if (status != EFI_SUCCESS)
 502                                 goto free_files;
 503                 }
 504
 505                 status = efi_file_size(sys_table_arg, fh, filename_16,
 506                                        (void **)&file->handle, &file->size);
 507                 if (status != EFI_SUCCESS)
 508                         goto close_handles;
 509
 510                 file_size_total += file->size;
 511         }
 512
 513         if (file_size_total) {
 514                 unsigned long addr;
 515
 516                 /*
 517                  * Multiple files need to be at consecutive addresses in memory,
 518                  * so allocate enough memory for all the files.  This is used
 519                  * for loading multiple files.
 520                  */
 521                 status = efi_high_alloc(sys_table_arg, file_size_total, 0x1000,
 522                                     &file_addr, max_addr);
 523                 if (status != EFI_SUCCESS) {
 524                         pr_efi_err(sys_table_arg, "Failed to alloc highmem for files\n");
 525                         goto close_handles;
 526                 }
 527
 528                 /* We've run out of free low memory. */
 529                 if (file_addr > max_addr) {
 530                         pr_efi_err(sys_table_arg, "We've run out of free low memory\n");
 531                         status = EFI_INVALID_PARAMETER;
 532                         goto free_file_total;
 533                 }
 534
 535                 addr = file_addr;
 536                 for (j = 0; j < nr_files; j++) {
 537                         unsigned long size;
 538
 539                         size = files[j].size;
 540                         while (size) {
 541                                 unsigned long chunksize;
 542
 543                                 if (IS_ENABLED(CONFIG_X86) && size > __chunk_size)
 544                                         chunksize = __chunk_size;
 545                                 else
 546                                         chunksize = size;
 547
 548                                 status = efi_file_read(files[j].handle,
 549                                                        &chunksize,
 550                                                        (void *)addr);
 551                                 if (status != EFI_SUCCESS) {
 552                                         pr_efi_err(sys_table_arg, "Failed to read file\n");
 553                                         goto free_file_total;
 554                                 }
 555                                 addr += chunksize;
 556                                 size -= chunksize;
 557                         }
 558
 559                         efi_file_close(files[j].handle);
 560                 }
 561
 562         }
 563
 564         efi_call_early(free_pool, files);
 565
 566         *load_addr = file_addr;
 567         *load_size = file_size_total;
 568
 569         return status;
 570
 571 free_file_total:
 572         efi_free(sys_table_arg, file_size_total, file_addr);
 573
 574 close_handles:
 575         for (k = j; k < i; k++)
 576                 efi_file_close(files[k].handle);
 577 free_files:
 578         efi_call_early(free_pool, files);
 579 fail:
 580         *load_addr = 0;
 581         *load_size = 0;
 582
 583         return status;
 584 }
 585 /*
 586  * Relocate a kernel image, either compressed or uncompressed.
 587  * In the ARM64 case, all kernel images are currently
 588  * uncompressed, and as such when we relocate it we need to
 589  * allocate additional space for the BSS segment. Any low
 590  * memory that this function should avoid needs to be
 591  * unavailable in the EFI memory map, as if the preferred
 592  * address is not available the lowest available address will
 593  * be used.
 594  */
 595 efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
 596                                  unsigned long *image_addr,
 597                                  unsigned long image_size,
 598                                  unsigned long alloc_size,
 599                                  unsigned long preferred_addr,
 600                                  unsigned long alignment)
 601 {
 602         unsigned long cur_image_addr;
 603         unsigned long new_addr = 0;
 604         efi_status_t status;
 605         unsigned long nr_pages;
 606         efi_physical_addr_t efi_addr = preferred_addr;
 607
 608         if (!image_addr || !image_size || !alloc_size)
 609                 return EFI_INVALID_PARAMETER;
 610         if (alloc_size < image_size)
 611                 return EFI_INVALID_PARAMETER;
 612
 613         cur_image_addr = *image_addr;
 614
 615         /*
 616          * The EFI firmware loader could have placed the kernel image
 617          * anywhere in memory, but the kernel has restrictions on the
 618          * max physical address it can run at.  Some architectures
 619          * also have a prefered address, so first try to relocate
 620          * to the preferred address.  If that fails, allocate as low
 621          * as possible while respecting the required alignment.
 622          */
 623         nr_pages = round_up(alloc_size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
 624         status = efi_call_early(allocate_pages,
 625                                 EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
 626                                 nr_pages, &efi_addr);
 627         new_addr = efi_addr;
 628         /*
 629          * If preferred address allocation failed allocate as low as
 630          * possible.
 631          */
 632         if (status != EFI_SUCCESS) {
 633                 status = efi_low_alloc(sys_table_arg, alloc_size, alignment,
 634                                        &new_addr);
 635         }
 636         if (status != EFI_SUCCESS) {
 637                 pr_efi_err(sys_table_arg, "Failed to allocate usable memory for kernel.\n");
 638                 return status;
 639         }
 640
 641         /*
 642          * We know source/dest won't overlap since both memory ranges
 643          * have been allocated by UEFI, so we can safely use memcpy.
 644          */
 645         memcpy((void *)new_addr, (void *)cur_image_addr, image_size);
 646
 647         /* Return the new address of the relocated image. */
 648         *image_addr = new_addr;
 649
 650         return status;
 651 }
 652
 653 /*
 654  * Get the number of UTF-8 bytes corresponding to an UTF-16 character.
 655  * This overestimates for surrogates, but that is okay.
 656  */
 657 static int efi_utf8_bytes(u16 c)
 658 {
 659         return 1 + (c >= 0x80) + (c >= 0x800);
 660 }
 661
 662 /*
 663  * Convert an UTF-16 string, not necessarily null terminated, to UTF-8.
 664  */
 665 static u8 *efi_utf16_to_utf8(u8 *dst, const u16 *src, int n)
 666 {
 667         unsigned int c;
 668
 669         while (n--) {
 670                 c = *src++;
 671                 if (n && c >= 0xd800 && c <= 0xdbff &&
 672                     *src >= 0xdc00 && *src <= 0xdfff) {
 673                         c = 0x10000 + ((c & 0x3ff) << 10) + (*src & 0x3ff);
 674                         src++;
 675                         n--;
 676                 }
 677                 if (c >= 0xd800 && c <= 0xdfff)
 678                         c = 0xfffd; /* Unmatched surrogate */
 679                 if (c < 0x80) {
 680                         *dst++ = c;
 681                         continue;
 682                 }
 683                 if (c < 0x800) {
 684                         *dst++ = 0xc0 + (c >> 6);
 685                         goto t1;
 686                 }
 687                 if (c < 0x10000) {
 688                         *dst++ = 0xe0 + (c >> 12);
 689                         goto t2;
 690                 }
 691                 *dst++ = 0xf0 + (c >> 18);
 692                 *dst++ = 0x80 + ((c >> 12) & 0x3f);
 693         t2:
 694                 *dst++ = 0x80 + ((c >> 6) & 0x3f);
 695         t1:
 696                 *dst++ = 0x80 + (c & 0x3f);
 697         }
 698
 699         return dst;
 700 }
 701
 702 #ifndef MAX_CMDLINE_ADDRESS
 703 #define MAX_CMDLINE_ADDRESS     ULONG_MAX
 704 #endif
 705
 706 /*
 707  * Convert the unicode UEFI command line to ASCII to pass to kernel.
 708  * Size of memory allocated return in *cmd_line_len.
 709  * Returns NULL on error.
 710  */
 711 char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
 712                           efi_loaded_image_t *image,
 713                           int *cmd_line_len)
 714 {
 715         const u16 *s2;
 716         u8 *s1 = NULL;
 717         unsigned long cmdline_addr = 0;
 718         int load_options_chars = image->load_options_size / 2; /* UTF-16 */
 719         const u16 *options = image->load_options;
 720         int options_bytes = 0;  /* UTF-8 bytes */
 721         int options_chars = 0;  /* UTF-16 chars */
 722         efi_status_t status;
 723         u16 zero = 0;
 724
 725         if (options) {
 726                 s2 = options;
 727                 while (*s2 && *s2 != '\n'
 728                        && options_chars < load_options_chars) {
 729                         options_bytes += efi_utf8_bytes(*s2++);
 730                         options_chars++;
 731                 }
 732         }
 733
 734         if (!options_chars) {
 735                 /* No command line options, so return empty string*/
 736                 options = &zero;
 737         }
 738
 739         options_bytes++;        /* NUL termination */
 740
 741         status = efi_high_alloc(sys_table_arg, options_bytes, 0,
 742                                 &cmdline_addr, MAX_CMDLINE_ADDRESS);
 743         if (status != EFI_SUCCESS)
 744                 return NULL;
 745
 746         s1 = (u8 *)cmdline_addr;
 747         s2 = (const u16 *)options;
 748
 749         s1 = efi_utf16_to_utf8(s1, s2, options_chars);
 750         *s1 = '\0';
 751
 752         *cmd_line_len = options_bytes;
 753         return (char *)cmdline_addr;
 754 }
 755
 756 /*
 757  * Handle calling ExitBootServices according to the requirements set out by the
 758  * spec.  Obtains the current memory map, and returns that info after calling
 759  * ExitBootServices.  The client must specify a function to perform any
 760  * processing of the memory map data prior to ExitBootServices.  A client
 761  * specific structure may be passed to the function via priv.  The client
 762  * function may be called multiple times.
 763  */
 764 efi_status_t efi_exit_boot_services(efi_system_table_t *sys_table_arg,
 765                                     void *handle,
 766                                     struct efi_boot_memmap *map,
 767                                     void *priv,
 768                                     efi_exit_boot_map_processing priv_func)
 769 {
 770         efi_status_t status;
 771
 772         status = efi_get_memory_map(sys_table_arg, map);
 773
 774         if (status != EFI_SUCCESS)
 775                 goto fail;
 776
 777         status = priv_func(sys_table_arg, map, priv);
 778         if (status != EFI_SUCCESS)
 779                 goto free_map;
 780
 781         status = efi_call_early(exit_boot_services, handle, *map->key_ptr);
 782
 783         if (status == EFI_INVALID_PARAMETER) {
 784                 /*
 785                  * The memory map changed between efi_get_memory_map() and
 786                  * exit_boot_services().  Per the UEFI Spec v2.6, Section 6.4:
 787                  * EFI_BOOT_SERVICES.ExitBootServices we need to get the
 788                  * updated map, and try again.  The spec implies one retry
 789                  * should be sufficent, which is confirmed against the EDK2
 790                  * implementation.  Per the spec, we can only invoke
 791                  * get_memory_map() and exit_boot_services() - we cannot alloc
 792                  * so efi_get_memory_map() cannot be used, and we must reuse
 793                  * the buffer.  For all practical purposes, the headroom in the
 794                  * buffer should account for any changes in the map so the call
 795                  * to get_memory_map() is expected to succeed here.
 796                  */
 797                 *map->map_size = *map->buff_size;
 798                 status = efi_call_early(get_memory_map,
 799                                         map->map_size,
 800                                         *map->map,
 801                                         map->key_ptr,
 802                                         map->desc_size,
 803                                         map->desc_ver);
 804
 805                 /* exit_boot_services() was called, thus cannot free */
 806                 if (status != EFI_SUCCESS)
 807                         goto fail;
 808
 809                 status = priv_func(sys_table_arg, map, priv);
 810                 /* exit_boot_services() was called, thus cannot free */
 811                 if (status != EFI_SUCCESS)
 812                         goto fail;
 813
 814                 status = efi_call_early(exit_boot_services, handle, *map->key_ptr);
 815         }
 816
 817         /* exit_boot_services() was called, thus cannot free */
 818         if (status != EFI_SUCCESS)
 819                 goto fail;
 820
 821         return EFI_SUCCESS;
 822
 823 free_map:
 824         efi_call_early(free_pool, *map->map);
 825 fail:
 826         return status;
 827 }