Add a Notification GUID for the implementation of EFI_SIMPLE_INPUT_EX protocol for...

[mirror_edk2.git] / MdeModulePkg / Universal / Console / TerminalDxe / Terminal.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \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
Module Name:\r
\r
  terminal.h\r
\r
Abstract:\r
\r
  \r
Revision History\r
\r
--*/\r
\r
#ifndef _TERMINAL_H\r
#define _TERMINAL_H\r
\r
\r
#include <PiDxe.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/SerialIo.h>\r
#include <Guid/GlobalVariable.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Guid/HotPlugDevice.h>\r
#include <Guid/PcAnsi.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
\r
\r
\r
#define RAW_FIFO_MAX_NUMBER 256\r
#define FIFO_MAX_NUMBER     128\r
\r
typedef struct {\r
  UINT8 Head;\r
  UINT8 Tail;\r
  UINT8 Data[RAW_FIFO_MAX_NUMBER + 1];\r
} RAW_DATA_FIFO;\r
\r
typedef struct {\r
  UINT8   Head;\r
  UINT8   Tail;\r
  UINT16  Data[FIFO_MAX_NUMBER + 1];\r
} UNICODE_FIFO;\r
\r
typedef struct {\r
  UINT8         Head;\r
  UINT8         Tail;\r
  EFI_INPUT_KEY Data[FIFO_MAX_NUMBER + 1];\r
} EFI_KEY_FIFO;\r
\r
#define TERMINAL_DEV_SIGNATURE  EFI_SIGNATURE_32 ('t', 'm', 'n', 'l')\r
\r
typedef struct {\r
  UINTN                               Signature;\r
  EFI_HANDLE                          Handle;\r
  UINT8                               TerminalType;\r
  EFI_SERIAL_IO_PROTOCOL              *SerialIo;\r
  EFI_DEVICE_PATH_PROTOCOL            *DevicePath;\r
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL      SimpleInput;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL     SimpleTextOutput;\r
  EFI_SIMPLE_TEXT_OUTPUT_MODE         SimpleTextOutputMode;\r
  UINTN                               SerialInTimeOut;\r
  RAW_DATA_FIFO                       RawFiFo;\r
  UNICODE_FIFO                        UnicodeFiFo;\r
  EFI_KEY_FIFO                        EfiKeyFiFo;\r
  EFI_UNICODE_STRING_TABLE            *ControllerNameTable;\r
  EFI_EVENT                           TwoSecondTimeOut;\r
  UINT32                              InputState;\r
  UINT32                              ResetState;\r
\r
  //\r
  // Esc could not be output to the screen by user,\r
  // but the terminal driver need to output it to\r
  // the terminal emulation software to send control sequence.\r
  // This boolean is used by the terminal driver only\r
  // to indicate whether the Esc could be sent or not.\r
  //\r
  BOOLEAN                             OutputEscChar;\r
} TERMINAL_DEV;\r
\r
#define INPUT_STATE_DEFAULT               0x00\r
#define INPUT_STATE_ESC                   0x01\r
#define INPUT_STATE_CSI                   0x02\r
#define INPUT_STATE_LEFTOPENBRACKET       0x04\r
#define INPUT_STATE_O                     0x08\r
#define INPUT_STATE_2                     0x10\r
\r
#define RESET_STATE_DEFAULT               0x00\r
#define RESET_STATE_ESC_R                 0x01\r
#define RESET_STATE_ESC_R_ESC_r           0x02\r
\r
#define TERMINAL_CON_IN_DEV_FROM_THIS(a)  CR (a, TERMINAL_DEV, SimpleInput, TERMINAL_DEV_SIGNATURE)\r
#define TERMINAL_CON_OUT_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleTextOutput, TERMINAL_DEV_SIGNATURE)\r
\r
typedef union {\r
  UINT8 Utf8_1;\r
  UINT8 Utf8_2[2];\r
  UINT8 Utf8_3[3];\r
} UTF8_CHAR;\r
\r
#define PcAnsiType                0\r
#define VT100Type                 1\r
#define VT100PlusType             2\r
#define VTUTF8Type                3\r
\r
#define LEFTOPENBRACKET           0x5b  // '['\r
#define ACAP                      0x41\r
#define BCAP                      0x42\r
#define CCAP                      0x43\r
#define DCAP                      0x44\r
\r
#define MODE0_COLUMN_COUNT        80\r
#define MODE0_ROW_COUNT           25\r
\r
#define BACKSPACE                 8\r
#define ESC                       27\r
#define CSI                       0x9B\r
#define DEL                       127\r
#define BRIGHT_CONTROL_OFFSET     2\r
#define FOREGROUND_CONTROL_OFFSET 6\r
#define BACKGROUND_CONTROL_OFFSET 11\r
#define ROW_OFFSET                2\r
#define COLUMN_OFFSET             5\r
\r
typedef struct {\r
  UINT16  Unicode;\r
  CHAR8   PcAnsi;\r
  CHAR8   Ascii;\r
} UNICODE_TO_CHAR;\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL   gTerminalDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gTerminalComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gTerminalComponentName2;\r
\r
//\r
// Prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
InitializeTerminal (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalConInReset (\r
  IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL    *This,\r
  IN  BOOLEAN                           ExtendedVerification\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalConInReadKeyStroke (\r
  IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,\r
  OUT EFI_INPUT_KEY                   *Key\r
  )\r
;\r
\r
VOID\r
EFIAPI\r
TerminalConInWaitForKey (\r
  IN  EFI_EVENT     Event,\r
  IN  VOID          *Context\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutReset (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,\r
  IN  BOOLEAN                            ExtendedVerification\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutOutputString (\r
  IN   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                            *WString\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutTestString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                           *WString\r
  )\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
\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutSetMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            ModeNumber\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutSetAttribute (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            Attribute\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutClearScreen (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This\r
  )\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
\r
EFI_STATUS\r
EFIAPI\r
TerminalConOutEnableCursor (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  BOOLEAN                          Visible\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
TerminalDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN  EFI_HANDLE                     Controller,\r
  IN  UINTN                          NumberOfChildren,\r
  IN  EFI_HANDLE                     *ChildHandleBuffer\r
  );\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the driver.\r
\r
  This function retrieves the user readable name of a driver in the form of a\r
  Unicode string. If the driver specified by This has a user readable name in\r
  the language specified by Language, then a pointer to the driver name is\r
  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
  by This does not support the language specified by Language,\r
  then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language. This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified\r
                                in RFC 3066 or ISO 639-2 language code format.\r
\r
  @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                driver specified by This in the language\r
                                specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                This and the language specified by Language was\r
                                returned in DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by a driver.\r
\r
  This function retrieves the user readable name of the controller specified by\r
  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
  driver specified by This has a user readable name in the language specified by\r
  Language, then a pointer to the controller name is returned in ControllerName,\r
  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
  managing the controller specified by ControllerHandle and ChildHandle,\r
  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  ControllerHandle[in]  The handle of a controller that the driver\r
                                specified by This is managing.  This handle\r
                                specifies the controller whose name is to be\r
                                returned.\r
\r
  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
                                the name of.  This is an optional parameter that\r
                                may be NULL.  It will be NULL for device\r
                                drivers.  It will also be NULL for a bus drivers\r
                                that wish to retrieve the name of the bus\r
                                controller.  It will not be NULL for a bus\r
                                driver that wishes to retrieve the name of a\r
                                child controller.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language.  This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified in\r
                                RFC 3066 or ISO 639-2 language code format.\r
\r
  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                controller specified by ControllerHandle and\r
                                ChildHandle in the language specified by\r
                                Language from the point of view of the driver\r
                                specified by This.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
                                the language specified by Language for the\r
                                driver specified by This was returned in\r
                                DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TerminalComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
\r
//\r
// internal functions\r
//\r
EFI_STATUS\r
TerminalConInCheckForKey (\r
  IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This\r
  )\r
;\r
\r
VOID\r
TerminalUpdateConsoleDevVariable (\r
  IN CHAR16                    *VariableName,\r
  IN EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath\r
  )\r
;\r
\r
VOID\r
TerminalRemoveConsoleDevVariable (\r
  IN CHAR16                    *VariableName,\r
  IN EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath\r
  )\r
;\r
\r
VOID                                *\r
TerminalGetVariableAndSize (\r
  IN  CHAR16              *Name,\r
  IN  EFI_GUID            *VendorGuid,\r
  OUT UINTN               *VariableSize\r
  )\r
;\r
\r
EFI_STATUS\r
SetTerminalDevicePath (\r
  IN  UINT8                       TerminalType,\r
  IN  EFI_DEVICE_PATH_PROTOCOL    *ParentDevicePath,\r
  OUT EFI_DEVICE_PATH_PROTOCOL    **TerminalDevicePath\r
  )\r
;\r
\r
VOID\r
InitializeRawFiFo (\r
  IN  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
VOID\r
InitializeUnicodeFiFo (\r
  IN  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
VOID\r
InitializeEfiKeyFiFo (\r
  IN  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
EFI_STATUS\r
GetOneKeyFromSerial (\r
  EFI_SERIAL_IO_PROTOCOL  *SerialIo,\r
  UINT8                   *Input\r
  )\r
;\r
\r
BOOLEAN\r
RawFiFoInsertOneKey (\r
  TERMINAL_DEV  *TerminalDevice,\r
  UINT8         Input\r
  )\r
;\r
\r
BOOLEAN\r
RawFiFoRemoveOneKey (\r
  TERMINAL_DEV  *TerminalDevice,\r
  UINT8         *Output\r
  )\r
;\r
\r
BOOLEAN\r
IsRawFiFoEmpty (\r
  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
BOOLEAN\r
IsRawFiFoFull (\r
  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
BOOLEAN\r
EfiKeyFiFoInsertOneKey (\r
  TERMINAL_DEV      *TerminalDevice,\r
  EFI_INPUT_KEY     Key\r
  )\r
;\r
\r
BOOLEAN\r
EfiKeyFiFoRemoveOneKey (\r
  TERMINAL_DEV  *TerminalDevice,\r
  EFI_INPUT_KEY *Output\r
  )\r
;\r
\r
BOOLEAN\r
IsEfiKeyFiFoEmpty (\r
  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
BOOLEAN\r
IsEfiKeyFiFoFull (\r
  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
BOOLEAN\r
UnicodeFiFoInsertOneKey (\r
  TERMINAL_DEV      *TerminalDevice,\r
  UINT16            Input\r
  )\r
;\r
\r
BOOLEAN\r
UnicodeFiFoRemoveOneKey (\r
  TERMINAL_DEV  *TerminalDevice,\r
  UINT16        *Output\r
  )\r
;\r
\r
BOOLEAN\r
IsUnicodeFiFoEmpty (\r
  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
BOOLEAN\r
IsUnicodeFiFoFull (\r
  TERMINAL_DEV  *TerminalDevice\r
  )\r
;\r
\r
UINT8\r
UnicodeFiFoGetKeyCount (\r
  TERMINAL_DEV    *TerminalDevice\r
  )\r
;\r
\r
VOID\r
TranslateRawDataToEfiKey (\r
  IN  TERMINAL_DEV      *TerminalDevice\r
  )\r
;\r
\r
//\r
// internal functions for PC ANSI\r
//\r
VOID\r
AnsiRawDataToUnicode (\r
  IN  TERMINAL_DEV    *PcAnsiDevice\r
  )\r
;\r
\r
VOID\r
UnicodeToEfiKey (\r
  IN  TERMINAL_DEV    *PcAnsiDevice\r
  )\r
;\r
\r
EFI_STATUS\r
AnsiTestString (\r
  IN  TERMINAL_DEV    *TerminalDevice,\r
  IN  CHAR16          *WString\r
  )\r
;\r
\r
//\r
// internal functions for VT100\r
//\r
EFI_STATUS\r
VT100TestString (\r
  IN  TERMINAL_DEV    *VT100Device,\r
  IN  CHAR16          *WString\r
  )\r
;\r
\r
//\r
// internal functions for VT100Plus\r
//\r
EFI_STATUS\r
VT100PlusTestString (\r
  IN  TERMINAL_DEV    *TerminalDevice,\r
  IN  CHAR16          *WString\r
  )\r
;\r
\r
//\r
// internal functions for VTUTF8\r
//\r
VOID\r
VTUTF8RawDataToUnicode (\r
  IN  TERMINAL_DEV    *VtUtf8Device\r
  )\r
;\r
\r
EFI_STATUS\r
VTUTF8TestString (\r
  IN  TERMINAL_DEV    *TerminalDevice,\r
  IN  CHAR16          *WString\r
  )\r
;\r
\r
VOID\r
UnicodeToUtf8 (\r
  IN  CHAR16      Unicode,\r
  OUT UTF8_CHAR   *Utf8Char,\r
  OUT UINT8       *ValidBytes\r
  )\r
;\r
\r
VOID\r
GetOneValidUtf8Char (\r
  IN  TERMINAL_DEV      *Utf8Device,\r
  OUT UTF8_CHAR         *Utf8Char,\r
  OUT UINT8             *ValidBytes\r
  )\r
;\r
\r
VOID\r
Utf8ToUnicode (\r
  IN  UTF8_CHAR       Utf8Char,\r
  IN  UINT8           ValidBytes,\r
  OUT CHAR16          *UnicodeChar\r
  )\r
;\r
\r
//\r
// functions for boxdraw unicode\r
//\r
BOOLEAN\r
TerminalIsValidTextGraphics (\r
  IN  CHAR16  Graphic,\r
  OUT CHAR8   *PcAnsi, OPTIONAL\r
  OUT CHAR8   *Ascii OPTIONAL\r
  )\r
;\r
\r
BOOLEAN\r
TerminalIsValidAscii (\r
  IN  CHAR16  Ascii\r
  )\r
;\r
\r
BOOLEAN\r
TerminalIsValidEfiCntlChar (\r
  IN  CHAR16  CharC\r
  )\r
;\r
\r
#endif\r