Terminal.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Produces Simple Text Input Protocol, Simple Text Input Extended Protocol and
Simple Text Output Protocol upon Serial IO Protocol.
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "Terminal.h"
//
// Globals
//
0xa,
NULL,
};
EFI_GUID *gTerminalType[] = {
};
NULL,
0,
NULL,
NULL,
{ // SimpleTextInput
},
{ // SimpleTextOutput
},
{ // SimpleTextOutputMode
1, // MaxMode
0, // Mode
0, // CursorColumn
0, // CursorRow
TRUE // CursorVisible
},
NULL, // TerminalConsoleModeData
0, // SerialInTimeOut
NULL, // RawFifo
NULL, // UnicodeFiFo
NULL, // EfiKeyFiFo
NULL, // ControllerNameTable
NULL, // TimerEvent
NULL, // TwoSecondTimeOut
{ // SimpleTextInputEx
NULL,
},
{ // NotifyList
NULL,
NULL,
}
};
{100, 31},
//
// New modes can be added here.
//
};
/**
Test to see if this driver supports Controller.
@param This Protocol instance pointer.
@param Controller Handle of device to test
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device.
@retval EFI_ALREADY_STARTED This driver is already running on this device.
@retval other This driver does not support this device.
**/
)
{
//
// If remaining device path is not NULL, then make sure it is a
// device path that describes a terminal communications protocol.
//
if (RemainingDevicePath != NULL) {
//
// Check if RemainingDevicePath is the End of Device Path Node,
// if yes, go on checking other conditions
//
if (!IsDevicePathEnd (RemainingDevicePath)) {
//
// If RemainingDevicePath isn't the End of Device Path Node,
// check its validation
//
return EFI_UNSUPPORTED;
}
//
// only supports PC ANSI, VT100, VT100+ and VT-UTF8 terminal types
//
return EFI_UNSUPPORTED;
}
}
}
//
// Open the IO Abstraction(s) needed to perform the supported test
// The Controller must support the Serial I/O Protocol.
// This driver is a bus driver with at most 1 child device, so it is
// ok for it to be already started.
//
);
if (Status == EFI_ALREADY_STARTED) {
return EFI_SUCCESS;
}
return Status;
}
//
// Close the I/O Abstraction(s) used to perform the supported test
//
gBS->CloseProtocol (
);
//
// Open the EFI Device Path protocol needed to perform the supported test
//
(VOID **) &ParentDevicePath,
);
if (Status == EFI_ALREADY_STARTED) {
return EFI_SUCCESS;
}
return Status;
}
//
// Close protocol, don't use device path protocol in the Support() function
//
gBS->CloseProtocol (
);
return Status;
}
/**
Build the terminal device path for the child device according to the
terminal type.
@param ParentDevicePath Parent device path.
@param RemainingDevicePath A specific child device.
@return The child device path built.
**/
)
{
//
// Use the RemainingDevicePath to determine the terminal type
//
} else {
return NULL;
}
//
// Build the device path for the child device
//
);
return NULL;
}
return TerminalDevicePath;
}
/**
Compare a device path data structure to that of all the nodes of a
second device path instance.
@param Multi A pointer to a multi-instance device path data structure.
@param Single A pointer to a single-instance device path data structure.
@retval TRUE If the Single is contained within Multi.
@retval FALSE The Single is not match within Multi.
**/
)
{
DevicePath = Multi;
//
// Search for the match of 'Single' in 'Multi'
//
while (DevicePathInst != NULL) {
//
// If the single device path is found in multiple device paths,
// return success
//
return TRUE;
}
}
return FALSE;
}
/**
Check whether the terminal device path is in the global variable.
@param VariableName Pointer to one global variable.
@param TerminalDevicePath Pointer to the terminal device's device path.
@retval TRUE The devcie is in the global variable.
@retval FALSE The devcie is not in the global variable.
**/
)
{
//
// Get global variable and its size according to the name given.
//
return FALSE;
}
//
// Check whether the terminal device path is one of the variable instances.
//
return ReturnFlag;
}
/**
Free notify functions list.
@param ListHead The list head
@retval EFI_SUCCESS Free the notify list successfully.
@retval EFI_INVALID_PARAMETER ListHead is NULL.
**/
)
{
return EFI_INVALID_PARAMETER;
}
while (!IsListEmpty (ListHead)) {
NotifyNode = CR (
);
}
return EFI_SUCCESS;
}
/**
Initialize all the text modes which the terminal console supports.
It returns information for available text modes that the terminal can support.
@param[out] TextModeCount The total number of text modes that terminal console supports.
@param[out] TextModeData The buffer to the text modes column and row information.
Caller is responsible to free it when it's non-NULL.
@retval EFI_SUCCESS The supporting mode information is returned.
@retval EFI_INVALID_PARAMETER The parameters are invalid.
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// Get defined mode buffer pointer.
//
//
// Here we make sure that the final mode exposed does not include the duplicated modes,
// and does not include the invalid modes which exceed the max column and row.
// Reserve 2 modes for 80x25, 80x50 of terminal console.
//
//
// Mode 0 and mode 1 is for 80x25, 80x50 according to UEFI spec.
//
ValidCount = 0;
ValidCount++;
ValidCount++;
//
// Start from mode 2 to put the valid mode other than 80x25 and 80x50 in the output mode buffer.
//
//
// Skip the pre-defined mode which is invalid.
//
continue;
}
//
// Skip the duplicated mode.
//
break;
}
}
if (ValidIndex == ValidCount) {
ValidCount++;
}
}
}
);
//
// Return valid mode count and mode information buffer.
//
return EFI_SUCCESS;
}
/**
Start this driver on Controller by opening a Serial IO protocol,
reading Device Path, and creating a child handle with a Simple Text In,
Simple Text In Ex and Simple Text Out protocol, and device path protocol.
And store Console Device Environment Variables.
@param This Protocol instance pointer.
@param Controller Handle of device to bind driver to
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to Controller.
@retval EFI_ALREADY_STARTED This driver is already running on Controller.
@retval other This driver does not support this device.
**/
)
{
DefaultNode = NULL;
FirstEnter = FALSE;
//
// Get the Device Path Protocol to build the device path of the child device
//
(VOID **) &ParentDevicePath,
);
return Status;
}
//
// Open the Serial I/O Protocol BY_DRIVER. It might already be started.
//
);
return Status;
}
if (Status != EFI_ALREADY_STARTED) {
//
// the serial I/O protocol never be opened before, it is the first
// time to start the serial Io controller
//
FirstEnter = TRUE;
}
//
// Serial I/O is not already open by this driver, then tag the handle
// with the Terminal Driver GUID and update the ConInDev, ConOutDev, and
// StdErrDev variables with the list of possible terminal types on this
// serial port.
//
NULL,
);
);
goto Error;
}
if (!IsHotPlugDevice (ParentDevicePath)) {
//
// if the serial device is a hot plug device, do not update the
// ConInDev, ConOutDev, and StdErrDev variables.
//
}
}
//
// Check the requirement for the SimpleTxtIn and SimpleTxtOut protocols
//
// environment variable. But If RemainingDevicePath is NULL, then always
// produce both Simple In and Simple Text Output Protocols. This is required
// for the connect all sequences to make sure all possible consoles are
// produced no matter what the current values of ConIn, ConOut, or StdErr are.
//
if (RemainingDevicePath == NULL) {
}
if (DevicePath != NULL) {
} else {
goto Error;
}
//
// Simple text Out protocols are not required to be published
//
goto Error;
}
//
// create the child terminal handle during first entry
//
if (FirstEnter) {
//
// First enther the start funciton
//
FirstEnter = FALSE;
//
// Make sure a child handle does not already exist. This driver can only
// produce one child per serial port.
//
);
}
}
goto Error;
}
}
//
// If RemainingDevicePath is NULL, then create default device path node
//
if (RemainingDevicePath == NULL) {
if (DefaultNode == NULL) {
goto Error;
}
//
// Must be between PCANSITYPE (0) and VTUTF8TYPE (3)
//
} else if (!IsDevicePathEnd (RemainingDevicePath)) {
//
// If RemainingDevicePath isn't the End of Device Path Node,
// Use the RemainingDevicePath to determine the terminal type
//
} else {
goto Error;
}
} else {
//
// If RemainingDevicePath is the End of Device Path Node,
// skip enumerate any device and return EFI_SUCESSS
//
return EFI_SUCCESS;
}
//
// Initialize the Terminal Dev
//
if (TerminalDevice == NULL) {
goto Error;
}
);
goto Error;
}
);
goto Error;
}
//
// Allocates and initializes the FIFO buffer to be zero, used for accommodating
// the pre-read pending characters.
//
goto Error;
}
goto Error;
}
goto Error;
}
//
// Set the timeout value of serial buffer for
// keystroke response performance issue
//
SerialInTimeOut = 0;
}
);
//
// if set attributes operation fails, invalidate
// the value of SerialInTimeOut,thus make it
// inconsistent with the default timeout value
// of serial buffer. This will invoke the recalculation
// in the readkeystroke routine.
//
} else {
}
//
// Set Simple Text Output Protocol from template.
//
sizeof (mTerminalDevTemplate.SimpleTextOutput)
);
goto ReportError;
}
//
// For terminal devices, cursor is always visible
//
);
goto ReportError;
}
//
// Build the component name for the child device
//
switch (TerminalDevice->TerminalType) {
case PCANSITYPE:
"eng",
(CHAR16 *)L"PC-ANSI Serial Console",
);
"en",
(CHAR16 *)L"PC-ANSI Serial Console",
);
break;
case VT100TYPE:
"eng",
(CHAR16 *)L"VT-100 Serial Console",
);
"en",
(CHAR16 *)L"VT-100 Serial Console",
);
break;
case VT100PLUSTYPE:
"eng",
(CHAR16 *)L"VT-100+ Serial Console",
);
"en",
(CHAR16 *)L"VT-100+ Serial Console",
);
break;
case VTUTF8TYPE:
"eng",
(CHAR16 *)L"VT-UTF8 Serial Console",
);
"en",
(CHAR16 *)L"VT-UTF8 Serial Console",
);
break;
}
//
// Build the device path for the child device
//
);
goto Error;
}
goto ReportError;
}
goto ReportError;
}
goto ReportError;
}
);
);
NULL,
NULL,
);
);
goto Error;
}
//
// Register the Parent-Child relationship via
// EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
//
);
goto Error;
}
}
//
// Find the child handle, and get its TerminalDevice private data
//
);
//
// Find the child terminal handle.
// Test whether the SimpleTxtIn and SimpleTxtOut have been published
//
(VOID **) &SimpleTextInput,
);
}
(VOID **) &SimpleTextOutput,
);
}
break;
}
}
goto ReportError;
}
} else {
goto ReportError;
}
//
// Only do the reset if the device path is in the Conout variable
//
if (ConInSelected && !SimTxtInInstalled) {
);
//
// Need to report Error Code first
//
goto ReportError;
}
}
//
// Only output the configure string to remote terminal if the device path
// is in the Conout variable
//
if (ConOutSelected && !SimTxtOutInstalled) {
);
goto ReportError;
}
);
goto ReportError;
}
0
);
goto ReportError;
}
);
goto ReportError;
}
}
//
// environment variable. But If RemainingDevicePath is NULL, then always
// produce both Simple In and Simple Text Output Protocols. This is required
// for the connect all sequences to make sure all possible consoles are
// produced no matter what the current values of ConIn, ConOut, or StdErr are.
//
);
goto Error;
}
}
);
goto Error;
}
}
if (DefaultNode != NULL) {
}
return EFI_SUCCESS;
//
// Report error code before exiting
//
);
//
// Use the Stop() function to free all resources allocated in Start()
//
if (TerminalDevice != NULL) {
} else {
}
}
}
}
}
}
}
}
}
}
}
}
if (DefaultNode != NULL) {
}
return Status;
}
/**
Stop this driver on Controller by closing Simple Text In, Simple Text
In Ex, Simple Text Out protocol, and removing parent device path from
Console Device Environment Variables.
@param This Protocol instance pointer.
@param Controller Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed Controller.
@retval other This driver could not be removed from this device.
**/
)
{
(VOID **) &DevicePath
);
return Status;
}
//
// Complete all outstanding transactions to Controller.
// Don't allow any new transaction to Controller to be started.
//
if (NumberOfChildren == 0) {
//
// Close the bus driver
//
(VOID **) &ParentDevicePath,
);
//
// Remove Parent Device Path from
// the Console Device Environment Variables
//
//
// Uninstall the Terminal Driver's GUID Tag from the Serial controller
//
);
//
// Free the ParentDevicePath that was duplicated in Start()
//
}
}
gBS->CloseProtocol (
);
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
(VOID **) &SimpleTextOutput,
);
gBS->CloseProtocol (
);
);
gBS->OpenProtocol (
);
} else {
}
}
}
}
}
}
if (!AllChildrenStopped) {
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
/**
Update terminal device path in Console Device Environment Variables.
@param VariableName The Console Device Environment Variable.
@param ParentDevicePath The terminal device path to be updated.
**/
)
{
//
// Get global variable and its size according to the name given.
//
return;
}
//
// Append terminal device path onto the variable.
//
}
if (TempDevicePath != NULL) {
}
}
);
return ;
}
/**
Remove terminal device path from Console Device Environment Variables.
@param VariableName Console Device Environment Variables.
@param ParentDevicePath The terminal device path to be updated.
**/
)
{
//
// Get global variable and its size according to the name given.
//
return ;
}
NewVariable = NULL;
//
// Get first device path instance from Variable
//
return ;
}
//
// Loop through all the device path instances of Variable
//
do {
//
// Loop through all the terminal types that this driver supports
//
//
// Compare the generated device path to the current device path instance
//
if (TempDevicePath != NULL) {
}
}
}
//
// If a match was not found, then keep the current device path instance
//
if (!Match) {
if (SavedNewVariable != NULL) {
}
}
//
// Get next device path instance from Variable
//
if (FoundOne) {
);
}
if (NewVariable != NULL) {
}
return ;
}
/**
Build terminal device path according to terminal type.
@param TerminalType The terminal type is PC ANSI, VT100, VT100+ or VT-UTF8.
@param ParentDevicePath Parent device path.
@param TerminalDevicePath Returned terminal device path, if building successfully.
@retval EFI_UNSUPPORTED Terminal does not belong to the supported type.
@retval EFI_OUT_OF_RESOURCES Generate terminal device path failed.
@retval EFI_SUCCESS Build terminal device path successfully.
**/
)
{
//
// Generate terminal device path node according to terminal type.
//
switch (TerminalType) {
case PCANSITYPE:
break;
case VT100TYPE:
break;
case VT100PLUSTYPE:
break;
case VTUTF8TYPE:
break;
default:
return EFI_UNSUPPORTED;
}
//
// Get VENDOR_DEVCIE_PATH size and put into Node.Header
//
sizeof (VENDOR_DEVICE_PATH)
);
//
// Append the terminal node onto parent device path
// to generate a complete terminal device path.
//
);
if (*TerminalDevicePath == NULL) {
return EFI_OUT_OF_RESOURCES;
}
return EFI_SUCCESS;
}
/**
The user Entry Point for module Terminal. The user code starts with this function.
@param ImageHandle The firmware allocated handle for the EFI image.
@param 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.
**/
)
{
//
// Install driver model protocol(s).
//
);
return Status;
}
/**
Check if the device supports hot-plug through its device path.
This function could be updated to check more types of Hot Plug devices.
Currently, it checks USB and PCCard device.
@param DevicePath Pointer to device's device path.
@retval TRUE The devcie is a hot-plug device
@retval FALSE The devcie is not a hot-plug device.
**/
)
{
while (!IsDevicePathEnd (CheckDevicePath)) {
//
// Check device whether is hot plug device or not throught Device Path
//
//
// If Device is USB device
//
return TRUE;
}
//
// If Device is PCCard
//
return TRUE;
}
}
return FALSE;
}