MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c

   1 /** @file
   2   Implementation for EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL protocol.
   3
   4 Copyright (c) 2006 - 2009, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "Terminal.h"
  16
  17 //
  18 // This list is used to define the valid extend chars.
  19 // It also provides a mapping from Unicode to PCANSI or
  20 // ASCII. The ASCII mapping we just made up.
  21 //
  22 //
  23 UNICODE_TO_CHAR  UnicodeToPcAnsiOrAscii[] = {
  24   { BOXDRAW_HORIZONTAL,                 0xc4, L'-' },
  25   { BOXDRAW_VERTICAL,                   0xb3, L'|' },
  26   { BOXDRAW_DOWN_RIGHT,                 0xda, L'/' },
  27   { BOXDRAW_DOWN_LEFT,                  0xbf, L'\\' },
  28   { BOXDRAW_UP_RIGHT,                   0xc0, L'\\' },
  29   { BOXDRAW_UP_LEFT,                    0xd9, L'/' },
  30   { BOXDRAW_VERTICAL_RIGHT,             0xc3, L'|' },
  31   { BOXDRAW_VERTICAL_LEFT,              0xb4, L'|' },
  32   { BOXDRAW_DOWN_HORIZONTAL,            0xc2, L'+' },
  33   { BOXDRAW_UP_HORIZONTAL,              0xc1, L'+' },
  34   { BOXDRAW_VERTICAL_HORIZONTAL,        0xc5, L'+' },
  35   { BOXDRAW_DOUBLE_HORIZONTAL,          0xcd, L'-' },
  36   { BOXDRAW_DOUBLE_VERTICAL,            0xba, L'|' },
  37   { BOXDRAW_DOWN_RIGHT_DOUBLE,          0xd5, L'/' },
  38   { BOXDRAW_DOWN_DOUBLE_RIGHT,          0xd6, L'/' },
  39   { BOXDRAW_DOUBLE_DOWN_RIGHT,          0xc9, L'/' },
  40   { BOXDRAW_DOWN_LEFT_DOUBLE,           0xb8, L'\\' },
  41   { BOXDRAW_DOWN_DOUBLE_LEFT,           0xb7, L'\\' },
  42   { BOXDRAW_DOUBLE_DOWN_LEFT,           0xbb, L'\\' },
  43   { BOXDRAW_UP_RIGHT_DOUBLE,            0xd4, L'\\' },
  44   { BOXDRAW_UP_DOUBLE_RIGHT,            0xd3, L'\\' },
  45   { BOXDRAW_DOUBLE_UP_RIGHT,            0xc8, L'\\' },
  46   { BOXDRAW_UP_LEFT_DOUBLE,             0xbe, L'/' },
  47   { BOXDRAW_UP_DOUBLE_LEFT,             0xbd, L'/' },
  48   { BOXDRAW_DOUBLE_UP_LEFT,             0xbc, L'/' },
  49   { BOXDRAW_VERTICAL_RIGHT_DOUBLE,      0xc6, L'|' },
  50   { BOXDRAW_VERTICAL_DOUBLE_RIGHT,      0xc7, L'|' },
  51   { BOXDRAW_DOUBLE_VERTICAL_RIGHT,      0xcc, L'|' },
  52   { BOXDRAW_VERTICAL_LEFT_DOUBLE,       0xb5, L'|' },
  53   { BOXDRAW_VERTICAL_DOUBLE_LEFT,       0xb6, L'|' },
  54   { BOXDRAW_DOUBLE_VERTICAL_LEFT,       0xb9, L'|' },
  55   { BOXDRAW_DOWN_HORIZONTAL_DOUBLE,     0xd1, L'+' },
  56   { BOXDRAW_DOWN_DOUBLE_HORIZONTAL,     0xd2, L'+' },
  57   { BOXDRAW_DOUBLE_DOWN_HORIZONTAL,     0xcb, L'+' },
  58   { BOXDRAW_UP_HORIZONTAL_DOUBLE,       0xcf, L'+' },
  59   { BOXDRAW_UP_DOUBLE_HORIZONTAL,       0xd0, L'+' },
  60   { BOXDRAW_DOUBLE_UP_HORIZONTAL,       0xca, L'+' },
  61   { BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE, 0xd8, L'+' },
  62   { BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL, 0xd7, L'+' },
  63   { BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL, 0xce, L'+' },
  64
  65   { BLOCKELEMENT_FULL_BLOCK,            0xdb, L'*' },
  66   { BLOCKELEMENT_LIGHT_SHADE,           0xb0, L'+' },
  67
  68   { GEOMETRICSHAPE_UP_TRIANGLE,         0x1e, L'^' },
  69   { GEOMETRICSHAPE_RIGHT_TRIANGLE,      0x10, L'>' },
  70   { GEOMETRICSHAPE_DOWN_TRIANGLE,       0x1f, L'v' },
  71   { GEOMETRICSHAPE_LEFT_TRIANGLE,       0x11, L'<' },
  72
  73   { ARROW_LEFT,                         0x3c, L'<' },
  74   { ARROW_UP,                           0x18, L'^' },
  75   { ARROW_RIGHT,                        0x3e, L'>' },
  76   { ARROW_DOWN,                         0x19, L'v' },
  77
  78   { 0x0000,                             0x00, L'\0' }
  79 };
  80
  81 CHAR16 mSetModeString[]            = { ESC, '[', '=', '3', 'h', 0 };
  82 CHAR16 mSetAttributeString[]       = { ESC, '[', '0', 'm', ESC, '[', '4', '0', 'm', ESC, '[', '4', '0', 'm', 0 };
  83 CHAR16 mClearScreenString[]        = { ESC, '[', '2', 'J', 0 };
  84 CHAR16 mSetCursorPositionString[]  = { ESC, '[', '0', '0', ';', '0', '0', 'H', 0 };
  85
  86 //
  87 // Body of the ConOut functions
  88 //
  89
  90 /**
  91   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().
  92
  93   If ExtendeVerification is TRUE, then perform dependent serial device reset,
  94   and set display mode to mode 0.
  95   If ExtendedVerification is FALSE, only set display mode to mode 0.
  96
  97   @param  This                  Indicates the calling context.
  98   @param  ExtendedVerification  Indicates that the driver may perform a more
  99                                 exhaustive verification operation of the device
 100                                 during reset.
 101
 102   @retval EFI_SUCCESS           The reset operation succeeds.
 103   @retval EFI_DEVICE_ERROR      The terminal is not functioning correctly or the serial port reset fails.
 104
 105 **/
 106 EFI_STATUS
 107 EFIAPI
 108 TerminalConOutReset (
 109   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 110   IN  BOOLEAN                          ExtendedVerification
 111   )
 112 {
 113   EFI_STATUS    Status;
 114   TERMINAL_DEV  *TerminalDevice;
 115
 116   TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);
 117
 118   //
 119   // Perform a more exhaustive reset by resetting the serial port.
 120   //
 121   if (ExtendedVerification) {
 122     //
 123     // Report progress code here
 124     //
 125     REPORT_STATUS_CODE_WITH_DEVICE_PATH (
 126       EFI_PROGRESS_CODE,
 127       PcdGet32 (PcdStatusCodeValueRemoteConsoleReset),
 128       TerminalDevice->DevicePath
 129       );
 130
 131     Status = TerminalDevice->SerialIo->Reset (TerminalDevice->SerialIo);
 132     if (EFI_ERROR (Status)) {
 133       //
 134       // Report error code here
 135       //
 136       REPORT_STATUS_CODE_WITH_DEVICE_PATH (
 137         EFI_ERROR_CODE | EFI_ERROR_MINOR,
 138         PcdGet32 (PcdStatusCodeValueRemoteConsoleError),
 139         TerminalDevice->DevicePath
 140         );
 141
 142       return Status;
 143     }
 144   }
 145
 146   This->SetAttribute (This, EFI_TEXT_ATTR (This->Mode->Attribute & 0x0F, EFI_BLACK));
 147
 148   Status = This->SetMode (This, 0);
 149
 150   return Status;
 151 }
 152
 153
 154 /**
 155   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().
 156
 157   The Unicode string will be converted to terminal expressible data stream
 158   and send to terminal via serial port.
 159
 160   @param  This                    Indicates the calling context.
 161   @param  WString                 The Null-terminated Unicode string to be displayed
 162                                   on the terminal screen.
 163
 164   @retval EFI_SUCCESS             The string is output successfully.
 165   @retval EFI_DEVICE_ERROR        The serial port fails to send the string out.
 166   @retval EFI_WARN_UNKNOWN_GLYPH  Indicates that some of the characters in the Unicode string could not
 167                                   be rendered and are skipped.
 168   @retval EFI_UNSUPPORTED         If current display mode is out of range.
 169
 170 **/
 171 EFI_STATUS
 172 EFIAPI
 173 TerminalConOutOutputString (
 174   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 175   IN  CHAR16                           *WString
 176   )
 177 {
 178   TERMINAL_DEV                *TerminalDevice;
 179   EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;
 180   UINTN                       MaxColumn;
 181   UINTN                       MaxRow;
 182   UINTN                       Length;
 183   UTF8_CHAR                   Utf8Char;
 184   CHAR8                       GraphicChar;
 185   CHAR8                       AsciiChar;
 186   EFI_STATUS                  Status;
 187   UINT8                       ValidBytes;
 188   //
 189   //  flag used to indicate whether condition happens which will cause
 190   //  return EFI_WARN_UNKNOWN_GLYPH
 191   //
 192   BOOLEAN                     Warning;
 193
 194   ValidBytes  = 0;
 195   Warning     = FALSE;
 196   AsciiChar   = 0;
 197
 198   //
 199   //  get Terminal device data structure pointer.
 200   //
 201   TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);
 202
 203   //
 204   //  Get current display mode
 205   //
 206   Mode = This->Mode;
 207
 208   if (Mode->Mode > 2) {
 209     return EFI_UNSUPPORTED;
 210   }
 211
 212   This->QueryMode (
 213           This,
 214           Mode->Mode,
 215           &MaxColumn,
 216           &MaxRow
 217           );
 218
 219   for (; *WString != CHAR_NULL; WString++) {
 220
 221     switch (TerminalDevice->TerminalType) {
 222
 223     case PCANSITYPE:
 224     case VT100TYPE:
 225     case VT100PLUSTYPE:
 226
 227       if (!TerminalIsValidTextGraphics (*WString, &GraphicChar, &AsciiChar)) {
 228         //
 229         // If it's not a graphic character convert Unicode to ASCII.
 230         //
 231         GraphicChar = (CHAR8) *WString;
 232
 233         if (!(TerminalIsValidAscii (GraphicChar) || TerminalIsValidEfiCntlChar (GraphicChar))) {
 234           //
 235           // when this driver use the OutputString to output control string,
 236           // TerminalDevice->OutputEscChar is set to let the Esc char
 237           // to be output to the terminal emulation software.
 238           //
 239           if ((GraphicChar == 27) && TerminalDevice->OutputEscChar) {
 240             GraphicChar = 27;
 241           } else {
 242             GraphicChar = '?';
 243             Warning     = TRUE;
 244           }
 245         }
 246
 247         AsciiChar = GraphicChar;
 248
 249       }
 250
 251       if (TerminalDevice->TerminalType != PCANSITYPE) {
 252         GraphicChar = AsciiChar;
 253       }
 254
 255       Length = 1;
 256
 257       Status = TerminalDevice->SerialIo->Write (
 258                                           TerminalDevice->SerialIo,
 259                                           &Length,
 260                                           &GraphicChar
 261                                           );
 262
 263       if (EFI_ERROR (Status)) {
 264         goto OutputError;
 265       }
 266
 267       break;
 268
 269     case VTUTF8TYPE:
 270       UnicodeToUtf8 (*WString, &Utf8Char, &ValidBytes);
 271       Length = ValidBytes;
 272       Status = TerminalDevice->SerialIo->Write (
 273                                           TerminalDevice->SerialIo,
 274                                           &Length,
 275                                           (UINT8 *) &Utf8Char
 276                                           );
 277       if (EFI_ERROR (Status)) {
 278         goto OutputError;
 279       }
 280       break;
 281     }
 282     //
 283     //  Update cursor position.
 284     //
 285     switch (*WString) {
 286
 287     case CHAR_BACKSPACE:
 288       if (Mode->CursorColumn > 0) {
 289         Mode->CursorColumn--;
 290       }
 291       break;
 292
 293     case CHAR_LINEFEED:
 294       if (Mode->CursorRow < (INT32) (MaxRow - 1)) {
 295         Mode->CursorRow++;
 296       }
 297       break;
 298
 299     case CHAR_CARRIAGE_RETURN:
 300       Mode->CursorColumn = 0;
 301       break;
 302
 303     default:
 304       if (Mode->CursorColumn < (INT32) (MaxColumn - 1)) {
 305
 306         Mode->CursorColumn++;
 307
 308       } else {
 309
 310         Mode->CursorColumn = 0;
 311         if (Mode->CursorRow < (INT32) (MaxRow - 1)) {
 312           Mode->CursorRow++;
 313         }
 314
 315       }
 316       break;
 317
 318     };
 319
 320   }
 321
 322   if (Warning) {
 323     return EFI_WARN_UNKNOWN_GLYPH;
 324   }
 325
 326   return EFI_SUCCESS;
 327
 328 OutputError:
 329   REPORT_STATUS_CODE_WITH_DEVICE_PATH (
 330     EFI_ERROR_CODE | EFI_ERROR_MINOR,
 331     PcdGet32 (PcdStatusCodeValueRemoteConsoleOutputError),
 332     TerminalDevice->DevicePath
 333     );
 334
 335   return EFI_DEVICE_ERROR;
 336 }
 337
 338
 339 /**
 340   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().
 341
 342   If one of the characters in the *Wstring is
 343   neither valid Unicode drawing characters,
 344   not ASCII code, then this function will return
 345   EFI_UNSUPPORTED.
 346
 347   @param  This              Indicates the calling context.
 348   @param  WString           The Null-terminated Unicode string to be tested.
 349
 350   @retval EFI_SUCCESS       The terminal is capable of rendering the output string.
 351   @retval EFI_UNSUPPORTED   Some of the characters in the Unicode string cannot be rendered.
 352
 353 **/
 354 EFI_STATUS
 355 EFIAPI
 356 TerminalConOutTestString (
 357   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 358   IN  CHAR16                           *WString
 359   )
 360 {
 361   TERMINAL_DEV  *TerminalDevice;
 362   EFI_STATUS    Status;
 363
 364   //
 365   //  get Terminal device data structure pointer.
 366   //
 367   TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);
 368
 369   switch (TerminalDevice->TerminalType) {
 370
 371   case PCANSITYPE:
 372   case VT100TYPE:
 373   case VT100PLUSTYPE:
 374     Status = AnsiTestString (TerminalDevice, WString);
 375     break;
 376
 377   case VTUTF8TYPE:
 378     Status = VTUTF8TestString (TerminalDevice, WString);
 379     break;
 380
 381   default:
 382     Status = EFI_UNSUPPORTED;
 383     break;
 384   }
 385
 386   return Status;
 387 }
 388
 389
 390 /**
 391   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().
 392
 393   It returns information for an available text mode
 394   that the terminal supports.
 395   In this driver, we support text mode 80x25 (mode 0),
 396   80x50 (mode 1), 100x31 (mode 2).
 397
 398   @param This        Indicates the calling context.
 399   @param ModeNumber  The mode number to return information on.
 400   @param Columns     The returned columns of the requested mode.
 401   @param Rows        The returned rows of the requested mode.
 402
 403   @retval EFI_SUCCESS       The requested mode information is returned.
 404   @retval EFI_UNSUPPORTED   The mode number is not valid.
 405   @retval EFI_DEVICE_ERROR
 406
 407 **/
 408 EFI_STATUS
 409 EFIAPI
 410 TerminalConOutQueryMode (
 411   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 412   IN  UINTN                            ModeNumber,
 413   OUT UINTN                            *Columns,
 414   OUT UINTN                            *Rows
 415   )
 416 {
 417   if (This->Mode->MaxMode > 3) {
 418     return EFI_DEVICE_ERROR;
 419   }
 420
 421   if (ModeNumber == 0) {
 422     *Columns  = MODE0_COLUMN_COUNT;
 423     *Rows     = MODE0_ROW_COUNT;
 424     return EFI_SUCCESS;
 425   } else if (ModeNumber == 1) {
 426     *Columns  = MODE1_COLUMN_COUNT;
 427     *Rows     = MODE1_ROW_COUNT;
 428     return EFI_SUCCESS;
 429   } else if (ModeNumber == 2) {
 430     *Columns  = MODE2_COLUMN_COUNT;
 431     *Rows     = MODE2_ROW_COUNT;
 432     return EFI_SUCCESS;
 433   }
 434
 435   return EFI_UNSUPPORTED;
 436 }
 437
 438
 439 /**
 440   Implements EFI_SIMPLE_TEXT_OUT.SetMode().
 441
 442   Set the terminal to a specified display mode.
 443   In this driver, we only support mode 0.
 444
 445   @param This          Indicates the calling context.
 446   @param ModeNumber    The text mode to set.
 447
 448   @retval EFI_SUCCESS       The requested text mode is set.
 449   @retval EFI_DEVICE_ERROR  The requested text mode cannot be set
 450                             because of serial device error.
 451   @retval EFI_UNSUPPORTED   The text mode number is not valid.
 452
 453 **/
 454 EFI_STATUS
 455 EFIAPI
 456 TerminalConOutSetMode (
 457   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 458   IN  UINTN                            ModeNumber
 459   )
 460 {
 461   EFI_STATUS    Status;
 462   TERMINAL_DEV  *TerminalDevice;
 463
 464   //
 465   //  get Terminal device data structure pointer.
 466   //
 467   TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);
 468
 469   if (ModeNumber > 2) {
 470     return EFI_UNSUPPORTED;
 471   }
 472
 473   //
 474   // Set the current mode
 475   //
 476   This->Mode->Mode = (INT32) ModeNumber;
 477
 478   This->ClearScreen (This);
 479
 480   TerminalDevice->OutputEscChar = TRUE;
 481   Status                        = This->OutputString (This, mSetModeString);
 482   TerminalDevice->OutputEscChar = FALSE;
 483
 484   if (EFI_ERROR (Status)) {
 485     return EFI_DEVICE_ERROR;
 486   }
 487
 488   This->Mode->Mode  = (INT32) ModeNumber;
 489
 490   Status            = This->ClearScreen (This);
 491   if (EFI_ERROR (Status)) {
 492     return EFI_DEVICE_ERROR;
 493   }
 494
 495   return EFI_SUCCESS;
 496
 497 }
 498
 499
 500 /**
 501   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().
 502
 503   @param This        Indicates the calling context.
 504   @param Attribute   The attribute to set. Only bit0..6 are valid, all other bits
 505                      are undefined and must be zero.
 506
 507   @retval EFI_SUCCESS        The requested attribute is set.
 508   @retval EFI_DEVICE_ERROR   The requested attribute cannot be set due to serial port error.
 509   @retval EFI_UNSUPPORTED    The attribute requested is not defined by EFI spec.
 510
 511 **/
 512 EFI_STATUS
 513 EFIAPI
 514 TerminalConOutSetAttribute (
 515   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 516   IN  UINTN                            Attribute
 517   )
 518 {
 519   UINT8         ForegroundControl;
 520   UINT8         BackgroundControl;
 521   UINT8         BrightControl;
 522   INT32         SavedColumn;
 523   INT32         SavedRow;
 524   EFI_STATUS    Status;
 525   TERMINAL_DEV  *TerminalDevice;
 526
 527   SavedColumn = 0;
 528   SavedRow    = 0;
 529
 530   //
 531   //  get Terminal device data structure pointer.
 532   //
 533   TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);
 534
 535   //
 536   //  only the bit0..6 of the Attribute is valid
 537   //
 538   if ((Attribute | 0x7f) != 0x7f) {
 539     return EFI_UNSUPPORTED;
 540   }
 541
 542   //
 543   // Skip outputting the command string for the same attribute
 544   // It improves the terminal performance significantly
 545   //
 546   if (This->Mode->Attribute == (INT32) Attribute) {
 547     return EFI_SUCCESS;
 548   }
 549
 550   //
 551   //  convert Attribute value to terminal emulator
 552   //  understandable foreground color
 553   //
 554   switch (Attribute & 0x07) {
 555
 556   case EFI_BLACK:
 557     ForegroundControl = 30;
 558     break;
 559
 560   case EFI_BLUE:
 561     ForegroundControl = 34;
 562     break;
 563
 564   case EFI_GREEN:
 565     ForegroundControl = 32;
 566     break;
 567
 568   case EFI_CYAN:
 569     ForegroundControl = 36;
 570     break;
 571
 572   case EFI_RED:
 573     ForegroundControl = 31;
 574     break;
 575
 576   case EFI_MAGENTA:
 577     ForegroundControl = 35;
 578     break;
 579
 580   case EFI_BROWN:
 581     ForegroundControl = 33;
 582     break;
 583
 584   default:
 585
 586   case EFI_LIGHTGRAY:
 587     ForegroundControl = 37;
 588     break;
 589
 590   }
 591   //
 592   //  bit4 of the Attribute indicates bright control
 593   //  of terminal emulator.
 594   //
 595   BrightControl = (UINT8) ((Attribute >> 3) & 1);
 596
 597   //
 598   //  convert Attribute value to terminal emulator
 599   //  understandable background color.
 600   //
 601   switch ((Attribute >> 4) & 0x07) {
 602
 603   case EFI_BLACK:
 604     BackgroundControl = 40;
 605     break;
 606
 607   case EFI_BLUE:
 608     BackgroundControl = 44;
 609     break;
 610
 611   case EFI_GREEN:
 612     BackgroundControl = 42;
 613     break;
 614
 615   case EFI_CYAN:
 616     BackgroundControl = 46;
 617     break;
 618
 619   case EFI_RED:
 620     BackgroundControl = 41;
 621     break;
 622
 623   case EFI_MAGENTA:
 624     BackgroundControl = 45;
 625     break;
 626
 627   case EFI_BROWN:
 628     BackgroundControl = 43;
 629     break;
 630
 631   default:
 632
 633   case EFI_LIGHTGRAY:
 634     BackgroundControl = 47;
 635     break;
 636   }
 637   //
 638   // terminal emulator's control sequence to set attributes
 639   //
 640   mSetAttributeString[BRIGHT_CONTROL_OFFSET]          = (CHAR16) ('0' + BrightControl);
 641   mSetAttributeString[FOREGROUND_CONTROL_OFFSET + 0]  = (CHAR16) ('0' + (ForegroundControl / 10));
 642   mSetAttributeString[FOREGROUND_CONTROL_OFFSET + 1]  = (CHAR16) ('0' + (ForegroundControl % 10));
 643   mSetAttributeString[BACKGROUND_CONTROL_OFFSET + 0]  = (CHAR16) ('0' + (BackgroundControl / 10));
 644   mSetAttributeString[BACKGROUND_CONTROL_OFFSET + 1]  = (CHAR16) ('0' + (BackgroundControl % 10));
 645
 646   //
 647   // save current column and row
 648   // for future scrolling back use.
 649   //
 650   SavedColumn                   = This->Mode->CursorColumn;
 651   SavedRow                      = This->Mode->CursorRow;
 652
 653   TerminalDevice->OutputEscChar = TRUE;
 654   Status                        = This->OutputString (This, mSetAttributeString);
 655   TerminalDevice->OutputEscChar = FALSE;
 656
 657   if (EFI_ERROR (Status)) {
 658     return EFI_DEVICE_ERROR;
 659   }
 660   //
 661   //  scroll back to saved cursor position.
 662   //
 663   This->Mode->CursorColumn  = SavedColumn;
 664   This->Mode->CursorRow     = SavedRow;
 665
 666   This->Mode->Attribute     = (INT32) Attribute;
 667
 668   return EFI_SUCCESS;
 669
 670 }
 671
 672
 673 /**
 674   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().
 675   It clears the ANSI terminal's display to the
 676   currently selected background color.
 677
 678   @param This     Indicates the calling context.
 679
 680   @retval EFI_SUCCESS       The operation completed successfully.
 681   @retval EFI_DEVICE_ERROR  The terminal screen cannot be cleared due to serial port error.
 682   @retval EFI_UNSUPPORTED   The terminal is not in a valid display mode.
 683
 684 **/
 685 EFI_STATUS
 686 EFIAPI
 687 TerminalConOutClearScreen (
 688   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This
 689   )
 690 {
 691   EFI_STATUS    Status;
 692   TERMINAL_DEV  *TerminalDevice;
 693
 694   TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);
 695
 696   //
 697   //  control sequence for clear screen request
 698   //
 699   TerminalDevice->OutputEscChar = TRUE;
 700   Status                        = This->OutputString (This, mClearScreenString);
 701   TerminalDevice->OutputEscChar = FALSE;
 702
 703   if (EFI_ERROR (Status)) {
 704     return EFI_DEVICE_ERROR;
 705   }
 706
 707   Status = This->SetCursorPosition (This, 0, 0);
 708
 709   return Status;
 710 }
 711
 712
 713 /**
 714   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().
 715
 716   @param This      Indicates the calling context.
 717   @param Column    The row to set cursor to.
 718   @param Row       The column to set cursor to.
 719
 720   @retval EFI_SUCCESS       The operation completed successfully.
 721   @retval EFI_DEVICE_ERROR  The request fails due to serial port error.
 722   @retval EFI_UNSUPPORTED   The terminal is not in a valid text mode, or the cursor position
 723                             is invalid for current mode.
 724
 725 **/
 726 EFI_STATUS
 727 EFIAPI
 728 TerminalConOutSetCursorPosition (
 729   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 730   IN  UINTN                            Column,
 731   IN  UINTN                            Row
 732   )
 733 {
 734   EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;
 735   UINTN                       MaxColumn;
 736   UINTN                       MaxRow;
 737   EFI_STATUS                  Status;
 738   TERMINAL_DEV                *TerminalDevice;
 739
 740   TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);
 741
 742   //
 743   //  get current mode
 744   //
 745   Mode = This->Mode;
 746
 747   //
 748   //  get geometry of current mode
 749   //
 750   Status = This->QueryMode (
 751                   This,
 752                   Mode->Mode,
 753                   &MaxColumn,
 754                   &MaxRow
 755                   );
 756   if (EFI_ERROR (Status)) {
 757     return EFI_UNSUPPORTED;
 758   }
 759
 760   if (Column >= MaxColumn || Row >= MaxRow) {
 761     return EFI_UNSUPPORTED;
 762   }
 763   //
 764   // control sequence to move the cursor
 765   //
 766   mSetCursorPositionString[ROW_OFFSET + 0]    = (CHAR16) ('0' + ((Row + 1) / 10));
 767   mSetCursorPositionString[ROW_OFFSET + 1]    = (CHAR16) ('0' + ((Row + 1) % 10));
 768   mSetCursorPositionString[COLUMN_OFFSET + 0] = (CHAR16) ('0' + ((Column + 1) / 10));
 769   mSetCursorPositionString[COLUMN_OFFSET + 1] = (CHAR16) ('0' + ((Column + 1) % 10));
 770
 771   TerminalDevice->OutputEscChar               = TRUE;
 772   Status = This->OutputString (This, mSetCursorPositionString);
 773   TerminalDevice->OutputEscChar = FALSE;
 774
 775   if (EFI_ERROR (Status)) {
 776     return EFI_DEVICE_ERROR;
 777   }
 778   //
 779   //  update current cursor position
 780   //  in the Mode data structure.
 781   //
 782   Mode->CursorColumn  = (INT32) Column;
 783   Mode->CursorRow     = (INT32) Row;
 784
 785   return EFI_SUCCESS;
 786 }
 787
 788
 789 /**
 790   Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
 791
 792   In this driver, the cursor cannot be hidden.
 793
 794   @param This      Indicates the calling context.
 795   @param Visible   If TRUE, the cursor is set to be visible,
 796                    If FALSE, the cursor is set to be invisible.
 797
 798   @retval EFI_SUCCESS      The request is valid.
 799   @retval EFI_UNSUPPORTED  The terminal does not support cursor hidden.
 800
 801 **/
 802 EFI_STATUS
 803 EFIAPI
 804 TerminalConOutEnableCursor (
 805   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 806   IN  BOOLEAN                          Visible
 807   )
 808 {
 809   if (!Visible) {
 810     return EFI_UNSUPPORTED;
 811   }
 812
 813   return EFI_SUCCESS;
 814 }
 815
 816
 817 /**
 818   Detects if a Unicode char is for Box Drawing text graphics.
 819
 820   @param  Graphic      Unicode char to test.
 821   @param  PcAnsi       Optional pointer to return PCANSI equivalent of
 822                        Graphic.
 823   @param  Ascii        Optional pointer to return ASCII equivalent of
 824                        Graphic.
 825
 826   @retval TRUE         If Graphic is a supported Unicode Box Drawing character.
 827
 828 **/
 829 BOOLEAN
 830 TerminalIsValidTextGraphics (
 831   IN  CHAR16  Graphic,
 832   OUT CHAR8   *PcAnsi, OPTIONAL
 833   OUT CHAR8   *Ascii OPTIONAL
 834   )
 835 {
 836   UNICODE_TO_CHAR *Table;
 837
 838   if ((((Graphic & 0xff00) != 0x2500) && ((Graphic & 0xff00) != 0x2100))) {
 839     //
 840     // Unicode drawing code charts are all in the 0x25xx range,
 841     //  arrows are 0x21xx
 842     //
 843     return FALSE;
 844   }
 845
 846   for (Table = UnicodeToPcAnsiOrAscii; Table->Unicode != 0x0000; Table++) {
 847     if (Graphic == Table->Unicode) {
 848       if (PcAnsi != NULL) {
 849         *PcAnsi = Table->PcAnsi;
 850       }
 851
 852       if (Ascii != NULL) {
 853         *Ascii = Table->Ascii;
 854       }
 855
 856       return TRUE;
 857     }
 858   }
 859
 860   return FALSE;
 861 }
 862
 863 /**
 864   Detects if a valid ASCII char.
 865
 866   @param  Ascii        An ASCII character.
 867
 868   @retval TRUE         If it is a valid ASCII character.
 869   @retval FALSE        If it is not a valid ASCII character.
 870
 871 **/
 872 BOOLEAN
 873 TerminalIsValidAscii (
 874   IN  CHAR16  Ascii
 875   )
 876 {
 877   //
 878   // valid ascii code lies in the extent of 0x20 ~ 0x7f
 879   //
 880   if ((Ascii >= 0x20) && (Ascii <= 0x7f)) {
 881     return TRUE;
 882   }
 883
 884   return FALSE;
 885 }
 886
 887 /**
 888   Detects if a valid EFI control character.
 889
 890   @param  CharC        An input EFI Control character.
 891
 892   @retval TRUE         If it is a valid EFI control character.
 893   @retval FALSE        If it is not a valid EFI control character.
 894
 895 **/
 896 BOOLEAN
 897 TerminalIsValidEfiCntlChar (
 898   IN  CHAR16  CharC
 899   )
 900 {
 901   //
 902   // only support four control characters.
 903   //
 904   if (CharC == CHAR_NULL ||
 905       CharC == CHAR_BACKSPACE ||
 906       CharC == CHAR_LINEFEED ||
 907       CharC == CHAR_CARRIAGE_RETURN ||
 908       CharC == CHAR_TAB
 909       ) {
 910     return TRUE;
 911   }
 912
 913   return FALSE;
 914 }