ConPlatform.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Console Platform DXE Driver, install Console Device Guids and update Console
Environment Variables.
Copyright (c) 2006 - 2010, 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 "ConPlatform.h"
0xa,
NULL,
};
0xa,
NULL,
};
/**
Entrypoint of this module.
This function is the entrypoint of this module. It installs Driver Binding
Protocols together with Component Name Protocols.
@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.
**/
)
{
);
NULL,
);
return EFI_SUCCESS;
}
/**
Test to see if EFI_SIMPLE_TEXT_INPUT_PROTOCOL is supported on ControllerHandle.
@param This Protocol instance pointer.
@param ControllerHandle 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 other This driver does not support this device.
**/
)
{
return ConPlatformDriverBindingSupported (
This,
);
}
/**
Test to see if EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL is supported on ControllerHandle.
@param This Protocol instance pointer.
@param ControllerHandle 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 other This driver does not support this device.
**/
)
{
return ConPlatformDriverBindingSupported (
This,
);
}
/**
Test to see if the specified protocol is supported on ControllerHandle.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to test.
@param ProtocolGuid The specfic protocol.
@retval EFI_SUCCESS This driver supports this device.
@retval other This driver does not support this device.
**/
)
{
//
// Test to see if this is a physical device by checking if
// it has a Device Path Protocol.
//
NULL,
);
return Status;
}
//
// Test to see if this device supports the specified Protocol.
//
);
return Status;
}
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
/**
Start this driver on the device for console input.
Start this driver on ControllerHandle by opening Simple Text Input Protocol,
reading Device Path, and installing Console In Devcice GUID on ControllerHandle.
If this devcie is not one hot-plug devce, append its device path into the
console environment variables ConInDev.
@param This Protocol instance pointer.
@param ControllerHandle 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 ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device.
**/
)
{
//
// Get the Device Path Protocol so the environment variables can be updated
//
(VOID **) &DevicePath,
);
return Status;
}
//
// Open the Simple Text Input Protocol BY_DRIVER
//
);
return Status;
}
//
// Check if the device path is in ConIn Variable
//
L"ConIn",
);
}
//
// Check the device path, if it is a hot plug device,
// do not put the device path into ConInDev, and install
// gEfiConsoleInDeviceGuid to the device handle directly.
// The policy is, make hot plug device plug in and play immediately.
//
if (IsHotPlugDevice (DevicePath)) {
NULL,
);
//
// Append the device path to ConInDev only if it is in ConIn variable.
//
if (IsInConInVariable) {
L"ConInDev",
);
}
} else {
//
// If it is not a hot-plug device, append the device path to the
// ConInDev environment variable
//
L"ConInDev",
);
//
// If the device path is an instance in the ConIn environment variable,
// then install EfiConsoleInDeviceGuid onto ControllerHandle
//
if (IsInConInVariable) {
NULL,
);
} else {
gBS->CloseProtocol (
);
}
}
return EFI_SUCCESS;
}
/**
Start this driver on the device for console output and stardard error output.
Start this driver on ControllerHandle by opening Simple Text Output Protocol,
reading Device Path, and installing Console Out Devcic GUID, Standard Error
Device GUID on ControllerHandle.
If this devcie is not one hot-plug devce, append its device path into the
console environment variables ConOutDev, ErrOutDev.
@param This Protocol instance pointer.
@param ControllerHandle 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 ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device
**/
)
{
//
// Get the Device Path Protocol so the environment variables can be updated
//
(VOID **) &DevicePath,
);
return Status;
}
//
// Open the Simple Text Output Protocol BY_DRIVER
//
);
return Status;
}
//
// Check if the device path is in ConOut & ErrOut Variable
//
L"ConOut",
);
}
L"ErrOut",
);
}
//
// Check the device path, if it is a hot plug device,
// do not put the device path into ConOutDev and ErrOutDev,
// and install gEfiConsoleOutDeviceGuid to the device handle directly.
// The policy is, make hot plug device plug in and play immediately.
//
if (IsHotPlugDevice (DevicePath)) {
NULL,
);
//
// Append the device path to ConOutDev only if it is in ConOut variable.
//
if (IsInConOutVariable) {
L"ConOutDev",
);
}
//
// Append the device path to ErrOutDev only if it is in ErrOut variable.
//
if (IsInErrOutVariable) {
L"ErrOutDev",
);
}
} else {
//
// If it is not a hot-plug device, append the device path to
// the ConOutDev and ErrOutDev environment variable.
// For GOP device path, append the sibling device path as well.
//
if (!ConPlatformUpdateGopCandidate (DevicePath)) {
L"ConOutDev",
);
//
// Then append the device path to the ErrOutDev environment variable
//
L"ErrOutDev",
);
}
//
// If the device path is an instance in the ConOut environment variable,
// then install EfiConsoleOutDeviceGuid onto ControllerHandle
//
if (IsInConOutVariable) {
NULL,
);
}
//
// If the device path is an instance in the ErrOut environment variable,
// then install EfiStandardErrorDeviceGuid onto ControllerHandle
//
if (IsInErrOutVariable) {
NULL,
);
}
if (NeedClose) {
gBS->CloseProtocol (
);
}
}
return EFI_SUCCESS;
}
/**
Stop this driver on ControllerHandle by removing Console In Devcice GUID
and closing the Simple Text Input protocol on ControllerHandle.
@param This Protocol instance pointer.
@param ControllerHandle 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 ControllerHandle
@retval other This driver was not removed from this device
**/
)
{
//
// Get the Device Path Protocol firstly
//
(VOID **) &DevicePath,
);
//
// If there is device path on ControllerHandle
//
//
// Remove DevicePath from ConInDev if exists.
//
L"ConInDev",
);
}
//
// Uninstall the Console Device GUIDs from Controller Handle
//
This,
);
//
// Close the Simple Text Input Protocol
//
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
/**
Stop this driver on ControllerHandle by removing Console Out Devcice GUID
and closing the Simple Text Output protocol on ControllerHandle.
@param This Protocol instance pointer.
@param ControllerHandle 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 ControllerHandle
@retval other This driver was not removed from this device
**/
)
{
//
// Get the Device Path Protocol firstly
//
(VOID **) &DevicePath,
);
//
// Remove DevicePath from ConOutDev and ErrOutDev if exists.
//
L"ConOutDev",
);
L"ErrOutDev",
);
}
//
// Uninstall the Console Device GUIDs from Controller Handle
//
This,
);
This,
);
//
// Close the Simple Text Output Protocol
//
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
/**
Uninstall the specified protocol.
@param This Protocol instance pointer.
@param Handle Handle of device to uninstall protocol on.
@param ProtocolGuid The specified protocol need to be uninstalled.
**/
)
{
NULL,
);
NULL,
);
}
return ;
}
/**
Get the necessary size of buffer and read the variable.
First get the necessary size of buffer. Then read the
EFI variable (Name) and return a dynamically allocated
buffer. On failure return NULL.
@param Name String part of EFI variable name
@return Dynamically allocated memory that contains a copy of the EFI variable.
Caller is repsoncible freeing the buffer. Return NULL means Variable
was not read.
**/
VOID *
)
{
BufferSize = 0;
//
// Test to see if the variable exists. If it doesn't, return NULL.
//
Name,
NULL,
);
if (Status == EFI_BUFFER_TOO_SMALL) {
//
// Allocate the buffer to return
//
return NULL;
}
//
// Read variable into the allocated buffer.
//
Name,
NULL,
);
//
// To make sure Buffer is NULL if any error occurs.
//
}
}
return Buffer;
}
/**
Function compares 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.
@param NewDevicePath If Delete is TRUE, this parameter must not be null, and it
points to the remaining device path data structure.
(remaining device path = Multi - Single.)
@param Delete If TRUE, means removing Single from Multi.
If FALSE, the routine just check whether Single matches
with any instance in Multi.
@retval EFI_SUCCESS If the Single is contained within Multi.
@retval EFI_NOT_FOUND If the Single is not contained within Multi.
@retval EFI_INVALID_PARAMETER Multi is NULL.
@retval EFI_INVALID_PARAMETER Single is NULL.
@retval EFI_INVALID_PARAMETER NewDevicePath is NULL when Delete is TRUE.
**/
)
{
//
// The passed in DevicePath should not be NULL
//
return EFI_INVALID_PARAMETER;
}
//
// If performing Delete operation, the NewDevicePath must not be NULL.
//
if (Delete) {
if (NewDevicePath == NULL) {
return EFI_INVALID_PARAMETER;
}
}
DevicePath = Multi;
//
// Search for the match of 'Single' in 'Multi'
//
while (DevicePathInst != NULL) {
if (!Delete) {
//
// If Delete is FALSE, return EFI_SUCCESS if Single is found in Multi.
//
return EFI_SUCCESS;
}
} else {
if (Delete) {
//
// If the node of Multi does not match Single, then added it back to the result.
// That is, the node matching Single will be dropped and deleted from result.
//
);
if (TempDevicePath1 != NULL) {
}
}
}
}
if (Delete) {
//
// Return the new device path data structure with specified node deleted.
//
return EFI_SUCCESS;
}
return EFI_NOT_FOUND;
}
/**
Update console environment variables.
@param VariableName Console environment variables, ConOutDev, ConInDev
ErrOutDev, ConIn ,ConOut or ErrOut.
@param DevicePath Console devcie's device path.
@param Operation Variable operations, including APPEND, CHECK and DELETE.
@retval EFI_SUCCESS Variable operates successfully.
@retval EFI_OUT_OF_RESOURCES If variable cannot be appended.
@retval other Variable updating failed.
**/
)
{
//
// Get Variable according to variable name.
// The memory for Variable is allocated within ConPlatformGetVarible(),
// it is the caller's responsibility to free the memory before return.
//
//
// Match specified DevicePath in Console Variable.
//
NULL,
);
//
// Branch here includes 2 cases:
// 1. Operation is CHECK, simply return Status.
// 2. Operation is APPEND, and device path already exists in variable, also return.
//
if (VariableDevicePath != NULL) {
}
return Status;
}
//
// We reach here to append a device path that does not exist in variable.
//
);
if (NewVariableDevicePath == NULL) {
}
} else {
//
// We reach here to remove DevicePath from the environment variable that
// is a multi-instance device path.
//
);
}
if (VariableDevicePath != NULL) {
}
return Status;
}
if (NewVariableDevicePath != NULL) {
//
// Update Console Environment Variable.
//
);
}
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;
}
/**
Update ConOutDev and ErrOutDev variables to add the device path of
GOP controller itself and the sibling controllers.
@param DevicePath Pointer to device's device path.
@retval TRUE The devcie is a GOP device.
@retval FALSE The devcie is not a GOP device.
**/
)
{
//
// Check whether it's a GOP device.
//
return FALSE;
}
//
// Get the parent PciIo handle in order to find all the children
//
return FALSE;
}
);
return FALSE;
}
//
// Query all the children created by the GOP driver
//
(VOID **) &ChildDevicePath,
NULL,
NULL,
);
//
// Append the device path to ConOutDev and ErrOutDev
//
}
}
}
return TRUE;
}