menu: add support for client defined statusline function

Currently displaying status line is done in a weak function
menu_display_statusline().

bootmenu.c overrides the weak default function.
It calls menu_default_choice() and interprets the data as
struct bootmenu_entry.

pxe boot also uses common menu code for pxe menus.
If there is a system that enables both bootmenu and pxe,
menu_display_statusline() defined in bootmenu.c will be called
and it will interpret struct pxe_label as struct bootmenu_entry.
This leads to data aborts and pxe menu corruptions.

This patch adds support for client defined statusline function
to resolve the above bug.

Signed-off-by: Thirupathaiah Annapureddy <thiruan@linux.microsoft.com>
This commit is contained in:
Thirupathaiah Annapureddy 2020-03-18 11:38:42 -07:00 committed by Tom Rini
parent fdf0819afb
commit 5168d7a626
4 changed files with 41 additions and 37 deletions

View File

@ -365,6 +365,34 @@ cleanup:
return NULL;
}
static void menu_display_statusline(struct menu *m)
{
struct bootmenu_entry *entry;
struct bootmenu_data *menu;
if (menu_default_choice(m, (void *)&entry) < 0)
return;
menu = entry->menu;
printf(ANSI_CURSOR_POSITION, 1, 1);
puts(ANSI_CLEAR_LINE);
printf(ANSI_CURSOR_POSITION, 2, 1);
puts(" *** U-Boot Boot Menu ***");
puts(ANSI_CLEAR_LINE_TO_END);
printf(ANSI_CURSOR_POSITION, 3, 1);
puts(ANSI_CLEAR_LINE);
/* First 3 lines are bootmenu header + 2 empty lines between entries */
printf(ANSI_CURSOR_POSITION, menu->count + 5, 1);
puts(ANSI_CLEAR_LINE);
printf(ANSI_CURSOR_POSITION, menu->count + 6, 1);
puts(" Press UP/DOWN to move, ENTER to select");
puts(ANSI_CLEAR_LINE_TO_END);
printf(ANSI_CURSOR_POSITION, menu->count + 7, 1);
puts(ANSI_CLEAR_LINE);
}
static void bootmenu_show(int delay)
{
int init = 0;
@ -396,8 +424,9 @@ static void bootmenu_show(int delay)
if (!bootmenu)
return;
menu = menu_create(NULL, bootmenu->delay, 1, bootmenu_print_entry,
bootmenu_choice_entry, bootmenu);
menu = menu_create(NULL, bootmenu->delay, 1, menu_display_statusline,
bootmenu_print_entry, bootmenu_choice_entry,
bootmenu);
if (!menu) {
bootmenu_destroy(bootmenu);
return;
@ -445,34 +474,6 @@ cleanup:
#endif
}
void menu_display_statusline(struct menu *m)
{
struct bootmenu_entry *entry;
struct bootmenu_data *menu;
if (menu_default_choice(m, (void *)&entry) < 0)
return;
menu = entry->menu;
printf(ANSI_CURSOR_POSITION, 1, 1);
puts(ANSI_CLEAR_LINE);
printf(ANSI_CURSOR_POSITION, 2, 1);
puts(" *** U-Boot Boot Menu ***");
puts(ANSI_CLEAR_LINE_TO_END);
printf(ANSI_CURSOR_POSITION, 3, 1);
puts(ANSI_CLEAR_LINE);
/* First 3 lines are bootmenu header + 2 empty lines between entries */
printf(ANSI_CURSOR_POSITION, menu->count + 5, 1);
puts(ANSI_CLEAR_LINE);
printf(ANSI_CURSOR_POSITION, menu->count + 6, 1);
puts(" Press UP/DOWN to move, ENTER to select");
puts(ANSI_CLEAR_LINE_TO_END);
printf(ANSI_CURSOR_POSITION, menu->count + 7, 1);
puts(ANSI_CLEAR_LINE);
}
#ifdef CONFIG_AUTOBOOT_MENU_SHOW
int menu_show(int bootdelay)
{

View File

@ -1237,7 +1237,7 @@ static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg)
* Create a menu and add items for all the labels.
*/
m = menu_create(cfg->title, DIV_ROUND_UP(cfg->timeout, 10),
cfg->prompt, label_print, NULL, NULL);
cfg->prompt, NULL, label_print, NULL, NULL);
if (!m)
return NULL;

View File

@ -36,6 +36,7 @@ struct menu {
int timeout;
char *title;
int prompt;
void (*display_statusline)(struct menu *);
void (*item_data_print)(void *);
char *(*item_choice)(void *);
void *item_choice_data;
@ -106,10 +107,6 @@ static inline void *menu_item_destroy(struct menu *m,
return NULL;
}
__weak void menu_display_statusline(struct menu *m)
{
}
/*
* Display a menu so the user can make a choice of an item. First display its
* title, if any, and then each item in the menu.
@ -120,7 +117,8 @@ static inline void menu_display(struct menu *m)
puts(m->title);
putc('\n');
}
menu_display_statusline(m);
if (m->display_statusline)
m->display_statusline(m);
menu_items_iter(m, menu_item_print, NULL);
}
@ -344,6 +342,9 @@ int menu_item_add(struct menu *m, char *item_key, void *item_data)
* timeout. If 1, the user will be prompted for input regardless of the value
* of timeout.
*
* display_statusline - If not NULL, will be called to show a statusline when
* the menu is displayed.
*
* item_data_print - If not NULL, will be called for each item when the menu
* is displayed, with the pointer to the item's data passed as the argument.
* If NULL, each item's key will be printed instead. Since an item's key is
@ -360,6 +361,7 @@ int menu_item_add(struct menu *m, char *item_key, void *item_data)
* insufficient memory available to create the menu.
*/
struct menu *menu_create(char *title, int timeout, int prompt,
void (*display_statusline)(struct menu *),
void (*item_data_print)(void *),
char *(*item_choice)(void *),
void *item_choice_data)
@ -374,6 +376,7 @@ struct menu *menu_create(char *title, int timeout, int prompt,
m->default_item = NULL;
m->prompt = prompt;
m->timeout = timeout;
m->display_statusline = display_statusline;
m->item_data_print = item_data_print;
m->item_choice = item_choice;
m->item_choice_data = item_choice_data;

View File

@ -9,6 +9,7 @@
struct menu;
struct menu *menu_create(char *title, int timeout, int prompt,
void (*display_statusline)(struct menu *),
void (*item_data_print)(void *),
char *(*item_choice)(void *),
void *item_choice_data);
@ -16,7 +17,6 @@ int menu_default_set(struct menu *m, char *item_key);
int menu_get_choice(struct menu *m, void **choice);
int menu_item_add(struct menu *m, char *item_key, void *item_data);
int menu_destroy(struct menu *m);
void menu_display_statusline(struct menu *m);
int menu_default_choice(struct menu *m, void **choice);
/**