/** @file\r
Implementation for EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL protocol.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+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
// ASCII. The ASCII mapping we just made up.\r
//\r
//\r
-STATIC UNICODE_TO_CHAR UnicodeToPcAnsiOrAscii[] = {\r
+UNICODE_TO_CHAR UnicodeToPcAnsiOrAscii[] = {\r
{ BOXDRAW_HORIZONTAL, 0xc4, L'-' },\r
{ BOXDRAW_VERTICAL, 0xb3, L'|' },\r
{ BOXDRAW_DOWN_RIGHT, 0xda, L'/' },\r
{ GEOMETRICSHAPE_DOWN_TRIANGLE, 0x1f, L'v' },\r
{ GEOMETRICSHAPE_LEFT_TRIANGLE, 0x11, L'<' },\r
\r
- { ARROW_LEFT, 0x3c, L'<' },\r
- { ARROW_UP, 0x18, L'^' },\r
- { ARROW_RIGHT, 0x3e, L'>' },\r
- { ARROW_DOWN, 0x19, L'v' },\r
+ { ARROW_LEFT, 0x3c, L'<' },\r
+ { ARROW_UP, 0x18, L'^' },\r
+ { ARROW_RIGHT, 0x3e, L'>' },\r
+ { ARROW_DOWN, 0x19, L'v' },\r
\r
{ 0x0000, 0x00, L'\0' }\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
exhaustive verification operation of the device\r
during reset.\r
\r
- @return EFI_SUCCESS\r
- @return The reset operation succeeds.\r
- @return EFI_DEVICE_ERROR\r
- @return The terminal is not functioning correctly or the serial port reset fails.\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
//\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueRemoteConsoleReset),\r
+ (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_PC_RESET),\r
TerminalDevice->DevicePath\r
);\r
\r
//\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueRemoteConsoleError),\r
+ (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_CONTROLLER_ERROR),\r
TerminalDevice->DevicePath\r
);\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 WString The Null-terminated Unicode string to be displayed\r
on the terminal screen.\r
\r
- @return EFI_SUCCESS The string is output successfully.\r
- @return EFI_DEVICE_ERROR The serial port fails to send the string out.\r
- @return EFI_WARN_UNKNOWN_GLYPH Indicates that some of the characters in the Unicode string could not\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
- @return EFI_UNSUPPORTED\r
+ @retval EFI_UNSUPPORTED If current display mode is out of range.\r
\r
**/\r
EFI_STATUS\r
\r
ValidBytes = 0;\r
Warning = FALSE;\r
+ AsciiChar = 0;\r
\r
//\r
// get Terminal device data structure pointer.\r
//\r
Mode = This->Mode;\r
\r
- if (Mode->Mode > 2) {\r
+ if (Mode->Mode >= TERMINAL_MAX_MODE) {\r
return EFI_UNSUPPORTED;\r
}\r
\r
OutputError:\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueRemoteConsoleOutputError),\r
+ (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_OUTPUT_ERROR),\r
TerminalDevice->DevicePath\r
);\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
@param This Indicates the calling context.\r
@param WString The Null-terminated Unicode string to be tested.\r
\r
- @return EFI_SUCCESS The terminal is capable of rendering the output string.\r
- @return EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.\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
\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
In this driver, we support text mode 80x25 (mode 0),\r
@param Columns The returned columns of the requested mode.\r
@param Rows The returned rows of the requested mode.\r
\r
- @return EFI_SUCCESS The requested mode information is returned.\r
- @return EFI_UNSUPPORTED The mode number is not valid.\r
- @return EFI_DEVICE_ERROR\r
+ @retval EFI_SUCCESS The requested mode information is returned.\r
+ @retval EFI_UNSUPPORTED The mode number is not valid.\r
+ @retval EFI_DEVICE_ERROR\r
\r
**/\r
EFI_STATUS\r
OUT UINTN *Rows\r
)\r
{\r
- if (This->Mode->MaxMode > 3) {\r
+ if (This->Mode->MaxMode > TERMINAL_MAX_MODE) {\r
return EFI_DEVICE_ERROR;\r
}\r
\r
*Columns = MODE2_COLUMN_COUNT;\r
*Rows = MODE2_ROW_COUNT;\r
return EFI_SUCCESS;\r
+ } else if (ModeNumber == 3) {\r
+ *Columns = (UINTN) PcdGet32 (PcdConOutColumn);\r
+ if (*Columns == 0) {\r
+ *Columns = MODE0_COLUMN_COUNT;\r
+ }\r
+ *Rows = (UINTN) PcdGet32 (PcdConOutRow);\r
+ if (*Rows == 0) {\r
+ *Rows = MODE0_ROW_COUNT;\r
+ }\r
+ return EFI_SUCCESS;\r
}\r
\r
return EFI_UNSUPPORTED;\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
- @return EFI_SUCCESS The requested text mode is set.\r
- @return EFI_DEVICE_ERROR The requested text mode cannot be set \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
- @return EFI_UNSUPPORTED The text mode number is not valid.\r
+ @retval EFI_UNSUPPORTED The text mode number is not valid.\r
\r
**/\r
EFI_STATUS\r
//\r
TerminalDevice = TERMINAL_CON_OUT_DEV_FROM_THIS (This);\r
\r
- if (ModeNumber > 2) {\r
+ if (ModeNumber >= TERMINAL_MAX_MODE) {\r
return EFI_UNSUPPORTED;\r
}\r
\r
@param Attribute The attribute to set. Only bit0..6 are valid, all other bits\r
are undefined and must be zero.\r
\r
- @return EFI_SUCCESS The requested attribute is set.\r
- @return EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.\r
- @return EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.\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
\r
//\r
// Skip outputting the command string for the same attribute\r
- // It improves the terminal performance siginificantly\r
+ // It improves the terminal performance significantly\r
//\r
if (This->Mode->Attribute == (INT32) Attribute) {\r
return EFI_SUCCESS;\r
\r
@param This Indicates the calling context.\r
\r
- @return EFI_SUCCESS The operation completed successfully.\r
- @return EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.\r
- @return EFI_UNSUPPORTED The terminal is not in a valid display mode.\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
@param Column The row to set cursor to.\r
@param Row The column to set cursor to.\r
\r
- @return EFI_SUCCESS The operation completed successfully.\r
- @return EFI_DEVICE_ERROR The request fails due to serial port error.\r
- @return EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position\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
\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
- @return EFI_SUCCESS The request is valid.\r
- @return EFI_UNSUPPORTED The terminal does not support cursor hidden.\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
@param Ascii Optional pointer to return ASCII equivalent of\r
Graphic.\r
\r
- @return TRUE If Graphic is a supported Unicode Box Drawing character.\r
+ @retval TRUE If Graphic is a supported Unicode Box Drawing character.\r
\r
**/\r
BOOLEAN\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
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
projects / mirror_edk2.git / blobdiff