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 struct 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
  45 /** enum bootmenu_key - keys that can be returned by the bootmenu */
  46 enum bootmenu_key {
  47         BKEY_NONE = 0,
  48         BKEY_UP,
  49         BKEY_DOWN,
  50         BKEY_SELECT,
  51         BKEY_QUIT,
  52         BKEY_PLUS,
  53         BKEY_MINUS,
  54         BKEY_SPACE,
  55 };
  56
  57 /**
  58  * bootmenu_autoboot_loop() - handle autobooting if no key is pressed
  59  *
  60  * This shows a prompt to allow the user to press a key to interrupt auto boot
  61  * of the first menu option.
  62  *
  63  * It then waits for the required time (menu->delay in seconds) for a key to be
  64  * pressed. If nothing is pressed in that time, @key returns KEY_SELECT
  65  * indicating that the current option should be chosen.
  66  *
  67  * @menu: Menu being processed
  68  * @esc: Set to 1 if the escape key is pressed, otherwise not updated
  69  * Returns: code for the key the user pressed:
  70  *      enter: KEY_SELECT
  71  *      Ctrl-C: KEY_QUIT
  72  *      anything else: KEY_NONE
  73  */
  74 enum bootmenu_key bootmenu_autoboot_loop(struct bootmenu_data *menu, int *esc);
  75
  76 /**
  77  * bootmenu_loop() - handle waiting for a keypress when autoboot is disabled
  78  *
  79  * This is used when the menu delay is negative, indicating that the delay has
  80  * elapsed, or there was no delay to begin with.
  81  *
  82  * It reads a character and processes it, returning a menu-key code if a
  83  * character is recognised
  84  *
  85  * @menu: Menu being processed
  86  * @esc: On input, a non-zero value indicates that an escape sequence has
  87  *      resulted in that many characters so far. On exit this is updated to the
  88  *      new number of characters
  89  * Returns: code for the key the user pressed:
  90  *      enter: BKEY_SELECT
  91  *      Ctrl-C: BKEY_QUIT
  92  *      Up arrow: BKEY_UP
  93  *      Down arrow: BKEY_DOWN
  94  *      Escape (by itself): BKEY_QUIT
  95  *      Plus: BKEY_PLUS
  96  *      Minus: BKEY_MINUS
  97  *      Space: BKEY_SPACE
  98  */
  99 enum bootmenu_key bootmenu_loop(struct bootmenu_data *menu, int *esc);
 100
 101 #endif /* __MENU_H__ */