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