ad5859437eaec157cc4b16951a00e475ad694f11
[platform/kernel/u-boot.git] / include / menu.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright 2010-2011 Calxeda, Inc.
4  */
5
6 #ifndef __MENU_H__
7 #define __MENU_H__
8
9 struct menu;
10
11 struct menu *menu_create(char *title, int timeout, int prompt,
12                                 void (*display_statusline)(struct menu *),
13                                 void (*item_data_print)(void *),
14                                 char *(*item_choice)(void *),
15                                 void *item_choice_data);
16 int menu_default_set(struct menu *m, char *item_key);
17 int menu_get_choice(struct menu *m, void **choice);
18 int menu_item_add(struct menu *m, char *item_key, void *item_data);
19 int menu_destroy(struct menu *m);
20 int menu_default_choice(struct menu *m, void **choice);
21
22 /**
23  * menu_show() Show a boot menu
24  *
25  * This shows a menu and lets the user select an option. The menu is defined by
26  * environment variables (see README.bootmenu).
27  *
28  * This function doesn't normally return, but if the users requests the command
29  * problem, it will.
30  *
31  * @bootdelay: Delay to wait before running the default menu option (0 to run
32  *              the entry immediately)
33  * Return: If it returns, it always returns -1 to indicate that the boot should
34  *      be aborted and the command prompt should be provided
35  */
36 int menu_show(int bootdelay);
37
38 #endif /* __MENU_H__ */