Message ID | 20220902142349.16722-2-masahisa.kojima@linaro.org |
---|---|
State | Superseded |
Headers | show |
Series | enable menu-driven UEFI variable maintenance | expand |
On 9/2/22 16:23, Masahisa Kojima wrote: > This commit add the "eficonfig" command. > The "eficonfig" command implements the menu-driven UEFI boot option > maintenance feature. This commit implements the addition of > new boot option. User can select the block device volume having > efi_simple_file_system_protocol and select the file corresponding > to the Boot#### variable. User can also enter the description and > optional_data of the BOOT#### variable in utf8. > > This commit adds "include/efi_config.h", it contains the common > definition to be used from other menus such as UEFI Secure Boot > key management. > > Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org> > --- > Changes in v15: > - moves the free(entry->data) outside the eficonfig_destroy() function and > entry->data is freed explicitly only when needed > - expose eficonfig_destroy() for succeeding secure boot key management patch > > Changes in v14: > - fix the missing initialization > - add comment for key handling > > No change in v13: > > Changes in v12: > - add select/clear menu before displaying volume selectio > - move function declaration from efi_loader.h to efi_config.h > - remove unused declaration > - support the boot option does not have file path > - correctly handle if optional_data is empty > > Changes in v11: > - refactor menu entry construction, directly use eficonfig_entry structure > - remove reading directory info to calculate the number of entry > - fix invalid efi_free_pool() in ill_file_info() > - use ANSI_CURSOR_POSITION and ANSI_CLEAR_LINE instead of printf("\n") > since current eficonfig implementation does not handle console size correctly. > printf("\n") at the outside of console size breaks the console output. > > Changes in v10: > - add initrd file selection > - do refactoring > - eficonfig_process_common() use list structure > - remove u'/' before copying file_path into current_path > - fix typos > - check snprintf error > > Changes in v9: > - move "efi_guid_bootmenu_auto_generated definition" into efi_bootmgr.c > to address build error when CMD_EFICONFIG is disabled > - fix typos and comment > - remove file system information from error message > - remove unreachable code in eficonfig_choice_entry() > - single printf() call as much as possible > - call only getchar() in eficonfig_print_msg() > - filter out '.' entry from file selection > - update the efi_disk_get_device_name() implementation > - add function comment > > Changes in v8: > - command name is change from "efimenu" to "eficonfig" > - function and struct prefixes is changed to "eficonfig" > - fix menu header string > > Changes in v7: > - add "efimenu" command and uefi variable maintenance code > moved into cmd/efimenu.c > - create include/efimenu.h to define the common definition for > the other menu such as UEFI Secure Boot key management > - update boot option edit UI, user can select description, file, > and optional_data to edit in the same menu like following. > > ** Edit Boot Option ** > > Description: debian > File: virtio 0:1/EFI\debian\grubaa64.efi > Optional Data: test > Save > Quit > > - remove exit parameter from efimenu_process_common() > - menu title type is changed from u16 to char > - efimenu_process_common() add menu title string > - reduce printf/puts function call for displaying the menu > - efi_console_get_u16_string() accept 0 length to allow > optional_data is empty > - efi_console_get_u16_string() the "size" parameter name is changes to "count" > - efimenu is now designed to maintain the UEFI variables, remove autoboot related code > - remove one empty line before "Quit" entry > - efimenu_init() processes only the first time > > Changes in v6: > - fix typos > - modify volume name to match U-Boot syntax > - compile in CONFIG_EFI_LOADER=n and CONFIG_CMD_BOOTEFI_BOOTMGR=n > - simplify u16_strncmp() usage > - support "a\b.efi" file path, use link list to handle filepath > - modify length check condition > - UEFI related menu items only appears with CONFIG_AUTOBOOT_MENU_SHOW=y > > Changes in v5: > - remove forward declarations > - add const qualifier for menu items > - fix the possible unaligned access for directory info access > - split into three commit 1)add boot option 2) delete boot option 3)change boot order > This commit is 1)add boot option. > - fix file name buffer allocation size, it should be EFI_BOOTMENU_FILE_PATH_MAX * sizeof(u16) > - fix wrong size checking for file selection > > Chanes in v4: > - UEFI boot option maintenance menu is integrated into bootmenu > - display the simplified volume name(e.g. usb0:1, nvme1:2) for the > volume selection > - instead of extending lib/efi_loader/efi_bootmgr.c, newly create > lib/efi_loader/efi_bootmenu_maintenance.c and implement boot > variable maintenance into it. > > Changes in RFC v3: > not included in v3 series > > Changes in RFC v2: > - enable utf8 user input for boot option name > - create lib/efi_loader/efi_console.c::efi_console_get_u16_string() for > utf8 user input handling > - use u16_strlcat instead of u16_strcat > - remove the EFI_CALLs, and newly create or expose the following > xxx_int() functions. > efi_locate_handle_buffer_int(), efi_open_volume_int(), > efi_file_open_int(), efi_file_close_int(), efi_file_read_int() and > efi_file_setpos_int(). > Note that EFI_CALLs still exist for EFI_DEVICE_PATH_TO_TEXT_PROTOCOL > and EFI_SIMPLE_TEXT_INPUT/OUTPUT_PROTOCOL > - use efi_search_protocol() instead of calling locate_protocol() to get > the device_path_to_text_protocol interface. > - remove unnecessary puts(ANSI_CLEAR_LINE), this patch is still depends on > puts(ANSI_CLEAR_CONSOLE) > - skip SetVariable() if the bootorder is not changed > > cmd/Kconfig | 7 + > cmd/Makefile | 1 + > cmd/eficonfig.c | 1568 +++++++++++++++++++++++++++++++++ > include/efi_config.h | 96 ++ > include/efi_loader.h | 37 + > lib/efi_loader/efi_bootmgr.c | 3 + > lib/efi_loader/efi_boottime.c | 52 +- > lib/efi_loader/efi_console.c | 70 ++ > lib/efi_loader/efi_disk.c | 50 ++ > lib/efi_loader/efi_file.c | 75 +- > 10 files changed, 1912 insertions(+), 47 deletions(-) > create mode 100644 cmd/eficonfig.c > create mode 100644 include/efi_config.h > > diff --git a/cmd/Kconfig b/cmd/Kconfig > index 211ebe9c87..a1e8613c56 100644 > --- a/cmd/Kconfig > +++ b/cmd/Kconfig > @@ -1928,6 +1928,13 @@ config CMD_EFIDEBUG > particularly for managing boot parameters as well as examining > various EFI status for debugging. > > +config CMD_EFICONFIG > + bool "eficonfig - provide menu-driven uefi variables maintenance interface" > + depends on CMD_BOOTEFI_BOOTMGR > + help > + Enable the 'eficonfig' command which provides the menu-driven UEFI > + variable maintenance interface. > + > config CMD_EXCEPTION > bool "exception - raise exception" > depends on ARM || RISCV || SANDBOX || X86 > diff --git a/cmd/Makefile b/cmd/Makefile > index 6e87522b62..18f5cb890d 100644 > --- a/cmd/Makefile > +++ b/cmd/Makefile > @@ -63,6 +63,7 @@ obj-$(CONFIG_ENV_IS_IN_EEPROM) += eeprom.o > obj-$(CONFIG_CMD_EEPROM) += eeprom.o > obj-$(CONFIG_EFI) += efi.o > obj-$(CONFIG_CMD_EFIDEBUG) += efidebug.o > +obj-$(CONFIG_CMD_EFICONFIG) += eficonfig.o > obj-$(CONFIG_CMD_ELF) += elf.o > obj-$(CONFIG_CMD_EROFS) += erofs.o > obj-$(CONFIG_HUSH_PARSER) += exit.o > diff --git a/cmd/eficonfig.c b/cmd/eficonfig.c > new file mode 100644 > index 0000000000..30ce55d055 > --- /dev/null > +++ b/cmd/eficonfig.c > @@ -0,0 +1,1568 @@ > +// SPDX-License-Identifier: GPL-2.0+ > +/* > + * Menu-driven UEFI Variable maintenance > + * > + * Copyright (c) 2022 Masahisa Kojima, Linaro Limited > + */ > + > +#include <ansi.h> > +#include <common.h> > +#include <charset.h> > +#include <efi_loader.h> > +#include <efi_load_initrd.h> > +#include <efi_config.h> > +#include <efi_variable.h> > +#include <log.h> > +#include <malloc.h> > +#include <menu.h> > +#include <watchdog.h> > +#include <asm/unaligned.h> > +#include <linux/delay.h> > + > +static struct efi_simple_text_input_protocol *cin; > + > +#define EFICONFIG_DESCRIPTION_MAX 32 > +#define EFICONFIG_OPTIONAL_DATA_MAX 64 > + > +/** > + * struct eficonfig_filepath_info - structure to be used to store file path > + * > + * @name: file or directory name > + * @list: list structure > + */ > +struct eficonfig_filepath_info { > + u16 *name; > + struct list_head list; > +}; > + > +/** > + * struct eficonfig_boot_option - structure to be used for updating UEFI boot option > + * > + * @file_info: user selected file info > + * @initrd_info: user selected initrd file info > + * @boot_index: index of the boot option > + * @description: pointer to the description string > + * @optional_data: pointer to the optional_data > + * @edit_completed: flag indicates edit complete > + */ > +struct eficonfig_boot_option { > + struct eficonfig_select_file_info file_info; > + struct eficonfig_select_file_info initrd_info; > + unsigned int boot_index; > + u16 *description; > + u16 *optional_data; > + bool edit_completed; > +}; > + > +/** > + * struct eficonfig_volume_entry_data - structure to be used to store volume info > + * > + * @file_info: pointer to file info structure > + * @v: pointer to the protocol interface > + * @dp: pointer to the device path > + */ > +struct eficonfig_volume_entry_data { > + struct eficonfig_select_file_info *file_info; > + struct efi_simple_file_system_protocol *v; > + struct efi_device_path *dp; > +}; > + > +/** > + * struct eficonfig_file_entry_data - structure to be used to store file info > + * > + * @file_info: pointer to file info structure > + * @is_directory: flag to identify the directory or file > + * @file_name: name of directory or file > + */ > +struct eficonfig_file_entry_data { > + struct eficonfig_select_file_info *file_info; > + bool is_directory; > + u16 *file_name; > +}; > + > +/** > + * eficonfig_print_msg() - print message > + * > + * display the message to the user, user proceeds the screen > + * with any key press. > + * > + * @items: pointer to the structure of each menu entry > + * @count: the number of menu entry > + * @menu_header: pointer to the menu header string > + * Return: status code > + */ > +void eficonfig_print_msg(char *msg) > +{ > + /* Flush input */ > + while (tstc()) > + getchar(); > + > + printf(ANSI_CURSOR_HIDE > + ANSI_CLEAR_CONSOLE > + ANSI_CURSOR_POSITION > + "%s\n\n Press any key to continue", 3, 4, msg); > + > + getchar(); > +} > + > +/** > + * eficonfig_print_entry() - print each menu entry > + * > + * @data: pointer to the data associated with each menu entry > + */ > +static void eficonfig_print_entry(void *data) > +{ > + struct eficonfig_entry *entry = data; > + int reverse = (entry->efi_menu->active == entry->num); > + > + /* TODO: support scroll or page for many entries */ > + > + /* > + * Move cursor to line where the entry will be drawn (entry->num) > + * First 3 lines(menu header) + 1 empty line > + */ > + printf(ANSI_CURSOR_POSITION, entry->num + 4, 7); > + > + if (reverse) > + puts(ANSI_COLOR_REVERSE); > + > + printf("%s", entry->title); > + > + if (reverse) > + puts(ANSI_COLOR_RESET); > +} > + > +/** > + * eficonfig_display_statusline() - print status line > + * > + * @m: pointer to the menu structure > + */ > +static void eficonfig_display_statusline(struct menu *m) > +{ > + struct eficonfig_entry *entry; > + > + if (menu_default_choice(m, (void *)&entry) < 0) > + return; > + > + printf(ANSI_CURSOR_POSITION > + "\n%s\n" > + ANSI_CURSOR_POSITION ANSI_CLEAR_LINE ANSI_CURSOR_POSITION > + " Press UP/DOWN to move, ENTER to select, ESC/CTRL+C to quit" > + ANSI_CLEAR_LINE_TO_END ANSI_CURSOR_POSITION ANSI_CLEAR_LINE, > + 1, 1, entry->efi_menu->menu_header, entry->efi_menu->count + 5, 1, > + entry->efi_menu->count + 6, 1, entry->efi_menu->count + 7, 1); > +} > + > +/** > + * eficonfig_choice_entry() - user key input handler > + * > + * @data: pointer to the efimenu structure > + * Return: key string to identify the selected entry > + */ > +static char *eficonfig_choice_entry(void *data) > +{ > + int esc = 0; > + struct list_head *pos, *n; > + struct eficonfig_entry *entry; > + enum bootmenu_key key = KEY_NONE; > + struct efimenu *efi_menu = data; > + > + while (1) { > + bootmenu_loop((struct bootmenu_data *)efi_menu, &key, &esc); > + > + switch (key) { > + case KEY_UP: > + if (efi_menu->active > 0) > + --efi_menu->active; > + /* no menu key selected, regenerate menu */ > + return NULL; > + case KEY_DOWN: > + if (efi_menu->active < efi_menu->count - 1) > + ++efi_menu->active; > + /* no menu key selected, regenerate menu */ > + return NULL; > + case KEY_SELECT: > + list_for_each_safe(pos, n, &efi_menu->list) { > + entry = list_entry(pos, struct eficonfig_entry, list); > + if (entry->num == efi_menu->active) > + return entry->key; > + } > + break; > + case KEY_QUIT: > + /* Quit by choosing the last entry */ > + entry = list_last_entry(&efi_menu->list, struct eficonfig_entry, list); > + return entry->key; > + default: > + /* Pressed key is not valid, no need to regenerate the menu */ > + break; > + } > + } > +} > + > +/** > + * eficonfig_destroy() - destroy efimenu > + * > + * @efi_menu: pointer to the efimenu structure > + */ > +void eficonfig_destroy(struct efimenu *efi_menu) > +{ > + struct list_head *pos, *n; > + struct eficonfig_entry *entry; > + > + list_for_each_safe(pos, n, &efi_menu->list) { > + entry = list_entry(pos, struct eficonfig_entry, list); > + free(entry->title); > + list_del(&entry->list); > + free(entry); > + } > + free(efi_menu->menu_header); > + free(efi_menu); > +} > + > +/** > + * eficonfig_process_quit() - callback function for "Quit" entry > + * > + * @data: pointer to the data > + * Return: status code > + */ > +efi_status_t eficonfig_process_quit(void *data) > +{ > + return EFI_ABORTED; > +} > + > +/** > + * append_entry() - append menu item > + * > + * @efi_menu: pointer to the efimenu structure > + * @title: pointer to the entry title > + * @func: callback of each entry > + * @data: pointer to the data to be passed to each entry callback > + * Return: status code > + */ > +static efi_status_t append_entry(struct efimenu *efi_menu, > + char *title, eficonfig_entry_func func, void *data) > +{ > + struct eficonfig_entry *entry; > + > + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX) > + return EFI_OUT_OF_RESOURCES; > + > + entry = calloc(1, sizeof(struct eficonfig_entry)); > + if (!entry) > + return EFI_OUT_OF_RESOURCES; > + > + entry->title = title; > + sprintf(entry->key, "%d", efi_menu->count); > + entry->efi_menu = efi_menu; > + entry->func = func; > + entry->data = data; > + entry->num = efi_menu->count++; > + list_add_tail(&entry->list, &efi_menu->list); > + > + return EFI_SUCCESS; > +} > + > +/** > + * append_quit_entry() - append quit entry > + * > + * @efi_menu: pointer to the efimenu structure > + * Return: status code > + */ > +static efi_status_t append_quit_entry(struct efimenu *efi_menu) > +{ > + char *title; > + efi_status_t ret; > + > + title = strdup("Quit"); > + if (!title) > + return EFI_OUT_OF_RESOURCES; > + > + ret = append_entry(efi_menu, title, eficonfig_process_quit, NULL); > + if (ret != EFI_SUCCESS) > + free(title); > + > + return ret; > +} > + > +/** > + * eficonfig_create_fixed_menu() - create fixed entry menu structure > + * > + * @items: pointer to the menu entry item > + * @count: the number of menu entry > + * Return: pointer to the efimenu structure > + */ > +void *eficonfig_create_fixed_menu(const struct eficonfig_item *items, int count) > +{ > + u32 i; > + char *title; > + efi_status_t ret; > + struct efimenu *efi_menu; > + const struct eficonfig_item *iter = items; > + > + efi_menu = calloc(1, sizeof(struct efimenu)); > + if (!efi_menu) > + return NULL; > + > + INIT_LIST_HEAD(&efi_menu->list); > + for (i = 0; i < count; i++, iter++) { > + title = strdup(iter->title); > + if (!title) > + goto out; > + > + ret = append_entry(efi_menu, title, iter->func, iter->data); > + if (ret != EFI_SUCCESS) { > + free(title); > + goto out; > + } > + } > + > + return efi_menu; > +out: > + eficonfig_destroy(efi_menu); > + > + return NULL; > +} > + > +/** > + * eficonfig_process_common() - main handler for UEFI menu > + * > + * Construct the structures required to show the menu, then handle > + * the user input interacting with u-boot menu functions. > + * > + * @efi_menu: pointer to the efimenu structure > + * @menu_header: pointer to the menu header string > + * Return: status code > + */ > +efi_status_t eficonfig_process_common(struct efimenu *efi_menu, char *menu_header) > +{ > + struct menu *menu; > + void *choice = NULL; > + struct list_head *pos, *n; > + struct eficonfig_entry *entry; > + efi_status_t ret = EFI_SUCCESS; > + > + if (efi_menu->count > EFICONFIG_ENTRY_NUM_MAX) > + return EFI_OUT_OF_RESOURCES; > + > + efi_menu->delay = -1; > + efi_menu->active = 0; > + > + if (menu_header) { > + efi_menu->menu_header = strdup(menu_header); This does not build: +cmd/eficonfig.c:380:7: error: variable 'menu' is used uninitialized whenever 'if' condition is true [-Werror,-Wsometimes-uninitialized] + if (!efi_menu->menu_header) { + ^~~~~~~~~~~~~~~~~~~~~~ +cmd/eficonfig.c:416:15: note: uninitialized use occurs here + menu_destroy(menu); + ^~~~ +cmd/eficonfig.c:380:3: note: remove the 'if' if its condition is always false + ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +cmd/eficonfig.c:366:19: note: initialize the variable 'menu' to silence this warning + struct menu *menu; + ^ + = NULL Best regards Heinrich > + if (!efi_menu->menu_header) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + } > + > + menu = menu_create(NULL, 0, 1, eficonfig_display_statusline, > + eficonfig_print_entry, eficonfig_choice_entry, > + efi_menu); > + if (!menu) { > + ret = EFI_INVALID_PARAMETER; > + goto out; > + } > + > + list_for_each_safe(pos, n, &efi_menu->list) { > + entry = list_entry(pos, struct eficonfig_entry, list); > + if (!menu_item_add(menu, entry->key, entry)) { > + ret = EFI_INVALID_PARAMETER; > + goto out; > + } > + } > + > + entry = list_first_entry_or_null(&efi_menu->list, struct eficonfig_entry, list); > + if (entry) > + menu_default_set(menu, entry->key); > + > + printf(ANSI_CURSOR_HIDE > + ANSI_CLEAR_CONSOLE > + ANSI_CURSOR_POSITION, 1, 1); > + > + if (menu_get_choice(menu, &choice)) { > + entry = choice; > + if (entry->func) > + ret = entry->func(entry->data); > + } > +out: > + menu_destroy(menu); > + > + printf(ANSI_CLEAR_CONSOLE > + ANSI_CURSOR_POSITION > + ANSI_CURSOR_SHOW, 1, 1); > + > + return ret; > +} > + > +/** > + * eficonfig_volume_selected() - handler of volume selection > + * > + * @data: pointer to the data of selected entry > + * Return: status code > + */ > +static efi_status_t eficonfig_volume_selected(void *data) > +{ > + struct eficonfig_volume_entry_data *info = data; > + > + if (info) { > + info->file_info->current_volume = info->v; > + info->file_info->dp_volume = info->dp; > + } > + > + return EFI_SUCCESS; > +} > + > +/** > + * create_selected_device_path() - create device path > + * > + * @file_info: pointer to the selected file information > + * Return: > + * device path or NULL. Caller must free the returned value > + */ > +static > +struct efi_device_path *create_selected_device_path(struct eficonfig_select_file_info *file_info) > +{ > + char *p; > + void *buf; > + efi_uintn_t fp_size; > + struct efi_device_path *dp; > + struct efi_device_path_file_path *fp; > + > + fp_size = sizeof(struct efi_device_path) + > + ((u16_strlen(file_info->current_path) + 1) * sizeof(u16)); > + buf = calloc(1, fp_size + sizeof(END)); > + if (!buf) > + return NULL; > + > + fp = buf; > + fp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, > + fp->dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, > + fp->dp.length = (u16)fp_size; > + u16_strcpy(fp->str, file_info->current_path); > + > + p = buf; > + p += fp_size; > + *((struct efi_device_path *)p) = END; > + > + dp = efi_dp_append(file_info->dp_volume, (struct efi_device_path *)buf); > + free(buf); > + > + return dp; > +} > + > +/** > + * eficonfig_file_selected() - handler of file selection > + * > + * @data: pointer to the data of selected entry > + * Return: status code > + */ > +static efi_status_t eficonfig_file_selected(void *data) > +{ > + struct eficonfig_file_entry_data *info = data; > + > + if (!info) > + return EFI_INVALID_PARAMETER; > + > + if (u16_strcmp(info->file_name, u".") == 0 && > + u16_strlen(info->file_name) == 1) { > + /* stay current path */ > + } else if (u16_strcmp(info->file_name, u"..") == 0 && > + u16_strlen(info->file_name) == 2) { > + struct eficonfig_filepath_info *iter; > + struct list_head *pos, *n; > + int is_last; > + > + memset(info->file_info->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE); > + list_for_each_safe(pos, n, &info->file_info->filepath_list) { > + iter = list_entry(pos, struct eficonfig_filepath_info, list); > + > + is_last = list_is_last(&iter->list, &info->file_info->filepath_list); > + if (is_last) { > + list_del(&iter->list); > + free(iter->name); > + free(iter); > + break; > + } > + u16_strlcat(info->file_info->current_path, iter->name, > + EFICONFIG_FILE_PATH_MAX); > + u16_strlcat(info->file_info->current_path, u"\\", > + EFICONFIG_FILE_PATH_MAX); > + } > + } else { > + size_t new_len; > + struct eficonfig_filepath_info *filepath; > + > + new_len = u16_strlen(info->file_info->current_path) + > + u16_strlen(info->file_name); > + if (new_len >= EFICONFIG_FILE_PATH_MAX) { > + eficonfig_print_msg("File path is too long!"); > + return EFI_INVALID_PARAMETER; > + } > + u16_strlcat(info->file_info->current_path, info->file_name, > + EFICONFIG_FILE_PATH_MAX); > + > + filepath = calloc(1, sizeof(struct eficonfig_filepath_info)); > + if (!filepath) > + return EFI_OUT_OF_RESOURCES; > + > + filepath->name = u16_strdup(info->file_name); > + if (!filepath->name) { > + free(filepath); > + return EFI_OUT_OF_RESOURCES; > + } > + list_add_tail(&filepath->list, &info->file_info->filepath_list); > + > + if (info->is_directory) { > + /* > + * Remaining buffer should have enough space to contain u"\\" and > + * at least one character for file name > + */ > + if (new_len + 2 >= EFICONFIG_FILE_PATH_MAX) { > + eficonfig_print_msg("Directory path is too long!"); > + return EFI_INVALID_PARAMETER; > + } > + u16_strlcat(info->file_info->current_path, u"\\", > + EFICONFIG_FILE_PATH_MAX); > + } else { > + info->file_info->file_selected = true; > + } > + } > + return EFI_SUCCESS; > +} > + > +/** > + * eficonfig_select_volume() - construct the volume selection menu > + * > + * @file_info: pointer to the file selection structure > + * Return: status code > + */ > +static efi_status_t eficonfig_select_volume(struct eficonfig_select_file_info *file_info) > +{ > + u32 i; > + efi_status_t ret; > + efi_uintn_t count; > + struct efimenu *efi_menu; > + struct list_head *pos, *n; > + struct efi_handler *handler; > + struct eficonfig_entry *entry; > + struct efi_device_path *device_path; > + efi_handle_t *volume_handles = NULL; > + struct efi_simple_file_system_protocol *v; > + > + ret = efi_locate_handle_buffer_int(BY_PROTOCOL, &efi_simple_file_system_protocol_guid, > + NULL, &count, (efi_handle_t **)&volume_handles); > + if (ret != EFI_SUCCESS) { > + eficonfig_print_msg("No block device found!"); > + return ret; > + } > + > + efi_menu = calloc(1, sizeof(struct efimenu)); > + if (!efi_menu) > + return EFI_OUT_OF_RESOURCES; > + > + INIT_LIST_HEAD(&efi_menu->list); > + for (i = 0; i < count; i++) { > + char *devname; > + struct efi_block_io *block_io; > + struct eficonfig_volume_entry_data *info; > + > + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1) > + break; > + > + ret = efi_search_protocol(volume_handles[i], > + &efi_simple_file_system_protocol_guid, &handler); > + if (ret != EFI_SUCCESS) > + continue; > + ret = efi_protocol_open(handler, (void **)&v, efi_root, NULL, > + EFI_OPEN_PROTOCOL_GET_PROTOCOL); > + if (ret != EFI_SUCCESS) > + continue; > + > + ret = efi_search_protocol(volume_handles[i], &efi_guid_device_path, &handler); > + if (ret != EFI_SUCCESS) > + continue; > + ret = efi_protocol_open(handler, (void **)&device_path, > + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); > + if (ret != EFI_SUCCESS) > + continue; > + > + ret = efi_search_protocol(volume_handles[i], &efi_block_io_guid, &handler); > + if (ret != EFI_SUCCESS) > + continue; > + ret = efi_protocol_open(handler, (void **)&block_io, > + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); > + if (ret != EFI_SUCCESS) > + continue; > + > + info = calloc(1, sizeof(struct eficonfig_volume_entry_data)); > + if (!info) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + > + devname = calloc(1, BOOTMENU_DEVICE_NAME_MAX); > + if (!devname) { > + free(info); > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + ret = efi_disk_get_device_name(volume_handles[i], devname, > + BOOTMENU_DEVICE_NAME_MAX); > + if (ret != EFI_SUCCESS) { > + free(info); > + goto out; > + } > + > + info->v = v; > + info->dp = device_path; > + info->file_info = file_info; > + ret = append_entry(efi_menu, devname, eficonfig_volume_selected, info); > + if (ret != EFI_SUCCESS) { > + free(info); > + goto out; > + } > + } > + > + ret = append_quit_entry(efi_menu); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = eficonfig_process_common(efi_menu, " ** Select Volume **"); > +out: > + efi_free_pool(volume_handles); > + list_for_each_safe(pos, n, &efi_menu->list) { > + entry = list_entry(pos, struct eficonfig_entry, list); > + free(entry->data); > + } > + eficonfig_destroy(efi_menu); > + > + return ret; > +} > + > +/** > + * eficonfig_select_file() - construct the file selection menu > + * > + * @file_info: pointer to the file selection structure > + * @root: pointer to the file handle > + * Return: status code > + */ > +static efi_status_t eficonfig_select_file(struct eficonfig_select_file_info *file_info, > + struct efi_file_handle *root) > +{ > + efi_uintn_t len; > + efi_status_t ret; > + struct efimenu *efi_menu; > + struct efi_file_handle *f; > + struct efi_file_info *buf; > + struct list_head *pos, *n; > + > + buf = calloc(1, sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE); > + if (!buf) > + return EFI_OUT_OF_RESOURCES; > + > + while (!file_info->file_selected) { > + efi_menu = calloc(1, sizeof(struct efimenu)); > + if (!efi_menu) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + INIT_LIST_HEAD(&efi_menu->list); > + > + ret = efi_file_open_int(root, &f, file_info->current_path, EFI_FILE_MODE_READ, 0); > + if (ret != EFI_SUCCESS) { > + eficonfig_print_msg("Reading volume failed!"); > + ret = EFI_ABORTED; > + goto out; > + } > + > + /* Read directory and construct menu structure */ > + for (;;) { > + char *name, *p; > + int name_len; > + struct eficonfig_file_entry_data *info; > + > + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1) > + break; > + > + len = sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE; > + ret = efi_file_read_int(f, &len, buf); > + if (ret != EFI_SUCCESS || len == 0) > + break; > + > + info = calloc(1, sizeof(struct eficonfig_file_entry_data)); > + if (!info) { > + ret = EFI_OUT_OF_RESOURCES; > + goto err; > + } > + > + if (buf->attribute & EFI_FILE_DIRECTORY) { > + /* append u'/' at the end of directory name */ > + name_len = utf16_utf8_strlen(buf->file_name) + 2; > + > + /* filter out u'.' */ > + if (name_len == 3 && buf->file_name[0] == u'.') { > + free(info); > + continue; > + } > + > + name = calloc(1, name_len); > + if (!name) { > + free(info); > + ret = EFI_OUT_OF_RESOURCES; > + goto err; > + } > + p = name; > + utf16_utf8_strcpy(&p, buf->file_name); > + name[u16_strlen(buf->file_name)] = u'/'; > + > + info->is_directory = true; > + } else { > + name_len = utf16_utf8_strlen(buf->file_name) + 1; > + name = calloc(1, name_len); > + if (!name) { > + free(info); > + ret = EFI_OUT_OF_RESOURCES; > + goto err; > + } > + p = name; > + utf16_utf8_strcpy(&p, buf->file_name); > + } > + > + info->file_name = u16_strdup(buf->file_name); > + if (!info->file_name) { > + free(info); > + free(name); > + ret = EFI_OUT_OF_RESOURCES; > + goto err; > + } > + > + info->file_info = file_info; > + ret = append_entry(efi_menu, name, eficonfig_file_selected, info); > + if (ret != EFI_SUCCESS) { > + free(info); > + free(name); > + goto err; > + } > + } > + > + ret = append_quit_entry(efi_menu); > + if (ret != EFI_SUCCESS) > + goto err; > + > + ret = eficonfig_process_common(efi_menu, " ** Select File **"); > +err: > + efi_file_close_int(f); > + list_for_each_safe(pos, n, &efi_menu->list) { > + struct eficonfig_entry *entry; > + > + entry = list_entry(pos, struct eficonfig_entry, list); > + /* skip "Quit" */ > + if (list_is_last(&entry->list, &efi_menu->list)) > + break; > + > + free(((struct eficonfig_file_entry_data *)(entry->data))->file_name); > + free(entry->data); > + } > + eficonfig_destroy(efi_menu); > + if (ret != EFI_SUCCESS) > + break; > + } > + > +out: > + free(buf); > + return ret; > +} > + > +/** > + * handle_user_input() - handle user input > + * > + * @buf: pointer to the buffer > + * @buf_size: size of the buffer > + * @cursor_col: cursor column for user input > + * @msg: pointer to the string to display > + * Return: status code > + */ > +static efi_status_t handle_user_input(u16 *buf, int buf_size, > + int cursor_col, char *msg) > +{ > + u16 *tmp; > + efi_status_t ret; > + > + printf(ANSI_CLEAR_CONSOLE > + ANSI_CURSOR_POSITION > + "%s" > + ANSI_CURSOR_POSITION > + " Press ENTER to complete, ESC/CTRL+C to quit", > + 0, 1, msg, 8, 1); > + > + /* tmp is used to accept user cancel */ > + tmp = calloc(1, buf_size * sizeof(u16)); > + if (!tmp) > + return EFI_OUT_OF_RESOURCES; > + > + ret = efi_console_get_u16_string(cin, tmp, buf_size, NULL, 4, cursor_col); > + if (ret == EFI_SUCCESS) > + u16_strcpy(buf, tmp); > + > + free(tmp); > + > + /* to stay the parent menu */ > + ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret; > + > + return ret; > +} > + > +/** > + * eficonfig_boot_add_enter_description() - handle user input for description > + * > + * @data: pointer to the internal boot option structure > + * Return: status code > + */ > +static efi_status_t eficonfig_boot_add_enter_description(void *data) > +{ > + struct eficonfig_boot_option *bo = data; > + > + return handle_user_input(bo->description, EFICONFIG_DESCRIPTION_MAX, 22, > + "\n ** Edit Description **\n" > + "\n" > + " enter description: "); > +} > + > +/** > + * eficonfig_boot_add_optional_data() - handle user input for optional data > + * > + * @data: pointer to the internal boot option structure > + * Return: status code > + */ > +static efi_status_t eficonfig_boot_add_optional_data(void *data) > +{ > + struct eficonfig_boot_option *bo = data; > + > + return handle_user_input(bo->optional_data, EFICONFIG_OPTIONAL_DATA_MAX, 24, > + "\n ** Edit Optional Data **\n" > + "\n" > + " enter optional data:"); > +} > + > +/** > + * eficonfig_boot_edit_save() - handler to save the boot option > + * > + * @data: pointer to the internal boot option structure > + * Return: status code > + */ > +static efi_status_t eficonfig_boot_edit_save(void *data) > +{ > + struct eficonfig_boot_option *bo = data; > + > + if (u16_strlen(bo->description) == 0) { > + eficonfig_print_msg("Boot Description is empty!"); > + bo->edit_completed = false; > + return EFI_NOT_READY; > + } > + if (u16_strlen(bo->file_info.current_path) == 0) { > + eficonfig_print_msg("File is not selected!"); > + bo->edit_completed = false; > + return EFI_NOT_READY; > + } > + > + bo->edit_completed = true; > + > + return EFI_SUCCESS; > +} > + > +/** > + * eficonfig_process_select_file() - callback function for "Select File" entry > + * > + * @data: pointer to the data > + * Return: status code > + */ > +efi_status_t eficonfig_process_select_file(void *data) > +{ > + return EFI_SUCCESS; > +} > + > +/** > + * eficonfig_process_clear_file_selection() - callback function for "Clear" entry > + * > + * @data: pointer to the data > + * Return: status code > + */ > +efi_status_t eficonfig_process_clear_file_selection(void *data) > +{ > + struct eficonfig_select_file_info *file_info = data; > + > + /* clear the existing file information */ > + file_info->current_volume = NULL; > + file_info->current_path[0] = u'\0'; > + file_info->dp_volume = NULL; > + > + return EFI_ABORTED; > +} > + > +static struct eficonfig_item select_file_menu_items[] = { > + {"Select File", eficonfig_process_select_file}, > + {"Clear", eficonfig_process_clear_file_selection}, > + {"Quit", eficonfig_process_quit}, > +}; > + > + > +/** > + * eficonfig_display_select_file_option() - display select file option > + * > + * @file_info: pointer to the file information structure > + * Return: status code > + */ > +efi_status_t eficonfig_display_select_file_option(struct eficonfig_select_file_info *file_info) > +{ > + efi_status_t ret; > + struct efimenu *efi_menu; > + > + select_file_menu_items[1].data = file_info; > + efi_menu = eficonfig_create_fixed_menu(select_file_menu_items, > + ARRAY_SIZE(select_file_menu_items)); > + if (!efi_menu) > + return EFI_OUT_OF_RESOURCES; > + > + ret = eficonfig_process_common(efi_menu, " ** Update File **"); > + if (ret != EFI_SUCCESS) /* User selects "Clear" or "Quit" */ > + ret = EFI_NOT_READY; > + > + eficonfig_destroy(efi_menu); > + > + return ret; > +} > + > +/** > + * eficonfig_select_file_handler() - handle user file selection > + * > + * @data: pointer to the data > + * Return: status code > + */ > +efi_status_t eficonfig_select_file_handler(void *data) > +{ > + size_t len; > + efi_status_t ret; > + struct list_head *pos, *n; > + struct efi_file_handle *root; > + struct eficonfig_filepath_info *item; > + struct eficonfig_select_file_info *tmp = NULL; > + struct eficonfig_select_file_info *file_info = data; > + > + ret = eficonfig_display_select_file_option(file_info); > + if (ret != EFI_SUCCESS) > + return ret; > + > + tmp = calloc(1, sizeof(struct eficonfig_select_file_info)); > + if (!tmp) > + return EFI_OUT_OF_RESOURCES; > + > + tmp->current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); > + if (!tmp->current_path) { > + free(tmp); > + return EFI_OUT_OF_RESOURCES; > + } > + INIT_LIST_HEAD(&tmp->filepath_list); > + > + while (!tmp->file_selected) { > + tmp->current_volume = NULL; > + memset(tmp->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE); > + > + ret = eficonfig_select_volume(tmp); > + if (ret != EFI_SUCCESS) > + goto out; > + > + if (!tmp->current_volume) > + return EFI_INVALID_PARAMETER; > + > + ret = efi_open_volume_int(tmp->current_volume, &root); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = eficonfig_select_file(tmp, root); > + if (ret == EFI_ABORTED) > + continue; > + if (ret != EFI_SUCCESS) > + goto out; > + } > + > +out: > + if (ret == EFI_SUCCESS) { > + len = u16_strlen(tmp->current_path); > + len = (len >= EFICONFIG_FILE_PATH_MAX) ? (EFICONFIG_FILE_PATH_MAX - 1) : len; > + memcpy(file_info->current_path, tmp->current_path, len * sizeof(u16)); > + file_info->current_path[len] = u'\0'; > + file_info->current_volume = tmp->current_volume; > + file_info->dp_volume = tmp->dp_volume; > + } > + > + list_for_each_safe(pos, n, &tmp->filepath_list) { > + item = list_entry(pos, struct eficonfig_filepath_info, list); > + list_del(&item->list); > + free(item->name); > + free(item); > + } > + free(tmp->current_path); > + free(tmp); > + > + /* to stay the parent menu */ > + ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret; > + > + return ret; > +} > + > +/** > + * eficonfig_get_unused_bootoption() - get unused "Boot####" index > + * > + * @buf: pointer to the buffer to store boot option variable name > + * @buf_size: buffer size > + * @index: pointer to store the index in the BootOrder variable > + * Return: status code > + */ > +efi_status_t eficonfig_get_unused_bootoption(u16 *buf, efi_uintn_t buf_size, > + unsigned int *index) > +{ > + u32 i; > + efi_status_t ret; > + efi_uintn_t size; > + > + if (buf_size < u16_strsize(u"Boot####")) > + return EFI_BUFFER_TOO_SMALL; > + > + for (i = 0; i <= 0xFFFF; i++) { > + size = 0; > + efi_create_indexed_name(buf, buf_size, "Boot", i); > + ret = efi_get_variable_int(buf, &efi_global_variable_guid, > + NULL, &size, NULL, NULL); > + if (ret == EFI_BUFFER_TOO_SMALL) > + continue; > + else > + break; > + } > + > + if (i > 0xFFFF) > + return EFI_OUT_OF_RESOURCES; > + > + *index = i; > + > + return EFI_SUCCESS; > +} > + > +/** > + * eficonfig_set_boot_option() - set boot option > + * > + * @varname: pointer to variable name > + * @dp: pointer to device path > + * @label: pointer to label string > + * @optional_data: pointer to optional data > + * Return: status code > + */ > +static efi_status_t eficonfig_set_boot_option(u16 *varname, struct efi_device_path *dp, > + efi_uintn_t dp_size, u16 *label, char *optional_data) > +{ > + void *p = NULL; > + efi_status_t ret; > + efi_uintn_t size; > + struct efi_load_option lo; > + > + lo.file_path = dp; > + lo.file_path_length = dp_size; > + lo.attributes = LOAD_OPTION_ACTIVE; > + lo.optional_data = optional_data; > + lo.label = label; > + > + size = efi_serialize_load_option(&lo, (u8 **)&p); > + if (!size) > + return EFI_INVALID_PARAMETER; > + > + ret = efi_set_variable_int(varname, &efi_global_variable_guid, > + EFI_VARIABLE_NON_VOLATILE | > + EFI_VARIABLE_BOOTSERVICE_ACCESS | > + EFI_VARIABLE_RUNTIME_ACCESS, > + size, p, false); > + free(p); > + > + return ret; > +} > + > +/** > + * eficonfig_append_bootorder() - append new boot option in BootOrder variable > + * > + * @index: "Boot####" index to append to BootOrder variable > + * Return: status code > + */ > +efi_status_t eficonfig_append_bootorder(u16 index) > +{ > + u16 *bootorder; > + efi_status_t ret; > + u16 *new_bootorder = NULL; > + efi_uintn_t last, size, new_size; > + > + /* append new boot option */ > + bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size); > + last = size / sizeof(u16); > + new_size = size + sizeof(u16); > + new_bootorder = calloc(1, new_size); > + if (!new_bootorder) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + memcpy(new_bootorder, bootorder, size); > + new_bootorder[last] = index; > + > + ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid, > + EFI_VARIABLE_NON_VOLATILE | > + EFI_VARIABLE_BOOTSERVICE_ACCESS | > + EFI_VARIABLE_RUNTIME_ACCESS, > + new_size, new_bootorder, false); > + if (ret != EFI_SUCCESS) > + goto out; > + > +out: > + free(bootorder); > + free(new_bootorder); > + > + return ret; > +} > + > +/** > + * create_boot_option_entry() - create boot option entry > + * > + * @efi_menu: pointer to the efimenu structure > + * @title: pointer to the entry title > + * @val: pointer to boot option label > + * @func: callback of each entry > + * @data: pointer to the data to be passed to each entry callback > + * Return: status code > + */ > +static efi_status_t create_boot_option_entry(struct efimenu *efi_menu, char *title, u16 *val, > + eficonfig_entry_func func, void *data) > +{ > + u32 len; > + char *p, *buf; > + > + len = strlen(title) + 1; > + if (val) > + len += utf16_utf8_strlen(val); > + buf = calloc(1, len); > + if (!buf) > + return EFI_OUT_OF_RESOURCES; > + > + strcpy(buf, title); > + if (val) { > + p = buf + strlen(title); > + utf16_utf8_strcpy(&p, val); > + } > + > + return append_entry(efi_menu, buf, func, data); > +} > + > +/** > + * prepare_file_selection_entry() - prepare file selection entry > + * > + * @efi_menu: pointer to the efimenu structure > + * @title: pointer to the title string > + * @file_info: pointer to the file info > + * Return: status code > + */ > +static efi_status_t prepare_file_selection_entry(struct efimenu *efi_menu, char *title, > + struct eficonfig_select_file_info *file_info) > +{ > + u32 len; > + efi_status_t ret; > + u16 *file_name, *p; > + efi_handle_t handle; > + char devname[BOOTMENU_DEVICE_NAME_MAX] = {0}; > + > + /* get the device name only when the user already selected the file path */ > + handle = efi_dp_find_obj(file_info->dp_volume, NULL, NULL); > + if (handle) { > + ret = efi_disk_get_device_name(handle, devname, BOOTMENU_DEVICE_NAME_MAX); > + if (ret != EFI_SUCCESS) > + return ret; > + } > + > + /* append u'/' to devname, it is just for display purpose. */ > + if (file_info->current_path[0] != u'\0' && file_info->current_path[0] != u'/') > + strlcat(devname, "/", BOOTMENU_DEVICE_NAME_MAX); > + > + len = strlen(devname); > + len += utf16_utf8_strlen(file_info->current_path) + 1; > + file_name = calloc(1, len * sizeof(u16)); > + if (!file_name) > + return ret; > + > + p = file_name; > + utf8_utf16_strcpy(&p, devname); > + u16_strlcat(file_name, file_info->current_path, len); > + ret = create_boot_option_entry(efi_menu, title, file_name, > + eficonfig_select_file_handler, file_info); > + free(file_name); > + return ret; > +} > + > +/** > + * eficonfig_show_boot_option() - prepare menu entry for editing boot option > + * > + * Construct the structures to create edit boot option menu > + * > + * @bo: pointer to the boot option > + * @header_str: pointer to the header string > + * Return: status code > + */ > +static efi_status_t eficonfig_show_boot_option(struct eficonfig_boot_option *bo, > + char *header_str) > +{ > + efi_status_t ret; > + struct efimenu *efi_menu; > + > + efi_menu = calloc(1, sizeof(struct efimenu)); > + if (!efi_menu) > + return EFI_OUT_OF_RESOURCES; > + > + INIT_LIST_HEAD(&efi_menu->list); > + > + ret = create_boot_option_entry(efi_menu, "Description: ", bo->description, > + eficonfig_boot_add_enter_description, bo); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = prepare_file_selection_entry(efi_menu, "File: ", &bo->file_info); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = prepare_file_selection_entry(efi_menu, "Initrd File: ", &bo->initrd_info); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = create_boot_option_entry(efi_menu, "Optional Data: ", bo->optional_data, > + eficonfig_boot_add_optional_data, bo); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = create_boot_option_entry(efi_menu, "Save", NULL, > + eficonfig_boot_edit_save, bo); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = create_boot_option_entry(efi_menu, "Quit", NULL, > + eficonfig_process_quit, NULL); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = eficonfig_process_common(efi_menu, header_str); > +out: > + eficonfig_destroy(efi_menu); > + > + return ret; > +} > + > +/** > + * fill_file_info() - fill the file info from efi_device_path structure > + * > + * @dp: pointer to the device path > + * @file_info: pointer to the file info structure > + * @device_dp: pointer to the volume device path > + */ > +static void fill_file_info(struct efi_device_path *dp, > + struct eficonfig_select_file_info *file_info, > + struct efi_device_path *device_dp) > +{ > + u16 *file_str, *p; > + struct efi_device_path *file_dp = NULL; > + > + efi_dp_split_file_path(dp, &device_dp, &file_dp); > + file_info->dp_volume = device_dp; > + > + if (file_dp) { > + file_str = efi_dp_str(file_dp); > + /* > + * efi_convert_device_path_to_text() automatically adds u'/' at the > + * beginning of file name, remove u'/' before copying to current_path > + */ > + p = file_str; > + if (p[0] == u'/') > + p++; > + > + u16_strcpy(file_info->current_path, p); > + efi_free_pool(file_dp); > + efi_free_pool(file_str); > + } > +} > + > +/** > + * eficonfig_edit_boot_option() - prepare boot option structure for editing > + * > + * Construct the boot option structure and copy the existing value > + * > + * @varname: pointer to the UEFI variable name > + * @bo: pointer to the boot option > + * @load_option: pointer to the load option > + * @load_option_size: size of the load option > + * @header_str: pointer to the header string > + * Return : status code > + */ > +static efi_status_t eficonfig_edit_boot_option(u16 *varname, struct eficonfig_boot_option *bo, > + void *load_option, efi_uintn_t load_option_size, > + char *header_str) > +{ > + size_t len; > + efi_status_t ret; > + char *tmp = NULL, *p; > + struct efi_load_option lo = {0}; > + efi_uintn_t final_dp_size; > + struct efi_device_path *dp = NULL; > + efi_uintn_t size = load_option_size; > + struct efi_device_path *final_dp = NULL; > + struct efi_device_path *device_dp = NULL; > + struct efi_device_path *initrd_dp = NULL; > + struct efi_device_path *initrd_device_dp = NULL; > + > + const struct efi_initrd_dp id_dp = { > + .vendor = { > + { > + DEVICE_PATH_TYPE_MEDIA_DEVICE, > + DEVICE_PATH_SUB_TYPE_VENDOR_PATH, > + sizeof(id_dp.vendor), > + }, > + EFI_INITRD_MEDIA_GUID, > + }, > + .end = { > + DEVICE_PATH_TYPE_END, > + DEVICE_PATH_SUB_TYPE_END, > + sizeof(id_dp.end), > + } > + }; > + > + bo->file_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); > + if (!bo->file_info.current_path) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + > + bo->initrd_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); > + if (!bo->file_info.current_path) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + > + bo->description = calloc(1, EFICONFIG_DESCRIPTION_MAX * sizeof(u16)); > + if (!bo->description) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + > + bo->optional_data = calloc(1, EFICONFIG_OPTIONAL_DATA_MAX * sizeof(u16)); > + if (!bo->optional_data) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + > + /* copy the preset value */ > + if (load_option) { > + ret = efi_deserialize_load_option(&lo, load_option, &size); > + if (ret != EFI_SUCCESS) > + goto out; > + > + if (!lo.label || (lo.label && u16_strlen(lo.label) >= EFICONFIG_DESCRIPTION_MAX)) { > + ret = EFI_INVALID_PARAMETER; > + goto out; > + } > + u16_strcpy(bo->description, lo.label); > + > + /* EFI image file path is a first instance */ > + if (lo.file_path) > + fill_file_info(lo.file_path, &bo->file_info, device_dp); > + > + /* Initrd file path(optional) is placed at second instance. */ > + initrd_dp = efi_dp_from_lo(&lo, &efi_lf2_initrd_guid); > + if (initrd_dp) { > + fill_file_info(initrd_dp, &bo->initrd_info, initrd_device_dp); > + efi_free_pool(initrd_dp); > + } > + > + if (size > 0) > + memcpy(bo->optional_data, lo.optional_data, size); > + } > + > + while (1) { > + ret = eficonfig_show_boot_option(bo, header_str); > + if (ret == EFI_SUCCESS && bo->edit_completed) > + break; > + if (ret == EFI_NOT_READY) > + continue; > + if (ret != EFI_SUCCESS) > + goto out; > + } > + > + if (bo->initrd_info.dp_volume) { > + dp = create_selected_device_path(&bo->initrd_info); > + if (!dp) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + initrd_dp = efi_dp_append((const struct efi_device_path *)&id_dp, dp); > + efi_free_pool(dp); > + } > + > + dp = create_selected_device_path(&bo->file_info); > + if (!dp) { > + ret = EFI_OUT_OF_RESOURCES; > + goto out; > + } > + final_dp_size = efi_dp_size(dp) + sizeof(END); > + if (initrd_dp) { > + final_dp = efi_dp_concat(dp, initrd_dp); > + final_dp_size += efi_dp_size(initrd_dp) + sizeof(END); > + } else { > + final_dp = efi_dp_dup(dp); > + } > + efi_free_pool(dp); > + > + if (!final_dp) > + goto out; > + > + if (utf16_utf8_strlen(bo->optional_data)) { > + len = utf16_utf8_strlen(bo->optional_data) + 1; > + tmp = calloc(1, len); > + if (!tmp) > + goto out; > + p = tmp; > + utf16_utf8_strncpy(&p, bo->optional_data, u16_strlen(bo->optional_data)); > + } > + > + ret = eficonfig_set_boot_option(varname, final_dp, final_dp_size, bo->description, tmp); > + if (ret != EFI_SUCCESS) > + goto out; > +out: > + free(tmp); > + free(bo->optional_data); > + free(bo->description); > + free(bo->file_info.current_path); > + free(bo->initrd_info.current_path); > + efi_free_pool(device_dp); > + efi_free_pool(initrd_device_dp); > + efi_free_pool(initrd_dp); > + efi_free_pool(final_dp); > + > + return ret; > +} > + > +/** > + * eficonfig_process_add_boot_option() - handler to add boot option > + * > + * @data: pointer to the data for each entry > + * Return: status code > + */ > +static efi_status_t eficonfig_process_add_boot_option(void *data) > +{ > + u16 varname[9]; > + efi_status_t ret; > + struct eficonfig_boot_option *bo = NULL; > + > + bo = calloc(1, sizeof(struct eficonfig_boot_option)); > + if (!bo) > + return EFI_OUT_OF_RESOURCES; > + > + ret = eficonfig_get_unused_bootoption(varname, sizeof(varname), &bo->boot_index); > + if (ret != EFI_SUCCESS) > + return ret; > + > + ret = eficonfig_edit_boot_option(varname, bo, NULL, 0, " ** Add Boot Option ** "); > + if (ret != EFI_SUCCESS) > + goto out; > + > + ret = eficonfig_append_bootorder((u16)bo->boot_index); > + if (ret != EFI_SUCCESS) > + goto out; > + > +out: > + free(bo); > + > + /* to stay the parent menu */ > + ret = (ret == EFI_ABORTED) ? EFI_SUCCESS : ret; > + > + return ret; > +} > + > +/** > + * eficonfig_init() - do required initialization for eficonfig command > + * > + * Return: status code > + */ > +static efi_status_t eficonfig_init(void) > +{ > + efi_status_t ret = EFI_SUCCESS; > + static bool init; > + struct efi_handler *handler; > + > + if (!init) { > + ret = efi_search_protocol(efi_root, &efi_guid_text_input_protocol, &handler); > + if (ret != EFI_SUCCESS) > + return ret; > + > + ret = efi_protocol_open(handler, (void **)&cin, efi_root, NULL, > + EFI_OPEN_PROTOCOL_GET_PROTOCOL); > + if (ret != EFI_SUCCESS) > + return ret; > + } > + > + init = true; > + > + return ret; > +} > + > +static const struct eficonfig_item maintenance_menu_items[] = { > + {"Add Boot Option", eficonfig_process_add_boot_option}, > + {"Quit", eficonfig_process_quit}, > +}; > + > +/** > + * do_eficonfig() - execute `eficonfig` command > + * > + * @cmdtp: table entry describing command > + * @flag: bitmap indicating how the command was invoked > + * @argc: number of arguments > + * @argv: command line arguments > + * Return: status code > + */ > +static int do_eficonfig(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) > +{ > + efi_status_t ret; > + struct efimenu *efi_menu; > + > + if (argc > 1) > + return CMD_RET_USAGE; > + > + ret = efi_init_obj_list(); > + if (ret != EFI_SUCCESS) { > + log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n", > + ret & ~EFI_ERROR_MASK); > + > + return CMD_RET_FAILURE; > + } > + > + ret = eficonfig_init(); > + if (ret != EFI_SUCCESS) > + return CMD_RET_FAILURE; > + > + while (1) { > + efi_menu = eficonfig_create_fixed_menu(maintenance_menu_items, > + ARRAY_SIZE(maintenance_menu_items)); > + if (!efi_menu) > + return CMD_RET_FAILURE; > + > + ret = eficonfig_process_common(efi_menu, " ** UEFI Maintenance Menu **"); > + eficonfig_destroy(efi_menu); > + > + if (ret == EFI_ABORTED) > + break; > + } > + > + return CMD_RET_SUCCESS; > +} > + > +U_BOOT_CMD( > + eficonfig, 1, 0, do_eficonfig, > + "provide menu-driven UEFI variable maintenance interface", > + "" > +); > diff --git a/include/efi_config.h b/include/efi_config.h > new file mode 100644 > index 0000000000..ea5bc4e1bf > --- /dev/null > +++ b/include/efi_config.h > @@ -0,0 +1,96 @@ > +/* SPDX-License-Identifier: GPL-2.0+ */ > +/* > + * Menu-driven UEFI Variable maintenance > + * > + * Copyright (c) 2022 Masahisa Kojima, Linaro Limited > + */ > + > +#ifndef _EFI_CONFIG_H > +#define _EFI_CONFIG_H > + > +#include <efi_loader.h> > + > +#define EFICONFIG_ENTRY_NUM_MAX 99 > +#define EFICONFIG_FILE_PATH_MAX 512 > +#define EFICONFIG_FILE_PATH_BUF_SIZE (EFICONFIG_FILE_PATH_MAX * sizeof(u16)) > + > +typedef efi_status_t (*eficonfig_entry_func)(void *data); > + > +/** > + * struct eficonfig_entry - menu entry structure > + * > + * @num: menu entry index > + * @title: title of entry > + * @key: unique key > + * @efi_menu: pointer to the menu structure > + * @func: callback function to be called when this entry is selected > + * @data: data to be passed to the callback function, caller must free() this pointer > + * @list: list structure > + */ > +struct eficonfig_entry { > + u32 num; > + char *title; > + char key[3]; > + struct efimenu *efi_menu; > + eficonfig_entry_func func; > + void *data; > + struct list_head list; > +}; > + > +/** > + * struct efimenu - efi menu structure > + * > + * @delay: delay for autoboot > + * @active: active menu entry index > + * @count: total count of menu entry > + * @menu_header: menu header string > + * @list: menu entry list structure > + */ > +struct efimenu { > + int delay; > + int active; > + int count; > + char *menu_header; > + struct list_head list; > +}; > + > +/** > + * struct eficonfig_item - structure to construct eficonfig_entry > + * > + * @title: title of entry > + * @func: callback function to be called when this entry is selected > + * @data: data to be passed to the callback function > + */ > +struct eficonfig_item { > + char *title; > + eficonfig_entry_func func; > + void *data; > +}; > + > +/** > + * struct eficonfig_select_file_info - structure to be used for file selection > + * > + * @current_volume: pointer to the efi_simple_file_system_protocol > + * @dp_volume: pointer to device path of the selected device > + * @current_path: pointer to the selected file path string > + * @filepath_list: list_head structure for file path list > + * @file_selectred: flag indicates file selecting status > + */ > +struct eficonfig_select_file_info { > + struct efi_simple_file_system_protocol *current_volume; > + struct efi_device_path *dp_volume; > + u16 *current_path; > + struct list_head filepath_list; > + bool file_selected; > +}; > + > +void eficonfig_print_msg(char *msg); > +void eficonfig_destroy(struct efimenu *efi_menu); > +efi_status_t eficonfig_process_quit(void *data); > +efi_status_t eficonfig_process_common(struct efimenu *efi_menu, char *menu_header); > +efi_status_t eficonfig_select_file_handler(void *data); > +efi_status_t eficonfig_get_unused_bootoption(u16 *buf, > + efi_uintn_t buf_size, u32 *index); > +efi_status_t eficonfig_append_bootorder(u16 index); > + > +#endif > diff --git a/include/efi_loader.h b/include/efi_loader.h > index b0d6fff67c..4461f721e0 100644 > --- a/include/efi_loader.h > +++ b/include/efi_loader.h > @@ -142,6 +142,11 @@ static inline efi_status_t efi_launch_capsules(void) > EFI_GUID(0x63293792, 0xadf5, 0x9325, \ > 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e) > > +/* GUID for the auto generated boot menu entry */ > +#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \ > + EFI_GUID(0x38c1acc1, 0x9fc0, 0x41f0, \ > + 0xb9, 0x01, 0xfa, 0x74, 0xd6, 0xd6, 0xe4, 0xde) > + > /* Use internal device tree when starting UEFI application */ > #define EFI_FDT_USE_INTERNAL NULL > > @@ -226,6 +231,9 @@ const char *__efi_nesting_dec(void); > #define EFI_CACHELINE_SIZE 128 > #endif > > +/* max bootmenu title size for volume selection */ > +#define BOOTMENU_DEVICE_NAME_MAX 16 > + > /* Key identifying current memory map */ > extern efi_uintn_t efi_memory_map_key; > > @@ -249,6 +257,9 @@ extern const struct efi_hii_string_protocol efi_hii_string; > > uint16_t *efi_dp_str(struct efi_device_path *dp); > > +/* GUID for the auto generated boot menu entry */ > +extern const efi_guid_t efi_guid_bootmenu_auto_generated; > + > /* GUID of the U-Boot root node */ > extern const efi_guid_t efi_u_boot_guid; > #ifdef CONFIG_SANDBOX > @@ -314,6 +325,8 @@ extern const efi_guid_t efi_guid_firmware_management_protocol; > extern const efi_guid_t efi_esrt_guid; > /* GUID of the SMBIOS table */ > extern const efi_guid_t smbios_guid; > +/*GUID of console */ > +extern const efi_guid_t efi_guid_text_input_protocol; > > extern char __efi_runtime_start[], __efi_runtime_stop[]; > extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[]; > @@ -1064,4 +1077,28 @@ efi_status_t efi_esrt_populate(void); > efi_status_t efi_load_capsule_drivers(void); > > efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz); > + > +efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type, > + const efi_guid_t *protocol, void *search_key, > + efi_uintn_t *no_handles, efi_handle_t **buffer); > + > +efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this, > + struct efi_file_handle **root); > +efi_status_t efi_file_open_int(struct efi_file_handle *this, > + struct efi_file_handle **new_handle, > + u16 *file_name, u64 open_mode, > + u64 attributes); > +efi_status_t efi_file_close_int(struct efi_file_handle *file); > +efi_status_t efi_file_read_int(struct efi_file_handle *this, > + efi_uintn_t *buffer_size, void *buffer); > +efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos); > + > +typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key); > +efi_status_t efi_console_get_u16_string > + (struct efi_simple_text_input_protocol *cin, > + u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func, > + int row, int col); > + > +efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size); > + > #endif /* _EFI_LOADER_H */ > diff --git a/lib/efi_loader/efi_bootmgr.c b/lib/efi_loader/efi_bootmgr.c > index 234073ecb7..ede9116b3c 100644 > --- a/lib/efi_loader/efi_bootmgr.c > +++ b/lib/efi_loader/efi_bootmgr.c > @@ -19,6 +19,9 @@ > static const struct efi_boot_services *bs; > static const struct efi_runtime_services *rs; > > +const efi_guid_t efi_guid_bootmenu_auto_generated = > + EFICONFIG_AUTO_GENERATED_ENTRY_GUID; > + > /* > * bootmgr implements the logic of trying to find a payload to boot > * based on the BootOrder + BootXXXX variables, and then loading it. > diff --git a/lib/efi_loader/efi_boottime.c b/lib/efi_loader/efi_boottime.c > index 4da64b5d29..1233418e77 100644 > --- a/lib/efi_loader/efi_boottime.c > +++ b/lib/efi_loader/efi_boottime.c > @@ -2453,6 +2453,35 @@ static efi_status_t EFIAPI efi_protocols_per_handle( > return EFI_EXIT(EFI_SUCCESS); > } > > +efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type, > + const efi_guid_t *protocol, void *search_key, > + efi_uintn_t *no_handles, efi_handle_t **buffer) > +{ > + efi_status_t r; > + efi_uintn_t buffer_size = 0; > + > + if (!no_handles || !buffer) { > + r = EFI_INVALID_PARAMETER; > + goto out; > + } > + *no_handles = 0; > + *buffer = NULL; > + r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > + *buffer); > + if (r != EFI_BUFFER_TOO_SMALL) > + goto out; > + r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size, > + (void **)buffer); > + if (r != EFI_SUCCESS) > + goto out; > + r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > + *buffer); > + if (r == EFI_SUCCESS) > + *no_handles = buffer_size / sizeof(efi_handle_t); > +out: > + return r; > +} > + > /** > * efi_locate_handle_buffer() - locate handles implementing a protocol > * @search_type: selection criterion > @@ -2474,30 +2503,13 @@ efi_status_t EFIAPI efi_locate_handle_buffer( > efi_uintn_t *no_handles, efi_handle_t **buffer) > { > efi_status_t r; > - efi_uintn_t buffer_size = 0; > > EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key, > no_handles, buffer); > > - if (!no_handles || !buffer) { > - r = EFI_INVALID_PARAMETER; > - goto out; > - } > - *no_handles = 0; > - *buffer = NULL; > - r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > - *buffer); > - if (r != EFI_BUFFER_TOO_SMALL) > - goto out; > - r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size, > - (void **)buffer); > - if (r != EFI_SUCCESS) > - goto out; > - r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > - *buffer); > - if (r == EFI_SUCCESS) > - *no_handles = buffer_size / sizeof(efi_handle_t); > -out: > + r = efi_locate_handle_buffer_int(search_type, protocol, search_key, > + no_handles, buffer); > + > return EFI_EXIT(r); > } > > diff --git a/lib/efi_loader/efi_console.c b/lib/efi_loader/efi_console.c > index 3164fd484e..5be509f0d6 100644 > --- a/lib/efi_loader/efi_console.c > +++ b/lib/efi_loader/efi_console.c > @@ -7,6 +7,7 @@ > > #define LOG_CATEGORY LOGC_EFI > > +#include <ansi.h> > #include <common.h> > #include <charset.h> > #include <malloc.h> > @@ -1318,3 +1319,72 @@ out_of_memory: > printf("ERROR: Out of memory\n"); > return r; > } > + > +/** > + * efi_console_get_u16_string() - get user input string > + * > + * @cin: protocol interface to EFI_SIMPLE_TEXT_INPUT_PROTOCOL > + * @buf: buffer to store user input string in UTF16 > + * @count: number of u16 string including NULL terminator that buf has > + * @filter_func: callback to filter user input > + * @row: row number to locate user input form > + * @col: column number to locate user input form > + * Return: status code > + */ > +efi_status_t efi_console_get_u16_string(struct efi_simple_text_input_protocol *cin, > + u16 *buf, efi_uintn_t count, > + efi_console_filter_func filter_func, > + int row, int col) > +{ > + efi_status_t ret; > + efi_uintn_t len = 0; > + struct efi_input_key key; > + > + printf(ANSI_CURSOR_POSITION > + ANSI_CLEAR_LINE_TO_END > + ANSI_CURSOR_SHOW, row, col); > + > + ret = EFI_CALL(cin->reset(cin, false)); > + if (ret != EFI_SUCCESS) > + return ret; > + > + for (;;) { > + do { > + ret = EFI_CALL(cin->read_key_stroke(cin, &key)); > + mdelay(10); > + } while (ret == EFI_NOT_READY); > + > + if (key.unicode_char == u'\b') { > + if (len > 0) > + buf[--len] = u'\0'; > + > + printf(ANSI_CURSOR_POSITION > + "%ls" > + ANSI_CLEAR_LINE_TO_END, row, col, buf); > + continue; > + } else if (key.unicode_char == u'\r') { > + buf[len] = u'\0'; > + return EFI_SUCCESS; > + } else if (key.unicode_char == 0x3 || key.scan_code == 23) { > + return EFI_ABORTED; > + } else if (key.unicode_char < 0x20) { > + /* ignore control codes other than Ctrl+C, '\r' and '\b' */ > + continue; > + } else if (key.scan_code != 0) { > + /* only accept single ESC press for cancel */ > + continue; > + } > + > + if (filter_func) { > + if (filter_func(&key) != EFI_SUCCESS) > + continue; > + } > + > + if (len >= (count - 1)) > + continue; > + > + buf[len] = key.unicode_char; > + len++; > + printf(ANSI_CURSOR_POSITION "%ls", row, col, buf); > + } > +} > diff --git a/lib/efi_loader/efi_disk.c b/lib/efi_loader/efi_disk.c > index f269abf135..a34ca46a11 100644 > --- a/lib/efi_loader/efi_disk.c > +++ b/lib/efi_loader/efi_disk.c > @@ -760,3 +760,53 @@ efi_status_t efi_disk_init(void) > > return EFI_SUCCESS; > } > + > +/** > + * efi_disk_get_device_name() - get U-Boot device name associated with EFI handle > + * > + * @handle: pointer to the EFI handle > + * @buf: pointer to the buffer to store the string > + * @size: size of buffer > + * Return: status code > + */ > +efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size) > +{ > + int count; > + int diskid; > + enum uclass_id id; > + unsigned int part; > + struct udevice *dev; > + struct blk_desc *desc; > + const char *if_typename; > + bool is_partition = false; > + struct disk_part *part_data; > + > + if (!handle || !buf || !size) > + return EFI_INVALID_PARAMETER; > + > + dev = handle->dev; > + id = device_get_uclass_id(dev); > + if (id == UCLASS_BLK) { > + desc = dev_get_uclass_plat(dev); > + } else if (id == UCLASS_PARTITION) { > + desc = dev_get_uclass_plat(dev_get_parent(dev)); > + is_partition = true; > + } else { > + return EFI_INVALID_PARAMETER; > + } > + if_typename = blk_get_if_type_name(desc->if_type); > + diskid = desc->devnum; > + > + if (is_partition) { > + part_data = dev_get_uclass_plat(dev); > + part = part_data->partnum; > + count = snprintf(buf, size, "%s %d:%d", if_typename, diskid, part); > + } else { > + count = snprintf(buf, size, "%s %d", if_typename, diskid); > + } > + > + if (count < 0 || (count + 1) > size) > + return EFI_INVALID_PARAMETER; > + > + return EFI_SUCCESS; > +} > diff --git a/lib/efi_loader/efi_file.c b/lib/efi_loader/efi_file.c > index 7a7077e6d0..c96a7f7ca3 100644 > --- a/lib/efi_loader/efi_file.c > +++ b/lib/efi_loader/efi_file.c > @@ -246,10 +246,10 @@ error: > return NULL; > } > > -static efi_status_t efi_file_open_int(struct efi_file_handle *this, > - struct efi_file_handle **new_handle, > - u16 *file_name, u64 open_mode, > - u64 attributes) > +efi_status_t efi_file_open_int(struct efi_file_handle *this, > + struct efi_file_handle **new_handle, > + u16 *file_name, u64 open_mode, > + u64 attributes) > { > struct file_handle *fh = to_fh(this); > efi_status_t ret; > @@ -369,11 +369,17 @@ static efi_status_t file_close(struct file_handle *fh) > return EFI_SUCCESS; > } > > -static efi_status_t EFIAPI efi_file_close(struct efi_file_handle *file) > +efi_status_t efi_file_close_int(struct efi_file_handle *file) > { > struct file_handle *fh = to_fh(file); > + > + return file_close(fh); > +} > + > +static efi_status_t EFIAPI efi_file_close(struct efi_file_handle *file) > +{ > EFI_ENTRY("%p", file); > - return EFI_EXIT(file_close(fh)); > + return EFI_EXIT(efi_file_close_int(file)); > } > > static efi_status_t EFIAPI efi_file_delete(struct efi_file_handle *file) > @@ -562,8 +568,8 @@ static efi_status_t dir_read(struct file_handle *fh, u64 *buffer_size, > return EFI_SUCCESS; > } > > -static efi_status_t efi_file_read_int(struct efi_file_handle *this, > - efi_uintn_t *buffer_size, void *buffer) > +efi_status_t efi_file_read_int(struct efi_file_handle *this, > + efi_uintn_t *buffer_size, void *buffer) > { > struct file_handle *fh = to_fh(this); > efi_status_t ret = EFI_SUCCESS; > @@ -773,24 +779,11 @@ out: > return EFI_EXIT(ret); > } > > -/** > - * efi_file_setpos() - set current position in file > - * > - * This function implements the SetPosition service of the EFI file protocol. > - * See the UEFI spec for details. > - * > - * @file: file handle > - * @pos: new file position > - * Return: status code > - */ > -static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, > - u64 pos) > +efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos) > { > struct file_handle *fh = to_fh(file); > efi_status_t ret = EFI_SUCCESS; > > - EFI_ENTRY("%p, %llu", file, pos); > - > if (fh->isdir) { > if (pos != 0) { > ret = EFI_UNSUPPORTED; > @@ -812,6 +805,28 @@ static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, > fh->offset = pos; > > error: > + return ret; > +} > + > +/** > + * efi_file_setpos() - set current position in file > + * > + * This function implements the SetPosition service of the EFI file protocol. > + * See the UEFI spec for details. > + * > + * @file: file handle > + * @pos: new file position > + * Return: status code > + */ > +static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, > + u64 pos) > +{ > + efi_status_t ret = EFI_SUCCESS; > + > + EFI_ENTRY("%p, %llu", file, pos); > + > + ret = efi_file_setpos_int(file, pos); > + > return EFI_EXIT(ret); > } > > @@ -1138,17 +1153,23 @@ struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp) > return f; > } > > +efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this, > + struct efi_file_handle **root) > +{ > + struct file_system *fs = to_fs(this); > + > + *root = file_open(fs, NULL, NULL, 0, 0); > + > + return EFI_SUCCESS; > +} > + > static efi_status_t EFIAPI > efi_open_volume(struct efi_simple_file_system_protocol *this, > struct efi_file_handle **root) > { > - struct file_system *fs = to_fs(this); > - > EFI_ENTRY("%p, %p", this, root); > > - *root = file_open(fs, NULL, NULL, 0, 0); > - > - return EFI_EXIT(EFI_SUCCESS); > + return EFI_EXIT(efi_open_volume_int(this, root)); > } > > struct efi_simple_file_system_protocol *
Hi Heinrich, On Sun, 4 Sept 2022 at 18:05, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote: > > On 9/2/22 16:23, Masahisa Kojima wrote: > > This commit add the "eficonfig" command. > > The "eficonfig" command implements the menu-driven UEFI boot option > > maintenance feature. This commit implements the addition of > > new boot option. User can select the block device volume having > > efi_simple_file_system_protocol and select the file corresponding > > to the Boot#### variable. User can also enter the description and > > optional_data of the BOOT#### variable in utf8. > > > > This commit adds "include/efi_config.h", it contains the common > > definition to be used from other menus such as UEFI Secure Boot > > key management. > > > > Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org> > > --- > > Changes in v15: > > - moves the free(entry->data) outside the eficonfig_destroy() function and > > entry->data is freed explicitly only when needed > > - expose eficonfig_destroy() for succeeding secure boot key management patch > > > > Changes in v14: > > - fix the missing initialization > > - add comment for key handling > > > > No change in v13: > > > > Changes in v12: > > - add select/clear menu before displaying volume selectio > > - move function declaration from efi_loader.h to efi_config.h > > - remove unused declaration > > - support the boot option does not have file path > > - correctly handle if optional_data is empty > > > > Changes in v11: > > - refactor menu entry construction, directly use eficonfig_entry structure > > - remove reading directory info to calculate the number of entry > > - fix invalid efi_free_pool() in ill_file_info() > > - use ANSI_CURSOR_POSITION and ANSI_CLEAR_LINE instead of printf("\n") > > since current eficonfig implementation does not handle console size correctly. > > printf("\n") at the outside of console size breaks the console output. > > > > Changes in v10: > > - add initrd file selection > > - do refactoring > > - eficonfig_process_common() use list structure > > - remove u'/' before copying file_path into current_path > > - fix typos > > - check snprintf error > > > > Changes in v9: > > - move "efi_guid_bootmenu_auto_generated definition" into efi_bootmgr.c > > to address build error when CMD_EFICONFIG is disabled > > - fix typos and comment > > - remove file system information from error message > > - remove unreachable code in eficonfig_choice_entry() > > - single printf() call as much as possible > > - call only getchar() in eficonfig_print_msg() > > - filter out '.' entry from file selection > > - update the efi_disk_get_device_name() implementation > > - add function comment > > > > Changes in v8: > > - command name is change from "efimenu" to "eficonfig" > > - function and struct prefixes is changed to "eficonfig" > > - fix menu header string > > > > Changes in v7: > > - add "efimenu" command and uefi variable maintenance code > > moved into cmd/efimenu.c > > - create include/efimenu.h to define the common definition for > > the other menu such as UEFI Secure Boot key management > > - update boot option edit UI, user can select description, file, > > and optional_data to edit in the same menu like following. > > > > ** Edit Boot Option ** > > > > Description: debian > > File: virtio 0:1/EFI\debian\grubaa64.efi > > Optional Data: test > > Save > > Quit > > > > - remove exit parameter from efimenu_process_common() > > - menu title type is changed from u16 to char > > - efimenu_process_common() add menu title string > > - reduce printf/puts function call for displaying the menu > > - efi_console_get_u16_string() accept 0 length to allow > > optional_data is empty > > - efi_console_get_u16_string() the "size" parameter name is changes to "count" > > - efimenu is now designed to maintain the UEFI variables, remove autoboot related code > > - remove one empty line before "Quit" entry > > - efimenu_init() processes only the first time > > > > Changes in v6: > > - fix typos > > - modify volume name to match U-Boot syntax > > - compile in CONFIG_EFI_LOADER=n and CONFIG_CMD_BOOTEFI_BOOTMGR=n > > - simplify u16_strncmp() usage > > - support "a\b.efi" file path, use link list to handle filepath > > - modify length check condition > > - UEFI related menu items only appears with CONFIG_AUTOBOOT_MENU_SHOW=y > > > > Changes in v5: > > - remove forward declarations > > - add const qualifier for menu items > > - fix the possible unaligned access for directory info access > > - split into three commit 1)add boot option 2) delete boot option 3)change boot order > > This commit is 1)add boot option. > > - fix file name buffer allocation size, it should be EFI_BOOTMENU_FILE_PATH_MAX * sizeof(u16) > > - fix wrong size checking for file selection > > > > Chanes in v4: > > - UEFI boot option maintenance menu is integrated into bootmenu > > - display the simplified volume name(e.g. usb0:1, nvme1:2) for the > > volume selection > > - instead of extending lib/efi_loader/efi_bootmgr.c, newly create > > lib/efi_loader/efi_bootmenu_maintenance.c and implement boot > > variable maintenance into it. > > > > Changes in RFC v3: > > not included in v3 series > > > > Changes in RFC v2: > > - enable utf8 user input for boot option name > > - create lib/efi_loader/efi_console.c::efi_console_get_u16_string() for > > utf8 user input handling > > - use u16_strlcat instead of u16_strcat > > - remove the EFI_CALLs, and newly create or expose the following > > xxx_int() functions. > > efi_locate_handle_buffer_int(), efi_open_volume_int(), > > efi_file_open_int(), efi_file_close_int(), efi_file_read_int() and > > efi_file_setpos_int(). > > Note that EFI_CALLs still exist for EFI_DEVICE_PATH_TO_TEXT_PROTOCOL > > and EFI_SIMPLE_TEXT_INPUT/OUTPUT_PROTOCOL > > - use efi_search_protocol() instead of calling locate_protocol() to get > > the device_path_to_text_protocol interface. > > - remove unnecessary puts(ANSI_CLEAR_LINE), this patch is still depends on > > puts(ANSI_CLEAR_CONSOLE) > > - skip SetVariable() if the bootorder is not changed > > > > cmd/Kconfig | 7 + > > cmd/Makefile | 1 + > > cmd/eficonfig.c | 1568 +++++++++++++++++++++++++++++++++ > > include/efi_config.h | 96 ++ > > include/efi_loader.h | 37 + > > lib/efi_loader/efi_bootmgr.c | 3 + > > lib/efi_loader/efi_boottime.c | 52 +- > > lib/efi_loader/efi_console.c | 70 ++ > > lib/efi_loader/efi_disk.c | 50 ++ > > lib/efi_loader/efi_file.c | 75 +- > > 10 files changed, 1912 insertions(+), 47 deletions(-) > > create mode 100644 cmd/eficonfig.c > > create mode 100644 include/efi_config.h > > > > diff --git a/cmd/Kconfig b/cmd/Kconfig > > index 211ebe9c87..a1e8613c56 100644 > > --- a/cmd/Kconfig > > +++ b/cmd/Kconfig > > @@ -1928,6 +1928,13 @@ config CMD_EFIDEBUG > > particularly for managing boot parameters as well as examining > > various EFI status for debugging. > > > > +config CMD_EFICONFIG > > + bool "eficonfig - provide menu-driven uefi variables maintenance interface" > > + depends on CMD_BOOTEFI_BOOTMGR > > + help > > + Enable the 'eficonfig' command which provides the menu-driven UEFI > > + variable maintenance interface. > > + > > config CMD_EXCEPTION > > bool "exception - raise exception" > > depends on ARM || RISCV || SANDBOX || X86 > > diff --git a/cmd/Makefile b/cmd/Makefile > > index 6e87522b62..18f5cb890d 100644 > > --- a/cmd/Makefile > > +++ b/cmd/Makefile > > @@ -63,6 +63,7 @@ obj-$(CONFIG_ENV_IS_IN_EEPROM) += eeprom.o > > obj-$(CONFIG_CMD_EEPROM) += eeprom.o > > obj-$(CONFIG_EFI) += efi.o > > obj-$(CONFIG_CMD_EFIDEBUG) += efidebug.o > > +obj-$(CONFIG_CMD_EFICONFIG) += eficonfig.o > > obj-$(CONFIG_CMD_ELF) += elf.o > > obj-$(CONFIG_CMD_EROFS) += erofs.o > > obj-$(CONFIG_HUSH_PARSER) += exit.o > > diff --git a/cmd/eficonfig.c b/cmd/eficonfig.c > > new file mode 100644 > > index 0000000000..30ce55d055 > > --- /dev/null > > +++ b/cmd/eficonfig.c > > @@ -0,0 +1,1568 @@ > > +// SPDX-License-Identifier: GPL-2.0+ > > +/* > > + * Menu-driven UEFI Variable maintenance > > + * > > + * Copyright (c) 2022 Masahisa Kojima, Linaro Limited > > + */ > > + > > +#include <ansi.h> > > +#include <common.h> > > +#include <charset.h> > > +#include <efi_loader.h> > > +#include <efi_load_initrd.h> > > +#include <efi_config.h> > > +#include <efi_variable.h> > > +#include <log.h> > > +#include <malloc.h> > > +#include <menu.h> > > +#include <watchdog.h> > > +#include <asm/unaligned.h> > > +#include <linux/delay.h> > > + > > +static struct efi_simple_text_input_protocol *cin; > > + > > +#define EFICONFIG_DESCRIPTION_MAX 32 > > +#define EFICONFIG_OPTIONAL_DATA_MAX 64 > > + > > +/** > > + * struct eficonfig_filepath_info - structure to be used to store file path > > + * > > + * @name: file or directory name > > + * @list: list structure > > + */ > > +struct eficonfig_filepath_info { > > + u16 *name; > > + struct list_head list; > > +}; > > + > > +/** > > + * struct eficonfig_boot_option - structure to be used for updating UEFI boot option > > + * > > + * @file_info: user selected file info > > + * @initrd_info: user selected initrd file info > > + * @boot_index: index of the boot option > > + * @description: pointer to the description string > > + * @optional_data: pointer to the optional_data > > + * @edit_completed: flag indicates edit complete > > + */ > > +struct eficonfig_boot_option { > > + struct eficonfig_select_file_info file_info; > > + struct eficonfig_select_file_info initrd_info; > > + unsigned int boot_index; > > + u16 *description; > > + u16 *optional_data; > > + bool edit_completed; > > +}; > > + > > +/** > > + * struct eficonfig_volume_entry_data - structure to be used to store volume info > > + *` > > + * @file_info: pointer to file info structure > > + * @v: pointer to the protocol interface > > + * @dp: pointer to the device path > > + */ > > +struct eficonfig_volume_entry_data { > > + struct eficonfig_select_file_info *file_info; > > + struct efi_simple_file_system_protocol *v; > > + struct efi_device_path *dp; > > +}; > > + > > +/** > > + * struct eficonfig_file_entry_data - structure to be used to store file info > > + * > > + * @file_info: pointer to file info structure > > + * @is_directory: flag to identify the directory or file > > + * @file_name: name of directory or file > > + */ > > +struct eficonfig_file_entry_data { > > + struct eficonfig_select_file_info *file_info; > > + bool is_directory; > > + u16 *file_name; > > +}; > > + > > +/** > > + * eficonfig_print_msg() - print message > > + * > > + * display the message to the user, user proceeds the screen > > + * with any key press. > > + * > > + * @items: pointer to the structure of each menu entry > > + * @count: the number of menu entry > > + * @menu_header: pointer to the menu header string > > + * Return: status code > > + */ > > +void eficonfig_print_msg(char *msg) > > +{ > > + /* Flush input */ > > + while (tstc()) > > + getchar(); > > + > > + printf(ANSI_CURSOR_HIDE > > + ANSI_CLEAR_CONSOLE > > + ANSI_CURSOR_POSITION > > + "%s\n\n Press any key to continue", 3, 4, msg); > > + > > + getchar(); > > +} > > + > > +/** > > + * eficonfig_print_entry() - print each menu entry > > + * > > + * @data: pointer to the data associated with each menu entry > > + */ > > +static void eficonfig_print_entry(void *data) > > +{ > > + struct eficonfig_entry *entry = data; > > + int reverse = (entry->efi_menu->active == entry->num); > > + > > + /* TODO: support scroll or page for many entries */ > > + > > + /* > > + * Move cursor to line where the entry will be drawn (entry->num) > > + * First 3 lines(menu header) + 1 empty line > > + */ > > + printf(ANSI_CURSOR_POSITION, entry->num + 4, 7); > > + > > + if (reverse) > > + puts(ANSI_COLOR_REVERSE); > > + > > + printf("%s", entry->title); > > + > > + if (reverse) > > + puts(ANSI_COLOR_RESET); > > +} > > + > > +/** > > + * eficonfig_display_statusline() - print status line > > + * > > + * @m: pointer to the menu structure > > + */ > > +static void eficonfig_display_statusline(struct menu *m) > > +{ > > + struct eficonfig_entry *entry; > > + > > + if (menu_default_choice(m, (void *)&entry) < 0) > > + return; > > + > > + printf(ANSI_CURSOR_POSITION > > + "\n%s\n" > > + ANSI_CURSOR_POSITION ANSI_CLEAR_LINE ANSI_CURSOR_POSITION > > + " Press UP/DOWN to move, ENTER to select, ESC/CTRL+C to quit" > > + ANSI_CLEAR_LINE_TO_END ANSI_CURSOR_POSITION ANSI_CLEAR_LINE, > > + 1, 1, entry->efi_menu->menu_header, entry->efi_menu->count + 5, 1, > > + entry->efi_menu->count + 6, 1, entry->efi_menu->count + 7, 1); > > +} > > + > > +/** > > + * eficonfig_choice_entry() - user key input handler > > + * > > + * @data: pointer to the efimenu structure > > + * Return: key string to identify the selected entry > > + */ > > +static char *eficonfig_choice_entry(void *data) > > +{ > > + int esc = 0; > > + struct list_head *pos, *n; > > + struct eficonfig_entry *entry; > > + enum bootmenu_key key = KEY_NONE; > > + struct efimenu *efi_menu = data; > > + > > + while (1) { > > + bootmenu_loop((struct bootmenu_data *)efi_menu, &key, &esc); > > + > > + switch (key) { > > + case KEY_UP: > > + if (efi_menu->active > 0) > > + --efi_menu->active; > > + /* no menu key selected, regenerate menu */ > > + return NULL; > > + case KEY_DOWN: > > + if (efi_menu->active < efi_menu->count - 1) > > + ++efi_menu->active; > > + /* no menu key selected, regenerate menu */ > > + return NULL; > > + case KEY_SELECT: > > + list_for_each_safe(pos, n, &efi_menu->list) { > > + entry = list_entry(pos, struct eficonfig_entry, list); > > + if (entry->num == efi_menu->active) > > + return entry->key; > > + } > > + break; > > + case KEY_QUIT: > > + /* Quit by choosing the last entry */ > > + entry = list_last_entry(&efi_menu->list, struct eficonfig_entry, list); > > + return entry->key; > > + default: > > + /* Pressed key is not valid, no need to regenerate the menu */ > > + break; > > + } > > + } > > +} > > + > > +/** > > + * eficonfig_destroy() - destroy efimenu > > + * > > + * @efi_menu: pointer to the efimenu structure > > + */ > > +void eficonfig_destroy(struct efimenu *efi_menu) > > +{ > > + struct list_head *pos, *n; > > + struct eficonfig_entry *entry; > > + > > + list_for_each_safe(pos, n, &efi_menu->list) { > > + entry = list_entry(pos, struct eficonfig_entry, list); > > + free(entry->title); > > + list_del(&entry->list); > > + free(entry); > > + } > > + free(efi_menu->menu_header); > > + free(efi_menu); > > +} > > + > > +/** > > + * eficonfig_process_quit() - callback function for "Quit" entry > > + * > > + * @data: pointer to the data > > + * Return: status code > > + */ > > +efi_status_t eficonfig_process_quit(void *data) > > +{ > > + return EFI_ABORTED; > > +} > > + > > +/** > > + * append_entry() - append menu item > > + * > > + * @efi_menu: pointer to the efimenu structure > > + * @title: pointer to the entry title > > + * @func: callback of each entry > > + * @data: pointer to the data to be passed to each entry callback > > + * Return: status code > > + */ > > +static efi_status_t append_entry(struct efimenu *efi_menu, > > + char *title, eficonfig_entry_func func, void *data) > > +{ > > + struct eficonfig_entry *entry; > > + > > + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX) > > + return EFI_OUT_OF_RESOURCES; > > + > > + entry = calloc(1, sizeof(struct eficonfig_entry)); > > + if (!entry) > > + return EFI_OUT_OF_RESOURCES; > > + > > + entry->title = title; > > + sprintf(entry->key, "%d", efi_menu->count); > > + entry->efi_menu = efi_menu; > > + entry->func = func; > > + entry->data = data; > > + entry->num = efi_menu->count++; > > + list_add_tail(&entry->list, &efi_menu->list); > > + > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + * append_quit_entry() - append quit entry > > + * > > + * @efi_menu: pointer to the efimenu structure > > + * Return: status code > > + */ > > +static efi_status_t append_quit_entry(struct efimenu *efi_menu) > > +{ > > + char *title; > > + efi_status_t ret; > > + > > + title = strdup("Quit"); > > + if (!title) > > + return EFI_OUT_OF_RESOURCES; > > + > > + ret = append_entry(efi_menu, title, eficonfig_process_quit, NULL); > > + if (ret != EFI_SUCCESS) > > + free(title); > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_create_fixed_menu() - create fixed entry menu structure > > + * > > + * @items: pointer to the menu entry item > > + * @count: the number of menu entry > > + * Return: pointer to the efimenu structure > > + */ > > +void *eficonfig_create_fixed_menu(const struct eficonfig_item *items, int count) > > +{ > > + u32 i; > > + char *title; > > + efi_status_t ret; > > + struct efimenu *efi_menu; > > + const struct eficonfig_item *iter = items; > > + > > + efi_menu = calloc(1, sizeof(struct efimenu)); > > + if (!efi_menu) > > + return NULL; > > + > > + INIT_LIST_HEAD(&efi_menu->list); > > + for (i = 0; i < count; i++, iter++) { > > + title = strdup(iter->title); > > + if (!title) > > + goto out; > > + > > + ret = append_entry(efi_menu, title, iter->func, iter->data); > > + if (ret != EFI_SUCCESS) { > > + free(title); > > + goto out; > > + } > > + } > > + > > + return efi_menu; > > +out: > > + eficonfig_destroy(efi_menu); > > + > > + return NULL; > > +} > > + > > +/** > > + * eficonfig_process_common() - main handler for UEFI menu > > + * > > + * Construct the structures required to show the menu, then handle > > + * the user input interacting with u-boot menu functions. > > + * > > + * @efi_menu: pointer to the efimenu structure > > + * @menu_header: pointer to the menu header string > > + * Return: status code > > + */ > > +efi_status_t eficonfig_process_common(struct efimenu *efi_menu, char *menu_header) > > +{ > > + struct menu *menu; > > + void *choice = NULL; > > + struct list_head *pos, *n; > > + struct eficonfig_entry *entry; > > + efi_status_t ret = EFI_SUCCESS; > > + > > + if (efi_menu->count > EFICONFIG_ENTRY_NUM_MAX) > > + return EFI_OUT_OF_RESOURCES; > > + > > + efi_menu->delay = -1; > > + efi_menu->active = 0; > > + > > + if (menu_header) { > > + efi_menu->menu_header = strdup(menu_header); > > This does not build: I will fix the issue. Thanks, Masahisa Kojima > > +cmd/eficonfig.c:380:7: error: variable 'menu' is used uninitialized > whenever 'if' condition is true [-Werror,-Wsometimes-uninitialized] > + if (!efi_menu->menu_header) { > + ^~~~~~~~~~~~~~~~~~~~~~ > +cmd/eficonfig.c:416:15: note: uninitialized use occurs here > + menu_destroy(menu); > + ^~~~ > +cmd/eficonfig.c:380:3: note: remove the 'if' if its condition is always > false > + ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > +cmd/eficonfig.c:366:19: note: initialize the variable 'menu' to silence > this warning > + struct menu *menu; > + ^ > + = NULL > > Best regards > > Heinrich > > > + if (!efi_menu->menu_header) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + } > > + > > + menu = menu_create(NULL, 0, 1, eficonfig_display_statusline, > > + eficonfig_print_entry, eficonfig_choice_entry, > > + efi_menu); > > + if (!menu) { > > + ret = EFI_INVALID_PARAMETER; > > + goto out; > > + } > > + > > + list_for_each_safe(pos, n, &efi_menu->list) { > > + entry = list_entry(pos, struct eficonfig_entry, list); > > + if (!menu_item_add(menu, entry->key, entry)) { > > + ret = EFI_INVALID_PARAMETER; > > + goto out; > > + } > > + } > > + > > + entry = list_first_entry_or_null(&efi_menu->list, struct eficonfig_entry, list); > > + if (entry) > > + menu_default_set(menu, entry->key); > > + > > + printf(ANSI_CURSOR_HIDE > > + ANSI_CLEAR_CONSOLE > > + ANSI_CURSOR_POSITION, 1, 1); > > + > > + if (menu_get_choice(menu, &choice)) { > > + entry = choice; > > + if (entry->func) > > + ret = entry->func(entry->data); > > + } > > +out: > > + menu_destroy(menu); > > + > > + printf(ANSI_CLEAR_CONSOLE > > + ANSI_CURSOR_POSITION > > + ANSI_CURSOR_SHOW, 1, 1); > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_volume_selected() - handler of volume selection > > + * > > + * @data: pointer to the data of selected entry > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_volume_selected(void *data) > > +{ > > + struct eficonfig_volume_entry_data *info = data; > > + > > + if (info) { > > + info->file_info->current_volume = info->v; > > + info->file_info->dp_volume = info->dp; > > + } > > + > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + * create_selected_device_path() - create device path > > + * > > + * @file_info: pointer to the selected file information > > + * Return: > > + * device path or NULL. Caller must free the returned value > > + */ > > +static > > +struct efi_device_path *create_selected_device_path(struct eficonfig_select_file_info *file_info) > > +{ > > + char *p; > > + void *buf; > > + efi_uintn_t fp_size; > > + struct efi_device_path *dp; > > + struct efi_device_path_file_path *fp; > > + > > + fp_size = sizeof(struct efi_device_path) + > > + ((u16_strlen(file_info->current_path) + 1) * sizeof(u16)); > > + buf = calloc(1, fp_size + sizeof(END)); > > + if (!buf) > > + return NULL; > > + > > + fp = buf; > > + fp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, > > + fp->dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, > > + fp->dp.length = (u16)fp_size; > > + u16_strcpy(fp->str, file_info->current_path); > > + > > + p = buf; > > + p += fp_size; > > + *((struct efi_device_path *)p) = END; > > + > > + dp = efi_dp_append(file_info->dp_volume, (struct efi_device_path *)buf); > > + free(buf); > > + > > + return dp; > > +} > > + > > +/** > > + * eficonfig_file_selected() - handler of file selection > > + * > > + * @data: pointer to the data of selected entry > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_file_selected(void *data) > > +{ > > + struct eficonfig_file_entry_data *info = data; > > + > > + if (!info) > > + return EFI_INVALID_PARAMETER; > > + > > + if (u16_strcmp(info->file_name, u".") == 0 && > > + u16_strlen(info->file_name) == 1) { > > + /* stay current path */ > > + } else if (u16_strcmp(info->file_name, u"..") == 0 && > > + u16_strlen(info->file_name) == 2) { > > + struct eficonfig_filepath_info *iter; > > + struct list_head *pos, *n; > > + int is_last; > > + > > + memset(info->file_info->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE); > > + list_for_each_safe(pos, n, &info->file_info->filepath_list) { > > + iter = list_entry(pos, struct eficonfig_filepath_info, list); > > + > > + is_last = list_is_last(&iter->list, &info->file_info->filepath_list); > > + if (is_last) { > > + list_del(&iter->list); > > + free(iter->name); > > + free(iter); > > + break; > > + } > > + u16_strlcat(info->file_info->current_path, iter->name, > > + EFICONFIG_FILE_PATH_MAX); > > + u16_strlcat(info->file_info->current_path, u"\\", > > + EFICONFIG_FILE_PATH_MAX); > > + } > > + } else { > > + size_t new_len; > > + struct eficonfig_filepath_info *filepath; > > + > > + new_len = u16_strlen(info->file_info->current_path) + > > + u16_strlen(info->file_name); > > + if (new_len >= EFICONFIG_FILE_PATH_MAX) { > > + eficonfig_print_msg("File path is too long!"); > > + return EFI_INVALID_PARAMETER; > > + } > > + u16_strlcat(info->file_info->current_path, info->file_name, > > + EFICONFIG_FILE_PATH_MAX); > > + > > + filepath = calloc(1, sizeof(struct eficonfig_filepath_info)); > > + if (!filepath) > > + return EFI_OUT_OF_RESOURCES; > > + > > + filepath->name = u16_strdup(info->file_name); > > + if (!filepath->name) { > > + free(filepath); > > + return EFI_OUT_OF_RESOURCES; > > + } > > + list_add_tail(&filepath->list, &info->file_info->filepath_list); > > + > > + if (info->is_directory) { > > + /* > > + * Remaining buffer should have enough space to contain u"\\" and > > + * at least one character for file name > > + */ > > + if (new_len + 2 >= EFICONFIG_FILE_PATH_MAX) { > > + eficonfig_print_msg("Directory path is too long!"); > > + return EFI_INVALID_PARAMETER; > > + } > > + u16_strlcat(info->file_info->current_path, u"\\", > > + EFICONFIG_FILE_PATH_MAX); > > + } else { > > + info->file_info->file_selected = true; > > + } > > + } > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + * eficonfig_select_volume() - construct the volume selection menu > > + * > > + * @file_info: pointer to the file selection structure > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_select_volume(struct eficonfig_select_file_info *file_info) > > +{ > > + u32 i; > > + efi_status_t ret; > > + efi_uintn_t count; > > + struct efimenu *efi_menu; > > + struct list_head *pos, *n; > > + struct efi_handler *handler; > > + struct eficonfig_entry *entry; > > + struct efi_device_path *device_path; > > + efi_handle_t *volume_handles = NULL; > > + struct efi_simple_file_system_protocol *v; > > + > > + ret = efi_locate_handle_buffer_int(BY_PROTOCOL, &efi_simple_file_system_protocol_guid, > > + NULL, &count, (efi_handle_t **)&volume_handles); > > + if (ret != EFI_SUCCESS) { > > + eficonfig_print_msg("No block device found!"); > > + return ret; > > + } > > + > > + efi_menu = calloc(1, sizeof(struct efimenu)); > > + if (!efi_menu) > > + return EFI_OUT_OF_RESOURCES; > > + > > + INIT_LIST_HEAD(&efi_menu->list); > > + for (i = 0; i < count; i++) { > > + char *devname; > > + struct efi_block_io *block_io; > > + struct eficonfig_volume_entry_data *info; > > + > > + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1) > > + break; > > + > > + ret = efi_search_protocol(volume_handles[i], > > + &efi_simple_file_system_protocol_guid, &handler); > > + if (ret != EFI_SUCCESS) > > + continue; > > + ret = efi_protocol_open(handler, (void **)&v, efi_root, NULL, > > + EFI_OPEN_PROTOCOL_GET_PROTOCOL); > > + if (ret != EFI_SUCCESS) > > + continue; > > + > > + ret = efi_search_protocol(volume_handles[i], &efi_guid_device_path, &handler); > > + if (ret != EFI_SUCCESS) > > + continue; > > + ret = efi_protocol_open(handler, (void **)&device_path, > > + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); > > + if (ret != EFI_SUCCESS) > > + continue; > > + > > + ret = efi_search_protocol(volume_handles[i], &efi_block_io_guid, &handler); > > + if (ret != EFI_SUCCESS) > > + continue; > > + ret = efi_protocol_open(handler, (void **)&block_io, > > + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); > > + if (ret != EFI_SUCCESS) > > + continue; > > + > > + info = calloc(1, sizeof(struct eficonfig_volume_entry_data)); > > + if (!info) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + > > + devname = calloc(1, BOOTMENU_DEVICE_NAME_MAX); > > + if (!devname) { > > + free(info); > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + ret = efi_disk_get_device_name(volume_handles[i], devname, > > + BOOTMENU_DEVICE_NAME_MAX); > > + if (ret != EFI_SUCCESS) { > > + free(info); > > + goto out; > > + } > > + > > + info->v = v; > > + info->dp = device_path; > > + info->file_info = file_info; > > + ret = append_entry(efi_menu, devname, eficonfig_volume_selected, info); > > + if (ret != EFI_SUCCESS) { > > + free(info); > > + goto out; > > + } > > + } > > + > > + ret = append_quit_entry(efi_menu); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = eficonfig_process_common(efi_menu, " ** Select Volume **"); > > +out: > > + efi_free_pool(volume_handles); > > + list_for_each_safe(pos, n, &efi_menu->list) { > > + entry = list_entry(pos, struct eficonfig_entry, list); > > + free(entry->data); > > + } > > + eficonfig_destroy(efi_menu); > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_select_file() - construct the file selection menu > > + * > > + * @file_info: pointer to the file selection structure > > + * @root: pointer to the file handle > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_select_file(struct eficonfig_select_file_info *file_info, > > + struct efi_file_handle *root) > > +{ > > + efi_uintn_t len; > > + efi_status_t ret; > > + struct efimenu *efi_menu; > > + struct efi_file_handle *f; > > + struct efi_file_info *buf; > > + struct list_head *pos, *n; > > + > > + buf = calloc(1, sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE); > > + if (!buf) > > + return EFI_OUT_OF_RESOURCES; > > + > > + while (!file_info->file_selected) { > > + efi_menu = calloc(1, sizeof(struct efimenu)); > > + if (!efi_menu) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + INIT_LIST_HEAD(&efi_menu->list); > > + > > + ret = efi_file_open_int(root, &f, file_info->current_path, EFI_FILE_MODE_READ, 0); > > + if (ret != EFI_SUCCESS) { > > + eficonfig_print_msg("Reading volume failed!"); > > + ret = EFI_ABORTED; > > + goto out; > > + } > > + > > + /* Read directory and construct menu structure */ > > + for (;;) { > > + char *name, *p; > > + int name_len; > > + struct eficonfig_file_entry_data *info; > > + > > + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1) > > + break; > > + > > + len = sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE; > > + ret = efi_file_read_int(f, &len, buf); > > + if (ret != EFI_SUCCESS || len == 0) > > + break; > > + > > + info = calloc(1, sizeof(struct eficonfig_file_entry_data)); > > + if (!info) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto err; > > + } > > + > > + if (buf->attribute & EFI_FILE_DIRECTORY) { > > + /* append u'/' at the end of directory name */ > > + name_len = utf16_utf8_strlen(buf->file_name) + 2; > > + > > + /* filter out u'.' */ > > + if (name_len == 3 && buf->file_name[0] == u'.') { > > + free(info); > > + continue; > > + } > > + > > + name = calloc(1, name_len); > > + if (!name) { > > + free(info); > > + ret = EFI_OUT_OF_RESOURCES; > > + goto err; > > + } > > + p = name; > > + utf16_utf8_strcpy(&p, buf->file_name); > > + name[u16_strlen(buf->file_name)] = u'/'; > > + > > + info->is_directory = true; > > + } else { > > + name_len = utf16_utf8_strlen(buf->file_name) + 1; > > + name = calloc(1, name_len); > > + if (!name) { > > + free(info); > > + ret = EFI_OUT_OF_RESOURCES; > > + goto err; > > + } > > + p = name; > > + utf16_utf8_strcpy(&p, buf->file_name); > > + } > > + > > + info->file_name = u16_strdup(buf->file_name); > > + if (!info->file_name) { > > + free(info); > > + free(name); > > + ret = EFI_OUT_OF_RESOURCES; > > + goto err; > > + } > > + > > + info->file_info = file_info; > > + ret = append_entry(efi_menu, name, eficonfig_file_selected, info); > > + if (ret != EFI_SUCCESS) { > > + free(info); > > + free(name); > > + goto err; > > + } > > + } > > + > > + ret = append_quit_entry(efi_menu); > > + if (ret != EFI_SUCCESS) > > + goto err; > > + > > + ret = eficonfig_process_common(efi_menu, " ** Select File **"); > > +err: > > + efi_file_close_int(f); > > + list_for_each_safe(pos, n, &efi_menu->list) { > > + struct eficonfig_entry *entry; > > + > > + entry = list_entry(pos, struct eficonfig_entry, list); > > + /* skip "Quit" */ > > + if (list_is_last(&entry->list, &efi_menu->list)) > > + break; > > + > > + free(((struct eficonfig_file_entry_data *)(entry->data))->file_name); > > + free(entry->data); > > + } > > + eficonfig_destroy(efi_menu); > > + if (ret != EFI_SUCCESS) > > + break; > > + } > > + > > +out: > > + free(buf); > > + return ret; > > +} > > + > > +/** > > + * handle_user_input() - handle user input > > + * > > + * @buf: pointer to the buffer > > + * @buf_size: size of the buffer > > + * @cursor_col: cursor column for user input > > + * @msg: pointer to the string to display > > + * Return: status code > > + */ > > +static efi_status_t handle_user_input(u16 *buf, int buf_size, > > + int cursor_col, char *msg) > > +{ > > + u16 *tmp; > > + efi_status_t ret; > > + > > + printf(ANSI_CLEAR_CONSOLE > > + ANSI_CURSOR_POSITION > > + "%s" > > + ANSI_CURSOR_POSITION > > + " Press ENTER to complete, ESC/CTRL+C to quit", > > + 0, 1, msg, 8, 1); > > + > > + /* tmp is used to accept user cancel */ > > + tmp = calloc(1, buf_size * sizeof(u16)); > > + if (!tmp) > > + return EFI_OUT_OF_RESOURCES; > > + > > + ret = efi_console_get_u16_string(cin, tmp, buf_size, NULL, 4, cursor_col); > > + if (ret == EFI_SUCCESS) > > + u16_strcpy(buf, tmp); > > + > > + free(tmp); > > + > > + /* to stay the parent menu */ > > + ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret; > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_boot_add_enter_description() - handle user input for description > > + * > > + * @data: pointer to the internal boot option structure > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_boot_add_enter_description(void *data) > > +{ > > + struct eficonfig_boot_option *bo = data; > > + > > + return handle_user_input(bo->description, EFICONFIG_DESCRIPTION_MAX, 22, > > + "\n ** Edit Description **\n" > > + "\n" > > + " enter description: "); > > +} > > + > > +/** > > + * eficonfig_boot_add_optional_data() - handle user input for optional data > > + * > > + * @data: pointer to the internal boot option structure > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_boot_add_optional_data(void *data) > > +{ > > + struct eficonfig_boot_option *bo = data; > > + > > + return handle_user_input(bo->optional_data, EFICONFIG_OPTIONAL_DATA_MAX, 24, > > + "\n ** Edit Optional Data **\n" > > + "\n" > > + " enter optional data:"); > > +} > > + > > +/** > > + * eficonfig_boot_edit_save() - handler to save the boot option > > + * > > + * @data: pointer to the internal boot option structure > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_boot_edit_save(void *data) > > +{ > > + struct eficonfig_boot_option *bo = data; > > + > > + if (u16_strlen(bo->description) == 0) { > > + eficonfig_print_msg("Boot Description is empty!"); > > + bo->edit_completed = false; > > + return EFI_NOT_READY; > > + } > > + if (u16_strlen(bo->file_info.current_path) == 0) { > > + eficonfig_print_msg("File is not selected!"); > > + bo->edit_completed = false; > > + return EFI_NOT_READY; > > + } > > + > > + bo->edit_completed = true; > > + > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + * eficonfig_process_select_file() - callback function for "Select File" entry > > + * > > + * @data: pointer to the data > > + * Return: status code > > + */ > > +efi_status_t eficonfig_process_select_file(void *data) > > +{ > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + * eficonfig_process_clear_file_selection() - callback function for "Clear" entry > > + * > > + * @data: pointer to the data > > + * Return: status code > > + */ > > +efi_status_t eficonfig_process_clear_file_selection(void *data) > > +{ > > + struct eficonfig_select_file_info *file_info = data; > > + > > + /* clear the existing file information */ > > + file_info->current_volume = NULL; > > + file_info->current_path[0] = u'\0'; > > + file_info->dp_volume = NULL; > > + > > + return EFI_ABORTED; > > +} > > + > > +static struct eficonfig_item select_file_menu_items[] = { > > + {"Select File", eficonfig_process_select_file}, > > + {"Clear", eficonfig_process_clear_file_selection}, > > + {"Quit", eficonfig_process_quit}, > > +}; > > + > > + > > +/** > > + * eficonfig_display_select_file_option() - display select file option > > + * > > + * @file_info: pointer to the file information structure > > + * Return: status code > > + */ > > +efi_status_t eficonfig_display_select_file_option(struct eficonfig_select_file_info *file_info) > > +{ > > + efi_status_t ret; > > + struct efimenu *efi_menu; > > + > > + select_file_menu_items[1].data = file_info; > > + efi_menu = eficonfig_create_fixed_menu(select_file_menu_items, > > + ARRAY_SIZE(select_file_menu_items)); > > + if (!efi_menu) > > + return EFI_OUT_OF_RESOURCES; > > + > > + ret = eficonfig_process_common(efi_menu, " ** Update File **"); > > + if (ret != EFI_SUCCESS) /* User selects "Clear" or "Quit" */ > > + ret = EFI_NOT_READY; > > + > > + eficonfig_destroy(efi_menu); > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_select_file_handler() - handle user file selection > > + * > > + * @data: pointer to the data > > + * Return: status code > > + */ > > +efi_status_t eficonfig_select_file_handler(void *data) > > +{ > > + size_t len; > > + efi_status_t ret; > > + struct list_head *pos, *n; > > + struct efi_file_handle *root; > > + struct eficonfig_filepath_info *item; > > + struct eficonfig_select_file_info *tmp = NULL; > > + struct eficonfig_select_file_info *file_info = data; > > + > > + ret = eficonfig_display_select_file_option(file_info); > > + if (ret != EFI_SUCCESS) > > + return ret; > > + > > + tmp = calloc(1, sizeof(struct eficonfig_select_file_info)); > > + if (!tmp) > > + return EFI_OUT_OF_RESOURCES; > > + > > + tmp->current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); > > + if (!tmp->current_path) { > > + free(tmp); > > + return EFI_OUT_OF_RESOURCES; > > + } > > + INIT_LIST_HEAD(&tmp->filepath_list); > > + > > + while (!tmp->file_selected) { > > + tmp->current_volume = NULL; > > + memset(tmp->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE); > > + > > + ret = eficonfig_select_volume(tmp); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + if (!tmp->current_volume) > > + return EFI_INVALID_PARAMETER; > > + > > + ret = efi_open_volume_int(tmp->current_volume, &root); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = eficonfig_select_file(tmp, root); > > + if (ret == EFI_ABORTED) > > + continue; > > + if (ret != EFI_SUCCESS) > > + goto out; > > + } > > + > > +out: > > + if (ret == EFI_SUCCESS) { > > + len = u16_strlen(tmp->current_path); > > + len = (len >= EFICONFIG_FILE_PATH_MAX) ? (EFICONFIG_FILE_PATH_MAX - 1) : len; > > + memcpy(file_info->current_path, tmp->current_path, len * sizeof(u16)); > > + file_info->current_path[len] = u'\0'; > > + file_info->current_volume = tmp->current_volume; > > + file_info->dp_volume = tmp->dp_volume; > > + } > > + > > + list_for_each_safe(pos, n, &tmp->filepath_list) { > > + item = list_entry(pos, struct eficonfig_filepath_info, list); > > + list_del(&item->list); > > + free(item->name); > > + free(item); > > + } > > + free(tmp->current_path); > > + free(tmp); > > + > > + /* to stay the parent menu */ > > + ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret; > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_get_unused_bootoption() - get unused "Boot####" index > > + * > > + * @buf: pointer to the buffer to store boot option variable name > > + * @buf_size: buffer size > > + * @index: pointer to store the index in the BootOrder variable > > + * Return: status code > > + */ > > +efi_status_t eficonfig_get_unused_bootoption(u16 *buf, efi_uintn_t buf_size, > > + unsigned int *index) > > +{ > > + u32 i; > > + efi_status_t ret; > > + efi_uintn_t size; > > + > > + if (buf_size < u16_strsize(u"Boot####")) > > + return EFI_BUFFER_TOO_SMALL; > > + > > + for (i = 0; i <= 0xFFFF; i++) { > > + size = 0; > > + efi_create_indexed_name(buf, buf_size, "Boot", i); > > + ret = efi_get_variable_int(buf, &efi_global_variable_guid, > > + NULL, &size, NULL, NULL); > > + if (ret == EFI_BUFFER_TOO_SMALL) > > + continue; > > + else > > + break; > > + } > > + > > + if (i > 0xFFFF) > > + return EFI_OUT_OF_RESOURCES; > > + > > + *index = i; > > + > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + * eficonfig_set_boot_option() - set boot option > > + * > > + * @varname: pointer to variable name > > + * @dp: pointer to device path > > + * @label: pointer to label string > > + * @optional_data: pointer to optional data > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_set_boot_option(u16 *varname, struct efi_device_path *dp, > > + efi_uintn_t dp_size, u16 *label, char *optional_data) > > +{ > > + void *p = NULL; > > + efi_status_t ret; > > + efi_uintn_t size; > > + struct efi_load_option lo; > > + > > + lo.file_path = dp; > > + lo.file_path_length = dp_size; > > + lo.attributes = LOAD_OPTION_ACTIVE; > > + lo.optional_data = optional_data; > > + lo.label = label; > > + > > + size = efi_serialize_load_option(&lo, (u8 **)&p); > > + if (!size) > > + return EFI_INVALID_PARAMETER; > > + > > + ret = efi_set_variable_int(varname, &efi_global_variable_guid, > > + EFI_VARIABLE_NON_VOLATILE | > > + EFI_VARIABLE_BOOTSERVICE_ACCESS | > > + EFI_VARIABLE_RUNTIME_ACCESS, > > + size, p, false); > > + free(p); > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_append_bootorder() - append new boot option in BootOrder variable > > + * > > + * @index: "Boot####" index to append to BootOrder variable > > + * Return: status code > > + */ > > +efi_status_t eficonfig_append_bootorder(u16 index) > > +{ > > + u16 *bootorder; > > + efi_status_t ret; > > + u16 *new_bootorder = NULL; > > + efi_uintn_t last, size, new_size; > > + > > + /* append new boot option */ > > + bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size); > > + last = size / sizeof(u16); > > + new_size = size + sizeof(u16); > > + new_bootorder = calloc(1, new_size); > > + if (!new_bootorder) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + memcpy(new_bootorder, bootorder, size); > > + new_bootorder[last] = index; > > + > > + ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid, > > + EFI_VARIABLE_NON_VOLATILE | > > + EFI_VARIABLE_BOOTSERVICE_ACCESS | > > + EFI_VARIABLE_RUNTIME_ACCESS, > > + new_size, new_bootorder, false); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > +out: > > + free(bootorder); > > + free(new_bootorder); > > + > > + return ret; > > +} > > + > > +/** > > + * create_boot_option_entry() - create boot option entry > > + * > > + * @efi_menu: pointer to the efimenu structure > > + * @title: pointer to the entry title > > + * @val: pointer to boot option label > > + * @func: callback of each entry > > + * @data: pointer to the data to be passed to each entry callback > > + * Return: status code > > + */ > > +static efi_status_t create_boot_option_entry(struct efimenu *efi_menu, char *title, u16 *val, > > + eficonfig_entry_func func, void *data) > > +{ > > + u32 len; > > + char *p, *buf; > > + > > + len = strlen(title) + 1; > > + if (val) > > + len += utf16_utf8_strlen(val); > > + buf = calloc(1, len); > > + if (!buf) > > + return EFI_OUT_OF_RESOURCES; > > + > > + strcpy(buf, title); > > + if (val) { > > + p = buf + strlen(title); > > + utf16_utf8_strcpy(&p, val); > > + } > > + > > + return append_entry(efi_menu, buf, func, data); > > +} > > + > > +/** > > + * prepare_file_selection_entry() - prepare file selection entry > > + * > > + * @efi_menu: pointer to the efimenu structure > > + * @title: pointer to the title string > > + * @file_info: pointer to the file info > > + * Return: status code > > + */ > > +static efi_status_t prepare_file_selection_entry(struct efimenu *efi_menu, char *title, > > + struct eficonfig_select_file_info *file_info) > > +{ > > + u32 len; > > + efi_status_t ret; > > + u16 *file_name, *p; > > + efi_handle_t handle; > > + char devname[BOOTMENU_DEVICE_NAME_MAX] = {0}; > > + > > + /* get the device name only when the user already selected the file path */ > > + handle = efi_dp_find_obj(file_info->dp_volume, NULL, NULL); > > + if (handle) { > > + ret = efi_disk_get_device_name(handle, devname, BOOTMENU_DEVICE_NAME_MAX); > > + if (ret != EFI_SUCCESS) > > + return ret; > > + } > > + > > + /* append u'/' to devname, it is just for display purpose. */ > > + if (file_info->current_path[0] != u'\0' && file_info->current_path[0] != u'/') > > + strlcat(devname, "/", BOOTMENU_DEVICE_NAME_MAX); > > + > > + len = strlen(devname); > > + len += utf16_utf8_strlen(file_info->current_path) + 1; > > + file_name = calloc(1, len * sizeof(u16)); > > + if (!file_name) > > + return ret; > > + > > + p = file_name; > > + utf8_utf16_strcpy(&p, devname); > > + u16_strlcat(file_name, file_info->current_path, len); > > + ret = create_boot_option_entry(efi_menu, title, file_name, > > + eficonfig_select_file_handler, file_info); > > + free(file_name); > > + return ret; > > +} > > + > > +/** > > + * eficonfig_show_boot_option() - prepare menu entry for editing boot option > > + * > > + * Construct the structures to create edit boot option menu > > + * > > + * @bo: pointer to the boot option > > + * @header_str: pointer to the header string > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_show_boot_option(struct eficonfig_boot_option *bo, > > + char *header_str) > > +{ > > + efi_status_t ret; > > + struct efimenu *efi_menu; > > + > > + efi_menu = calloc(1, sizeof(struct efimenu)); > > + if (!efi_menu) > > + return EFI_OUT_OF_RESOURCES; > > + > > + INIT_LIST_HEAD(&efi_menu->list); > > + > > + ret = create_boot_option_entry(efi_menu, "Description: ", bo->description, > > + eficonfig_boot_add_enter_description, bo); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = prepare_file_selection_entry(efi_menu, "File: ", &bo->file_info); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = prepare_file_selection_entry(efi_menu, "Initrd File: ", &bo->initrd_info); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = create_boot_option_entry(efi_menu, "Optional Data: ", bo->optional_data, > > + eficonfig_boot_add_optional_data, bo); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = create_boot_option_entry(efi_menu, "Save", NULL, > > + eficonfig_boot_edit_save, bo); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = create_boot_option_entry(efi_menu, "Quit", NULL, > > + eficonfig_process_quit, NULL); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = eficonfig_process_common(efi_menu, header_str); > > +out: > > + eficonfig_destroy(efi_menu); > > + > > + return ret; > > +} > > + > > +/** > > + * fill_file_info() - fill the file info from efi_device_path structure > > + * > > + * @dp: pointer to the device path > > + * @file_info: pointer to the file info structure > > + * @device_dp: pointer to the volume device path > > + */ > > +static void fill_file_info(struct efi_device_path *dp, > > + struct eficonfig_select_file_info *file_info, > > + struct efi_device_path *device_dp) > > +{ > > + u16 *file_str, *p; > > + struct efi_device_path *file_dp = NULL; > > + > > + efi_dp_split_file_path(dp, &device_dp, &file_dp); > > + file_info->dp_volume = device_dp; > > + > > + if (file_dp) { > > + file_str = efi_dp_str(file_dp); > > + /* > > + * efi_convert_device_path_to_text() automatically adds u'/' at the > > + * beginning of file name, remove u'/' before copying to current_path > > + */ > > + p = file_str; > > + if (p[0] == u'/') > > + p++; > > + > > + u16_strcpy(file_info->current_path, p); > > + efi_free_pool(file_dp); > > + efi_free_pool(file_str); > > + } > > +} > > + > > +/** > > + * eficonfig_edit_boot_option() - prepare boot option structure for editing > > + * > > + * Construct the boot option structure and copy the existing value > > + * > > + * @varname: pointer to the UEFI variable name > > + * @bo: pointer to the boot option > > + * @load_option: pointer to the load option > > + * @load_option_size: size of the load option > > + * @header_str: pointer to the header string > > + * Return : status code > > + */ > > +static efi_status_t eficonfig_edit_boot_option(u16 *varname, struct eficonfig_boot_option *bo, > > + void *load_option, efi_uintn_t load_option_size, > > + char *header_str) > > +{ > > + size_t len; > > + efi_status_t ret; > > + char *tmp = NULL, *p; > > + struct efi_load_option lo = {0}; > > + efi_uintn_t final_dp_size; > > + struct efi_device_path *dp = NULL; > > + efi_uintn_t size = load_option_size; > > + struct efi_device_path *final_dp = NULL; > > + struct efi_device_path *device_dp = NULL; > > + struct efi_device_path *initrd_dp = NULL; > > + struct efi_device_path *initrd_device_dp = NULL; > > + > > + const struct efi_initrd_dp id_dp = { > > + .vendor = { > > + { > > + DEVICE_PATH_TYPE_MEDIA_DEVICE, > > + DEVICE_PATH_SUB_TYPE_VENDOR_PATH, > > + sizeof(id_dp.vendor), > > + }, > > + EFI_INITRD_MEDIA_GUID, > > + }, > > + .end = { > > + DEVICE_PATH_TYPE_END, > > + DEVICE_PATH_SUB_TYPE_END, > > + sizeof(id_dp.end), > > + } > > + }; > > + > > + bo->file_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); > > + if (!bo->file_info.current_path) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + > > + bo->initrd_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); > > + if (!bo->file_info.current_path) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + > > + bo->description = calloc(1, EFICONFIG_DESCRIPTION_MAX * sizeof(u16)); > > + if (!bo->description) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + > > + bo->optional_data = calloc(1, EFICONFIG_OPTIONAL_DATA_MAX * sizeof(u16)); > > + if (!bo->optional_data) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + > > + /* copy the preset value */ > > + if (load_option) { > > + ret = efi_deserialize_load_option(&lo, load_option, &size); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + if (!lo.label || (lo.label && u16_strlen(lo.label) >= EFICONFIG_DESCRIPTION_MAX)) { > > + ret = EFI_INVALID_PARAMETER; > > + goto out; > > + } > > + u16_strcpy(bo->description, lo.label); > > + > > + /* EFI image file path is a first instance */ > > + if (lo.file_path) > > + fill_file_info(lo.file_path, &bo->file_info, device_dp); > > + > > + /* Initrd file path(optional) is placed at second instance. */ > > + initrd_dp = efi_dp_from_lo(&lo, &efi_lf2_initrd_guid); > > + if (initrd_dp) { > > + fill_file_info(initrd_dp, &bo->initrd_info, initrd_device_dp); > > + efi_free_pool(initrd_dp); > > + } > > + > > + if (size > 0) > > + memcpy(bo->optional_data, lo.optional_data, size); > > + } > > + > > + while (1) { > > + ret = eficonfig_show_boot_option(bo, header_str); > > + if (ret == EFI_SUCCESS && bo->edit_completed) > > + break; > > + if (ret == EFI_NOT_READY) > > + continue; > > + if (ret != EFI_SUCCESS) > > + goto out; > > + } > > + > > + if (bo->initrd_info.dp_volume) { > > + dp = create_selected_device_path(&bo->initrd_info); > > + if (!dp) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + initrd_dp = efi_dp_append((const struct efi_device_path *)&id_dp, dp); > > + efi_free_pool(dp); > > + } > > + > > + dp = create_selected_device_path(&bo->file_info); > > + if (!dp) { > > + ret = EFI_OUT_OF_RESOURCES; > > + goto out; > > + } > > + final_dp_size = efi_dp_size(dp) + sizeof(END); > > + if (initrd_dp) { > > + final_dp = efi_dp_concat(dp, initrd_dp); > > + final_dp_size += efi_dp_size(initrd_dp) + sizeof(END); > > + } else { > > + final_dp = efi_dp_dup(dp); > > + } > > + efi_free_pool(dp); > > + > > + if (!final_dp) > > + goto out; > > + > > + if (utf16_utf8_strlen(bo->optional_data)) { > > + len = utf16_utf8_strlen(bo->optional_data) + 1; > > + tmp = calloc(1, len); > > + if (!tmp) > > + goto out; > > + p = tmp; > > + utf16_utf8_strncpy(&p, bo->optional_data, u16_strlen(bo->optional_data)); > > + } > > + > > + ret = eficonfig_set_boot_option(varname, final_dp, final_dp_size, bo->description, tmp); > > + if (ret != EFI_SUCCESS) > > + goto out; > > +out: > > + free(tmp); > > + free(bo->optional_data); > > + free(bo->description); > > + free(bo->file_info.current_path); > > + free(bo->initrd_info.current_path); > > + efi_free_pool(device_dp); > > + efi_free_pool(initrd_device_dp); > > + efi_free_pool(initrd_dp); > > + efi_free_pool(final_dp); > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_process_add_boot_option() - handler to add boot option > > + * > > + * @data: pointer to the data for each entry > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_process_add_boot_option(void *data) > > +{ > > + u16 varname[9]; > > + efi_status_t ret; > > + struct eficonfig_boot_option *bo = NULL; > > + > > + bo = calloc(1, sizeof(struct eficonfig_boot_option)); > > + if (!bo) > > + return EFI_OUT_OF_RESOURCES; > > + > > + ret = eficonfig_get_unused_bootoption(varname, sizeof(varname), &bo->boot_index); > > + if (ret != EFI_SUCCESS) > > + return ret; > > + > > + ret = eficonfig_edit_boot_option(varname, bo, NULL, 0, " ** Add Boot Option ** "); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > + ret = eficonfig_append_bootorder((u16)bo->boot_index); > > + if (ret != EFI_SUCCESS) > > + goto out; > > + > > +out: > > + free(bo); > > + > > + /* to stay the parent menu */ > > + ret = (ret == EFI_ABORTED) ? EFI_SUCCESS : ret; > > + > > + return ret; > > +} > > + > > +/** > > + * eficonfig_init() - do required initialization for eficonfig command > > + * > > + * Return: status code > > + */ > > +static efi_status_t eficonfig_init(void) > > +{ > > + efi_status_t ret = EFI_SUCCESS; > > + static bool init; > > + struct efi_handler *handler; > > + > > + if (!init) { > > + ret = efi_search_protocol(efi_root, &efi_guid_text_input_protocol, &handler); > > + if (ret != EFI_SUCCESS) > > + return ret; > > + > > + ret = efi_protocol_open(handler, (void **)&cin, efi_root, NULL, > > + EFI_OPEN_PROTOCOL_GET_PROTOCOL); > > + if (ret != EFI_SUCCESS) > > + return ret; > > + } > > + > > + init = true; > > + > > + return ret; > > +} > > + > > +static const struct eficonfig_item maintenance_menu_items[] = { > > + {"Add Boot Option", eficonfig_process_add_boot_option}, > > + {"Quit", eficonfig_process_quit}, > > +}; > > + > > +/** > > + * do_eficonfig() - execute `eficonfig` command > > + * > > + * @cmdtp: table entry describing command > > + * @flag: bitmap indicating how the command was invoked > > + * @argc: number of arguments > > + * @argv: command line arguments > > + * Return: status code > > + */ > > +static int do_eficonfig(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) > > +{ > > + efi_status_t ret; > > + struct efimenu *efi_menu; > > + > > + if (argc > 1) > > + return CMD_RET_USAGE; > > + > > + ret = efi_init_obj_list(); > > + if (ret != EFI_SUCCESS) { > > + log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n", > > + ret & ~EFI_ERROR_MASK); > > + > > + return CMD_RET_FAILURE; > > + } > > + > > + ret = eficonfig_init(); > > + if (ret != EFI_SUCCESS) > > + return CMD_RET_FAILURE; > > + > > + while (1) { > > + efi_menu = eficonfig_create_fixed_menu(maintenance_menu_items, > > + ARRAY_SIZE(maintenance_menu_items)); > > + if (!efi_menu) > > + return CMD_RET_FAILURE; > > + > > + ret = eficonfig_process_common(efi_menu, " ** UEFI Maintenance Menu **"); > > + eficonfig_destroy(efi_menu); > > + > > + if (ret == EFI_ABORTED) > > + break; > > + } > > + > > + return CMD_RET_SUCCESS; > > +} > > + > > +U_BOOT_CMD( > > + eficonfig, 1, 0, do_eficonfig, > > + "provide menu-driven UEFI variable maintenance interface", > > + "" > > +); > > diff --git a/include/efi_config.h b/include/efi_config.h > > new file mode 100644 > > index 0000000000..ea5bc4e1bf > > --- /dev/null > > +++ b/include/efi_config.h > > @@ -0,0 +1,96 @@ > > +/* SPDX-License-Identifier: GPL-2.0+ */ > > +/* > > + * Menu-driven UEFI Variable maintenance > > + * > > + * Copyright (c) 2022 Masahisa Kojima, Linaro Limited > > + */ > > + > > +#ifndef _EFI_CONFIG_H > > +#define _EFI_CONFIG_H > > + > > +#include <efi_loader.h> > > + > > +#define EFICONFIG_ENTRY_NUM_MAX 99 > > +#define EFICONFIG_FILE_PATH_MAX 512 > > +#define EFICONFIG_FILE_PATH_BUF_SIZE (EFICONFIG_FILE_PATH_MAX * sizeof(u16)) > > + > > +typedef efi_status_t (*eficonfig_entry_func)(void *data); > > + > > +/** > > + * struct eficonfig_entry - menu entry structure > > + * > > + * @num: menu entry index > > + * @title: title of entry > > + * @key: unique key > > + * @efi_menu: pointer to the menu structure > > + * @func: callback function to be called when this entry is selected > > + * @data: data to be passed to the callback function, caller must free() this pointer > > + * @list: list structure > > + */ > > +struct eficonfig_entry { > > + u32 num; > > + char *title; > > + char key[3]; > > + struct efimenu *efi_menu; > > + eficonfig_entry_func func; > > + void *data; > > + struct list_head list; > > +}; > > + > > +/** > > + * struct efimenu - efi menu structure > > + * > > + * @delay: delay for autoboot > > + * @active: active menu entry index > > + * @count: total count of menu entry > > + * @menu_header: menu header string > > + * @list: menu entry list structure > > + */ > > +struct efimenu { > > + int delay; > > + int active; > > + int count; > > + char *menu_header; > > + struct list_head list; > > +}; > > + > > +/** > > + * struct eficonfig_item - structure to construct eficonfig_entry > > + * > > + * @title: title of entry > > + * @func: callback function to be called when this entry is selected > > + * @data: data to be passed to the callback function > > + */ > > +struct eficonfig_item { > > + char *title; > > + eficonfig_entry_func func; > > + void *data; > > +}; > > + > > +/** > > + * struct eficonfig_select_file_info - structure to be used for file selection > > + * > > + * @current_volume: pointer to the efi_simple_file_system_protocol > > + * @dp_volume: pointer to device path of the selected device > > + * @current_path: pointer to the selected file path string > > + * @filepath_list: list_head structure for file path list > > + * @file_selectred: flag indicates file selecting status > > + */ > > +struct eficonfig_select_file_info { > > + struct efi_simple_file_system_protocol *current_volume; > > + struct efi_device_path *dp_volume; > > + u16 *current_path; > > + struct list_head filepath_list; > > + bool file_selected; > > +}; > > + > > +void eficonfig_print_msg(char *msg); > > +void eficonfig_destroy(struct efimenu *efi_menu); > > +efi_status_t eficonfig_process_quit(void *data); > > +efi_status_t eficonfig_process_common(struct efimenu *efi_menu, char *menu_header); > > +efi_status_t eficonfig_select_file_handler(void *data); > > +efi_status_t eficonfig_get_unused_bootoption(u16 *buf, > > + efi_uintn_t buf_size, u32 *index); > > +efi_status_t eficonfig_append_bootorder(u16 index); > > + > > +#endif > > diff --git a/include/efi_loader.h b/include/efi_loader.h > > index b0d6fff67c..4461f721e0 100644 > > --- a/include/efi_loader.h > > +++ b/include/efi_loader.h > > @@ -142,6 +142,11 @@ static inline efi_status_t efi_launch_capsules(void) > > EFI_GUID(0x63293792, 0xadf5, 0x9325, \ > > 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e) > > > > +/* GUID for the auto generated boot menu entry */ > > +#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \ > > + EFI_GUID(0x38c1acc1, 0x9fc0, 0x41f0, \ > > + 0xb9, 0x01, 0xfa, 0x74, 0xd6, 0xd6, 0xe4, 0xde) > > + > > /* Use internal device tree when starting UEFI application */ > > #define EFI_FDT_USE_INTERNAL NULL > > > > @@ -226,6 +231,9 @@ const char *__efi_nesting_dec(void); > > #define EFI_CACHELINE_SIZE 128 > > #endif > > > > +/* max bootmenu title size for volume selection */ > > +#define BOOTMENU_DEVICE_NAME_MAX 16 > > + > > /* Key identifying current memory map */ > > extern efi_uintn_t efi_memory_map_key; > > > > @@ -249,6 +257,9 @@ extern const struct efi_hii_string_protocol efi_hii_string; > > > > uint16_t *efi_dp_str(struct efi_device_path *dp); > > > > +/* GUID for the auto generated boot menu entry */ > > +extern const efi_guid_t efi_guid_bootmenu_auto_generated; > > + > > /* GUID of the U-Boot root node */ > > extern const efi_guid_t efi_u_boot_guid; > > #ifdef CONFIG_SANDBOX > > @@ -314,6 +325,8 @@ extern const efi_guid_t efi_guid_firmware_management_protocol; > > extern const efi_guid_t efi_esrt_guid; > > /* GUID of the SMBIOS table */ > > extern const efi_guid_t smbios_guid; > > +/*GUID of console */ > > +extern const efi_guid_t efi_guid_text_input_protocol; > > > > extern char __efi_runtime_start[], __efi_runtime_stop[]; > > extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[]; > > @@ -1064,4 +1077,28 @@ efi_status_t efi_esrt_populate(void); > > efi_status_t efi_load_capsule_drivers(void); > > > > efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz); > > + > > +efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type, > > + const efi_guid_t *protocol, void *search_key, > > + efi_uintn_t *no_handles, efi_handle_t **buffer); > > + > > +efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this, > > + struct efi_file_handle **root); > > +efi_status_t efi_file_open_int(struct efi_file_handle *this, > > + struct efi_file_handle **new_handle, > > + u16 *file_name, u64 open_mode, > > + u64 attributes); > > +efi_status_t efi_file_close_int(struct efi_file_handle *file); > > +efi_status_t efi_file_read_int(struct efi_file_handle *this, > > + efi_uintn_t *buffer_size, void *buffer); > > +efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos); > > + > > +typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key); > > +efi_status_t efi_console_get_u16_string > > + (struct efi_simple_text_input_protocol *cin, > > + u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func, > > + int row, int col); > > + > > +efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size); > > + > > #endif /* _EFI_LOADER_H */ > > diff --git a/lib/efi_loader/efi_bootmgr.c b/lib/efi_loader/efi_bootmgr.c > > index 234073ecb7..ede9116b3c 100644 > > --- a/lib/efi_loader/efi_bootmgr.c > > +++ b/lib/efi_loader/efi_bootmgr.c > > @@ -19,6 +19,9 @@ > > static const struct efi_boot_services *bs; > > static const struct efi_runtime_services *rs; > > > > +const efi_guid_t efi_guid_bootmenu_auto_generated = > > + EFICONFIG_AUTO_GENERATED_ENTRY_GUID; > > + > > /* > > * bootmgr implements the logic of trying to find a payload to boot > > * based on the BootOrder + BootXXXX variables, and then loading it. > > diff --git a/lib/efi_loader/efi_boottime.c b/lib/efi_loader/efi_boottime.c > > index 4da64b5d29..1233418e77 100644 > > --- a/lib/efi_loader/efi_boottime.c > > +++ b/lib/efi_loader/efi_boottime.c > > @@ -2453,6 +2453,35 @@ static efi_status_t EFIAPI efi_protocols_per_handle( > > return EFI_EXIT(EFI_SUCCESS); > > } > > > > +efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type, > > + const efi_guid_t *protocol, void *search_key, > > + efi_uintn_t *no_handles, efi_handle_t **buffer) > > +{ > > + efi_status_t r; > > + efi_uintn_t buffer_size = 0; > > + > > + if (!no_handles || !buffer) { > > + r = EFI_INVALID_PARAMETER; > > + goto out; > > + } > > + *no_handles = 0; > > + *buffer = NULL; > > + r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > > + *buffer); > > + if (r != EFI_BUFFER_TOO_SMALL) > > + goto out; > > + r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size, > > + (void **)buffer); > > + if (r != EFI_SUCCESS) > > + goto out; > > + r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > > + *buffer); > > + if (r == EFI_SUCCESS) > > + *no_handles = buffer_size / sizeof(efi_handle_t); > > +out: > > + return r; > > +} > > + > > /** > > * efi_locate_handle_buffer() - locate handles implementing a protocol > > * @search_type: selection criterion > > @@ -2474,30 +2503,13 @@ efi_status_t EFIAPI efi_locate_handle_buffer( > > efi_uintn_t *no_handles, efi_handle_t **buffer) > > { > > efi_status_t r; > > - efi_uintn_t buffer_size = 0; > > > > EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key, > > no_handles, buffer); > > > > - if (!no_handles || !buffer) { > > - r = EFI_INVALID_PARAMETER; > > - goto out; > > - } > > - *no_handles = 0; > > - *buffer = NULL; > > - r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > > - *buffer); > > - if (r != EFI_BUFFER_TOO_SMALL) > > - goto out; > > - r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size, > > - (void **)buffer); > > - if (r != EFI_SUCCESS) > > - goto out; > > - r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, > > - *buffer); > > - if (r == EFI_SUCCESS) > > - *no_handles = buffer_size / sizeof(efi_handle_t); > > -out: > > + r = efi_locate_handle_buffer_int(search_type, protocol, search_key, > > + no_handles, buffer); > > + > > return EFI_EXIT(r); > > } > > > > diff --git a/lib/efi_loader/efi_console.c b/lib/efi_loader/efi_console.c > > index 3164fd484e..5be509f0d6 100644 > > --- a/lib/efi_loader/efi_console.c > > +++ b/lib/efi_loader/efi_console.c > > @@ -7,6 +7,7 @@ > > > > #define LOG_CATEGORY LOGC_EFI > > > > +#include <ansi.h> > > #include <common.h> > > #include <charset.h> > > #include <malloc.h> > > @@ -1318,3 +1319,72 @@ out_of_memory: > > printf("ERROR: Out of memory\n"); > > return r; > > } > > + > > +/** > > + * efi_console_get_u16_string() - get user input string > > + * > > + * @cin: protocol interface to EFI_SIMPLE_TEXT_INPUT_PROTOCOL > > + * @buf: buffer to store user input string in UTF16 > > + * @count: number of u16 string including NULL terminator that buf has > > + * @filter_func: callback to filter user input > > + * @row: row number to locate user input form > > + * @col: column number to locate user input form > > + * Return: status code > > + */ > > +efi_status_t efi_console_get_u16_string(struct efi_simple_text_input_protocol *cin, > > + u16 *buf, efi_uintn_t count, > > + efi_console_filter_func filter_func, > > + int row, int col) > > +{ > > + efi_status_t ret; > > + efi_uintn_t len = 0; > > + struct efi_input_key key; > > + > > + printf(ANSI_CURSOR_POSITION > > + ANSI_CLEAR_LINE_TO_END > > + ANSI_CURSOR_SHOW, row, col); > > + > > + ret = EFI_CALL(cin->reset(cin, false)); > > + if (ret != EFI_SUCCESS) > > + return ret; > > + > > + for (;;) { > > + do { > > + ret = EFI_CALL(cin->read_key_stroke(cin, &key)); > > + mdelay(10); > > + } while (ret == EFI_NOT_READY); > > + > > + if (key.unicode_char == u'\b') { > > + if (len > 0) > > + buf[--len] = u'\0'; > > + > > + printf(ANSI_CURSOR_POSITION > > + "%ls" > > + ANSI_CLEAR_LINE_TO_END, row, col, buf); > > + continue; > > + } else if (key.unicode_char == u'\r') { > > + buf[len] = u'\0'; > > + return EFI_SUCCESS; > > + } else if (key.unicode_char == 0x3 || key.scan_code == 23) { > > + return EFI_ABORTED; > > + } else if (key.unicode_char < 0x20) { > > + /* ignore control codes other than Ctrl+C, '\r' and '\b' */ > > + continue; > > + } else if (key.scan_code != 0) { > > + /* only accept single ESC press for cancel */ > > + continue; > > + } > > + > > + if (filter_func) { > > + if (filter_func(&key) != EFI_SUCCESS) > > + continue; > > + } > > + > > + if (len >= (count - 1)) > > + continue; > > + > > + buf[len] = key.unicode_char; > > + len++; > > + printf(ANSI_CURSOR_POSITION "%ls", row, col, buf); > > + } > > +} > > diff --git a/lib/efi_loader/efi_disk.c b/lib/efi_loader/efi_disk.c > > index f269abf135..a34ca46a11 100644 > > --- a/lib/efi_loader/efi_disk.c > > +++ b/lib/efi_loader/efi_disk.c > > @@ -760,3 +760,53 @@ efi_status_t efi_disk_init(void) > > > > return EFI_SUCCESS; > > } > > + > > +/** > > + * efi_disk_get_device_name() - get U-Boot device name associated with EFI handle > > + * > > + * @handle: pointer to the EFI handle > > + * @buf: pointer to the buffer to store the string > > + * @size: size of buffer > > + * Return: status code > > + */ > > +efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size) > > +{ > > + int count; > > + int diskid; > > + enum uclass_id id; > > + unsigned int part; > > + struct udevice *dev; > > + struct blk_desc *desc; > > + const char *if_typename; > > + bool is_partition = false; > > + struct disk_part *part_data; > > + > > + if (!handle || !buf || !size) > > + return EFI_INVALID_PARAMETER; > > + > > + dev = handle->dev; > > + id = device_get_uclass_id(dev); > > + if (id == UCLASS_BLK) { > > + desc = dev_get_uclass_plat(dev); > > + } else if (id == UCLASS_PARTITION) { > > + desc = dev_get_uclass_plat(dev_get_parent(dev)); > > + is_partition = true; > > + } else { > > + return EFI_INVALID_PARAMETER; > > + } > > + if_typename = blk_get_if_type_name(desc->if_type); > > + diskid = desc->devnum; > > + > > + if (is_partition) { > > + part_data = dev_get_uclass_plat(dev); > > + part = part_data->partnum; > > + count = snprintf(buf, size, "%s %d:%d", if_typename, diskid, part); > > + } else { > > + count = snprintf(buf, size, "%s %d", if_typename, diskid); > > + } > > + > > + if (count < 0 || (count + 1) > size) > > + return EFI_INVALID_PARAMETER; > > + > > + return EFI_SUCCESS; > > +} > > diff --git a/lib/efi_loader/efi_file.c b/lib/efi_loader/efi_file.c > > index 7a7077e6d0..c96a7f7ca3 100644 > > --- a/lib/efi_loader/efi_file.c > > +++ b/lib/efi_loader/efi_file.c > > @@ -246,10 +246,10 @@ error: > > return NULL; > > } > > > > -static efi_status_t efi_file_open_int(struct efi_file_handle *this, > > - struct efi_file_handle **new_handle, > > - u16 *file_name, u64 open_mode, > > - u64 attributes) > > +efi_status_t efi_file_open_int(struct efi_file_handle *this, > > + struct efi_file_handle **new_handle, > > + u16 *file_name, u64 open_mode, > > + u64 attributes) > > { > > struct file_handle *fh = to_fh(this); > > efi_status_t ret; > > @@ -369,11 +369,17 @@ static efi_status_t file_close(struct file_handle *fh) > > return EFI_SUCCESS; > > } > > > > -static efi_status_t EFIAPI efi_file_close(struct efi_file_handle *file) > > +efi_status_t efi_file_close_int(struct efi_file_handle *file) > > { > > struct file_handle *fh = to_fh(file); > > + > > + return file_close(fh); > > +} > > + > > +static efi_status_t EFIAPI efi_file_close(struct efi_file_handle *file) > > +{ > > EFI_ENTRY("%p", file); > > - return EFI_EXIT(file_close(fh)); > > + return EFI_EXIT(efi_file_close_int(file)); > > } > > > > static efi_status_t EFIAPI efi_file_delete(struct efi_file_handle *file) > > @@ -562,8 +568,8 @@ static efi_status_t dir_read(struct file_handle *fh, u64 *buffer_size, > > return EFI_SUCCESS; > > } > > > > -static efi_status_t efi_file_read_int(struct efi_file_handle *this, > > - efi_uintn_t *buffer_size, void *buffer) > > +efi_status_t efi_file_read_int(struct efi_file_handle *this, > > + efi_uintn_t *buffer_size, void *buffer) > > { > > struct file_handle *fh = to_fh(this); > > efi_status_t ret = EFI_SUCCESS; > > @@ -773,24 +779,11 @@ out: > > return EFI_EXIT(ret); > > } > > > > -/** > > - * efi_file_setpos() - set current position in file > > - * > > - * This function implements the SetPosition service of the EFI file protocol. > > - * See the UEFI spec for details. > > - * > > - * @file: file handle > > - * @pos: new file position > > - * Return: status code > > - */ > > -static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, > > - u64 pos) > > +efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos) > > { > > struct file_handle *fh = to_fh(file); > > efi_status_t ret = EFI_SUCCESS; > > > > - EFI_ENTRY("%p, %llu", file, pos); > > - > > if (fh->isdir) { > > if (pos != 0) { > > ret = EFI_UNSUPPORTED; > > @@ -812,6 +805,28 @@ static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, > > fh->offset = pos; > > > > error: > > + return ret; > > +} > > + > > +/** > > + * efi_file_setpos() - set current position in file > > + * > > + * This function implements the SetPosition service of the EFI file protocol. > > + * See the UEFI spec for details. > > + * > > + * @file: file handle > > + * @pos: new file position > > + * Return: status code > > + */ > > +static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, > > + u64 pos) > > +{ > > + efi_status_t ret = EFI_SUCCESS; > > + > > + EFI_ENTRY("%p, %llu", file, pos); > > + > > + ret = efi_file_setpos_int(file, pos); > > + > > return EFI_EXIT(ret); > > } > > > > @@ -1138,17 +1153,23 @@ struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp) > > return f; > > } > > > > +efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this, > > + struct efi_file_handle **root) > > +{ > > + struct file_system *fs = to_fs(this); > > + > > + *root = file_open(fs, NULL, NULL, 0, 0); > > + > > + return EFI_SUCCESS; > > +} > > + > > static efi_status_t EFIAPI > > efi_open_volume(struct efi_simple_file_system_protocol *this, > > struct efi_file_handle **root) > > { > > - struct file_system *fs = to_fs(this); > > - > > EFI_ENTRY("%p, %p", this, root); > > > > - *root = file_open(fs, NULL, NULL, 0, 0); > > - > > - return EFI_EXIT(EFI_SUCCESS); > > + return EFI_EXIT(efi_open_volume_int(this, root)); > > } > > > > struct efi_simple_file_system_protocol * >
diff --git a/cmd/Kconfig b/cmd/Kconfig index 211ebe9c87..a1e8613c56 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -1928,6 +1928,13 @@ config CMD_EFIDEBUG particularly for managing boot parameters as well as examining various EFI status for debugging. +config CMD_EFICONFIG + bool "eficonfig - provide menu-driven uefi variables maintenance interface" + depends on CMD_BOOTEFI_BOOTMGR + help + Enable the 'eficonfig' command which provides the menu-driven UEFI + variable maintenance interface. + config CMD_EXCEPTION bool "exception - raise exception" depends on ARM || RISCV || SANDBOX || X86 diff --git a/cmd/Makefile b/cmd/Makefile index 6e87522b62..18f5cb890d 100644 --- a/cmd/Makefile +++ b/cmd/Makefile @@ -63,6 +63,7 @@ obj-$(CONFIG_ENV_IS_IN_EEPROM) += eeprom.o obj-$(CONFIG_CMD_EEPROM) += eeprom.o obj-$(CONFIG_EFI) += efi.o obj-$(CONFIG_CMD_EFIDEBUG) += efidebug.o +obj-$(CONFIG_CMD_EFICONFIG) += eficonfig.o obj-$(CONFIG_CMD_ELF) += elf.o obj-$(CONFIG_CMD_EROFS) += erofs.o obj-$(CONFIG_HUSH_PARSER) += exit.o diff --git a/cmd/eficonfig.c b/cmd/eficonfig.c new file mode 100644 index 0000000000..30ce55d055 --- /dev/null +++ b/cmd/eficonfig.c @@ -0,0 +1,1568 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Menu-driven UEFI Variable maintenance + * + * Copyright (c) 2022 Masahisa Kojima, Linaro Limited + */ + +#include <ansi.h> +#include <common.h> +#include <charset.h> +#include <efi_loader.h> +#include <efi_load_initrd.h> +#include <efi_config.h> +#include <efi_variable.h> +#include <log.h> +#include <malloc.h> +#include <menu.h> +#include <watchdog.h> +#include <asm/unaligned.h> +#include <linux/delay.h> + +static struct efi_simple_text_input_protocol *cin; + +#define EFICONFIG_DESCRIPTION_MAX 32 +#define EFICONFIG_OPTIONAL_DATA_MAX 64 + +/** + * struct eficonfig_filepath_info - structure to be used to store file path + * + * @name: file or directory name + * @list: list structure + */ +struct eficonfig_filepath_info { + u16 *name; + struct list_head list; +}; + +/** + * struct eficonfig_boot_option - structure to be used for updating UEFI boot option + * + * @file_info: user selected file info + * @initrd_info: user selected initrd file info + * @boot_index: index of the boot option + * @description: pointer to the description string + * @optional_data: pointer to the optional_data + * @edit_completed: flag indicates edit complete + */ +struct eficonfig_boot_option { + struct eficonfig_select_file_info file_info; + struct eficonfig_select_file_info initrd_info; + unsigned int boot_index; + u16 *description; + u16 *optional_data; + bool edit_completed; +}; + +/** + * struct eficonfig_volume_entry_data - structure to be used to store volume info + * + * @file_info: pointer to file info structure + * @v: pointer to the protocol interface + * @dp: pointer to the device path + */ +struct eficonfig_volume_entry_data { + struct eficonfig_select_file_info *file_info; + struct efi_simple_file_system_protocol *v; + struct efi_device_path *dp; +}; + +/** + * struct eficonfig_file_entry_data - structure to be used to store file info + * + * @file_info: pointer to file info structure + * @is_directory: flag to identify the directory or file + * @file_name: name of directory or file + */ +struct eficonfig_file_entry_data { + struct eficonfig_select_file_info *file_info; + bool is_directory; + u16 *file_name; +}; + +/** + * eficonfig_print_msg() - print message + * + * display the message to the user, user proceeds the screen + * with any key press. + * + * @items: pointer to the structure of each menu entry + * @count: the number of menu entry + * @menu_header: pointer to the menu header string + * Return: status code + */ +void eficonfig_print_msg(char *msg) +{ + /* Flush input */ + while (tstc()) + getchar(); + + printf(ANSI_CURSOR_HIDE + ANSI_CLEAR_CONSOLE + ANSI_CURSOR_POSITION + "%s\n\n Press any key to continue", 3, 4, msg); + + getchar(); +} + +/** + * eficonfig_print_entry() - print each menu entry + * + * @data: pointer to the data associated with each menu entry + */ +static void eficonfig_print_entry(void *data) +{ + struct eficonfig_entry *entry = data; + int reverse = (entry->efi_menu->active == entry->num); + + /* TODO: support scroll or page for many entries */ + + /* + * Move cursor to line where the entry will be drawn (entry->num) + * First 3 lines(menu header) + 1 empty line + */ + printf(ANSI_CURSOR_POSITION, entry->num + 4, 7); + + if (reverse) + puts(ANSI_COLOR_REVERSE); + + printf("%s", entry->title); + + if (reverse) + puts(ANSI_COLOR_RESET); +} + +/** + * eficonfig_display_statusline() - print status line + * + * @m: pointer to the menu structure + */ +static void eficonfig_display_statusline(struct menu *m) +{ + struct eficonfig_entry *entry; + + if (menu_default_choice(m, (void *)&entry) < 0) + return; + + printf(ANSI_CURSOR_POSITION + "\n%s\n" + ANSI_CURSOR_POSITION ANSI_CLEAR_LINE ANSI_CURSOR_POSITION + " Press UP/DOWN to move, ENTER to select, ESC/CTRL+C to quit" + ANSI_CLEAR_LINE_TO_END ANSI_CURSOR_POSITION ANSI_CLEAR_LINE, + 1, 1, entry->efi_menu->menu_header, entry->efi_menu->count + 5, 1, + entry->efi_menu->count + 6, 1, entry->efi_menu->count + 7, 1); +} + +/** + * eficonfig_choice_entry() - user key input handler + * + * @data: pointer to the efimenu structure + * Return: key string to identify the selected entry + */ +static char *eficonfig_choice_entry(void *data) +{ + int esc = 0; + struct list_head *pos, *n; + struct eficonfig_entry *entry; + enum bootmenu_key key = KEY_NONE; + struct efimenu *efi_menu = data; + + while (1) { + bootmenu_loop((struct bootmenu_data *)efi_menu, &key, &esc); + + switch (key) { + case KEY_UP: + if (efi_menu->active > 0) + --efi_menu->active; + /* no menu key selected, regenerate menu */ + return NULL; + case KEY_DOWN: + if (efi_menu->active < efi_menu->count - 1) + ++efi_menu->active; + /* no menu key selected, regenerate menu */ + return NULL; + case KEY_SELECT: + list_for_each_safe(pos, n, &efi_menu->list) { + entry = list_entry(pos, struct eficonfig_entry, list); + if (entry->num == efi_menu->active) + return entry->key; + } + break; + case KEY_QUIT: + /* Quit by choosing the last entry */ + entry = list_last_entry(&efi_menu->list, struct eficonfig_entry, list); + return entry->key; + default: + /* Pressed key is not valid, no need to regenerate the menu */ + break; + } + } +} + +/** + * eficonfig_destroy() - destroy efimenu + * + * @efi_menu: pointer to the efimenu structure + */ +void eficonfig_destroy(struct efimenu *efi_menu) +{ + struct list_head *pos, *n; + struct eficonfig_entry *entry; + + list_for_each_safe(pos, n, &efi_menu->list) { + entry = list_entry(pos, struct eficonfig_entry, list); + free(entry->title); + list_del(&entry->list); + free(entry); + } + free(efi_menu->menu_header); + free(efi_menu); +} + +/** + * eficonfig_process_quit() - callback function for "Quit" entry + * + * @data: pointer to the data + * Return: status code + */ +efi_status_t eficonfig_process_quit(void *data) +{ + return EFI_ABORTED; +} + +/** + * append_entry() - append menu item + * + * @efi_menu: pointer to the efimenu structure + * @title: pointer to the entry title + * @func: callback of each entry + * @data: pointer to the data to be passed to each entry callback + * Return: status code + */ +static efi_status_t append_entry(struct efimenu *efi_menu, + char *title, eficonfig_entry_func func, void *data) +{ + struct eficonfig_entry *entry; + + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX) + return EFI_OUT_OF_RESOURCES; + + entry = calloc(1, sizeof(struct eficonfig_entry)); + if (!entry) + return EFI_OUT_OF_RESOURCES; + + entry->title = title; + sprintf(entry->key, "%d", efi_menu->count); + entry->efi_menu = efi_menu; + entry->func = func; + entry->data = data; + entry->num = efi_menu->count++; + list_add_tail(&entry->list, &efi_menu->list); + + return EFI_SUCCESS; +} + +/** + * append_quit_entry() - append quit entry + * + * @efi_menu: pointer to the efimenu structure + * Return: status code + */ +static efi_status_t append_quit_entry(struct efimenu *efi_menu) +{ + char *title; + efi_status_t ret; + + title = strdup("Quit"); + if (!title) + return EFI_OUT_OF_RESOURCES; + + ret = append_entry(efi_menu, title, eficonfig_process_quit, NULL); + if (ret != EFI_SUCCESS) + free(title); + + return ret; +} + +/** + * eficonfig_create_fixed_menu() - create fixed entry menu structure + * + * @items: pointer to the menu entry item + * @count: the number of menu entry + * Return: pointer to the efimenu structure + */ +void *eficonfig_create_fixed_menu(const struct eficonfig_item *items, int count) +{ + u32 i; + char *title; + efi_status_t ret; + struct efimenu *efi_menu; + const struct eficonfig_item *iter = items; + + efi_menu = calloc(1, sizeof(struct efimenu)); + if (!efi_menu) + return NULL; + + INIT_LIST_HEAD(&efi_menu->list); + for (i = 0; i < count; i++, iter++) { + title = strdup(iter->title); + if (!title) + goto out; + + ret = append_entry(efi_menu, title, iter->func, iter->data); + if (ret != EFI_SUCCESS) { + free(title); + goto out; + } + } + + return efi_menu; +out: + eficonfig_destroy(efi_menu); + + return NULL; +} + +/** + * eficonfig_process_common() - main handler for UEFI menu + * + * Construct the structures required to show the menu, then handle + * the user input interacting with u-boot menu functions. + * + * @efi_menu: pointer to the efimenu structure + * @menu_header: pointer to the menu header string + * Return: status code + */ +efi_status_t eficonfig_process_common(struct efimenu *efi_menu, char *menu_header) +{ + struct menu *menu; + void *choice = NULL; + struct list_head *pos, *n; + struct eficonfig_entry *entry; + efi_status_t ret = EFI_SUCCESS; + + if (efi_menu->count > EFICONFIG_ENTRY_NUM_MAX) + return EFI_OUT_OF_RESOURCES; + + efi_menu->delay = -1; + efi_menu->active = 0; + + if (menu_header) { + efi_menu->menu_header = strdup(menu_header); + if (!efi_menu->menu_header) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + } + + menu = menu_create(NULL, 0, 1, eficonfig_display_statusline, + eficonfig_print_entry, eficonfig_choice_entry, + efi_menu); + if (!menu) { + ret = EFI_INVALID_PARAMETER; + goto out; + } + + list_for_each_safe(pos, n, &efi_menu->list) { + entry = list_entry(pos, struct eficonfig_entry, list); + if (!menu_item_add(menu, entry->key, entry)) { + ret = EFI_INVALID_PARAMETER; + goto out; + } + } + + entry = list_first_entry_or_null(&efi_menu->list, struct eficonfig_entry, list); + if (entry) + menu_default_set(menu, entry->key); + + printf(ANSI_CURSOR_HIDE + ANSI_CLEAR_CONSOLE + ANSI_CURSOR_POSITION, 1, 1); + + if (menu_get_choice(menu, &choice)) { + entry = choice; + if (entry->func) + ret = entry->func(entry->data); + } +out: + menu_destroy(menu); + + printf(ANSI_CLEAR_CONSOLE + ANSI_CURSOR_POSITION + ANSI_CURSOR_SHOW, 1, 1); + + return ret; +} + +/** + * eficonfig_volume_selected() - handler of volume selection + * + * @data: pointer to the data of selected entry + * Return: status code + */ +static efi_status_t eficonfig_volume_selected(void *data) +{ + struct eficonfig_volume_entry_data *info = data; + + if (info) { + info->file_info->current_volume = info->v; + info->file_info->dp_volume = info->dp; + } + + return EFI_SUCCESS; +} + +/** + * create_selected_device_path() - create device path + * + * @file_info: pointer to the selected file information + * Return: + * device path or NULL. Caller must free the returned value + */ +static +struct efi_device_path *create_selected_device_path(struct eficonfig_select_file_info *file_info) +{ + char *p; + void *buf; + efi_uintn_t fp_size; + struct efi_device_path *dp; + struct efi_device_path_file_path *fp; + + fp_size = sizeof(struct efi_device_path) + + ((u16_strlen(file_info->current_path) + 1) * sizeof(u16)); + buf = calloc(1, fp_size + sizeof(END)); + if (!buf) + return NULL; + + fp = buf; + fp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, + fp->dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, + fp->dp.length = (u16)fp_size; + u16_strcpy(fp->str, file_info->current_path); + + p = buf; + p += fp_size; + *((struct efi_device_path *)p) = END; + + dp = efi_dp_append(file_info->dp_volume, (struct efi_device_path *)buf); + free(buf); + + return dp; +} + +/** + * eficonfig_file_selected() - handler of file selection + * + * @data: pointer to the data of selected entry + * Return: status code + */ +static efi_status_t eficonfig_file_selected(void *data) +{ + struct eficonfig_file_entry_data *info = data; + + if (!info) + return EFI_INVALID_PARAMETER; + + if (u16_strcmp(info->file_name, u".") == 0 && + u16_strlen(info->file_name) == 1) { + /* stay current path */ + } else if (u16_strcmp(info->file_name, u"..") == 0 && + u16_strlen(info->file_name) == 2) { + struct eficonfig_filepath_info *iter; + struct list_head *pos, *n; + int is_last; + + memset(info->file_info->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE); + list_for_each_safe(pos, n, &info->file_info->filepath_list) { + iter = list_entry(pos, struct eficonfig_filepath_info, list); + + is_last = list_is_last(&iter->list, &info->file_info->filepath_list); + if (is_last) { + list_del(&iter->list); + free(iter->name); + free(iter); + break; + } + u16_strlcat(info->file_info->current_path, iter->name, + EFICONFIG_FILE_PATH_MAX); + u16_strlcat(info->file_info->current_path, u"\\", + EFICONFIG_FILE_PATH_MAX); + } + } else { + size_t new_len; + struct eficonfig_filepath_info *filepath; + + new_len = u16_strlen(info->file_info->current_path) + + u16_strlen(info->file_name); + if (new_len >= EFICONFIG_FILE_PATH_MAX) { + eficonfig_print_msg("File path is too long!"); + return EFI_INVALID_PARAMETER; + } + u16_strlcat(info->file_info->current_path, info->file_name, + EFICONFIG_FILE_PATH_MAX); + + filepath = calloc(1, sizeof(struct eficonfig_filepath_info)); + if (!filepath) + return EFI_OUT_OF_RESOURCES; + + filepath->name = u16_strdup(info->file_name); + if (!filepath->name) { + free(filepath); + return EFI_OUT_OF_RESOURCES; + } + list_add_tail(&filepath->list, &info->file_info->filepath_list); + + if (info->is_directory) { + /* + * Remaining buffer should have enough space to contain u"\\" and + * at least one character for file name + */ + if (new_len + 2 >= EFICONFIG_FILE_PATH_MAX) { + eficonfig_print_msg("Directory path is too long!"); + return EFI_INVALID_PARAMETER; + } + u16_strlcat(info->file_info->current_path, u"\\", + EFICONFIG_FILE_PATH_MAX); + } else { + info->file_info->file_selected = true; + } + } + return EFI_SUCCESS; +} + +/** + * eficonfig_select_volume() - construct the volume selection menu + * + * @file_info: pointer to the file selection structure + * Return: status code + */ +static efi_status_t eficonfig_select_volume(struct eficonfig_select_file_info *file_info) +{ + u32 i; + efi_status_t ret; + efi_uintn_t count; + struct efimenu *efi_menu; + struct list_head *pos, *n; + struct efi_handler *handler; + struct eficonfig_entry *entry; + struct efi_device_path *device_path; + efi_handle_t *volume_handles = NULL; + struct efi_simple_file_system_protocol *v; + + ret = efi_locate_handle_buffer_int(BY_PROTOCOL, &efi_simple_file_system_protocol_guid, + NULL, &count, (efi_handle_t **)&volume_handles); + if (ret != EFI_SUCCESS) { + eficonfig_print_msg("No block device found!"); + return ret; + } + + efi_menu = calloc(1, sizeof(struct efimenu)); + if (!efi_menu) + return EFI_OUT_OF_RESOURCES; + + INIT_LIST_HEAD(&efi_menu->list); + for (i = 0; i < count; i++) { + char *devname; + struct efi_block_io *block_io; + struct eficonfig_volume_entry_data *info; + + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1) + break; + + ret = efi_search_protocol(volume_handles[i], + &efi_simple_file_system_protocol_guid, &handler); + if (ret != EFI_SUCCESS) + continue; + ret = efi_protocol_open(handler, (void **)&v, efi_root, NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) + continue; + + ret = efi_search_protocol(volume_handles[i], &efi_guid_device_path, &handler); + if (ret != EFI_SUCCESS) + continue; + ret = efi_protocol_open(handler, (void **)&device_path, + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) + continue; + + ret = efi_search_protocol(volume_handles[i], &efi_block_io_guid, &handler); + if (ret != EFI_SUCCESS) + continue; + ret = efi_protocol_open(handler, (void **)&block_io, + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) + continue; + + info = calloc(1, sizeof(struct eficonfig_volume_entry_data)); + if (!info) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + + devname = calloc(1, BOOTMENU_DEVICE_NAME_MAX); + if (!devname) { + free(info); + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + ret = efi_disk_get_device_name(volume_handles[i], devname, + BOOTMENU_DEVICE_NAME_MAX); + if (ret != EFI_SUCCESS) { + free(info); + goto out; + } + + info->v = v; + info->dp = device_path; + info->file_info = file_info; + ret = append_entry(efi_menu, devname, eficonfig_volume_selected, info); + if (ret != EFI_SUCCESS) { + free(info); + goto out; + } + } + + ret = append_quit_entry(efi_menu); + if (ret != EFI_SUCCESS) + goto out; + + ret = eficonfig_process_common(efi_menu, " ** Select Volume **"); +out: + efi_free_pool(volume_handles); + list_for_each_safe(pos, n, &efi_menu->list) { + entry = list_entry(pos, struct eficonfig_entry, list); + free(entry->data); + } + eficonfig_destroy(efi_menu); + + return ret; +} + +/** + * eficonfig_select_file() - construct the file selection menu + * + * @file_info: pointer to the file selection structure + * @root: pointer to the file handle + * Return: status code + */ +static efi_status_t eficonfig_select_file(struct eficonfig_select_file_info *file_info, + struct efi_file_handle *root) +{ + efi_uintn_t len; + efi_status_t ret; + struct efimenu *efi_menu; + struct efi_file_handle *f; + struct efi_file_info *buf; + struct list_head *pos, *n; + + buf = calloc(1, sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE); + if (!buf) + return EFI_OUT_OF_RESOURCES; + + while (!file_info->file_selected) { + efi_menu = calloc(1, sizeof(struct efimenu)); + if (!efi_menu) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + INIT_LIST_HEAD(&efi_menu->list); + + ret = efi_file_open_int(root, &f, file_info->current_path, EFI_FILE_MODE_READ, 0); + if (ret != EFI_SUCCESS) { + eficonfig_print_msg("Reading volume failed!"); + ret = EFI_ABORTED; + goto out; + } + + /* Read directory and construct menu structure */ + for (;;) { + char *name, *p; + int name_len; + struct eficonfig_file_entry_data *info; + + if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1) + break; + + len = sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE; + ret = efi_file_read_int(f, &len, buf); + if (ret != EFI_SUCCESS || len == 0) + break; + + info = calloc(1, sizeof(struct eficonfig_file_entry_data)); + if (!info) { + ret = EFI_OUT_OF_RESOURCES; + goto err; + } + + if (buf->attribute & EFI_FILE_DIRECTORY) { + /* append u'/' at the end of directory name */ + name_len = utf16_utf8_strlen(buf->file_name) + 2; + + /* filter out u'.' */ + if (name_len == 3 && buf->file_name[0] == u'.') { + free(info); + continue; + } + + name = calloc(1, name_len); + if (!name) { + free(info); + ret = EFI_OUT_OF_RESOURCES; + goto err; + } + p = name; + utf16_utf8_strcpy(&p, buf->file_name); + name[u16_strlen(buf->file_name)] = u'/'; + + info->is_directory = true; + } else { + name_len = utf16_utf8_strlen(buf->file_name) + 1; + name = calloc(1, name_len); + if (!name) { + free(info); + ret = EFI_OUT_OF_RESOURCES; + goto err; + } + p = name; + utf16_utf8_strcpy(&p, buf->file_name); + } + + info->file_name = u16_strdup(buf->file_name); + if (!info->file_name) { + free(info); + free(name); + ret = EFI_OUT_OF_RESOURCES; + goto err; + } + + info->file_info = file_info; + ret = append_entry(efi_menu, name, eficonfig_file_selected, info); + if (ret != EFI_SUCCESS) { + free(info); + free(name); + goto err; + } + } + + ret = append_quit_entry(efi_menu); + if (ret != EFI_SUCCESS) + goto err; + + ret = eficonfig_process_common(efi_menu, " ** Select File **"); +err: + efi_file_close_int(f); + list_for_each_safe(pos, n, &efi_menu->list) { + struct eficonfig_entry *entry; + + entry = list_entry(pos, struct eficonfig_entry, list); + /* skip "Quit" */ + if (list_is_last(&entry->list, &efi_menu->list)) + break; + + free(((struct eficonfig_file_entry_data *)(entry->data))->file_name); + free(entry->data); + } + eficonfig_destroy(efi_menu); + if (ret != EFI_SUCCESS) + break; + } + +out: + free(buf); + return ret; +} + +/** + * handle_user_input() - handle user input + * + * @buf: pointer to the buffer + * @buf_size: size of the buffer + * @cursor_col: cursor column for user input + * @msg: pointer to the string to display + * Return: status code + */ +static efi_status_t handle_user_input(u16 *buf, int buf_size, + int cursor_col, char *msg) +{ + u16 *tmp; + efi_status_t ret; + + printf(ANSI_CLEAR_CONSOLE + ANSI_CURSOR_POSITION + "%s" + ANSI_CURSOR_POSITION + " Press ENTER to complete, ESC/CTRL+C to quit", + 0, 1, msg, 8, 1); + + /* tmp is used to accept user cancel */ + tmp = calloc(1, buf_size * sizeof(u16)); + if (!tmp) + return EFI_OUT_OF_RESOURCES; + + ret = efi_console_get_u16_string(cin, tmp, buf_size, NULL, 4, cursor_col); + if (ret == EFI_SUCCESS) + u16_strcpy(buf, tmp); + + free(tmp); + + /* to stay the parent menu */ + ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret; + + return ret; +} + +/** + * eficonfig_boot_add_enter_description() - handle user input for description + * + * @data: pointer to the internal boot option structure + * Return: status code + */ +static efi_status_t eficonfig_boot_add_enter_description(void *data) +{ + struct eficonfig_boot_option *bo = data; + + return handle_user_input(bo->description, EFICONFIG_DESCRIPTION_MAX, 22, + "\n ** Edit Description **\n" + "\n" + " enter description: "); +} + +/** + * eficonfig_boot_add_optional_data() - handle user input for optional data + * + * @data: pointer to the internal boot option structure + * Return: status code + */ +static efi_status_t eficonfig_boot_add_optional_data(void *data) +{ + struct eficonfig_boot_option *bo = data; + + return handle_user_input(bo->optional_data, EFICONFIG_OPTIONAL_DATA_MAX, 24, + "\n ** Edit Optional Data **\n" + "\n" + " enter optional data:"); +} + +/** + * eficonfig_boot_edit_save() - handler to save the boot option + * + * @data: pointer to the internal boot option structure + * Return: status code + */ +static efi_status_t eficonfig_boot_edit_save(void *data) +{ + struct eficonfig_boot_option *bo = data; + + if (u16_strlen(bo->description) == 0) { + eficonfig_print_msg("Boot Description is empty!"); + bo->edit_completed = false; + return EFI_NOT_READY; + } + if (u16_strlen(bo->file_info.current_path) == 0) { + eficonfig_print_msg("File is not selected!"); + bo->edit_completed = false; + return EFI_NOT_READY; + } + + bo->edit_completed = true; + + return EFI_SUCCESS; +} + +/** + * eficonfig_process_select_file() - callback function for "Select File" entry + * + * @data: pointer to the data + * Return: status code + */ +efi_status_t eficonfig_process_select_file(void *data) +{ + return EFI_SUCCESS; +} + +/** + * eficonfig_process_clear_file_selection() - callback function for "Clear" entry + * + * @data: pointer to the data + * Return: status code + */ +efi_status_t eficonfig_process_clear_file_selection(void *data) +{ + struct eficonfig_select_file_info *file_info = data; + + /* clear the existing file information */ + file_info->current_volume = NULL; + file_info->current_path[0] = u'\0'; + file_info->dp_volume = NULL; + + return EFI_ABORTED; +} + +static struct eficonfig_item select_file_menu_items[] = { + {"Select File", eficonfig_process_select_file}, + {"Clear", eficonfig_process_clear_file_selection}, + {"Quit", eficonfig_process_quit}, +}; + + +/** + * eficonfig_display_select_file_option() - display select file option + * + * @file_info: pointer to the file information structure + * Return: status code + */ +efi_status_t eficonfig_display_select_file_option(struct eficonfig_select_file_info *file_info) +{ + efi_status_t ret; + struct efimenu *efi_menu; + + select_file_menu_items[1].data = file_info; + efi_menu = eficonfig_create_fixed_menu(select_file_menu_items, + ARRAY_SIZE(select_file_menu_items)); + if (!efi_menu) + return EFI_OUT_OF_RESOURCES; + + ret = eficonfig_process_common(efi_menu, " ** Update File **"); + if (ret != EFI_SUCCESS) /* User selects "Clear" or "Quit" */ + ret = EFI_NOT_READY; + + eficonfig_destroy(efi_menu); + + return ret; +} + +/** + * eficonfig_select_file_handler() - handle user file selection + * + * @data: pointer to the data + * Return: status code + */ +efi_status_t eficonfig_select_file_handler(void *data) +{ + size_t len; + efi_status_t ret; + struct list_head *pos, *n; + struct efi_file_handle *root; + struct eficonfig_filepath_info *item; + struct eficonfig_select_file_info *tmp = NULL; + struct eficonfig_select_file_info *file_info = data; + + ret = eficonfig_display_select_file_option(file_info); + if (ret != EFI_SUCCESS) + return ret; + + tmp = calloc(1, sizeof(struct eficonfig_select_file_info)); + if (!tmp) + return EFI_OUT_OF_RESOURCES; + + tmp->current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); + if (!tmp->current_path) { + free(tmp); + return EFI_OUT_OF_RESOURCES; + } + INIT_LIST_HEAD(&tmp->filepath_list); + + while (!tmp->file_selected) { + tmp->current_volume = NULL; + memset(tmp->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE); + + ret = eficonfig_select_volume(tmp); + if (ret != EFI_SUCCESS) + goto out; + + if (!tmp->current_volume) + return EFI_INVALID_PARAMETER; + + ret = efi_open_volume_int(tmp->current_volume, &root); + if (ret != EFI_SUCCESS) + goto out; + + ret = eficonfig_select_file(tmp, root); + if (ret == EFI_ABORTED) + continue; + if (ret != EFI_SUCCESS) + goto out; + } + +out: + if (ret == EFI_SUCCESS) { + len = u16_strlen(tmp->current_path); + len = (len >= EFICONFIG_FILE_PATH_MAX) ? (EFICONFIG_FILE_PATH_MAX - 1) : len; + memcpy(file_info->current_path, tmp->current_path, len * sizeof(u16)); + file_info->current_path[len] = u'\0'; + file_info->current_volume = tmp->current_volume; + file_info->dp_volume = tmp->dp_volume; + } + + list_for_each_safe(pos, n, &tmp->filepath_list) { + item = list_entry(pos, struct eficonfig_filepath_info, list); + list_del(&item->list); + free(item->name); + free(item); + } + free(tmp->current_path); + free(tmp); + + /* to stay the parent menu */ + ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret; + + return ret; +} + +/** + * eficonfig_get_unused_bootoption() - get unused "Boot####" index + * + * @buf: pointer to the buffer to store boot option variable name + * @buf_size: buffer size + * @index: pointer to store the index in the BootOrder variable + * Return: status code + */ +efi_status_t eficonfig_get_unused_bootoption(u16 *buf, efi_uintn_t buf_size, + unsigned int *index) +{ + u32 i; + efi_status_t ret; + efi_uintn_t size; + + if (buf_size < u16_strsize(u"Boot####")) + return EFI_BUFFER_TOO_SMALL; + + for (i = 0; i <= 0xFFFF; i++) { + size = 0; + efi_create_indexed_name(buf, buf_size, "Boot", i); + ret = efi_get_variable_int(buf, &efi_global_variable_guid, + NULL, &size, NULL, NULL); + if (ret == EFI_BUFFER_TOO_SMALL) + continue; + else + break; + } + + if (i > 0xFFFF) + return EFI_OUT_OF_RESOURCES; + + *index = i; + + return EFI_SUCCESS; +} + +/** + * eficonfig_set_boot_option() - set boot option + * + * @varname: pointer to variable name + * @dp: pointer to device path + * @label: pointer to label string + * @optional_data: pointer to optional data + * Return: status code + */ +static efi_status_t eficonfig_set_boot_option(u16 *varname, struct efi_device_path *dp, + efi_uintn_t dp_size, u16 *label, char *optional_data) +{ + void *p = NULL; + efi_status_t ret; + efi_uintn_t size; + struct efi_load_option lo; + + lo.file_path = dp; + lo.file_path_length = dp_size; + lo.attributes = LOAD_OPTION_ACTIVE; + lo.optional_data = optional_data; + lo.label = label; + + size = efi_serialize_load_option(&lo, (u8 **)&p); + if (!size) + return EFI_INVALID_PARAMETER; + + ret = efi_set_variable_int(varname, &efi_global_variable_guid, + EFI_VARIABLE_NON_VOLATILE | + EFI_VARIABLE_BOOTSERVICE_ACCESS | + EFI_VARIABLE_RUNTIME_ACCESS, + size, p, false); + free(p); + + return ret; +} + +/** + * eficonfig_append_bootorder() - append new boot option in BootOrder variable + * + * @index: "Boot####" index to append to BootOrder variable + * Return: status code + */ +efi_status_t eficonfig_append_bootorder(u16 index) +{ + u16 *bootorder; + efi_status_t ret; + u16 *new_bootorder = NULL; + efi_uintn_t last, size, new_size; + + /* append new boot option */ + bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size); + last = size / sizeof(u16); + new_size = size + sizeof(u16); + new_bootorder = calloc(1, new_size); + if (!new_bootorder) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + memcpy(new_bootorder, bootorder, size); + new_bootorder[last] = index; + + ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid, + EFI_VARIABLE_NON_VOLATILE | + EFI_VARIABLE_BOOTSERVICE_ACCESS | + EFI_VARIABLE_RUNTIME_ACCESS, + new_size, new_bootorder, false); + if (ret != EFI_SUCCESS) + goto out; + +out: + free(bootorder); + free(new_bootorder); + + return ret; +} + +/** + * create_boot_option_entry() - create boot option entry + * + * @efi_menu: pointer to the efimenu structure + * @title: pointer to the entry title + * @val: pointer to boot option label + * @func: callback of each entry + * @data: pointer to the data to be passed to each entry callback + * Return: status code + */ +static efi_status_t create_boot_option_entry(struct efimenu *efi_menu, char *title, u16 *val, + eficonfig_entry_func func, void *data) +{ + u32 len; + char *p, *buf; + + len = strlen(title) + 1; + if (val) + len += utf16_utf8_strlen(val); + buf = calloc(1, len); + if (!buf) + return EFI_OUT_OF_RESOURCES; + + strcpy(buf, title); + if (val) { + p = buf + strlen(title); + utf16_utf8_strcpy(&p, val); + } + + return append_entry(efi_menu, buf, func, data); +} + +/** + * prepare_file_selection_entry() - prepare file selection entry + * + * @efi_menu: pointer to the efimenu structure + * @title: pointer to the title string + * @file_info: pointer to the file info + * Return: status code + */ +static efi_status_t prepare_file_selection_entry(struct efimenu *efi_menu, char *title, + struct eficonfig_select_file_info *file_info) +{ + u32 len; + efi_status_t ret; + u16 *file_name, *p; + efi_handle_t handle; + char devname[BOOTMENU_DEVICE_NAME_MAX] = {0}; + + /* get the device name only when the user already selected the file path */ + handle = efi_dp_find_obj(file_info->dp_volume, NULL, NULL); + if (handle) { + ret = efi_disk_get_device_name(handle, devname, BOOTMENU_DEVICE_NAME_MAX); + if (ret != EFI_SUCCESS) + return ret; + } + + /* append u'/' to devname, it is just for display purpose. */ + if (file_info->current_path[0] != u'\0' && file_info->current_path[0] != u'/') + strlcat(devname, "/", BOOTMENU_DEVICE_NAME_MAX); + + len = strlen(devname); + len += utf16_utf8_strlen(file_info->current_path) + 1; + file_name = calloc(1, len * sizeof(u16)); + if (!file_name) + return ret; + + p = file_name; + utf8_utf16_strcpy(&p, devname); + u16_strlcat(file_name, file_info->current_path, len); + ret = create_boot_option_entry(efi_menu, title, file_name, + eficonfig_select_file_handler, file_info); + free(file_name); + return ret; +} + +/** + * eficonfig_show_boot_option() - prepare menu entry for editing boot option + * + * Construct the structures to create edit boot option menu + * + * @bo: pointer to the boot option + * @header_str: pointer to the header string + * Return: status code + */ +static efi_status_t eficonfig_show_boot_option(struct eficonfig_boot_option *bo, + char *header_str) +{ + efi_status_t ret; + struct efimenu *efi_menu; + + efi_menu = calloc(1, sizeof(struct efimenu)); + if (!efi_menu) + return EFI_OUT_OF_RESOURCES; + + INIT_LIST_HEAD(&efi_menu->list); + + ret = create_boot_option_entry(efi_menu, "Description: ", bo->description, + eficonfig_boot_add_enter_description, bo); + if (ret != EFI_SUCCESS) + goto out; + + ret = prepare_file_selection_entry(efi_menu, "File: ", &bo->file_info); + if (ret != EFI_SUCCESS) + goto out; + + ret = prepare_file_selection_entry(efi_menu, "Initrd File: ", &bo->initrd_info); + if (ret != EFI_SUCCESS) + goto out; + + ret = create_boot_option_entry(efi_menu, "Optional Data: ", bo->optional_data, + eficonfig_boot_add_optional_data, bo); + if (ret != EFI_SUCCESS) + goto out; + + ret = create_boot_option_entry(efi_menu, "Save", NULL, + eficonfig_boot_edit_save, bo); + if (ret != EFI_SUCCESS) + goto out; + + ret = create_boot_option_entry(efi_menu, "Quit", NULL, + eficonfig_process_quit, NULL); + if (ret != EFI_SUCCESS) + goto out; + + ret = eficonfig_process_common(efi_menu, header_str); +out: + eficonfig_destroy(efi_menu); + + return ret; +} + +/** + * fill_file_info() - fill the file info from efi_device_path structure + * + * @dp: pointer to the device path + * @file_info: pointer to the file info structure + * @device_dp: pointer to the volume device path + */ +static void fill_file_info(struct efi_device_path *dp, + struct eficonfig_select_file_info *file_info, + struct efi_device_path *device_dp) +{ + u16 *file_str, *p; + struct efi_device_path *file_dp = NULL; + + efi_dp_split_file_path(dp, &device_dp, &file_dp); + file_info->dp_volume = device_dp; + + if (file_dp) { + file_str = efi_dp_str(file_dp); + /* + * efi_convert_device_path_to_text() automatically adds u'/' at the + * beginning of file name, remove u'/' before copying to current_path + */ + p = file_str; + if (p[0] == u'/') + p++; + + u16_strcpy(file_info->current_path, p); + efi_free_pool(file_dp); + efi_free_pool(file_str); + } +} + +/** + * eficonfig_edit_boot_option() - prepare boot option structure for editing + * + * Construct the boot option structure and copy the existing value + * + * @varname: pointer to the UEFI variable name + * @bo: pointer to the boot option + * @load_option: pointer to the load option + * @load_option_size: size of the load option + * @header_str: pointer to the header string + * Return : status code + */ +static efi_status_t eficonfig_edit_boot_option(u16 *varname, struct eficonfig_boot_option *bo, + void *load_option, efi_uintn_t load_option_size, + char *header_str) +{ + size_t len; + efi_status_t ret; + char *tmp = NULL, *p; + struct efi_load_option lo = {0}; + efi_uintn_t final_dp_size; + struct efi_device_path *dp = NULL; + efi_uintn_t size = load_option_size; + struct efi_device_path *final_dp = NULL; + struct efi_device_path *device_dp = NULL; + struct efi_device_path *initrd_dp = NULL; + struct efi_device_path *initrd_device_dp = NULL; + + const struct efi_initrd_dp id_dp = { + .vendor = { + { + DEVICE_PATH_TYPE_MEDIA_DEVICE, + DEVICE_PATH_SUB_TYPE_VENDOR_PATH, + sizeof(id_dp.vendor), + }, + EFI_INITRD_MEDIA_GUID, + }, + .end = { + DEVICE_PATH_TYPE_END, + DEVICE_PATH_SUB_TYPE_END, + sizeof(id_dp.end), + } + }; + + bo->file_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); + if (!bo->file_info.current_path) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + + bo->initrd_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE); + if (!bo->file_info.current_path) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + + bo->description = calloc(1, EFICONFIG_DESCRIPTION_MAX * sizeof(u16)); + if (!bo->description) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + + bo->optional_data = calloc(1, EFICONFIG_OPTIONAL_DATA_MAX * sizeof(u16)); + if (!bo->optional_data) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + + /* copy the preset value */ + if (load_option) { + ret = efi_deserialize_load_option(&lo, load_option, &size); + if (ret != EFI_SUCCESS) + goto out; + + if (!lo.label || (lo.label && u16_strlen(lo.label) >= EFICONFIG_DESCRIPTION_MAX)) { + ret = EFI_INVALID_PARAMETER; + goto out; + } + u16_strcpy(bo->description, lo.label); + + /* EFI image file path is a first instance */ + if (lo.file_path) + fill_file_info(lo.file_path, &bo->file_info, device_dp); + + /* Initrd file path(optional) is placed at second instance. */ + initrd_dp = efi_dp_from_lo(&lo, &efi_lf2_initrd_guid); + if (initrd_dp) { + fill_file_info(initrd_dp, &bo->initrd_info, initrd_device_dp); + efi_free_pool(initrd_dp); + } + + if (size > 0) + memcpy(bo->optional_data, lo.optional_data, size); + } + + while (1) { + ret = eficonfig_show_boot_option(bo, header_str); + if (ret == EFI_SUCCESS && bo->edit_completed) + break; + if (ret == EFI_NOT_READY) + continue; + if (ret != EFI_SUCCESS) + goto out; + } + + if (bo->initrd_info.dp_volume) { + dp = create_selected_device_path(&bo->initrd_info); + if (!dp) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + initrd_dp = efi_dp_append((const struct efi_device_path *)&id_dp, dp); + efi_free_pool(dp); + } + + dp = create_selected_device_path(&bo->file_info); + if (!dp) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + final_dp_size = efi_dp_size(dp) + sizeof(END); + if (initrd_dp) { + final_dp = efi_dp_concat(dp, initrd_dp); + final_dp_size += efi_dp_size(initrd_dp) + sizeof(END); + } else { + final_dp = efi_dp_dup(dp); + } + efi_free_pool(dp); + + if (!final_dp) + goto out; + + if (utf16_utf8_strlen(bo->optional_data)) { + len = utf16_utf8_strlen(bo->optional_data) + 1; + tmp = calloc(1, len); + if (!tmp) + goto out; + p = tmp; + utf16_utf8_strncpy(&p, bo->optional_data, u16_strlen(bo->optional_data)); + } + + ret = eficonfig_set_boot_option(varname, final_dp, final_dp_size, bo->description, tmp); + if (ret != EFI_SUCCESS) + goto out; +out: + free(tmp); + free(bo->optional_data); + free(bo->description); + free(bo->file_info.current_path); + free(bo->initrd_info.current_path); + efi_free_pool(device_dp); + efi_free_pool(initrd_device_dp); + efi_free_pool(initrd_dp); + efi_free_pool(final_dp); + + return ret; +} + +/** + * eficonfig_process_add_boot_option() - handler to add boot option + * + * @data: pointer to the data for each entry + * Return: status code + */ +static efi_status_t eficonfig_process_add_boot_option(void *data) +{ + u16 varname[9]; + efi_status_t ret; + struct eficonfig_boot_option *bo = NULL; + + bo = calloc(1, sizeof(struct eficonfig_boot_option)); + if (!bo) + return EFI_OUT_OF_RESOURCES; + + ret = eficonfig_get_unused_bootoption(varname, sizeof(varname), &bo->boot_index); + if (ret != EFI_SUCCESS) + return ret; + + ret = eficonfig_edit_boot_option(varname, bo, NULL, 0, " ** Add Boot Option ** "); + if (ret != EFI_SUCCESS) + goto out; + + ret = eficonfig_append_bootorder((u16)bo->boot_index); + if (ret != EFI_SUCCESS) + goto out; + +out: + free(bo); + + /* to stay the parent menu */ + ret = (ret == EFI_ABORTED) ? EFI_SUCCESS : ret; + + return ret; +} + +/** + * eficonfig_init() - do required initialization for eficonfig command + * + * Return: status code + */ +static efi_status_t eficonfig_init(void) +{ + efi_status_t ret = EFI_SUCCESS; + static bool init; + struct efi_handler *handler; + + if (!init) { + ret = efi_search_protocol(efi_root, &efi_guid_text_input_protocol, &handler); + if (ret != EFI_SUCCESS) + return ret; + + ret = efi_protocol_open(handler, (void **)&cin, efi_root, NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) + return ret; + } + + init = true; + + return ret; +} + +static const struct eficonfig_item maintenance_menu_items[] = { + {"Add Boot Option", eficonfig_process_add_boot_option}, + {"Quit", eficonfig_process_quit}, +}; + +/** + * do_eficonfig() - execute `eficonfig` command + * + * @cmdtp: table entry describing command + * @flag: bitmap indicating how the command was invoked + * @argc: number of arguments + * @argv: command line arguments + * Return: status code + */ +static int do_eficonfig(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) +{ + efi_status_t ret; + struct efimenu *efi_menu; + + if (argc > 1) + return CMD_RET_USAGE; + + ret = efi_init_obj_list(); + if (ret != EFI_SUCCESS) { + log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n", + ret & ~EFI_ERROR_MASK); + + return CMD_RET_FAILURE; + } + + ret = eficonfig_init(); + if (ret != EFI_SUCCESS) + return CMD_RET_FAILURE; + + while (1) { + efi_menu = eficonfig_create_fixed_menu(maintenance_menu_items, + ARRAY_SIZE(maintenance_menu_items)); + if (!efi_menu) + return CMD_RET_FAILURE; + + ret = eficonfig_process_common(efi_menu, " ** UEFI Maintenance Menu **"); + eficonfig_destroy(efi_menu); + + if (ret == EFI_ABORTED) + break; + } + + return CMD_RET_SUCCESS; +} + +U_BOOT_CMD( + eficonfig, 1, 0, do_eficonfig, + "provide menu-driven UEFI variable maintenance interface", + "" +); diff --git a/include/efi_config.h b/include/efi_config.h new file mode 100644 index 0000000000..ea5bc4e1bf --- /dev/null +++ b/include/efi_config.h @@ -0,0 +1,96 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ +/* + * Menu-driven UEFI Variable maintenance + * + * Copyright (c) 2022 Masahisa Kojima, Linaro Limited + */ + +#ifndef _EFI_CONFIG_H +#define _EFI_CONFIG_H + +#include <efi_loader.h> + +#define EFICONFIG_ENTRY_NUM_MAX 99 +#define EFICONFIG_FILE_PATH_MAX 512 +#define EFICONFIG_FILE_PATH_BUF_SIZE (EFICONFIG_FILE_PATH_MAX * sizeof(u16)) + +typedef efi_status_t (*eficonfig_entry_func)(void *data); + +/** + * struct eficonfig_entry - menu entry structure + * + * @num: menu entry index + * @title: title of entry + * @key: unique key + * @efi_menu: pointer to the menu structure + * @func: callback function to be called when this entry is selected + * @data: data to be passed to the callback function, caller must free() this pointer + * @list: list structure + */ +struct eficonfig_entry { + u32 num; + char *title; + char key[3]; + struct efimenu *efi_menu; + eficonfig_entry_func func; + void *data; + struct list_head list; +}; + +/** + * struct efimenu - efi menu structure + * + * @delay: delay for autoboot + * @active: active menu entry index + * @count: total count of menu entry + * @menu_header: menu header string + * @list: menu entry list structure + */ +struct efimenu { + int delay; + int active; + int count; + char *menu_header; + struct list_head list; +}; + +/** + * struct eficonfig_item - structure to construct eficonfig_entry + * + * @title: title of entry + * @func: callback function to be called when this entry is selected + * @data: data to be passed to the callback function + */ +struct eficonfig_item { + char *title; + eficonfig_entry_func func; + void *data; +}; + +/** + * struct eficonfig_select_file_info - structure to be used for file selection + * + * @current_volume: pointer to the efi_simple_file_system_protocol + * @dp_volume: pointer to device path of the selected device + * @current_path: pointer to the selected file path string + * @filepath_list: list_head structure for file path list + * @file_selectred: flag indicates file selecting status + */ +struct eficonfig_select_file_info { + struct efi_simple_file_system_protocol *current_volume; + struct efi_device_path *dp_volume; + u16 *current_path; + struct list_head filepath_list; + bool file_selected; +}; + +void eficonfig_print_msg(char *msg); +void eficonfig_destroy(struct efimenu *efi_menu); +efi_status_t eficonfig_process_quit(void *data); +efi_status_t eficonfig_process_common(struct efimenu *efi_menu, char *menu_header); +efi_status_t eficonfig_select_file_handler(void *data); +efi_status_t eficonfig_get_unused_bootoption(u16 *buf, + efi_uintn_t buf_size, u32 *index); +efi_status_t eficonfig_append_bootorder(u16 index); + +#endif diff --git a/include/efi_loader.h b/include/efi_loader.h index b0d6fff67c..4461f721e0 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -142,6 +142,11 @@ static inline efi_status_t efi_launch_capsules(void) EFI_GUID(0x63293792, 0xadf5, 0x9325, \ 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e) +/* GUID for the auto generated boot menu entry */ +#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \ + EFI_GUID(0x38c1acc1, 0x9fc0, 0x41f0, \ + 0xb9, 0x01, 0xfa, 0x74, 0xd6, 0xd6, 0xe4, 0xde) + /* Use internal device tree when starting UEFI application */ #define EFI_FDT_USE_INTERNAL NULL @@ -226,6 +231,9 @@ const char *__efi_nesting_dec(void); #define EFI_CACHELINE_SIZE 128 #endif +/* max bootmenu title size for volume selection */ +#define BOOTMENU_DEVICE_NAME_MAX 16 + /* Key identifying current memory map */ extern efi_uintn_t efi_memory_map_key; @@ -249,6 +257,9 @@ extern const struct efi_hii_string_protocol efi_hii_string; uint16_t *efi_dp_str(struct efi_device_path *dp); +/* GUID for the auto generated boot menu entry */ +extern const efi_guid_t efi_guid_bootmenu_auto_generated; + /* GUID of the U-Boot root node */ extern const efi_guid_t efi_u_boot_guid; #ifdef CONFIG_SANDBOX @@ -314,6 +325,8 @@ extern const efi_guid_t efi_guid_firmware_management_protocol; extern const efi_guid_t efi_esrt_guid; /* GUID of the SMBIOS table */ extern const efi_guid_t smbios_guid; +/*GUID of console */ +extern const efi_guid_t efi_guid_text_input_protocol; extern char __efi_runtime_start[], __efi_runtime_stop[]; extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[]; @@ -1064,4 +1077,28 @@ efi_status_t efi_esrt_populate(void); efi_status_t efi_load_capsule_drivers(void); efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz); + +efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type, + const efi_guid_t *protocol, void *search_key, + efi_uintn_t *no_handles, efi_handle_t **buffer); + +efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this, + struct efi_file_handle **root); +efi_status_t efi_file_open_int(struct efi_file_handle *this, + struct efi_file_handle **new_handle, + u16 *file_name, u64 open_mode, + u64 attributes); +efi_status_t efi_file_close_int(struct efi_file_handle *file); +efi_status_t efi_file_read_int(struct efi_file_handle *this, + efi_uintn_t *buffer_size, void *buffer); +efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos); + +typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key); +efi_status_t efi_console_get_u16_string + (struct efi_simple_text_input_protocol *cin, + u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func, + int row, int col); + +efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size); + #endif /* _EFI_LOADER_H */ diff --git a/lib/efi_loader/efi_bootmgr.c b/lib/efi_loader/efi_bootmgr.c index 234073ecb7..ede9116b3c 100644 --- a/lib/efi_loader/efi_bootmgr.c +++ b/lib/efi_loader/efi_bootmgr.c @@ -19,6 +19,9 @@ static const struct efi_boot_services *bs; static const struct efi_runtime_services *rs; +const efi_guid_t efi_guid_bootmenu_auto_generated = + EFICONFIG_AUTO_GENERATED_ENTRY_GUID; + /* * bootmgr implements the logic of trying to find a payload to boot * based on the BootOrder + BootXXXX variables, and then loading it. diff --git a/lib/efi_loader/efi_boottime.c b/lib/efi_loader/efi_boottime.c index 4da64b5d29..1233418e77 100644 --- a/lib/efi_loader/efi_boottime.c +++ b/lib/efi_loader/efi_boottime.c @@ -2453,6 +2453,35 @@ static efi_status_t EFIAPI efi_protocols_per_handle( return EFI_EXIT(EFI_SUCCESS); } +efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type, + const efi_guid_t *protocol, void *search_key, + efi_uintn_t *no_handles, efi_handle_t **buffer) +{ + efi_status_t r; + efi_uintn_t buffer_size = 0; + + if (!no_handles || !buffer) { + r = EFI_INVALID_PARAMETER; + goto out; + } + *no_handles = 0; + *buffer = NULL; + r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, + *buffer); + if (r != EFI_BUFFER_TOO_SMALL) + goto out; + r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size, + (void **)buffer); + if (r != EFI_SUCCESS) + goto out; + r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, + *buffer); + if (r == EFI_SUCCESS) + *no_handles = buffer_size / sizeof(efi_handle_t); +out: + return r; +} + /** * efi_locate_handle_buffer() - locate handles implementing a protocol * @search_type: selection criterion @@ -2474,30 +2503,13 @@ efi_status_t EFIAPI efi_locate_handle_buffer( efi_uintn_t *no_handles, efi_handle_t **buffer) { efi_status_t r; - efi_uintn_t buffer_size = 0; EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key, no_handles, buffer); - if (!no_handles || !buffer) { - r = EFI_INVALID_PARAMETER; - goto out; - } - *no_handles = 0; - *buffer = NULL; - r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, - *buffer); - if (r != EFI_BUFFER_TOO_SMALL) - goto out; - r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size, - (void **)buffer); - if (r != EFI_SUCCESS) - goto out; - r = efi_locate_handle(search_type, protocol, search_key, &buffer_size, - *buffer); - if (r == EFI_SUCCESS) - *no_handles = buffer_size / sizeof(efi_handle_t); -out: + r = efi_locate_handle_buffer_int(search_type, protocol, search_key, + no_handles, buffer); + return EFI_EXIT(r); } diff --git a/lib/efi_loader/efi_console.c b/lib/efi_loader/efi_console.c index 3164fd484e..5be509f0d6 100644 --- a/lib/efi_loader/efi_console.c +++ b/lib/efi_loader/efi_console.c @@ -7,6 +7,7 @@ #define LOG_CATEGORY LOGC_EFI +#include <ansi.h> #include <common.h> #include <charset.h> #include <malloc.h> @@ -1318,3 +1319,72 @@ out_of_memory: printf("ERROR: Out of memory\n"); return r; } + +/** + * efi_console_get_u16_string() - get user input string + * + * @cin: protocol interface to EFI_SIMPLE_TEXT_INPUT_PROTOCOL + * @buf: buffer to store user input string in UTF16 + * @count: number of u16 string including NULL terminator that buf has + * @filter_func: callback to filter user input + * @row: row number to locate user input form + * @col: column number to locate user input form + * Return: status code + */ +efi_status_t efi_console_get_u16_string(struct efi_simple_text_input_protocol *cin, + u16 *buf, efi_uintn_t count, + efi_console_filter_func filter_func, + int row, int col) +{ + efi_status_t ret; + efi_uintn_t len = 0; + struct efi_input_key key; + + printf(ANSI_CURSOR_POSITION + ANSI_CLEAR_LINE_TO_END + ANSI_CURSOR_SHOW, row, col); + + ret = EFI_CALL(cin->reset(cin, false)); + if (ret != EFI_SUCCESS) + return ret; + + for (;;) { + do { + ret = EFI_CALL(cin->read_key_stroke(cin, &key)); + mdelay(10); + } while (ret == EFI_NOT_READY); + + if (key.unicode_char == u'\b') { + if (len > 0) + buf[--len] = u'\0'; + + printf(ANSI_CURSOR_POSITION + "%ls" + ANSI_CLEAR_LINE_TO_END, row, col, buf); + continue; + } else if (key.unicode_char == u'\r') { + buf[len] = u'\0'; + return EFI_SUCCESS; + } else if (key.unicode_char == 0x3 || key.scan_code == 23) { + return EFI_ABORTED; + } else if (key.unicode_char < 0x20) { + /* ignore control codes other than Ctrl+C, '\r' and '\b' */ + continue; + } else if (key.scan_code != 0) { + /* only accept single ESC press for cancel */ + continue; + } + + if (filter_func) { + if (filter_func(&key) != EFI_SUCCESS) + continue; + } + + if (len >= (count - 1)) + continue; + + buf[len] = key.unicode_char; + len++; + printf(ANSI_CURSOR_POSITION "%ls", row, col, buf); + } +} diff --git a/lib/efi_loader/efi_disk.c b/lib/efi_loader/efi_disk.c index f269abf135..a34ca46a11 100644 --- a/lib/efi_loader/efi_disk.c +++ b/lib/efi_loader/efi_disk.c @@ -760,3 +760,53 @@ efi_status_t efi_disk_init(void) return EFI_SUCCESS; } + +/** + * efi_disk_get_device_name() - get U-Boot device name associated with EFI handle + * + * @handle: pointer to the EFI handle + * @buf: pointer to the buffer to store the string + * @size: size of buffer + * Return: status code + */ +efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size) +{ + int count; + int diskid; + enum uclass_id id; + unsigned int part; + struct udevice *dev; + struct blk_desc *desc; + const char *if_typename; + bool is_partition = false; + struct disk_part *part_data; + + if (!handle || !buf || !size) + return EFI_INVALID_PARAMETER; + + dev = handle->dev; + id = device_get_uclass_id(dev); + if (id == UCLASS_BLK) { + desc = dev_get_uclass_plat(dev); + } else if (id == UCLASS_PARTITION) { + desc = dev_get_uclass_plat(dev_get_parent(dev)); + is_partition = true; + } else { + return EFI_INVALID_PARAMETER; + } + if_typename = blk_get_if_type_name(desc->if_type); + diskid = desc->devnum; + + if (is_partition) { + part_data = dev_get_uclass_plat(dev); + part = part_data->partnum; + count = snprintf(buf, size, "%s %d:%d", if_typename, diskid, part); + } else { + count = snprintf(buf, size, "%s %d", if_typename, diskid); + } + + if (count < 0 || (count + 1) > size) + return EFI_INVALID_PARAMETER; + + return EFI_SUCCESS; +} diff --git a/lib/efi_loader/efi_file.c b/lib/efi_loader/efi_file.c index 7a7077e6d0..c96a7f7ca3 100644 --- a/lib/efi_loader/efi_file.c +++ b/lib/efi_loader/efi_file.c @@ -246,10 +246,10 @@ error: return NULL; } -static efi_status_t efi_file_open_int(struct efi_file_handle *this, - struct efi_file_handle **new_handle, - u16 *file_name, u64 open_mode, - u64 attributes) +efi_status_t efi_file_open_int(struct efi_file_handle *this, + struct efi_file_handle **new_handle, + u16 *file_name, u64 open_mode, + u64 attributes) { struct file_handle *fh = to_fh(this); efi_status_t ret; @@ -369,11 +369,17 @@ static efi_status_t file_close(struct file_handle *fh) return EFI_SUCCESS; } -static efi_status_t EFIAPI efi_file_close(struct efi_file_handle *file) +efi_status_t efi_file_close_int(struct efi_file_handle *file) { struct file_handle *fh = to_fh(file); + + return file_close(fh); +} + +static efi_status_t EFIAPI efi_file_close(struct efi_file_handle *file) +{ EFI_ENTRY("%p", file); - return EFI_EXIT(file_close(fh)); + return EFI_EXIT(efi_file_close_int(file)); } static efi_status_t EFIAPI efi_file_delete(struct efi_file_handle *file) @@ -562,8 +568,8 @@ static efi_status_t dir_read(struct file_handle *fh, u64 *buffer_size, return EFI_SUCCESS; } -static efi_status_t efi_file_read_int(struct efi_file_handle *this, - efi_uintn_t *buffer_size, void *buffer) +efi_status_t efi_file_read_int(struct efi_file_handle *this, + efi_uintn_t *buffer_size, void *buffer) { struct file_handle *fh = to_fh(this); efi_status_t ret = EFI_SUCCESS; @@ -773,24 +779,11 @@ out: return EFI_EXIT(ret); } -/** - * efi_file_setpos() - set current position in file - * - * This function implements the SetPosition service of the EFI file protocol. - * See the UEFI spec for details. - * - * @file: file handle - * @pos: new file position - * Return: status code - */ -static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, - u64 pos) +efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos) { struct file_handle *fh = to_fh(file); efi_status_t ret = EFI_SUCCESS; - EFI_ENTRY("%p, %llu", file, pos); - if (fh->isdir) { if (pos != 0) { ret = EFI_UNSUPPORTED; @@ -812,6 +805,28 @@ static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, fh->offset = pos; error: + return ret; +} + +/** + * efi_file_setpos() - set current position in file + * + * This function implements the SetPosition service of the EFI file protocol. + * See the UEFI spec for details. + * + * @file: file handle + * @pos: new file position + * Return: status code + */ +static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file, + u64 pos) +{ + efi_status_t ret = EFI_SUCCESS; + + EFI_ENTRY("%p, %llu", file, pos); + + ret = efi_file_setpos_int(file, pos); + return EFI_EXIT(ret); } @@ -1138,17 +1153,23 @@ struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp) return f; } +efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this, + struct efi_file_handle **root) +{ + struct file_system *fs = to_fs(this); + + *root = file_open(fs, NULL, NULL, 0, 0); + + return EFI_SUCCESS; +} + static efi_status_t EFIAPI efi_open_volume(struct efi_simple_file_system_protocol *this, struct efi_file_handle **root) { - struct file_system *fs = to_fs(this); - EFI_ENTRY("%p, %p", this, root); - *root = file_open(fs, NULL, NULL, 0, 0); - - return EFI_EXIT(EFI_SUCCESS); + return EFI_EXIT(efi_open_volume_int(this, root)); } struct efi_simple_file_system_protocol *
This commit add the "eficonfig" command. The "eficonfig" command implements the menu-driven UEFI boot option maintenance feature. This commit implements the addition of new boot option. User can select the block device volume having efi_simple_file_system_protocol and select the file corresponding to the Boot#### variable. User can also enter the description and optional_data of the BOOT#### variable in utf8. This commit adds "include/efi_config.h", it contains the common definition to be used from other menus such as UEFI Secure Boot key management. Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org> --- Changes in v15: - moves the free(entry->data) outside the eficonfig_destroy() function and entry->data is freed explicitly only when needed - expose eficonfig_destroy() for succeeding secure boot key management patch Changes in v14: - fix the missing initialization - add comment for key handling No change in v13: Changes in v12: - add select/clear menu before displaying volume selectio - move function declaration from efi_loader.h to efi_config.h - remove unused declaration - support the boot option does not have file path - correctly handle if optional_data is empty Changes in v11: - refactor menu entry construction, directly use eficonfig_entry structure - remove reading directory info to calculate the number of entry - fix invalid efi_free_pool() in ill_file_info() - use ANSI_CURSOR_POSITION and ANSI_CLEAR_LINE instead of printf("\n") since current eficonfig implementation does not handle console size correctly. printf("\n") at the outside of console size breaks the console output. Changes in v10: - add initrd file selection - do refactoring - eficonfig_process_common() use list structure - remove u'/' before copying file_path into current_path - fix typos - check snprintf error Changes in v9: - move "efi_guid_bootmenu_auto_generated definition" into efi_bootmgr.c to address build error when CMD_EFICONFIG is disabled - fix typos and comment - remove file system information from error message - remove unreachable code in eficonfig_choice_entry() - single printf() call as much as possible - call only getchar() in eficonfig_print_msg() - filter out '.' entry from file selection - update the efi_disk_get_device_name() implementation - add function comment Changes in v8: - command name is change from "efimenu" to "eficonfig" - function and struct prefixes is changed to "eficonfig" - fix menu header string Changes in v7: - add "efimenu" command and uefi variable maintenance code moved into cmd/efimenu.c - create include/efimenu.h to define the common definition for the other menu such as UEFI Secure Boot key management - update boot option edit UI, user can select description, file, and optional_data to edit in the same menu like following. ** Edit Boot Option ** Description: debian File: virtio 0:1/EFI\debian\grubaa64.efi Optional Data: test Save Quit - remove exit parameter from efimenu_process_common() - menu title type is changed from u16 to char - efimenu_process_common() add menu title string - reduce printf/puts function call for displaying the menu - efi_console_get_u16_string() accept 0 length to allow optional_data is empty - efi_console_get_u16_string() the "size" parameter name is changes to "count" - efimenu is now designed to maintain the UEFI variables, remove autoboot related code - remove one empty line before "Quit" entry - efimenu_init() processes only the first time Changes in v6: - fix typos - modify volume name to match U-Boot syntax - compile in CONFIG_EFI_LOADER=n and CONFIG_CMD_BOOTEFI_BOOTMGR=n - simplify u16_strncmp() usage - support "a\b.efi" file path, use link list to handle filepath - modify length check condition - UEFI related menu items only appears with CONFIG_AUTOBOOT_MENU_SHOW=y Changes in v5: - remove forward declarations - add const qualifier for menu items - fix the possible unaligned access for directory info access - split into three commit 1)add boot option 2) delete boot option 3)change boot order This commit is 1)add boot option. - fix file name buffer allocation size, it should be EFI_BOOTMENU_FILE_PATH_MAX * sizeof(u16) - fix wrong size checking for file selection Chanes in v4: - UEFI boot option maintenance menu is integrated into bootmenu - display the simplified volume name(e.g. usb0:1, nvme1:2) for the volume selection - instead of extending lib/efi_loader/efi_bootmgr.c, newly create lib/efi_loader/efi_bootmenu_maintenance.c and implement boot variable maintenance into it. Changes in RFC v3: not included in v3 series Changes in RFC v2: - enable utf8 user input for boot option name - create lib/efi_loader/efi_console.c::efi_console_get_u16_string() for utf8 user input handling - use u16_strlcat instead of u16_strcat - remove the EFI_CALLs, and newly create or expose the following xxx_int() functions. efi_locate_handle_buffer_int(), efi_open_volume_int(), efi_file_open_int(), efi_file_close_int(), efi_file_read_int() and efi_file_setpos_int(). Note that EFI_CALLs still exist for EFI_DEVICE_PATH_TO_TEXT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT/OUTPUT_PROTOCOL - use efi_search_protocol() instead of calling locate_protocol() to get the device_path_to_text_protocol interface. - remove unnecessary puts(ANSI_CLEAR_LINE), this patch is still depends on puts(ANSI_CLEAR_CONSOLE) - skip SetVariable() if the bootorder is not changed cmd/Kconfig | 7 + cmd/Makefile | 1 + cmd/eficonfig.c | 1568 +++++++++++++++++++++++++++++++++ include/efi_config.h | 96 ++ include/efi_loader.h | 37 + lib/efi_loader/efi_bootmgr.c | 3 + lib/efi_loader/efi_boottime.c | 52 +- lib/efi_loader/efi_console.c | 70 ++ lib/efi_loader/efi_disk.c | 50 ++ lib/efi_loader/efi_file.c | 75 +- 10 files changed, 1912 insertions(+), 47 deletions(-) create mode 100644 cmd/eficonfig.c create mode 100644 include/efi_config.h