eficonfig: add vertical scroll support

The current eficonfig menu does not support vertical scroll,
so it can not display the menu entries greater than
the console row size.

This commit add the vertial scroll support.
The console size is retrieved by
SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode() service, then
calculates the row size for menu entry by subtracting
menu header and description row size from the console row size.
"start" and "end" are added in the efimenu structure.
"start" keeps the menu entry index at the top, "end" keeps
the bottom menu entry index. item_data_print() menu function
only draws the menu entry between "start" and "end".

This commit also fixes the issue that "Save" and "Quit"
entries can be moved by BKEY_PLUS in change boot order menu.

Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>

diff --git a/cmd/eficonfig.c b/cmd/eficonfig.c
index 01bd1b05bc2028b1252e1ca86e394b5bd74dc978..47c04cf536303c3282027174d08f24f26cfbc503 100644 (file)
--- a/cmd/eficonfig.c
+++ b/cmd/eficonfig.c
@@ -30,8 +30,13 @@ static const char *eficonfig_change_boot_order_desc =
        "  Press SPACE to activate or deactivate the entry\n"
        "  Select [Save] to complete, ESC/CTRL+C to quit";
 
+static struct efi_simple_text_output_protocol *cout;
+static int avail_row;
+
 #define EFICONFIG_DESCRIPTION_MAX 32
 #define EFICONFIG_OPTIONAL_DATA_MAX 64
+#define EFICONFIG_MENU_HEADER_ROW_NUM 3
+#define EFICONFIG_MENU_DESC_ROW_NUM 5
 
 /**
  * struct eficonfig_filepath_info - structure to be used to store file path
@@ -122,6 +127,30 @@ struct eficonfig_save_boot_order_data {
        bool selected;
 };
 
+/**
+ * struct eficonfig_menu_adjust - update start and end entry index
+ *
+ * @efi_menu:  pointer to efimenu structure
+ * @add:       flag to add or substract the index
+ */
+static void eficonfig_menu_adjust(struct efimenu *efi_menu, bool add)
+{
+       if (add)
+               ++efi_menu->active;
+       else
+               --efi_menu->active;
+
+       if (add && efi_menu->end < efi_menu->active) {
+               efi_menu->start++;
+               efi_menu->end++;
+       } else if (!add && efi_menu->start > efi_menu->active) {
+               efi_menu->start--;
+               efi_menu->end--;
+       }
+}
+#define eficonfig_menu_up(_a) eficonfig_menu_adjust(_a, false)
+#define eficonfig_menu_down(_a) eficonfig_menu_adjust(_a, true)
+
 /**
  * eficonfig_print_msg() - print message
  *
@@ -157,18 +186,16 @@ void eficonfig_print_entry(void *data)
        struct eficonfig_entry *entry = data;
        bool reverse = (entry->efi_menu->active == entry->num);
 
-       /* TODO: support scroll or page for many entries */
+       if (entry->efi_menu->start > entry->num || entry->efi_menu->end < entry->num)
+               return;
 
-       /*
-        * Move cursor to line where the entry will be drawn (entry->num)
-        * First 3 lines(menu header) + 1 empty line
-        */
-       printf(ANSI_CURSOR_POSITION, entry->num + 4, 7);
+       printf(ANSI_CURSOR_POSITION, (entry->num - entry->efi_menu->start) +
+              EFICONFIG_MENU_HEADER_ROW_NUM + 1, 7);
 
        if (reverse)
                puts(ANSI_COLOR_REVERSE);
 
-       printf("%s", entry->title);
+       printf(ANSI_CLEAR_LINE "%s", entry->title);
 
        if (reverse)
                puts(ANSI_COLOR_RESET);
@@ -191,8 +218,8 @@ void eficonfig_display_statusline(struct menu *m)
               ANSI_CURSOR_POSITION ANSI_CLEAR_LINE ANSI_CURSOR_POSITION
               "%s"
               ANSI_CLEAR_LINE_TO_END,
-              1, 1, entry->efi_menu->menu_header, entry->efi_menu->count + 5, 1,
-              entry->efi_menu->count + 6, 1, entry->efi_menu->menu_desc);
+              1, 1, entry->efi_menu->menu_header, avail_row + 4, 1,
+              avail_row + 5, 1, entry->efi_menu->menu_desc);
 }
 
 /**
@@ -217,12 +244,14 @@ char *eficonfig_choice_entry(void *data)
                switch (key) {
                case BKEY_UP:
                        if (efi_menu->active > 0)
-                               --efi_menu->active;
+                               eficonfig_menu_up(efi_menu);
+
                        /* no menu key selected, regenerate menu */
                        return NULL;
                case BKEY_DOWN:
                        if (efi_menu->active < efi_menu->count - 1)
-                               ++efi_menu->active;
+                               eficonfig_menu_down(efi_menu);
+
                        /* no menu key selected, regenerate menu */
                        return NULL;
                case BKEY_SELECT:
@@ -402,6 +431,8 @@ efi_status_t eficonfig_process_common(struct efimenu *efi_menu,
 
        efi_menu->delay = -1;
        efi_menu->active = 0;
+       efi_menu->start = 0;
+       efi_menu->end = avail_row - 1;
 
        if (menu_header) {
                efi_menu->menu_header = strdup(menu_header);
@@ -1868,7 +1899,11 @@ static void eficonfig_print_change_boot_order_entry(void *data)
        struct eficonfig_entry *entry = data;
        bool reverse = (entry->efi_menu->active == entry->num);
 
-       printf(ANSI_CURSOR_POSITION, entry->num + 4, 7);
+       if (entry->efi_menu->start > entry->num || entry->efi_menu->end < entry->num)
+               return;
+
+       printf(ANSI_CURSOR_POSITION ANSI_CLEAR_LINE,
+              (entry->num - entry->efi_menu->start) + EFICONFIG_MENU_HEADER_ROW_NUM + 1, 7);
 
        if (reverse)
                puts(ANSI_COLOR_REVERSE);
@@ -1906,7 +1941,8 @@ char *eficonfig_choice_change_boot_order(void *data)
 
                switch (key) {
                case BKEY_PLUS:
-                       if (efi_menu->active > 0) {
+                       if (efi_menu->active > 0 &&
+                           efi_menu->active < efi_menu->count - 2) {
                                list_for_each_safe(pos, n, &efi_menu->list) {
                                        entry = list_entry(pos, struct eficonfig_entry, list);
                                        if (entry->num == efi_menu->active)
@@ -1917,11 +1953,14 @@ char *eficonfig_choice_change_boot_order(void *data)
                                tmp->num++;
                                list_del(&tmp->list);
                                list_add(&tmp->list, &entry->list);
+
+                               eficonfig_menu_up(efi_menu);
                        }
-                       fallthrough;
+                       return NULL;
                case BKEY_UP:
                        if (efi_menu->active > 0)
-                               --efi_menu->active;
+                               eficonfig_menu_up(efi_menu);
+
                        return NULL;
                case BKEY_MINUS:
                        if (efi_menu->active < efi_menu->count - 3) {
@@ -1936,12 +1975,13 @@ char *eficonfig_choice_change_boot_order(void *data)
                                list_del(&entry->list);
                                list_add(&entry->list, &tmp->list);
 
-                               ++efi_menu->active;
+                               eficonfig_menu_down(efi_menu);
                        }
                        return NULL;
                case BKEY_DOWN:
                        if (efi_menu->active < efi_menu->count - 1)
-                               ++efi_menu->active;
+                               eficonfig_menu_down(efi_menu);
+
                        return NULL;
                case BKEY_SELECT:
                        /* "Save" */
@@ -2590,6 +2630,7 @@ static efi_status_t eficonfig_init(void)
        efi_status_t ret = EFI_SUCCESS;
        static bool init;
        struct efi_handler *handler;
+       unsigned long columns, rows;
 
        if (!init) {
                ret = efi_search_protocol(efi_root, &efi_guid_text_input_protocol, &handler);
@@ -2600,6 +2641,23 @@ static efi_status_t eficonfig_init(void)
                                        EFI_OPEN_PROTOCOL_GET_PROTOCOL);
                if (ret != EFI_SUCCESS)
                        return ret;
+               ret = efi_search_protocol(efi_root, &efi_guid_text_output_protocol, &handler);
+               if (ret != EFI_SUCCESS)
+                       return ret;
+
+               ret = efi_protocol_open(handler, (void **)&cout, efi_root, NULL,
+                                       EFI_OPEN_PROTOCOL_GET_PROTOCOL);
+               if (ret != EFI_SUCCESS)
+                       return ret;
+
+               cout->query_mode(cout, cout->mode->mode, &columns, &rows);
+               avail_row = rows - (EFICONFIG_MENU_HEADER_ROW_NUM +
+                                   EFICONFIG_MENU_DESC_ROW_NUM);
+               if (avail_row <= 0) {
+                       eficonfig_print_msg("Console size is too small!");
+                       return EFI_INVALID_PARAMETER;
+               }
+               /* TODO: Should we check the minimum column size? */
        }
 
        init = true;

diff --git a/include/efi_config.h b/include/efi_config.h
index cec5715f844b8361339bd442bcb30d0a7deb958f..6a104e4b1db5dd99b7dffc94fea9a4f77f080220 100644 (file)
--- a/include/efi_config.h
+++ b/include/efi_config.h
@@ -49,6 +49,8 @@ struct eficonfig_entry {
  * @menu_header:       menu header string
  * @menu_desc:         menu description string
  * @list:              menu entry list structure
+ * @start:             top menu index to draw
+ * @end:               bottom menu index to draw
  */
 struct efimenu {
        int delay;
@@ -57,6 +59,8 @@ struct efimenu {
        char *menu_header;
        const char *menu_desc;
        struct list_head list;
+       int start;
+       int end;
 };
 
 /**

diff --git a/include/efi_loader.h b/include/efi_loader.h
index f9e427f090597d6557d7a8029112d34d870f79d2..4560b0d04cb9cea059b1d519bd5167a0171b699b 100644 (file)
--- a/include/efi_loader.h
+++ b/include/efi_loader.h
@@ -328,6 +328,7 @@ extern const efi_guid_t efi_esrt_guid;
 extern const efi_guid_t smbios_guid;
 /*GUID of console */
 extern const efi_guid_t efi_guid_text_input_protocol;
+extern const efi_guid_t efi_guid_text_output_protocol;
 
 extern char __efi_runtime_start[], __efi_runtime_stop[];
 extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];