Cleanup SerailIO drivers to have a device path and use PCD settings for various stuff...

[mirror_edk2.git] / EmbeddedPkg / SimpleTextInOutSerial / SimpleTextInOut.c

/** @file\r
  Simple Console that sits on a SerialLib. \r
\r
  Copyright (c) 2008-2009, Apple Inc. All rights reserved.\r
  \r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
/* \r
  Symbols used in table below\r
===========================\r
  ESC = 0x1B\r
  CSI = 0x9B\r
  DEL = 0x7f\r
  ^   = CTRL\r
\r
+=========+======+===========+==========+==========+\r
|         | EFI  | UEFI 2.0  |          |          |\r
|         | Scan |           |  VT100+  |          |\r
|   KEY   | Code |  PC ANSI  |  VTUTF8  |   VT100  |\r
+=========+======+===========+==========+==========+\r
| NULL    | 0x00 |           |          |          |\r
| UP      | 0x01 | ESC [ A   | ESC [ A  | ESC [ A  |\r
| DOWN    | 0x02 | ESC [ B   | ESC [ B  | ESC [ B  |\r
| RIGHT   | 0x03 | ESC [ C   | ESC [ C  | ESC [ C  |\r
| LEFT    | 0x04 | ESC [ D   | ESC [ D  | ESC [ D  |\r
| HOME    | 0x05 | ESC [ H   | ESC h    | ESC [ H  |\r
| END     | 0x06 | ESC [ F   | ESC k    | ESC [ K  |\r
| INSERT  | 0x07 | ESC [ @   | ESC +    | ESC [ @  |\r
|         |      | ESC [ L   |          | ESC [ L  |\r
| DELETE  | 0x08 | ESC [ X   | ESC -    | ESC [ P  |\r
| PG UP   | 0x09 | ESC [ I   | ESC ?    | ESC [ V  |\r
|         |      |           |          | ESC [ ?  |\r
| PG DOWN | 0x0A | ESC [ G   | ESC /    | ESC [ U  |\r
|         |      |           |          | ESC [ /  |\r
| F1      | 0x0B | ESC [ M   | ESC 1    | ESC O P  |\r
| F2      | 0x0C | ESC [ N   | ESC 2    | ESC O Q  |\r
| F3      | 0x0D | ESC [ O   | ESC 3    | ESC O w  |\r
| F4      | 0x0E | ESC [ P   | ESC 4    | ESC O x  |\r
| F5      | 0x0F | ESC [ Q   | ESC 5    | ESC O t  |\r
| F6      | 0x10 | ESC [ R   | ESC 6    | ESC O u  |\r
| F7      | 0x11 | ESC [ S   | ESC 7    | ESC O q  |\r
| F8      | 0x12 | ESC [ T   | ESC 8    | ESC O r  |\r
| F9      | 0x13 | ESC [ U   | ESC 9    | ESC O p  |\r
| F10     | 0x14 | ESC [ V   | ESC 0    | ESC O M  |\r
| Escape  | 0x17 | ESC       | ESC      | ESC      |\r
| F11     | 0x15 |           | ESC !    |          |\r
| F12     | 0x16 |           | ESC @    |          |\r
+=========+======+===========+==========+==========+\r
\r
*/\r
\r
#include <PiDxe.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/SerialPortLib.h>\r
#include <Library/PcdLib.h>\r
\r
#include <Protocol/SerialIo.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/DevicePath.h>\r
\r
\r
#define MODE0_COLUMN_COUNT        80\r
#define MODE0_ROW_COUNT           25\r
\r
\r
EFI_STATUS\r
EFIAPI\r
TextInReset(\r
  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
  IN BOOLEAN                        ExtendedVerification\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
ReadKeyStroke(\r
  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
  OUT EFI_INPUT_KEY                 *Key\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
TextOutReset(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN BOOLEAN                          ExtendedVerification\r
  );\r
\r
CHAR8 *\r
EFIAPI\r
SafeUnicodeStrToAsciiStr (\r
  IN      CONST CHAR16                *Source,\r
  OUT     CHAR8                       *Destination\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
OutputString (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN CHAR16                           *String\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
TestString (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN CHAR16                           *String\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
QueryMode (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN UINTN                            ModeNumber,\r
  OUT UINTN                           *Columns,\r
  OUT UINTN                           *Rows\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
SetMode(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN UINTN                            ModeNumber\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
SetAttribute(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN UINTN                            Attribute\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
ClearScreen (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
SetCursorPosition (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN UINTN                            Column,\r
  IN UINTN                            Row\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
EnableCursor (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN BOOLEAN                          Enable\r
  );\r
\r
\r
 EFI_SIMPLE_TEXT_INPUT_PROTOCOL mSimpleTextIn = {\r
  TextInReset,\r
  ReadKeyStroke,\r
  NULL\r
};\r
\r
 EFI_SIMPLE_TEXT_OUTPUT_MODE mSimpleTextOutMode = {\r
  1,\r
  0,\r
  EFI_TEXT_ATTR( EFI_LIGHTGRAY, EFI_BLACK ),\r
  0,\r
  0,\r
  TRUE\r
};\r
\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL mSimpleTextOut = {\r
  TextOutReset,\r
  OutputString,\r
  TestString,\r
  QueryMode,\r
  SetMode,\r
  SetAttribute,\r
  ClearScreen,\r
  SetCursorPosition,\r
  EnableCursor,\r
  &mSimpleTextOutMode\r
};\r
\r
EFI_HANDLE           mInstallHandle = NULL;\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH        Guid;\r
  UART_DEVICE_PATH          Uart;\r
  EFI_DEVICE_PATH_PROTOCOL  End;\r
} SIMPLE_TEXT_OUT_DEVICE_PATH;\r
\r
SIMPLE_TEXT_OUT_DEVICE_PATH mDevicePath = {\r
  {\r
    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, sizeof (VENDOR_DEVICE_PATH), 0},\r
    EFI_CALLER_ID_GUID\r
  },\r
  {\r
    { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (UART_DEVICE_PATH), 0},\r
    0,        // Reserved\r
    FixedPcdGet64 (PcdUartDefaultBaudRate),   // BaudRate\r
    FixedPcdGet8 (PcdUartDefaultDataBits),    // DataBits\r
    FixedPcdGet8 (PcdUartDefaultParity),      // Parity (N)\r
    FixedPcdGet8 (PcdUartDefaultStopBits)     // StopBits\r
  },\r
  { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (EFI_DEVICE_PATH_PROTOCOL), 0}\r
};\r
\r
\r
\r
\r
BOOLEAN\r
TextOutIsValidAscii (\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
BOOLEAN\r
TextOutIsValidEfiCntlChar (\r
  IN CHAR16       Char\r
  )\r
{\r
  //\r
  // only support four control characters.\r
  //\r
  if (Char == CHAR_NULL ||\r
      Char == CHAR_BACKSPACE ||\r
      Char == CHAR_LINEFEED ||\r
      Char == CHAR_CARRIAGE_RETURN ||\r
      Char == CHAR_TAB ) {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
\r
VOID\r
EFIAPI\r
WaitForKeyEvent (\r
  IN EFI_EVENT          Event,\r
  IN VOID               *Context\r
  )\r
{\r
  if (SerialPortPoll ())  {\r
    gBS->SignalEvent (Event);\r
  }\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
TextInReset (\r
  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
  IN BOOLEAN                        ExtendedVerification\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
ReadKeyStroke (\r
  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
  OUT EFI_INPUT_KEY                 *Key\r
  )\r
{\r
  CHAR8             Char;\r
  \r
  if (!SerialPortPoll ()) {\r
    return EFI_NOT_READY;\r
  }\r
  \r
  SerialPortRead ((UINT8 *)&Char, 1);\r
  \r
  //\r
  // Check for ESC sequence. This code is not techincally correct VT100 code.\r
  // An illegal ESC sequence represents an ESC and the characters that follow.\r
  // This code will eat one or two chars after an escape. This is done to \r
  // prevent some complex FIFOing of the data. It is good enough to get\r
  // the arrow and delete keys working\r
  //\r
  Key->UnicodeChar = 0;\r
  Key->ScanCode    = SCAN_NULL;\r
  if (Char == 0x1b) {\r
    SerialPortRead ((UINT8 *)&Char, 1);\r
    if (Char == '[') {\r
      SerialPortRead ((UINT8 *)&Char, 1);\r
      switch (Char) {\r
      case 'A':\r
        Key->ScanCode = SCAN_UP;\r
        break;\r
      case 'B':\r
        Key->ScanCode = SCAN_DOWN;\r
        break;\r
      case 'C':\r
        Key->ScanCode = SCAN_RIGHT;\r
        break;\r
      case 'D':\r
        Key->ScanCode = SCAN_LEFT;\r
        break;\r
      case 'H':\r
        Key->ScanCode = SCAN_HOME;\r
        break;\r
      case 'K':\r
      case 'F': // PC ANSI \r
        Key->ScanCode = SCAN_END;\r
        break;\r
      case '@':\r
      case 'L':\r
        Key->ScanCode = SCAN_INSERT;\r
        break;\r
      case 'P':\r
      case 'X': // PC ANSI \r
        Key->ScanCode = SCAN_DELETE;\r
        break;\r
      case 'U':\r
      case '/':\r
      case 'G': // PC ANSI\r
        Key->ScanCode = SCAN_PAGE_DOWN;\r
        break;\r
      case 'V':\r
      case '?':\r
      case 'I': // PC ANSI\r
        Key->ScanCode = SCAN_PAGE_UP;\r
        break;\r
\r
      // PCANSI that does not conflict with VT100\r
      case 'M':\r
        Key->ScanCode = SCAN_F1;\r
        break;\r
      case 'N':\r
        Key->ScanCode = SCAN_F2;\r
        break;\r
      case 'O':\r
        Key->ScanCode = SCAN_F3;\r
        break;\r
      case 'Q':\r
        Key->ScanCode = SCAN_F5;\r
        break;\r
      case 'R':\r
        Key->ScanCode = SCAN_F6;\r
        break;\r
      case 'S':\r
        Key->ScanCode = SCAN_F7;\r
        break;\r
      case 'T':\r
        Key->ScanCode = SCAN_F8;\r
        break;\r
\r
      default:\r
        Key->UnicodeChar = Char;\r
        break;\r
      }\r
    } else if (Char == '0') {\r
      SerialPortRead ((UINT8 *)&Char, 1);\r
      switch (Char) {\r
      case 'P':\r
        Key->ScanCode = SCAN_F1;\r
        break;\r
      case 'Q':\r
        Key->ScanCode = SCAN_F2;\r
        break;\r
      case 'w':\r
        Key->ScanCode = SCAN_F3;\r
        break;\r
      case 'x':\r
        Key->ScanCode = SCAN_F4;\r
        break;\r
      case 't':\r
        Key->ScanCode = SCAN_F5;\r
        break;\r
      case 'u':\r
        Key->ScanCode = SCAN_F6;\r
        break;\r
      case 'q':\r
        Key->ScanCode = SCAN_F7;\r
        break;\r
      case 'r':\r
        Key->ScanCode = SCAN_F8;\r
        break;\r
      case 'p':\r
        Key->ScanCode = SCAN_F9;\r
        break;\r
      case 'm':\r
        Key->ScanCode = SCAN_F10;\r
        break;\r
      default :\r
        break;\r
      }\r
    }\r
  } else if (Char < ' ') {\r
    if ((Char == CHAR_BACKSPACE) || \r
        (Char == CHAR_TAB)       || \r
        (Char == CHAR_LINEFEED)  || \r
        (Char == CHAR_CARRIAGE_RETURN)) {\r
      // Only let through EFI required control characters\r
      Key->UnicodeChar = (CHAR16)Char;  \r
    }\r
  } else if (Char == 0x7f) {\r
    Key->ScanCode = SCAN_DELETE;\r
  } else {\r
    Key->UnicodeChar = (CHAR16)Char;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
TextOutReset (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN BOOLEAN                          ExtendedVerification\r
  )\r
{\r
  EFI_STATUS            Status;\r
\r
  This->SetAttribute(\r
        This,\r
        EFI_TEXT_ATTR(This->Mode->Attribute & 0x0F, EFI_BACKGROUND_BLACK)\r
        );\r
\r
  Status = This->SetMode (This, 0);\r
\r
  return Status;\r
}\r
\r
CHAR8 *\r
EFIAPI\r
SafeUnicodeStrToAsciiStr (\r
  IN      CONST CHAR16                *Source,\r
  OUT     CHAR8                       *Destination\r
  )\r
{\r
  CHAR8                               *ReturnValue;\r
\r
  ASSERT (Destination != NULL);\r
\r
  //\r
  // ASSERT if Source is long than PcdMaximumUnicodeStringLength.\r
  // Length tests are performed inside StrLen().\r
  //\r
  ASSERT (StrSize (Source) != 0);\r
\r
  //\r
  // Source and Destination should not overlap\r
  //\r
  ASSERT ((UINTN) ((CHAR16 *) Destination -  Source) > StrLen (Source));\r
  ASSERT ((UINTN) ((CHAR8 *) Source - Destination) > StrLen (Source));\r
\r
\r
  ReturnValue = Destination;\r
  while (*Source != '\0') {\r
    //\r
    // If any non-ascii characters in Source then replace it with '?'.\r
    //\r
    if (*Source < 0x80) {\r
      *Destination = (CHAR8) *Source;\r
    } else {\r
      *Destination = '?';\r
\r
      //Surrogate pair check.\r
      if ((*Source >= 0xD800) && (*Source <= 0xDFFF)) {\r
        Source++;\r
      }\r
    }\r
\r
    Destination++;\r
    Source++;\r
  }\r
\r
  *Destination = '\0';\r
\r
  //\r
  // ASSERT Original Destination is less long than PcdMaximumAsciiStringLength.\r
  // Length tests are performed inside AsciiStrLen().\r
  //\r
  ASSERT (AsciiStrSize (ReturnValue) != 0);\r
\r
  return ReturnValue;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
OutputString (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN CHAR16                           *String\r
  )\r
{\r
  UINTN Size          = StrLen(String) + 1;\r
  CHAR8 *OutputString = AllocatePool(Size);\r
  \r
  //If there is any non-ascii characters in String buffer then replace it with '?'\r
  //Eventually, UnicodeStrToAsciiStr API should be fixed.\r
  SafeUnicodeStrToAsciiStr(String, OutputString);  \r
  SerialPortWrite ((UINT8 *)OutputString, Size - 1);\r
\r
  FreePool(OutputString);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
TestString (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN CHAR16                           *String\r
  )\r
{\r
  CHAR8           Character;\r
\r
  for ( ; *String != CHAR_NULL; String++) {\r
    Character = (CHAR8)*String;\r
    if (!(TextOutIsValidAscii (Character) || TextOutIsValidEfiCntlChar (Character))) {\r
      return EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
QueryMode (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN UINTN                            ModeNumber,\r
  OUT UINTN                          *Columns,\r
  OUT UINTN                          *Rows\r
  )\r
{\r
  if (This->Mode->MaxMode > 1) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (ModeNumber == 0) {\r
    *Columns  = MODE0_COLUMN_COUNT;\r
    *Rows     = MODE0_ROW_COUNT;\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_UNSUPPORTED;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
SetMode (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,\r
  IN UINTN                              ModeNumber\r
  )\r
{\r
  if (ModeNumber != 0) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  This->Mode->Mode = 0;\r
  This->ClearScreen (This);\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
SetAttribute(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,\r
  IN UINTN                              Attribute\r
  )\r
{\r
  This->Mode->Attribute = (INT32)Attribute;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
ClearScreen (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This\r
  )\r
{\r
  EFI_STATUS    Status;\r
\r
  Status = This->SetCursorPosition (This, 0, 0);\r
  return Status;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
SetCursorPosition (\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
  EFI_STATUS                        Status;\r
  UINTN                             MaxColumn;\r
  UINTN                             MaxRow;\r
\r
  Mode = This->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
  Mode->CursorColumn = (INT32)Column;\r
  Mode->CursorRow = (INT32)Row;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
EnableCursor (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN BOOLEAN                          Enable\r
  )\r
{\r
  if (!Enable) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
SimpleTextInOutEntryPoint (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS            Status;\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_NOTIFY,\r
                  WaitForKeyEvent,\r
                  NULL,\r
                  &mSimpleTextIn.WaitForKey\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
  \r
  Status = gBS->InstallMultipleProtocolInterfaces(\r
                  &mInstallHandle,\r
                  &gEfiSimpleTextInProtocolGuid,   &mSimpleTextIn,\r
                  &gEfiSimpleTextOutProtocolGuid,  &mSimpleTextOut,\r
                  &gEfiDevicePathProtocolGuid,     &mDevicePath,\r
                  NULL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    gST->ConOut = &mSimpleTextOut;\r
    gST->ConIn = &mSimpleTextIn;\r
  }\r
  \r
  return Status;\r
}\r