u-boot/cmd/eficonfig.c
Masahisa Kojima e5948ee301 eficonfig: add "Change Boot Order" menu entry
This commit adds the menu entry to update UEFI BootOrder variable.
User moves the entry with UP/DOWN key, changes the order
with PLUS/MINUS key, press SPACE to activate or deactivate
the entry, then finalizes the order by ENTER key.
If the entry is activated, the boot index is added into the
BootOrder variable in the order of the list.

The U-Boot menu framework is well designed for static menu,
this commit implements the own menu display and key handling
for dynamically change the order of menu entry.

Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
2022-09-14 08:43:32 +02:00

2502 lines
62 KiB
C

// 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 <sort.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 {
char *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;
char *file_name;
};
/**
* struct eficonfig_boot_selection_data - structure to be used to select the boot option entry
*
* @boot_index: index of the boot option
* @selected: pointer to store the selected index in the BootOrder variable
*/
struct eficonfig_boot_selection_data {
u16 boot_index;
int *selected;
};
/**
* struct eficonfig_boot_order - structure to be used to update BootOrder variable
*
* @num: index in the menu entry
* @description: pointer to the description string
* @boot_index: boot option index
* @active: flag to include the boot option into BootOrder variable
* @list: list structure
*/
struct eficonfig_boot_order {
u32 num;
u16 *description;
u32 boot_index;
bool active;
struct list_head list;
};
/**
* 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;
if (!efi_menu)
return;
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)
return EFI_OUT_OF_RESOURCES;
}
menu = menu_create(NULL, 0, 1, eficonfig_display_statusline,
eficonfig_print_entry, eficonfig_choice_entry,
efi_menu);
if (!menu)
return EFI_INVALID_PARAMETER;
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)
{
u16 *tmp;
struct eficonfig_file_entry_data *info = data;
if (!info)
return EFI_INVALID_PARAMETER;
if (!strcmp(info->file_name, "..")) {
struct eficonfig_filepath_info *iter;
struct list_head *pos, *n;
int is_last;
char *filepath;
tmp = info->file_info->current_path;
memset(info->file_info->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE);
filepath = calloc(1, EFICONFIG_FILE_PATH_MAX);
if (!filepath)
return EFI_OUT_OF_RESOURCES;
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;
}
strlcat(filepath, iter->name, EFICONFIG_FILE_PATH_MAX);
}
utf8_utf16_strcpy(&tmp, filepath);
} else {
size_t new_len;
struct eficonfig_filepath_info *filepath_info;
new_len = u16_strlen(info->file_info->current_path) +
strlen(info->file_name);
if (new_len >= EFICONFIG_FILE_PATH_MAX) {
eficonfig_print_msg("File path is too long!");
return EFI_INVALID_PARAMETER;
}
tmp = &info->file_info->current_path[u16_strlen(info->file_info->current_path)];
utf8_utf16_strcpy(&tmp, info->file_name);
filepath_info = calloc(1, sizeof(struct eficonfig_filepath_info));
if (!filepath_info)
return EFI_OUT_OF_RESOURCES;
filepath_info->name = strdup(info->file_name);
if (!filepath_info->name) {
free(filepath_info);
return EFI_OUT_OF_RESOURCES;
}
list_add_tail(&filepath_info->list, &info->file_info->filepath_list);
if (!info->is_directory)
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;
}
/**
* sort_file() - sort the file name in ascii order
*
* @data1: pointer to the file entry data
* @data2: pointer to the file entry data
* Return: -1 if the data1 file name is less than data2 file name,
* 0 if both file name match,
* 1 if the data1 file name is greater thant data2 file name.
*/
static int sort_file(const void *arg1, const void *arg2)
{
const struct eficonfig_file_entry_data *data1, *data2;
data1 = *((const struct eficonfig_file_entry_data **)arg1);
data2 = *((const struct eficonfig_file_entry_data **)arg2);
return strcasecmp(data1->file_name, data2->file_name);
}
/**
* eficonfig_create_file_entry() - construct the file menu entry
*
* @efi_menu: pointer to the efimenu structure
* @count: number of the directory and file
* @tmp_infos: pointer to the entry data array
* @f: pointer to the file handle
* @buf: pointer to the buffer to store the directory information
* @file_info: pointer to the file selection structure
* Return: status code
*/
static efi_status_t
eficonfig_create_file_entry(struct efimenu *efi_menu, u32 count,
struct eficonfig_file_entry_data **tmp_infos,
struct efi_file_handle *f, struct efi_file_info *buf,
struct eficonfig_select_file_info *file_info)
{
char *name, *p;
efi_uintn_t len;
efi_status_t ret;
u32 i, entry_num = 0;
struct eficonfig_file_entry_data *info;
efi_file_setpos_int(f, 0);
/* Read directory and construct menu structure */
for (i = 0; i < count; i++) {
if (entry_num >= 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 out;
}
/* append '\\' at the end of directory name */
name = calloc(1, utf16_utf8_strlen(buf->file_name) + 2);
if (!name) {
ret = EFI_OUT_OF_RESOURCES;
free(info);
goto out;
}
p = name;
utf16_utf8_strcpy(&p, buf->file_name);
if (buf->attribute & EFI_FILE_DIRECTORY) {
/* filter out u'.' */
if (!u16_strcmp(buf->file_name, u".")) {
free(info);
free(name);
continue;
}
name[u16_strlen(buf->file_name)] = '\\';
info->is_directory = true;
}
info->file_name = name;
info->file_info = file_info;
tmp_infos[entry_num++] = info;
}
qsort(tmp_infos, entry_num, sizeof(*tmp_infos),
(int (*)(const void *, const void *))sort_file);
for (i = 0; i < entry_num; i++) {
ret = append_entry(efi_menu, tmp_infos[i]->file_name,
eficonfig_file_selected, tmp_infos[i]);
if (ret != EFI_SUCCESS)
goto out;
}
out:
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)
{
u32 count = 0, i;
efi_uintn_t len;
efi_status_t ret;
struct efimenu *efi_menu;
struct efi_file_handle *f;
struct efi_file_info *buf;
struct eficonfig_file_entry_data **tmp_infos;
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!");
free(efi_menu);
ret = EFI_ABORTED;
goto out;
}
/* Count the number of directory entries */
for (;;) {
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;
count++;
}
/* allocate array to sort the entry */
tmp_infos = calloc(count, sizeof(*tmp_infos));
if (!tmp_infos) {
ret = EFI_OUT_OF_RESOURCES;
goto err;
}
ret = eficonfig_create_file_entry(efi_menu, count, tmp_infos,
f, buf, file_info);
if (ret != EFI_SUCCESS)
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);
eficonfig_destroy(efi_menu);
if (tmp_infos) {
for (i = 0; i < count; i++)
free(tmp_infos[i]);
}
free(tmp_infos);
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 = NULL, *p;
efi_handle_t handle;
char *devname;
devname = calloc(1, EFICONFIG_VOLUME_PATH_MAX + 1);
if (!devname)
return EFI_OUT_OF_RESOURCES;
/* 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, EFICONFIG_VOLUME_PATH_MAX);
if (ret != EFI_SUCCESS)
goto out;
}
/*
* If the preconfigured volume does not exist in the system, display the text
* converted volume device path instead of U-Boot friendly name(e.g. "usb 0:1").
*/
if (!handle && file_info->dp_volume) {
u16 *dp_str;
char *q = devname;
dp_str = efi_dp_str(file_info->dp_volume);
if (dp_str)
utf16_utf8_strncpy(&q, dp_str, EFICONFIG_VOLUME_PATH_MAX);
efi_free_pool(dp_str);
}
/* 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, "/", EFICONFIG_VOLUME_PATH_MAX + 1);
len = strlen(devname);
len += utf16_utf8_strlen(file_info->current_path) + 1;
file_name = calloc(1, len * sizeof(u16));
if (!file_name) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
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);
out:
free(devname);
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) {
ret = EFI_INVALID_PARAMETER;
goto out;
}
/* truncate the long label string */
if (u16_strlen(lo.label) >= EFICONFIG_DESCRIPTION_MAX)
lo.label[EFICONFIG_DESCRIPTION_MAX - 1] = u'\0';
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_process_boot_selected() - handler to select boot option entry
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_boot_selected(void *data)
{
struct eficonfig_boot_selection_data *info = data;
if (info)
*info->selected = info->boot_index;
return EFI_SUCCESS;
}
/**
* search_bootorder() - search the boot option index in BootOrder
*
* @bootorder: pointer to the BootOrder variable
* @num: number of BootOrder entry
* @target: target boot option index to search
* @index: pointer to store the index of BootOrder variable
* Return: true if exists, false otherwise
*/
static bool search_bootorder(u16 *bootorder, efi_uintn_t num, u32 target, u32 *index)
{
u32 i;
for (i = 0; i < num; i++) {
if (target == bootorder[i]) {
if (index)
*index = i;
return true;
}
}
return false;
}
/**
* eficonfig_add_boot_selection_entry() - add boot option menu entry
*
* @efi_menu: pointer to store the efimenu structure
* @boot_index: boot option index to be added
* @selected: pointer to store the selected boot option index
* Return: status code
*/
static efi_status_t eficonfig_add_boot_selection_entry(struct efimenu *efi_menu,
unsigned int boot_index,
unsigned int *selected)
{
char *buf, *p;
efi_status_t ret;
efi_uintn_t size;
void *load_option;
struct efi_load_option lo;
u16 varname[] = u"Boot####";
struct eficonfig_boot_selection_data *info;
efi_create_indexed_name(varname, sizeof(varname), "Boot", boot_index);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option)
return EFI_SUCCESS;
ret = efi_deserialize_load_option(&lo, load_option, &size);
if (ret != EFI_SUCCESS) {
log_warning("Invalid load option for %ls\n", varname);
free(load_option);
return ret;
}
if (size >= sizeof(efi_guid_t) &&
!guidcmp(lo.optional_data, &efi_guid_bootmenu_auto_generated)) {
/*
* auto generated entry has GUID in optional_data,
* skip auto generated entry because it will be generated
* again even if it is edited or deleted.
*/
free(load_option);
return EFI_SUCCESS;
}
info = calloc(1, sizeof(struct eficonfig_boot_selection_data));
if (!info) {
free(load_option);
return EFI_OUT_OF_RESOURCES;
}
buf = calloc(1, utf16_utf8_strlen(lo.label) + 1);
if (!buf) {
free(load_option);
free(info);
return EFI_OUT_OF_RESOURCES;
}
p = buf;
utf16_utf8_strcpy(&p, lo.label);
info->boot_index = boot_index;
info->selected = selected;
ret = append_entry(efi_menu, buf, eficonfig_process_boot_selected, info);
if (ret != EFI_SUCCESS) {
free(load_option);
free(info);
return ret;
}
free(load_option);
return EFI_SUCCESS;
}
/**
* eficonfig_show_boot_selection() - construct boot option menu entry
*
* @selected: pointer to store the selected boot option index
* Return: status code
*/
static efi_status_t eficonfig_show_boot_selection(unsigned int *selected)
{
u32 i;
u16 *bootorder;
efi_status_t ret;
efi_uintn_t num, size;
struct efimenu *efi_menu;
struct list_head *pos, *n;
struct eficonfig_entry *entry;
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu)
return EFI_OUT_OF_RESOURCES;
bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size);
INIT_LIST_HEAD(&efi_menu->list);
num = size / sizeof(u16);
/* list the load option in the order of BootOrder variable */
for (i = 0; i < num; i++) {
ret = eficonfig_add_boot_selection_entry(efi_menu, bootorder[i], selected);
if (ret != EFI_SUCCESS)
goto out;
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1)
break;
}
/* list the remaining load option not included in the BootOrder */
for (i = 0; i <= 0xFFFF; i++) {
/* If the index is included in the BootOrder, skip it */
if (search_bootorder(bootorder, num, i, NULL))
continue;
ret = eficonfig_add_boot_selection_entry(efi_menu, i, selected);
if (ret != EFI_SUCCESS)
goto out;
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1)
break;
}
ret = append_quit_entry(efi_menu);
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_process_common(efi_menu, " ** Select Boot Option **");
out:
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_process_edit_boot_option() - handler to edit boot option
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_edit_boot_option(void *data)
{
efi_status_t ret;
efi_uintn_t size;
struct eficonfig_boot_option *bo = NULL;
while (1) {
unsigned int selected;
void *load_option;
u16 varname[] = u"Boot####";
ret = eficonfig_show_boot_selection(&selected);
if (ret != EFI_SUCCESS)
break;
bo = calloc(1, sizeof(struct eficonfig_boot_option));
if (!bo) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
bo->boot_index = selected;
efi_create_indexed_name(varname, sizeof(varname), "Boot", selected);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option) {
free(bo);
ret = EFI_NOT_FOUND;
goto out;
}
ret = eficonfig_edit_boot_option(varname, bo, load_option, size,
" ** Edit Boot Option ** ");
free(load_option);
free(bo);
if (ret != EFI_SUCCESS && ret != EFI_ABORTED)
break;
}
out:
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* eficonfig_display_change_boot_order() - display the BootOrder list
*
* @efi_menu: pointer to the efimenu structure
* Return: status code
*/
static void eficonfig_display_change_boot_order(struct efimenu *efi_menu)
{
bool reverse;
struct list_head *pos, *n;
struct eficonfig_boot_order *entry;
printf(ANSI_CLEAR_CONSOLE ANSI_CURSOR_POSITION
"\n ** Change Boot Order **\n"
ANSI_CURSOR_POSITION
" Press UP/DOWN to move, +/- to change order"
ANSI_CURSOR_POSITION
" Press SPACE to activate or deactivate the entry"
ANSI_CURSOR_POSITION
" Select [Save] to complete, ESC/CTRL+C to quit"
ANSI_CURSOR_POSITION ANSI_CLEAR_LINE,
1, 1, efi_menu->count + 5, 1, efi_menu->count + 6, 1,
efi_menu->count + 7, 1, efi_menu->count + 8, 1);
/* draw boot option list */
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_boot_order, list);
reverse = (entry->num == efi_menu->active);
printf(ANSI_CURSOR_POSITION, entry->num + 4, 7);
if (reverse)
puts(ANSI_COLOR_REVERSE);
if (entry->num < efi_menu->count - 2) {
if (entry->active)
printf("[*] ");
else
printf("[ ] ");
}
printf("%ls", entry->description);
if (reverse)
puts(ANSI_COLOR_RESET);
}
}
/**
* eficonfig_choice_change_boot_order() - handle the BootOrder update
*
* @efi_menu: pointer to the efimenu structure
* Return: status code
*/
static efi_status_t eficonfig_choice_change_boot_order(struct efimenu *efi_menu)
{
int esc = 0;
struct list_head *pos, *n;
struct eficonfig_boot_order *tmp;
enum bootmenu_key key = KEY_NONE;
struct eficonfig_boot_order *entry;
while (1) {
bootmenu_loop(NULL, &key, &esc);
switch (key) {
case KEY_PLUS:
if (efi_menu->active > 0) {
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_boot_order, list);
if (entry->num == efi_menu->active)
break;
}
tmp = list_entry(pos->prev, struct eficonfig_boot_order, list);
entry->num--;
tmp->num++;
list_del(&tmp->list);
list_add(&tmp->list, &entry->list);
}
fallthrough;
case KEY_UP:
if (efi_menu->active > 0)
--efi_menu->active;
return EFI_NOT_READY;
case KEY_MINUS:
if (efi_menu->active < efi_menu->count - 3) {
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_boot_order, list);
if (entry->num == efi_menu->active)
break;
}
tmp = list_entry(pos->next, struct eficonfig_boot_order, list);
entry->num++;
tmp->num--;
list_del(&entry->list);
list_add(&entry->list, &tmp->list);
++efi_menu->active;
}
return EFI_NOT_READY;
case KEY_DOWN:
if (efi_menu->active < efi_menu->count - 1)
++efi_menu->active;
return EFI_NOT_READY;
case KEY_SELECT:
/* "Save" */
if (efi_menu->active == efi_menu->count - 2)
return EFI_SUCCESS;
/* "Quit" */
if (efi_menu->active == efi_menu->count - 1)
return EFI_ABORTED;
break;
case KEY_SPACE:
if (efi_menu->active < efi_menu->count - 2) {
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_boot_order, list);
if (entry->num == efi_menu->active) {
entry->active = entry->active ? false : true;
return EFI_NOT_READY;
}
}
}
break;
case KEY_QUIT:
return EFI_ABORTED;
default:
/* Pressed key is not valid, no need to regenerate the menu */
break;
}
}
}
/**
* eficonfig_add_change_boot_order_entry() - add boot order entry
*
* @efi_menu: pointer to the efimenu structure
* @boot_index: boot option index to be added
* @active: flag to include the boot option into BootOrder
* Return: status code
*/
static efi_status_t eficonfig_add_change_boot_order_entry(struct efimenu *efi_menu,
u32 boot_index, bool active)
{
efi_status_t ret;
efi_uintn_t size;
void *load_option;
struct efi_load_option lo;
u16 varname[] = u"Boot####";
struct eficonfig_boot_order *entry;
efi_create_indexed_name(varname, sizeof(varname), "Boot", boot_index);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option)
return EFI_SUCCESS;
ret = efi_deserialize_load_option(&lo, load_option, &size);
if (ret != EFI_SUCCESS) {
free(load_option);
return ret;
}
entry = calloc(1, sizeof(struct eficonfig_boot_order));
if (!entry) {
free(load_option);
return EFI_OUT_OF_RESOURCES;
}
entry->description = u16_strdup(lo.label);
if (!entry->description) {
free(load_option);
free(entry);
return EFI_OUT_OF_RESOURCES;
}
entry->num = efi_menu->count++;
entry->boot_index = boot_index;
entry->active = active;
list_add_tail(&entry->list, &efi_menu->list);
free(load_option);
return EFI_SUCCESS;
}
/**
* eficonfig_create_change_boot_order_entry() - create boot order entry
*
* @efi_menu: pointer to the efimenu structure
* @bootorder: pointer to the BootOrder variable
* @num: number of BootOrder entry
* Return: status code
*/
static efi_status_t eficonfig_create_change_boot_order_entry(struct efimenu *efi_menu,
u16 *bootorder, efi_uintn_t num)
{
u32 i;
efi_status_t ret;
struct eficonfig_boot_order *entry;
/* list the load option in the order of BootOrder variable */
for (i = 0; i < num; i++) {
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 2)
break;
ret = eficonfig_add_change_boot_order_entry(efi_menu, bootorder[i], true);
if (ret != EFI_SUCCESS)
goto out;
}
/* list the remaining load option not included in the BootOrder */
for (i = 0; i < 0xFFFF; i++) {
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 2)
break;
/* If the index is included in the BootOrder, skip it */
if (search_bootorder(bootorder, num, i, NULL))
continue;
ret = eficonfig_add_change_boot_order_entry(efi_menu, i, false);
if (ret != EFI_SUCCESS)
goto out;
}
/* add "Save" and "Quit" entries */
entry = calloc(1, sizeof(struct eficonfig_boot_order));
if (!entry)
goto out;
entry->num = efi_menu->count++;
entry->description = u16_strdup(u"Save");
list_add_tail(&entry->list, &efi_menu->list);
entry = calloc(1, sizeof(struct eficonfig_boot_order));
if (!entry)
goto out;
entry->num = efi_menu->count++;
entry->description = u16_strdup(u"Quit");
list_add_tail(&entry->list, &efi_menu->list);
efi_menu->active = 0;
return EFI_SUCCESS;
out:
return EFI_OUT_OF_RESOURCES;
}
/**
* eficonfig_process_change_boot_order() - handler to change boot order
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_change_boot_order(void *data)
{
u32 count;
u16 *bootorder;
efi_status_t ret;
efi_uintn_t num, size;
struct list_head *pos, *n;
struct eficonfig_boot_order *entry;
struct efimenu *efi_menu;
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu)
return EFI_OUT_OF_RESOURCES;
bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size);
INIT_LIST_HEAD(&efi_menu->list);
num = size / sizeof(u16);
ret = eficonfig_create_change_boot_order_entry(efi_menu, bootorder, num);
if (ret != EFI_SUCCESS)
goto out;
while (1) {
eficonfig_display_change_boot_order(efi_menu);
ret = eficonfig_choice_change_boot_order(efi_menu);
if (ret == EFI_SUCCESS) {
u16 *new_bootorder;
new_bootorder = calloc(1, (efi_menu->count - 2) * sizeof(u16));
if (!new_bootorder) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
/* create new BootOrder */
count = 0;
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_boot_order, list);
if (entry->active)
new_bootorder[count++] = entry->boot_index;
}
size = count * sizeof(u16);
ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
size, new_bootorder, false);
free(new_bootorder);
goto out;
} else if (ret == EFI_NOT_READY) {
continue;
} else {
goto out;
}
}
out:
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_boot_order, list);
list_del(&entry->list);
free(entry->description);
free(entry);
}
free(bootorder);
free(efi_menu);
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* delete_boot_option() - delete selected boot option
*
* @boot_index: boot option index to delete
* Return: status code
*/
static efi_status_t delete_boot_option(u16 boot_index)
{
u16 *bootorder;
u16 varname[9];
efi_status_t ret;
unsigned int index;
efi_uintn_t num, size;
efi_create_indexed_name(varname, sizeof(varname),
"Boot", boot_index);
ret = efi_set_variable_int(varname, &efi_global_variable_guid,
0, 0, NULL, false);
if (ret != EFI_SUCCESS) {
log_err("delete boot option(%ls) failed\n", varname);
return ret;
}
/* update BootOrder if necessary */
bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size);
if (!bootorder)
return EFI_SUCCESS;
num = size / sizeof(u16);
if (!search_bootorder(bootorder, num, boot_index, &index))
return EFI_SUCCESS;
memmove(&bootorder[index], &bootorder[index + 1],
(num - index - 1) * sizeof(u16));
size -= sizeof(u16);
ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
size, bootorder, false);
return ret;
}
/**
* eficonfig_process_delete_boot_option() - handler to delete boot option
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_delete_boot_option(void *data)
{
efi_status_t ret;
unsigned int selected;
while (1) {
ret = eficonfig_show_boot_selection(&selected);
if (ret == EFI_SUCCESS)
ret = delete_boot_option(selected);
if (ret != EFI_SUCCESS)
break;
}
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* eficonfig_enumerate_boot_option() - enumerate the possible bootable media
*
* @opt: pointer to the media boot option structure
* @volume_handles: pointer to the efi handles
* @count: number of efi handle
* Return: status code
*/
efi_status_t eficonfig_enumerate_boot_option(struct eficonfig_media_boot_option *opt,
efi_handle_t *volume_handles, efi_status_t count)
{
u32 i;
struct efi_handler *handler;
efi_status_t ret = EFI_SUCCESS;
for (i = 0; i < count; i++) {
u16 *p;
u16 dev_name[BOOTMENU_DEVICE_NAME_MAX];
char *optional_data;
struct efi_load_option lo;
char buf[BOOTMENU_DEVICE_NAME_MAX];
struct efi_device_path *device_path;
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_disk_get_device_name(volume_handles[i], buf, BOOTMENU_DEVICE_NAME_MAX);
if (ret != EFI_SUCCESS)
continue;
p = dev_name;
utf8_utf16_strncpy(&p, buf, strlen(buf));
lo.label = dev_name;
lo.attributes = LOAD_OPTION_ACTIVE;
lo.file_path = device_path;
lo.file_path_length = efi_dp_size(device_path) + sizeof(END);
/*
* Set the dedicated guid to optional_data, it is used to identify
* the boot option that automatically generated by the bootmenu.
* efi_serialize_load_option() expects optional_data is null-terminated
* utf8 string, so set the "1234567" string to allocate enough space
* to store guid, instead of realloc the load_option.
*/
lo.optional_data = "1234567";
opt[i].size = efi_serialize_load_option(&lo, (u8 **)&opt[i].lo);
if (!opt[i].size) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
/* set the guid */
optional_data = (char *)opt[i].lo + (opt[i].size - u16_strsize(u"1234567"));
memcpy(optional_data, &efi_guid_bootmenu_auto_generated, sizeof(efi_guid_t));
}
out:
return ret;
}
/**
* eficonfig_delete_invalid_boot_option() - delete non-existing boot option
*
* @opt: pointer to the media boot option structure
* @count: number of media boot option structure
* Return: status code
*/
efi_status_t eficonfig_delete_invalid_boot_option(struct eficonfig_media_boot_option *opt,
efi_status_t count)
{
u32 i, j;
efi_uintn_t size;
efi_status_t ret;
void *load_option;
struct efi_load_option lo;
u16 varname[] = u"Boot####";
for (i = 0; i <= 0xFFFF; i++) {
efi_uintn_t tmp;
efi_create_indexed_name(varname, sizeof(varname), "Boot", i);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option)
continue;
tmp = size;
ret = efi_deserialize_load_option(&lo, load_option, &size);
if (ret != EFI_SUCCESS)
goto next;
if (size >= sizeof(efi_guid_bootmenu_auto_generated)) {
if (guidcmp(lo.optional_data, &efi_guid_bootmenu_auto_generated) == 0) {
for (j = 0; j < count; j++) {
if (opt[j].size == tmp &&
memcmp(opt[j].lo, load_option, tmp) == 0) {
opt[j].exist = true;
break;
}
}
if (j == count) {
ret = delete_boot_option(i);
if (ret != EFI_SUCCESS) {
free(load_option);
goto out;
}
}
}
}
next:
free(load_option);
}
out:
return ret;
}
/**
* eficonfig_generate_media_device_boot_option() - generate the media device boot option
*
* This function enumerates all devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
* and generate the bootmenu entries.
* This function also provide the BOOT#### variable maintenance for
* the media device entries.
* - Automatically create the BOOT#### variable for the newly detected device,
* this BOOT#### variable is distinguished by the special GUID
* stored in the EFI_LOAD_OPTION.optional_data
* - If the device is not attached to the system, the associated BOOT#### variable
* is automatically deleted.
*
* Return: status code
*/
efi_status_t eficonfig_generate_media_device_boot_option(void)
{
u32 i;
efi_status_t ret;
efi_uintn_t count;
efi_handle_t *volume_handles = NULL;
struct eficonfig_media_boot_option *opt = NULL;
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)
return ret;
opt = calloc(count, sizeof(struct eficonfig_media_boot_option));
if (!opt)
goto out;
/* enumerate all devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL */
ret = eficonfig_enumerate_boot_option(opt, volume_handles, count);
if (ret != EFI_SUCCESS)
goto out;
/*
* System hardware configuration may vary depending on the user setup.
* The boot option is automatically added by the bootmenu.
* If the device is not attached to the system, the boot option needs
* to be deleted.
*/
ret = eficonfig_delete_invalid_boot_option(opt, count);
if (ret != EFI_SUCCESS)
goto out;
/* add non-existent boot option */
for (i = 0; i < count; i++) {
u32 boot_index;
u16 var_name[9];
if (!opt[i].exist) {
ret = eficonfig_get_unused_bootoption(var_name, sizeof(var_name),
&boot_index);
if (ret != EFI_SUCCESS)
goto out;
ret = efi_set_variable_int(var_name, &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
opt[i].size, opt[i].lo, false);
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_append_bootorder(boot_index);
if (ret != EFI_SUCCESS) {
efi_set_variable_int(var_name, &efi_global_variable_guid,
0, 0, NULL, false);
goto out;
}
}
}
out:
if (opt) {
for (i = 0; i < count; i++)
free(opt[i].lo);
}
free(opt);
efi_free_pool(volume_handles);
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},
{"Edit Boot Option", eficonfig_process_edit_boot_option},
{"Change Boot Order", eficonfig_process_change_boot_order},
{"Delete Boot Option", eficonfig_process_delete_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;
ret = eficonfig_generate_media_device_boot_option();
if (ret != EFI_SUCCESS && ret != EFI_NOT_FOUND)
return ret;
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",
""
);