Merge tag 'efi-2019-07-rc5-2' of git://git.denx.de/u-boot-efi
[platform/kernel/u-boot.git] / lib / efi_loader / efi_console.c
index d17f0a1..706e6ad 100644 (file)
@@ -62,6 +62,21 @@ static struct simple_text_output_mode efi_con_mode = {
        .cursor_visible = 1,
 };
 
+static int term_get_char(s32 *c)
+{
+       u64 timeout;
+
+       /* Wait up to 100 ms for a character */
+       timeout = timer_get_us() + 100000;
+
+       while (!tstc())
+               if (timer_get_us() > timeout)
+                       return 1;
+
+       *c = getc();
+       return 0;
+}
+
 /*
  * Receive and parse a reply from the terminal.
  *
@@ -72,34 +87,36 @@ static struct simple_text_output_mode efi_con_mode = {
  */
 static int term_read_reply(int *n, int num, char end_char)
 {
-       char c;
+       s32 c;
        int i = 0;
 
-       c = getc();
-       if (c != cESC)
+       if (term_get_char(&c) || c != cESC)
                return -1;
-       c = getc();
-       if (c != '[')
+
+       if (term_get_char(&c) || c != '[')
                return -1;
 
        n[0] = 0;
        while (1) {
-               c = getc();
-               if (c == ';') {
-                       i++;
-                       if (i >= num)
+               if (!term_get_char(&c)) {
+                       if (c == ';') {
+                               i++;
+                               if (i >= num)
+                                       return -1;
+                               n[i] = 0;
+                               continue;
+                       } else if (c == end_char) {
+                               break;
+                       } else if (c > '9' || c < '0') {
                                return -1;
-                       n[i] = 0;
-                       continue;
-               } else if (c == end_char) {
-                       break;
-               } else if (c > '9' || c < '0') {
+                       }
+
+                       /* Read one more decimal position */
+                       n[i] *= 10;
+                       n[i] += c - '0';
+               } else {
                        return -1;
                }
-
-               /* Read one more decimal position */
-               n[i] *= 10;
-               n[i] += c - '0';
        }
        if (i != num - 1)
                return -1;
@@ -119,6 +136,11 @@ static efi_status_t EFIAPI efi_cout_output_string(
 
        EFI_ENTRY("%p, %p", this, string);
 
+       if (!this || !string) {
+               ret = EFI_INVALID_PARAMETER;
+               goto out;
+       }
+
        buf = malloc(utf16_utf8_strlen(string) + 1);
        if (!buf) {
                ret = EFI_OUT_OF_RESOURCES;
@@ -185,32 +207,47 @@ static bool cout_mode_matches(struct cout_mode *mode, int rows, int cols)
        return (mode->rows == rows) && (mode->columns == cols);
 }
 
+/**
+ * query_console_serial() - query console size
+ *
+ * @rows       pointer to return number of rows
+ * @columns    pointer to return number of columns
+ * Returns     0 on success
+ */
 static int query_console_serial(int *rows, int *cols)
 {
-       /* Ask the terminal about its size */
-       int n[3];
-       u64 timeout;
+       int ret = 0;
+       int n[2];
 
        /* Empty input buffer */
        while (tstc())
                getc();
 
-       printf(ESC"[18t");
-
-       /* Check if we have a terminal that understands */
-       timeout = timer_get_us() + 1000000;
-       while (!tstc())
-               if (timer_get_us() > timeout)
-                       return -1;
-
-       /* Read {depth,rows,cols} */
-       if (term_read_reply(n, 3, 't'))
-               return -1;
-
-       *cols = n[2];
-       *rows = n[1];
+       /*
+        * Not all terminals understand CSI [18t for querying the console size.
+        * We should adhere to escape sequences documented in the console_codes
+        * man page and the ECMA-48 standard.
+        *
+        * So here we follow a different approach. We position the cursor to the
+        * bottom right and query its position. Before leaving the function we
+        * restore the original cursor position.
+        */
+       printf(ESC "7"          /* Save cursor position */
+              ESC "[r"         /* Set scrolling region to full window */
+              ESC "[999;999H"  /* Move to bottom right corner */
+              ESC "[6n");      /* Query cursor position */
+
+       /* Read {rows,cols} */
+       if (term_read_reply(n, 2, 'R')) {
+               ret = 1;
+               goto out;
+       }
 
-       return 0;
+       *cols = n[1];
+       *rows = n[0];
+out:
+       printf(ESC "8");        /* Restore cursor position */
+       return ret;
 }
 
 /*
@@ -279,23 +316,6 @@ static efi_status_t EFIAPI efi_cout_query_mode(
        return EFI_EXIT(EFI_SUCCESS);
 }
 
-static efi_status_t EFIAPI efi_cout_set_mode(
-                       struct efi_simple_text_output_protocol *this,
-                       unsigned long mode_number)
-{
-       EFI_ENTRY("%p, %ld", this, mode_number);
-
-
-       if (mode_number > efi_con_mode.max_mode)
-               return EFI_EXIT(EFI_UNSUPPORTED);
-
-       efi_con_mode.mode = mode_number;
-       efi_con_mode.cursor_column = 0;
-       efi_con_mode.cursor_row = 0;
-
-       return EFI_EXIT(EFI_SUCCESS);
-}
-
 static const struct {
        unsigned int fg;
        unsigned int bg;
@@ -321,6 +341,7 @@ static efi_status_t EFIAPI efi_cout_set_attribute(
 
        EFI_ENTRY("%p, %lx", this, attribute);
 
+       efi_con_mode.attribute = attribute;
        if (attribute)
                printf(ESC"[%u;%u;%um", bold, color[fg].fg, color[bg].bg);
        else
@@ -341,6 +362,20 @@ static efi_status_t EFIAPI efi_cout_clear_screen(
        return EFI_EXIT(EFI_SUCCESS);
 }
 
+static efi_status_t EFIAPI efi_cout_set_mode(
+                       struct efi_simple_text_output_protocol *this,
+                       unsigned long mode_number)
+{
+       EFI_ENTRY("%p, %ld", this, mode_number);
+
+       if (mode_number >= efi_con_mode.max_mode)
+               return EFI_EXIT(EFI_UNSUPPORTED);
+       efi_con_mode.mode = mode_number;
+       EFI_CALL(efi_cout_clear_screen(this));
+
+       return EFI_EXIT(EFI_SUCCESS);
+}
+
 static efi_status_t EFIAPI efi_cout_reset(
                        struct efi_simple_text_output_protocol *this,
                        char extended_verification)
@@ -350,6 +385,7 @@ static efi_status_t EFIAPI efi_cout_reset(
        /* Clear screen */
        EFI_CALL(efi_cout_clear_screen(this));
        /* Set default colors */
+       efi_con_mode.attribute = 0x07;
        printf(ESC "[0;37;40m");
 
        return EFI_EXIT(EFI_SUCCESS);
@@ -359,13 +395,31 @@ static efi_status_t EFIAPI efi_cout_set_cursor_position(
                        struct efi_simple_text_output_protocol *this,
                        unsigned long column, unsigned long row)
 {
+       efi_status_t ret = EFI_SUCCESS;
+       struct simple_text_output_mode *con = &efi_con_mode;
+       struct cout_mode *mode = &efi_cout_modes[con->mode];
+
        EFI_ENTRY("%p, %ld, %ld", this, column, row);
 
-       printf(ESC"[%d;%df", (int)row, (int)column);
+       /* Check parameters */
+       if (!this) {
+               ret = EFI_INVALID_PARAMETER;
+               goto out;
+       }
+       if (row >= mode->rows || column >= mode->columns) {
+               ret = EFI_UNSUPPORTED;
+               goto out;
+       }
+
+       /*
+        * Set cursor position by sending CSI H.
+        * EFI origin is [0, 0], terminal origin is [1, 1].
+        */
+       printf(ESC "[%d;%dH", (int)row + 1, (int)column + 1);
        efi_con_mode.cursor_column = column;
        efi_con_mode.cursor_row = row;
-
-       return EFI_EXIT(EFI_SUCCESS);
+out:
+       return EFI_EXIT(ret);
 }
 
 static efi_status_t EFIAPI efi_cout_enable_cursor(
@@ -375,6 +429,7 @@ static efi_status_t EFIAPI efi_cout_enable_cursor(
        EFI_ENTRY("%p, %d", this, enable);
 
        printf(ESC"[?25%c", enable ? 'h' : 'l');
+       efi_con_mode.cursor_visible = !!enable;
 
        return EFI_EXIT(EFI_SUCCESS);
 }
@@ -392,15 +447,53 @@ struct efi_simple_text_output_protocol efi_con_out = {
        .mode = (void*)&efi_con_mode,
 };
 
+/**
+ * struct efi_cin_notify_function - registered console input notify function
+ *
+ * @link:      link to list
+ * @data:      key to notify
+ * @function:  function to call
+ */
+struct efi_cin_notify_function {
+       struct list_head link;
+       struct efi_key_data key;
+       efi_status_t (EFIAPI *function)
+               (struct efi_key_data *key_data);
+};
+
 static bool key_available;
 static struct efi_key_data next_key;
+static LIST_HEAD(cin_notify_functions);
+
+/**
+ * set_shift_mask() - set shift mask
+ *
+ * @mod:       Xterm shift mask
+ */
+void set_shift_mask(int mod, struct efi_key_state *key_state)
+{
+       key_state->key_shift_state = EFI_SHIFT_STATE_VALID;
+       if (mod) {
+               --mod;
+               if (mod & 1)
+                       key_state->key_shift_state |= EFI_LEFT_SHIFT_PRESSED;
+               if (mod & 2)
+                       key_state->key_shift_state |= EFI_LEFT_ALT_PRESSED;
+               if (mod & 4)
+                       key_state->key_shift_state |= EFI_LEFT_CONTROL_PRESSED;
+               if (mod & 8)
+                       key_state->key_shift_state |= EFI_LEFT_LOGO_PRESSED;
+       } else {
+               key_state->key_shift_state |= EFI_LEFT_LOGO_PRESSED;
+       }
+}
 
 /**
  * analyze_modifiers() - analyze modifiers (shift, alt, ctrl) for function keys
  *
  * This gets called when we have already parsed CSI.
  *
- * @modifiers:  bitmask (shift, alt, ctrl)
+ * @modifiers:  bit mask (shift, alt, ctrl)
  * @return:    the unmodified code
  */
 static int analyze_modifiers(struct efi_key_state *key_state)
@@ -429,19 +522,7 @@ static int analyze_modifiers(struct efi_key_state *key_state)
                }
        }
 out:
-       if (mod)
-               --mod;
-       key_state->key_shift_state = EFI_SHIFT_STATE_VALID;
-       if (mod) {
-               if (mod & 1)
-                       key_state->key_shift_state |= EFI_LEFT_SHIFT_PRESSED;
-               if (mod & 2)
-                       key_state->key_shift_state |= EFI_LEFT_ALT_PRESSED;
-               if (mod & 4)
-                       key_state->key_shift_state |= EFI_LEFT_CONTROL_PRESSED;
-               if (mod & 8)
-                       key_state->key_shift_state |= EFI_LEFT_LOGO_PRESSED;
-       }
+       set_shift_mask(mod, key_state);
        if (!ret)
                ret = c;
        return ret;
@@ -455,15 +536,13 @@ out:
  */
 static efi_status_t efi_cin_read_key(struct efi_key_data *key)
 {
-       efi_status_t ret;
        struct efi_input_key pressed_key = {
                .scan_code = 0,
                .unicode_char = 0,
        };
        s32 ch;
 
-       ret = console_read_unicode(&ch);
-       if (ret)
+       if (console_read_unicode(&ch))
                return EFI_NOT_READY;
 
        key->key_state.key_shift_state = EFI_SHIFT_STATE_INVALID;
@@ -472,7 +551,9 @@ static efi_status_t efi_cin_read_key(struct efi_key_data *key)
        /* We do not support multi-word codes */
        if (ch >= 0x10000)
                ch = '?';
-       if (ch == cESC) {
+
+       switch (ch) {
+       case 0x1b:
                /*
                 * Xterm Control Sequences
                 * https://www.xfree86.org/4.8.0/ctlseqs.html
@@ -484,14 +565,13 @@ static efi_status_t efi_cin_read_key(struct efi_key_data *key)
                        break;
                case 'O': /* F1 - F4 */
                        ch = getc();
-                       /* skip modifiers */
-                       if (ch <= '9')
+                       /* consider modifiers */
+                       if (ch < 'P') {
+                               set_shift_mask(ch - '0', &key->key_state);
                                ch = getc();
+                       }
                        pressed_key.scan_code = ch - 'P' + 11;
                        break;
-               case 'a'...'z':
-                       ch = ch - 'a';
-                       break;
                case '[':
                        ch = getc();
                        switch (ch) {
@@ -550,10 +630,14 @@ static efi_status_t efi_cin_read_key(struct efi_key_data *key)
                                pressed_key.scan_code = 10;
                                analyze_modifiers(&key->key_state);
                                break;
-                       }
+                       } /* [ */
                        break;
+               default:
+                       /* ALT key */
+                       set_shift_mask(3, &key->key_state);
                }
-       } else if (ch == 0x7f) {
+               break;
+       case 0x7f:
                /* Backspace */
                ch = 0x08;
        }
@@ -567,7 +651,7 @@ static efi_status_t efi_cin_read_key(struct efi_key_data *key)
                 * entered using the control key.
                 */
                if (ch >= 0x01 && ch <= 0x1f) {
-                       key->key_state.key_shift_state =
+                       key->key_state.key_shift_state |=
                                        EFI_SHIFT_STATE_VALID;
                        switch (ch) {
                        case 0x01 ... 0x07:
@@ -584,6 +668,34 @@ static efi_status_t efi_cin_read_key(struct efi_key_data *key)
 }
 
 /**
+ * efi_cin_notify() - notify registered functions
+ */
+static void efi_cin_notify(void)
+{
+       struct efi_cin_notify_function *item;
+
+       list_for_each_entry(item, &cin_notify_functions, link) {
+               bool match = true;
+
+               /* We do not support toggle states */
+               if (item->key.key.unicode_char || item->key.key.scan_code) {
+                       if (item->key.key.unicode_char !=
+                           next_key.key.unicode_char ||
+                           item->key.key.scan_code != next_key.key.scan_code)
+                               match = false;
+               }
+               if (item->key.key_state.key_shift_state &&
+                   item->key.key_state.key_shift_state !=
+                   next_key.key_state.key_shift_state)
+                       match = false;
+
+               if (match)
+                       /* We don't bother about the return code */
+                       EFI_CALL(item->function(&next_key));
+       }
+}
+
+/**
  * efi_cin_check() - check if keyboard input is available
  */
 static void efi_cin_check(void)
@@ -591,7 +703,7 @@ static void efi_cin_check(void)
        efi_status_t ret;
 
        if (key_available) {
-               efi_signal_event(efi_con_in.wait_for_key, true);
+               efi_signal_event(efi_con_in.wait_for_key);
                return;
        }
 
@@ -600,8 +712,12 @@ static void efi_cin_check(void)
                if (ret == EFI_SUCCESS) {
                        key_available = true;
 
+                       /* Notify registered functions */
+                       efi_cin_notify();
+
                        /* Queue the wait for key event */
-                       efi_signal_event(efi_con_in.wait_for_key, true);
+                       if (key_available)
+                               efi_signal_event(efi_con_in.wait_for_key);
                }
        }
 }
@@ -686,9 +802,26 @@ static efi_status_t EFIAPI efi_cin_read_key_stroke_ex(
                ret = EFI_NOT_READY;
                goto out;
        }
+       /*
+        * CTRL+A - CTRL+Z have to be signaled as a - z.
+        * SHIFT+CTRL+A - SHIFT+CTRL+Z have to be signaled as A - Z.
+        */
+       switch (next_key.key.unicode_char) {
+       case 0x01 ... 0x07:
+       case 0x0b ... 0x0c:
+       case 0x0e ... 0x1a:
+               if (!(next_key.key_state.key_toggle_state &
+                     EFI_CAPS_LOCK_ACTIVE) ^
+                   !(next_key.key_state.key_shift_state &
+                     (EFI_LEFT_SHIFT_PRESSED | EFI_RIGHT_SHIFT_PRESSED)))
+                       next_key.key.unicode_char += 0x40;
+               else
+                       next_key.key.unicode_char += 0x60;
+       }
        *key_data = next_key;
        key_available = false;
        efi_con_in.wait_for_key->is_signaled = false;
+
 out:
        return EFI_EXIT(ret);
 }
@@ -697,7 +830,7 @@ out:
  * efi_cin_set_state() - set toggle key state
  *
  * @this:              instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
- * @key_toggle_state:  key toggle state
+ * @key_toggle_state:  pointer to key toggle state
  * Return:             status code
  *
  * This function implements the SetState service of the
@@ -708,9 +841,9 @@ out:
  */
 static efi_status_t EFIAPI efi_cin_set_state(
                struct efi_simple_text_input_ex_protocol *this,
-               u8 key_toggle_state)
+               u8 *key_toggle_state)
 {
-       EFI_ENTRY("%p, %u", this, key_toggle_state);
+       EFI_ENTRY("%p, %p", this, key_toggle_state);
        /*
         * U-Boot supports multiple console input sources like serial and
         * net console for which a key toggle state cannot be set at all.
@@ -743,9 +876,35 @@ static efi_status_t EFIAPI efi_cin_register_key_notify(
                        struct efi_key_data *key_data),
                void **notify_handle)
 {
+       efi_status_t ret = EFI_SUCCESS;
+       struct efi_cin_notify_function *notify_function;
+
        EFI_ENTRY("%p, %p, %p, %p",
                  this, key_data, key_notify_function, notify_handle);
-       return EFI_EXIT(EFI_OUT_OF_RESOURCES);
+
+       /* Check parameters */
+       if (!this || !key_data || !key_notify_function || !notify_handle) {
+               ret = EFI_INVALID_PARAMETER;
+               goto out;
+       }
+
+       EFI_PRINT("u+%04x, sc %04x, sh %08x, tg %02x\n",
+                 key_data->key.unicode_char,
+              key_data->key.scan_code,
+              key_data->key_state.key_shift_state,
+              key_data->key_state.key_toggle_state);
+
+       notify_function = calloc(1, sizeof(struct efi_cin_notify_function));
+       if (!notify_function) {
+               ret = EFI_OUT_OF_RESOURCES;
+               goto out;
+       }
+       notify_function->key = *key_data;
+       notify_function->function = key_notify_function;
+       list_add_tail(&notify_function->link, &cin_notify_functions);
+       *notify_handle = notify_function;
+out:
+       return EFI_EXIT(ret);
 }
 
 /**
@@ -765,8 +924,30 @@ static efi_status_t EFIAPI efi_cin_unregister_key_notify(
                struct efi_simple_text_input_ex_protocol *this,
                void *notification_handle)
 {
+       efi_status_t ret = EFI_INVALID_PARAMETER;
+       struct efi_cin_notify_function *item, *notify_function =
+                       notification_handle;
+
        EFI_ENTRY("%p, %p", this, notification_handle);
-       return EFI_EXIT(EFI_INVALID_PARAMETER);
+
+       /* Check parameters */
+       if (!this || !notification_handle)
+               goto out;
+
+       list_for_each_entry(item, &cin_notify_functions, link) {
+               if (item == notify_function) {
+                       ret = EFI_SUCCESS;
+                       break;
+               }
+       }
+       if (ret != EFI_SUCCESS)
+               goto out;
+
+       /* Remove the notify function */
+       list_del(&notify_function->link);
+       free(notify_function);
+out:
+       return EFI_EXIT(ret);
 }
 
 
@@ -894,38 +1075,40 @@ static void EFIAPI efi_key_notify(struct efi_event *event, void *context)
  * efi_console_register() - install the console protocols
  *
  * This function is called from do_bootefi_exec().
+ *
+ * Return:     status code
  */
-int efi_console_register(void)
+efi_status_t efi_console_register(void)
 {
        efi_status_t r;
-       struct efi_object *efi_console_output_obj;
-       struct efi_object *efi_console_input_obj;
+       efi_handle_t console_output_handle;
+       efi_handle_t console_input_handle;
 
        /* Set up mode information */
        query_console_size();
 
        /* Create handles */
-       r = efi_create_handle((efi_handle_t *)&efi_console_output_obj);
+       r = efi_create_handle(&console_output_handle);
        if (r != EFI_SUCCESS)
                goto out_of_memory;
 
-       r = efi_add_protocol(efi_console_output_obj->handle,
+       r = efi_add_protocol(console_output_handle,
                             &efi_guid_text_output_protocol, &efi_con_out);
        if (r != EFI_SUCCESS)
                goto out_of_memory;
-       systab.con_out_handle = efi_console_output_obj->handle;
-       systab.stderr_handle = efi_console_output_obj->handle;
+       systab.con_out_handle = console_output_handle;
+       systab.stderr_handle = console_output_handle;
 
-       r = efi_create_handle((efi_handle_t *)&efi_console_input_obj);
+       r = efi_create_handle(&console_input_handle);
        if (r != EFI_SUCCESS)
                goto out_of_memory;
 
-       r = efi_add_protocol(efi_console_input_obj->handle,
+       r = efi_add_protocol(console_input_handle,
                             &efi_guid_text_input_protocol, &efi_con_in);
        if (r != EFI_SUCCESS)
                goto out_of_memory;
-       systab.con_in_handle = efi_console_input_obj->handle;
-       r = efi_add_protocol(efi_console_input_obj->handle,
+       systab.con_in_handle = console_input_handle;
+       r = efi_add_protocol(console_input_handle,
                             &efi_guid_text_input_ex_protocol, &efi_con_in_ex);
        if (r != EFI_SUCCESS)
                goto out_of_memory;