lib/efi_loader/efi_console.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  EFI application console interface
   4  *
   5  *  Copyright (c) 2016 Alexander Graf
   6  */
   7
   8 #include <common.h>
   9 #include <charset.h>
  10 #include <dm/device.h>
  11 #include <efi_loader.h>
  12 #include <stdio_dev.h>
  13 #include <video_console.h>
  14
  15 #define EFI_COUT_MODE_2 2
  16 #define EFI_MAX_COUT_MODE 3
  17
  18 struct cout_mode {
  19         unsigned long columns;
  20         unsigned long rows;
  21         int present;
  22 };
  23
  24 static struct cout_mode efi_cout_modes[] = {
  25         /* EFI Mode 0 is 80x25 and always present */
  26         {
  27                 .columns = 80,
  28                 .rows = 25,
  29                 .present = 1,
  30         },
  31         /* EFI Mode 1 is always 80x50 */
  32         {
  33                 .columns = 80,
  34                 .rows = 50,
  35                 .present = 0,
  36         },
  37         /* Value are unknown until we query the console */
  38         {
  39                 .columns = 0,
  40                 .rows = 0,
  41                 .present = 0,
  42         },
  43 };
  44
  45 const efi_guid_t efi_guid_text_input_ex_protocol =
  46                         EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID;
  47 const efi_guid_t efi_guid_text_input_protocol =
  48                         EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID;
  49 const efi_guid_t efi_guid_text_output_protocol =
  50                         EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID;
  51
  52 #define cESC '\x1b'
  53 #define ESC "\x1b"
  54
  55 /* Default to mode 0 */
  56 static struct simple_text_output_mode efi_con_mode = {
  57         .max_mode = 1,
  58         .mode = 0,
  59         .attribute = 0,
  60         .cursor_column = 0,
  61         .cursor_row = 0,
  62         .cursor_visible = 1,
  63 };
  64
  65 static int term_get_char(s32 *c)
  66 {
  67         u64 timeout;
  68
  69         /* Wait up to 100 ms for a character */
  70         timeout = timer_get_us() + 100000;
  71
  72         while (!tstc())
  73                 if (timer_get_us() > timeout)
  74                         return 1;
  75
  76         *c = getc();
  77         return 0;
  78 }
  79
  80 /*
  81  * Receive and parse a reply from the terminal.
  82  *
  83  * @n:          array of return values
  84  * @num:        number of return values expected
  85  * @end_char:   character indicating end of terminal message
  86  * @return:     non-zero indicates error
  87  */
  88 static int term_read_reply(int *n, int num, char end_char)
  89 {
  90         s32 c;
  91         int i = 0;
  92
  93         if (term_get_char(&c) || c != cESC)
  94                 return -1;
  95
  96         if (term_get_char(&c) || c != '[')
  97                 return -1;
  98
  99         n[0] = 0;
 100         while (1) {
 101                 if (!term_get_char(&c)) {
 102                         if (c == ';') {
 103                                 i++;
 104                                 if (i >= num)
 105                                         return -1;
 106                                 n[i] = 0;
 107                                 continue;
 108                         } else if (c == end_char) {
 109                                 break;
 110                         } else if (c > '9' || c < '0') {
 111                                 return -1;
 112                         }
 113
 114                         /* Read one more decimal position */
 115                         n[i] *= 10;
 116                         n[i] += c - '0';
 117                 } else {
 118                         return -1;
 119                 }
 120         }
 121         if (i != num - 1)
 122                 return -1;
 123
 124         return 0;
 125 }
 126
 127 static efi_status_t EFIAPI efi_cout_output_string(
 128                         struct efi_simple_text_output_protocol *this,
 129                         const efi_string_t string)
 130 {
 131         struct simple_text_output_mode *con = &efi_con_mode;
 132         struct cout_mode *mode = &efi_cout_modes[con->mode];
 133         char *buf, *pos;
 134         u16 *p;
 135         efi_status_t ret = EFI_SUCCESS;
 136
 137         EFI_ENTRY("%p, %p", this, string);
 138
 139         if (!this || !string) {
 140                 ret = EFI_INVALID_PARAMETER;
 141                 goto out;
 142         }
 143
 144         buf = malloc(utf16_utf8_strlen(string) + 1);
 145         if (!buf) {
 146                 ret = EFI_OUT_OF_RESOURCES;
 147                 goto out;
 148         }
 149         pos = buf;
 150         utf16_utf8_strcpy(&pos, string);
 151         fputs(stdout, buf);
 152         free(buf);
 153
 154         /*
 155          * Update the cursor position.
 156          *
 157          * The UEFI spec provides advance rules for U+0000, U+0008, U+000A,
 158          * and U000D. All other characters, including control characters
 159          * U+0007 (BEL) and U+0009 (TAB), have to increase the column by one.
 160          */
 161         for (p = string; *p; ++p) {
 162                 switch (*p) {
 163                 case '\b':      /* U+0008, backspace */
 164                         con->cursor_column = max(0, con->cursor_column - 1);
 165                         break;
 166                 case '\n':      /* U+000A, newline */
 167                         con->cursor_column = 0;
 168                         con->cursor_row++;
 169                         break;
 170                 case '\r':      /* U+000D, carriage-return */
 171                         con->cursor_column = 0;
 172                         break;
 173                 case 0xd800 ... 0xdbff:
 174                         /*
 175                          * Ignore high surrogates, we do not want to count a
 176                          * Unicode character twice.
 177                          */
 178                         break;
 179                 default:
 180                         con->cursor_column++;
 181                         break;
 182                 }
 183                 if (con->cursor_column >= mode->columns) {
 184                         con->cursor_column = 0;
 185                         con->cursor_row++;
 186                 }
 187                 con->cursor_row = min(con->cursor_row, (s32)mode->rows - 1);
 188         }
 189
 190 out:
 191         return EFI_EXIT(ret);
 192 }
 193
 194 static efi_status_t EFIAPI efi_cout_test_string(
 195                         struct efi_simple_text_output_protocol *this,
 196                         const efi_string_t string)
 197 {
 198         EFI_ENTRY("%p, %p", this, string);
 199         return EFI_EXIT(EFI_SUCCESS);
 200 }
 201
 202 static bool cout_mode_matches(struct cout_mode *mode, int rows, int cols)
 203 {
 204         if (!mode->present)
 205                 return false;
 206
 207         return (mode->rows == rows) && (mode->columns == cols);
 208 }
 209
 210 /**
 211  * query_console_serial() - query console size
 212  *
 213  * @rows        pointer to return number of rows
 214  * @columns     pointer to return number of columns
 215  * Returns      0 on success
 216  */
 217 static int query_console_serial(int *rows, int *cols)
 218 {
 219         int ret = 0;
 220         int n[2];
 221
 222         /* Empty input buffer */
 223         while (tstc())
 224                 getc();
 225
 226         /*
 227          * Not all terminals understand CSI [18t for querying the console size.
 228          * We should adhere to escape sequences documented in the console_codes
 229          * man page and the ECMA-48 standard.
 230          *
 231          * So here we follow a different approach. We position the cursor to the
 232          * bottom right and query its position. Before leaving the function we
 233          * restore the original cursor position.
 234          */
 235         printf(ESC "7"          /* Save cursor position */
 236                ESC "[r"         /* Set scrolling region to full window */
 237                ESC "[999;999H"  /* Move to bottom right corner */
 238                ESC "[6n");      /* Query cursor position */
 239
 240         /* Read {rows,cols} */
 241         if (term_read_reply(n, 2, 'R')) {
 242                 ret = 1;
 243                 goto out;
 244         }
 245
 246         *cols = n[1];
 247         *rows = n[0];
 248 out:
 249         printf(ESC "8");        /* Restore cursor position */
 250         return ret;
 251 }
 252
 253 /*
 254  * Update the mode table.
 255  *
 256  * By default the only mode available is 80x25. If the console has at least 50
 257  * lines, enable mode 80x50. If we can query the console size and it is neither
 258  * 80x25 nor 80x50, set it as an additional mode.
 259  */
 260 static void query_console_size(void)
 261 {
 262         const char *stdout_name = env_get("stdout");
 263         int rows = 25, cols = 80;
 264
 265         if (stdout_name && !strcmp(stdout_name, "vidconsole") &&
 266             IS_ENABLED(CONFIG_DM_VIDEO)) {
 267                 struct stdio_dev *stdout_dev =
 268                         stdio_get_by_name("vidconsole");
 269                 struct udevice *dev = stdout_dev->priv;
 270                 struct vidconsole_priv *priv =
 271                         dev_get_uclass_priv(dev);
 272                 rows = priv->rows;
 273                 cols = priv->cols;
 274         } else if (query_console_serial(&rows, &cols)) {
 275                 return;
 276         }
 277
 278         /* Test if we can have Mode 1 */
 279         if (cols >= 80 && rows >= 50) {
 280                 efi_cout_modes[1].present = 1;
 281                 efi_con_mode.max_mode = 2;
 282         }
 283
 284         /*
 285          * Install our mode as mode 2 if it is different
 286          * than mode 0 or 1 and set it as the currently selected mode
 287          */
 288         if (!cout_mode_matches(&efi_cout_modes[0], rows, cols) &&
 289             !cout_mode_matches(&efi_cout_modes[1], rows, cols)) {
 290                 efi_cout_modes[EFI_COUT_MODE_2].columns = cols;
 291                 efi_cout_modes[EFI_COUT_MODE_2].rows = rows;
 292                 efi_cout_modes[EFI_COUT_MODE_2].present = 1;
 293                 efi_con_mode.max_mode = EFI_MAX_COUT_MODE;
 294                 efi_con_mode.mode = EFI_COUT_MODE_2;
 295         }
 296 }
 297
 298 static efi_status_t EFIAPI efi_cout_query_mode(
 299                         struct efi_simple_text_output_protocol *this,
 300                         unsigned long mode_number, unsigned long *columns,
 301                         unsigned long *rows)
 302 {
 303         EFI_ENTRY("%p, %ld, %p, %p", this, mode_number, columns, rows);
 304
 305         if (mode_number >= efi_con_mode.max_mode)
 306                 return EFI_EXIT(EFI_UNSUPPORTED);
 307
 308         if (efi_cout_modes[mode_number].present != 1)
 309                 return EFI_EXIT(EFI_UNSUPPORTED);
 310
 311         if (columns)
 312                 *columns = efi_cout_modes[mode_number].columns;
 313         if (rows)
 314                 *rows = efi_cout_modes[mode_number].rows;
 315
 316         return EFI_EXIT(EFI_SUCCESS);
 317 }
 318
 319 static const struct {
 320         unsigned int fg;
 321         unsigned int bg;
 322 } color[] = {
 323         { 30, 40 },     /* 0: black */
 324         { 34, 44 },     /* 1: blue */
 325         { 32, 42 },     /* 2: green */
 326         { 36, 46 },     /* 3: cyan */
 327         { 31, 41 },     /* 4: red */
 328         { 35, 45 },     /* 5: magenta */
 329         { 33, 43 },     /* 6: brown, map to yellow as EDK2 does*/
 330         { 37, 47 },     /* 7: light gray, map to white */
 331 };
 332
 333 /* See EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute(). */
 334 static efi_status_t EFIAPI efi_cout_set_attribute(
 335                         struct efi_simple_text_output_protocol *this,
 336                         unsigned long attribute)
 337 {
 338         unsigned int bold = EFI_ATTR_BOLD(attribute);
 339         unsigned int fg = EFI_ATTR_FG(attribute);
 340         unsigned int bg = EFI_ATTR_BG(attribute);
 341
 342         EFI_ENTRY("%p, %lx", this, attribute);
 343
 344         efi_con_mode.attribute = attribute;
 345         if (attribute)
 346                 printf(ESC"[%u;%u;%um", bold, color[fg].fg, color[bg].bg);
 347         else
 348                 printf(ESC"[0;37;40m");
 349
 350         return EFI_EXIT(EFI_SUCCESS);
 351 }
 352
 353 static efi_status_t EFIAPI efi_cout_clear_screen(
 354                         struct efi_simple_text_output_protocol *this)
 355 {
 356         EFI_ENTRY("%p", this);
 357
 358         printf(ESC"[2J");
 359         efi_con_mode.cursor_column = 0;
 360         efi_con_mode.cursor_row = 0;
 361
 362         return EFI_EXIT(EFI_SUCCESS);
 363 }
 364
 365 static efi_status_t EFIAPI efi_cout_set_mode(
 366                         struct efi_simple_text_output_protocol *this,
 367                         unsigned long mode_number)
 368 {
 369         EFI_ENTRY("%p, %ld", this, mode_number);
 370
 371         if (mode_number >= efi_con_mode.max_mode)
 372                 return EFI_EXIT(EFI_UNSUPPORTED);
 373         efi_con_mode.mode = mode_number;
 374         EFI_CALL(efi_cout_clear_screen(this));
 375
 376         return EFI_EXIT(EFI_SUCCESS);
 377 }
 378
 379 static efi_status_t EFIAPI efi_cout_reset(
 380                         struct efi_simple_text_output_protocol *this,
 381                         char extended_verification)
 382 {
 383         EFI_ENTRY("%p, %d", this, extended_verification);
 384
 385         /* Clear screen */
 386         EFI_CALL(efi_cout_clear_screen(this));
 387         /* Set default colors */
 388         efi_con_mode.attribute = 0x07;
 389         printf(ESC "[0;37;40m");
 390
 391         return EFI_EXIT(EFI_SUCCESS);
 392 }
 393
 394 static efi_status_t EFIAPI efi_cout_set_cursor_position(
 395                         struct efi_simple_text_output_protocol *this,
 396                         unsigned long column, unsigned long row)
 397 {
 398         efi_status_t ret = EFI_SUCCESS;
 399         struct simple_text_output_mode *con = &efi_con_mode;
 400         struct cout_mode *mode = &efi_cout_modes[con->mode];
 401
 402         EFI_ENTRY("%p, %ld, %ld", this, column, row);
 403
 404         /* Check parameters */
 405         if (!this) {
 406                 ret = EFI_INVALID_PARAMETER;
 407                 goto out;
 408         }
 409         if (row >= mode->rows || column >= mode->columns) {
 410                 ret = EFI_UNSUPPORTED;
 411                 goto out;
 412         }
 413
 414         /*
 415          * Set cursor position by sending CSI H.
 416          * EFI origin is [0, 0], terminal origin is [1, 1].
 417          */
 418         printf(ESC "[%d;%dH", (int)row + 1, (int)column + 1);
 419         efi_con_mode.cursor_column = column;
 420         efi_con_mode.cursor_row = row;
 421 out:
 422         return EFI_EXIT(ret);
 423 }
 424
 425 static efi_status_t EFIAPI efi_cout_enable_cursor(
 426                         struct efi_simple_text_output_protocol *this,
 427                         bool enable)
 428 {
 429         EFI_ENTRY("%p, %d", this, enable);
 430
 431         printf(ESC"[?25%c", enable ? 'h' : 'l');
 432         efi_con_mode.cursor_visible = !!enable;
 433
 434         return EFI_EXIT(EFI_SUCCESS);
 435 }
 436
 437 struct efi_simple_text_output_protocol efi_con_out = {
 438         .reset = efi_cout_reset,
 439         .output_string = efi_cout_output_string,
 440         .test_string = efi_cout_test_string,
 441         .query_mode = efi_cout_query_mode,
 442         .set_mode = efi_cout_set_mode,
 443         .set_attribute = efi_cout_set_attribute,
 444         .clear_screen = efi_cout_clear_screen,
 445         .set_cursor_position = efi_cout_set_cursor_position,
 446         .enable_cursor = efi_cout_enable_cursor,
 447         .mode = (void*)&efi_con_mode,
 448 };
 449
 450 /**
 451  * struct efi_cin_notify_function - registered console input notify function
 452  *
 453  * @link:       link to list
 454  * @data:       key to notify
 455  * @function:   function to call
 456  */
 457 struct efi_cin_notify_function {
 458         struct list_head link;
 459         struct efi_key_data key;
 460         efi_status_t (EFIAPI *function)
 461                 (struct efi_key_data *key_data);
 462 };
 463
 464 static bool key_available;
 465 static struct efi_key_data next_key;
 466 static LIST_HEAD(cin_notify_functions);
 467
 468 /**
 469  * set_shift_mask() - set shift mask
 470  *
 471  * @mod:        Xterm shift mask
 472  */
 473 void set_shift_mask(int mod, struct efi_key_state *key_state)
 474 {
 475         key_state->key_shift_state = EFI_SHIFT_STATE_VALID;
 476         if (mod) {
 477                 --mod;
 478                 if (mod & 1)
 479                         key_state->key_shift_state |= EFI_LEFT_SHIFT_PRESSED;
 480                 if (mod & 2)
 481                         key_state->key_shift_state |= EFI_LEFT_ALT_PRESSED;
 482                 if (mod & 4)
 483                         key_state->key_shift_state |= EFI_LEFT_CONTROL_PRESSED;
 484                 if (!mod || (mod & 8))
 485                         key_state->key_shift_state |= EFI_LEFT_LOGO_PRESSED;
 486         }
 487 }
 488
 489 /**
 490  * analyze_modifiers() - analyze modifiers (shift, alt, ctrl) for function keys
 491  *
 492  * This gets called when we have already parsed CSI.
 493  *
 494  * @modifiers:  bit mask (shift, alt, ctrl)
 495  * @return:     the unmodified code
 496  */
 497 static int analyze_modifiers(struct efi_key_state *key_state)
 498 {
 499         int c, mod = 0, ret = 0;
 500
 501         c = getc();
 502
 503         if (c != ';') {
 504                 ret = c;
 505                 if (c == '~')
 506                         goto out;
 507                 c = getc();
 508         }
 509         for (;;) {
 510                 switch (c) {
 511                 case '0'...'9':
 512                         mod *= 10;
 513                         mod += c - '0';
 514                 /* fall through */
 515                 case ';':
 516                         c = getc();
 517                         break;
 518                 default:
 519                         goto out;
 520                 }
 521         }
 522 out:
 523         set_shift_mask(mod, key_state);
 524         if (!ret)
 525                 ret = c;
 526         return ret;
 527 }
 528
 529 /**
 530  * efi_cin_read_key() - read a key from the console input
 531  *
 532  * @key:        - key received
 533  * Return:      - status code
 534  */
 535 static efi_status_t efi_cin_read_key(struct efi_key_data *key)
 536 {
 537         struct efi_input_key pressed_key = {
 538                 .scan_code = 0,
 539                 .unicode_char = 0,
 540         };
 541         s32 ch;
 542
 543         if (console_read_unicode(&ch))
 544                 return EFI_NOT_READY;
 545
 546         key->key_state.key_shift_state = EFI_SHIFT_STATE_INVALID;
 547         key->key_state.key_toggle_state = EFI_TOGGLE_STATE_INVALID;
 548
 549         /* We do not support multi-word codes */
 550         if (ch >= 0x10000)
 551                 ch = '?';
 552
 553         switch (ch) {
 554         case 0x1b:
 555                 /*
 556                  * Xterm Control Sequences
 557                  * https://www.xfree86.org/4.8.0/ctlseqs.html
 558                  */
 559                 ch = getc();
 560                 switch (ch) {
 561                 case cESC: /* ESC */
 562                         pressed_key.scan_code = 23;
 563                         break;
 564                 case 'O': /* F1 - F4, End */
 565                         ch = getc();
 566                         /* consider modifiers */
 567                         if (ch == 'F') { /* End */
 568                                 pressed_key.scan_code = 6;
 569                                 break;
 570                         } else if (ch < 'P') {
 571                                 set_shift_mask(ch - '0', &key->key_state);
 572                                 ch = getc();
 573                         }
 574                         pressed_key.scan_code = ch - 'P' + 11;
 575                         break;
 576                 case '[':
 577                         ch = getc();
 578                         switch (ch) {
 579                         case 'A'...'D': /* up, down right, left */
 580                                 pressed_key.scan_code = ch - 'A' + 1;
 581                                 break;
 582                         case 'F': /* End */
 583                                 pressed_key.scan_code = 6;
 584                                 break;
 585                         case 'H': /* Home */
 586                                 pressed_key.scan_code = 5;
 587                                 break;
 588                         case '1':
 589                                 ch = analyze_modifiers(&key->key_state);
 590                                 switch (ch) {
 591                                 case '1'...'5': /* F1 - F5 */
 592                                         pressed_key.scan_code = ch - '1' + 11;
 593                                         break;
 594                                 case '6'...'9': /* F5 - F8 */
 595                                         pressed_key.scan_code = ch - '6' + 15;
 596                                         break;
 597                                 case 'A'...'D': /* up, down right, left */
 598                                         pressed_key.scan_code = ch - 'A' + 1;
 599                                         break;
 600                                 case 'F': /* End */
 601                                         pressed_key.scan_code = 6;
 602                                         break;
 603                                 case 'H': /* Home */
 604                                         pressed_key.scan_code = 5;
 605                                         break;
 606                                 case '~': /* Home */
 607                                         pressed_key.scan_code = 5;
 608                                         break;
 609                                 }
 610                                 break;
 611                         case '2':
 612                                 ch = analyze_modifiers(&key->key_state);
 613                                 switch (ch) {
 614                                 case '0'...'1': /* F9 - F10 */
 615                                         pressed_key.scan_code = ch - '0' + 19;
 616                                         break;
 617                                 case '3'...'4': /* F11 - F12 */
 618                                         pressed_key.scan_code = ch - '3' + 21;
 619                                         break;
 620                                 case '~': /* INS */
 621                                         pressed_key.scan_code = 7;
 622                                         break;
 623                                 }
 624                                 break;
 625                         case '3': /* DEL */
 626                                 pressed_key.scan_code = 8;
 627                                 analyze_modifiers(&key->key_state);
 628                                 break;
 629                         case '5': /* PG UP */
 630                                 pressed_key.scan_code = 9;
 631                                 analyze_modifiers(&key->key_state);
 632                                 break;
 633                         case '6': /* PG DOWN */
 634                                 pressed_key.scan_code = 10;
 635                                 analyze_modifiers(&key->key_state);
 636                                 break;
 637                         } /* [ */
 638                         break;
 639                 default:
 640                         /* ALT key */
 641                         set_shift_mask(3, &key->key_state);
 642                 }
 643                 break;
 644         case 0x7f:
 645                 /* Backspace */
 646                 ch = 0x08;
 647         }
 648         if (pressed_key.scan_code) {
 649                 key->key_state.key_shift_state |= EFI_SHIFT_STATE_VALID;
 650         } else {
 651                 pressed_key.unicode_char = ch;
 652
 653                 /*
 654                  * Assume left control key for control characters typically
 655                  * entered using the control key.
 656                  */
 657                 if (ch >= 0x01 && ch <= 0x1f) {
 658                         key->key_state.key_shift_state |=
 659                                         EFI_SHIFT_STATE_VALID;
 660                         switch (ch) {
 661                         case 0x01 ... 0x07:
 662                         case 0x0b ... 0x0c:
 663                         case 0x0e ... 0x1f:
 664                                 key->key_state.key_shift_state |=
 665                                                 EFI_LEFT_CONTROL_PRESSED;
 666                         }
 667                 }
 668         }
 669         key->key = pressed_key;
 670
 671         return EFI_SUCCESS;
 672 }
 673
 674 /**
 675  * efi_cin_notify() - notify registered functions
 676  */
 677 static void efi_cin_notify(void)
 678 {
 679         struct efi_cin_notify_function *item;
 680
 681         list_for_each_entry(item, &cin_notify_functions, link) {
 682                 bool match = true;
 683
 684                 /* We do not support toggle states */
 685                 if (item->key.key.unicode_char || item->key.key.scan_code) {
 686                         if (item->key.key.unicode_char !=
 687                             next_key.key.unicode_char ||
 688                             item->key.key.scan_code != next_key.key.scan_code)
 689                                 match = false;
 690                 }
 691                 if (item->key.key_state.key_shift_state &&
 692                     item->key.key_state.key_shift_state !=
 693                     next_key.key_state.key_shift_state)
 694                         match = false;
 695
 696                 if (match)
 697                         /* We don't bother about the return code */
 698                         EFI_CALL(item->function(&next_key));
 699         }
 700 }
 701
 702 /**
 703  * efi_cin_check() - check if keyboard input is available
 704  */
 705 static void efi_cin_check(void)
 706 {
 707         efi_status_t ret;
 708
 709         if (key_available) {
 710                 efi_signal_event(efi_con_in.wait_for_key);
 711                 return;
 712         }
 713
 714         if (tstc()) {
 715                 ret = efi_cin_read_key(&next_key);
 716                 if (ret == EFI_SUCCESS) {
 717                         key_available = true;
 718
 719                         /* Notify registered functions */
 720                         efi_cin_notify();
 721
 722                         /* Queue the wait for key event */
 723                         if (key_available)
 724                                 efi_signal_event(efi_con_in.wait_for_key);
 725                 }
 726         }
 727 }
 728
 729 /**
 730  * efi_cin_empty_buffer() - empty input buffer
 731  */
 732 static void efi_cin_empty_buffer(void)
 733 {
 734         while (tstc())
 735                 getc();
 736         key_available = false;
 737 }
 738
 739 /**
 740  * efi_cin_reset_ex() - reset console input
 741  *
 742  * @this:                       - the extended simple text input protocol
 743  * @extended_verification:      - extended verification
 744  *
 745  * This function implements the reset service of the
 746  * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
 747  *
 748  * See the Unified Extensible Firmware Interface (UEFI) specification for
 749  * details.
 750  *
 751  * Return: old value of the task priority level
 752  */
 753 static efi_status_t EFIAPI efi_cin_reset_ex(
 754                 struct efi_simple_text_input_ex_protocol *this,
 755                 bool extended_verification)
 756 {
 757         efi_status_t ret = EFI_SUCCESS;
 758
 759         EFI_ENTRY("%p, %d", this, extended_verification);
 760
 761         /* Check parameters */
 762         if (!this) {
 763                 ret = EFI_INVALID_PARAMETER;
 764                 goto out;
 765         }
 766
 767         efi_cin_empty_buffer();
 768 out:
 769         return EFI_EXIT(ret);
 770 }
 771
 772 /**
 773  * efi_cin_read_key_stroke_ex() - read key stroke
 774  *
 775  * @this:       instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
 776  * @key_data:   key read from console
 777  * Return:      status code
 778  *
 779  * This function implements the ReadKeyStrokeEx service of the
 780  * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
 781  *
 782  * See the Unified Extensible Firmware Interface (UEFI) specification for
 783  * details.
 784  */
 785 static efi_status_t EFIAPI efi_cin_read_key_stroke_ex(
 786                 struct efi_simple_text_input_ex_protocol *this,
 787                 struct efi_key_data *key_data)
 788 {
 789         efi_status_t ret = EFI_SUCCESS;
 790
 791         EFI_ENTRY("%p, %p", this, key_data);
 792
 793         /* Check parameters */
 794         if (!this || !key_data) {
 795                 ret = EFI_INVALID_PARAMETER;
 796                 goto out;
 797         }
 798
 799         /* We don't do interrupts, so check for timers cooperatively */
 800         efi_timer_check();
 801
 802         /* Enable console input after ExitBootServices */
 803         efi_cin_check();
 804
 805         if (!key_available) {
 806                 ret = EFI_NOT_READY;
 807                 goto out;
 808         }
 809         /*
 810          * CTRL+A - CTRL+Z have to be signaled as a - z.
 811          * SHIFT+CTRL+A - SHIFT+CTRL+Z have to be signaled as A - Z.
 812          */
 813         switch (next_key.key.unicode_char) {
 814         case 0x01 ... 0x07:
 815         case 0x0b ... 0x0c:
 816         case 0x0e ... 0x1a:
 817                 if (!(next_key.key_state.key_toggle_state &
 818                       EFI_CAPS_LOCK_ACTIVE) ^
 819                     !(next_key.key_state.key_shift_state &
 820                       (EFI_LEFT_SHIFT_PRESSED | EFI_RIGHT_SHIFT_PRESSED)))
 821                         next_key.key.unicode_char += 0x40;
 822                 else
 823                         next_key.key.unicode_char += 0x60;
 824         }
 825         *key_data = next_key;
 826         key_available = false;
 827         efi_con_in.wait_for_key->is_signaled = false;
 828
 829 out:
 830         return EFI_EXIT(ret);
 831 }
 832
 833 /**
 834  * efi_cin_set_state() - set toggle key state
 835  *
 836  * @this:               instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
 837  * @key_toggle_state:   pointer to key toggle state
 838  * Return:              status code
 839  *
 840  * This function implements the SetState service of the
 841  * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
 842  *
 843  * See the Unified Extensible Firmware Interface (UEFI) specification for
 844  * details.
 845  */
 846 static efi_status_t EFIAPI efi_cin_set_state(
 847                 struct efi_simple_text_input_ex_protocol *this,
 848                 u8 *key_toggle_state)
 849 {
 850         EFI_ENTRY("%p, %p", this, key_toggle_state);
 851         /*
 852          * U-Boot supports multiple console input sources like serial and
 853          * net console for which a key toggle state cannot be set at all.
 854          *
 855          * According to the UEFI specification it is allowable to not implement
 856          * this service.
 857          */
 858         return EFI_EXIT(EFI_UNSUPPORTED);
 859 }
 860
 861 /**
 862  * efi_cin_register_key_notify() - register key notification function
 863  *
 864  * @this:                       instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
 865  * @key_data:                   key to be notified
 866  * @key_notify_function:        function to be called if the key is pressed
 867  * @notify_handle:              handle for unregistering the notification
 868  * Return:                      status code
 869  *
 870  * This function implements the SetState service of the
 871  * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
 872  *
 873  * See the Unified Extensible Firmware Interface (UEFI) specification for
 874  * details.
 875  */
 876 static efi_status_t EFIAPI efi_cin_register_key_notify(
 877                 struct efi_simple_text_input_ex_protocol *this,
 878                 struct efi_key_data *key_data,
 879                 efi_status_t (EFIAPI *key_notify_function)(
 880                         struct efi_key_data *key_data),
 881                 void **notify_handle)
 882 {
 883         efi_status_t ret = EFI_SUCCESS;
 884         struct efi_cin_notify_function *notify_function;
 885
 886         EFI_ENTRY("%p, %p, %p, %p",
 887                   this, key_data, key_notify_function, notify_handle);
 888
 889         /* Check parameters */
 890         if (!this || !key_data || !key_notify_function || !notify_handle) {
 891                 ret = EFI_INVALID_PARAMETER;
 892                 goto out;
 893         }
 894
 895         EFI_PRINT("u+%04x, sc %04x, sh %08x, tg %02x\n",
 896                   key_data->key.unicode_char,
 897                key_data->key.scan_code,
 898                key_data->key_state.key_shift_state,
 899                key_data->key_state.key_toggle_state);
 900
 901         notify_function = calloc(1, sizeof(struct efi_cin_notify_function));
 902         if (!notify_function) {
 903                 ret = EFI_OUT_OF_RESOURCES;
 904                 goto out;
 905         }
 906         notify_function->key = *key_data;
 907         notify_function->function = key_notify_function;
 908         list_add_tail(&notify_function->link, &cin_notify_functions);
 909         *notify_handle = notify_function;
 910 out:
 911         return EFI_EXIT(ret);
 912 }
 913
 914 /**
 915  * efi_cin_unregister_key_notify() - unregister key notification function
 916  *
 917  * @this:                       instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
 918  * @notification_handle:        handle received when registering
 919  * Return:                      status code
 920  *
 921  * This function implements the SetState service of the
 922  * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
 923  *
 924  * See the Unified Extensible Firmware Interface (UEFI) specification for
 925  * details.
 926  */
 927 static efi_status_t EFIAPI efi_cin_unregister_key_notify(
 928                 struct efi_simple_text_input_ex_protocol *this,
 929                 void *notification_handle)
 930 {
 931         efi_status_t ret = EFI_INVALID_PARAMETER;
 932         struct efi_cin_notify_function *item, *notify_function =
 933                         notification_handle;
 934
 935         EFI_ENTRY("%p, %p", this, notification_handle);
 936
 937         /* Check parameters */
 938         if (!this || !notification_handle)
 939                 goto out;
 940
 941         list_for_each_entry(item, &cin_notify_functions, link) {
 942                 if (item == notify_function) {
 943                         ret = EFI_SUCCESS;
 944                         break;
 945                 }
 946         }
 947         if (ret != EFI_SUCCESS)
 948                 goto out;
 949
 950         /* Remove the notify function */
 951         list_del(&notify_function->link);
 952         free(notify_function);
 953 out:
 954         return EFI_EXIT(ret);
 955 }
 956
 957
 958 /**
 959  * efi_cin_reset() - drain the input buffer
 960  *
 961  * @this:                       instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
 962  * @extended_verification:      allow for exhaustive verification
 963  * Return:                      status code
 964  *
 965  * This function implements the Reset service of the
 966  * EFI_SIMPLE_TEXT_INPUT_PROTOCOL.
 967  *
 968  * See the Unified Extensible Firmware Interface (UEFI) specification for
 969  * details.
 970  */
 971 static efi_status_t EFIAPI efi_cin_reset
 972                         (struct efi_simple_text_input_protocol *this,
 973                          bool extended_verification)
 974 {
 975         efi_status_t ret = EFI_SUCCESS;
 976
 977         EFI_ENTRY("%p, %d", this, extended_verification);
 978
 979         /* Check parameters */
 980         if (!this) {
 981                 ret = EFI_INVALID_PARAMETER;
 982                 goto out;
 983         }
 984
 985         efi_cin_empty_buffer();
 986 out:
 987         return EFI_EXIT(ret);
 988 }
 989
 990 /**
 991  * efi_cin_read_key_stroke() - read key stroke
 992  *
 993  * @this:       instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
 994  * @key:        key read from console
 995  * Return:      status code
 996  *
 997  * This function implements the ReadKeyStroke service of the
 998  * EFI_SIMPLE_TEXT_INPUT_PROTOCOL.
 999  *
1000  * See the Unified Extensible Firmware Interface (UEFI) specification for
1001  * details.
1002  */
1003 static efi_status_t EFIAPI efi_cin_read_key_stroke
1004                         (struct efi_simple_text_input_protocol *this,
1005                          struct efi_input_key *key)
1006 {
1007         efi_status_t ret = EFI_SUCCESS;
1008
1009         EFI_ENTRY("%p, %p", this, key);
1010
1011         /* Check parameters */
1012         if (!this || !key) {
1013                 ret = EFI_INVALID_PARAMETER;
1014                 goto out;
1015         }
1016
1017         /* We don't do interrupts, so check for timers cooperatively */
1018         efi_timer_check();
1019
1020         /* Enable console input after ExitBootServices */
1021         efi_cin_check();
1022
1023         if (!key_available) {
1024                 ret = EFI_NOT_READY;
1025                 goto out;
1026         }
1027         *key = next_key.key;
1028         key_available = false;
1029         efi_con_in.wait_for_key->is_signaled = false;
1030 out:
1031         return EFI_EXIT(ret);
1032 }
1033
1034 static struct efi_simple_text_input_ex_protocol efi_con_in_ex = {
1035         .reset = efi_cin_reset_ex,
1036         .read_key_stroke_ex = efi_cin_read_key_stroke_ex,
1037         .wait_for_key_ex = NULL,
1038         .set_state = efi_cin_set_state,
1039         .register_key_notify = efi_cin_register_key_notify,
1040         .unregister_key_notify = efi_cin_unregister_key_notify,
1041 };
1042
1043 struct efi_simple_text_input_protocol efi_con_in = {
1044         .reset = efi_cin_reset,
1045         .read_key_stroke = efi_cin_read_key_stroke,
1046         .wait_for_key = NULL,
1047 };
1048
1049 static struct efi_event *console_timer_event;
1050
1051 /*
1052  * efi_console_timer_notify() - notify the console timer event
1053  *
1054  * @event:      console timer event
1055  * @context:    not used
1056  */
1057 static void EFIAPI efi_console_timer_notify(struct efi_event *event,
1058                                             void *context)
1059 {
1060         EFI_ENTRY("%p, %p", event, context);
1061         efi_cin_check();
1062         EFI_EXIT(EFI_SUCCESS);
1063 }
1064
1065 /**
1066  * efi_key_notify() - notify the wait for key event
1067  *
1068  * @event:      wait for key event
1069  * @context:    not used
1070  */
1071 static void EFIAPI efi_key_notify(struct efi_event *event, void *context)
1072 {
1073         EFI_ENTRY("%p, %p", event, context);
1074         efi_cin_check();
1075         EFI_EXIT(EFI_SUCCESS);
1076 }
1077
1078 /**
1079  * efi_console_register() - install the console protocols
1080  *
1081  * This function is called from do_bootefi_exec().
1082  *
1083  * Return:      status code
1084  */
1085 efi_status_t efi_console_register(void)
1086 {
1087         efi_status_t r;
1088         efi_handle_t console_output_handle;
1089         efi_handle_t console_input_handle;
1090
1091         /* Set up mode information */
1092         query_console_size();
1093
1094         /* Create handles */
1095         r = efi_create_handle(&console_output_handle);
1096         if (r != EFI_SUCCESS)
1097                 goto out_of_memory;
1098
1099         r = efi_add_protocol(console_output_handle,
1100                              &efi_guid_text_output_protocol, &efi_con_out);
1101         if (r != EFI_SUCCESS)
1102                 goto out_of_memory;
1103         systab.con_out_handle = console_output_handle;
1104         systab.stderr_handle = console_output_handle;
1105
1106         r = efi_create_handle(&console_input_handle);
1107         if (r != EFI_SUCCESS)
1108                 goto out_of_memory;
1109
1110         r = efi_add_protocol(console_input_handle,
1111                              &efi_guid_text_input_protocol, &efi_con_in);
1112         if (r != EFI_SUCCESS)
1113                 goto out_of_memory;
1114         systab.con_in_handle = console_input_handle;
1115         r = efi_add_protocol(console_input_handle,
1116                              &efi_guid_text_input_ex_protocol, &efi_con_in_ex);
1117         if (r != EFI_SUCCESS)
1118                 goto out_of_memory;
1119
1120         /* Create console events */
1121         r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK, efi_key_notify,
1122                              NULL, NULL, &efi_con_in.wait_for_key);
1123         if (r != EFI_SUCCESS) {
1124                 printf("ERROR: Failed to register WaitForKey event\n");
1125                 return r;
1126         }
1127         efi_con_in_ex.wait_for_key_ex = efi_con_in.wait_for_key;
1128         r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK,
1129                              efi_console_timer_notify, NULL, NULL,
1130                              &console_timer_event);
1131         if (r != EFI_SUCCESS) {
1132                 printf("ERROR: Failed to register console event\n");
1133                 return r;
1134         }
1135         /* 5000 ns cycle is sufficient for 2 MBaud */
1136         r = efi_set_timer(console_timer_event, EFI_TIMER_PERIODIC, 50);
1137         if (r != EFI_SUCCESS)
1138                 printf("ERROR: Failed to set console timer\n");
1139         return r;
1140 out_of_memory:
1141         printf("ERROR: Out of memory\n");
1142         return r;
1143 }