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
9struct cli_ch_state;
10struct menu;
11
12struct menu *menu_create(char *title, int timeout, int prompt,
13				void (*display_statusline)(struct menu *),
14				void (*item_data_print)(void *),
15				char *(*item_choice)(void *),
16				void *item_choice_data);
17int menu_default_set(struct menu *m, char *item_key);
18int menu_get_choice(struct menu *m, void **choice);
19int menu_item_add(struct menu *m, char *item_key, void *item_data);
20int menu_destroy(struct menu *m);
21int menu_default_choice(struct menu *m, void **choice);
22
23/**
24 * menu_show() Show a boot menu
25 *
26 * This shows a menu and lets the user select an option. The menu is defined by
27 * environment variables (see README.bootmenu).
28 *
29 * This function doesn't normally return, but if the users requests the command
30 * problem, it will.
31 *
32 * @bootdelay: Delay to wait before running the default menu option (0 to run
33 *		the entry immediately)
34 * Return: If it returns, it always returns -1 to indicate that the boot should
35 *	be aborted and the command prompt should be provided
36 */
37int menu_show(int bootdelay);
38
39struct bootmenu_data {
40	int delay;			/* delay for autoboot */
41	int active;			/* active menu entry */
42	int count;			/* total count of menu entries */
43	struct bootmenu_entry *first;	/* first menu entry */
44};
45
46/** enum bootmenu_key - keys that can be returned by the bootmenu */
47enum bootmenu_key {
48	BKEY_NONE = 0,
49	BKEY_UP,
50	BKEY_DOWN,
51	BKEY_SELECT,
52	BKEY_QUIT,
53	BKEY_SAVE,
54
55	/* 'extra' keys, which are used by menus but not cedit */
56	BKEY_PLUS,
57	BKEY_MINUS,
58	BKEY_SPACE,
59
60	BKEY_COUNT,
61
62	/* Keys from here on are not used by cedit */
63	BKEY_FIRST_EXTRA = BKEY_PLUS,
64};
65
66/**
67 * bootmenu_autoboot_loop() - handle autobooting if no key is pressed
68 *
69 * This shows a prompt to allow the user to press a key to interrupt auto boot
70 * of the first menu option.
71 *
72 * It then waits for the required time (menu->delay in seconds) for a key to be
73 * pressed. If nothing is pressed in that time, @key returns KEY_SELECT
74 * indicating that the current option should be chosen.
75 *
76 * @menu: Menu being processed
77 * @esc: Set to 1 if the escape key is pressed, otherwise not updated
78 * Returns: code for the key the user pressed:
79 *	enter: KEY_SELECT
80 *	Ctrl-C: KEY_QUIT
81 *	anything else: KEY_NONE
82 */
83enum bootmenu_key bootmenu_autoboot_loop(struct bootmenu_data *menu,
84					 struct cli_ch_state *cch);
85
86/**
87 * bootmenu_loop() - handle waiting for a keypress when autoboot is disabled
88 *
89 * This is used when the menu delay is negative, indicating that the delay has
90 * elapsed, or there was no delay to begin with.
91 *
92 * It reads a character and processes it, returning a menu-key code if a
93 * character is recognised
94 *
95 * @menu: Menu being processed
96 * @esc: On input, a non-zero value indicates that an escape sequence has
97 *	resulted in that many characters so far. On exit this is updated to the
98 *	new number of characters
99 * Returns: code for the key the user pressed:
100 *	enter: BKEY_SELECT
101 *	Ctrl-C: BKEY_QUIT
102 *	Up arrow: BKEY_UP
103 *	Down arrow: BKEY_DOWN
104 *	Escape (by itself): BKEY_QUIT
105 *	Plus: BKEY_PLUS
106 *	Minus: BKEY_MINUS
107 *	Space: BKEY_SPACE
108 */
109enum bootmenu_key bootmenu_loop(struct bootmenu_data *menu,
110				struct cli_ch_state *cch);
111
112/**
113 * bootmenu_conv_key() - Convert a U-Boot keypress into a menu key
114 *
115 * @ichar: Keypress to convert (ASCII, including control characters)
116 * Returns: Menu key that corresponds to @ichar, or BKEY_NONE if none
117 */
118enum bootmenu_key bootmenu_conv_key(int ichar);
119
120#endif /* __MENU_H__ */
121