[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
  VENDOR_DEVICE_PATH                  Node;\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
#define VarConsoleInpDev  L"ConInDev"\r
#define VarConsoleOutDev  L"ConOutDev"\r
#define VarErrorOutDev    L"ErrOutDev"\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gTerminalDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gTerminalComponentName;\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
EFI_STATUS\r
EFIAPI\r
TerminalComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\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
// 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
Commit	Line	Data
95276127	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	terminal.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	\r
	19	Revision History\r
	20	\r
	21	--*/\r
	22	\r
	23	#ifndef _TERMINAL_H\r
	24	#define _TERMINAL_H\r
	25	\r
97a079ed A	26	\r
	27	#include <PiDxe.h>\r
	28	#include <Protocol/SimpleTextOut.h>\r
	29	#include <Protocol/SerialIo.h>\r
	30	#include <Guid/GlobalVariable.h>\r
	31	#include <Protocol/DevicePath.h>\r
	32	#include <Protocol/SimpleTextIn.h>\r
	33	#include <Guid/HotPlugDevice.h>\r
	34	#include <Guid/PcAnsi.h>\r
	35	#include <Library/DebugLib.h>\r
	36	#include <Library/UefiDriverEntryPoint.h>\r
	37	#include <Library/UefiLib.h>\r
	38	#include <Library/ReportStatusCodeLib.h>\r
	39	#include <Library/BaseMemoryLib.h>\r
	40	#include <Library/MemoryAllocationLib.h>\r
	41	#include <Library/UefiBootServicesTableLib.h>\r
	42	#include <Library/UefiRuntimeServicesTableLib.h>\r
	43	#include <Library/DevicePathLib.h>\r
	44	#include <Library/PcdLib.h>\r
	45	\r
	46	\r
95276127	47	\r
	48	#define RAW_FIFO_MAX_NUMBER 256\r
	49	#define FIFO_MAX_NUMBER 128\r
	50	\r
	51	typedef struct {\r
	52	UINT8 Head;\r
	53	UINT8 Tail;\r
	54	UINT8 Data[RAW_FIFO_MAX_NUMBER + 1];\r
	55	} RAW_DATA_FIFO;\r
	56	\r
	57	typedef struct {\r
	58	UINT8 Head;\r
	59	UINT8 Tail;\r
	60	UINT16 Data[FIFO_MAX_NUMBER + 1];\r
	61	} UNICODE_FIFO;\r
	62	\r
	63	typedef struct {\r
	64	UINT8 Head;\r
	65	UINT8 Tail;\r
	66	EFI_INPUT_KEY Data[FIFO_MAX_NUMBER + 1];\r
	67	} EFI_KEY_FIFO;\r
	68	\r
	69	#define TERMINAL_DEV_SIGNATURE EFI_SIGNATURE_32 ('t', 'm', 'n', 'l')\r
	70	\r
	71	typedef struct {\r
	72	UINTN Signature;\r
	73	EFI_HANDLE Handle;\r
	74	UINT8 TerminalType;\r
	75	EFI_SERIAL_IO_PROTOCOL *SerialIo;\r
	76	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	77	VENDOR_DEVICE_PATH Node;\r
	78	EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleInput;\r
	79	EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;\r
	80	EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r
	81	UINTN SerialInTimeOut;\r
	82	RAW_DATA_FIFO RawFiFo;\r
	83	UNICODE_FIFO UnicodeFiFo;\r
	84	EFI_KEY_FIFO EfiKeyFiFo;\r
	85	EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
	86	EFI_EVENT TwoSecondTimeOut;\r
	87	UINT32 InputState;\r
	88	UINT32 ResetState;\r
	89	\r
	90	//\r
	91	// Esc could not be output to the screen by user,\r
	92	// but the terminal driver need to output it to\r
	93	// the terminal emulation software to send control sequence.\r
	94	// This boolean is used by the terminal driver only\r
	95	// to indicate whether the Esc could be sent or not.\r
	96	//\r
	97	BOOLEAN OutputEscChar;\r
	98	} TERMINAL_DEV;\r
	99	\r
	100	#define INPUT_STATE_DEFAULT 0x00\r
	101	#define INPUT_STATE_ESC 0x01\r
	102	#define INPUT_STATE_CSI 0x02\r
	103	#define INPUT_STATE_LEFTOPENBRACKET 0x04\r
	104	#define INPUT_STATE_O 0x08\r
	105	#define INPUT_STATE_2 0x10\r
	106	\r
	107	#define RESET_STATE_DEFAULT 0x00\r
	108	#define RESET_STATE_ESC_R 0x01\r
	109	#define RESET_STATE_ESC_R_ESC_r 0x02\r
	110	\r
111	#define TERMINAL_CON_IN_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleInput, TERMINAL_DEV_SIGNATURE)\r
112	#define TERMINAL_CON_OUT_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleTextOutput, TERMINAL_DEV_SIGNATURE)\r
113	\r
114	typedef union {\r
115	UINT8 Utf8_1;\r
116	UINT8 Utf8_2[2];\r
117	UINT8 Utf8_3[3];\r
118	} UTF8_CHAR;\r
119	\r
120	#define PcAnsiType 0\r
121	#define VT100Type 1\r
122	#define VT100PlusType 2\r
123	#define VTUTF8Type 3\r
124	\r
125	#define LEFTOPENBRACKET 0x5b // '['\r
126	#define ACAP 0x41\r
127	#define BCAP 0x42\r
128	#define CCAP 0x43\r
129	#define DCAP 0x44\r
130	\r
131	#define MODE0_COLUMN_COUNT 80\r
132	#define MODE0_ROW_COUNT 25\r
133	\r
134	#define BACKSPACE 8\r
135	#define ESC 27\r
136	#define CSI 0x9B\r
137	#define DEL 127\r
138	#define BRIGHT_CONTROL_OFFSET 2\r
139	#define FOREGROUND_CONTROL_OFFSET 6\r
140	#define BACKGROUND_CONTROL_OFFSET 11\r
141	#define ROW_OFFSET 2\r
142	#define COLUMN_OFFSET 5\r
143	\r
144	typedef struct {\r
145	UINT16 Unicode;\r
146	CHAR8 PcAnsi;\r
147	CHAR8 Ascii;\r
148	} UNICODE_TO_CHAR;\r
149	\r
150	#define VarConsoleInpDev L"ConInDev"\r
151	#define VarConsoleOutDev L"ConOutDev"\r
152	#define VarErrorOutDev L"ErrOutDev"\r
153	\r
154	//\r
155	// Global Variables\r
156	//\r
157	extern EFI_DRIVER_BINDING_PROTOCOL gTerminalDriverBinding;\r
158	extern EFI_COMPONENT_NAME_PROTOCOL gTerminalComponentName;\r
159	\r
160	//\r
161	// Prototypes\r
162	//\r
163	EFI_STATUS\r
164	EFIAPI\r
165	InitializeTerminal (\r
166	IN EFI_HANDLE ImageHandle,\r
167	IN EFI_SYSTEM_TABLE *SystemTable\r
168	)\r
169	;\r
170	\r
171	EFI_STATUS\r
172	EFIAPI\r
173	TerminalConInReset (\r
174	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
175	IN BOOLEAN ExtendedVerification\r
176	)\r
177	;\r
178	\r
179	EFI_STATUS\r
180	EFIAPI\r
181	TerminalConInReadKeyStroke (\r
182	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
183	OUT EFI_INPUT_KEY *Key\r
184	)\r
185	;\r
186	\r
187	VOID\r
188	EFIAPI\r
189	TerminalConInWaitForKey (\r
190	IN EFI_EVENT Event,\r
191	IN VOID *Context\r
192	)\r
193	;\r
194	\r
195	EFI_STATUS\r
196	EFIAPI\r
197	TerminalConOutReset (\r
198	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
199	IN BOOLEAN ExtendedVerification\r
200	)\r
201	;\r
202	\r
203	EFI_STATUS\r
204	EFIAPI\r
205	TerminalConOutOutputString (\r
206	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
207	IN CHAR16 *WString\r
208	)\r
209	;\r
210	\r
211	EFI_STATUS\r
212	EFIAPI\r
213	TerminalConOutTestString (\r
214	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
215	IN CHAR16 *WString\r
216	)\r
217	;\r
218	\r
219	EFI_STATUS\r
220	EFIAPI\r
221	TerminalConOutQueryMode (\r
222	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
223	IN UINTN ModeNumber,\r
224	OUT UINTN *Columns,\r
225	OUT UINTN *Rows\r
226	)\r
227	;\r
228	\r
229	EFI_STATUS\r
230	EFIAPI\r
231	TerminalConOutSetMode (\r
232	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
233	IN UINTN ModeNumber\r
234	)\r
235	;\r
236	\r
237	EFI_STATUS\r
238	EFIAPI\r
239	TerminalConOutSetAttribute (\r
240	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
241	IN UINTN Attribute\r
242	)\r
243	;\r
244	\r
245	EFI_STATUS\r
246	EFIAPI\r
247	TerminalConOutClearScreen (\r
248	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
249	)\r
250	;\r
251	\r
252	EFI_STATUS\r
253	EFIAPI\r
254	TerminalConOutSetCursorPosition (\r
255	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
256	IN UINTN Column,\r
257	IN UINTN Row\r
258	)\r
259	;\r
260	\r
261	EFI_STATUS\r
262	EFIAPI\r
263	TerminalConOutEnableCursor (\r
264	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
265	IN BOOLEAN Visible\r
266	)\r
267	;\r
268	\r
269	EFI_STATUS\r
270	EFIAPI\r
271	TerminalDriverBindingSupported (\r
272	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
273	IN EFI_HANDLE Controller,\r
274	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
275	);\r
276	\r
277	EFI_STATUS\r
278	EFIAPI\r
279	TerminalDriverBindingStart (\r
280	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
281	IN EFI_HANDLE Controller,\r
282	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
283	);\r
284	\r
285	EFI_STATUS\r
286	EFIAPI\r
287	TerminalDriverBindingStop (\r
288	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
289	IN EFI_HANDLE Controller,\r
290	IN UINTN NumberOfChildren,\r
291	IN EFI_HANDLE *ChildHandleBuffer\r
292	);\r
293	\r
294	EFI_STATUS\r
295	EFIAPI\r
296	TerminalComponentNameGetDriverName (\r
297	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
298	IN CHAR8 *Language,\r
299	OUT CHAR16 **DriverName\r
300	);\r
301	\r
302	EFI_STATUS\r
303	EFIAPI\r
304	TerminalComponentNameGetControllerName (\r
305	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
306	IN EFI_HANDLE ControllerHandle,\r
307	IN EFI_HANDLE ChildHandle OPTIONAL,\r
308	IN CHAR8 *Language,\r
309	OUT CHAR16 **ControllerName\r
310	);\r
311	\r
312	//\r
313	// internal functions\r
314	//\r
315	EFI_STATUS\r
316	TerminalConInCheckForKey (\r
317	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This\r
318	)\r
319	;\r
320	\r
321	VOID\r
322	TerminalUpdateConsoleDevVariable (\r
323	IN CHAR16 *VariableName,\r
324	IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath\r
325	)\r
326	;\r
327	\r
328	VOID\r
329	TerminalRemoveConsoleDevVariable (\r
330	IN CHAR16 *VariableName,\r
331	IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath\r
332	)\r
333	;\r
334	\r
335	VOID *\r
336	TerminalGetVariableAndSize (\r
337	IN CHAR16 *Name,\r
338	IN EFI_GUID *VendorGuid,\r
339	OUT UINTN *VariableSize\r
340	)\r
341	;\r
342	\r
343	EFI_STATUS\r
344	SetTerminalDevicePath (\r
345	IN UINT8 TerminalType,\r
346	IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,\r
347	OUT EFI_DEVICE_PATH_PROTOCOL **TerminalDevicePath\r
348	)\r
349	;\r
350	\r
351	VOID\r
352	InitializeRawFiFo (\r
353	IN TERMINAL_DEV *TerminalDevice\r
354	)\r
355	;\r
356	\r
357	VOID\r
358	InitializeUnicodeFiFo (\r
359	IN TERMINAL_DEV *TerminalDevice\r
360	)\r
361	;\r
362	\r
363	VOID\r
364	InitializeEfiKeyFiFo (\r
365	IN TERMINAL_DEV *TerminalDevice\r
366	)\r
367	;\r
368	\r
369	EFI_STATUS\r
370	GetOneKeyFromSerial (\r
371	EFI_SERIAL_IO_PROTOCOL *SerialIo,\r
372	UINT8 *Input\r
373	)\r
374	;\r
375	\r
376	BOOLEAN\r
377	RawFiFoInsertOneKey (\r
378	TERMINAL_DEV *TerminalDevice,\r
379	UINT8 Input\r
380	)\r
381	;\r
382	\r
383	BOOLEAN\r
384	RawFiFoRemoveOneKey (\r
385	TERMINAL_DEV *TerminalDevice,\r
386	UINT8 *Output\r
387	)\r
388	;\r
389	\r
390	BOOLEAN\r
391	IsRawFiFoEmpty (\r
392	TERMINAL_DEV *TerminalDevice\r
393	)\r
394	;\r
395	\r
396	BOOLEAN\r
397	IsRawFiFoFull (\r
398	TERMINAL_DEV *TerminalDevice\r
399	)\r
400	;\r
401	\r
402	BOOLEAN\r
403	EfiKeyFiFoInsertOneKey (\r
404	TERMINAL_DEV *TerminalDevice,\r
405	EFI_INPUT_KEY Key\r
406	)\r
407	;\r
408	\r
409	BOOLEAN\r
410	EfiKeyFiFoRemoveOneKey (\r
411	TERMINAL_DEV *TerminalDevice,\r
412	EFI_INPUT_KEY *Output\r
413	)\r
414	;\r
415	\r
416	BOOLEAN\r
417	IsEfiKeyFiFoEmpty (\r
418	TERMINAL_DEV *TerminalDevice\r
419	)\r
420	;\r
421	\r
422	BOOLEAN\r
423	IsEfiKeyFiFoFull (\r
424	TERMINAL_DEV *TerminalDevice\r
425	)\r
426	;\r
427	\r
428	BOOLEAN\r
429	UnicodeFiFoInsertOneKey (\r
430	TERMINAL_DEV *TerminalDevice,\r
431	UINT16 Input\r
432	)\r
433	;\r
434	\r
435	BOOLEAN\r
436	UnicodeFiFoRemoveOneKey (\r
437	TERMINAL_DEV *TerminalDevice,\r
438	UINT16 *Output\r
439	)\r
440	;\r
441	\r
442	BOOLEAN\r
443	IsUnicodeFiFoEmpty (\r
444	TERMINAL_DEV *TerminalDevice\r
445	)\r
446	;\r
447	\r
448	BOOLEAN\r
449	IsUnicodeFiFoFull (\r
450	TERMINAL_DEV *TerminalDevice\r
451	)\r
452	;\r
453	\r
454	UINT8\r
455	UnicodeFiFoGetKeyCount (\r
456	TERMINAL_DEV *TerminalDevice\r
457	)\r
458	;\r
459	\r
460	VOID\r
461	TranslateRawDataToEfiKey (\r
462	IN TERMINAL_DEV *TerminalDevice\r
463	)\r
464	;\r
465	\r
466	//\r
467	// internal functions for PC ANSI\r
468	//\r
469	VOID\r
470	AnsiRawDataToUnicode (\r
471	IN TERMINAL_DEV *PcAnsiDevice\r
472	)\r
473	;\r
474	\r
475	VOID\r
476	UnicodeToEfiKey (\r
477	IN TERMINAL_DEV *PcAnsiDevice\r
478	)\r
479	;\r
480	\r
481	EFI_STATUS\r
482	AnsiTestString (\r
483	IN TERMINAL_DEV *TerminalDevice,\r
484	IN CHAR16 *WString\r
485	)\r
486	;\r
487	\r
488	//\r
489	// internal functions for VT100\r
490	//\r
491	EFI_STATUS\r
492	VT100TestString (\r
493	IN TERMINAL_DEV *VT100Device,\r
494	IN CHAR16 *WString\r
495	)\r
496	;\r
497	\r
498	//\r
499	// internal functions for VT100Plus\r
500	//\r
501	EFI_STATUS\r
502	VT100PlusTestString (\r
503	IN TERMINAL_DEV *TerminalDevice,\r
504	IN CHAR16 *WString\r
505	)\r
506	;\r
507	\r
508	//\r
509	// internal functions for VTUTF8\r
510	//\r
511	VOID\r
512	VTUTF8RawDataToUnicode (\r
513	IN TERMINAL_DEV *VtUtf8Device\r
514	)\r
515	;\r
516	\r
517	EFI_STATUS\r
518	VTUTF8TestString (\r
519	IN TERMINAL_DEV *TerminalDevice,\r
520	IN CHAR16 *WString\r
521	)\r
522	;\r
523	\r
524	VOID\r
525	UnicodeToUtf8 (\r
526	IN CHAR16 Unicode,\r
527	OUT UTF8_CHAR *Utf8Char,\r
528	OUT UINT8 *ValidBytes\r
529	)\r
530	;\r
531	\r
532	VOID\r
533	GetOneValidUtf8Char (\r
534	IN TERMINAL_DEV *Utf8Device,\r
535	OUT UTF8_CHAR *Utf8Char,\r
536	OUT UINT8 *ValidBytes\r
537	)\r
538	;\r
539	\r
540	VOID\r
541	Utf8ToUnicode (\r
542	IN UTF8_CHAR Utf8Char,\r
543	IN UINT8 ValidBytes,\r
544	OUT CHAR16 *UnicodeChar\r
545	)\r
546	;\r
547	\r
548	//\r
549	// functions for boxdraw unicode\r
550	//\r
551	BOOLEAN\r
552	TerminalIsValidTextGraphics (\r
553	IN CHAR16 Graphic,\r
554	OUT CHAR8 *PcAnsi, OPTIONAL\r
555	OUT CHAR8 *Ascii OPTIONAL\r
556	)\r
557	;\r
558	\r
559	BOOLEAN\r
560	TerminalIsValidAscii (\r
561	IN CHAR16 Ascii\r
562	)\r
563	;\r
564	\r
565	BOOLEAN\r
566	TerminalIsValidEfiCntlChar (\r
567	IN CHAR16 CharC\r
568	)\r
569	;\r
570	\r
571	#endif\r