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 {
  46         KEY_NONE = 0,
  47         KEY_UP,
  48         KEY_DOWN,
  49         KEY_SELECT,
  50         KEY_QUIT,
  51         KEY_PLUS,
  52         KEY_MINUS,
  53         KEY_SPACE,
  54 };
  55
  56 void bootmenu_autoboot_loop(struct bootmenu_data *menu,
  57                             enum bootmenu_key *key, int *esc);
  58 void bootmenu_loop(struct bootmenu_data *menu,
  59                    enum bootmenu_key *key, int *esc);
  60
  61 #endif /* __MENU_H__ */