mirror of https://github.com/acidanthera/audk.git
1443 lines
48 KiB
C
1443 lines
48 KiB
C
/** @file
|
||
Pei Core Firmware File System service routines.
|
||
|
||
Copyright (c) 2006 - 2009, Intel Corporation
|
||
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.
|
||
|
||
**/
|
||
|
||
#include "FwVol.h"
|
||
|
||
EFI_PEI_NOTIFY_DESCRIPTOR mNotifyOnFvInfoList = {
|
||
(EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
|
||
&gEfiPeiFirmwareVolumeInfoPpiGuid,
|
||
FirmwareVolmeInfoPpiNotifyCallback
|
||
};
|
||
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI mPeiFfs2FvPpi = {
|
||
PeiFfs2FvPpiProcessVolume,
|
||
PeiFfs2FvPpiFindFileByType,
|
||
PeiFfs2FvPpiFindFileByName,
|
||
PeiFfs2FvPpiGetFileInfo,
|
||
PeiFfs2FvPpiGetVolumeInfo,
|
||
PeiFfs2FvPpiFindSectionByType
|
||
};
|
||
|
||
EFI_PEI_PPI_DESCRIPTOR mPeiFfs2FvPpiList = {
|
||
(EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
|
||
&gEfiFirmwareFileSystem2Guid,
|
||
&mPeiFfs2FvPpi
|
||
};
|
||
|
||
/**
|
||
Returns the file state set by the highest zero bit in the State field
|
||
|
||
@param ErasePolarity Erase Polarity as defined by EFI_FVB2_ERASE_POLARITY
|
||
in the Attributes field.
|
||
@param FfsHeader Pointer to FFS File Header.
|
||
|
||
@retval EFI_FFS_FILE_STATE File state is set by the highest none zero bit
|
||
in the header State field.
|
||
**/
|
||
EFI_FFS_FILE_STATE
|
||
GetFileState(
|
||
IN UINT8 ErasePolarity,
|
||
IN EFI_FFS_FILE_HEADER *FfsHeader
|
||
)
|
||
{
|
||
EFI_FFS_FILE_STATE FileState;
|
||
EFI_FFS_FILE_STATE HighestBit;
|
||
|
||
FileState = FfsHeader->State;
|
||
|
||
if (ErasePolarity != 0) {
|
||
FileState = (EFI_FFS_FILE_STATE)~FileState;
|
||
}
|
||
|
||
//
|
||
// Get file state set by its highest none zero bit.
|
||
//
|
||
HighestBit = 0x80;
|
||
while (HighestBit != 0 && (HighestBit & FileState) == 0) {
|
||
HighestBit >>= 1;
|
||
}
|
||
|
||
return HighestBit;
|
||
}
|
||
|
||
/**
|
||
Calculates the checksum of the header of a file.
|
||
|
||
@param FileHeader Pointer to FFS File Header.
|
||
|
||
@return Checksum of the header.
|
||
Zero means the header is good.
|
||
Non-zero means the header is bad.
|
||
**/
|
||
UINT8
|
||
CalculateHeaderChecksum (
|
||
IN EFI_FFS_FILE_HEADER *FileHeader
|
||
)
|
||
{
|
||
EFI_FFS_FILE_HEADER TestFileHeader;
|
||
|
||
CopyMem (&TestFileHeader, FileHeader, sizeof (EFI_FFS_FILE_HEADER));
|
||
//
|
||
// Ingore State and File field in FFS header.
|
||
//
|
||
TestFileHeader.State = 0;
|
||
TestFileHeader.IntegrityCheck.Checksum.File = 0;
|
||
|
||
return CalculateSum8 ((CONST UINT8 *) &TestFileHeader, sizeof (EFI_FFS_FILE_HEADER));
|
||
}
|
||
|
||
/**
|
||
Find FV handler according to FileHandle in that FV.
|
||
|
||
@param FileHandle Handle of file image
|
||
|
||
@return Pointer to instance of PEI_CORE_FV_HANDLE.
|
||
**/
|
||
PEI_CORE_FV_HANDLE*
|
||
FileHandleToVolume (
|
||
IN EFI_PEI_FILE_HANDLE FileHandle
|
||
)
|
||
{
|
||
UINTN Index;
|
||
PEI_CORE_INSTANCE *PrivateData;
|
||
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;
|
||
|
||
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer ());
|
||
|
||
for (Index = 0; Index < PrivateData->FvCount; Index++) {
|
||
FwVolHeader = PrivateData->Fv[Index].FvHeader;
|
||
if (((UINT64) (UINTN) FileHandle > (UINT64) (UINTN) FwVolHeader ) && \
|
||
((UINT64) (UINTN) FileHandle <= ((UINT64) (UINTN) FwVolHeader + FwVolHeader->FvLength - 1))) {
|
||
return &PrivateData->Fv[Index];
|
||
}
|
||
}
|
||
return NULL;
|
||
}
|
||
|
||
/**
|
||
Given the input file pointer, search for the first matching file in the
|
||
FFS volume as defined by SearchType. The search starts from FileHeader inside
|
||
the Firmware Volume defined by FwVolHeader.
|
||
If SearchType is EFI_FV_FILETYPE_ALL, the first FFS file will return without check its file type.
|
||
If SearchType is PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE,
|
||
the first PEIM, or COMBINED PEIM or FV file type FFS file will return.
|
||
|
||
@param FvHandle Pointer to the FV header of the volume to search
|
||
@param FileName File name
|
||
@param SearchType Filter to find only files of this type.
|
||
Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
|
||
@param FileHandle This parameter must point to a valid FFS volume.
|
||
@param AprioriFile Pointer to AprioriFile image in this FV if has
|
||
|
||
@return EFI_NOT_FOUND No files matching the search criteria were found
|
||
@retval EFI_SUCCESS Success to search given file
|
||
|
||
**/
|
||
EFI_STATUS
|
||
FindFileEx (
|
||
IN CONST EFI_PEI_FV_HANDLE FvHandle,
|
||
IN CONST EFI_GUID *FileName, OPTIONAL
|
||
IN EFI_FV_FILETYPE SearchType,
|
||
IN OUT EFI_PEI_FILE_HANDLE *FileHandle,
|
||
IN OUT EFI_PEI_FV_HANDLE *AprioriFile OPTIONAL
|
||
)
|
||
{
|
||
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;
|
||
EFI_FFS_FILE_HEADER **FileHeader;
|
||
EFI_FFS_FILE_HEADER *FfsFileHeader;
|
||
UINT32 FileLength;
|
||
UINT32 FileOccupiedSize;
|
||
UINT32 FileOffset;
|
||
UINT64 FvLength;
|
||
UINT8 ErasePolarity;
|
||
UINT8 FileState;
|
||
|
||
//
|
||
// Convert the handle of FV to FV header for memory-mapped firmware volume
|
||
//
|
||
FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) FvHandle;
|
||
FileHeader = (EFI_FFS_FILE_HEADER **)FileHandle;
|
||
|
||
FvLength = FwVolHeader->FvLength;
|
||
if ((FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) != 0) {
|
||
ErasePolarity = 1;
|
||
} else {
|
||
ErasePolarity = 0;
|
||
}
|
||
|
||
//
|
||
// If FileHeader is not specified (NULL) or FileName is not NULL,
|
||
// start with the first file in the firmware volume. Otherwise,
|
||
// start from the FileHeader.
|
||
//
|
||
if ((*FileHeader == NULL) || (FileName != NULL)) {
|
||
FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FwVolHeader + FwVolHeader->HeaderLength);
|
||
} else {
|
||
//
|
||
// Length is 24 bits wide so mask upper 8 bits
|
||
// FileLength is adjusted to FileOccupiedSize as it is 8 byte aligned.
|
||
//
|
||
FileLength = *(UINT32 *)(*FileHeader)->Size & 0x00FFFFFF;
|
||
FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);
|
||
FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)*FileHeader + FileOccupiedSize);
|
||
}
|
||
|
||
FileOffset = (UINT32) ((UINT8 *)FfsFileHeader - (UINT8 *)FwVolHeader);
|
||
ASSERT (FileOffset <= 0xFFFFFFFF);
|
||
|
||
while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {
|
||
//
|
||
// Get FileState which is the highest bit of the State
|
||
//
|
||
FileState = GetFileState (ErasePolarity, FfsFileHeader);
|
||
switch (FileState) {
|
||
|
||
case EFI_FILE_HEADER_INVALID:
|
||
FileOffset += sizeof(EFI_FFS_FILE_HEADER);
|
||
FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + sizeof(EFI_FFS_FILE_HEADER));
|
||
break;
|
||
|
||
case EFI_FILE_DATA_VALID:
|
||
case EFI_FILE_MARKED_FOR_UPDATE:
|
||
if (CalculateHeaderChecksum (FfsFileHeader) != 0) {
|
||
ASSERT (FALSE);
|
||
*FileHeader = NULL;
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
|
||
FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;
|
||
FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);
|
||
|
||
if (FileName != NULL) {
|
||
if (CompareGuid (&FfsFileHeader->Name, (EFI_GUID*)FileName)) {
|
||
*FileHeader = FfsFileHeader;
|
||
return EFI_SUCCESS;
|
||
}
|
||
} else if (SearchType == PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE) {
|
||
if ((FfsFileHeader->Type == EFI_FV_FILETYPE_PEIM) ||
|
||
(FfsFileHeader->Type == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER) ||
|
||
(FfsFileHeader->Type == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE)) {
|
||
|
||
*FileHeader = FfsFileHeader;
|
||
return EFI_SUCCESS;
|
||
} else if (AprioriFile != NULL) {
|
||
if (FfsFileHeader->Type == EFI_FV_FILETYPE_FREEFORM) {
|
||
if (CompareGuid (&FfsFileHeader->Name, &gPeiAprioriFileNameGuid)) {
|
||
*AprioriFile = FfsFileHeader;
|
||
}
|
||
}
|
||
}
|
||
} else if (((SearchType == FfsFileHeader->Type) || (SearchType == EFI_FV_FILETYPE_ALL)) &&
|
||
(FfsFileHeader->Type != EFI_FV_FILETYPE_FFS_PAD)) {
|
||
*FileHeader = FfsFileHeader;
|
||
return EFI_SUCCESS;
|
||
}
|
||
|
||
FileOffset += FileOccupiedSize;
|
||
FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);
|
||
break;
|
||
|
||
case EFI_FILE_DELETED:
|
||
FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;
|
||
FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);
|
||
FileOffset += FileOccupiedSize;
|
||
FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);
|
||
break;
|
||
|
||
default:
|
||
*FileHeader = NULL;
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
}
|
||
|
||
*FileHeader = NULL;
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
|
||
/**
|
||
Initialize PeiCore Fv List.
|
||
|
||
@param PrivateData - Pointer to PEI_CORE_INSTANCE.
|
||
@param SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.
|
||
**/
|
||
VOID
|
||
PeiInitializeFv (
|
||
IN PEI_CORE_INSTANCE *PrivateData,
|
||
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData
|
||
)
|
||
{
|
||
EFI_STATUS Status;
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI *FvPpi;
|
||
EFI_PEI_FV_HANDLE FvHandle;
|
||
EFI_FIRMWARE_VOLUME_HEADER *BfvHeader;
|
||
|
||
//
|
||
// Install FV_PPI for FFS2 file system.
|
||
//
|
||
PeiServicesInstallPpi (&mPeiFfs2FvPpiList);
|
||
|
||
BfvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)SecCoreData->BootFirmwareVolumeBase;
|
||
|
||
//
|
||
// The FV_PPI in BFV's format should be installed.
|
||
//
|
||
Status = PeiServicesLocatePpi (
|
||
&BfvHeader->FileSystemGuid,
|
||
0,
|
||
NULL,
|
||
(VOID**)&FvPpi
|
||
);
|
||
ASSERT_EFI_ERROR (Status);
|
||
|
||
//
|
||
// Get handle of BFV
|
||
//
|
||
FvPpi->ProcessVolume (
|
||
FvPpi,
|
||
SecCoreData->BootFirmwareVolumeBase,
|
||
(UINTN)BfvHeader->FvLength,
|
||
&FvHandle
|
||
);
|
||
|
||
//
|
||
// Update internal PEI_CORE_FV array.
|
||
//
|
||
PrivateData->Fv[PrivateData->FvCount].FvHeader = BfvHeader;
|
||
PrivateData->Fv[PrivateData->FvCount].FvPpi = FvPpi;
|
||
PrivateData->Fv[PrivateData->FvCount].FvHandle = FvHandle;
|
||
DEBUG ((
|
||
EFI_D_INFO,
|
||
"The %dth FV start address is 0x%11p, size is 0x%08x, handle is 0x%p\n",
|
||
(UINT32) PrivateData->FvCount,
|
||
(VOID *) BfvHeader,
|
||
BfvHeader->FvLength,
|
||
FvHandle
|
||
));
|
||
PrivateData->FvCount ++;
|
||
|
||
//
|
||
// Post a call-back for the FvInfoPPI services to expose
|
||
// additional Fvs to PeiCore.
|
||
//
|
||
Status = PeiServicesNotifyPpi (&mNotifyOnFvInfoList);
|
||
ASSERT_EFI_ERROR (Status);
|
||
|
||
}
|
||
|
||
/**
|
||
Process Firmware Volum Information once FvInfoPPI install.
|
||
The FV Info will be registered into PeiCore private data structure.
|
||
And search the inside FV image, if found, the new FV INFO PPI will be installed.
|
||
|
||
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
|
||
@param NotifyDescriptor Address of the notification descriptor data structure.
|
||
@param Ppi Address of the PPI that was installed.
|
||
|
||
@retval EFI_SUCCESS The FV Info is registered into PeiCore private data structure.
|
||
@return if not EFI_SUCESS, fail to verify FV.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
FirmwareVolmeInfoPpiNotifyCallback (
|
||
IN EFI_PEI_SERVICES **PeiServices,
|
||
IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,
|
||
IN VOID *Ppi
|
||
)
|
||
{
|
||
EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *FvInfoPpi;
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI *FvPpi;
|
||
PEI_CORE_INSTANCE *PrivateData;
|
||
EFI_STATUS Status;
|
||
EFI_PEI_FV_HANDLE FvHandle;
|
||
UINTN FvIndex;
|
||
EFI_PEI_FILE_HANDLE FileHandle;
|
||
VOID *DepexData;
|
||
|
||
Status = EFI_SUCCESS;
|
||
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);
|
||
|
||
if (PrivateData->FvCount >= FixedPcdGet32 (PcdPeiCoreMaxFvSupported)) {
|
||
DEBUG ((EFI_D_ERROR, "The number of Fv Images (%d) exceed the max supported FVs (%d) in Pei", PrivateData->FvCount + 1, FixedPcdGet32 (PcdPeiCoreMaxFvSupported)));
|
||
DEBUG ((EFI_D_ERROR, "PcdPeiCoreMaxFvSupported value need be reconfigurated in DSC"));
|
||
ASSERT (FALSE);
|
||
}
|
||
|
||
FvInfoPpi = (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *)Ppi;
|
||
|
||
//
|
||
// Locate the corresponding FV_PPI according to founded FV's format guid
|
||
//
|
||
Status = PeiServicesLocatePpi (
|
||
&FvInfoPpi->FvFormat,
|
||
0,
|
||
NULL,
|
||
(VOID**)&FvPpi
|
||
);
|
||
if (!EFI_ERROR (Status)) {
|
||
//
|
||
// Process new found FV and get FV handle.
|
||
//
|
||
Status = FvPpi->ProcessVolume (FvPpi, FvInfoPpi->FvInfo, FvInfoPpi->FvInfoSize, &FvHandle);
|
||
if (EFI_ERROR (Status)) {
|
||
DEBUG ((EFI_D_ERROR, "Fail to process new found FV, FV may be corrupted!\n"));
|
||
return Status;
|
||
}
|
||
|
||
//
|
||
// Check whether the FV has already been processed.
|
||
//
|
||
for (FvIndex = 0; FvIndex < PrivateData->FvCount; FvIndex ++) {
|
||
if (PrivateData->Fv[FvIndex].FvHandle == FvHandle) {
|
||
DEBUG ((EFI_D_INFO, "The Fv %p has already been processed!\n", FvInfoPpi->FvInfo));
|
||
return EFI_SUCCESS;
|
||
}
|
||
}
|
||
|
||
//
|
||
// Update internal PEI_CORE_FV array.
|
||
//
|
||
PrivateData->Fv[PrivateData->FvCount].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) FvInfoPpi->FvInfo;
|
||
PrivateData->Fv[PrivateData->FvCount].FvPpi = FvPpi;
|
||
PrivateData->Fv[PrivateData->FvCount].FvHandle = FvHandle;
|
||
DEBUG ((
|
||
EFI_D_INFO,
|
||
"The %dth FV start address is 0x%11p, size is 0x%08x, handle is 0x%p\n",
|
||
(UINT32) PrivateData->FvCount,
|
||
(VOID *) FvInfoPpi->FvInfo,
|
||
FvInfoPpi->FvInfoSize,
|
||
FvHandle
|
||
));
|
||
PrivateData->FvCount ++;
|
||
|
||
//
|
||
// Scan and process the new discoveried FV for EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
|
||
//
|
||
FileHandle = NULL;
|
||
do {
|
||
Status = FvPpi->FindFileByType (
|
||
FvPpi,
|
||
EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE,
|
||
FvHandle,
|
||
&FileHandle
|
||
);
|
||
if (!EFI_ERROR (Status)) {
|
||
Status = FvPpi->FindSectionByType (
|
||
FvPpi,
|
||
EFI_SECTION_PEI_DEPEX,
|
||
FileHandle,
|
||
(VOID**)&DepexData
|
||
);
|
||
if (!EFI_ERROR (Status)) {
|
||
if (!PeimDispatchReadiness (PeiServices, DepexData)) {
|
||
//
|
||
// Dependency is not satisfied.
|
||
//
|
||
continue;
|
||
}
|
||
}
|
||
|
||
DEBUG ((EFI_D_INFO, "Found firmware volume Image File %p in FV[%d] %p\n", FileHandle, PrivateData->FvCount - 1, FvHandle));
|
||
ProcessFvFile (&PrivateData->Fv[PrivateData->FvCount - 1], FileHandle);
|
||
}
|
||
} while (FileHandle != NULL);
|
||
} else {
|
||
DEBUG ((EFI_D_ERROR, "Fail to process FV %p because no corresponding EFI_FIRMWARE_VOLUME_PPI is found!\n", FvInfoPpi->FvInfo));
|
||
|
||
//
|
||
// If can not find EFI_FIRMWARE_VOLUME_PPI to process firmware to get FvHandle,
|
||
// use the address of FV buffer as its handle.
|
||
//
|
||
FvHandle = FvInfoPpi->FvInfo;
|
||
|
||
//
|
||
// Check whether the FV has already been processed.
|
||
//
|
||
for (FvIndex = 0; FvIndex < PrivateData->FvCount; FvIndex ++) {
|
||
if (PrivateData->Fv[FvIndex].FvHandle == FvHandle) {
|
||
DEBUG ((EFI_D_INFO, "The Fv %p has already been processed!\n", FvHandle));
|
||
return EFI_SUCCESS;
|
||
}
|
||
}
|
||
|
||
PrivateData->Fv[PrivateData->FvCount].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) FvInfoPpi->FvInfo;
|
||
PrivateData->Fv[PrivateData->FvCount].FvPpi = NULL;
|
||
PrivateData->Fv[PrivateData->FvCount].FvHandle = FvHandle;
|
||
PrivateData->FvCount ++;
|
||
}
|
||
|
||
return EFI_SUCCESS;
|
||
}
|
||
|
||
/**
|
||
Go through the file to search SectionType section.
|
||
Search within encapsulation sections (compression and GUIDed) recursively,
|
||
until the match section is found.
|
||
|
||
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
|
||
@param SectionType Filter to find only section of this type.
|
||
@param Section From where to search.
|
||
@param SectionSize The file size to search.
|
||
@param OutputBuffer A pointer to the discovered section, if successful.
|
||
NULL if section not found
|
||
|
||
@return EFI_NOT_FOUND The match section is not found.
|
||
@return EFI_SUCCESS The match section is found.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
ProcessSection (
|
||
IN CONST EFI_PEI_SERVICES **PeiServices,
|
||
IN EFI_SECTION_TYPE SectionType,
|
||
IN EFI_COMMON_SECTION_HEADER *Section,
|
||
IN UINTN SectionSize,
|
||
OUT VOID **OutputBuffer
|
||
)
|
||
{
|
||
EFI_STATUS Status;
|
||
UINT32 SectionLength;
|
||
UINT32 ParsedLength;
|
||
EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *GuidSectionPpi;
|
||
EFI_PEI_DECOMPRESS_PPI *DecompressPpi;
|
||
VOID *PpiOutput;
|
||
UINTN PpiOutputSize;
|
||
UINTN Index;
|
||
UINT32 Authentication;
|
||
PEI_CORE_INSTANCE *PrivateData;
|
||
|
||
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);
|
||
*OutputBuffer = NULL;
|
||
ParsedLength = 0;
|
||
Index = 0;
|
||
Status = EFI_NOT_FOUND;
|
||
PpiOutput = NULL;
|
||
PpiOutputSize = 0;
|
||
while (ParsedLength < SectionSize) {
|
||
if (Section->Type == SectionType) {
|
||
*OutputBuffer = (VOID *)(Section + 1);
|
||
return EFI_SUCCESS;
|
||
} else if ((Section->Type == EFI_SECTION_GUID_DEFINED) || (Section->Type == EFI_SECTION_COMPRESSION)) {
|
||
//
|
||
// Check the encapsulated section is extracted into the cache data.
|
||
//
|
||
for (Index = 0; Index < PrivateData->CacheSection.AllSectionCount; Index ++) {
|
||
if (Section == PrivateData->CacheSection.Section[Index]) {
|
||
PpiOutput = PrivateData->CacheSection.SectionData[Index];
|
||
PpiOutputSize = PrivateData->CacheSection.SectionSize[Index];
|
||
//
|
||
// Search section directly from the cache data.
|
||
//
|
||
return ProcessSection (
|
||
PeiServices,
|
||
SectionType,
|
||
PpiOutput,
|
||
PpiOutputSize,
|
||
OutputBuffer
|
||
);
|
||
}
|
||
}
|
||
|
||
Status = EFI_NOT_FOUND;
|
||
if (Section->Type == EFI_SECTION_GUID_DEFINED) {
|
||
Status = PeiServicesLocatePpi (
|
||
&((EFI_GUID_DEFINED_SECTION *)Section)->SectionDefinitionGuid,
|
||
0,
|
||
NULL,
|
||
(VOID **) &GuidSectionPpi
|
||
);
|
||
if (!EFI_ERROR (Status)) {
|
||
Status = GuidSectionPpi->ExtractSection (
|
||
GuidSectionPpi,
|
||
Section,
|
||
&PpiOutput,
|
||
&PpiOutputSize,
|
||
&Authentication
|
||
);
|
||
}
|
||
} else if (Section->Type == EFI_SECTION_COMPRESSION) {
|
||
Status = PeiServicesLocatePpi (&gEfiPeiDecompressPpiGuid, 0, NULL, (VOID **) &DecompressPpi);
|
||
if (!EFI_ERROR (Status)) {
|
||
Status = DecompressPpi->Decompress (
|
||
DecompressPpi,
|
||
(CONST EFI_COMPRESSION_SECTION*) Section,
|
||
&PpiOutput,
|
||
&PpiOutputSize
|
||
);
|
||
}
|
||
}
|
||
|
||
if (!EFI_ERROR (Status)) {
|
||
//
|
||
// Update cache section data.
|
||
//
|
||
if (PrivateData->CacheSection.AllSectionCount < CACHE_SETION_MAX_NUMBER) {
|
||
PrivateData->CacheSection.AllSectionCount ++;
|
||
}
|
||
PrivateData->CacheSection.Section [PrivateData->CacheSection.SectionIndex] = Section;
|
||
PrivateData->CacheSection.SectionData [PrivateData->CacheSection.SectionIndex] = PpiOutput;
|
||
PrivateData->CacheSection.SectionSize [PrivateData->CacheSection.SectionIndex] = PpiOutputSize;
|
||
PrivateData->CacheSection.SectionIndex = (PrivateData->CacheSection.SectionIndex + 1)%CACHE_SETION_MAX_NUMBER;
|
||
|
||
return ProcessSection (
|
||
PeiServices,
|
||
SectionType,
|
||
PpiOutput,
|
||
PpiOutputSize,
|
||
OutputBuffer
|
||
);
|
||
}
|
||
}
|
||
|
||
//
|
||
// Size is 24 bits wide so mask upper 8 bits.
|
||
// SectionLength is adjusted it is 4 byte aligned.
|
||
// Go to the next section
|
||
//
|
||
SectionLength = *(UINT32 *)Section->Size & 0x00FFFFFF;
|
||
SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);
|
||
ASSERT (SectionLength != 0);
|
||
ParsedLength += SectionLength;
|
||
Section = (EFI_COMMON_SECTION_HEADER *)((UINT8 *)Section + SectionLength);
|
||
}
|
||
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
|
||
|
||
/**
|
||
Searches for the next matching section within the specified file.
|
||
|
||
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
|
||
@param SectionType Filter to find only sections of this type.
|
||
@param FileHandle Pointer to the current file to search.
|
||
@param SectionData A pointer to the discovered section, if successful.
|
||
NULL if section not found
|
||
|
||
@retval EFI_NOT_FOUND The section was not found.
|
||
@retval EFI_SUCCESS The section was found.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfsFindSectionData (
|
||
IN CONST EFI_PEI_SERVICES **PeiServices,
|
||
IN EFI_SECTION_TYPE SectionType,
|
||
IN EFI_PEI_FILE_HANDLE FileHandle,
|
||
OUT VOID **SectionData
|
||
)
|
||
{
|
||
PEI_CORE_FV_HANDLE *CoreFvHandle;
|
||
|
||
CoreFvHandle = FileHandleToVolume (FileHandle);
|
||
if ((CoreFvHandle == NULL) || (CoreFvHandle->FvPpi == NULL)) {
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
|
||
return CoreFvHandle->FvPpi->FindSectionByType (CoreFvHandle->FvPpi, SectionType, FileHandle, SectionData);
|
||
}
|
||
|
||
/**
|
||
Searches for the next matching file in the firmware volume.
|
||
|
||
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
|
||
@param SearchType Filter to find only files of this type.
|
||
Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
|
||
@param VolumeHandle Handle of firmware volume in which to search.
|
||
@param FileHandle On entry, points to the current handle from which to begin searching or NULL to start
|
||
at the beginning of the firmware volume. On exit, points the file handle of the next file
|
||
in the volume or NULL if there are no more files.
|
||
|
||
@retval EFI_NOT_FOUND The file was not found.
|
||
@retval EFI_NOT_FOUND The header checksum was not zero.
|
||
@retval EFI_SUCCESS The file was found.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfsFindNextFile (
|
||
IN CONST EFI_PEI_SERVICES **PeiServices,
|
||
IN UINT8 SearchType,
|
||
IN EFI_PEI_FV_HANDLE FvHandle,
|
||
IN OUT EFI_PEI_FILE_HANDLE *FileHandle
|
||
)
|
||
{
|
||
PEI_CORE_FV_HANDLE *CoreFvHandle;
|
||
|
||
CoreFvHandle = FvHandleToCoreHandle (FvHandle);
|
||
|
||
//
|
||
// To make backward compatiblity, if can not find corresponding the handle of FV
|
||
// then treat FV as build-in FFS2 format and memory mapped FV that FV handle is pointed
|
||
// to the address of first byte of FV.
|
||
//
|
||
if ((CoreFvHandle == NULL) && FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {
|
||
return FindFileEx (FvHandle, NULL, SearchType, FileHandle, NULL);
|
||
}
|
||
|
||
if ((CoreFvHandle == NULL) || CoreFvHandle->FvPpi == NULL) {
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
|
||
return CoreFvHandle->FvPpi->FindFileByType (CoreFvHandle->FvPpi, SearchType, FvHandle, FileHandle);
|
||
}
|
||
|
||
|
||
/**
|
||
Search the firmware volumes by index
|
||
|
||
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
|
||
@param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware
|
||
Volume (BFV).
|
||
@param VolumeHandle On exit, points to the next volume handle or NULL if it does not exist.
|
||
|
||
@retval EFI_INVALID_PARAMETER VolumeHandle is NULL
|
||
@retval EFI_NOT_FOUND The volume was not found.
|
||
@retval EFI_SUCCESS The volume was found.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfsFindNextVolume (
|
||
IN CONST EFI_PEI_SERVICES **PeiServices,
|
||
IN UINTN Instance,
|
||
IN OUT EFI_PEI_FV_HANDLE *VolumeHandle
|
||
)
|
||
{
|
||
PEI_CORE_INSTANCE *Private;
|
||
PEI_CORE_FV_HANDLE *CoreFvHandle;
|
||
|
||
if (VolumeHandle == NULL) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
Private = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);
|
||
|
||
CoreFvHandle = FindNextCoreFvHandle (Private, Instance);
|
||
if (CoreFvHandle == NULL) {
|
||
*VolumeHandle = NULL;
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
|
||
*VolumeHandle = CoreFvHandle->FvHandle;
|
||
|
||
return EFI_SUCCESS;
|
||
}
|
||
|
||
|
||
/**
|
||
Find a file within a volume by its name.
|
||
|
||
@param FileName A pointer to the name of the file to find within the firmware volume.
|
||
@param VolumeHandle The firmware volume to search
|
||
@param FileHandle Upon exit, points to the found file's handle
|
||
or NULL if it could not be found.
|
||
|
||
@retval EFI_SUCCESS File was found.
|
||
@retval EFI_NOT_FOUND File was not found.
|
||
@retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or FileName was NULL.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfsFindFileByName (
|
||
IN CONST EFI_GUID *FileName,
|
||
IN EFI_PEI_FV_HANDLE VolumeHandle,
|
||
OUT EFI_PEI_FILE_HANDLE *FileHandle
|
||
)
|
||
{
|
||
PEI_CORE_FV_HANDLE *CoreFvHandle;
|
||
|
||
if ((VolumeHandle == NULL) || (FileName == NULL) || (FileHandle == NULL)) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
CoreFvHandle = FvHandleToCoreHandle (VolumeHandle);
|
||
if ((CoreFvHandle == NULL) || (CoreFvHandle->FvPpi == NULL)) {
|
||
return EFI_NOT_FOUND;
|
||
}
|
||
|
||
return CoreFvHandle->FvPpi->FindFileByName (CoreFvHandle->FvPpi, FileName, &VolumeHandle, FileHandle);
|
||
}
|
||
|
||
/**
|
||
Returns information about a specific file.
|
||
|
||
@param FileHandle Handle of the file.
|
||
@param FileInfo Upon exit, points to the file’s information.
|
||
|
||
@retval EFI_INVALID_PARAMETER If FileInfo is NULL.
|
||
@retval EFI_INVALID_PARAMETER If FileHandle does not represent a valid file.
|
||
@retval EFI_SUCCESS File information returned.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfsGetFileInfo (
|
||
IN EFI_PEI_FILE_HANDLE FileHandle,
|
||
OUT EFI_FV_FILE_INFO *FileInfo
|
||
)
|
||
{
|
||
PEI_CORE_FV_HANDLE *CoreFvHandle;
|
||
|
||
if ((FileHandle == NULL) || (FileInfo == NULL)) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
//
|
||
// Retrieve the FirmwareVolume which the file resides in.
|
||
//
|
||
CoreFvHandle = FileHandleToVolume (FileHandle);
|
||
if ((CoreFvHandle == NULL) || (CoreFvHandle->FvPpi == NULL)) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
return CoreFvHandle->FvPpi->GetFileInfo (CoreFvHandle->FvPpi, FileHandle, FileInfo);
|
||
}
|
||
|
||
|
||
/**
|
||
Returns information about the specified volume.
|
||
|
||
This function returns information about a specific firmware
|
||
volume, including its name, type, attributes, starting address
|
||
and size.
|
||
|
||
@param VolumeHandle Handle of the volume.
|
||
@param VolumeInfo Upon exit, points to the volume's information.
|
||
|
||
@retval EFI_SUCCESS Volume information returned.
|
||
@retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.
|
||
@retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.
|
||
@retval EFI_SUCCESS Information successfully returned.
|
||
@retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfsGetVolumeInfo (
|
||
IN EFI_PEI_FV_HANDLE VolumeHandle,
|
||
OUT EFI_FV_INFO *VolumeInfo
|
||
)
|
||
{
|
||
PEI_CORE_FV_HANDLE *CoreHandle;
|
||
|
||
if (VolumeInfo == NULL) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
CoreHandle = FvHandleToCoreHandle (VolumeHandle);
|
||
|
||
if ((CoreHandle == NULL) || (CoreHandle->FvPpi == NULL)) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
return CoreHandle->FvPpi->GetVolumeInfo (CoreHandle->FvPpi, VolumeHandle, VolumeInfo);
|
||
}
|
||
|
||
/**
|
||
Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.
|
||
|
||
@param ParentFvCoreHandle Pointer of EFI_CORE_FV_HANDLE to parent Fv image that contain this Fv image.
|
||
@param ParentFvFileHandle File handle of a Fv type file that contain this Fv image.
|
||
|
||
@retval EFI_NOT_FOUND FV image can't be found.
|
||
@retval EFI_SUCCESS Successfully to process it.
|
||
@retval EFI_OUT_OF_RESOURCES Can not allocate page when aligning FV image
|
||
@retval Others Can not find EFI_SECTION_FIRMWARE_VOLUME_IMAGE section
|
||
|
||
**/
|
||
EFI_STATUS
|
||
ProcessFvFile (
|
||
IN PEI_CORE_FV_HANDLE *ParentFvCoreHandle,
|
||
IN EFI_PEI_FILE_HANDLE ParentFvFileHandle
|
||
)
|
||
{
|
||
EFI_STATUS Status;
|
||
EFI_FV_INFO ParentFvImageInfo;
|
||
UINT32 FvAlignment;
|
||
VOID *NewFvBuffer;
|
||
EFI_PEI_HOB_POINTERS HobPtr;
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI *ParentFvPpi;
|
||
EFI_PEI_FV_HANDLE ParentFvHandle;
|
||
EFI_FIRMWARE_VOLUME_HEADER *FvHeader;
|
||
EFI_FV_FILE_INFO FileInfo;
|
||
|
||
//
|
||
// Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already
|
||
// been extracted.
|
||
//
|
||
HobPtr.Raw = GetHobList ();
|
||
while ((HobPtr.Raw = GetNextHob (EFI_HOB_TYPE_FV2, HobPtr.Raw)) != NULL) {
|
||
if (CompareGuid (&(((EFI_FFS_FILE_HEADER *)ParentFvFileHandle)->Name), &HobPtr.FirmwareVolume2->FileName)) {
|
||
//
|
||
// this FILE has been dispatched, it will not be dispatched again.
|
||
//
|
||
DEBUG ((EFI_D_INFO, "FV file %p has been dispatched!\r\n", ParentFvFileHandle));
|
||
return EFI_SUCCESS;
|
||
}
|
||
HobPtr.Raw = GET_NEXT_HOB (HobPtr);
|
||
}
|
||
|
||
ParentFvHandle = ParentFvCoreHandle->FvHandle;
|
||
ParentFvPpi = ParentFvCoreHandle->FvPpi;
|
||
|
||
//
|
||
// Find FvImage in FvFile
|
||
//
|
||
Status = ParentFvPpi->FindSectionByType (
|
||
ParentFvPpi,
|
||
EFI_SECTION_FIRMWARE_VOLUME_IMAGE,
|
||
ParentFvFileHandle,
|
||
(VOID **)&FvHeader
|
||
);
|
||
|
||
if (EFI_ERROR (Status)) {
|
||
return Status;
|
||
}
|
||
|
||
//
|
||
// FvAlignment must be more than 8 bytes required by FvHeader structure.
|
||
//
|
||
FvAlignment = 1 << ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);
|
||
if (FvAlignment < 8) {
|
||
FvAlignment = 8;
|
||
}
|
||
|
||
//
|
||
// Check FvImage
|
||
//
|
||
if ((UINTN) FvHeader % FvAlignment != 0) {
|
||
NewFvBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINT32) FvHeader->FvLength), FvAlignment);
|
||
if (NewFvBuffer == NULL) {
|
||
return EFI_OUT_OF_RESOURCES;
|
||
}
|
||
CopyMem (NewFvBuffer, FvHeader, (UINTN) FvHeader->FvLength);
|
||
FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) NewFvBuffer;
|
||
}
|
||
|
||
Status = ParentFvPpi->GetVolumeInfo (ParentFvPpi, ParentFvHandle, &ParentFvImageInfo);
|
||
ASSERT_EFI_ERROR (Status);
|
||
|
||
Status = ParentFvPpi->GetFileInfo (ParentFvPpi, ParentFvFileHandle, &FileInfo);
|
||
ASSERT_EFI_ERROR (Status);
|
||
|
||
//
|
||
// Install FvPpi and Build FvHob
|
||
//
|
||
PeiServicesInstallFvInfoPpi (
|
||
&FvHeader->FileSystemGuid,
|
||
(VOID**) FvHeader,
|
||
(UINT32) FvHeader->FvLength,
|
||
&ParentFvImageInfo.FvName,
|
||
&FileInfo.FileName
|
||
);
|
||
|
||
//
|
||
// Inform the extracted FvImage to Fv HOB consumer phase, i.e. DXE phase
|
||
//
|
||
BuildFvHob (
|
||
(EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,
|
||
FvHeader->FvLength
|
||
);
|
||
|
||
//
|
||
// Makes the encapsulated volume show up in DXE phase to skip processing of
|
||
// encapsulated file again.
|
||
//
|
||
BuildFv2Hob (
|
||
(EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,
|
||
FvHeader->FvLength,
|
||
&ParentFvImageInfo.FvName,
|
||
&FileInfo.FileName
|
||
);
|
||
|
||
return EFI_SUCCESS;
|
||
}
|
||
|
||
/**
|
||
Process a firmware volume and create a volume handle.
|
||
|
||
Create a volume handle from the information in the buffer. For
|
||
memory-mapped firmware volumes, Buffer and BufferSize refer to
|
||
the start of the firmware volume and the firmware volume size.
|
||
For non memory-mapped firmware volumes, this points to a
|
||
buffer which contains the necessary information for creating
|
||
the firmware volume handle. Normally, these values are derived
|
||
from the EFI_FIRMWARE_VOLUME_INFO_PPI.
|
||
|
||
|
||
@param This Points to this instance of the
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||
@param Buffer Points to the start of the buffer.
|
||
@param BufferSize Size of the buffer.
|
||
@param FvHandle Points to the returned firmware volume
|
||
handle. The firmware volume handle must
|
||
be unique within the system.
|
||
|
||
@retval EFI_SUCCESS Firmware volume handle created.
|
||
@retval EFI_VOLUME_CORRUPTED Volume was corrupt.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfs2FvPpiProcessVolume (
|
||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||
IN VOID *Buffer,
|
||
IN UINTN BufferSize,
|
||
OUT EFI_PEI_FV_HANDLE *FvHandle
|
||
)
|
||
{
|
||
EFI_STATUS Status;
|
||
|
||
ASSERT (FvHandle != NULL);
|
||
|
||
if (Buffer == NULL) {
|
||
return EFI_VOLUME_CORRUPTED;
|
||
}
|
||
|
||
//
|
||
// The build-in EFI_PEI_FIRMWARE_VOLUME_PPI for FFS2 support memory-mapped
|
||
// FV image and the handle is pointed to Fv image's buffer.
|
||
//
|
||
*FvHandle = (EFI_PEI_FV_HANDLE) Buffer;
|
||
|
||
//
|
||
// Do verify for given FV buffer.
|
||
//
|
||
Status = VerifyFv ((EFI_FIRMWARE_VOLUME_HEADER*) Buffer);
|
||
if (EFI_ERROR(Status)) {
|
||
DEBUG ((EFI_D_ERROR, "Fail to verify FV which address is 0x%11p", Buffer));
|
||
return EFI_VOLUME_CORRUPTED;
|
||
}
|
||
|
||
return EFI_SUCCESS;
|
||
}
|
||
|
||
/**
|
||
Finds the next file of the specified type.
|
||
|
||
This service enables PEI modules to discover additional firmware files.
|
||
The FileHandle must be unique within the system.
|
||
|
||
@param This Points to this instance of the
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||
@param SearchType A filter to find only files of this type. Type
|
||
EFI_FV_FILETYPE_ALL causes no filtering to be
|
||
done.
|
||
@param FvHandle Handle of firmware volume in which to
|
||
search.
|
||
@param FileHandle Points to the current handle from which to
|
||
begin searching or NULL to start at the
|
||
beginning of the firmware volume. Updated
|
||
upon return to reflect the file found.
|
||
|
||
@retval EFI_SUCCESS The file was found.
|
||
@retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfs2FvPpiFindFileByType (
|
||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||
IN EFI_FV_FILETYPE SearchType,
|
||
IN EFI_PEI_FV_HANDLE FvHandle,
|
||
IN OUT EFI_PEI_FILE_HANDLE *FileHandle
|
||
)
|
||
{
|
||
return FindFileEx (FvHandle, NULL, SearchType, FileHandle, NULL);
|
||
}
|
||
|
||
/**
|
||
Find a file within a volume by its name.
|
||
|
||
This service searches for files with a specific name, within
|
||
either the specified firmware volume or all firmware volumes.
|
||
|
||
@param This Points to this instance of the
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||
@param FileName A pointer to the name of the file to find
|
||
within the firmware volume.
|
||
@param FvHandle Upon entry, the pointer to the firmware
|
||
volume to search or NULL if all firmware
|
||
volumes should be searched. Upon exit, the
|
||
actual firmware volume in which the file was
|
||
found.
|
||
@param FileHandle Upon exit, points to the found file's
|
||
handle or NULL if it could not be found.
|
||
|
||
@retval EFI_SUCCESS File was found.
|
||
@retval EFI_NOT_FOUND File was not found.
|
||
@retval EFI_INVALID_PARAMETER FvHandle or FileHandle or
|
||
FileName was NULL.
|
||
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfs2FvPpiFindFileByName (
|
||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||
IN CONST EFI_GUID *FileName,
|
||
IN EFI_PEI_FV_HANDLE *FvHandle,
|
||
OUT EFI_PEI_FILE_HANDLE *FileHandle
|
||
)
|
||
{
|
||
EFI_STATUS Status;
|
||
PEI_CORE_INSTANCE *PrivateData;
|
||
UINTN Index;
|
||
|
||
if ((FvHandle == NULL) || (FileName == NULL) || (FileHandle == NULL)) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
if (*FvHandle != NULL) {
|
||
Status = FindFileEx (*FvHandle, FileName, 0, FileHandle, NULL);
|
||
if (Status == EFI_NOT_FOUND) {
|
||
*FileHandle = NULL;
|
||
}
|
||
} else {
|
||
//
|
||
// If *FvHandle = NULL, so search all FV for given filename
|
||
//
|
||
Status = EFI_NOT_FOUND;
|
||
|
||
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer());
|
||
for (Index = 0; Index < PrivateData->FvCount; Index ++) {
|
||
//
|
||
// Only search the FV which is associated with a EFI_PEI_FIRMWARE_VOLUME_PPI instance.
|
||
//
|
||
if (PrivateData->Fv[Index].FvPpi != NULL) {
|
||
Status = FindFileEx (PrivateData->Fv[Index].FvHandle, FileName, 0, FileHandle, NULL);
|
||
if (!EFI_ERROR (Status)) {
|
||
*FvHandle = PrivateData->Fv[Index].FvHandle;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
return Status;
|
||
}
|
||
|
||
/**
|
||
Returns information about a specific file.
|
||
|
||
This function returns information about a specific
|
||
file, including its file name, type, attributes, starting
|
||
address and size.
|
||
|
||
@param This Points to this instance of the
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||
@param FileHandle Handle of the file.
|
||
@param FileInfo Upon exit, points to the file's
|
||
information.
|
||
|
||
@retval EFI_SUCCESS File information returned.
|
||
@retval EFI_INVALID_PARAMETER If FileHandle does not
|
||
represent a valid file.
|
||
@retval EFI_INVALID_PARAMETER If FileInfo is NULL.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfs2FvPpiGetFileInfo (
|
||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||
IN EFI_PEI_FILE_HANDLE FileHandle,
|
||
OUT EFI_FV_FILE_INFO *FileInfo
|
||
)
|
||
{
|
||
UINT8 FileState;
|
||
UINT8 ErasePolarity;
|
||
EFI_FFS_FILE_HEADER *FileHeader;
|
||
PEI_CORE_FV_HANDLE *CoreFvHandle;
|
||
|
||
if ((FileHandle == NULL) || (FileInfo == NULL)) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
//
|
||
// Retrieve the FirmwareVolume which the file resides in.
|
||
//
|
||
CoreFvHandle = FileHandleToVolume (FileHandle);
|
||
if (CoreFvHandle == NULL) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
if (CoreFvHandle->FvHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {
|
||
ErasePolarity = 1;
|
||
} else {
|
||
ErasePolarity = 0;
|
||
}
|
||
|
||
//
|
||
// Get FileState which is the highest bit of the State
|
||
//
|
||
FileState = GetFileState (ErasePolarity, (EFI_FFS_FILE_HEADER*)FileHandle);
|
||
|
||
switch (FileState) {
|
||
case EFI_FILE_DATA_VALID:
|
||
case EFI_FILE_MARKED_FOR_UPDATE:
|
||
break;
|
||
default:
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
FileHeader = (EFI_FFS_FILE_HEADER *)FileHandle;
|
||
CopyMem (&FileInfo->FileName, &FileHeader->Name, sizeof(EFI_GUID));
|
||
FileInfo->FileType = FileHeader->Type;
|
||
FileInfo->FileAttributes = FileHeader->Attributes;
|
||
FileInfo->BufferSize = ((*(UINT32 *)FileHeader->Size) & 0x00FFFFFF) - sizeof (EFI_FFS_FILE_HEADER);
|
||
FileInfo->Buffer = (FileHeader + 1);
|
||
return EFI_SUCCESS;
|
||
}
|
||
|
||
/**
|
||
This function returns information about the firmware volume.
|
||
|
||
@param This Points to this instance of the
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||
@param FvHandle Handle to the firmware handle.
|
||
@param VolumeInfo Points to the returned firmware volume
|
||
information.
|
||
|
||
@retval EFI_SUCCESS Information returned successfully.
|
||
@retval EFI_INVALID_PARAMETER FvHandle does not indicate a valid
|
||
firmware volume or VolumeInfo is NULL.
|
||
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfs2FvPpiGetVolumeInfo (
|
||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||
IN EFI_PEI_FV_HANDLE FvHandle,
|
||
OUT EFI_FV_INFO *VolumeInfo
|
||
)
|
||
{
|
||
EFI_FIRMWARE_VOLUME_HEADER FwVolHeader;
|
||
EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExHeaderInfo;
|
||
|
||
if (VolumeInfo == NULL) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
//
|
||
// VolumeHandle may not align at 8 byte,
|
||
// but FvLength is UINT64 type, which requires FvHeader align at least 8 byte.
|
||
// So, Copy FvHeader into the local FvHeader structure.
|
||
//
|
||
CopyMem (&FwVolHeader, FvHandle, sizeof (EFI_FIRMWARE_VOLUME_HEADER));
|
||
|
||
//
|
||
// Check Fv Image Signature
|
||
//
|
||
if (FwVolHeader.Signature != EFI_FVH_SIGNATURE) {
|
||
return EFI_INVALID_PARAMETER;
|
||
}
|
||
|
||
ZeroMem (VolumeInfo, sizeof (EFI_FV_INFO));
|
||
VolumeInfo->FvAttributes = FwVolHeader.Attributes;
|
||
VolumeInfo->FvStart = (VOID *) FvHandle;
|
||
VolumeInfo->FvSize = FwVolHeader.FvLength;
|
||
CopyMem (&VolumeInfo->FvFormat, &FwVolHeader.FileSystemGuid, sizeof(EFI_GUID));
|
||
|
||
if (FwVolHeader.ExtHeaderOffset != 0) {
|
||
FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER*)(((UINT8 *)FvHandle) + FwVolHeader.ExtHeaderOffset);
|
||
CopyMem (&VolumeInfo->FvName, &FwVolExHeaderInfo->FvName, sizeof(EFI_GUID));
|
||
}
|
||
|
||
return EFI_SUCCESS;
|
||
}
|
||
|
||
/**
|
||
Find the next matching section in the firmware file.
|
||
|
||
This service enables PEI modules to discover sections
|
||
of a given type within a valid file.
|
||
|
||
@param This Points to this instance of the
|
||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||
@param SearchType A filter to find only sections of this
|
||
type.
|
||
@param FileHandle Handle of firmware file in which to
|
||
search.
|
||
@param SectionData Updated upon return to point to the
|
||
section found.
|
||
|
||
@retval EFI_SUCCESS Section was found.
|
||
@retval EFI_NOT_FOUND Section of the specified type was not
|
||
found. SectionData contains NULL.
|
||
**/
|
||
EFI_STATUS
|
||
EFIAPI
|
||
PeiFfs2FvPpiFindSectionByType (
|
||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||
IN EFI_SECTION_TYPE SearchType,
|
||
IN EFI_PEI_FILE_HANDLE FileHandle,
|
||
OUT VOID **SectionData
|
||
)
|
||
{
|
||
EFI_FFS_FILE_HEADER *FfsFileHeader;
|
||
UINT32 FileSize;
|
||
EFI_COMMON_SECTION_HEADER *Section;
|
||
|
||
FfsFileHeader = (EFI_FFS_FILE_HEADER *)(FileHandle);
|
||
|
||
//
|
||
// Size is 24 bits wide so mask upper 8 bits.
|
||
// Does not include FfsFileHeader header size
|
||
// FileSize is adjusted to FileOccupiedSize as it is 8 byte aligned.
|
||
//
|
||
Section = (EFI_COMMON_SECTION_HEADER *)(FfsFileHeader + 1);
|
||
FileSize = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;
|
||
FileSize -= sizeof (EFI_FFS_FILE_HEADER);
|
||
|
||
return ProcessSection (
|
||
GetPeiServicesTablePointer (),
|
||
SearchType,
|
||
Section,
|
||
FileSize,
|
||
SectionData
|
||
);
|
||
}
|
||
|
||
/**
|
||
Convert the handle of FV to pointer of corresponding PEI_CORE_FV_HANDLE.
|
||
|
||
@param FvHandle The handle of a FV.
|
||
|
||
@retval NULL if can not find.
|
||
@return Pointer of corresponding PEI_CORE_FV_HANDLE.
|
||
**/
|
||
PEI_CORE_FV_HANDLE *
|
||
FvHandleToCoreHandle (
|
||
IN EFI_PEI_FV_HANDLE FvHandle
|
||
)
|
||
{
|
||
UINTN Index;
|
||
PEI_CORE_INSTANCE *PrivateData;
|
||
|
||
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer());
|
||
for (Index = 0; Index < PrivateData->FvCount; Index ++) {
|
||
if (FvHandle == PrivateData->Fv[Index].FvHandle) {
|
||
return &PrivateData->Fv[Index];
|
||
}
|
||
}
|
||
|
||
return NULL;
|
||
}
|
||
|
||
/**
|
||
Get instance of PEI_CORE_FV_HANDLE for next volume according to given index.
|
||
|
||
This routine also will install FvInfo ppi for FV hob in PI ways.
|
||
|
||
@param Private Pointer of PEI_CORE_INSTANCE
|
||
@param Instance The index of FV want to be searched.
|
||
|
||
@return Instance of PEI_CORE_FV_HANDLE.
|
||
**/
|
||
PEI_CORE_FV_HANDLE *
|
||
FindNextCoreFvHandle (
|
||
IN PEI_CORE_INSTANCE *Private,
|
||
IN UINTN Instance
|
||
)
|
||
{
|
||
UINTN Index;
|
||
BOOLEAN Match;
|
||
EFI_HOB_FIRMWARE_VOLUME *FvHob;
|
||
|
||
//
|
||
// Handle Framework FvHob and Install FvInfo Ppi for it.
|
||
//
|
||
if (FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {
|
||
//
|
||
// Loop to search the wanted FirmwareVolume which supports FFS
|
||
//
|
||
FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetFirstHob (EFI_HOB_TYPE_FV);
|
||
while (FvHob != NULL) {
|
||
for (Index = 0, Match = FALSE; Index < Private->FvCount; Index++) {
|
||
if ((EFI_PEI_FV_HANDLE)(UINTN)FvHob->BaseAddress == Private->Fv[Index].FvHeader) {
|
||
Match = TRUE;
|
||
break;
|
||
}
|
||
}
|
||
//
|
||
// If Not Found, Install FvInfo Ppi for it.
|
||
//
|
||
if (!Match) {
|
||
PeiServicesInstallFvInfoPpi (
|
||
&(((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)FvHob->BaseAddress)->FileSystemGuid),
|
||
(VOID *)(UINTN)FvHob->BaseAddress,
|
||
(UINT32)FvHob->Length,
|
||
NULL,
|
||
NULL
|
||
);
|
||
}
|
||
FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetNextHob (EFI_HOB_TYPE_FV, (VOID *)((UINTN)FvHob + FvHob->Header.HobLength));
|
||
}
|
||
}
|
||
|
||
if (Instance >= Private->FvCount) {
|
||
return NULL;
|
||
}
|
||
|
||
return &Private->Fv[Instance];
|
||
}
|
||
|
||
/**
|
||
After PeiCore image is shadowed into permanent memory, all build-in FvPpi should
|
||
be re-installed with the instance in permanent memory and all cached FvPpi pointers in
|
||
PrivateData->Fv[] array should be fixed up to be pointed to the one in permenant
|
||
memory.
|
||
|
||
@param PrivateData Pointer to PEI_CORE_INSTANCE.
|
||
**/
|
||
VOID
|
||
PeiReinitializeFv (
|
||
IN PEI_CORE_INSTANCE *PrivateData
|
||
)
|
||
{
|
||
VOID *OldFfs2FvPpi;
|
||
EFI_PEI_PPI_DESCRIPTOR *OldDescriptor;
|
||
UINTN Index;
|
||
EFI_STATUS Status;
|
||
|
||
//
|
||
// Locate old build-in Ffs2 EFI_PEI_FIRMWARE_VOLUME_PPI which
|
||
// in flash.
|
||
//
|
||
Status = PeiServicesLocatePpi (
|
||
&gEfiFirmwareFileSystem2Guid,
|
||
0,
|
||
&OldDescriptor,
|
||
&OldFfs2FvPpi
|
||
);
|
||
ASSERT_EFI_ERROR (Status);
|
||
|
||
//
|
||
// Re-install the EFI_PEI_FIRMWARE_VOLUME_PPI for build-in Ffs2
|
||
// which is shadowed from flash to permanent memory within PeiCore image.
|
||
//
|
||
Status = PeiServicesReInstallPpi (OldDescriptor, &mPeiFfs2FvPpiList);
|
||
ASSERT_EFI_ERROR (Status);
|
||
|
||
//
|
||
// Fixup all FvPpi pointers for the implementation in flash to permanent memory.
|
||
//
|
||
for (Index = 0; Index < FixedPcdGet32 (PcdPeiCoreMaxFvSupported); Index ++) {
|
||
if (PrivateData->Fv[Index].FvPpi == OldFfs2FvPpi) {
|
||
PrivateData->Fv[Index].FvPpi = &mPeiFfs2FvPpi;
|
||
}
|
||
}
|
||
}
|
||
|