[mirror_edk2.git] / MdeModulePkg / Universal / Console / TerminalDxe / TerminalConOut.c

/** @file\r
  Implementation for EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL protocol.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
Copyright (C) 2016 Silicon Graphics, Inc. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Terminal.h"\r
\r
//\r
// This list is used to define the valid extend chars.\r
// It also provides a mapping from Unicode to PCANSI or\r
// ASCII. The ASCII mapping we just made up.\r
//\r
//\r
UNICODE_TO_CHAR  UnicodeToPcAnsiOrAscii[] = {\r
  { BOXDRAW_HORIZONTAL,                 0xc4, L'-'  },\r
  { BOXDRAW_VERTICAL,                   0xb3, L'|'  },\r
  { BOXDRAW_DOWN_RIGHT,                 0xda, L'/'  },\r
  { BOXDRAW_DOWN_LEFT,                  0xbf, L'\\' },\r
  { BOXDRAW_UP_RIGHT,                   0xc0, L'\\' },\r
  { BOXDRAW_UP_LEFT,                    0xd9, L'/'  },\r
  { BOXDRAW_VERTICAL_RIGHT,             0xc3, L'|'  },\r
  { BOXDRAW_VERTICAL_LEFT,              0xb4, L'|'  },\r
  { BOXDRAW_DOWN_HORIZONTAL,            0xc2, L'+'  },\r
  { BOXDRAW_UP_HORIZONTAL,              0xc1, L'+'  },\r
  { BOXDRAW_VERTICAL_HORIZONTAL,        0xc5, L'+'  },\r
  { BOXDRAW_DOUBLE_HORIZONTAL,          0xcd, L'-'  },\r
  { BOXDRAW_DOUBLE_VERTICAL,            0xba, L'|'  },\r
  { BOXDRAW_DOWN_RIGHT_DOUBLE,          0xd5, L'/'  },\r
  { BOXDRAW_DOWN_DOUBLE_RIGHT,          0xd6, L'/'  },\r
  { BOXDRAW_DOUBLE_DOWN_RIGHT,          0xc9, L'/'  },\r
  { BOXDRAW_DOWN_LEFT_DOUBLE,           0xb8, L'\\' },\r
  { BOXDRAW_DOWN_DOUBLE_LEFT,           0xb7, L'\\' },\r
  { BOXDRAW_DOUBLE_DOWN_LEFT,           0xbb, L'\\' },\r
  { BOXDRAW_UP_RIGHT_DOUBLE,            0xd4, L'\\' },\r
  { BOXDRAW_UP_DOUBLE_RIGHT,            0xd3, L'\\' },\r
  { BOXDRAW_DOUBLE_UP_RIGHT,            0xc8, L'\\' },\r
  { BOXDRAW_UP_LEFT_DOUBLE,             0xbe, L'/'  },\r
  { BOXDRAW_UP_DOUBLE_LEFT,             0xbd, L'/'  },\r
  { BOXDRAW_DOUBLE_UP_LEFT,             0xbc, L'/'  },\r
  { BOXDRAW_VERTICAL_RIGHT_DOUBLE,      0xc6, L'|'  },\r
  { BOXDRAW_VERTICAL_DOUBLE_RIGHT,      0xc7, L'|'  },\r
  { BOXDRAW_DOUBLE_VERTICAL_RIGHT,      0xcc, L'|'  },\r
  { BOXDRAW_VERTICAL_LEFT_DOUBLE,       0xb5, L'|'  },\r
  { BOXDRAW_VERTICAL_DOUBLE_LEFT,       0xb6, L'|'  },\r
  { BOXDRAW_DOUBLE_VERTICAL_LEFT,       0xb9, L'|'  },\r
  { BOXDRAW_DOWN_HORIZONTAL_DOUBLE,     0xd1, L'+'  },\r
  { BOXDRAW_DOWN_DOUBLE_HORIZONTAL,     0xd2, L'+'  },\r
  { BOXDRAW_DOUBLE_DOWN_HORIZONTAL,     0xcb, L'+'  },\r
  { BOXDRAW_UP_HORIZONTAL_DOUBLE,       0xcf, L'+'  },\r
  { BOXDRAW_UP_DOUBLE_HORIZONTAL,       0xd0, L'+'  },\r
  { BOXDRAW_DOUBLE_UP_HORIZONTAL,       0xca, L'+'  },\r
  { BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE, 0xd8, L'+'  },\r
  { BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL, 0xd7, L'+'  },\r
  { BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL, 0xce, L'+'  },\r
\r
  { BLOCKELEMENT_FULL_BLOCK,            0xdb, L'*'  },\r
  { BLOCKELEMENT_LIGHT_SHADE,           0xb0, L'+'  },\r
\r
  { GEOMETRICSHAPE_UP_TRIANGLE,         '^',  L'^'  },\r
  { GEOMETRICSHAPE_RIGHT_TRIANGLE,      '>',  L'>'  },\r
  { GEOMETRICSHAPE_DOWN_TRIANGLE,       'v',  L'v'  },\r
  { GEOMETRICSHAPE_LEFT_TRIANGLE,       '<',  L'<'  },\r
\r
  { ARROW_LEFT,                         '<',  L'<'  },\r
  { ARROW_UP,                           '^',  L'^'  },\r
  { ARROW_RIGHT,                        '>',  L'>'  },\r
  { ARROW_DOWN,                         'v',  L'v'  },\r
\r
  { 0x0000,                             0x00, L'\0' }\r
};\r
\r
CHAR16  mSetModeString[]           = { ESC, '[', '=', '3', 'h', 0 };\r
CHAR16  mSetAttributeString[]      = { ESC, '[', '0', 'm', ESC, '[', '4', '0', 'm', ESC, '[', '4', '0', 'm', 0 };\r
CHAR16  mClearScreenString[]       = { ESC, '[', '2', 'J', 0 };\r
CHAR16  mSetCursorPositionString[] = { ESC, '[', '0', '0', ';', '0', '0', 'H', 0 };\r
CHAR16  mCursorForwardString[]     = { ESC, '[', '0', '0', 'C', 0 };\r
CHAR16  mCursorBackwardString[]    = { ESC, '[', '0', '0', 'D', 0 };\r
\r
//\r
// Body of the ConOut functions\r
//\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().\r
\r
  If ExtendeVerification is TRUE, then perform dependent serial device reset,\r
  and set display mode to mode 0.\r
  If ExtendedVerification is FALSE, only set display mode to mode 0.\r
\r
  @param  This                  Indicates the calling context.\r
  @param  ExtendedVerification  Indicates that the driver may perform a more\r
                                exhaustive verification operation of the device\r
                                during reset.\r
\r
  @retval EFI_SUCCESS           The reset operation succeeds.\r
  @retval EFI_DEVICE_ERROR      The terminal is not functioning correctly or the serial port reset fails.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutReset (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  BOOLEAN                          ExtendedVerification\r
  )\r
{\r
  EFI_STATUS    Status;\r
  TERMINAL_DEV  *TerminalDevice;\r
\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
  //\r
  // Perform a more exhaustive reset by resetting the serial port.\r
  //\r
  if (ExtendedVerification) {\r
    //\r
    // Report progress code here\r
    //\r
    REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
      EFI_PROGRESS_CODE,\r
      (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_PC_RESET),\r
      TerminalDevice->DevicePath\r
      );\r
\r
    Status = TerminalDevice->SerialIo->Reset (TerminalDevice->SerialIo);\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Report error code here\r
      //\r
      REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
        EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
        (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_CONTROLLER_ERROR),\r
        TerminalDevice->DevicePath\r
        );\r
\r
      return Status;\r
    }\r
  }\r
\r
  This->SetAttribute (This, EFI_TEXT_ATTR (This->Mode->Attribute & 0x0F, EFI_BLACK));\r
\r
  Status = This->SetMode (This, 0);\r
\r
  return Status;\r
}\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().\r
\r
  The Unicode string will be converted to terminal expressible data stream\r
  and send to terminal via serial port.\r
\r
  @param  This                    Indicates the calling context.\r
  @param  WString                 The Null-terminated Unicode string to be displayed\r
                                  on the terminal screen.\r
\r
  @retval EFI_SUCCESS             The string is output successfully.\r
  @retval EFI_DEVICE_ERROR        The serial port fails to send the string out.\r
  @retval EFI_WARN_UNKNOWN_GLYPH  Indicates that some of the characters in the Unicode string could not\r
                                  be rendered and are skipped.\r
  @retval EFI_UNSUPPORTED         If current display mode is out of range.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutOutputString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                           *WString\r
  )\r
{\r
  TERMINAL_DEV                 *TerminalDevice;\r
  EFI_SIMPLE_TEXT_OUTPUT_MODE  *Mode;\r
  UINTN                        MaxColumn;\r
  UINTN                        MaxRow;\r
  UINTN                        Length;\r
  UTF8_CHAR                    Utf8Char;\r
  CHAR8                        GraphicChar;\r
  CHAR8                        AsciiChar;\r
  EFI_STATUS                   Status;\r
  UINT8                        ValidBytes;\r
  CHAR8                        CrLfStr[2];\r
  //\r
  //  flag used to indicate whether condition happens which will cause\r
  //  return EFI_WARN_UNKNOWN_GLYPH\r
  //\r
  BOOLEAN  Warning;\r
\r
  ValidBytes = 0;\r
  Warning    = FALSE;\r
  AsciiChar  = 0;\r
\r
  //\r
  //  get Terminal device data structure pointer.\r
  //\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
  //\r
  //  Get current display mode\r
  //\r
  Mode = This->Mode;\r
\r
  if (Mode->Mode >= Mode->MaxMode) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  This->QueryMode (\r
          This,\r
          Mode->Mode,\r
          &MaxColumn,\r
          &MaxRow\r
          );\r
\r
  for ( ; *WString != CHAR_NULL; WString++) {\r
    switch (TerminalDevice->TerminalType) {\r
      case TerminalTypePcAnsi:\r
      case TerminalTypeVt100:\r
      case TerminalTypeVt100Plus:\r
      case TerminalTypeTtyTerm:\r
      case TerminalTypeLinux:\r
      case TerminalTypeXtermR6:\r
      case TerminalTypeVt400:\r
      case TerminalTypeSCO:\r
\r
        if (!TerminalIsValidTextGraphics (*WString, &GraphicChar, &AsciiChar)) {\r
          //\r
          // If it's not a graphic character convert Unicode to ASCII.\r
          //\r
          GraphicChar = (CHAR8)*WString;\r
\r
          if (!(TerminalIsValidAscii (GraphicChar) || TerminalIsValidEfiCntlChar (GraphicChar))) {\r
            //\r
            // when this driver use the OutputString to output control string,\r
            // TerminalDevice->OutputEscChar is set to let the Esc char\r
            // to be output to the terminal emulation software.\r
            //\r
            if ((GraphicChar == 27) && TerminalDevice->OutputEscChar) {\r
              GraphicChar = 27;\r
            } else {\r
              GraphicChar = '?';\r
              Warning     = TRUE;\r
            }\r
          }\r
\r
          AsciiChar = GraphicChar;\r
        }\r
\r
        if (TerminalDevice->TerminalType != TerminalTypePcAnsi) {\r
          GraphicChar = AsciiChar;\r
        }\r
\r
        Length = 1;\r
\r
        Status = TerminalDevice->SerialIo->Write (\r
                                             TerminalDevice->SerialIo,\r
                                             &Length,\r
                                             &GraphicChar\r
                                             );\r
\r
        if (EFI_ERROR (Status)) {\r
          goto OutputError;\r
        }\r
\r
        break;\r
\r
      case TerminalTypeVtUtf8:\r
        UnicodeToUtf8 (*WString, &Utf8Char, &ValidBytes);\r
        Length = ValidBytes;\r
        Status = TerminalDevice->SerialIo->Write (\r
                                             TerminalDevice->SerialIo,\r
                                             &Length,\r
                                             (UINT8 *)&Utf8Char\r
                                             );\r
        if (EFI_ERROR (Status)) {\r
          goto OutputError;\r
        }\r
\r
        break;\r
    }\r
\r
    //\r
    //  Update cursor position.\r
    //\r
    switch (*WString) {\r
      case CHAR_BACKSPACE:\r
        if (Mode->CursorColumn > 0) {\r
          Mode->CursorColumn--;\r
        }\r
\r
        break;\r
\r
      case CHAR_LINEFEED:\r
        if (Mode->CursorRow < (INT32)(MaxRow - 1)) {\r
          Mode->CursorRow++;\r
        }\r
\r
        break;\r
\r
      case CHAR_CARRIAGE_RETURN:\r
        Mode->CursorColumn = 0;\r
        break;\r
\r
      default:\r
        if (Mode->CursorColumn < (INT32)(MaxColumn - 1)) {\r
          Mode->CursorColumn++;\r
        } else {\r
          Mode->CursorColumn = 0;\r
          if (Mode->CursorRow < (INT32)(MaxRow - 1)) {\r
            Mode->CursorRow++;\r
          }\r
\r
          if ((TerminalDevice->TerminalType == TerminalTypeTtyTerm) &&\r
              !TerminalDevice->OutputEscChar)\r
          {\r
            //\r
            // We've written the last character on the line.  The\r
            // terminal doesn't actually wrap its cursor until we print\r
            // the next character, but the driver thinks it has wrapped\r
            // already.  Print CR LF to synchronize the terminal with\r
            // the driver, but only if we're not in the middle of\r
            // printing an escape sequence.\r
            //\r
            CrLfStr[0] = '\r';\r
            CrLfStr[1] = '\n';\r
\r
            Length = sizeof (CrLfStr);\r
\r
            Status = TerminalDevice->SerialIo->Write (\r
                                                 TerminalDevice->SerialIo,\r
                                                 &Length,\r
                                                 CrLfStr\r
                                                 );\r
\r
            if (EFI_ERROR (Status)) {\r
              goto OutputError;\r
            }\r
          }\r
        }\r
\r
        break;\r
    }\r
  }\r
\r
  if (Warning) {\r
    return EFI_WARN_UNKNOWN_GLYPH;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
OutputError:\r
  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
    EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
    (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_OUTPUT_ERROR),\r
    TerminalDevice->DevicePath\r
    );\r
\r
  return EFI_DEVICE_ERROR;\r
}\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().\r
\r
  If one of the characters in the *Wstring is\r
  neither valid Unicode drawing characters,\r
  not ASCII code, then this function will return\r
  EFI_UNSUPPORTED.\r
\r
  @param  This              Indicates the calling context.\r
  @param  WString           The Null-terminated Unicode string to be tested.\r
\r
  @retval EFI_SUCCESS       The terminal is capable of rendering the output string.\r
  @retval EFI_UNSUPPORTED   Some of the characters in the Unicode string cannot be rendered.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutTestString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                           *WString\r
  )\r
{\r
  TERMINAL_DEV  *TerminalDevice;\r
  EFI_STATUS    Status;\r
\r
  //\r
  //  get Terminal device data structure pointer.\r
  //\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
  switch (TerminalDevice->TerminalType) {\r
    case TerminalTypePcAnsi:\r
    case TerminalTypeVt100:\r
    case TerminalTypeVt100Plus:\r
    case TerminalTypeTtyTerm:\r
      Status = AnsiTestString (TerminalDevice, WString);\r
      break;\r
\r
    case TerminalTypeVtUtf8:\r
      Status = VTUTF8TestString (TerminalDevice, WString);\r
      break;\r
\r
    default:\r
      Status = EFI_UNSUPPORTED;\r
      break;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().\r
\r
  It returns information for an available text mode\r
  that the terminal supports.\r
\r
  @param This        Indicates the calling context.\r
  @param ModeNumber  The mode number to return information on.\r
  @param Columns     The returned columns of the requested mode.\r
  @param Rows        The returned rows of the requested mode.\r
\r
  @retval EFI_SUCCESS       The requested mode information is returned.\r
  @retval EFI_UNSUPPORTED   The mode number is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutQueryMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            ModeNumber,\r
  OUT UINTN                            *Columns,\r
  OUT UINTN                            *Rows\r
  )\r
{\r
  TERMINAL_DEV  *TerminalDevice;\r
\r
  if (ModeNumber >= (UINTN)This->Mode->MaxMode) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Get Terminal device data structure pointer.\r
  //\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
  *Columns       = TerminalDevice->TerminalConsoleModeData[ModeNumber].Columns;\r
  *Rows          = TerminalDevice->TerminalConsoleModeData[ModeNumber].Rows;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUT.SetMode().\r
\r
  Set the terminal to a specified display mode.\r
  In this driver, we only support mode 0.\r
\r
  @param This          Indicates the calling context.\r
  @param ModeNumber    The text mode to set.\r
\r
  @retval EFI_SUCCESS       The requested text mode is set.\r
  @retval EFI_DEVICE_ERROR  The requested text mode cannot be set\r
                            because of serial device error.\r
  @retval EFI_UNSUPPORTED   The text mode number is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutSetMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            ModeNumber\r
  )\r
{\r
  EFI_STATUS    Status;\r
  TERMINAL_DEV  *TerminalDevice;\r
\r
  //\r
  //  get Terminal device data structure pointer.\r
  //\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
  if (ModeNumber >= (UINTN)This->Mode->MaxMode) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Set the current mode\r
  //\r
  This->Mode->Mode = (INT32)ModeNumber;\r
\r
  This->ClearScreen (This);\r
\r
  TerminalDevice->OutputEscChar = TRUE;\r
  Status                        = This->OutputString (This, mSetModeString);\r
  TerminalDevice->OutputEscChar = FALSE;\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  This->Mode->Mode = (INT32)ModeNumber;\r
\r
  Status = This->ClearScreen (This);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().\r
\r
  @param This        Indicates the calling context.\r
  @param Attribute   The attribute to set. Only bit0..6 are valid, all other bits\r
                     are undefined and must be zero.\r
\r
  @retval EFI_SUCCESS        The requested attribute is set.\r
  @retval EFI_DEVICE_ERROR   The requested attribute cannot be set due to serial port error.\r
  @retval EFI_UNSUPPORTED    The attribute requested is not defined by EFI spec.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutSetAttribute (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            Attribute\r
  )\r
{\r
  UINT8         ForegroundControl;\r
  UINT8         BackgroundControl;\r
  UINT8         BrightControl;\r
  INT32         SavedColumn;\r
  INT32         SavedRow;\r
  EFI_STATUS    Status;\r
  TERMINAL_DEV  *TerminalDevice;\r
\r
  SavedColumn = 0;\r
  SavedRow    = 0;\r
\r
  //\r
  //  get Terminal device data structure pointer.\r
  //\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
  //\r
  //  only the bit0..6 of the Attribute is valid\r
  //\r
  if ((Attribute | 0x7f) != 0x7f) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Skip outputting the command string for the same attribute\r
  // It improves the terminal performance significantly\r
  //\r
  if (This->Mode->Attribute == (INT32)Attribute) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  //  convert Attribute value to terminal emulator\r
  //  understandable foreground color\r
  //\r
  switch (Attribute & 0x07) {\r
    case EFI_BLACK:\r
      ForegroundControl = 30;\r
      break;\r
\r
    case EFI_BLUE:\r
      ForegroundControl = 34;\r
      break;\r
\r
    case EFI_GREEN:\r
      ForegroundControl = 32;\r
      break;\r
\r
    case EFI_CYAN:\r
      ForegroundControl = 36;\r
      break;\r
\r
    case EFI_RED:\r
      ForegroundControl = 31;\r
      break;\r
\r
    case EFI_MAGENTA:\r
      ForegroundControl = 35;\r
      break;\r
\r
    case EFI_BROWN:\r
      ForegroundControl = 33;\r
      break;\r
\r
    default:\r
\r
    case EFI_LIGHTGRAY:\r
      ForegroundControl = 37;\r
      break;\r
  }\r
\r
  //\r
  //  bit4 of the Attribute indicates bright control\r
  //  of terminal emulator.\r
  //\r
  BrightControl = (UINT8)((Attribute >> 3) & 1);\r
\r
  //\r
  //  convert Attribute value to terminal emulator\r
  //  understandable background color.\r
  //\r
  switch ((Attribute >> 4) & 0x07) {\r
    case EFI_BLACK:\r
      BackgroundControl = 40;\r
      break;\r
\r
    case EFI_BLUE:\r
      BackgroundControl = 44;\r
      break;\r
\r
    case EFI_GREEN:\r
      BackgroundControl = 42;\r
      break;\r
\r
    case EFI_CYAN:\r
      BackgroundControl = 46;\r
      break;\r
\r
    case EFI_RED:\r
      BackgroundControl = 41;\r
      break;\r
\r
    case EFI_MAGENTA:\r
      BackgroundControl = 45;\r
      break;\r
\r
    case EFI_BROWN:\r
      BackgroundControl = 43;\r
      break;\r
\r
    default:\r
\r
    case EFI_LIGHTGRAY:\r
      BackgroundControl = 47;\r
      break;\r
  }\r
\r
  //\r
  // terminal emulator's control sequence to set attributes\r
  //\r
  mSetAttributeString[BRIGHT_CONTROL_OFFSET]         = (CHAR16)('0' + BrightControl);\r
  mSetAttributeString[FOREGROUND_CONTROL_OFFSET + 0] = (CHAR16)('0' + (ForegroundControl / 10));\r
  mSetAttributeString[FOREGROUND_CONTROL_OFFSET + 1] = (CHAR16)('0' + (ForegroundControl % 10));\r
  mSetAttributeString[BACKGROUND_CONTROL_OFFSET + 0] = (CHAR16)('0' + (BackgroundControl / 10));\r
  mSetAttributeString[BACKGROUND_CONTROL_OFFSET + 1] = (CHAR16)('0' + (BackgroundControl % 10));\r
\r
  //\r
  // save current column and row\r
  // for future scrolling back use.\r
  //\r
  SavedColumn = This->Mode->CursorColumn;\r
  SavedRow    = This->Mode->CursorRow;\r
\r
  TerminalDevice->OutputEscChar = TRUE;\r
  Status                        = This->OutputString (This, mSetAttributeString);\r
  TerminalDevice->OutputEscChar = FALSE;\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  //  scroll back to saved cursor position.\r
  //\r
  This->Mode->CursorColumn = SavedColumn;\r
  This->Mode->CursorRow    = SavedRow;\r
\r
  This->Mode->Attribute = (INT32)Attribute;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().\r
  It clears the ANSI terminal's display to the\r
  currently selected background color.\r
\r
  @param This     Indicates the calling context.\r
\r
  @retval EFI_SUCCESS       The operation completed successfully.\r
  @retval EFI_DEVICE_ERROR  The terminal screen cannot be cleared due to serial port error.\r
  @retval EFI_UNSUPPORTED   The terminal is not in a valid display mode.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutClearScreen (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This\r
  )\r
{\r
  EFI_STATUS    Status;\r
  TERMINAL_DEV  *TerminalDevice;\r
\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
  //\r
  //  control sequence for clear screen request\r
  //\r
  TerminalDevice->OutputEscChar = TRUE;\r
  Status                        = This->OutputString (This, mClearScreenString);\r
  TerminalDevice->OutputEscChar = FALSE;\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Status = This->SetCursorPosition (This, 0, 0);\r
\r
  return Status;\r
}\r
\r
/**\r
  Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().\r
\r
  @param This      Indicates the calling context.\r
  @param Column    The row to set cursor to.\r
  @param Row       The column to set cursor to.\r
\r
  @retval EFI_SUCCESS       The operation completed successfully.\r
  @retval EFI_DEVICE_ERROR  The request fails due to serial port error.\r
  @retval EFI_UNSUPPORTED   The terminal is not in a valid text mode, or the cursor position\r
                            is invalid for current mode.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutSetCursorPosition (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            Column,\r
  IN  UINTN                            Row\r
  )\r
{\r
  EFI_SIMPLE_TEXT_OUTPUT_MODE  *Mode;\r
  UINTN                        MaxColumn;\r
  UINTN                        MaxRow;\r
  EFI_STATUS                   Status;\r
  TERMINAL_DEV                 *TerminalDevice;\r
  CHAR16                       *String;\r
\r
  TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
  //\r
  //  get current mode\r
  //\r
  Mode = This->Mode;\r
\r
  //\r
  //  get geometry of current mode\r
  //\r
  Status = This->QueryMode (\r
                   This,\r
                   Mode->Mode,\r
                   &MaxColumn,\r
                   &MaxRow\r
                   );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if ((Column >= MaxColumn) || (Row >= MaxRow)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // control sequence to move the cursor\r
  //\r
  // Optimize cursor motion control sequences for TtyTerm.  Move\r
  // within the current line if possible, and don't output anyting if\r
  // it isn't necessary.\r
  //\r
  if ((TerminalDevice->TerminalType == TerminalTypeTtyTerm) &&\r
      ((UINTN)Mode->CursorRow == Row))\r
  {\r
    if ((UINTN)Mode->CursorColumn > Column) {\r
      mCursorBackwardString[FW_BACK_OFFSET + 0] = (CHAR16)('0' + ((Mode->CursorColumn - Column) / 10));\r
      mCursorBackwardString[FW_BACK_OFFSET + 1] = (CHAR16)('0' + ((Mode->CursorColumn - Column) % 10));\r
      String                                    = mCursorBackwardString;\r
    } else if (Column > (UINTN)Mode->CursorColumn) {\r
      mCursorForwardString[FW_BACK_OFFSET + 0] = (CHAR16)('0' + ((Column - Mode->CursorColumn) / 10));\r
      mCursorForwardString[FW_BACK_OFFSET + 1] = (CHAR16)('0' + ((Column - Mode->CursorColumn) % 10));\r
      String                                   = mCursorForwardString;\r
    } else {\r
      String = L"";  // No cursor motion necessary\r
    }\r
  } else {\r
    mSetCursorPositionString[ROW_OFFSET + 0]    = (CHAR16)('0' + ((Row + 1) / 10));\r
    mSetCursorPositionString[ROW_OFFSET + 1]    = (CHAR16)('0' + ((Row + 1) % 10));\r
    mSetCursorPositionString[COLUMN_OFFSET + 0] = (CHAR16)('0' + ((Column + 1) / 10));\r
    mSetCursorPositionString[COLUMN_OFFSET + 1] = (CHAR16)('0' + ((Column + 1) % 10));\r
    String                                      = mSetCursorPositionString;\r
  }\r
\r
  TerminalDevice->OutputEscChar = TRUE;\r
  Status                        = This->OutputString (This, String);\r
  TerminalDevice->OutputEscChar = FALSE;\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  //  update current cursor position\r
  //  in the Mode data structure.\r
  //\r
  Mode->CursorColumn = (INT32)Column;\r
  Mode->CursorRow    = (INT32)Row;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Implements SIMPLE_TEXT_OUTPUT.EnableCursor().\r
\r
  In this driver, the cursor cannot be hidden.\r
\r
  @param This      Indicates the calling context.\r
  @param Visible   If TRUE, the cursor is set to be visible,\r
                   If FALSE, the cursor is set to be invisible.\r
\r
  @retval EFI_SUCCESS      The request is valid.\r
  @retval EFI_UNSUPPORTED  The terminal does not support cursor hidden.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutEnableCursor (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  BOOLEAN                          Visible\r
  )\r
{\r
  if (!Visible) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Detects if a Unicode char is for Box Drawing text graphics.\r
\r
  @param  Graphic      Unicode char to test.\r
  @param  PcAnsi       Optional pointer to return PCANSI equivalent of\r
                       Graphic.\r
  @param  Ascii        Optional pointer to return ASCII equivalent of\r
                       Graphic.\r
\r
  @retval TRUE         If Graphic is a supported Unicode Box Drawing character.\r
\r
**/\r
BOOLEAN\r
TerminalIsValidTextGraphics (\r
  IN  CHAR16  Graphic,\r
  OUT CHAR8   *PcAnsi  OPTIONAL,\r
  OUT CHAR8   *Ascii OPTIONAL\r
  )\r
{\r
  UNICODE_TO_CHAR  *Table;\r
\r
  if ((((Graphic & 0xff00) != 0x2500) && ((Graphic & 0xff00) != 0x2100))) {\r
    //\r
    // Unicode drawing code charts are all in the 0x25xx range,\r
    //  arrows are 0x21xx\r
    //\r
    return FALSE;\r
  }\r
\r
  for (Table = UnicodeToPcAnsiOrAscii; Table->Unicode != 0x0000; Table++) {\r
    if (Graphic == Table->Unicode) {\r
      if (PcAnsi != NULL) {\r
        *PcAnsi = Table->PcAnsi;\r
      }\r
\r
      if (Ascii != NULL) {\r
        *Ascii = Table->Ascii;\r
      }\r
\r
      return TRUE;\r
    }\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Detects if a valid ASCII char.\r
\r
  @param  Ascii        An ASCII character.\r
\r
  @retval TRUE         If it is a valid ASCII character.\r
  @retval FALSE        If it is not a valid ASCII character.\r
\r
**/\r
BOOLEAN\r
TerminalIsValidAscii (\r
  IN  CHAR16  Ascii\r
  )\r
{\r
  //\r
  // valid ascii code lies in the extent of 0x20 ~ 0x7f\r
  //\r
  if ((Ascii >= 0x20) && (Ascii <= 0x7f)) {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Detects if a valid EFI control character.\r
\r
  @param  CharC        An input EFI Control character.\r
\r
  @retval TRUE         If it is a valid EFI control character.\r
  @retval FALSE        If it is not a valid EFI control character.\r
\r
**/\r
BOOLEAN\r
TerminalIsValidEfiCntlChar (\r
  IN  CHAR16  CharC\r
  )\r
{\r
  //\r
  // only support four control characters.\r
  //\r
  if ((CharC == CHAR_NULL) ||\r
      (CharC == CHAR_BACKSPACE) ||\r
      (CharC == CHAR_LINEFEED) ||\r
      (CharC == CHAR_CARRIAGE_RETURN) ||\r
      (CharC == CHAR_TAB)\r
      )\r
  {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r