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 10c0891ac1SAlexey Dobriyan #include <linux/stdarg.h> 112c7d1e30SArvind Sankar 1280b1bfe1SArvind Sankar #include <linux/ctype.h> 13f4f75ad5SArd Biesheuvel #include <linux/efi.h> 14fd0528a2SArvind Sankar #include <linux/kernel.h> 1523d5b73fSArvind Sankar #include <linux/printk.h> /* For CONSOLE_LOGLEVEL_* */ 16f4f75ad5SArd Biesheuvel #include <asm/efi.h> 1780b1bfe1SArvind Sankar #include <asm/setup.h> 18f4f75ad5SArd Biesheuvel 19f4f75ad5SArd Biesheuvel #include "efistub.h" 20f4f75ad5SArd Biesheuvel 21980771f6SArd Biesheuvel bool efi_nochunk; 227c116db2SWill Deacon bool efi_nokaslr = !IS_ENABLED(CONFIG_RANDOMIZE_BASE); 2323d5b73fSArvind Sankar int efi_loglevel = CONSOLE_LOGLEVEL_DEFAULT; 24980771f6SArd Biesheuvel bool efi_novamap; 25980771f6SArd Biesheuvel 2620287d56SArd Biesheuvel static bool efi_noinitrd; 2754439370SArvind Sankar static bool efi_nosoftreserve; 2854439370SArvind Sankar static bool efi_disable_pci_dma = IS_ENABLED(CONFIG_EFI_DISABLE_PCI_DMA); 2960f38de7SArd Biesheuvel 30b617c526SDan Williams bool __pure __efi_soft_reserve_enabled(void) 31b617c526SDan Williams { 32b617c526SDan Williams return !efi_nosoftreserve; 33b617c526SDan Williams } 3460f38de7SArd Biesheuvel 358c0a839cSHeinrich Schuchardt /** 368c0a839cSHeinrich Schuchardt * efi_char16_puts() - Write a UCS-2 encoded string to the console 378c0a839cSHeinrich Schuchardt * @str: UCS-2 encoded string 388c0a839cSHeinrich Schuchardt */ 39cb8c90a0SArvind Sankar void efi_char16_puts(efi_char16_t *str) 40cb8c90a0SArvind Sankar { 41cb8c90a0SArvind Sankar efi_call_proto(efi_table_attr(efi_system_table, con_out), 42cb8c90a0SArvind Sankar output_string, str); 43cb8c90a0SArvind Sankar } 44cb8c90a0SArvind Sankar 454b75bd36SArvind Sankar static 464b75bd36SArvind Sankar u32 utf8_to_utf32(const u8 **s8) 474b75bd36SArvind Sankar { 484b75bd36SArvind Sankar u32 c32; 494b75bd36SArvind Sankar u8 c0, cx; 504b75bd36SArvind Sankar size_t clen, i; 514b75bd36SArvind Sankar 524b75bd36SArvind Sankar c0 = cx = *(*s8)++; 534b75bd36SArvind Sankar /* 544b75bd36SArvind Sankar * The position of the most-significant 0 bit gives us the length of 554b75bd36SArvind Sankar * a multi-octet encoding. 564b75bd36SArvind Sankar */ 574b75bd36SArvind Sankar for (clen = 0; cx & 0x80; ++clen) 584b75bd36SArvind Sankar cx <<= 1; 594b75bd36SArvind Sankar /* 604b75bd36SArvind Sankar * If the 0 bit is in position 8, this is a valid single-octet 614b75bd36SArvind Sankar * encoding. If the 0 bit is in position 7 or positions 1-3, the 624b75bd36SArvind Sankar * encoding is invalid. 634b75bd36SArvind Sankar * In either case, we just return the first octet. 644b75bd36SArvind Sankar */ 654b75bd36SArvind Sankar if (clen < 2 || clen > 4) 664b75bd36SArvind Sankar return c0; 674b75bd36SArvind Sankar /* Get the bits from the first octet. */ 684b75bd36SArvind Sankar c32 = cx >> clen--; 694b75bd36SArvind Sankar for (i = 0; i < clen; ++i) { 704b75bd36SArvind Sankar /* Trailing octets must have 10 in most significant bits. */ 714b75bd36SArvind Sankar cx = (*s8)[i] ^ 0x80; 724b75bd36SArvind Sankar if (cx & 0xc0) 734b75bd36SArvind Sankar return c0; 744b75bd36SArvind Sankar c32 = (c32 << 6) | cx; 754b75bd36SArvind Sankar } 764b75bd36SArvind Sankar /* 774b75bd36SArvind Sankar * Check for validity: 784b75bd36SArvind Sankar * - The character must be in the Unicode range. 794b75bd36SArvind Sankar * - It must not be a surrogate. 804b75bd36SArvind Sankar * - It must be encoded using the correct number of octets. 814b75bd36SArvind Sankar */ 824b75bd36SArvind Sankar if (c32 > 0x10ffff || 834b75bd36SArvind Sankar (c32 & 0xf800) == 0xd800 || 844b75bd36SArvind Sankar clen != (c32 >= 0x80) + (c32 >= 0x800) + (c32 >= 0x10000)) 854b75bd36SArvind Sankar return c0; 864b75bd36SArvind Sankar *s8 += clen; 874b75bd36SArvind Sankar return c32; 884b75bd36SArvind Sankar } 894b75bd36SArvind Sankar 908c0a839cSHeinrich Schuchardt /** 918c0a839cSHeinrich Schuchardt * efi_puts() - Write a UTF-8 encoded string to the console 928c0a839cSHeinrich Schuchardt * @str: UTF-8 encoded string 938c0a839cSHeinrich Schuchardt */ 94cb8c90a0SArvind Sankar void efi_puts(const char *str) 95f4f75ad5SArd Biesheuvel { 96fd0528a2SArvind Sankar efi_char16_t buf[128]; 97fd0528a2SArvind Sankar size_t pos = 0, lim = ARRAY_SIZE(buf); 984b75bd36SArvind Sankar const u8 *s8 = (const u8 *)str; 994b75bd36SArvind Sankar u32 c32; 100f4f75ad5SArd Biesheuvel 1014b75bd36SArvind Sankar while (*s8) { 1024b75bd36SArvind Sankar if (*s8 == '\n') 103fd0528a2SArvind Sankar buf[pos++] = L'\r'; 1044b75bd36SArvind Sankar c32 = utf8_to_utf32(&s8); 1054b75bd36SArvind Sankar if (c32 < 0x10000) { 1064b75bd36SArvind Sankar /* Characters in plane 0 use a single word. */ 1074b75bd36SArvind Sankar buf[pos++] = c32; 1084b75bd36SArvind Sankar } else { 1094b75bd36SArvind Sankar /* 1104b75bd36SArvind Sankar * Characters in other planes encode into a surrogate 1114b75bd36SArvind Sankar * pair. 1124b75bd36SArvind Sankar */ 1134b75bd36SArvind Sankar buf[pos++] = (0xd800 - (0x10000 >> 10)) + (c32 >> 10); 1144b75bd36SArvind Sankar buf[pos++] = 0xdc00 + (c32 & 0x3ff); 1154b75bd36SArvind Sankar } 1164b75bd36SArvind Sankar if (*s8 == '\0' || pos >= lim - 2) { 117fd0528a2SArvind Sankar buf[pos] = L'\0'; 118fd0528a2SArvind Sankar efi_char16_puts(buf); 119fd0528a2SArvind Sankar pos = 0; 120fd0528a2SArvind Sankar } 121f4f75ad5SArd Biesheuvel } 122f4f75ad5SArd Biesheuvel } 123f4f75ad5SArd Biesheuvel 1248c0a839cSHeinrich Schuchardt /** 1258c0a839cSHeinrich Schuchardt * efi_printk() - Print a kernel message 1268c0a839cSHeinrich Schuchardt * @fmt: format string 1278c0a839cSHeinrich Schuchardt * 1288c0a839cSHeinrich Schuchardt * The first letter of the format string is used to determine the logging level 1298c0a839cSHeinrich Schuchardt * of the message. If the level is less then the current EFI logging level, the 1308c0a839cSHeinrich Schuchardt * message is suppressed. The message will be truncated to 255 bytes. 1318c0a839cSHeinrich Schuchardt * 1328c0a839cSHeinrich Schuchardt * Return: number of printed characters 1338c0a839cSHeinrich Schuchardt */ 1342c7d1e30SArvind Sankar int efi_printk(const char *fmt, ...) 1352c7d1e30SArvind Sankar { 1362c7d1e30SArvind Sankar char printf_buf[256]; 1372c7d1e30SArvind Sankar va_list args; 1382c7d1e30SArvind Sankar int printed; 13923d5b73fSArvind Sankar int loglevel = printk_get_level(fmt); 14023d5b73fSArvind Sankar 14123d5b73fSArvind Sankar switch (loglevel) { 14223d5b73fSArvind Sankar case '0' ... '9': 14323d5b73fSArvind Sankar loglevel -= '0'; 14423d5b73fSArvind Sankar break; 14523d5b73fSArvind Sankar default: 14623d5b73fSArvind Sankar /* 14723d5b73fSArvind Sankar * Use loglevel -1 for cases where we just want to print to 14823d5b73fSArvind Sankar * the screen. 14923d5b73fSArvind Sankar */ 15023d5b73fSArvind Sankar loglevel = -1; 15123d5b73fSArvind Sankar break; 15223d5b73fSArvind Sankar } 15323d5b73fSArvind Sankar 15423d5b73fSArvind Sankar if (loglevel >= efi_loglevel) 15523d5b73fSArvind Sankar return 0; 15623d5b73fSArvind Sankar 15723d5b73fSArvind Sankar if (loglevel >= 0) 15823d5b73fSArvind Sankar efi_puts("EFI stub: "); 15923d5b73fSArvind Sankar 16023d5b73fSArvind Sankar fmt = printk_skip_level(fmt); 1612c7d1e30SArvind Sankar 1622c7d1e30SArvind Sankar va_start(args, fmt); 1638fb331e1SArvind Sankar printed = vsnprintf(printf_buf, sizeof(printf_buf), fmt, args); 1642c7d1e30SArvind Sankar va_end(args); 1652c7d1e30SArvind Sankar 1662c7d1e30SArvind Sankar efi_puts(printf_buf); 1678fb331e1SArvind Sankar if (printed >= sizeof(printf_buf)) { 1688fb331e1SArvind Sankar efi_puts("[Message truncated]\n"); 1698fb331e1SArvind Sankar return -1; 1708fb331e1SArvind Sankar } 1712c7d1e30SArvind Sankar 1722c7d1e30SArvind Sankar return printed; 1732c7d1e30SArvind Sankar } 1742c7d1e30SArvind Sankar 1758c0a839cSHeinrich Schuchardt /** 1768c0a839cSHeinrich Schuchardt * efi_parse_options() - Parse EFI command line options 1778c0a839cSHeinrich Schuchardt * @cmdline: kernel command line 1788c0a839cSHeinrich Schuchardt * 1798c0a839cSHeinrich Schuchardt * Parse the ASCII string @cmdline for EFI options, denoted by the efi= 1805a17dae4SMatt Fleming * option, e.g. efi=nochunk. 1815a17dae4SMatt Fleming * 1825a17dae4SMatt Fleming * It should be noted that efi= is parsed in two very different 1835a17dae4SMatt Fleming * environments, first in the early boot environment of the EFI boot 1845a17dae4SMatt Fleming * stub, and subsequently during the kernel boot. 1858c0a839cSHeinrich Schuchardt * 1868c0a839cSHeinrich Schuchardt * Return: status code 1875a17dae4SMatt Fleming */ 18860f38de7SArd Biesheuvel efi_status_t efi_parse_options(char const *cmdline) 1895a17dae4SMatt Fleming { 190a37ca6a2SArvind Sankar size_t len; 19191d150c0SArd Biesheuvel efi_status_t status; 19291d150c0SArd Biesheuvel char *str, *buf; 1935a17dae4SMatt Fleming 194a37ca6a2SArvind Sankar if (!cmdline) 195a37ca6a2SArvind Sankar return EFI_SUCCESS; 196a37ca6a2SArvind Sankar 1978a8a3237SArvind Sankar len = strnlen(cmdline, COMMAND_LINE_SIZE - 1) + 1; 19891d150c0SArd Biesheuvel status = efi_bs_call(allocate_pool, EFI_LOADER_DATA, len, (void **)&buf); 19991d150c0SArd Biesheuvel if (status != EFI_SUCCESS) 20091d150c0SArd Biesheuvel return status; 20191d150c0SArd Biesheuvel 2028a8a3237SArvind Sankar memcpy(buf, cmdline, len - 1); 2038a8a3237SArvind Sankar buf[len - 1] = '\0'; 2048a8a3237SArvind Sankar str = skip_spaces(buf); 20591d150c0SArd Biesheuvel 20691d150c0SArd Biesheuvel while (*str) { 20791d150c0SArd Biesheuvel char *param, *val; 20891d150c0SArd Biesheuvel 20991d150c0SArd Biesheuvel str = next_arg(str, ¶m, &val); 2101fd9717dSArvind Sankar if (!val && !strcmp(param, "--")) 2111fd9717dSArvind Sankar break; 21291d150c0SArd Biesheuvel 21391d150c0SArd Biesheuvel if (!strcmp(param, "nokaslr")) { 2147d4e323dSArd Biesheuvel efi_nokaslr = true; 21591d150c0SArd Biesheuvel } else if (!strcmp(param, "quiet")) { 21623d5b73fSArvind Sankar efi_loglevel = CONSOLE_LOGLEVEL_QUIET; 21779d3219dSArd Biesheuvel } else if (!strcmp(param, "noinitrd")) { 21879d3219dSArd Biesheuvel efi_noinitrd = true; 21991d150c0SArd Biesheuvel } else if (!strcmp(param, "efi") && val) { 22091d150c0SArd Biesheuvel efi_nochunk = parse_option_str(val, "nochunk"); 22191d150c0SArd Biesheuvel efi_novamap = parse_option_str(val, "novamap"); 222eeff7d63SArd Biesheuvel 22391d150c0SArd Biesheuvel efi_nosoftreserve = IS_ENABLED(CONFIG_EFI_SOFT_RESERVE) && 22491d150c0SArd Biesheuvel parse_option_str(val, "nosoftreserve"); 2255a17dae4SMatt Fleming 22691d150c0SArd Biesheuvel if (parse_option_str(val, "disable_early_pci_dma")) 2274444f854SMatthew Garrett efi_disable_pci_dma = true; 22891d150c0SArd Biesheuvel if (parse_option_str(val, "no_disable_early_pci_dma")) 2294444f854SMatthew Garrett efi_disable_pci_dma = false; 23023d5b73fSArvind Sankar if (parse_option_str(val, "debug")) 23123d5b73fSArvind Sankar efi_loglevel = CONSOLE_LOGLEVEL_DEBUG; 232fffb6804SArvind Sankar } else if (!strcmp(param, "video") && 233fffb6804SArvind Sankar val && strstarts(val, "efifb:")) { 234fffb6804SArvind Sankar efi_parse_option_graphics(val + strlen("efifb:")); 2354444f854SMatthew Garrett } 2365a17dae4SMatt Fleming } 23791d150c0SArd Biesheuvel efi_bs_call(free_pool, buf); 2385a17dae4SMatt Fleming return EFI_SUCCESS; 2395a17dae4SMatt Fleming } 240f4f75ad5SArd Biesheuvel 241f4f75ad5SArd Biesheuvel /* 2424a568ce2SArvind Sankar * The EFI_LOAD_OPTION descriptor has the following layout: 2434a568ce2SArvind Sankar * u32 Attributes; 2444a568ce2SArvind Sankar * u16 FilePathListLength; 2454a568ce2SArvind Sankar * u16 Description[]; 2464a568ce2SArvind Sankar * efi_device_path_protocol_t FilePathList[]; 2474a568ce2SArvind Sankar * u8 OptionalData[]; 2484a568ce2SArvind Sankar * 2494a568ce2SArvind Sankar * This function validates and unpacks the variable-size data fields. 2504a568ce2SArvind Sankar */ 2514a568ce2SArvind Sankar static 2524a568ce2SArvind Sankar bool efi_load_option_unpack(efi_load_option_unpacked_t *dest, 2534a568ce2SArvind Sankar const efi_load_option_t *src, size_t size) 2544a568ce2SArvind Sankar { 2554a568ce2SArvind Sankar const void *pos; 2564a568ce2SArvind Sankar u16 c; 2574a568ce2SArvind Sankar efi_device_path_protocol_t header; 2584a568ce2SArvind Sankar const efi_char16_t *description; 2594a568ce2SArvind Sankar const efi_device_path_protocol_t *file_path_list; 2604a568ce2SArvind Sankar 2614a568ce2SArvind Sankar if (size < offsetof(efi_load_option_t, variable_data)) 2624a568ce2SArvind Sankar return false; 2634a568ce2SArvind Sankar pos = src->variable_data; 2644a568ce2SArvind Sankar size -= offsetof(efi_load_option_t, variable_data); 2654a568ce2SArvind Sankar 2664a568ce2SArvind Sankar if ((src->attributes & ~EFI_LOAD_OPTION_MASK) != 0) 2674a568ce2SArvind Sankar return false; 2684a568ce2SArvind Sankar 2694a568ce2SArvind Sankar /* Scan description. */ 2704a568ce2SArvind Sankar description = pos; 2714a568ce2SArvind Sankar do { 2724a568ce2SArvind Sankar if (size < sizeof(c)) 2734a568ce2SArvind Sankar return false; 2744a568ce2SArvind Sankar c = *(const u16 *)pos; 2754a568ce2SArvind Sankar pos += sizeof(c); 2764a568ce2SArvind Sankar size -= sizeof(c); 2774a568ce2SArvind Sankar } while (c != L'\0'); 2784a568ce2SArvind Sankar 2794a568ce2SArvind Sankar /* Scan file_path_list. */ 2804a568ce2SArvind Sankar file_path_list = pos; 2814a568ce2SArvind Sankar do { 2824a568ce2SArvind Sankar if (size < sizeof(header)) 2834a568ce2SArvind Sankar return false; 2844a568ce2SArvind Sankar header = *(const efi_device_path_protocol_t *)pos; 2854a568ce2SArvind Sankar if (header.length < sizeof(header)) 2864a568ce2SArvind Sankar return false; 2874a568ce2SArvind Sankar if (size < header.length) 2884a568ce2SArvind Sankar return false; 2894a568ce2SArvind Sankar pos += header.length; 2904a568ce2SArvind Sankar size -= header.length; 2914a568ce2SArvind Sankar } while ((header.type != EFI_DEV_END_PATH && header.type != EFI_DEV_END_PATH2) || 2924a568ce2SArvind Sankar (header.sub_type != EFI_DEV_END_ENTIRE)); 2934a568ce2SArvind Sankar if (pos != (const void *)file_path_list + src->file_path_list_length) 2944a568ce2SArvind Sankar return false; 2954a568ce2SArvind Sankar 2964a568ce2SArvind Sankar dest->attributes = src->attributes; 2974a568ce2SArvind Sankar dest->file_path_list_length = src->file_path_list_length; 2984a568ce2SArvind Sankar dest->description = description; 2994a568ce2SArvind Sankar dest->file_path_list = file_path_list; 3004a568ce2SArvind Sankar dest->optional_data_size = size; 3014a568ce2SArvind Sankar dest->optional_data = size ? pos : NULL; 3024a568ce2SArvind Sankar 3034a568ce2SArvind Sankar return true; 3044a568ce2SArvind Sankar } 3054a568ce2SArvind Sankar 3064a568ce2SArvind Sankar /* 3074a568ce2SArvind Sankar * At least some versions of Dell firmware pass the entire contents of the 3084a568ce2SArvind Sankar * Boot#### variable, i.e. the EFI_LOAD_OPTION descriptor, rather than just the 3094a568ce2SArvind Sankar * OptionalData field. 3104a568ce2SArvind Sankar * 3114a568ce2SArvind Sankar * Detect this case and extract OptionalData. 3124a568ce2SArvind Sankar */ 313*a241d94bSArd Biesheuvel void efi_apply_loadoptions_quirk(const void **load_options, u32 *load_options_size) 3144a568ce2SArvind Sankar { 3154a568ce2SArvind Sankar const efi_load_option_t *load_option = *load_options; 3164a568ce2SArvind Sankar efi_load_option_unpacked_t load_option_unpacked; 3174a568ce2SArvind Sankar 3184a568ce2SArvind Sankar if (!IS_ENABLED(CONFIG_X86)) 3194a568ce2SArvind Sankar return; 3204a568ce2SArvind Sankar if (!load_option) 3214a568ce2SArvind Sankar return; 3224a568ce2SArvind Sankar if (*load_options_size < sizeof(*load_option)) 3234a568ce2SArvind Sankar return; 3244a568ce2SArvind Sankar if ((load_option->attributes & ~EFI_LOAD_OPTION_BOOT_MASK) != 0) 3254a568ce2SArvind Sankar return; 3264a568ce2SArvind Sankar 3274a568ce2SArvind Sankar if (!efi_load_option_unpack(&load_option_unpacked, load_option, *load_options_size)) 3284a568ce2SArvind Sankar return; 3294a568ce2SArvind Sankar 3304a568ce2SArvind Sankar efi_warn_once(FW_BUG "LoadOptions is an EFI_LOAD_OPTION descriptor\n"); 3314a568ce2SArvind Sankar efi_warn_once(FW_BUG "Using OptionalData as a workaround\n"); 3324a568ce2SArvind Sankar 3334a568ce2SArvind Sankar *load_options = load_option_unpacked.optional_data; 3344a568ce2SArvind Sankar *load_options_size = load_option_unpacked.optional_data_size; 3354a568ce2SArvind Sankar } 3364a568ce2SArvind Sankar 3374a568ce2SArvind Sankar /* 338f4f75ad5SArd Biesheuvel * Convert the unicode UEFI command line to ASCII to pass to kernel. 339f4f75ad5SArd Biesheuvel * Size of memory allocated return in *cmd_line_len. 340f4f75ad5SArd Biesheuvel * Returns NULL on error. 341f4f75ad5SArd Biesheuvel */ 34227cd5511SArd Biesheuvel char *efi_convert_cmdline(efi_loaded_image_t *image, int *cmd_line_len) 343f4f75ad5SArd Biesheuvel { 344*a241d94bSArd Biesheuvel const efi_char16_t *options = efi_table_attr(image, load_options); 345*a241d94bSArd Biesheuvel u32 options_size = efi_table_attr(image, load_options_size); 34680b1bfe1SArvind Sankar int options_bytes = 0, safe_options_bytes = 0; /* UTF-8 bytes */ 347*a241d94bSArd Biesheuvel unsigned long cmdline_addr = 0; 348*a241d94bSArd Biesheuvel const efi_char16_t *s2; 34980b1bfe1SArvind Sankar bool in_quote = false; 350f4f75ad5SArd Biesheuvel efi_status_t status; 351*a241d94bSArd Biesheuvel u32 options_chars; 352f4f75ad5SArd Biesheuvel 353*a241d94bSArd Biesheuvel efi_apply_loadoptions_quirk((const void **)&options, &options_size); 354*a241d94bSArd Biesheuvel options_chars = options_size / sizeof(efi_char16_t); 3554a568ce2SArvind Sankar 356f4f75ad5SArd Biesheuvel if (options) { 357f4f75ad5SArd Biesheuvel s2 = options; 35880b1bfe1SArvind Sankar while (options_bytes < COMMAND_LINE_SIZE && options_chars--) { 359*a241d94bSArd Biesheuvel efi_char16_t c = *s2++; 36015c316bcSArvind Sankar 36180b1bfe1SArvind Sankar if (c < 0x80) { 36215c316bcSArvind Sankar if (c == L'\0' || c == L'\n') 36315c316bcSArvind Sankar break; 36480b1bfe1SArvind Sankar if (c == L'"') 36580b1bfe1SArvind Sankar in_quote = !in_quote; 36680b1bfe1SArvind Sankar else if (!in_quote && isspace((char)c)) 36780b1bfe1SArvind Sankar safe_options_bytes = options_bytes; 36880b1bfe1SArvind Sankar 36980b1bfe1SArvind Sankar options_bytes++; 37080b1bfe1SArvind Sankar continue; 37180b1bfe1SArvind Sankar } 37280b1bfe1SArvind Sankar 37315c316bcSArvind Sankar /* 37415c316bcSArvind Sankar * Get the number of UTF-8 bytes corresponding to a 37515c316bcSArvind Sankar * UTF-16 character. 37615c316bcSArvind Sankar * The first part handles everything in the BMP. 37715c316bcSArvind Sankar */ 37880b1bfe1SArvind Sankar options_bytes += 2 + (c >= 0x800); 37915c316bcSArvind Sankar /* 38015c316bcSArvind Sankar * Add one more byte for valid surrogate pairs. Invalid 38115c316bcSArvind Sankar * surrogates will be replaced with 0xfffd and take up 38215c316bcSArvind Sankar * only 3 bytes. 38315c316bcSArvind Sankar */ 38415c316bcSArvind Sankar if ((c & 0xfc00) == 0xd800) { 38515c316bcSArvind Sankar /* 38615c316bcSArvind Sankar * If the very last word is a high surrogate, 38715c316bcSArvind Sankar * we must ignore it since we can't access the 38815c316bcSArvind Sankar * low surrogate. 38915c316bcSArvind Sankar */ 39004b24409SArvind Sankar if (!options_chars) { 39115c316bcSArvind Sankar options_bytes -= 3; 39215c316bcSArvind Sankar } else if ((*s2 & 0xfc00) == 0xdc00) { 39315c316bcSArvind Sankar options_bytes++; 39404b24409SArvind Sankar options_chars--; 39515c316bcSArvind Sankar s2++; 39615c316bcSArvind Sankar } 39715c316bcSArvind Sankar } 398f4f75ad5SArd Biesheuvel } 39980b1bfe1SArvind Sankar if (options_bytes >= COMMAND_LINE_SIZE) { 40080b1bfe1SArvind Sankar options_bytes = safe_options_bytes; 40180b1bfe1SArvind Sankar efi_err("Command line is too long: truncated to %d bytes\n", 40280b1bfe1SArvind Sankar options_bytes); 40380b1bfe1SArvind Sankar } 404f4f75ad5SArd Biesheuvel } 405f4f75ad5SArd Biesheuvel 406f4f75ad5SArd Biesheuvel options_bytes++; /* NUL termination */ 407f4f75ad5SArd Biesheuvel 40827cd5511SArd Biesheuvel status = efi_bs_call(allocate_pool, EFI_LOADER_DATA, options_bytes, 40927cd5511SArd Biesheuvel (void **)&cmdline_addr); 410f4f75ad5SArd Biesheuvel if (status != EFI_SUCCESS) 411f4f75ad5SArd Biesheuvel return NULL; 412f4f75ad5SArd Biesheuvel 41304b24409SArvind Sankar snprintf((char *)cmdline_addr, options_bytes, "%.*ls", 41404b24409SArvind Sankar options_bytes - 1, options); 415f4f75ad5SArd Biesheuvel 416f4f75ad5SArd Biesheuvel *cmd_line_len = options_bytes; 417f4f75ad5SArd Biesheuvel return (char *)cmdline_addr; 418f4f75ad5SArd Biesheuvel } 419fc07716bSJeffrey Hugo 4208c0a839cSHeinrich Schuchardt /** 4218c0a839cSHeinrich Schuchardt * efi_exit_boot_services() - Exit boot services 4228c0a839cSHeinrich Schuchardt * @handle: handle of the exiting image 4238c0a839cSHeinrich Schuchardt * @map: pointer to receive the memory map 4248c0a839cSHeinrich Schuchardt * @priv: argument to be passed to @priv_func 4258c0a839cSHeinrich Schuchardt * @priv_func: function to process the memory map before exiting boot services 4268c0a839cSHeinrich Schuchardt * 427fc07716bSJeffrey Hugo * Handle calling ExitBootServices according to the requirements set out by the 428fc07716bSJeffrey Hugo * spec. Obtains the current memory map, and returns that info after calling 429fc07716bSJeffrey Hugo * ExitBootServices. The client must specify a function to perform any 430fc07716bSJeffrey Hugo * processing of the memory map data prior to ExitBootServices. A client 431fc07716bSJeffrey Hugo * specific structure may be passed to the function via priv. The client 432fc07716bSJeffrey Hugo * function may be called multiple times. 4338c0a839cSHeinrich Schuchardt * 4348c0a839cSHeinrich Schuchardt * Return: status code 435fc07716bSJeffrey Hugo */ 436cd33a5c1SArd Biesheuvel efi_status_t efi_exit_boot_services(void *handle, 437fc07716bSJeffrey Hugo struct efi_boot_memmap *map, 438fc07716bSJeffrey Hugo void *priv, 439fc07716bSJeffrey Hugo efi_exit_boot_map_processing priv_func) 440fc07716bSJeffrey Hugo { 441fc07716bSJeffrey Hugo efi_status_t status; 442fc07716bSJeffrey Hugo 443cd33a5c1SArd Biesheuvel status = efi_get_memory_map(map); 444fc07716bSJeffrey Hugo 445fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 446fc07716bSJeffrey Hugo goto fail; 447fc07716bSJeffrey Hugo 448cd33a5c1SArd Biesheuvel status = priv_func(map, priv); 449fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 450fc07716bSJeffrey Hugo goto free_map; 451fc07716bSJeffrey Hugo 4524444f854SMatthew Garrett if (efi_disable_pci_dma) 4534444f854SMatthew Garrett efi_pci_disable_bridge_busmaster(); 4544444f854SMatthew Garrett 455966291f6SArd Biesheuvel status = efi_bs_call(exit_boot_services, handle, *map->key_ptr); 456fc07716bSJeffrey Hugo 457fc07716bSJeffrey Hugo if (status == EFI_INVALID_PARAMETER) { 458fc07716bSJeffrey Hugo /* 459fc07716bSJeffrey Hugo * The memory map changed between efi_get_memory_map() and 460fc07716bSJeffrey Hugo * exit_boot_services(). Per the UEFI Spec v2.6, Section 6.4: 461fc07716bSJeffrey Hugo * EFI_BOOT_SERVICES.ExitBootServices we need to get the 462fc07716bSJeffrey Hugo * updated map, and try again. The spec implies one retry 463fc07716bSJeffrey Hugo * should be sufficent, which is confirmed against the EDK2 464fc07716bSJeffrey Hugo * implementation. Per the spec, we can only invoke 465fc07716bSJeffrey Hugo * get_memory_map() and exit_boot_services() - we cannot alloc 466fc07716bSJeffrey Hugo * so efi_get_memory_map() cannot be used, and we must reuse 467fc07716bSJeffrey Hugo * the buffer. For all practical purposes, the headroom in the 468fc07716bSJeffrey Hugo * buffer should account for any changes in the map so the call 469fc07716bSJeffrey Hugo * to get_memory_map() is expected to succeed here. 470fc07716bSJeffrey Hugo */ 471fc07716bSJeffrey Hugo *map->map_size = *map->buff_size; 472966291f6SArd Biesheuvel status = efi_bs_call(get_memory_map, 473fc07716bSJeffrey Hugo map->map_size, 474fc07716bSJeffrey Hugo *map->map, 475fc07716bSJeffrey Hugo map->key_ptr, 476fc07716bSJeffrey Hugo map->desc_size, 477fc07716bSJeffrey Hugo map->desc_ver); 478fc07716bSJeffrey Hugo 479fc07716bSJeffrey Hugo /* exit_boot_services() was called, thus cannot free */ 480fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 481fc07716bSJeffrey Hugo goto fail; 482fc07716bSJeffrey Hugo 483cd33a5c1SArd Biesheuvel status = priv_func(map, priv); 484fc07716bSJeffrey Hugo /* exit_boot_services() was called, thus cannot free */ 485fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 486fc07716bSJeffrey Hugo goto fail; 487fc07716bSJeffrey Hugo 488966291f6SArd Biesheuvel status = efi_bs_call(exit_boot_services, handle, *map->key_ptr); 489fc07716bSJeffrey Hugo } 490fc07716bSJeffrey Hugo 491fc07716bSJeffrey Hugo /* exit_boot_services() was called, thus cannot free */ 492fc07716bSJeffrey Hugo if (status != EFI_SUCCESS) 493fc07716bSJeffrey Hugo goto fail; 494fc07716bSJeffrey Hugo 495fc07716bSJeffrey Hugo return EFI_SUCCESS; 496fc07716bSJeffrey Hugo 497fc07716bSJeffrey Hugo free_map: 498966291f6SArd Biesheuvel efi_bs_call(free_pool, *map->map); 499fc07716bSJeffrey Hugo fail: 500fc07716bSJeffrey Hugo return status; 501fc07716bSJeffrey Hugo } 50282d736acSMatthew Garrett 5038c0a839cSHeinrich Schuchardt /** 5048c0a839cSHeinrich Schuchardt * get_efi_config_table() - retrieve UEFI configuration table 5058c0a839cSHeinrich Schuchardt * @guid: GUID of the configuration table to be retrieved 5068c0a839cSHeinrich Schuchardt * Return: pointer to the configuration table or NULL 5078c0a839cSHeinrich Schuchardt */ 508cd33a5c1SArd Biesheuvel void *get_efi_config_table(efi_guid_t guid) 50982d736acSMatthew Garrett { 510ccc27ae7SArd Biesheuvel unsigned long tables = efi_table_attr(efi_system_table, tables); 511ccc27ae7SArd Biesheuvel int nr_tables = efi_table_attr(efi_system_table, nr_tables); 512f958efe9SArd Biesheuvel int i; 513f958efe9SArd Biesheuvel 514f958efe9SArd Biesheuvel for (i = 0; i < nr_tables; i++) { 515f958efe9SArd Biesheuvel efi_config_table_t *t = (void *)tables; 516f958efe9SArd Biesheuvel 517f958efe9SArd Biesheuvel if (efi_guidcmp(t->guid, guid) == 0) 51899ea8b1dSArd Biesheuvel return efi_table_attr(t, table); 519f958efe9SArd Biesheuvel 520f958efe9SArd Biesheuvel tables += efi_is_native() ? sizeof(efi_config_table_t) 521f958efe9SArd Biesheuvel : sizeof(efi_config_table_32_t); 522f958efe9SArd Biesheuvel } 523f958efe9SArd Biesheuvel return NULL; 52482d736acSMatthew Garrett } 525dc29da14SArd Biesheuvel 526ec93fc37SArd Biesheuvel /* 527ec93fc37SArd Biesheuvel * The LINUX_EFI_INITRD_MEDIA_GUID vendor media device path below provides a way 528ec93fc37SArd Biesheuvel * for the firmware or bootloader to expose the initrd data directly to the stub 529ec93fc37SArd Biesheuvel * via the trivial LoadFile2 protocol, which is defined in the UEFI spec, and is 530ec93fc37SArd Biesheuvel * very easy to implement. It is a simple Linux initrd specific conduit between 531ec93fc37SArd Biesheuvel * kernel and firmware, allowing us to put the EFI stub (being part of the 532ec93fc37SArd Biesheuvel * kernel) in charge of where and when to load the initrd, while leaving it up 533ec93fc37SArd Biesheuvel * to the firmware to decide whether it needs to expose its filesystem hierarchy 534ec93fc37SArd Biesheuvel * via EFI protocols. 535ec93fc37SArd Biesheuvel */ 536ec93fc37SArd Biesheuvel static const struct { 537ec93fc37SArd Biesheuvel struct efi_vendor_dev_path vendor; 538ec93fc37SArd Biesheuvel struct efi_generic_dev_path end; 539ec93fc37SArd Biesheuvel } __packed initrd_dev_path = { 540ec93fc37SArd Biesheuvel { 541ec93fc37SArd Biesheuvel { 542ec93fc37SArd Biesheuvel EFI_DEV_MEDIA, 543ec93fc37SArd Biesheuvel EFI_DEV_MEDIA_VENDOR, 544ec93fc37SArd Biesheuvel sizeof(struct efi_vendor_dev_path), 545ec93fc37SArd Biesheuvel }, 546ec93fc37SArd Biesheuvel LINUX_EFI_INITRD_MEDIA_GUID 547ec93fc37SArd Biesheuvel }, { 548ec93fc37SArd Biesheuvel EFI_DEV_END_PATH, 549ec93fc37SArd Biesheuvel EFI_DEV_END_ENTIRE, 550ec93fc37SArd Biesheuvel sizeof(struct efi_generic_dev_path) 551ec93fc37SArd Biesheuvel } 552ec93fc37SArd Biesheuvel }; 553ec93fc37SArd Biesheuvel 554ec93fc37SArd Biesheuvel /** 5558c0a839cSHeinrich Schuchardt * efi_load_initrd_dev_path() - load the initrd from the Linux initrd device path 556ec93fc37SArd Biesheuvel * @load_addr: pointer to store the address where the initrd was loaded 557ec93fc37SArd Biesheuvel * @load_size: pointer to store the size of the loaded initrd 558ec93fc37SArd Biesheuvel * @max: upper limit for the initrd memory allocation 5598c0a839cSHeinrich Schuchardt * 5608c0a839cSHeinrich Schuchardt * Return: 5618c0a839cSHeinrich Schuchardt * * %EFI_SUCCESS if the initrd was loaded successfully, in which 562ec93fc37SArd Biesheuvel * case @load_addr and @load_size are assigned accordingly 5638c0a839cSHeinrich Schuchardt * * %EFI_NOT_FOUND if no LoadFile2 protocol exists on the initrd device path 5648c0a839cSHeinrich Schuchardt * * %EFI_INVALID_PARAMETER if load_addr == NULL or load_size == NULL 5658c0a839cSHeinrich Schuchardt * * %EFI_OUT_OF_RESOURCES if memory allocation failed 5668c0a839cSHeinrich Schuchardt * * %EFI_LOAD_ERROR in all other cases 567ec93fc37SArd Biesheuvel */ 568f61900fdSArvind Sankar static 569ec93fc37SArd Biesheuvel efi_status_t efi_load_initrd_dev_path(unsigned long *load_addr, 570ec93fc37SArd Biesheuvel unsigned long *load_size, 571ec93fc37SArd Biesheuvel unsigned long max) 572ec93fc37SArd Biesheuvel { 573ec93fc37SArd Biesheuvel efi_guid_t lf2_proto_guid = EFI_LOAD_FILE2_PROTOCOL_GUID; 574ec93fc37SArd Biesheuvel efi_device_path_protocol_t *dp; 575ec93fc37SArd Biesheuvel efi_load_file2_protocol_t *lf2; 576ec93fc37SArd Biesheuvel unsigned long initrd_addr; 577ec93fc37SArd Biesheuvel unsigned long initrd_size; 578ec93fc37SArd Biesheuvel efi_handle_t handle; 579ec93fc37SArd Biesheuvel efi_status_t status; 580ec93fc37SArd Biesheuvel 581ec93fc37SArd Biesheuvel dp = (efi_device_path_protocol_t *)&initrd_dev_path; 582ec93fc37SArd Biesheuvel status = efi_bs_call(locate_device_path, &lf2_proto_guid, &dp, &handle); 583ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) 584ec93fc37SArd Biesheuvel return status; 585ec93fc37SArd Biesheuvel 586ec93fc37SArd Biesheuvel status = efi_bs_call(handle_protocol, handle, &lf2_proto_guid, 587ec93fc37SArd Biesheuvel (void **)&lf2); 588ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) 589ec93fc37SArd Biesheuvel return status; 590ec93fc37SArd Biesheuvel 591ec93fc37SArd Biesheuvel status = efi_call_proto(lf2, load_file, dp, false, &initrd_size, NULL); 592ec93fc37SArd Biesheuvel if (status != EFI_BUFFER_TOO_SMALL) 593ec93fc37SArd Biesheuvel return EFI_LOAD_ERROR; 594ec93fc37SArd Biesheuvel 595ec93fc37SArd Biesheuvel status = efi_allocate_pages(initrd_size, &initrd_addr, max); 596ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) 597ec93fc37SArd Biesheuvel return status; 598ec93fc37SArd Biesheuvel 599ec93fc37SArd Biesheuvel status = efi_call_proto(lf2, load_file, dp, false, &initrd_size, 600ec93fc37SArd Biesheuvel (void *)initrd_addr); 601ec93fc37SArd Biesheuvel if (status != EFI_SUCCESS) { 602ec93fc37SArd Biesheuvel efi_free(initrd_size, initrd_addr); 603ec93fc37SArd Biesheuvel return EFI_LOAD_ERROR; 604ec93fc37SArd Biesheuvel } 605ec93fc37SArd Biesheuvel 606ec93fc37SArd Biesheuvel *load_addr = initrd_addr; 607ec93fc37SArd Biesheuvel *load_size = initrd_size; 608ec93fc37SArd Biesheuvel return EFI_SUCCESS; 609ec93fc37SArd Biesheuvel } 610f61900fdSArvind Sankar 611f61900fdSArvind Sankar static 612f61900fdSArvind Sankar efi_status_t efi_load_initrd_cmdline(efi_loaded_image_t *image, 613f61900fdSArvind Sankar unsigned long *load_addr, 614f61900fdSArvind Sankar unsigned long *load_size, 615f61900fdSArvind Sankar unsigned long soft_limit, 616f61900fdSArvind Sankar unsigned long hard_limit) 617f61900fdSArvind Sankar { 618f61900fdSArvind Sankar if (!IS_ENABLED(CONFIG_EFI_GENERIC_STUB_INITRD_CMDLINE_LOADER) || 619f61900fdSArvind Sankar (IS_ENABLED(CONFIG_X86) && (!efi_is_native() || image == NULL))) { 620f61900fdSArvind Sankar *load_addr = *load_size = 0; 621f61900fdSArvind Sankar return EFI_SUCCESS; 622f61900fdSArvind Sankar } 623f61900fdSArvind Sankar 624f61900fdSArvind Sankar return handle_cmdline_files(image, L"initrd=", sizeof(L"initrd=") - 2, 625f61900fdSArvind Sankar soft_limit, hard_limit, 626f61900fdSArvind Sankar load_addr, load_size); 627f61900fdSArvind Sankar } 628f61900fdSArvind Sankar 629f046fff8SIlias Apalodimas static const struct { 630f046fff8SIlias Apalodimas efi_tcg2_event_t event_data; 631f046fff8SIlias Apalodimas efi_tcg2_tagged_event_t tagged_event; 632f046fff8SIlias Apalodimas u8 tagged_event_data[]; 633f046fff8SIlias Apalodimas } initrd_tcg2_event = { 634f046fff8SIlias Apalodimas { 635f046fff8SIlias Apalodimas sizeof(initrd_tcg2_event) + sizeof("Linux initrd"), 636f046fff8SIlias Apalodimas { 637f046fff8SIlias Apalodimas sizeof(initrd_tcg2_event.event_data.event_header), 638f046fff8SIlias Apalodimas EFI_TCG2_EVENT_HEADER_VERSION, 639f046fff8SIlias Apalodimas 9, 640f046fff8SIlias Apalodimas EV_EVENT_TAG, 641f046fff8SIlias Apalodimas }, 642f046fff8SIlias Apalodimas }, 643f046fff8SIlias Apalodimas { 644f046fff8SIlias Apalodimas INITRD_EVENT_TAG_ID, 645f046fff8SIlias Apalodimas sizeof("Linux initrd"), 646f046fff8SIlias Apalodimas }, 647f046fff8SIlias Apalodimas { "Linux initrd" }, 648f046fff8SIlias Apalodimas }; 649f046fff8SIlias Apalodimas 650f046fff8SIlias Apalodimas static void efi_measure_initrd(unsigned long load_addr, unsigned long load_size) 651f046fff8SIlias Apalodimas { 652f046fff8SIlias Apalodimas efi_guid_t tcg2_guid = EFI_TCG2_PROTOCOL_GUID; 653f046fff8SIlias Apalodimas efi_tcg2_protocol_t *tcg2 = NULL; 654f046fff8SIlias Apalodimas efi_status_t status; 655f046fff8SIlias Apalodimas 656f046fff8SIlias Apalodimas efi_bs_call(locate_protocol, &tcg2_guid, NULL, (void **)&tcg2); 657f046fff8SIlias Apalodimas if (tcg2) { 658f046fff8SIlias Apalodimas status = efi_call_proto(tcg2, hash_log_extend_event, 659f046fff8SIlias Apalodimas 0, load_addr, load_size, 660f046fff8SIlias Apalodimas &initrd_tcg2_event.event_data); 661f046fff8SIlias Apalodimas if (status != EFI_SUCCESS) 662f046fff8SIlias Apalodimas efi_warn("Failed to measure initrd data: 0x%lx\n", 663f046fff8SIlias Apalodimas status); 664f046fff8SIlias Apalodimas else 665f046fff8SIlias Apalodimas efi_info("Measured initrd data into PCR %d\n", 666f046fff8SIlias Apalodimas initrd_tcg2_event.event_data.event_header.pcr_index); 667f046fff8SIlias Apalodimas } 668f046fff8SIlias Apalodimas } 669f046fff8SIlias Apalodimas 6708c0a839cSHeinrich Schuchardt /** 6718c0a839cSHeinrich Schuchardt * efi_load_initrd() - Load initial RAM disk 6728c0a839cSHeinrich Schuchardt * @image: EFI loaded image protocol 6738c0a839cSHeinrich Schuchardt * @load_addr: pointer to loaded initrd 6748c0a839cSHeinrich Schuchardt * @load_size: size of loaded initrd 675947228cbSAtish Patra * @soft_limit: preferred address for loading the initrd 676947228cbSAtish Patra * @hard_limit: upper limit address for loading the initrd 6778c0a839cSHeinrich Schuchardt * 6788c0a839cSHeinrich Schuchardt * Return: status code 6798c0a839cSHeinrich Schuchardt */ 680f61900fdSArvind Sankar efi_status_t efi_load_initrd(efi_loaded_image_t *image, 681f61900fdSArvind Sankar unsigned long *load_addr, 682f61900fdSArvind Sankar unsigned long *load_size, 683f61900fdSArvind Sankar unsigned long soft_limit, 684f61900fdSArvind Sankar unsigned long hard_limit) 685f61900fdSArvind Sankar { 686f61900fdSArvind Sankar efi_status_t status; 687f61900fdSArvind Sankar 68820287d56SArd Biesheuvel if (efi_noinitrd) { 68920287d56SArd Biesheuvel *load_addr = *load_size = 0; 690f046fff8SIlias Apalodimas status = EFI_SUCCESS; 691f046fff8SIlias Apalodimas } else { 692f61900fdSArvind Sankar status = efi_load_initrd_dev_path(load_addr, load_size, hard_limit); 693f61900fdSArvind Sankar if (status == EFI_SUCCESS) { 694f61900fdSArvind Sankar efi_info("Loaded initrd from LINUX_EFI_INITRD_MEDIA_GUID device path\n"); 695f046fff8SIlias Apalodimas if (*load_size > 0) 696f046fff8SIlias Apalodimas efi_measure_initrd(*load_addr, *load_size); 697f61900fdSArvind Sankar } else if (status == EFI_NOT_FOUND) { 698f61900fdSArvind Sankar status = efi_load_initrd_cmdline(image, load_addr, load_size, 699f61900fdSArvind Sankar soft_limit, hard_limit); 700f61900fdSArvind Sankar if (status == EFI_SUCCESS && *load_size > 0) 701f61900fdSArvind Sankar efi_info("Loaded initrd from command line option\n"); 702f61900fdSArvind Sankar } 70320287d56SArd Biesheuvel if (status != EFI_SUCCESS) { 70420287d56SArd Biesheuvel efi_err("Failed to load initrd: 0x%lx\n", status); 70520287d56SArd Biesheuvel *load_addr = *load_size = 0; 70620287d56SArd Biesheuvel } 707f046fff8SIlias Apalodimas } 708f046fff8SIlias Apalodimas 709f61900fdSArvind Sankar return status; 710f61900fdSArvind Sankar } 71114c574f3SArvind Sankar 7128c0a839cSHeinrich Schuchardt /** 7138c0a839cSHeinrich Schuchardt * efi_wait_for_key() - Wait for key stroke 7148c0a839cSHeinrich Schuchardt * @usec: number of microseconds to wait for key stroke 7158c0a839cSHeinrich Schuchardt * @key: key entered 7168c0a839cSHeinrich Schuchardt * 7178c0a839cSHeinrich Schuchardt * Wait for up to @usec microseconds for a key stroke. 7188c0a839cSHeinrich Schuchardt * 7198c0a839cSHeinrich Schuchardt * Return: status code, EFI_SUCCESS if key received 7208c0a839cSHeinrich Schuchardt */ 72114c574f3SArvind Sankar efi_status_t efi_wait_for_key(unsigned long usec, efi_input_key_t *key) 72214c574f3SArvind Sankar { 72314c574f3SArvind Sankar efi_event_t events[2], timer; 72414c574f3SArvind Sankar unsigned long index; 72514c574f3SArvind Sankar efi_simple_text_input_protocol_t *con_in; 72614c574f3SArvind Sankar efi_status_t status; 72714c574f3SArvind Sankar 72814c574f3SArvind Sankar con_in = efi_table_attr(efi_system_table, con_in); 72914c574f3SArvind Sankar if (!con_in) 73014c574f3SArvind Sankar return EFI_UNSUPPORTED; 73114c574f3SArvind Sankar efi_set_event_at(events, 0, efi_table_attr(con_in, wait_for_key)); 73214c574f3SArvind Sankar 73314c574f3SArvind Sankar status = efi_bs_call(create_event, EFI_EVT_TIMER, 0, NULL, NULL, &timer); 73414c574f3SArvind Sankar if (status != EFI_SUCCESS) 73514c574f3SArvind Sankar return status; 73614c574f3SArvind Sankar 73714c574f3SArvind Sankar status = efi_bs_call(set_timer, timer, EfiTimerRelative, 73814c574f3SArvind Sankar EFI_100NSEC_PER_USEC * usec); 73914c574f3SArvind Sankar if (status != EFI_SUCCESS) 74014c574f3SArvind Sankar return status; 74114c574f3SArvind Sankar efi_set_event_at(events, 1, timer); 74214c574f3SArvind Sankar 74314c574f3SArvind Sankar status = efi_bs_call(wait_for_event, 2, events, &index); 74414c574f3SArvind Sankar if (status == EFI_SUCCESS) { 74514c574f3SArvind Sankar if (index == 0) 74614c574f3SArvind Sankar status = efi_call_proto(con_in, read_keystroke, key); 74714c574f3SArvind Sankar else 74814c574f3SArvind Sankar status = EFI_TIMEOUT; 74914c574f3SArvind Sankar } 75014c574f3SArvind Sankar 75114c574f3SArvind Sankar efi_bs_call(close_event, timer); 75214c574f3SArvind Sankar 75314c574f3SArvind Sankar return status; 75414c574f3SArvind Sankar } 755