tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clean codes per ECC for TerminalDxe module. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5389 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff 2008-07-01 06:34:04 +00:00
parent ede2f5b299
commit e49ef4337f
5 changed files with 1104 additions and 906 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

179
MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c
View File

@ -16,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include "Terminal.h"
STATIC
EFI_STATUS
TerminalFreeNotifyList (
IN OUT LIST_ENTRY *ListHead
@ -209,6 +208,19 @@ TerminalDriverBindingSupported (
return Status;
}
/**
Start the controller.
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL
instance.
@param Controller The handle of the controller to start.
@param RemainingDevicePath A pointer to the remaining portion of a devcie
path.
@return EFI_SUCCESS.
**/
EFI_STATUS
EFIAPI
TerminalDriverBindingStart (
@ -216,23 +228,6 @@ TerminalDriverBindingStart (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
Start the controller.
Arguments:
This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - The handle of the controller to start.
RemainingDevicePath - A pointer to the remaining portion of a devcie path.
Returns:
EFI_SUCCESS.
--*/
{
EFI_STATUS Status;
EFI_SERIAL_IO_PROTOCOL *SerialIo;
@ -358,8 +353,8 @@ TerminalDriverBindingStart (
}
TerminalType = FixedPcdGet8 (PcdDefaultTerminalType);
// must be between PcAnsiType (0) and VTUTF8Type (3)
ASSERT (TerminalType <= VTUTF8Type);
// must be between PCANSITYPE (0) and VTUTF8TYPE (3)
ASSERT (TerminalType <= VTUTF8TYPE);
CopyMem (&DefaultNode->Guid, gTerminalType[TerminalType], sizeof (EFI_GUID));
RemainingDevicePath = (EFI_DEVICE_PATH_PROTOCOL*)DefaultNode;
@ -369,13 +364,13 @@ TerminalDriverBindingStart (
//
Node = (VENDOR_DEVICE_PATH *)RemainingDevicePath;
if (CompareGuid (&Node->Guid, &gEfiPcAnsiGuid)) {
TerminalType = PcAnsiType;
TerminalType = PCANSITYPE;
} else if (CompareGuid (&Node->Guid, &gEfiVT100Guid)) {
TerminalType = VT100Type;
TerminalType = VT100TYPE;
} else if (CompareGuid (&Node->Guid, &gEfiVT100PlusGuid)) {
TerminalType = VT100PlusType;
TerminalType = VT100PLUSTYPE;
} else if (CompareGuid (&Node->Guid, &gEfiVTUTF8Guid)) {
TerminalType = VTUTF8Type;
TerminalType = VTUTF8TYPE;
} else {
goto Error;
}
@ -544,7 +539,7 @@ TerminalDriverBindingStart (
//
TerminalDevice->ControllerNameTable = NULL;
switch (TerminalDevice->TerminalType) {
case PcAnsiType:
case PCANSITYPE:
AddUnicodeString2 (
"eng",
gTerminalComponentName.SupportedLanguages,
@ -562,7 +557,7 @@ TerminalDriverBindingStart (
break;
case VT100Type:
case VT100TYPE:
AddUnicodeString2 (
"eng",
gTerminalComponentName.SupportedLanguages,
@ -580,7 +575,7 @@ TerminalDriverBindingStart (
break;
case VT100PlusType:
case VT100PLUSTYPE:
AddUnicodeString2 (
"eng",
gTerminalComponentName.SupportedLanguages,
@ -598,7 +593,7 @@ TerminalDriverBindingStart (
break;
case VTUTF8Type:
case VTUTF8TYPE:
AddUnicodeString2 (
"eng",
gTerminalComponentName.SupportedLanguages,
@ -731,6 +726,21 @@ Error:
return Status;
}
/**
Stop a device controller.
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL
instance.
@param Controller A handle to the device being stopped.
@param NumberOfChildren The number of child device handles in
ChildHandleBuffer.
@param ChildHandleBuffer An array of child handles to be freed.
@retval EFI_SUCCESS Operation successful.
@retval EFI_DEVICE_ERROR Devices error.
**/
EFI_STATUS
EFIAPI
TerminalDriverBindingStop (
@ -739,25 +749,6 @@ TerminalDriverBindingStop (
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
)
/*++
Routine Description:
Stop a device controller.
Arguments:
This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - A handle to the device being stopped.
NumberOfChildren - The number of child device handles in ChildHandleBuffer.
ChildHandleBuffer - An array of child handles to be freed.
Returns:
EFI_SUCCESS - Operation successful.
EFI_DEVICE_ERROR - Devices error.
--*/
{
EFI_STATUS Status;
UINTN Index;
@ -927,25 +918,19 @@ TerminalDriverBindingStop (
return EFI_SUCCESS;
}
STATIC
/**
@param ListHead The list head
@retval EFI_SUCCESS Free the notify list successfully
@retval EFI_INVALID_PARAMETER ListHead is invalid.
**/
EFI_STATUS
TerminalFreeNotifyList (
IN OUT LIST_ENTRY *ListHead
)
/*++
Routine Description:
Arguments:
ListHead - The list head
Returns:
EFI_SUCCESS - Free the notify list successfully
EFI_INVALID_PARAMETER - ListHead is invalid.
--*/
{
TERMINAL_CONSOLE_IN_EX_NOTIFY *NotifyNode;
@ -994,7 +979,7 @@ TerminalUpdateConsoleDevVariable (
//
// Append terminal device path onto the variable.
//
for (TerminalType = PcAnsiType; TerminalType <= VTUTF8Type; TerminalType++) {
for (TerminalType = PCANSITYPE; TerminalType <= VTUTF8TYPE; TerminalType++) {
SetTerminalDevicePath (TerminalType, ParentDevicePath, &TempDevicePath);
NewVariable = AppendDevicePathInstance (Variable, TempDevicePath);
if (Variable != NULL) {
@ -1023,25 +1008,21 @@ TerminalUpdateConsoleDevVariable (
return ;
}
/**
Remove console device variable.
@param VariableName A pointer to the variable name.
@param ParentDevicePath A pointer to the parent device path.
@return None.
**/
VOID
TerminalRemoveConsoleDevVariable (
IN CHAR16 *VariableName,
IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath
)
/*++
Routine Description:
Remove console device variable.
Arguments:
VariableName - A pointer to the variable name.
ParentDevicePath - A pointer to the parent device path.
Returns:
--*/
{
EFI_STATUS Status;
BOOLEAN FoundOne;
@ -1091,7 +1072,7 @@ TerminalRemoveConsoleDevVariable (
// Loop through all the terminal types that this driver supports
//
Match = FALSE;
for (TerminalType = PcAnsiType; TerminalType <= VTUTF8Type; TerminalType++) {
for (TerminalType = PCANSITYPE; TerminalType <= VTUTF8TYPE; TerminalType++) {
SetTerminalDevicePath (TerminalType, ParentDevicePath, &TempDevicePath);
@ -1146,32 +1127,26 @@ TerminalRemoveConsoleDevVariable (
return ;
}
/**
Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
buffer, and the size of the buffer. On failure return NULL.
@param Name String part of EFI variable name
@param VendorGuid GUID part of EFI variable name
@param VariableSize Returns the size of the EFI variable that was read
@return Dynamically allocated memory that contains a copy of the EFI variable.
@return Caller is repsoncible freeing the buffer.
@retval NULL Variable was not read
**/
VOID *
TerminalGetVariableAndSize (
IN CHAR16 *Name,
IN EFI_GUID *VendorGuid,
OUT UINTN *VariableSize
)
/*++
Routine Description:
Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
buffer, and the size of the buffer. On failure return NULL.
Arguments:
Name - String part of EFI variable name
VendorGuid - GUID part of EFI variable name
VariableSize - Returns the size of the EFI variable that was read
Returns:
Dynamically allocated memory that contains a copy of the EFI variable.
Caller is repsoncible freeing the buffer.
NULL - Variable was not read
--*/
{
EFI_STATUS Status;
UINTN BufferSize;
@ -1245,7 +1220,7 @@ SetTerminalDevicePath (
//
switch (TerminalType) {
case PcAnsiType:
case PCANSITYPE:
CopyMem (
&Node.Guid,
&gEfiPcAnsiGuid,
@ -1253,7 +1228,7 @@ SetTerminalDevicePath (
);
break;
case VT100Type:
case VT100TYPE:
CopyMem (
&Node.Guid,
&gEfiVT100Guid,
@ -1261,7 +1236,7 @@ SetTerminalDevicePath (
);
break;
case VT100PlusType:
case VT100PLUSTYPE:
CopyMem (
&Node.Guid,
&gEfiVT100PlusGuid,
@ -1269,7 +1244,7 @@ SetTerminalDevicePath (
);
break;
case VTUTF8Type:
case VTUTF8TYPE:
CopyMem (
&Node.Guid,
&gEfiVTUTF8Guid,

578
MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
View File

@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _TERMINAL_H
#define _TERMINAL_H
#ifndef _TERMINAL_H_
#define _TERMINAL_H_
#include <PiDxe.h>
@ -121,10 +121,10 @@ typedef union {
UINT8 Utf8_3[3];
} UTF8_CHAR;
#define PcAnsiType 0
#define VT100Type 1
#define VT100PlusType 2
#define VTUTF8Type 3
#define PCANSITYPE 0
#define VT100TYPE 1
#define VT100PLUSTYPE 2
#define VTUTF8TYPE 3
#define LEFTOPENBRACKET 0x5b // '['
#define ACAP 0x41
@ -165,9 +165,17 @@ extern EFI_COMPONENT_NAME_PROTOCOL gTerminalComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gTerminalComponentName2;
extern EFI_GUID gSimpleTextInExNotifyGuid;
//
// Prototypes
//
/**
The user Entry Point for module Terminal. The user code starts with this function.
@param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
@retval other Some error occurs when executing this entry point.
**/
EFI_STATUS
EFIAPI
InitializeTerminal (
@ -176,6 +184,20 @@ InitializeTerminal (
)
;
/**
Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.Reset().
This driver only perform dependent serial device reset regardless of
the value of ExtendeVerification
@param This Indicates the calling context.
@param ExtendedVerification Skip by this driver.
@return EFI_SUCCESS
@return The reset operation succeeds.
@return EFI_DEVICE_ERROR
@return The dependent serial port reset fails.
**/
EFI_STATUS
EFIAPI
TerminalConInReset (
@ -184,6 +206,23 @@ TerminalConInReset (
)
;
/**
Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
@param This Indicates the calling context.
@param Key A pointer to a buffer that is filled in with the
keystroke information for the key that was sent
from terminal.
@return EFI_SUCCESS
@return The keystroke information is returned successfully.
@return EFI_NOT_READY
@return There is no keystroke data available.
@return EFI_DEVICE_ERROR
@return The dependent serial device encounters error.
**/
EFI_STATUS
EFIAPI
TerminalConInReadKeyStroke (
@ -193,29 +232,36 @@ TerminalConInReadKeyStroke (
;
/**
@param RegsiteredData A pointer to a buffer that is filled in with the
keystroke state data for the key that was
registered.
@param InputData A pointer to a buffer that is filled in with the
keystroke state data for the key that was
pressed.
@retval TRUE Key be pressed matches a registered key.
@retval FLASE Match failed.
**/
BOOLEAN
IsKeyRegistered (
IN EFI_KEY_DATA *RegsiteredData,
IN EFI_KEY_DATA *InputData
)
/*++
Routine Description:
Arguments:
RegsiteredData - A pointer to a buffer that is filled in with the keystroke
state data for the key that was registered.
InputData - A pointer to a buffer that is filled in with the keystroke
state data for the key that was pressed.
Returns:
TRUE - Key be pressed matches a registered key.
FLASE - Match failed.
--*/
;
/**
Event notification function for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
Signal the event if there is key available
@param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
@return none.
**/
VOID
EFIAPI
TerminalConInWaitForKeyEx (
@ -223,86 +269,96 @@ TerminalConInWaitForKeyEx (
IN VOID *Context
)
;
//
// Simple Text Input Ex protocol prototypes
//
/**
Reset the input device and optionaly run diagnostics
@param This Protocol instance pointer.
@param ExtendedVerification Driver may perform diagnostics on reset.
@retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
not be reset.
**/
EFI_STATUS
EFIAPI
TerminalConInResetEx (
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
)
/*++
Routine Description:
Reset the input device and optionaly run diagnostics
Arguments:
This - Protocol instance pointer.
ExtendedVerification - Driver may perform diagnostics on reset.
Returns:
EFI_SUCCESS - The device was reset.
EFI_DEVICE_ERROR - The device is not functioning properly and could
not be reset.
--*/
;
/**
Reads the next keystroke from the input device. The WaitForKey Event can
be used to test for existance of a keystroke via WaitForEvent () call.
@param This Protocol instance pointer.
@param KeyData A pointer to a buffer that is filled in with the
keystroke state data for the key that was
pressed.
@retval EFI_SUCCESS The keystroke information was returned.
@retval EFI_NOT_READY There was no keystroke data availiable.
@retval EFI_DEVICE_ERROR The keystroke information was not returned due
to hardware errors.
@retval EFI_INVALID_PARAMETER KeyData is NULL.
**/
EFI_STATUS
EFIAPI
TerminalConInReadKeyStrokeEx (
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
OUT EFI_KEY_DATA *KeyData
)
/*++
Routine Description:
Reads the next keystroke from the input device. The WaitForKey Event can
be used to test for existance of a keystroke via WaitForEvent () call.
Arguments:
This - Protocol instance pointer.
KeyData - A pointer to a buffer that is filled in with the keystroke
state data for the key that was pressed.
Returns:
EFI_SUCCESS - The keystroke information was returned.
EFI_NOT_READY - There was no keystroke data availiable.
EFI_DEVICE_ERROR - The keystroke information was not returned due to
hardware errors.
EFI_INVALID_PARAMETER - KeyData is NULL.
--*/
;
/**
Set certain state for the input device.
@param This Protocol instance pointer.
@param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
state for the input device.
@retval EFI_SUCCESS The device state was set successfully.
@retval EFI_DEVICE_ERROR The device is not functioning correctly and
could not have the setting adjusted.
@retval EFI_UNSUPPORTED The device does not have the ability to set its
state.
@retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
**/
EFI_STATUS
EFIAPI
TerminalConInSetState (
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
IN EFI_KEY_TOGGLE_STATE *KeyToggleState
)
/*++
Routine Description:
Set certain state for the input device.
Arguments:
This - Protocol instance pointer.
KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the
state for the input device.
Returns:
EFI_SUCCESS - The device state was set successfully.
EFI_DEVICE_ERROR - The device is not functioning correctly and could
not have the setting adjusted.
EFI_UNSUPPORTED - The device does not have the ability to set its state.
EFI_INVALID_PARAMETER - KeyToggleState is NULL.
--*/
;
/**
Register a notification function for a particular keystroke for the input device.
@param This Protocol instance pointer.
@param KeyData A pointer to a buffer that is filled in with the
keystroke information data for the key that was
pressed.
@param KeyNotificationFunction Points to the function to be called when the key
sequence is typed specified by KeyData.
@param NotifyHandle Points to the unique handle assigned to the
registered notification.
@retval EFI_SUCCESS The notification function was registered
successfully.
@retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data
structures.
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.
**/
EFI_STATUS
EFIAPI
TerminalConInRegisterKeyNotify (
@ -311,50 +367,39 @@ TerminalConInRegisterKeyNotify (
IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,
OUT EFI_HANDLE *NotifyHandle
)
/*++
Routine Description:
Register a notification function for a particular keystroke for the input device.
Arguments:
This - Protocol instance pointer.
KeyData - A pointer to a buffer that is filled in with the keystroke
information data for the key that was pressed.
KeyNotificationFunction - Points to the function to be called when the key
sequence is typed specified by KeyData.
NotifyHandle - Points to the unique handle assigned to the registered notification.
Returns:
EFI_SUCCESS - The notification function was registered successfully.
EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.
EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL.
--*/
;
/**
Remove a registered notification function from a particular keystroke.
@param This Protocol instance pointer.
@param NotificationHandle The handle of the notification function being
unregistered.
@retval EFI_SUCCESS The notification function was unregistered
successfully.
@retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
@retval EFI_NOT_FOUND Can not find the matching entry in database.
**/
EFI_STATUS
EFIAPI
TerminalConInUnregisterKeyNotify (
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
IN EFI_HANDLE NotificationHandle
)
/*++
Routine Description:
Remove a registered notification function from a particular keystroke.
Arguments:
This - Protocol instance pointer.
NotificationHandle - The handle of the notification function being unregistered.
Returns:
EFI_SUCCESS - The notification function was unregistered successfully.
EFI_INVALID_PARAMETER - The NotificationHandle is invalid.
EFI_NOT_FOUND - Can not find the matching entry in database.
--*/
;
/**
Event notification function for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey event
Signal the event if there is key available
@param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
@return None
**/
VOID
EFIAPI
TerminalConInWaitForKey (
@ -363,6 +408,23 @@ TerminalConInWaitForKey (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().
If ExtendeVerification is TRUE, then perform dependent serial device reset,
and set display mode to mode 0.
If ExtendedVerification is FALSE, only set display mode to mode 0.
@param This Indicates the calling context.
@param ExtendedVerification Indicates that the driver may perform a more
exhaustive verification operation of the device
during reset.
@return EFI_SUCCESS
@return The reset operation succeeds.
@return EFI_DEVICE_ERROR
@return The terminal is not functioning correctly or the serial port reset fails.
**/
EFI_STATUS
EFIAPI
TerminalConOutReset (
@ -371,6 +433,22 @@ TerminalConOutReset (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().
The Unicode string will be converted to terminal expressible data stream
and send to terminal via serial port.
@param This Indicates the calling context.
@param WString The Null-terminated Unicode string to be displayed
on the terminal screen.
@return EFI_SUCCESS The string is output successfully.
@return EFI_DEVICE_ERROR The serial port fails to send the string out.
@return EFI_WARN_UNKNOWN_GLYPH Indicates that some of the characters in the Unicode string could not
be rendered and are skipped.
@return EFI_UNSUPPORTED
**/
EFI_STATUS
EFIAPI
TerminalConOutOutputString (
@ -379,6 +457,20 @@ TerminalConOutOutputString (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().
If one of the characters in the *Wstring is
neither valid Unicode drawing characters,
not ASCII code, then this function will return
EFI_UNSUPPORTED.
@param This Indicates the calling context.
@param WString The Null-terminated Unicode string to be tested.
@return EFI_SUCCESS The terminal is capable of rendering the output string.
@return EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.
**/
EFI_STATUS
EFIAPI
TerminalConOutTestString (
@ -387,6 +479,23 @@ TerminalConOutTestString (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().
It returns information for an available text mode
that the terminal supports.
In this driver, we support text mode 80x25 (mode 0),
80x50 (mode 1), 100x31 (mode 2).
@param This Indicates the calling context.
@param ModeNumber The mode number to return information on.
@param Columns The returned columns of the requested mode.
@param Rows The returned rows of the requested mode.
@return EFI_SUCCESS The requested mode information is returned.
@return EFI_UNSUPPORTED The mode number is not valid.
@return EFI_DEVICE_ERROR
**/
EFI_STATUS
EFIAPI
TerminalConOutQueryMode (
@ -397,6 +506,20 @@ TerminalConOutQueryMode (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUT.SetMode().
Set the terminal to a specified display mode.
In this driver, we only support mode 0.
@param This Indicates the calling context.
@param ModeNumber The text mode to set.
@return EFI_SUCCESS The requested text mode is set.
@return EFI_DEVICE_ERROR The requested text mode cannot be set
because of serial device error.
@return EFI_UNSUPPORTED The text mode number is not valid.
**/
EFI_STATUS
EFIAPI
TerminalConOutSetMode (
@ -405,6 +528,18 @@ TerminalConOutSetMode (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().
@param This Indicates the calling context.
@param Attribute The attribute to set. Only bit0..6 are valid, all other bits
are undefined and must be zero.
@return EFI_SUCCESS The requested attribute is set.
@return EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.
@return EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
**/
EFI_STATUS
EFIAPI
TerminalConOutSetAttribute (
@ -413,6 +548,18 @@ TerminalConOutSetAttribute (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().
It clears the ANSI terminal's display to the
currently selected background color.
@param This Indicates the calling context.
@return EFI_SUCCESS The operation completed successfully.
@return EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.
@return EFI_UNSUPPORTED The terminal is not in a valid display mode.
**/
EFI_STATUS
EFIAPI
TerminalConOutClearScreen (
@ -420,6 +567,19 @@ TerminalConOutClearScreen (
)
;
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().
@param This Indicates the calling context.
@param Column The row to set cursor to.
@param Row The column to set cursor to.
@return EFI_SUCCESS The operation completed successfully.
@return EFI_DEVICE_ERROR The request fails due to serial port error.
@return EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position
is invalid for current mode.
**/
EFI_STATUS
EFIAPI
TerminalConOutSetCursorPosition (
@ -429,6 +589,18 @@ TerminalConOutSetCursorPosition (
)
;
/**
Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
In this driver, the cursor cannot be hidden.
@param This Indicates the calling context.
@param Visible If TRUE, the cursor is set to be visible,
If FALSE, the cursor is set to be invisible.
@return EFI_SUCCESS The request is valid.
@return EFI_UNSUPPORTED The terminal does not support cursor hidden.
**/
EFI_STATUS
EFIAPI
TerminalConOutEnableCursor (
@ -592,6 +764,19 @@ TerminalComponentNameGetControllerName (
//
// internal functions
//
/**
Check for a pending key in the Efi Key FIFO or Serial device buffer.
@param This Indicates the calling context.
@return EFI_SUCCESS
@return There is key pending.
@return EFI_NOT_READY
@return There is no key pending.
@return EFI_DEVICE_ERROR
**/
EFI_STATUS
TerminalConInCheckForKey (
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This
@ -605,6 +790,15 @@ TerminalUpdateConsoleDevVariable (
)
;
/**
Remove console device variable.
@param VariableName A pointer to the variable name.
@param ParentDevicePath A pointer to the parent device path.
@return None.
**/
VOID
TerminalRemoveConsoleDevVariable (
IN CHAR16 *VariableName,
@ -612,6 +806,19 @@ TerminalRemoveConsoleDevVariable (
)
;
/**
Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
buffer, and the size of the buffer. On failure return NULL.
@param Name String part of EFI variable name
@param VendorGuid GUID part of EFI variable name
@param VariableSize Returns the size of the EFI variable that was read
@return Dynamically allocated memory that contains a copy of the EFI variable.
@return Caller is repsoncible freeing the buffer.
@retval NULL Variable was not read
**/
VOID *
TerminalGetVariableAndSize (
IN CHAR16 *Name,
@ -646,6 +853,18 @@ InitializeEfiKeyFiFo (
)
;
/**
Get one key out of serial buffer.
@param SerialIo Serial I/O protocl attached to the serial device.
@param Input The fetched key.
@return EFI_NOT_READY If serial buffer is empty.
@return EFI_DEVICE_ERROR If reading serial buffer encounter error.
@return EFI_SUCCESS If reading serial buffer successfully, put
the fetched key to the parameter output.
**/
EFI_STATUS
GetOneKeyFromSerial (
EFI_SERIAL_IO_PROTOCOL *SerialIo,
@ -653,6 +872,17 @@ GetOneKeyFromSerial (
)
;
/**
Insert one byte raw data into the Raw Data FIFO.
@param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
@return TRUE If insert successfully.
@return FLASE If Raw Data buffer is full before key insertion,
and the key is lost.
**/
BOOLEAN
RawFiFoInsertOneKey (
TERMINAL_DEV *TerminalDevice,
@ -660,6 +890,16 @@ RawFiFoInsertOneKey (
)
;
/**
Remove one pre-fetched key out of the Raw Data FIFO.
@param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
@return TRUE If insert successfully.
@return FLASE If Raw Data FIFO buffer is empty before remove operation.
**/
BOOLEAN
RawFiFoRemoveOneKey (
TERMINAL_DEV *TerminalDevice,
@ -667,18 +907,47 @@ RawFiFoRemoveOneKey (
)
;
/**
Clarify whether Raw Data FIFO buffer is empty.
@param TerminalDevice Terminal driver private structure
@return TRUE If Raw Data FIFO buffer is empty.
@return FLASE If Raw Data FIFO buffer is not empty.
**/
BOOLEAN
IsRawFiFoEmpty (
TERMINAL_DEV *TerminalDevice
)
;
/**
Clarify whether Raw Data FIFO buffer is full.
@param TerminalDevice Terminal driver private structure
@return TRUE If Raw Data FIFO buffer is full.
@return FLASE If Raw Data FIFO buffer is not full.
**/
BOOLEAN
IsRawFiFoFull (
TERMINAL_DEV *TerminalDevice
)
;
/**
Insert one pre-fetched key into the FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Key The key will be input.
@return TRUE If insert successfully.
@return FLASE If FIFO buffer is full before key insertion,
and the key is lost.
**/
BOOLEAN
EfiKeyFiFoInsertOneKey (
TERMINAL_DEV *TerminalDevice,
@ -686,6 +955,16 @@ EfiKeyFiFoInsertOneKey (
)
;
/**
Remove one pre-fetched key out of the FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
@return TRUE If insert successfully.
@return FLASE If FIFO buffer is empty before remove operation.
**/
BOOLEAN
EfiKeyFiFoRemoveOneKey (
TERMINAL_DEV *TerminalDevice,
@ -693,18 +972,47 @@ EfiKeyFiFoRemoveOneKey (
)
;
/**
Clarify whether FIFO buffer is empty.
@param TerminalDevice Terminal driver private structure
@return TRUE If FIFO buffer is empty.
@return FLASE If FIFO buffer is not empty.
**/
BOOLEAN
IsEfiKeyFiFoEmpty (
TERMINAL_DEV *TerminalDevice
)
;
/**
Clarify whether FIFO buffer is full.
@param TerminalDevice Terminal driver private structure
@return TRUE If FIFO buffer is full.
@return FLASE If FIFO buffer is not full.
**/
BOOLEAN
IsEfiKeyFiFoFull (
TERMINAL_DEV *TerminalDevice
)
;
/**
Insert one pre-fetched key into the Unicode FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
@return TRUE If insert successfully.
@return FLASE If Unicode FIFO buffer is full before key insertion,
and the key is lost.
**/
BOOLEAN
UnicodeFiFoInsertOneKey (
TERMINAL_DEV *TerminalDevice,
@ -712,6 +1020,16 @@ UnicodeFiFoInsertOneKey (
)
;
/**
Remove one pre-fetched key out of the Unicode FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
@return TRUE If insert successfully.
@return FLASE If Unicode FIFO buffer is empty before remove operation.
**/
BOOLEAN
UnicodeFiFoRemoveOneKey (
TERMINAL_DEV *TerminalDevice,
@ -719,12 +1037,30 @@ UnicodeFiFoRemoveOneKey (
)
;
/**
Clarify whether Unicode FIFO buffer is empty.
@param TerminalDevice Terminal driver private structure
@return TRUE If Unicode FIFO buffer is empty.
@return FLASE If Unicode FIFO buffer is not empty.
**/
BOOLEAN
IsUnicodeFiFoEmpty (
TERMINAL_DEV *TerminalDevice
)
;
/**
Clarify whether Unicode FIFO buffer is full.
@param TerminalDevice Terminal driver private structure
@return TRUE If Unicode FIFO buffer is full.
@return FLASE If Unicode FIFO buffer is not full.
**/
BOOLEAN
IsUnicodeFiFoFull (
TERMINAL_DEV *TerminalDevice
@ -765,26 +1101,6 @@ AnsiTestString (
)
;
//
// internal functions for VT100
//
EFI_STATUS
VT100TestString (
IN TERMINAL_DEV *VT100Device,
IN CHAR16 *WString
)
;
//
// internal functions for VT100Plus
//
EFI_STATUS
VT100PlusTestString (
IN TERMINAL_DEV *TerminalDevice,
IN CHAR16 *WString
)
;
//
// internal functions for VTUTF8
//

820
MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
View File

File diff suppressed because it is too large Load Diff

431
MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c
View File

@ -86,36 +86,30 @@ CHAR16 mSetCursorPositionString[] = { ESC, '[', '0', '0', ';', '0', '0', 'H', 0
//
// Body of the ConOut functions
//
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().
If ExtendeVerification is TRUE, then perform dependent serial device reset,
and set display mode to mode 0.
If ExtendedVerification is FALSE, only set display mode to mode 0.
@param This Indicates the calling context.
@param ExtendedVerification Indicates that the driver may perform a more
exhaustive verification operation of the device
during reset.
@return EFI_SUCCESS
@return The reset operation succeeds.
@return EFI_DEVICE_ERROR
@return The terminal is not functioning correctly or the serial port reset fails.
**/
EFI_STATUS
EFIAPI
TerminalConOutReset (
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().
If ExtendeVerification is TRUE, then perform dependent serial device reset,
and set display mode to mode 0.
If ExtendedVerification is FALSE, only set display mode to mode 0.
Arguments:
This - Indicates the calling context.
ExtendedVerification - Indicates that the driver may perform a more exhaustive
verification operation of the device during reset.
Returns:
EFI_SUCCESS
The reset operation succeeds.
EFI_DEVICE_ERROR
The terminal is not functioning correctly or the serial port reset fails.
--*/
{
EFI_STATUS Status;
TERMINAL_DEV *TerminalDevice;
@ -157,42 +151,29 @@ TerminalConOutReset (
return Status;
}
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().
The Unicode string will be converted to terminal expressible data stream
and send to terminal via serial port.
@param This Indicates the calling context.
@param WString The Null-terminated Unicode string to be displayed
on the terminal screen.
@return EFI_SUCCESS The string is output successfully.
@return EFI_DEVICE_ERROR The serial port fails to send the string out.
@return EFI_WARN_UNKNOWN_GLYPH Indicates that some of the characters in the Unicode string could not
be rendered and are skipped.
@return EFI_UNSUPPORTED
**/
EFI_STATUS
EFIAPI
TerminalConOutOutputString (
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
IN CHAR16 *WString
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().
The Unicode string will be converted to terminal expressible data stream
and send to terminal via serial port.
Arguments:
This - Indicates the calling context.
WString - The Null-terminated Unicode string to be displayed on
the terminal screen.
Returns:
EFI_SUCCESS
The string is output successfully.
EFI_DEVICE_ERROR
The serial port fails to send the string out.
EFI_WARN_UNKNOWN_GLYPH
Indicates that some of the characters in the Unicode string could not
be rendered and are skipped.
EFI_UNSUPPORTED
--*/
{
TERMINAL_DEV *TerminalDevice;
EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;
@ -238,9 +219,9 @@ TerminalConOutOutputString (
switch (TerminalDevice->TerminalType) {
case PcAnsiType:
case VT100Type:
case VT100PlusType:
case PCANSITYPE:
case VT100TYPE:
case VT100PLUSTYPE:
if (!TerminalIsValidTextGraphics (*WString, &GraphicChar, &AsciiChar)) {
//
@ -266,7 +247,7 @@ TerminalConOutOutputString (
}
if (TerminalDevice->TerminalType != PcAnsiType) {
if (TerminalDevice->TerminalType != PCANSITYPE) {
GraphicChar = AsciiChar;
}
@ -284,7 +265,7 @@ TerminalConOutOutputString (
break;
case VTUTF8Type:
case VTUTF8TYPE:
UnicodeToUtf8 (*WString, &Utf8Char, &ValidBytes);
Length = ValidBytes;
Status = TerminalDevice->SerialIo->Write (
@ -353,37 +334,27 @@ OutputError:
return EFI_DEVICE_ERROR;
}
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().
If one of the characters in the *Wstring is
neither valid Unicode drawing characters,
not ASCII code, then this function will return
EFI_UNSUPPORTED.
@param This Indicates the calling context.
@param WString The Null-terminated Unicode string to be tested.
@return EFI_SUCCESS The terminal is capable of rendering the output string.
@return EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.
**/
EFI_STATUS
EFIAPI
TerminalConOutTestString (
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
IN CHAR16 *WString
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().
If one of the characters in the *Wstring is
neither valid Unicode drawing characters,
not ASCII code, then this function will return
EFI_UNSUPPORTED.
Arguments:
This - Indicates the calling context.
WString - The Null-terminated Unicode string to be tested.
Returns:
EFI_SUCCESS
The terminal is capable of rendering the output string.
EFI_UNSUPPORTED
Some of the characters in the Unicode string cannot be rendered.
--*/
{
TERMINAL_DEV *TerminalDevice;
EFI_STATUS Status;
@ -395,13 +366,13 @@ TerminalConOutTestString (
switch (TerminalDevice->TerminalType) {
case PcAnsiType:
case VT100Type:
case VT100PlusType:
case PCANSITYPE:
case VT100TYPE:
case VT100PLUSTYPE:
Status = AnsiTestString (TerminalDevice, WString);
break;
case VTUTF8Type:
case VTUTF8TYPE:
Status = VTUTF8TestString (TerminalDevice, WString);
break;
@ -413,6 +384,24 @@ TerminalConOutTestString (
return Status;
}
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().
It returns information for an available text mode
that the terminal supports.
In this driver, we support text mode 80x25 (mode 0),
80x50 (mode 1), 100x31 (mode 2).
@param This Indicates the calling context.
@param ModeNumber The mode number to return information on.
@param Columns The returned columns of the requested mode.
@param Rows The returned rows of the requested mode.
@return EFI_SUCCESS The requested mode information is returned.
@return EFI_UNSUPPORTED The mode number is not valid.
@return EFI_DEVICE_ERROR
**/
EFI_STATUS
EFIAPI
TerminalConOutQueryMode (
@ -421,41 +410,6 @@ TerminalConOutQueryMode (
OUT UINTN *Columns,
OUT UINTN *Rows
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUT_PROTOCOL.QueryMode().
It returns information for an available text mode
that the terminal supports.
In this driver, we support text mode 80x25 (mode 0),
80x50 (mode 1), 100x31 (mode 2).
Arguments:
*This
Indicates the calling context.
ModeNumber
The mode number to return information on.
Columns
The returned columns of the requested mode.
Rows
The returned rows of the requested mode.
Returns:
EFI_SUCCESS
The requested mode information is returned.
EFI_UNSUPPORTED
The mode number is not valid.
EFI_DEVICE_ERROR
--*/
{
if (This->Mode->MaxMode > 3) {
return EFI_DEVICE_ERROR;
@ -478,39 +432,27 @@ TerminalConOutQueryMode (
return EFI_UNSUPPORTED;
}
/**
Implements EFI_SIMPLE_TEXT_OUT.SetMode().
Set the terminal to a specified display mode.
In this driver, we only support mode 0.
@param This Indicates the calling context.
@param ModeNumber The text mode to set.
@return EFI_SUCCESS The requested text mode is set.
@return EFI_DEVICE_ERROR The requested text mode cannot be set
because of serial device error.
@return EFI_UNSUPPORTED The text mode number is not valid.
**/
EFI_STATUS
EFIAPI
TerminalConOutSetMode (
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
IN UINTN ModeNumber
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUT.SetMode().
Set the terminal to a specified display mode.
In this driver, we only support mode 0.
Arguments:
This
Indicates the calling context.
ModeNumber
The text mode to set.
Returns:
EFI_SUCCESS
The requested text mode is set.
EFI_DEVICE_ERROR
The requested text mode cannot be set because of serial device error.
EFI_UNSUPPORTED
The text mode number is not valid.
--*/
{
EFI_STATUS Status;
TERMINAL_DEV *TerminalDevice;
@ -550,38 +492,25 @@ TerminalConOutSetMode (
}
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().
@param This Indicates the calling context.
@param Attribute The attribute to set. Only bit0..6 are valid, all other bits
are undefined and must be zero.
@return EFI_SUCCESS The requested attribute is set.
@return EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.
@return EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
**/
EFI_STATUS
EFIAPI
TerminalConOutSetAttribute (
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
IN UINTN Attribute
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().
Arguments:
This
Indicates the calling context.
Attribute
The attribute to set. Only bit0..6 are valid, all other bits
are undefined and must be zero.
Returns:
EFI_SUCCESS
The requested attribute is set.
EFI_DEVICE_ERROR
The requested attribute cannot be set due to serial port error.
EFI_UNSUPPORTED
The attribute requested is not defined by EFI spec.
--*/
{
UINT8 ForegroundControl;
UINT8 BackgroundControl;
@ -736,36 +665,24 @@ TerminalConOutSetAttribute (
}
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().
It clears the ANSI terminal's display to the
currently selected background color.
@param This Indicates the calling context.
@return EFI_SUCCESS The operation completed successfully.
@return EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.
@return EFI_UNSUPPORTED The terminal is not in a valid display mode.
**/
EFI_STATUS
EFIAPI
TerminalConOutClearScreen (
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().
It clears the ANSI terminal's display to the
currently selected background color.
Arguments:
This
Indicates the calling context.
Returns:
EFI_SUCCESS
The operation completed successfully.
EFI_DEVICE_ERROR
The terminal screen cannot be cleared due to serial port error.
EFI_UNSUPPORTED
The terminal is not in a valid display mode.
--*/
{
EFI_STATUS Status;
TERMINAL_DEV *TerminalDevice;
@ -788,6 +705,20 @@ TerminalConOutClearScreen (
return Status;
}
/**
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().
@param This Indicates the calling context.
@param Column The row to set cursor to.
@param Row The column to set cursor to.
@return EFI_SUCCESS The operation completed successfully.
@return EFI_DEVICE_ERROR The request fails due to serial port error.
@return EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position
is invalid for current mode.
**/
EFI_STATUS
EFIAPI
TerminalConOutSetCursorPosition (
@ -795,35 +726,6 @@ TerminalConOutSetCursorPosition (
IN UINTN Column,
IN UINTN Row
)
/*++
Routine Description:
Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().
Arguments:
This
Indicates the calling context.
Column
The row to set cursor to.
Row
The column to set cursor to.
Returns:
EFI_SUCCESS
The operation completed successfully.
EFI_DEVICE_ERROR
The request fails due to serial port error.
EFI_UNSUPPORTED
The terminal is not in a valid text mode, or the cursor position
is invalid for current mode.
--*/
{
EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;
UINTN MaxColumn;
@ -879,36 +781,25 @@ TerminalConOutSetCursorPosition (
return EFI_SUCCESS;
}
/**
Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
In this driver, the cursor cannot be hidden.
@param This Indicates the calling context.
@param Visible If TRUE, the cursor is set to be visible,
If FALSE, the cursor is set to be invisible.
@return EFI_SUCCESS The request is valid.
@return EFI_UNSUPPORTED The terminal does not support cursor hidden.
**/
EFI_STATUS
EFIAPI
TerminalConOutEnableCursor (
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
IN BOOLEAN Visible
)
/*++
Routine Description:
Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
In this driver, the cursor cannot be hidden.
Arguments:
This
Indicates the calling context.
Visible
If TRUE, the cursor is set to be visible,
If FALSE, the cursor is set to be invisible.
Returns:
EFI_SUCCESS
The request is valid.
EFI_UNSUPPORTED
The terminal does not support cursor hidden.
--*/
{
if (!Visible) {
return EFI_UNSUPPORTED;
@ -917,31 +808,25 @@ TerminalConOutEnableCursor (
return EFI_SUCCESS;
}
/**
Detects if a Unicode char is for Box Drawing text graphics.
@param Graphic Unicode char to test.
@param PcAnsi Optional pointer to return PCANSI equivalent of
Graphic.
@param Ascii Optional pointer to return ASCII equivalent of
Graphic.
@return TRUE If Graphic is a supported Unicode Box Drawing character.
**/
BOOLEAN
TerminalIsValidTextGraphics (
IN CHAR16 Graphic,
OUT CHAR8 *PcAnsi, OPTIONAL
OUT CHAR8 *Ascii OPTIONAL
)
/*++
Routine Description:
Detects if a Unicode char is for Box Drawing text graphics.
Arguments:
Graphic - Unicode char to test.
PcAnsi - Optional pointer to return PCANSI equivalent of Graphic.
Ascii - Optional pointer to return ASCII equivalent of Graphic.
Returns:
TRUE if Graphic is a supported Unicode Box Drawing character.
--*/
{
UNICODE_TO_CHAR *Table;

2
MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c
View File

@ -1,4 +1,4 @@
/**@file
/** @file
Implementation translation among different code tyies.
Copyright (c) 2006, Intel Corporation. <BR>