mirror of https://github.com/acidanthera/audk.git
286 lines
8.5 KiB
C
286 lines
8.5 KiB
C
|
/** @file
|
||
|
|
Library functions that abstract areas of conflict between Tiano an UEFI 2.0.
|
||
|
|
|
||
|
|
Help Port Framework/Tinao code that has conflicts with UEFI 2.0 by hiding the
|
||
|
|
oldconflicts with library functions and supporting implementations of the old
|
||
|
|
(R8.5/EFI 1.10) and new (R9/UEFI 2.0) way.
|
||
|
|
|
||
|
|
Copyright (c) 2006, Intel Corporation<BR>
|
||
|
|
All rights reserved. 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
|
||
|
|
http://opensource.org/licenses/bsd-license.php
|
||
|
|
|
||
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
Create a Legacy Boot Event.
|
||
|
|
|
||
|
|
Tiano extended the CreateEvent Type enum to add a legacy boot event type.
|
||
|
|
This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was
|
||
|
|
added and now it's possible to not voilate the UEFI specification by
|
||
|
|
declaring a GUID for the legacy boot event class. This library supports
|
||
|
|
the R8.5/EFI 1.10 form and R9/UEFI 2.0 form and allows common code to
|
||
|
|
work both ways.
|
||
|
|
|
||
|
|
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS Event was created.
|
||
|
|
@retval Other Event was not created.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
EfiCreateEventLegacyBoot (
|
||
|
|
OUT EFI_EVENT *LegacyBootEvent
|
||
|
|
)
|
||
|
|
{
|
||
|
|
EFI_STATUS Status;
|
||
|
|
|
||
|
|
ASSERT (LegacyBootEvent != NULL);
|
||
|
|
|
||
|
|
#if (EFI_SPECIFICATION_VERSION < 0x00020000)
|
||
|
|
//
|
||
|
|
// prior to UEFI 2.0 use Tiano extension to EFI
|
||
|
|
//
|
||
|
|
Status = gBS->CreateEvent (
|
||
|
|
EFI_EVENT_SIGNAL_LEGACY_BOOT | EFI_EVENT_NOTIFY_SIGNAL_ALL,
|
||
|
|
EFI_TPL_CALLBACK,
|
||
|
|
NULL,
|
||
|
|
NULL,
|
||
|
|
LegacyBootEvent
|
||
|
|
);
|
||
|
|
#else
|
||
|
|
//
|
||
|
|
// For UEFI 2.0 and the future use an Event Group
|
||
|
|
//
|
||
|
|
Status = gBS->CreateEventEx (
|
||
|
|
EVENT_NOTIFY_SIGNAL,
|
||
|
|
EFI_TPL_CALLBACK,
|
||
|
|
NULL,
|
||
|
|
NULL,
|
||
|
|
&gEfiEventLegacyBootGuid,
|
||
|
|
LegacyBootEvent
|
||
|
|
);
|
||
|
|
#endif
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
Create a Read to Boot Event.
|
||
|
|
|
||
|
|
Tiano extended the CreateEvent Type enum to add a ready to boot event type.
|
||
|
|
This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was
|
||
|
|
added and now it's possible to not voilate the UEFI specification and use
|
||
|
|
the ready to boot event class defined in UEFI 2.0. This library supports
|
||
|
|
the R8.5/EFI 1.10 form and R9/UEFI 2.0 form and allows common code to
|
||
|
|
work both ways.
|
||
|
|
|
||
|
|
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS Event was created.
|
||
|
|
@retval Other Event was not created.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
EfiCreateEventReadyToBoot (
|
||
|
|
IN EFI_EVENT *ReadyToBootEvent
|
||
|
|
)
|
||
|
|
{
|
||
|
|
EFI_STATUS Status;
|
||
|
|
|
||
|
|
ASSERT (ReadyToBootEvent != NULL);
|
||
|
|
|
||
|
|
#if (EFI_SPECIFICATION_VERSION < 0x00020000)
|
||
|
|
//
|
||
|
|
// prior to UEFI 2.0 use Tiano extension to EFI
|
||
|
|
//
|
||
|
|
Status = gBS->CreateEvent (
|
||
|
|
EFI_EVENT_SIGNAL_READY_TO_BOOT | EFI_EVENT_NOTIFY_SIGNAL_ALL,
|
||
|
|
EFI_TPL_CALLBACK,
|
||
|
|
NULL,
|
||
|
|
NULL,
|
||
|
|
ReadyToBootEvent
|
||
|
|
);
|
||
|
|
#else
|
||
|
|
//
|
||
|
|
// For UEFI 2.0 and the future use an Event Group
|
||
|
|
//
|
||
|
|
Status = gBS->CreateEventEx (
|
||
|
|
EVENT_NOTIFY_SIGNAL,
|
||
|
|
EFI_TPL_CALLBACK,
|
||
|
|
NULL,
|
||
|
|
NULL,
|
||
|
|
&gEfiEventReadyToBootGuid,
|
||
|
|
ReadyToBootEvent
|
||
|
|
);
|
||
|
|
#endif
|
||
|
|
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
Signal a Ready to Boot Event.
|
||
|
|
|
||
|
|
Create a Ready to Boot Event. Signal it and close it. This causes other
|
||
|
|
events of the same event group to be signaled in other modules.
|
||
|
|
|
||
|
|
**/
|
||
|
|
VOID
|
||
|
|
EFIAPI
|
||
|
|
EfiSignalEventReadyToBoot (
|
||
|
|
VOID
|
||
|
|
)
|
||
|
|
{
|
||
|
|
EFI_STATUS Status;
|
||
|
|
EFI_EVENT ReadyToBootEvent;
|
||
|
|
|
||
|
|
Status = EfiCreateEventReadyToBoot (&ReadyToBootEvent);
|
||
|
|
if (!EFI_ERROR (Status)) {
|
||
|
|
gBS->SignalEvent (ReadyToBootEvent);
|
||
|
|
gBS->CloseEvent (ReadyToBootEvent);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Signal a Legacy Boot Event.
|
||
|
|
|
||
|
|
Create a legacy Boot Event. Signal it and close it. This causes other
|
||
|
|
events of the same event group to be signaled in other modules.
|
||
|
|
|
||
|
|
**/
|
||
|
|
VOID
|
||
|
|
EFIAPI
|
||
|
|
EfiSignalEventLegacyBoot (
|
||
|
|
VOID
|
||
|
|
)
|
||
|
|
{
|
||
|
|
EFI_STATUS Status;
|
||
|
|
EFI_EVENT LegacyBootEvent;
|
||
|
|
|
||
|
|
Status = EfiCreateEventLegacyBoot (&LegacyBootEvent);
|
||
|
|
if (!EFI_ERROR (Status)) {
|
||
|
|
gBS->SignalEvent (LegacyBootEvent);
|
||
|
|
gBS->CloseEvent (LegacyBootEvent);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
Check to see if the Firmware Volume (FV) Media Device Path is valid
|
||
|
|
|
||
|
|
Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum
|
||
|
|
so as we move to UEFI 2.0 support we must use a mechanism that conforms with
|
||
|
|
the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed
|
||
|
|
device path is defined for PIWG extensions of device path. If the code
|
||
|
|
is compiled to conform with the UEFI 2.0 specification use the new device path
|
||
|
|
else use the old form for backwards compatability. The return value to this
|
||
|
|
function points to a location in FvDevicePathNode and it does not allocate
|
||
|
|
new memory for the GUID pointer that is returned.
|
||
|
|
|
||
|
|
@param FvDevicePathNode Pointer to FV device path to check.
|
||
|
|
|
||
|
|
@retval NULL FvDevicePathNode is not valid.
|
||
|
|
@retval Other FvDevicePathNode is valid and pointer to NameGuid was returned.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_GUID *
|
||
|
|
EFIAPI
|
||
|
|
EfiGetNameGuidFromFwVolDevicePathNode (
|
||
|
|
IN MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode
|
||
|
|
)
|
||
|
|
{
|
||
|
|
ASSERT (FvDevicePathNode != NULL);
|
||
|
|
|
||
|
|
#if (EFI_SPECIFICATION_VERSION < 0x00020000)
|
||
|
|
//
|
||
|
|
// Use old Device Path that conflicts with UEFI
|
||
|
|
//
|
||
|
|
if (DevicePathType (&FvDevicePathNode->Header) == MEDIA_DEVICE_PATH ||
|
||
|
|
DevicePathSubType (&FvDevicePathNode->Header) == MEDIA_FV_FILEPATH_DP) {
|
||
|
|
return &FvDevicePathNode->NameGuid;
|
||
|
|
}
|
||
|
|
|
||
|
|
#else
|
||
|
|
//
|
||
|
|
// Use the new Device path that does not conflict with the UEFI
|
||
|
|
//
|
||
|
|
if (FvDevicePathNode->Piwg.Header.Type == MEDIA_DEVICE_PATH ||
|
||
|
|
FvDevicePathNode->Piwg.Header.SubType == MEDIA_VENDOR_DP) {
|
||
|
|
if (CompareGuid (&gEfiFrameworkDevicePathGuid, &FvDevicePathNode->Piwg.PiwgSpecificDevicePath)) {
|
||
|
|
if (FvDevicePathNode->Piwg.Type == PIWG_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE) {
|
||
|
|
return &FvDevicePathNode->NameGuid;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
return NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
Initialize a Firmware Volume (FV) Media Device Path node.
|
||
|
|
|
||
|
|
Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum
|
||
|
|
so as we move to UEFI 2.0 support we must use a mechanism that conforms with
|
||
|
|
the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed
|
||
|
|
device path is defined for PIWG extensions of device path. If the code
|
||
|
|
is compiled to conform with the UEFI 2.0 specification use the new device path
|
||
|
|
else use the old form for backwards compatability.
|
||
|
|
|
||
|
|
@param FvDevicePathNode Pointer to a FV device path node to initialize
|
||
|
|
@param NameGuid FV file name to use in FvDevicePathNode
|
||
|
|
|
||
|
|
**/
|
||
|
|
VOID
|
||
|
|
EFIAPI
|
||
|
|
EfiInitializeFwVolDevicepathNode (
|
||
|
|
IN MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode,
|
||
|
|
IN EFI_GUID *NameGuid
|
||
|
|
)
|
||
|
|
{
|
||
|
|
ASSERT (FvDevicePathNode != NULL);
|
||
|
|
ASSERT (NameGuid != NULL);
|
||
|
|
|
||
|
|
#if (EFI_SPECIFICATION_VERSION < 0x00020000)
|
||
|
|
//
|
||
|
|
// Use old Device Path that conflicts with UEFI
|
||
|
|
//
|
||
|
|
FvDevicePathNode->Header.Type = MEDIA_DEVICE_PATH;
|
||
|
|
FvDevicePathNode->Header.SubType = MEDIA_FV_FILEPATH_DP;
|
||
|
|
SetDevicePathNodeLength (&FvDevicePathNode->Header, sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH));
|
||
|
|
|
||
|
|
#else
|
||
|
|
//
|
||
|
|
// Use the new Device path that does not conflict with the UEFI
|
||
|
|
//
|
||
|
|
FvDevicePathNode->Piwg.Header.Type = MEDIA_DEVICE_PATH;
|
||
|
|
FvDevicePathNode->Piwg.Header.SubType = MEDIA_VENDOR_DP;
|
||
|
|
SetDevicePathNodeLength (&FvDevicePathNode->Piwg.Header, sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH));
|
||
|
|
|
||
|
|
//
|
||
|
|
// Add the GUID for generic PIWG device paths
|
||
|
|
//
|
||
|
|
CopyGuid (&FvDevicePathNode->Piwg.PiwgSpecificDevicePath, &gEfiFrameworkDevicePathGuid);
|
||
|
|
|
||
|
|
//
|
||
|
|
// Add in the FW Vol File Path PIWG defined inforation
|
||
|
|
//
|
||
|
|
FvDevicePathNode->Piwg.Type = PIWG_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE;
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
CopyGuid (&FvDevicePathNode->NameGuid, NameGuid);
|
||
|
|
|
||
|
|
}
|
||
|
|
|