blob: 702aacb170c64a219f645be86eaee8b0fe320694 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Jason Hobbsb69bf522011-08-23 11:06:49 +00002/*
3 * Copyright 2010-2011 Calxeda, Inc.
Jason Hobbsb69bf522011-08-23 11:06:49 +00004 */
5
6#ifndef __MENU_H__
7#define __MENU_H__
8
9struct menu;
10
Jason Hobbsb41bc5a2011-08-23 11:06:50 +000011struct menu *menu_create(char *title, int timeout, int prompt,
Thirupathaiah Annapureddy5168d7a2020-03-18 11:38:42 -070012 void (*display_statusline)(struct menu *),
Pali Rohárfc9d64f2013-03-23 14:50:40 +000013 void (*item_data_print)(void *),
14 char *(*item_choice)(void *),
15 void *item_choice_data);
Jason Hobbsb69bf522011-08-23 11:06:49 +000016int menu_default_set(struct menu *m, char *item_key);
17int menu_get_choice(struct menu *m, void **choice);
18int menu_item_add(struct menu *m, char *item_key, void *item_data);
19int menu_destroy(struct menu *m);
Anatolij Gustschin6a3439f2013-03-23 14:52:04 +000020int menu_default_choice(struct menu *m, void **choice);
Jason Hobbsb69bf522011-08-23 11:06:49 +000021
Simon Glass14b9df12019-07-20 20:51:26 -060022/**
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)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010033 * Return: If it returns, it always returns -1 to indicate that the boot should
Simon Glass14b9df12019-07-20 20:51:26 -060034 * be aborted and the command prompt should be provided
35 */
Heiko Schocher317d6c52012-01-16 21:13:35 +000036int menu_show(int bootdelay);
Simon Glass14b9df12019-07-20 20:51:26 -060037
Masahisa Kojima3ae6cf52022-04-28 17:09:45 +090038struct bootmenu_data {
39 int delay; /* delay for autoboot */
40 int active; /* active menu entry */
41 int count; /* total count of menu entries */
42 struct bootmenu_entry *first; /* first menu entry */
43};
44
45enum bootmenu_key {
46 KEY_NONE = 0,
47 KEY_UP,
48 KEY_DOWN,
49 KEY_SELECT,
50 KEY_QUIT,
Masahisa Kojima95fc6692022-09-12 17:33:52 +090051 KEY_PLUS,
52 KEY_MINUS,
53 KEY_SPACE,
Masahisa Kojima3ae6cf52022-04-28 17:09:45 +090054};
55
56void bootmenu_autoboot_loop(struct bootmenu_data *menu,
57 enum bootmenu_key *key, int *esc);
58void bootmenu_loop(struct bootmenu_data *menu,
59 enum bootmenu_key *key, int *esc);
60
Jason Hobbsb69bf522011-08-23 11:06:49 +000061#endif /* __MENU_H__ */