/**
Searches the FFS file the the currently executing module was loaded from and returns the first matching FFS section.
This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType.
If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType,
then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(),
and the size of the allocated buffer is returned in Size. It is the caller's responsibility
to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for
details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.
If the currently executing module was not loaded from an FFS file, then EFI_NOT_FOUND is returned.
If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
the search will be retried with a section type of EFI_SECTION_PE32.
This function must be called with a TPL <= TPL_NOTIFY.
If Buffer is NULL, then ASSERT().
If Size is NULL, then ASSERT().
@param SectionType Indicates the FFS section type to search for within
the FFS file that the currently executing module
was loaded from.
@param SectionInstance Indicates which section instance to retrieve within
the FFS file that the currently executing module
was loaded from.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer
using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
firmware volume that contains the matching FFS
section does not allow reads.
**/
EFI_STATUS
EFIAPI
GetSectionFromFfs (
IN EFI_SECTION_TYPE SectionType,
IN UINTN SectionInstance,
OUT VOID **Buffer,
OUT UINTN *Size
)
{
return InternalGetSectionFromFv(
InternalImageHandleToFvHandle(gImageHandle),
&gEfiCallerIdGuid,
SectionType,
SectionInstance,
Buffer,
Size
);
}
/**
Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section.
This function searches the firmware volume that the currently executing module was loaded
from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found a search
is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance
instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
It is the caller's responsibility to use FreePool() to free the allocated buffer.
See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from
an FFS file based on SectionType and SectionInstance.
If the currently executing module was not loaded from a firmware volume, then EFI_NOT_FOUND is returned.
If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
the search will be retried with a section type of EFI_SECTION_PE32.
This function must be called with a TPL <= TPL_NOTIFY.
If NameGuid is NULL, then ASSERT().
If Buffer is NULL, then ASSERT().
If Size is NULL, then ASSERT().
@param NameGuid A pointer to to the FFS filename GUID to search for
within the firmware volumes that the currently
executing module was loaded from.
@param SectionType Indicates the FFS section type to search for within
the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file
specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer
using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
firmware volume that contains the matching FFS
section does not allow reads.
**/
EFI_STATUS
EFIAPI
GetSectionFromFv (
IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType,
IN UINTN SectionInstance,
OUT VOID **Buffer,
OUT UINTN *Size
)
{
return InternalGetSectionFromFv (
InternalImageHandleToFvHandle(gImageHandle),
NameGuid,
SectionType,
SectionInstance,
Buffer,
Size
);
}
/**
Searches all the available firmware volumes and returns the first matching FFS section.
This function searches all the firmware volumes for FFS files with FV file type specified by FileType
The order that the firmware volumes is searched is not deterministic. For each available FV a search
is made for FFS file of type FileType. If the FV contains more than one FFS file with the same FileType,
the FileInstance instance will be the matched FFS file. For each FFS file found a search
is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances
of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
It is the caller's responsibility to use FreePool() to free the allocated buffer.
See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections
are retrieved from an FFS file based on SectionType and SectionInstance.
If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
the search will be retried with a section type of EFI_SECTION_PE32.
This function must be called with a TPL <= TPL_NOTIFY.
If Buffer is NULL, then ASSERT().
If Size is NULL, then ASSERT().
@param FileType Indicates the FV file type to search for within all
available FVs.
@param FileInstance Indicates which file instance within all available
FVs specified by FileType.
FileInstance starts from zero.
@param SectionType Indicates the FFS section type to search for
within the FFS file
specified by FileType with FileInstance.
@param SectionInstance Indicates which section instance within the FFS file
specified by FileType with FileInstance to retrieve.
SectionInstance starts from zero.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this
buffer using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because
the firmware volume that
contains the matching FFS section does not allow reads.
**/
EFI_STATUS
EFIAPI
GetSectionFromAnyFvByFileType (
IN EFI_FV_FILETYPE FileType,
IN UINTN FileInstance,
IN EFI_SECTION_TYPE SectionType,
IN UINTN SectionInstance,
OUT VOID **Buffer,
OUT UINTN *Size
)
{
EFI_STATUS Status;
EFI_HANDLE *HandleBuffer;
UINTN HandleCount;
UINTN IndexFv;
UINTN IndexFile;
UINTN Key;
EFI_GUID NameGuid;
EFI_FV_FILE_ATTRIBUTES Attributes;
EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;
//
// Locate all available FVs.
//
HandleBuffer = NULL;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiFirmwareVolume2ProtocolGuid,
NULL,
&HandleCount,
&HandleBuffer
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Go through FVs one by one to find the required section data.
//
for (IndexFv = 0; IndexFv < HandleCount; IndexFv++) {
Status = gBS->HandleProtocol (
HandleBuffer[IndexFv],
&gEfiFirmwareVolume2ProtocolGuid,
(VOID **)&Fv
);
if (EFI_ERROR (Status)) {
continue;
}
//
// Use Firmware Volume 2 Protocol to search for a file of type FileType in all FVs.
//
IndexFile = FileInstance + 1;
Key = 0;
do {
Status = Fv->GetNextFile (Fv, &Key, &FileType, &NameGuid, &Attributes, Size);
if (EFI_ERROR (Status)) {
break;
}
IndexFile --;
} while (IndexFile > 0);
//
// Fv File with the required FV file type is found.
// Search the section file in the found FV file.
//
if (IndexFile == 0) {
Status = InternalGetSectionFromFv (
HandleBuffer[IndexFv],
&NameGuid,
SectionType,
SectionInstance,
Buffer,
Size
);
if (!EFI_ERROR (Status)) {
goto Done;
}
}
}
//
// The required FFS section file is not found.
//
if (IndexFv == HandleCount) {
Status = EFI_NOT_FOUND;
}
Done:
if (HandleBuffer != NULL) {
FreePool(HandleBuffer);
}
return Status;
}
/**
Searches all the availables firmware volumes and returns the first matching FFS section.
This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid.
The order that the firmware volumes is searched is not deterministic. For each FFS file found a search
is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances
of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
It is the caller's responsibility to use FreePool() to free the allocated buffer.
See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections
are retrieved from an FFS file based on SectionType and SectionInstance.
If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
the search will be retried with a section type of EFI_SECTION_PE32.
This function must be called with a TPL <= TPL_NOTIFY.
If NameGuid is NULL, then ASSERT().
If Buffer is NULL, then ASSERT().
If Size is NULL, then ASSERT().
@param NameGuid A pointer to to the FFS filename GUID to search for
within any of the firmware volumes in the platform.
@param SectionType Indicates the FFS section type to search for within
the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file
specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer
using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to
retrieve the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
firmware volume that
contains the matching FFS section does not allow reads.
**/
EFI_STATUS
EFIAPI
GetSectionFromAnyFv (
IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType,
IN UINTN SectionInstance,
OUT VOID **Buffer,
OUT UINTN *Size
)
{
EFI_STATUS Status;
EFI_HANDLE *HandleBuffer;
UINTN HandleCount;
UINTN Index;
EFI_HANDLE FvHandle;
//
// Search the FV that contain the caller's FFS first.
// FV builder can choose to build FFS into the this FV
// so that this implementation of GetSectionFromAnyFv
// will locate the FFS faster.
//
FvHandle = InternalImageHandleToFvHandle (gImageHandle);
Status = InternalGetSectionFromFv (
FvHandle,
NameGuid,
SectionType,
SectionInstance,
Buffer,
Size
);
if (!EFI_ERROR (Status)) {
return EFI_SUCCESS;
}
HandleBuffer = NULL;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiFirmwareVolume2ProtocolGuid,
NULL,
&HandleCount,
&HandleBuffer
);
if (EFI_ERROR (Status)) {
goto Done;
}
for (Index = 0; Index < HandleCount; Index++) {
//
// Skip the FV that contain the caller's FFS
//
if (HandleBuffer[Index] != FvHandle) {
Status = InternalGetSectionFromFv (
HandleBuffer[Index],
NameGuid,
SectionType,
SectionInstance,
Buffer,
Size
);
if (!EFI_ERROR (Status)) {
goto Done;
}
}
}
if (Index == HandleCount) {
Status = EFI_NOT_FOUND;
}
Done:
if (HandleBuffer != NULL) {
FreePool(HandleBuffer);
}
return Status;
}
/**
Searches all the available firmware volumes and returns the file device path of first matching
FFS section.
This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid.
The order that the firmware volumes is searched is not deterministic. For each FFS file found a search
is made for FFS sections of type SectionType.
If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
the search will be retried with a section type of EFI_SECTION_PE32.
This function must be called with a TPL <= TPL_NOTIFY.
If NameGuid is NULL, then ASSERT().
@param NameGuid A pointer to to the FFS filename GUID to search for
within any of the firmware volumes in the platform.
@param SectionType Indicates the FFS section type to search for within
the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file
specified by NameGuid to retrieve.
@param FvFileDevicePath Device path for the target FFS
file.
@retval EFI_SUCCESS The specified file device path of FFS section was returned.
@retval EFI_NOT_FOUND The specified file device path of FFS section could not be found.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
firmware volume that contains the matching FFS section does not
allow reads.
@retval EFI_INVALID_PARAMETER FvFileDevicePath is NULL.
**/
EFI_STATUS
EFIAPI
GetFileDevicePathFromAnyFv (
IN CONST EFI_GUID *NameGuid,
IN EFI_SECTION_TYPE SectionType,
IN UINTN SectionInstance,
OUT EFI_DEVICE_PATH_PROTOCOL **FvFileDevicePath
)
{
EFI_STATUS Status;
EFI_HANDLE *HandleBuffer;
UINTN HandleCount;
UINTN Index;
EFI_HANDLE FvHandle;
EFI_DEVICE_PATH_PROTOCOL *FvDevicePath;
MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *TempFvFileDevicePath;
VOID *Buffer;
UINTN Size;
if (FvFileDevicePath == NULL) {
return EFI_INVALID_PARAMETER;
}
HandleBuffer = NULL;
FvDevicePath = NULL;
TempFvFileDevicePath = NULL;
Buffer = NULL;
Size = 0;
//
// Search the FV that contain the caller's FFS first.
// FV builder can choose to build FFS into the this FV
// so that this implementation of GetSectionFromAnyFv
// will locate the FFS faster.
//
FvHandle = InternalImageHandleToFvHandle (gImageHandle);
Status = InternalGetSectionFromFv (
FvHandle,
NameGuid,
SectionType,
SectionInstance,
&Buffer,
&Size
);
if (!EFI_ERROR (Status)) {
goto Done;
}
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiFirmwareVolume2ProtocolGuid,
NULL,
&HandleCount,
&HandleBuffer
);
if (EFI_ERROR (Status)) {
goto Done;
}
for (Index = 0; Index < HandleCount; Index++) {
//
// Skip the FV that contain the caller's FFS
//
if (HandleBuffer[Index] != FvHandle) {
Status = InternalGetSectionFromFv (
HandleBuffer[Index],
NameGuid,
SectionType,
SectionInstance,
&Buffer,
&Size
);
if (!EFI_ERROR (Status)) {
//
// Update FvHandle to the current handle.
//
FvHandle = HandleBuffer[Index];
goto Done;
}
}
}
if (Index == HandleCount) {
Status = EFI_NOT_FOUND;
}
Done:
if (Status == EFI_SUCCESS) {
//
// Build a device path to the file in the FV to pass into gBS->LoadImage
//
Status = gBS->HandleProtocol (FvHandle, &gEfiDevicePathProtocolGuid, (VOID **)&FvDevicePath);
if (EFI_ERROR (Status)) {
*FvFileDevicePath = NULL;
} else {
TempFvFileDevicePath = AllocateZeroPool (sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH) + END_DEVICE_PATH_LENGTH);
if (TempFvFileDevicePath == NULL) {
*FvFileDevicePath = NULL;
return EFI_OUT_OF_RESOURCES;
}
EfiInitializeFwVolDevicepathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH*)TempFvFileDevicePath, NameGuid);
SetDevicePathEndNode (NextDevicePathNode (TempFvFileDevicePath));
*FvFileDevicePath = AppendDevicePath (
FvDevicePath,
(EFI_DEVICE_PATH_PROTOCOL *)TempFvFileDevicePath
);
FreePool (TempFvFileDevicePath);
}
}
if (Buffer != NULL) {
FreePool (Buffer);
}
if (HandleBuffer != NULL) {
FreePool (HandleBuffer);
}
return Status;
}
