Prepare v2023.10

[platform/kernel/u-boot.git] / include / menu.h

diff --git a/include/menu.h b/include/menu.h
index 29b4579..64ce89b 100644 (file)
--- a/include/menu.h
+++ b/include/menu.h
@@ -6,6 +6,7 @@
 #ifndef __MENU_H__
 #define __MENU_H__
 
+struct cli_ch_state;
 struct menu;
 
 struct menu *menu_create(char *title, int timeout, int prompt,
@@ -52,6 +53,9 @@ enum bootmenu_key {
        BKEY_PLUS,
        BKEY_MINUS,
        BKEY_SPACE,
+       BKEY_SAVE,
+
+       BKEY_COUNT,
 };
 
 /**
@@ -65,14 +69,14 @@ enum bootmenu_key {
  * indicating that the current option should be chosen.
  *
  * @menu: Menu being processed
- * @key: Returns the code for the key the user pressed:
+ * @esc: Set to 1 if the escape key is pressed, otherwise not updated
+ * Returns: code for the key the user pressed:
  *     enter: KEY_SELECT
  *     Ctrl-C: KEY_QUIT
  *     anything else: KEY_NONE
- * @esc: Set to 1 if the escape key is pressed, otherwise not updated
  */
-void bootmenu_autoboot_loop(struct bootmenu_data *menu,
-                           enum bootmenu_key *key, int *esc);
+enum bootmenu_key bootmenu_autoboot_loop(struct bootmenu_data *menu,
+                                        struct cli_ch_state *cch);
 
 /**
  * bootmenu_loop() - handle waiting for a keypress when autoboot is disabled
@@ -84,7 +88,10 @@ void bootmenu_autoboot_loop(struct bootmenu_data *menu,
  * character is recognised
  *
  * @menu: Menu being processed
- * @key: Returns the code for the key the user pressed:
+ * @esc: On input, a non-zero value indicates that an escape sequence has
+ *     resulted in that many characters so far. On exit this is updated to the
+ *     new number of characters
+ * Returns: code for the key the user pressed:
  *     enter: BKEY_SELECT
  *     Ctrl-C: BKEY_QUIT
  *     Up arrow: BKEY_UP
@@ -93,11 +100,16 @@ void bootmenu_autoboot_loop(struct bootmenu_data *menu,
  *     Plus: BKEY_PLUS
  *     Minus: BKEY_MINUS
  *     Space: BKEY_SPACE
- * @esc: On input, a non-zero value indicates that an escape sequence has
- *     resulted in that many characters so far. On exit this is updated to the
- *     new number of characters
  */
-void bootmenu_loop(struct bootmenu_data *menu,
-                  enum bootmenu_key *key, int *esc);
+enum bootmenu_key bootmenu_loop(struct bootmenu_data *menu,
+                               struct cli_ch_state *cch);
+
+/**
+ * bootmenu_conv_key() - Convert a U-Boot keypress into a menu key
+ *
+ * @ichar: Keypress to convert (ASCII, including control characters)
+ * Returns: Menu key that corresponds to @ichar, or BKEY_NONE if none
+ */
+enum bootmenu_key bootmenu_conv_key(int ichar);
 
 #endif /* __MENU_H__ */