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