14febfb8dSArd Biesheuvel // SPDX-License-Identifier: GPL-2.0 2f4f75ad5SArd Biesheuvel /* 3f4f75ad5SArd Biesheuvel * Helper functions used by the EFI stub on multiple 4f4f75ad5SArd Biesheuvel * architectures. This should be #included by the EFI stub 5f4f75ad5SArd Biesheuvel * implementation files. 6f4f75ad5SArd Biesheuvel * 7f4f75ad5SArd Biesheuvel * Copyright 2011 Intel Corporation; author Matt Fleming 8f4f75ad5SArd Biesheuvel */ 9f4f75ad5SArd Biesheuvel 102c7d1e30SArvind Sankar #include <stdarg.h> 112c7d1e30SArvind Sankar 12f4f75ad5SArd Biesheuvel #include <linux/efi.h> 13fd0528a2SArvind Sankar #include <linux/kernel.h> 1423d5b73fSArvind Sankar #include <linux/printk.h> /* For CONSOLE_LOGLEVEL_* */ 15f4f75ad5SArd Biesheuvel #include <asm/efi.h> 16f4f75ad5SArd Biesheuvel 17f4f75ad5SArd Biesheuvel #include "efistub.h" 18f4f75ad5SArd Biesheuvel 19980771f6SArd Biesheuvel bool efi_nochunk; 20980771f6SArd Biesheuvel bool efi_nokaslr; 21980771f6SArd Biesheuvel bool efi_noinitrd; 2223d5b73fSArvind Sankar int efi_loglevel = CONSOLE_LOGLEVEL_DEFAULT; 23980771f6SArd Biesheuvel bool efi_novamap; 24980771f6SArd Biesheuvel 2554439370SArvind Sankar static bool efi_nosoftreserve; 2654439370SArvind Sankar static bool efi_disable_pci_dma = IS_ENABLED(CONFIG_EFI_DISABLE_PCI_DMA); 2760f38de7SArd Biesheuvel 28b617c526SDan Williams bool __pure __efi_soft_reserve_enabled(void) 29b617c526SDan Williams { 30b617c526SDan Williams return !efi_nosoftreserve; 31b617c526SDan Williams } 3260f38de7SArd Biesheuvel 33cb8c90a0SArvind Sankar void efi_char16_puts(efi_char16_t *str) 34cb8c90a0SArvind Sankar { 35cb8c90a0SArvind Sankar efi_call_proto(efi_table_attr(efi_system_table, con_out), 36cb8c90a0SArvind Sankar output_string, str); 37cb8c90a0SArvind Sankar } 38cb8c90a0SArvind Sankar 394b75bd36SArvind Sankar static 404b75bd36SArvind Sankar u32 utf8_to_utf32(const u8 **s8) 414b75bd36SArvind Sankar { 424b75bd36SArvind Sankar u32 c32; 434b75bd36SArvind Sankar u8 c0, cx; 444b75bd36SArvind Sankar size_t clen, i; 454b75bd36SArvind Sankar 464b75bd36SArvind Sankar c0 = cx = *(*s8)++; 474b75bd36SArvind Sankar /* 484b75bd36SArvind Sankar * The position of the most-significant 0 bit gives us the length of 494b75bd36SArvind Sankar * a multi-octet encoding. 504b75bd36SArvind Sankar */ 514b75bd36SArvind Sankar for (clen = 0; cx & 0x80; ++clen) 524b75bd36SArvind Sankar cx <<= 1; 534b75bd36SArvind Sankar /* 544b75bd36SArvind Sankar * If the 0 bit is in position 8, this is a valid single-octet 554b75bd36SArvind Sankar * encoding. If the 0 bit is in position 7 or positions 1-3, the 564b75bd36SArvind Sankar * encoding is invalid. 574b75bd36SArvind Sankar * In either case, we just return the first octet. 584b75bd36SArvind Sankar */ 594b75bd36SArvind Sankar if (clen < 2 || clen > 4) 604b75bd36SArvind Sankar return c0; 614b75bd36SArvind Sankar /* Get the bits from the first octet. */ 624b75bd36SArvind Sankar c32 = cx >> clen--; 634b75bd36SArvind Sankar for (i = 0; i < clen; ++i) { 644b75bd36SArvind Sankar /* Trailing octets must have 10 in most significant bits. */ 654b75bd36SArvind Sankar cx = (*s8)[i] ^ 0x80; 664b75bd36SArvind Sankar if (cx & 0xc0) 674b75bd36SArvind Sankar return c0; 684b75bd36SArvind Sankar c32 = (c32 << 6) | cx; 694b75bd36SArvind Sankar } 704b75bd36SArvind Sankar /* 714b75bd36SArvind Sankar * Check for validity: 724b75bd36SArvind Sankar * - The character must be in the Unicode range. 734b75bd36SArvind Sankar * - It must not be a surrogate. 744b75bd36SArvind Sankar * - It must be encoded using the correct number of octets. 754b75bd36SArvind Sankar */ 764b75bd36SArvind Sankar if (c32 > 0x10ffff || 774b75bd36SArvind Sankar (c32 & 0xf800) == 0xd800 || 784b75bd36SArvind Sankar clen != (c32 >= 0x80) + (c32 >= 0x800) + (c32 >= 0x10000)) 794b75bd36SArvind Sankar return c0; 804b75bd36SArvind Sankar *s8 += clen; 814b75bd36SArvind Sankar return c32; 824b75bd36SArvind Sankar } 834b75bd36SArvind Sankar 84cb8c90a0SArvind Sankar void efi_puts(const char *str) 85f4f75ad5SArd Biesheuvel { 86fd0528a2SArvind Sankar efi_char16_t buf[128]; 87fd0528a2SArvind Sankar size_t pos = 0, lim = ARRAY_SIZE(buf); 884b75bd36SArvind Sankar const u8 *s8 = (const u8 *)str; 894b75bd36SArvind Sankar u32 c32; 90f4f75ad5SArd Biesheuvel 914b75bd36SArvind Sankar while (*s8) { 924b75bd36SArvind Sankar if (*s8 == '\n') 93fd0528a2SArvind Sankar buf[pos++] = L'\r'; 944b75bd36SArvind Sankar c32 = utf8_to_utf32(&s8); 954b75bd36SArvind Sankar if (c32 < 0x10000) { 964b75bd36SArvind Sankar /* Characters in plane 0 use a single word. */ 974b75bd36SArvind Sankar buf[pos++] = c32; 984b75bd36SArvind Sankar } else { 994b75bd36SArvind Sankar /* 1004b75bd36SArvind Sankar * Characters in other planes encode into a surrogate 1014b75bd36SArvind Sankar * pair. 1024b75bd36SArvind Sankar */ 1034b75bd36SArvind Sankar buf[pos++] = (0xd800 - (0x10000 >> 10)) + (c32 >> 10); 1044b75bd36SArvind Sankar buf[pos++] = 0xdc00 + (c32 & 0x3ff); 1054b75bd36SArvind Sankar } 1064b75bd36SArvind Sankar if (*s8 == '\0' || pos >= lim - 2) { 107fd0528a2SArvind Sankar buf[pos] = L'\0'; 108fd0528a2SArvind Sankar efi_char16_puts(buf); 109fd0528a2SArvind Sankar pos = 0; 110fd0528a2SArvind Sankar } 111f4f75ad5SArd Biesheuvel } 112f4f75ad5SArd Biesheuvel } 113f4f75ad5SArd Biesheuvel 1142c7d1e30SArvind Sankar int efi_printk(const char *fmt, ...) 1152c7d1e30SArvind Sankar { 1162c7d1e30SArvind Sankar char printf_buf[256]; 1172c7d1e30SArvind Sankar va_list args; 1182c7d1e30SArvind Sankar int printed; 11923d5b73fSArvind Sankar int loglevel = printk_get_level(fmt); 12023d5b73fSArvind Sankar 12123d5b73fSArvind Sankar switch (loglevel) { 12223d5b73fSArvind Sankar case '0' ... '9': 12323d5b73fSArvind Sankar loglevel -= '0'; 12423d5b73fSArvind Sankar break; 12523d5b73fSArvind Sankar default: 12623d5b73fSArvind Sankar /* 12723d5b73fSArvind Sankar * Use loglevel -1 for cases where we just want to print to 12823d5b73fSArvind Sankar * the screen. 12923d5b73fSArvind Sankar */ 13023d5b73fSArvind Sankar loglevel = -1; 13123d5b73fSArvind Sankar break; 13223d5b73fSArvind Sankar } 13323d5b73fSArvind Sankar 13423d5b73fSArvind Sankar if (loglevel >= efi_loglevel) 13523d5b73fSArvind Sankar return 0; 13623d5b73fSArvind Sankar 13723d5b73fSArvind Sankar if (loglevel >= 0) 13823d5b73fSArvind Sankar efi_puts("EFI stub: "); 13923d5b73fSArvind Sankar 14023d5b73fSArvind Sankar fmt = printk_skip_level(fmt); 1412c7d1e30SArvind Sankar 1422c7d1e30SArvind Sankar va_start(args, fmt); 1438fb331e1SArvind Sankar printed = vsnprintf(printf_buf, sizeof(printf_buf), fmt, args); 1442c7d1e30SArvind Sankar va_end(args); 1452c7d1e30SArvind Sankar 1462c7d1e30SArvind Sankar efi_puts(printf_buf); 1478fb331e1SArvind Sankar if (printed >= sizeof(printf_buf)) { 1488fb331e1SArvind Sankar efi_puts("[Message truncated]\n"); 1498fb331e1SArvind Sankar return -1; 1508fb331e1SArvind Sankar } 1512c7d1e30SArvind Sankar 1522c7d1e30SArvind Sankar return printed; 1532c7d1e30SArvind Sankar } 1542c7d1e30SArvind Sankar 1555a17dae4SMatt Fleming /* 1565a17dae4SMatt Fleming * Parse the ASCII string 'cmdline' for EFI options, denoted by the efi= 1575a17dae4SMatt Fleming * option, e.g. efi=nochunk. 1585a17dae4SMatt Fleming * 1595a17dae4SMatt Fleming * It should be noted that efi= is parsed in two very different 1605a17dae4SMatt Fleming * environments, first in the early boot environment of the EFI boot 1615a17dae4SMatt Fleming * stub, and subsequently during the kernel boot. 1625a17dae4SMatt Fleming */ 16360f38de7SArd Biesheuvel efi_status_t efi_parse_options(char const *cmdline) 1645a17dae4SMatt Fleming { 16591d150c0SArd Biesheuvel size_t len = strlen(cmdline) + 1; 16691d150c0SArd Biesheuvel efi_status_t status; 16791d150c0SArd Biesheuvel char *str, *buf; 1685a17dae4SMatt Fleming 16991d150c0SArd Biesheuvel status = efi_bs_call(allocate_pool, EFI_LOADER_DATA, len, (void **)&buf); 17091d150c0SArd Biesheuvel if (status != EFI_SUCCESS) 17191d150c0SArd Biesheuvel return status; 17291d150c0SArd Biesheuvel 17391d150c0SArd Biesheuvel str = skip_spaces(memcpy(buf, cmdline, len)); 17491d150c0SArd Biesheuvel 17591d150c0SArd Biesheuvel while (*str) { 17691d150c0SArd Biesheuvel char *param, *val; 17791d150c0SArd Biesheuvel 17891d150c0SArd Biesheuvel str = next_arg(str, ¶m, &val); 17991d150c0SArd Biesheuvel 18091d150c0SArd Biesheuvel if (!strcmp(param, "nokaslr")) { 1817d4e323dSArd Biesheuvel efi_nokaslr = true; 18291d150c0SArd Biesheuvel } else if (!strcmp(param, "quiet")) { 18323d5b73fSArvind Sankar efi_loglevel = CONSOLE_LOGLEVEL_QUIET; 18479d3219dSArd Biesheuvel } else if (!strcmp(param, "noinitrd")) { 18579d3219dSArd Biesheuvel efi_noinitrd = true; 18691d150c0SArd Biesheuvel } else if (!strcmp(param, "efi") && val) { 18791d150c0SArd Biesheuvel efi_nochunk = parse_option_str(val, "nochunk"); 18891d150c0SArd Biesheuvel efi_novamap = parse_option_str(val, "novamap"); 189eeff7d63SArd Biesheuvel 19091d150c0SArd Biesheuvel efi_nosoftreserve = IS_ENABLED(CONFIG_EFI_SOFT_RESERVE) && 19191d150c0SArd Biesheuvel parse_option_str(val, "nosoftreserve"); 1925a17dae4SMatt Fleming 19391d150c0SArd Biesheuvel if (parse_option_str(val, "disable_early_pci_dma")) 1944444f854SMatthew Garrett efi_disable_pci_dma = true; 19591d150c0SArd Biesheuvel if (parse_option_str(val, "no_disable_early_pci_dma")) 1964444f854SMatthew Garrett efi_disable_pci_dma = false; 19723d5b73fSArvind Sankar if (parse_option_str(val, "debug")) 19823d5b73fSArvind Sankar efi_loglevel = CONSOLE_LOGLEVEL_DEBUG; 199fffb6804SArvind Sankar } else if (!strcmp(param, "video") && 200fffb6804SArvind Sankar val && strstarts(val, "efifb:")) { 201fffb6804SArvind Sankar efi_parse_option_graphics(val + strlen("efifb:")); 2024444f854SMatthew Garrett } 2035a17dae4SMatt Fleming } 20491d150c0SArd Biesheuvel efi_bs_call(free_pool, buf); 2055a17dae4SMatt Fleming return EFI_SUCCESS; 2065a17dae4SMatt Fleming } 207f4f75ad5SArd Biesheuvel 208f4f75ad5SArd Biesheuvel /* 209f4f75ad5SArd Biesheuvel * Get the number of UTF-8 bytes corresponding to an UTF-16 character. 210f4f75ad5SArd Biesheuvel * This overestimates for surrogates, but that is okay. 211f4f75ad5SArd Biesheuvel */ 212f4f75ad5SArd Biesheuvel static int efi_utf8_bytes(u16 c) 213f4f75ad5SArd Biesheuvel { 214f4f75ad5SArd Biesheuvel return 1 + (c >= 0x80) + (c >= 0x800); 215f4f75ad5SArd Biesheuvel } 216f4f75ad5SArd Biesheuvel 217f4f75ad5SArd Biesheuvel /* 218f4f75ad5SArd Biesheuvel * Convert an UTF-16 string, not necessarily null terminated, to UTF-8. 219f4f75ad5SArd Biesheuvel */ 220f4f75ad5SArd Biesheuvel static u8 *efi_utf16_to_utf8(u8 *dst, const u16 *src, int n) 221f4f75ad5SArd Biesheuvel { 222f4f75ad5SArd Biesheuvel unsigned int c; 223f4f75ad5SArd Biesheuvel 224f4f75ad5SArd Biesheuvel while (n--) { 225f4f75ad5SArd Biesheuvel c = *src++; 226f4f75ad5SArd Biesheuvel if (n && c >= 0xd800 && c <= 0xdbff && 227f4f75ad5SArd Biesheuvel *src >= 0xdc00 && *src <= 0xdfff) { 228f4f75ad5SArd Biesheuvel c = 0x10000 + ((c & 0x3ff) << 10) + (*src & 0x3ff); 229f4f75ad5SArd Biesheuvel src++; 230f4f75ad5SArd Biesheuvel n--; 231f4f75ad5SArd Biesheuvel } 232f4f75ad5SArd Biesheuvel if (c >= 0xd800 && c <= 0xdfff) 233f4f75ad5SArd Biesheuvel c = 0xfffd; /* Unmatched surrogate */ 234f4f75ad5SArd Biesheuvel if (c < 0x80) { 235f4f75ad5SArd Biesheuvel *dst++ = c; 236f4f75ad5SArd Biesheuvel continue; 237f4f75ad5SArd Biesheuvel } 238f4f75ad5SArd Biesheuvel if (c < 0x800) { 239f4f75ad5SArd Biesheuvel *dst++ = 0xc0 + (c >> 6); 240f4f75ad5SArd Biesheuvel goto t1; 241f4f75ad5SArd Biesheuvel } 242f4f75ad5SArd Biesheuvel if (c < 0x10000) { 243f4f75ad5SArd Biesheuvel *dst++ = 0xe0 + (c >> 12); 244f4f75ad5SArd Biesheuvel goto t2; 245f4f75ad5SArd Biesheuvel } 246f4f75ad5SArd Biesheuvel *dst++ = 0xf0 + (c >> 18); 247f4f75ad5SArd Biesheuvel *dst++ = 0x80 + ((c >> 12) & 0x3f); 248f4f75ad5SArd Biesheuvel t2: 249f4f75ad5SArd Biesheuvel *dst++ = 0x80 + ((c >> 6) & 0x3f); 250f4f75ad5SArd Biesheuvel t1: 251f4f75ad5SArd Biesheuvel *dst++ = 0x80 + (c & 0x3f); 252f4f75ad5SArd Biesheuvel } 253f4f75ad5SArd Biesheuvel 254f4f75ad5SArd Biesheuvel return dst; 255f4f75ad5SArd Biesheuvel } 256f4f75ad5SArd Biesheuvel 257f4f75ad5SArd Biesheuvel /* 258f4f75ad5SArd Biesheuvel * Convert the unicode UEFI command line to ASCII to pass to kernel. 259f4f75ad5SArd Biesheuvel * Size of memory allocated return in *cmd_line_len. 260f4f75ad5SArd Biesheuvel * Returns NULL on error. 261f4f75ad5SArd Biesheuvel */ 262cd33a5c1SArd Biesheuvel char *efi_convert_cmdline(efi_loaded_image_t *image, 2631e45bf73SArd Biesheuvel int *cmd_line_len, unsigned long max_addr) 264f4f75ad5SArd Biesheuvel { 265f4f75ad5SArd Biesheuvel const u16 *s2; 266f4f75ad5SArd Biesheuvel u8 *s1 = NULL; 267f4f75ad5SArd Biesheuvel unsigned long cmdline_addr = 0; 268f7b85b33SArd Biesheuvel int load_options_chars = efi_table_attr(image, load_options_size) / 2; 269f7b85b33SArd Biesheuvel const u16 *options = efi_table_attr(image, load_options); 270f4f75ad5SArd Biesheuvel int options_bytes = 0; /* UTF-8 bytes */ 271f4f75ad5SArd Biesheuvel int options_chars = 0; /* UTF-16 chars */ 272f4f75ad5SArd Biesheuvel efi_status_t status; 273f4f75ad5SArd Biesheuvel u16 zero = 0; 274f4f75ad5SArd Biesheuvel 275f4f75ad5SArd Biesheuvel if (options) { 276f4f75ad5SArd Biesheuvel s2 = options; 277f4f75ad5SArd Biesheuvel while (*s2 && *s2 != '\n' 278f4f75ad5SArd Biesheuvel && options_chars < load_options_chars) { 279f4f75ad5SArd Biesheuvel options_bytes += efi_utf8_bytes(*s2++); 280f4f75ad5SArd Biesheuvel options_chars++; 281f4f75ad5SArd Biesheuvel } 282f4f75ad5SArd Biesheuvel } 283f4f75ad5SArd Biesheuvel 284f4f75ad5SArd Biesheuvel if (!options_chars) { 285f4f75ad5SArd Biesheuvel /* No command line options, so return empty string*/ 286f4f75ad5SArd Biesheuvel options = &zero; 287f4f75ad5SArd Biesheuvel } 288f4f75ad5SArd Biesheuvel 289f4f75ad5SArd Biesheuvel options_bytes++; /* NUL termination */ 290f4f75ad5SArd Biesheuvel 2911e45bf73SArd Biesheuvel status = efi_allocate_pages(options_bytes, &cmdline_addr, max_addr); 292f4f75ad5SArd Biesheuvel if (status != EFI_SUCCESS) 293f4f75ad5SArd Biesheuvel return NULL; 294f4f75ad5SArd Biesheuvel 295f4f75ad5SArd Biesheuvel s1 = (u8 *)cmdline_addr; 296f4f75ad5SArd Biesheuvel s2 = (const u16 *)options; 297f4f75ad5SArd Biesheuvel 298f4f75ad5SArd Biesheuvel s1 = efi_utf16_to_utf8(s1, s2, options_chars); 299f4f75ad5SArd Biesheuvel *s1 = '\0'; 300f4f75ad5SArd Biesheuvel 301f4f75ad5SArd Biesheuvel *cmd_line_len = options_bytes; 302f4f75ad5SArd Biesheuvel return (char *)cmdline_addr; 303f4f75ad5SArd Biesheuvel } 304fc07716bSJeffrey Hugo 305fc07716bSJeffrey Hugo /* 306fc07716bSJeffrey Hugo * Handle calling ExitBootServices according to the requirements set out by the 307fc07716bSJeffrey Hugo * spec. Obtains the current memory map, and returns that info after calling 308fc07716bSJeffrey Hugo * ExitBootServices. The client must specify a function to perform any 309fc07716bSJeffrey Hugo * processing of the memory map data prior to ExitBootServices. A client 310fc07716bSJeffrey Hugo * specific structure may be passed to the function via priv. The client 311fc07716bSJeffrey Hugo * function may be called multiple times. 312fc07716bSJeffrey Hugo */ 313cd33a5c1SArd Biesheuvel efi_status_t efi_exit_boot_services(void *handle, 314fc07716bSJeffrey Hugo struct efi_boot_memmap *map, 315fc07716bSJeffrey Hugo void *priv, 316fc07716bSJeffrey Hugo efi_exit_boot_map_processing priv_func) 317fc07716bSJeffrey Hugo { 318fc07716bSJeffrey Hugo efi_status_t status; 319fc07716bSJeffrey Hugo 320cd33a5c1SArd Biesheuvel status = efi_get_memory_map(map); 321fc07716bSJeffrey Hugo 322fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 323fc07716bSJeffrey Hugo goto fail; 324fc07716bSJeffrey Hugo 325cd33a5c1SArd Biesheuvel status = priv_func(map, priv); 326fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 327fc07716bSJeffrey Hugo goto free_map; 328fc07716bSJeffrey Hugo 3294444f854SMatthew Garrett if (efi_disable_pci_dma) 3304444f854SMatthew Garrett efi_pci_disable_bridge_busmaster(); 3314444f854SMatthew Garrett 332966291f6SArd Biesheuvel status = efi_bs_call(exit_boot_services, handle, *map->key_ptr); 333fc07716bSJeffrey Hugo 334fc07716bSJeffrey Hugo if (status == EFI_INVALID_PARAMETER) { 335fc07716bSJeffrey Hugo /* 336fc07716bSJeffrey Hugo * The memory map changed between efi_get_memory_map() and 337fc07716bSJeffrey Hugo * exit_boot_services(). Per the UEFI Spec v2.6, Section 6.4: 338fc07716bSJeffrey Hugo * EFI_BOOT_SERVICES.ExitBootServices we need to get the 339fc07716bSJeffrey Hugo * updated map, and try again. The spec implies one retry 340fc07716bSJeffrey Hugo * should be sufficent, which is confirmed against the EDK2 341fc07716bSJeffrey Hugo * implementation. Per the spec, we can only invoke 342fc07716bSJeffrey Hugo * get_memory_map() and exit_boot_services() - we cannot alloc 343fc07716bSJeffrey Hugo * so efi_get_memory_map() cannot be used, and we must reuse 344fc07716bSJeffrey Hugo * the buffer. For all practical purposes, the headroom in the 345fc07716bSJeffrey Hugo * buffer should account for any changes in the map so the call 346fc07716bSJeffrey Hugo * to get_memory_map() is expected to succeed here. 347fc07716bSJeffrey Hugo */ 348fc07716bSJeffrey Hugo *map->map_size = *map->buff_size; 349966291f6SArd Biesheuvel status = efi_bs_call(get_memory_map, 350fc07716bSJeffrey Hugo map->map_size, 351fc07716bSJeffrey Hugo *map->map, 352fc07716bSJeffrey Hugo map->key_ptr, 353fc07716bSJeffrey Hugo map->desc_size, 354fc07716bSJeffrey Hugo map->desc_ver); 355fc07716bSJeffrey Hugo 356fc07716bSJeffrey Hugo /* exit_boot_services() was called, thus cannot free */ 357fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 358fc07716bSJeffrey Hugo goto fail; 359fc07716bSJeffrey Hugo 360cd33a5c1SArd Biesheuvel status = priv_func(map, priv); 361fc07716bSJeffrey Hugo /* exit_boot_services() was called, thus cannot free */ 362fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 363fc07716bSJeffrey Hugo goto fail; 364fc07716bSJeffrey Hugo 365966291f6SArd Biesheuvel status = efi_bs_call(exit_boot_services, handle, *map->key_ptr); 366fc07716bSJeffrey Hugo } 367fc07716bSJeffrey Hugo 368fc07716bSJeffrey Hugo /* exit_boot_services() was called, thus cannot free */ 369fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 370fc07716bSJeffrey Hugo goto fail; 371fc07716bSJeffrey Hugo 372fc07716bSJeffrey Hugo return EFI_SUCCESS; 373fc07716bSJeffrey Hugo 374fc07716bSJeffrey Hugo free_map: 375966291f6SArd Biesheuvel efi_bs_call(free_pool, *map->map); 376fc07716bSJeffrey Hugo fail: 377fc07716bSJeffrey Hugo return status; 378fc07716bSJeffrey Hugo } 37982d736acSMatthew Garrett 380cd33a5c1SArd Biesheuvel void *get_efi_config_table(efi_guid_t guid) 38182d736acSMatthew Garrett { 382ccc27ae7SArd Biesheuvel unsigned long tables = efi_table_attr(efi_system_table, tables); 383ccc27ae7SArd Biesheuvel int nr_tables = efi_table_attr(efi_system_table, nr_tables); 384f958efe9SArd Biesheuvel int i; 385f958efe9SArd Biesheuvel 386f958efe9SArd Biesheuvel for (i = 0; i < nr_tables; i++) { 387f958efe9SArd Biesheuvel efi_config_table_t *t = (void *)tables; 388f958efe9SArd Biesheuvel 389f958efe9SArd Biesheuvel if (efi_guidcmp(t->guid, guid) == 0) 39099ea8b1dSArd Biesheuvel return efi_table_attr(t, table); 391f958efe9SArd Biesheuvel 392f958efe9SArd Biesheuvel tables += efi_is_native() ? sizeof(efi_config_table_t) 393f958efe9SArd Biesheuvel : sizeof(efi_config_table_32_t); 394f958efe9SArd Biesheuvel } 395f958efe9SArd Biesheuvel return NULL; 39682d736acSMatthew Garrett } 397dc29da14SArd Biesheuvel 398ec93fc37SArd Biesheuvel /* 399ec93fc37SArd Biesheuvel * The LINUX_EFI_INITRD_MEDIA_GUID vendor media device path below provides a way 400ec93fc37SArd Biesheuvel * for the firmware or bootloader to expose the initrd data directly to the stub 401ec93fc37SArd Biesheuvel * via the trivial LoadFile2 protocol, which is defined in the UEFI spec, and is 402ec93fc37SArd Biesheuvel * very easy to implement. It is a simple Linux initrd specific conduit between 403ec93fc37SArd Biesheuvel * kernel and firmware, allowing us to put the EFI stub (being part of the 404ec93fc37SArd Biesheuvel * kernel) in charge of where and when to load the initrd, while leaving it up 405ec93fc37SArd Biesheuvel * to the firmware to decide whether it needs to expose its filesystem hierarchy 406ec93fc37SArd Biesheuvel * via EFI protocols. 407ec93fc37SArd Biesheuvel */ 408ec93fc37SArd Biesheuvel static const struct { 409ec93fc37SArd Biesheuvel struct efi_vendor_dev_path vendor; 410ec93fc37SArd Biesheuvel struct efi_generic_dev_path end; 411ec93fc37SArd Biesheuvel } __packed initrd_dev_path = { 412ec93fc37SArd Biesheuvel { 413ec93fc37SArd Biesheuvel { 414ec93fc37SArd Biesheuvel EFI_DEV_MEDIA, 415ec93fc37SArd Biesheuvel EFI_DEV_MEDIA_VENDOR, 416ec93fc37SArd Biesheuvel sizeof(struct efi_vendor_dev_path), 417ec93fc37SArd Biesheuvel }, 418ec93fc37SArd Biesheuvel LINUX_EFI_INITRD_MEDIA_GUID 419ec93fc37SArd Biesheuvel }, { 420ec93fc37SArd Biesheuvel EFI_DEV_END_PATH, 421ec93fc37SArd Biesheuvel EFI_DEV_END_ENTIRE, 422ec93fc37SArd Biesheuvel sizeof(struct efi_generic_dev_path) 423ec93fc37SArd Biesheuvel } 424ec93fc37SArd Biesheuvel }; 425ec93fc37SArd Biesheuvel 426ec93fc37SArd Biesheuvel /** 427ec93fc37SArd Biesheuvel * efi_load_initrd_dev_path - load the initrd from the Linux initrd device path 428ec93fc37SArd Biesheuvel * @load_addr: pointer to store the address where the initrd was loaded 429ec93fc37SArd Biesheuvel * @load_size: pointer to store the size of the loaded initrd 430ec93fc37SArd Biesheuvel * @max: upper limit for the initrd memory allocation 431ec93fc37SArd Biesheuvel * @return: %EFI_SUCCESS if the initrd was loaded successfully, in which 432ec93fc37SArd Biesheuvel * case @load_addr and @load_size are assigned accordingly 433ec93fc37SArd Biesheuvel * %EFI_NOT_FOUND if no LoadFile2 protocol exists on the initrd 434ec93fc37SArd Biesheuvel * device path 435ec93fc37SArd Biesheuvel * %EFI_INVALID_PARAMETER if load_addr == NULL or load_size == NULL 436ec93fc37SArd Biesheuvel * %EFI_OUT_OF_RESOURCES if memory allocation failed 437ec93fc37SArd Biesheuvel * %EFI_LOAD_ERROR in all other cases 438ec93fc37SArd Biesheuvel */ 439f61900fdSArvind Sankar static 440ec93fc37SArd Biesheuvel efi_status_t efi_load_initrd_dev_path(unsigned long *load_addr, 441ec93fc37SArd Biesheuvel unsigned long *load_size, 442ec93fc37SArd Biesheuvel unsigned long max) 443ec93fc37SArd Biesheuvel { 444ec93fc37SArd Biesheuvel efi_guid_t lf2_proto_guid = EFI_LOAD_FILE2_PROTOCOL_GUID; 445ec93fc37SArd Biesheuvel efi_device_path_protocol_t *dp; 446ec93fc37SArd Biesheuvel efi_load_file2_protocol_t *lf2; 447ec93fc37SArd Biesheuvel unsigned long initrd_addr; 448ec93fc37SArd Biesheuvel unsigned long initrd_size; 449ec93fc37SArd Biesheuvel efi_handle_t handle; 450ec93fc37SArd Biesheuvel efi_status_t status; 451ec93fc37SArd Biesheuvel 452ec93fc37SArd Biesheuvel dp = (efi_device_path_protocol_t *)&initrd_dev_path; 453ec93fc37SArd Biesheuvel status = efi_bs_call(locate_device_path, &lf2_proto_guid, &dp, &handle); 454ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) 455ec93fc37SArd Biesheuvel return status; 456ec93fc37SArd Biesheuvel 457ec93fc37SArd Biesheuvel status = efi_bs_call(handle_protocol, handle, &lf2_proto_guid, 458ec93fc37SArd Biesheuvel (void **)&lf2); 459ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) 460ec93fc37SArd Biesheuvel return status; 461ec93fc37SArd Biesheuvel 462ec93fc37SArd Biesheuvel status = efi_call_proto(lf2, load_file, dp, false, &initrd_size, NULL); 463ec93fc37SArd Biesheuvel if (status != EFI_BUFFER_TOO_SMALL) 464ec93fc37SArd Biesheuvel return EFI_LOAD_ERROR; 465ec93fc37SArd Biesheuvel 466ec93fc37SArd Biesheuvel status = efi_allocate_pages(initrd_size, &initrd_addr, max); 467ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) 468ec93fc37SArd Biesheuvel return status; 469ec93fc37SArd Biesheuvel 470ec93fc37SArd Biesheuvel status = efi_call_proto(lf2, load_file, dp, false, &initrd_size, 471ec93fc37SArd Biesheuvel (void *)initrd_addr); 472ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) { 473ec93fc37SArd Biesheuvel efi_free(initrd_size, initrd_addr); 474ec93fc37SArd Biesheuvel return EFI_LOAD_ERROR; 475ec93fc37SArd Biesheuvel } 476ec93fc37SArd Biesheuvel 477ec93fc37SArd Biesheuvel *load_addr = initrd_addr; 478ec93fc37SArd Biesheuvel *load_size = initrd_size; 479ec93fc37SArd Biesheuvel return EFI_SUCCESS; 480ec93fc37SArd Biesheuvel } 481f61900fdSArvind Sankar 482f61900fdSArvind Sankar static 483f61900fdSArvind Sankar efi_status_t efi_load_initrd_cmdline(efi_loaded_image_t *image, 484f61900fdSArvind Sankar unsigned long *load_addr, 485f61900fdSArvind Sankar unsigned long *load_size, 486f61900fdSArvind Sankar unsigned long soft_limit, 487f61900fdSArvind Sankar unsigned long hard_limit) 488f61900fdSArvind Sankar { 489f61900fdSArvind Sankar if (!IS_ENABLED(CONFIG_EFI_GENERIC_STUB_INITRD_CMDLINE_LOADER) || 490f61900fdSArvind Sankar (IS_ENABLED(CONFIG_X86) && (!efi_is_native() || image == NULL))) { 491f61900fdSArvind Sankar *load_addr = *load_size = 0; 492f61900fdSArvind Sankar return EFI_SUCCESS; 493f61900fdSArvind Sankar } 494f61900fdSArvind Sankar 495f61900fdSArvind Sankar return handle_cmdline_files(image, L"initrd=", sizeof(L"initrd=") - 2, 496f61900fdSArvind Sankar soft_limit, hard_limit, 497f61900fdSArvind Sankar load_addr, load_size); 498f61900fdSArvind Sankar } 499f61900fdSArvind Sankar 500f61900fdSArvind Sankar efi_status_t efi_load_initrd(efi_loaded_image_t *image, 501f61900fdSArvind Sankar unsigned long *load_addr, 502f61900fdSArvind Sankar unsigned long *load_size, 503f61900fdSArvind Sankar unsigned long soft_limit, 504f61900fdSArvind Sankar unsigned long hard_limit) 505f61900fdSArvind Sankar { 506f61900fdSArvind Sankar efi_status_t status; 507f61900fdSArvind Sankar 508f61900fdSArvind Sankar if (!load_addr || !load_size) 509f61900fdSArvind Sankar return EFI_INVALID_PARAMETER; 510f61900fdSArvind Sankar 511f61900fdSArvind Sankar status = efi_load_initrd_dev_path(load_addr, load_size, hard_limit); 512f61900fdSArvind Sankar if (status == EFI_SUCCESS) { 513f61900fdSArvind Sankar efi_info("Loaded initrd from LINUX_EFI_INITRD_MEDIA_GUID device path\n"); 514f61900fdSArvind Sankar } else if (status == EFI_NOT_FOUND) { 515f61900fdSArvind Sankar status = efi_load_initrd_cmdline(image, load_addr, load_size, 516f61900fdSArvind Sankar soft_limit, hard_limit); 517f61900fdSArvind Sankar if (status == EFI_SUCCESS && *load_size > 0) 518f61900fdSArvind Sankar efi_info("Loaded initrd from command line option\n"); 519f61900fdSArvind Sankar } 520f61900fdSArvind Sankar 521f61900fdSArvind Sankar return status; 522f61900fdSArvind Sankar } 52314c574f3SArvind Sankar 52414c574f3SArvind Sankar efi_status_t efi_wait_for_key(unsigned long usec, efi_input_key_t *key) 52514c574f3SArvind Sankar { 52614c574f3SArvind Sankar efi_event_t events[2], timer; 52714c574f3SArvind Sankar unsigned long index; 52814c574f3SArvind Sankar efi_simple_text_input_protocol_t *con_in; 52914c574f3SArvind Sankar efi_status_t status; 53014c574f3SArvind Sankar 53114c574f3SArvind Sankar con_in = efi_table_attr(efi_system_table, con_in); 53214c574f3SArvind Sankar if (!con_in) 53314c574f3SArvind Sankar return EFI_UNSUPPORTED; 53414c574f3SArvind Sankar efi_set_event_at(events, 0, efi_table_attr(con_in, wait_for_key)); 53514c574f3SArvind Sankar 53614c574f3SArvind Sankar status = efi_bs_call(create_event, EFI_EVT_TIMER, 0, NULL, NULL, &timer); 53714c574f3SArvind Sankar if (status != EFI_SUCCESS) 53814c574f3SArvind Sankar return status; 53914c574f3SArvind Sankar 54014c574f3SArvind Sankar status = efi_bs_call(set_timer, timer, EfiTimerRelative, 54114c574f3SArvind Sankar EFI_100NSEC_PER_USEC * usec); 54214c574f3SArvind Sankar if (status != EFI_SUCCESS) 54314c574f3SArvind Sankar return status; 54414c574f3SArvind Sankar efi_set_event_at(events, 1, timer); 54514c574f3SArvind Sankar 54614c574f3SArvind Sankar status = efi_bs_call(wait_for_event, 2, events, &index); 54714c574f3SArvind Sankar if (status == EFI_SUCCESS) { 54814c574f3SArvind Sankar if (index == 0) 54914c574f3SArvind Sankar status = efi_call_proto(con_in, read_keystroke, key); 55014c574f3SArvind Sankar else 55114c574f3SArvind Sankar status = EFI_TIMEOUT; 55214c574f3SArvind Sankar } 55314c574f3SArvind Sankar 55414c574f3SArvind Sankar efi_bs_call(close_event, timer); 55514c574f3SArvind Sankar 55614c574f3SArvind Sankar return status; 55714c574f3SArvind Sankar } 558