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