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_output_protocol =
  46                         EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID;
  47 const efi_guid_t efi_guid_text_input_protocol =
  48                         EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID;
  49
  50 #define cESC '\x1b'
  51 #define ESC "\x1b"
  52
  53 /* Default to mode 0 */
  54 static struct simple_text_output_mode efi_con_mode = {
  55         .max_mode = 1,
  56         .mode = 0,
  57         .attribute = 0,
  58         .cursor_column = 0,
  59         .cursor_row = 0,
  60         .cursor_visible = 1,
  61 };
  62
  63 /*
  64  * Receive and parse a reply from the terminal.
  65  *
  66  * @n:          array of return values
  67  * @num:        number of return values expected
  68  * @end_char:   character indicating end of terminal message
  69  * @return:     non-zero indicates error
  70  */
  71 static int term_read_reply(int *n, int num, char end_char)
  72 {
  73         char c;
  74         int i = 0;
  75
  76         c = getc();
  77         if (c != cESC)
  78                 return -1;
  79         c = getc();
  80         if (c != '[')
  81                 return -1;
  82
  83         n[0] = 0;
  84         while (1) {
  85                 c = getc();
  86                 if (c == ';') {
  87                         i++;
  88                         if (i >= num)
  89                                 return -1;
  90                         n[i] = 0;
  91                         continue;
  92                 } else if (c == end_char) {
  93                         break;
  94                 } else if (c > '9' || c < '0') {
  95                         return -1;
  96                 }
  97
  98                 /* Read one more decimal position */
  99                 n[i] *= 10;
 100                 n[i] += c - '0';
 101         }
 102         if (i != num - 1)
 103                 return -1;
 104
 105         return 0;
 106 }
 107
 108 static efi_status_t EFIAPI efi_cout_reset(
 109                         struct efi_simple_text_output_protocol *this,
 110                         char extended_verification)
 111 {
 112         EFI_ENTRY("%p, %d", this, extended_verification);
 113         return EFI_EXIT(EFI_UNSUPPORTED);
 114 }
 115
 116 static efi_status_t EFIAPI efi_cout_output_string(
 117                         struct efi_simple_text_output_protocol *this,
 118                         const efi_string_t string)
 119 {
 120         struct simple_text_output_mode *con = &efi_con_mode;
 121         struct cout_mode *mode = &efi_cout_modes[con->mode];
 122
 123         EFI_ENTRY("%p, %p", this, string);
 124
 125         unsigned int n16 = utf16_strlen(string);
 126         char buf[MAX_UTF8_PER_UTF16 * n16 + 1];
 127         u16 *p;
 128
 129         *utf16_to_utf8((u8 *)buf, string, n16) = '\0';
 130
 131         fputs(stdout, buf);
 132
 133         /*
 134          * Update the cursor position.
 135          *
 136          * The UEFI spec provides advance rules for U+0000, U+0008, U+000A,
 137          * and U000D. All other characters, including control characters
 138          * U+0007 (bel) and U+0009 (tab), have to increase the column by one.
 139          */
 140         for (p = string; *p; ++p) {
 141                 switch (*p) {
 142                 case '\b':      /* U+0008, backspace */
 143                         con->cursor_column = max(0, con->cursor_column - 1);
 144                         break;
 145                 case '\n':      /* U+000A, newline */
 146                         con->cursor_column = 0;
 147                         con->cursor_row++;
 148                         break;
 149                 case '\r':      /* U+000D, carriage-return */
 150                         con->cursor_column = 0;
 151                         break;
 152                 case 0xd800 ... 0xdbff:
 153                         /*
 154                          * Ignore high surrogates, we do not want to count a
 155                          * Unicode character twice.
 156                          */
 157                         break;
 158                 default:
 159                         con->cursor_column++;
 160                         break;
 161                 }
 162                 if (con->cursor_column >= mode->columns) {
 163                         con->cursor_column = 0;
 164                         con->cursor_row++;
 165                 }
 166                 con->cursor_row = min(con->cursor_row, (s32)mode->rows - 1);
 167         }
 168
 169         return EFI_EXIT(EFI_SUCCESS);
 170 }
 171
 172 static efi_status_t EFIAPI efi_cout_test_string(
 173                         struct efi_simple_text_output_protocol *this,
 174                         const efi_string_t string)
 175 {
 176         EFI_ENTRY("%p, %p", this, string);
 177         return EFI_EXIT(EFI_SUCCESS);
 178 }
 179
 180 static bool cout_mode_matches(struct cout_mode *mode, int rows, int cols)
 181 {
 182         if (!mode->present)
 183                 return false;
 184
 185         return (mode->rows == rows) && (mode->columns == cols);
 186 }
 187
 188 static int query_console_serial(int *rows, int *cols)
 189 {
 190         /* Ask the terminal about its size */
 191         int n[3];
 192         u64 timeout;
 193
 194         /* Empty input buffer */
 195         while (tstc())
 196                 getc();
 197
 198         printf(ESC"[18t");
 199
 200         /* Check if we have a terminal that understands */
 201         timeout = timer_get_us() + 1000000;
 202         while (!tstc())
 203                 if (timer_get_us() > timeout)
 204                         return -1;
 205
 206         /* Read {depth,rows,cols} */
 207         if (term_read_reply(n, 3, 't'))
 208                 return -1;
 209
 210         *cols = n[2];
 211         *rows = n[1];
 212
 213         return 0;
 214 }
 215
 216 /*
 217  * Update the mode table.
 218  *
 219  * By default the only mode available is 80x25. If the console has at least 50
 220  * lines, enable mode 80x50. If we can query the console size and it is neither
 221  * 80x25 nor 80x50, set it as an additional mode.
 222  */
 223 static void query_console_size(void)
 224 {
 225         const char *stdout_name = env_get("stdout");
 226         int rows, cols;
 227
 228         if (stdout_name && !strcmp(stdout_name, "vidconsole") &&
 229             IS_ENABLED(CONFIG_DM_VIDEO)) {
 230                 struct stdio_dev *stdout_dev =
 231                         stdio_get_by_name("vidconsole");
 232                 struct udevice *dev = stdout_dev->priv;
 233                 struct vidconsole_priv *priv =
 234                         dev_get_uclass_priv(dev);
 235                 rows = priv->rows;
 236                 cols = priv->cols;
 237         } else if (query_console_serial(&rows, &cols)) {
 238                 return;
 239         }
 240
 241         /* Test if we can have Mode 1 */
 242         if (cols >= 80 && rows >= 50) {
 243                 efi_cout_modes[1].present = 1;
 244                 efi_con_mode.max_mode = 2;
 245         }
 246
 247         /*
 248          * Install our mode as mode 2 if it is different
 249          * than mode 0 or 1 and set it as the currently selected mode
 250          */
 251         if (!cout_mode_matches(&efi_cout_modes[0], rows, cols) &&
 252             !cout_mode_matches(&efi_cout_modes[1], rows, cols)) {
 253                 efi_cout_modes[EFI_COUT_MODE_2].columns = cols;
 254                 efi_cout_modes[EFI_COUT_MODE_2].rows = rows;
 255                 efi_cout_modes[EFI_COUT_MODE_2].present = 1;
 256                 efi_con_mode.max_mode = EFI_MAX_COUT_MODE;
 257                 efi_con_mode.mode = EFI_COUT_MODE_2;
 258         }
 259 }
 260
 261 static efi_status_t EFIAPI efi_cout_query_mode(
 262                         struct efi_simple_text_output_protocol *this,
 263                         unsigned long mode_number, unsigned long *columns,
 264                         unsigned long *rows)
 265 {
 266         EFI_ENTRY("%p, %ld, %p, %p", this, mode_number, columns, rows);
 267
 268         if (mode_number >= efi_con_mode.max_mode)
 269                 return EFI_EXIT(EFI_UNSUPPORTED);
 270
 271         if (efi_cout_modes[mode_number].present != 1)
 272                 return EFI_EXIT(EFI_UNSUPPORTED);
 273
 274         if (columns)
 275                 *columns = efi_cout_modes[mode_number].columns;
 276         if (rows)
 277                 *rows = efi_cout_modes[mode_number].rows;
 278
 279         return EFI_EXIT(EFI_SUCCESS);
 280 }
 281
 282 static efi_status_t EFIAPI efi_cout_set_mode(
 283                         struct efi_simple_text_output_protocol *this,
 284                         unsigned long mode_number)
 285 {
 286         EFI_ENTRY("%p, %ld", this, mode_number);
 287
 288
 289         if (mode_number > efi_con_mode.max_mode)
 290                 return EFI_EXIT(EFI_UNSUPPORTED);
 291
 292         efi_con_mode.mode = mode_number;
 293         efi_con_mode.cursor_column = 0;
 294         efi_con_mode.cursor_row = 0;
 295
 296         return EFI_EXIT(EFI_SUCCESS);
 297 }
 298
 299 static const struct {
 300         unsigned int fg;
 301         unsigned int bg;
 302 } color[] = {
 303         { 30, 40 },     /* 0: black */
 304         { 34, 44 },     /* 1: blue */
 305         { 32, 42 },     /* 2: green */
 306         { 36, 46 },     /* 3: cyan */
 307         { 31, 41 },     /* 4: red */
 308         { 35, 45 },     /* 5: magenta */
 309         { 33, 43 },     /* 6: brown, map to yellow as edk2 does*/
 310         { 37, 47 },     /* 7: light grey, map to white */
 311 };
 312
 313 /* See EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute(). */
 314 static efi_status_t EFIAPI efi_cout_set_attribute(
 315                         struct efi_simple_text_output_protocol *this,
 316                         unsigned long attribute)
 317 {
 318         unsigned int bold = EFI_ATTR_BOLD(attribute);
 319         unsigned int fg = EFI_ATTR_FG(attribute);
 320         unsigned int bg = EFI_ATTR_BG(attribute);
 321
 322         EFI_ENTRY("%p, %lx", this, attribute);
 323
 324         if (attribute)
 325                 printf(ESC"[%u;%u;%um", bold, color[fg].fg, color[bg].bg);
 326         else
 327                 printf(ESC"[0;37;40m");
 328
 329         return EFI_EXIT(EFI_SUCCESS);
 330 }
 331
 332 static efi_status_t EFIAPI efi_cout_clear_screen(
 333                         struct efi_simple_text_output_protocol *this)
 334 {
 335         EFI_ENTRY("%p", this);
 336
 337         printf(ESC"[2J");
 338
 339         return EFI_EXIT(EFI_SUCCESS);
 340 }
 341
 342 static efi_status_t EFIAPI efi_cout_set_cursor_position(
 343                         struct efi_simple_text_output_protocol *this,
 344                         unsigned long column, unsigned long row)
 345 {
 346         EFI_ENTRY("%p, %ld, %ld", this, column, row);
 347
 348         printf(ESC"[%d;%df", (int)row, (int)column);
 349         efi_con_mode.cursor_column = column;
 350         efi_con_mode.cursor_row = row;
 351
 352         return EFI_EXIT(EFI_SUCCESS);
 353 }
 354
 355 static efi_status_t EFIAPI efi_cout_enable_cursor(
 356                         struct efi_simple_text_output_protocol *this,
 357                         bool enable)
 358 {
 359         EFI_ENTRY("%p, %d", this, enable);
 360
 361         printf(ESC"[?25%c", enable ? 'h' : 'l');
 362
 363         return EFI_EXIT(EFI_SUCCESS);
 364 }
 365
 366 struct efi_simple_text_output_protocol efi_con_out = {
 367         .reset = efi_cout_reset,
 368         .output_string = efi_cout_output_string,
 369         .test_string = efi_cout_test_string,
 370         .query_mode = efi_cout_query_mode,
 371         .set_mode = efi_cout_set_mode,
 372         .set_attribute = efi_cout_set_attribute,
 373         .clear_screen = efi_cout_clear_screen,
 374         .set_cursor_position = efi_cout_set_cursor_position,
 375         .enable_cursor = efi_cout_enable_cursor,
 376         .mode = (void*)&efi_con_mode,
 377 };
 378
 379 static efi_status_t EFIAPI efi_cin_reset(
 380                         struct efi_simple_input_interface *this,
 381                         bool extended_verification)
 382 {
 383         EFI_ENTRY("%p, %d", this, extended_verification);
 384         return EFI_EXIT(EFI_UNSUPPORTED);
 385 }
 386
 387 /*
 388  * Analyze modifiers (shift, alt, ctrl) for function keys.
 389  * This gets called when we have already parsed CSI.
 390  *
 391  * @modifiers:  bitmask (shift, alt, ctrl)
 392  * @return:     the unmodified code
 393  */
 394 static char skip_modifiers(int *modifiers)
 395 {
 396         char c, mod = 0, ret = 0;
 397
 398         c = getc();
 399
 400         if (c != ';') {
 401                 ret = c;
 402                 if (c == '~')
 403                         goto out;
 404                 c = getc();
 405         }
 406         for (;;) {
 407                 switch (c) {
 408                 case '0'...'9':
 409                         mod *= 10;
 410                         mod += c - '0';
 411                 /* fall through */
 412                 case ';':
 413                         c = getc();
 414                         break;
 415                 default:
 416                         goto out;
 417                 }
 418         }
 419 out:
 420         if (mod)
 421                 --mod;
 422         if (modifiers)
 423                 *modifiers = mod;
 424         if (!ret)
 425                 ret = c;
 426         return ret;
 427 }
 428
 429 static efi_status_t EFIAPI efi_cin_read_key_stroke(
 430                         struct efi_simple_input_interface *this,
 431                         struct efi_input_key *key)
 432 {
 433         struct efi_input_key pressed_key = {
 434                 .scan_code = 0,
 435                 .unicode_char = 0,
 436         };
 437         char ch;
 438
 439         EFI_ENTRY("%p, %p", this, key);
 440
 441         /* We don't do interrupts, so check for timers cooperatively */
 442         efi_timer_check();
 443
 444         if (!tstc()) {
 445                 /* No key pressed */
 446                 return EFI_EXIT(EFI_NOT_READY);
 447         }
 448
 449         ch = getc();
 450         if (ch == cESC) {
 451                 /*
 452                  * Xterm Control Sequences
 453                  * https://www.xfree86.org/4.8.0/ctlseqs.html
 454                  */
 455                 ch = getc();
 456                 switch (ch) {
 457                 case cESC: /* ESC */
 458                         pressed_key.scan_code = 23;
 459                         break;
 460                 case 'O': /* F1 - F4 */
 461                         ch = getc();
 462                         /* skip modifiers */
 463                         if (ch <= '9')
 464                                 ch = getc();
 465                         pressed_key.scan_code = ch - 'P' + 11;
 466                         break;
 467                 case 'a'...'z':
 468                         ch = ch - 'a';
 469                         break;
 470                 case '[':
 471                         ch = getc();
 472                         switch (ch) {
 473                         case 'A'...'D': /* up, down right, left */
 474                                 pressed_key.scan_code = ch - 'A' + 1;
 475                                 break;
 476                         case 'F': /* End */
 477                                 pressed_key.scan_code = 6;
 478                                 break;
 479                         case 'H': /* Home */
 480                                 pressed_key.scan_code = 5;
 481                                 break;
 482                         case '1':
 483                                 ch = skip_modifiers(NULL);
 484                                 switch (ch) {
 485                                 case '1'...'5': /* F1 - F5 */
 486                                         pressed_key.scan_code = ch - '1' + 11;
 487                                         break;
 488                                 case '7'...'9': /* F6 - F8 */
 489                                         pressed_key.scan_code = ch - '7' + 16;
 490                                         break;
 491                                 case 'A'...'D': /* up, down right, left */
 492                                         pressed_key.scan_code = ch - 'A' + 1;
 493                                         break;
 494                                 case 'F':
 495                                         pressed_key.scan_code = 6; /* End */
 496                                         break;
 497                                 case 'H':
 498                                         pressed_key.scan_code = 5; /* Home */
 499                                         break;
 500                                 }
 501                                 break;
 502                         case '2':
 503                                 ch = skip_modifiers(NULL);
 504                                 switch (ch) {
 505                                 case '0'...'1': /* F9 - F10 */
 506                                         pressed_key.scan_code = ch - '0' + 19;
 507                                         break;
 508                                 case '3'...'4': /* F11 - F12 */
 509                                         pressed_key.scan_code = ch - '3' + 21;
 510                                         break;
 511                                 case '~': /* INS */
 512                                         pressed_key.scan_code = 7;
 513                                         break;
 514                                 }
 515                                 break;
 516                         case '3': /* DEL */
 517                                 pressed_key.scan_code = 8;
 518                                 skip_modifiers(NULL);
 519                                 break;
 520                         case '5': /* PG UP */
 521                                 pressed_key.scan_code = 9;
 522                                 skip_modifiers(NULL);
 523                                 break;
 524                         case '6': /* PG DOWN */
 525                                 pressed_key.scan_code = 10;
 526                                 skip_modifiers(NULL);
 527                                 break;
 528                         }
 529                         break;
 530                 }
 531         } else if (ch == 0x7f) {
 532                 /* Backspace */
 533                 ch = 0x08;
 534         }
 535         if (!pressed_key.scan_code)
 536                 pressed_key.unicode_char = ch;
 537         *key = pressed_key;
 538
 539         return EFI_EXIT(EFI_SUCCESS);
 540 }
 541
 542 struct efi_simple_input_interface efi_con_in = {
 543         .reset = efi_cin_reset,
 544         .read_key_stroke = efi_cin_read_key_stroke,
 545         .wait_for_key = NULL,
 546 };
 547
 548 static struct efi_event *console_timer_event;
 549
 550 static void EFIAPI efi_key_notify(struct efi_event *event, void *context)
 551 {
 552 }
 553
 554 /*
 555  * Notification function of the console timer event.
 556  *
 557  * event:       console timer event
 558  * context:     not used
 559  */
 560 static void EFIAPI efi_console_timer_notify(struct efi_event *event,
 561                                             void *context)
 562 {
 563         EFI_ENTRY("%p, %p", event, context);
 564
 565         /* Check if input is available */
 566         if (tstc()) {
 567                 /* Queue the wait for key event */
 568                 efi_con_in.wait_for_key->is_signaled = true;
 569                 efi_signal_event(efi_con_in.wait_for_key, true);
 570         }
 571         EFI_EXIT(EFI_SUCCESS);
 572 }
 573
 574 /* This gets called from do_bootefi_exec(). */
 575 int efi_console_register(void)
 576 {
 577         efi_status_t r;
 578         struct efi_object *efi_console_output_obj;
 579         struct efi_object *efi_console_input_obj;
 580
 581         /* Set up mode information */
 582         query_console_size();
 583
 584         /* Create handles */
 585         r = efi_create_handle((efi_handle_t *)&efi_console_output_obj);
 586         if (r != EFI_SUCCESS)
 587                 goto out_of_memory;
 588         r = efi_add_protocol(efi_console_output_obj->handle,
 589                              &efi_guid_text_output_protocol, &efi_con_out);
 590         if (r != EFI_SUCCESS)
 591                 goto out_of_memory;
 592         r = efi_create_handle((efi_handle_t *)&efi_console_input_obj);
 593         if (r != EFI_SUCCESS)
 594                 goto out_of_memory;
 595         r = efi_add_protocol(efi_console_input_obj->handle,
 596                              &efi_guid_text_input_protocol, &efi_con_in);
 597         if (r != EFI_SUCCESS)
 598                 goto out_of_memory;
 599
 600         /* Create console events */
 601         r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK, efi_key_notify,
 602                              NULL, NULL, &efi_con_in.wait_for_key);
 603         if (r != EFI_SUCCESS) {
 604                 printf("ERROR: Failed to register WaitForKey event\n");
 605                 return r;
 606         }
 607         r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK,
 608                              efi_console_timer_notify, NULL, NULL,
 609                              &console_timer_event);
 610         if (r != EFI_SUCCESS) {
 611                 printf("ERROR: Failed to register console event\n");
 612                 return r;
 613         }
 614         /* 5000 ns cycle is sufficient for 2 MBaud */
 615         r = efi_set_timer(console_timer_event, EFI_TIMER_PERIODIC, 50);
 616         if (r != EFI_SUCCESS)
 617                 printf("ERROR: Failed to set console timer\n");
 618         return r;
 619 out_of_memory:
 620         printf("ERROR: Out of meemory\n");
 621         return r;
 622 }