/** @file\r
Pei Core Firmware File System service routines.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
http://opensource.org/licenses/bsd-license.php \r
\r
**/\r
\r
-#include "PeiMain.h"\r
+#include "FwVol.h"\r
\r
EFI_PEI_NOTIFY_DESCRIPTOR mNotifyOnFvInfoList = {\r
(EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
FirmwareVolmeInfoPpiNotifyCallback \r
};\r
\r
+PEI_FW_VOL_INSTANCE mPeiFfs2FwVol = {\r
+ PEI_FW_VOL_SIGNATURE,\r
+ FALSE,\r
+ {\r
+ PeiFfsFvPpiProcessVolume,\r
+ PeiFfsFvPpiFindFileByType,\r
+ PeiFfsFvPpiFindFileByName,\r
+ PeiFfsFvPpiGetFileInfo,\r
+ PeiFfsFvPpiGetVolumeInfo,\r
+ PeiFfsFvPpiFindSectionByType\r
+ }\r
+};\r
+\r
+PEI_FW_VOL_INSTANCE mPeiFfs3FwVol = {\r
+ PEI_FW_VOL_SIGNATURE,\r
+ TRUE,\r
+ {\r
+ PeiFfsFvPpiProcessVolume,\r
+ PeiFfsFvPpiFindFileByType,\r
+ PeiFfsFvPpiFindFileByName,\r
+ PeiFfsFvPpiGetFileInfo,\r
+ PeiFfsFvPpiGetVolumeInfo,\r
+ PeiFfsFvPpiFindSectionByType\r
+ }\r
+};\r
+ \r
+EFI_PEI_PPI_DESCRIPTOR mPeiFfs2FvPpiList = {\r
+ (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
+ &gEfiFirmwareFileSystem2Guid,\r
+ &mPeiFfs2FwVol.Fv\r
+};\r
+\r
+EFI_PEI_PPI_DESCRIPTOR mPeiFfs3FvPpiList = {\r
+ (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
+ &gEfiFirmwareFileSystem3Guid,\r
+ &mPeiFfs3FwVol.Fv\r
+};\r
+\r
+/**\r
+Required Alignment Alignment Value in FFS Alignment Value in\r
+(bytes) Attributes Field Firmware Volume Interfaces\r
+1 0 0\r
+16 1 4\r
+128 2 7\r
+512 3 9\r
+1 KB 4 10\r
+4 KB 5 12\r
+32 KB 6 15\r
+64 KB 7 16\r
+**/\r
+UINT8 mFvAttributes[] = {0, 4, 7, 9, 10, 12, 15, 16};\r
+\r
+/**\r
+ Convert the FFS File Attributes to FV File Attributes\r
+\r
+ @param FfsAttributes The attributes of UINT8 type.\r
+\r
+ @return The attributes of EFI_FV_FILE_ATTRIBUTES\r
+\r
+**/\r
+EFI_FV_FILE_ATTRIBUTES\r
+FfsAttributes2FvFileAttributes (\r
+ IN EFI_FFS_FILE_ATTRIBUTES FfsAttributes\r
+ )\r
+{\r
+ UINT8 DataAlignment;\r
+ EFI_FV_FILE_ATTRIBUTES FileAttribute;\r
+\r
+ DataAlignment = (UINT8) ((FfsAttributes & FFS_ATTRIB_DATA_ALIGNMENT) >> 3);\r
+ ASSERT (DataAlignment < 8);\r
\r
-#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
- ((ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1)))\r
+ FileAttribute = (EFI_FV_FILE_ATTRIBUTES) mFvAttributes[DataAlignment];\r
+\r
+ if ((FfsAttributes & FFS_ATTRIB_FIXED) == FFS_ATTRIB_FIXED) {\r
+ FileAttribute |= EFI_FV_FILE_ATTRIB_FIXED;\r
+ }\r
+\r
+ return FileAttribute;\r
+}\r
\r
/**\r
Returns the file state set by the highest zero bit in the State field\r
IN EFI_FFS_FILE_HEADER *FileHeader\r
)\r
{\r
- EFI_FFS_FILE_HEADER TestFileHeader;\r
- \r
- CopyMem (&TestFileHeader, FileHeader, sizeof (EFI_FFS_FILE_HEADER));\r
- //\r
- // Ingore State and File field in FFS header.\r
- //\r
- TestFileHeader.State = 0;\r
- TestFileHeader.IntegrityCheck.Checksum.File = 0;\r
+ EFI_FFS_FILE_HEADER2 TestFileHeader;\r
+\r
+ if (IS_FFS_FILE2 (FileHeader)) {\r
+ CopyMem (&TestFileHeader, FileHeader, sizeof (EFI_FFS_FILE_HEADER2));\r
+ //\r
+ // Ingore State and File field in FFS header.\r
+ //\r
+ TestFileHeader.State = 0;\r
+ TestFileHeader.IntegrityCheck.Checksum.File = 0;\r
+\r
+ return CalculateSum8 ((CONST UINT8 *) &TestFileHeader, sizeof (EFI_FFS_FILE_HEADER2));\r
+ } else {\r
+ CopyMem (&TestFileHeader, FileHeader, sizeof (EFI_FFS_FILE_HEADER));\r
+ //\r
+ // Ingore State and File field in FFS header.\r
+ //\r
+ TestFileHeader.State = 0;\r
+ TestFileHeader.IntegrityCheck.Checksum.File = 0;\r
\r
- return CalculateSum8 ((CONST UINT8 *) &TestFileHeader, sizeof (EFI_FFS_FILE_HEADER));\r
+ return CalculateSum8 ((CONST UINT8 *) &TestFileHeader, sizeof (EFI_FFS_FILE_HEADER));\r
+ }\r
}\r
\r
/**\r
- Find FV handler according some FileHandle in that FV.\r
+ Find FV handler according to FileHandle in that FV.\r
\r
@param FileHandle Handle of file image\r
- @param VolumeHandle Handle of the found FV, if not found, NULL will be set.\r
-\r
- @retval TRUE The corresponding FV handler is found.\r
- @retval FALSE The corresponding FV handler is not found.\r
-\r
+ \r
+ @return Pointer to instance of PEI_CORE_FV_HANDLE.\r
**/\r
-BOOLEAN\r
-EFIAPI\r
-PeiFileHandleToVolume (\r
- IN EFI_PEI_FILE_HANDLE FileHandle,\r
- OUT EFI_PEI_FV_HANDLE *VolumeHandle\r
+PEI_CORE_FV_HANDLE*\r
+FileHandleToVolume (\r
+ IN EFI_PEI_FILE_HANDLE FileHandle\r
)\r
{\r
UINTN Index;\r
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
\r
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer ());\r
+ \r
for (Index = 0; Index < PrivateData->FvCount; Index++) {\r
FwVolHeader = PrivateData->Fv[Index].FvHeader;\r
if (((UINT64) (UINTN) FileHandle > (UINT64) (UINTN) FwVolHeader ) && \\r
((UINT64) (UINTN) FileHandle <= ((UINT64) (UINTN) FwVolHeader + FwVolHeader->FvLength - 1))) {\r
- *VolumeHandle = (EFI_PEI_FV_HANDLE)FwVolHeader;\r
- return TRUE;\r
+ return &PrivateData->Fv[Index];\r
}\r
}\r
- *VolumeHandle = NULL;\r
- return FALSE;\r
+ return NULL;\r
}\r
\r
/**\r
\r
**/\r
EFI_STATUS\r
-PeiFindFileEx (\r
+FindFileEx (\r
IN CONST EFI_PEI_FV_HANDLE FvHandle,\r
IN CONST EFI_GUID *FileName, OPTIONAL\r
IN EFI_FV_FILETYPE SearchType,\r
IN OUT EFI_PEI_FILE_HANDLE *FileHandle,\r
- IN OUT EFI_PEI_FV_HANDLE *AprioriFile OPTIONAL\r
+ IN OUT EFI_PEI_FILE_HANDLE *AprioriFile OPTIONAL\r
)\r
{\r
- EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
+ EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
+ EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExtHeader;\r
EFI_FFS_FILE_HEADER **FileHeader;\r
EFI_FFS_FILE_HEADER *FfsFileHeader;\r
UINT32 FileLength;\r
UINT64 FvLength;\r
UINT8 ErasePolarity;\r
UINT8 FileState;\r
-\r
- FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)FvHandle;\r
+ UINT8 DataCheckSum;\r
+ BOOLEAN IsFfs3Fv;\r
+ \r
+ //\r
+ // Convert the handle of FV to FV header for memory-mapped firmware volume\r
+ //\r
+ FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) FvHandle;\r
FileHeader = (EFI_FFS_FILE_HEADER **)FileHandle;\r
\r
+ IsFfs3Fv = CompareGuid (&FwVolHeader->FileSystemGuid, &gEfiFirmwareFileSystem3Guid);\r
+\r
FvLength = FwVolHeader->FvLength;\r
if ((FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) != 0) {\r
ErasePolarity = 1;\r
// start from the FileHeader.\r
//\r
if ((*FileHeader == NULL) || (FileName != NULL)) {\r
- FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FwVolHeader + FwVolHeader->HeaderLength);\r
+ if (FwVolHeader->ExtHeaderOffset != 0) {\r
+ //\r
+ // Searching for files starts on an 8 byte aligned boundary after the end of the Extended Header if it exists.\r
+ //\r
+ FwVolExtHeader = (EFI_FIRMWARE_VOLUME_EXT_HEADER *) ((UINT8 *) FwVolHeader + FwVolHeader->ExtHeaderOffset);\r
+ FfsFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FwVolExtHeader + FwVolExtHeader->ExtHeaderSize);\r
+ FfsFileHeader = (EFI_FFS_FILE_HEADER *) ALIGN_POINTER (FfsFileHeader, 8);\r
+ } else {\r
+ FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *) FwVolHeader + FwVolHeader->HeaderLength);\r
+ }\r
} else {\r
+ if (IS_FFS_FILE2 (*FileHeader)) {\r
+ if (!IsFfs3Fv) {\r
+ DEBUG ((EFI_D_ERROR, "It is a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &(*FileHeader)->Name));\r
+ }\r
+ FileLength = FFS_FILE2_SIZE (*FileHeader);\r
+ ASSERT (FileLength > 0x00FFFFFF);\r
+ } else {\r
+ FileLength = FFS_FILE_SIZE (*FileHeader);\r
+ }\r
//\r
- // Length is 24 bits wide so mask upper 8 bits\r
// FileLength is adjusted to FileOccupiedSize as it is 8 byte aligned.\r
//\r
- FileLength = *(UINT32 *)(*FileHeader)->Size & 0x00FFFFFF;\r
FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)*FileHeader + FileOccupiedSize);\r
}\r
FileState = GetFileState (ErasePolarity, FfsFileHeader);\r
switch (FileState) {\r
\r
+ case EFI_FILE_HEADER_CONSTRUCTION:\r
case EFI_FILE_HEADER_INVALID:\r
- FileOffset += sizeof(EFI_FFS_FILE_HEADER);\r
- FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + sizeof(EFI_FFS_FILE_HEADER));\r
+ if (IS_FFS_FILE2 (FfsFileHeader)) {\r
+ if (!IsFfs3Fv) {\r
+ DEBUG ((EFI_D_ERROR, "Found a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &FfsFileHeader->Name));\r
+ }\r
+ FileOffset += sizeof (EFI_FFS_FILE_HEADER2);\r
+ FfsFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER2));\r
+ } else {\r
+ FileOffset += sizeof (EFI_FFS_FILE_HEADER);\r
+ FfsFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER));\r
+ }\r
break;\r
\r
case EFI_FILE_DATA_VALID:\r
return EFI_NOT_FOUND;\r
}\r
\r
- FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
- FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r
+ if (IS_FFS_FILE2 (FfsFileHeader)) {\r
+ FileLength = FFS_FILE2_SIZE (FfsFileHeader);\r
+ ASSERT (FileLength > 0x00FFFFFF);\r
+ FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
+ if (!IsFfs3Fv) {\r
+ DEBUG ((EFI_D_ERROR, "Found a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &FfsFileHeader->Name));\r
+ FileOffset += FileOccupiedSize;\r
+ FfsFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FfsFileHeader + FileOccupiedSize);\r
+ break;\r
+ }\r
+ } else {\r
+ FileLength = FFS_FILE_SIZE (FfsFileHeader);\r
+ FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
+ }\r
+\r
+ DataCheckSum = FFS_FIXED_CHECKSUM;\r
+ if ((FfsFileHeader->Attributes & FFS_ATTRIB_CHECKSUM) == FFS_ATTRIB_CHECKSUM) {\r
+ if (IS_FFS_FILE2 (FfsFileHeader)) {\r
+ DataCheckSum = CalculateCheckSum8 ((CONST UINT8 *) FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER2), FileLength - sizeof(EFI_FFS_FILE_HEADER2));\r
+ } else {\r
+ DataCheckSum = CalculateCheckSum8 ((CONST UINT8 *) FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER), FileLength - sizeof(EFI_FFS_FILE_HEADER));\r
+ }\r
+ }\r
+ if (FfsFileHeader->IntegrityCheck.Checksum.File != DataCheckSum) {\r
+ ASSERT (FALSE);\r
+ *FileHeader = NULL;\r
+ return EFI_NOT_FOUND;\r
+ }\r
\r
if (FileName != NULL) {\r
if (CompareGuid (&FfsFileHeader->Name, (EFI_GUID*)FileName)) {\r
break;\r
\r
case EFI_FILE_DELETED:\r
- FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
+ if (IS_FFS_FILE2 (FfsFileHeader)) {\r
+ if (!IsFfs3Fv) {\r
+ DEBUG ((EFI_D_ERROR, "Found a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &FfsFileHeader->Name));\r
+ }\r
+ FileLength = FFS_FILE2_SIZE (FfsFileHeader);\r
+ ASSERT (FileLength > 0x00FFFFFF);\r
+ } else {\r
+ FileLength = FFS_FILE_SIZE (FfsFileHeader);\r
+ }\r
FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r
FileOffset += FileOccupiedSize;\r
FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData\r
)\r
{\r
- EFI_STATUS Status;\r
+ EFI_STATUS Status;\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI *FvPpi;\r
+ EFI_PEI_FV_HANDLE FvHandle;\r
+ EFI_FIRMWARE_VOLUME_HEADER *BfvHeader;\r
+ \r
//\r
- // The BFV must be the first entry. The Core FV support is stateless \r
- // The AllFV list has a single entry per FV in PEI. \r
- // The Fv list only includes FV that PEIMs will be dispatched from and\r
- // its File System Format is PI 1.0 definition.\r
+ // Install FV_PPI for FFS2 file system.\r
//\r
- PrivateData->FvCount = 1;\r
- PrivateData->Fv[0].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)SecCoreData->BootFirmwareVolumeBase;\r
+ PeiServicesInstallPpi (&mPeiFfs2FvPpiList);\r
\r
- PrivateData->AllFvCount = 1;\r
- PrivateData->AllFv[0] = (EFI_PEI_FV_HANDLE)PrivateData->Fv[0].FvHeader;\r
+ //\r
+ // Install FV_PPI for FFS3 file system.\r
+ //\r
+ PeiServicesInstallPpi (&mPeiFfs3FvPpiList);\r
\r
+ BfvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)SecCoreData->BootFirmwareVolumeBase;\r
+ \r
+ //\r
+ // The FV_PPI in BFV's format should be installed.\r
+ //\r
+ Status = PeiServicesLocatePpi (\r
+ &BfvHeader->FileSystemGuid,\r
+ 0,\r
+ NULL,\r
+ (VOID**)&FvPpi\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ //\r
+ // Get handle of BFV\r
+ //\r
+ FvPpi->ProcessVolume (\r
+ FvPpi, \r
+ SecCoreData->BootFirmwareVolumeBase,\r
+ (UINTN)BfvHeader->FvLength,\r
+ &FvHandle\r
+ );\r
\r
+ //\r
+ // Update internal PEI_CORE_FV array.\r
+ //\r
+ PrivateData->Fv[PrivateData->FvCount].FvHeader = BfvHeader;\r
+ PrivateData->Fv[PrivateData->FvCount].FvPpi = FvPpi;\r
+ PrivateData->Fv[PrivateData->FvCount].FvHandle = FvHandle;\r
+ DEBUG ((\r
+ EFI_D_INFO, \r
+ "The %dth FV start address is 0x%11p, size is 0x%08x, handle is 0x%p\n", \r
+ (UINT32) PrivateData->FvCount, \r
+ (VOID *) BfvHeader, \r
+ BfvHeader->FvLength,\r
+ FvHandle\r
+ )); \r
+ PrivateData->FvCount ++;\r
+ \r
//\r
// Post a call-back for the FvInfoPPI services to expose\r
// additional Fvs to PeiCore.\r
ASSERT_EFI_ERROR (Status);\r
\r
}\r
-\r
+ \r
/**\r
Process Firmware Volum Information once FvInfoPPI install.\r
The FV Info will be registered into PeiCore private data structure.\r
IN VOID *Ppi\r
)\r
{\r
- UINT8 FvCount;\r
- EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *Fv;\r
+ EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *FvInfoPpi;\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI *FvPpi;\r
PEI_CORE_INSTANCE *PrivateData;\r
+ EFI_STATUS Status;\r
+ EFI_PEI_FV_HANDLE FvHandle;\r
+ UINTN FvIndex;\r
EFI_PEI_FILE_HANDLE FileHandle;\r
VOID *DepexData;\r
- UINT32 AuthenticationStatus;\r
- EFI_STATUS Status;\r
\r
- FileHandle = NULL;\r
- DepexData = NULL;\r
Status = EFI_SUCCESS;\r
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
\r
ASSERT (FALSE);\r
}\r
\r
- Fv = (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *)Ppi;\r
+ FvInfoPpi = (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *)Ppi;\r
\r
//\r
- // Only add FileSystem2 Fv to Fv list\r
+ // Locate the corresponding FV_PPI according to founded FV's format guid\r
//\r
- if (CompareGuid (&Fv->FvFormat, &gEfiFirmwareFileSystem2Guid)) {\r
- for (FvCount = 0; FvCount < PrivateData->FvCount; FvCount ++) {\r
- if ((UINTN)PrivateData->Fv[FvCount].FvHeader == (UINTN)Fv->FvInfo) {\r
+ Status = PeiServicesLocatePpi (\r
+ &FvInfoPpi->FvFormat, \r
+ 0, \r
+ NULL,\r
+ (VOID**)&FvPpi\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ //\r
+ // Process new found FV and get FV handle.\r
+ //\r
+ Status = FvPpi->ProcessVolume (FvPpi, FvInfoPpi->FvInfo, FvInfoPpi->FvInfoSize, &FvHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((EFI_D_ERROR, "Fail to process new found FV, FV may be corrupted!\n"));\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Check whether the FV has already been processed.\r
+ //\r
+ for (FvIndex = 0; FvIndex < PrivateData->FvCount; FvIndex ++) {\r
+ if (PrivateData->Fv[FvIndex].FvHandle == FvHandle) {\r
+ DEBUG ((EFI_D_INFO, "The Fv %p has already been processed!\n", FvInfoPpi->FvInfo));\r
return EFI_SUCCESS;\r
}\r
}\r
- \r
- Status = VerifyFv ((EFI_FIRMWARE_VOLUME_HEADER*)Fv->FvInfo);\r
- if (EFI_ERROR(Status)) {\r
- DEBUG ((EFI_D_ERROR, "Fail to verify FV which address is 0x%11p", (VOID *) Fv->FvInfo));\r
- return Status;\r
- }\r
- \r
- PrivateData->Fv[PrivateData->FvCount++].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Fv->FvInfo;\r
\r
- PrivateData->AllFv[PrivateData->AllFvCount++] = (EFI_PEI_FV_HANDLE)Fv->FvInfo;\r
- \r
- DEBUG ((EFI_D_INFO, "The %dth FvImage start address is 0x%11p and size is 0x%08x\n", (UINT32)PrivateData->AllFvCount, (VOID *) Fv->FvInfo, Fv->FvInfoSize));\r
//\r
- // Preprocess all FV type files in this new FileSystem2 Fv image\r
+ // Update internal PEI_CORE_FV array.\r
//\r
+ PrivateData->Fv[PrivateData->FvCount].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) FvInfoPpi->FvInfo;\r
+ PrivateData->Fv[PrivateData->FvCount].FvPpi = FvPpi;\r
+ PrivateData->Fv[PrivateData->FvCount].FvHandle = FvHandle;\r
+ DEBUG ((\r
+ EFI_D_INFO, \r
+ "The %dth FV start address is 0x%11p, size is 0x%08x, handle is 0x%p\n", \r
+ (UINT32) PrivateData->FvCount, \r
+ (VOID *) FvInfoPpi->FvInfo, \r
+ FvInfoPpi->FvInfoSize,\r
+ FvHandle\r
+ )); \r
+ PrivateData->FvCount ++;\r
+\r
+ //\r
+ // Scan and process the new discoveried FV for EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE \r
+ //\r
+ FileHandle = NULL;\r
do {\r
- Status = PeiFindFileEx (\r
- (EFI_PEI_FV_HANDLE)Fv->FvInfo, \r
- NULL, \r
- EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE, \r
- &FileHandle, \r
- NULL\r
- );\r
+ Status = FvPpi->FindFileByType (\r
+ FvPpi,\r
+ EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE,\r
+ FvHandle,\r
+ &FileHandle\r
+ );\r
if (!EFI_ERROR (Status)) {\r
- Status = PeiFfsFindSectionData (\r
- (CONST EFI_PEI_SERVICES **) PeiServices,\r
- EFI_SECTION_PEI_DEPEX,\r
- FileHandle, \r
- (VOID **)&DepexData\r
- );\r
+ Status = FvPpi->FindSectionByType (\r
+ FvPpi,\r
+ EFI_SECTION_PEI_DEPEX,\r
+ FileHandle,\r
+ (VOID**)&DepexData\r
+ );\r
if (!EFI_ERROR (Status)) {\r
if (!PeimDispatchReadiness (PeiServices, DepexData)) {\r
//\r
continue;\r
}\r
}\r
- //\r
- // Process FvFile to install FvInfo ppi and build FvHob\r
- // \r
- ProcessFvFile ((CONST EFI_PEI_SERVICES **) PeiServices, (EFI_PEI_FV_HANDLE)Fv->FvInfo, FileHandle, &AuthenticationStatus);\r
+ \r
+ DEBUG ((EFI_D_INFO, "Found firmware volume Image File %p in FV[%d] %p\n", FileHandle, PrivateData->FvCount - 1, FvHandle));\r
+ ProcessFvFile (&PrivateData->Fv[PrivateData->FvCount - 1], FileHandle);\r
}\r
} while (FileHandle != NULL);\r
+ } else {\r
+ DEBUG ((EFI_D_ERROR, "Fail to process FV %p because no corresponding EFI_FIRMWARE_VOLUME_PPI is found!\n", FvInfoPpi->FvInfo));\r
+ \r
+ AddUnknownFormatFvInfo (PrivateData, &FvInfoPpi->FvFormat, FvInfoPpi->FvInfo, FvInfoPpi->FvInfoSize);\r
}\r
-\r
+ \r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Verify the Guided Section GUID by checking if there is the Guided Section GUID HOB recorded the GUID itself.\r
+\r
+ @param GuidedSectionGuid The Guided Section GUID.\r
+ @param GuidedSectionExtraction A pointer to the pointer to the supported Guided Section Extraction Ppi\r
+ for the Guided Section.\r
+\r
+ @return TRUE The GuidedSectionGuid could be identified, and the pointer to\r
+ the Guided Section Extraction Ppi will be returned to *GuidedSectionExtraction.\r
+ @return FALSE The GuidedSectionGuid could not be identified, or \r
+ the Guided Section Extraction Ppi has not been installed yet.\r
+\r
+**/\r
+BOOLEAN\r
+VerifyGuidedSectionGuid (\r
+ IN EFI_GUID *GuidedSectionGuid,\r
+ OUT EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI **GuidedSectionExtraction\r
+ )\r
+{\r
+ EFI_PEI_HOB_POINTERS Hob;\r
+ EFI_GUID *GuidRecorded;\r
+ VOID *Interface;\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Check if there is the Guided Section GUID HOB recorded the GUID itself.\r
+ //\r
+ Hob.Raw = GetFirstGuidHob (GuidedSectionGuid);\r
+ if (Hob.Raw != NULL) {\r
+ GuidRecorded = (EFI_GUID *) GET_GUID_HOB_DATA (Hob);\r
+ if (CompareGuid (GuidRecorded, GuidedSectionGuid)) {\r
+ //\r
+ // Found the recorded GuidedSectionGuid.\r
+ //\r
+ Status = PeiServicesLocatePpi (GuidedSectionGuid, 0, NULL, (VOID **) &Interface);\r
+ if (!EFI_ERROR (Status) && Interface != NULL) {\r
+ //\r
+ // Found the supported Guided Section Extraction Ppi for the Guided Section.\r
+ //\r
+ *GuidedSectionExtraction = (EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *) Interface;\r
+ return TRUE;\r
+ }\r
+ return FALSE;\r
+ }\r
+ }\r
+\r
+ return FALSE;\r
+}\r
+\r
/**\r
Go through the file to search SectionType section. \r
Search within encapsulation sections (compression and GUIDed) recursively, \r
until the match section is found.\r
\r
- @param PeiServices - An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- @param SectionType - Filter to find only section of this type.\r
- @param Section - From where to search.\r
- @param SectionSize - The file size to search.\r
- @param OutputBuffer - A pointer to the discovered section, if successful.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param SectionType Filter to find only section of this type.\r
+ @param Section From where to search.\r
+ @param SectionSize The file size to search.\r
+ @param OutputBuffer A pointer to the discovered section, if successful.\r
NULL if section not found\r
+ @param IsFfs3Fv Indicates the FV format.\r
\r
@return EFI_NOT_FOUND The match section is not found.\r
@return EFI_SUCCESS The match section is found.\r
\r
**/\r
EFI_STATUS\r
-PeiFfsProcessSection (\r
+ProcessSection (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN EFI_SECTION_TYPE SectionType,\r
IN EFI_COMMON_SECTION_HEADER *Section,\r
IN UINTN SectionSize,\r
- OUT VOID **OutputBuffer\r
+ OUT VOID **OutputBuffer,\r
+ IN BOOLEAN IsFfs3Fv\r
)\r
{\r
EFI_STATUS Status;\r
UINTN Index;\r
UINT32 Authentication;\r
PEI_CORE_INSTANCE *PrivateData;\r
+ EFI_GUID *SectionDefinitionGuid;\r
\r
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
*OutputBuffer = NULL;\r
PpiOutput = NULL;\r
PpiOutputSize = 0;\r
while (ParsedLength < SectionSize) {\r
+\r
+ if (IS_SECTION2 (Section)) {\r
+ ASSERT (SECTION2_SIZE (Section) > 0x00FFFFFF);\r
+ if (!IsFfs3Fv) {\r
+ DEBUG ((EFI_D_ERROR, "Found a FFS3 formatted section in a non-FFS3 formatted FV.\n"));\r
+ SectionLength = SECTION2_SIZE (Section);\r
+ //\r
+ // SectionLength is adjusted it is 4 byte aligned.\r
+ // Go to the next section\r
+ //\r
+ SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
+ ASSERT (SectionLength != 0);\r
+ ParsedLength += SectionLength;\r
+ Section = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) Section + SectionLength);\r
+ continue;\r
+ }\r
+ }\r
+\r
if (Section->Type == SectionType) {\r
- *OutputBuffer = (VOID *)(Section + 1);\r
+ if (IS_SECTION2 (Section)) {\r
+ *OutputBuffer = (VOID *)((UINT8 *) Section + sizeof (EFI_COMMON_SECTION_HEADER2));\r
+ } else {\r
+ *OutputBuffer = (VOID *)((UINT8 *) Section + sizeof (EFI_COMMON_SECTION_HEADER));\r
+ }\r
return EFI_SUCCESS;\r
} else if ((Section->Type == EFI_SECTION_GUID_DEFINED) || (Section->Type == EFI_SECTION_COMPRESSION)) {\r
//\r
//\r
// Search section directly from the cache data.\r
//\r
- return PeiFfsProcessSection (\r
- PeiServices,\r
- SectionType, \r
- PpiOutput, \r
- PpiOutputSize, \r
- OutputBuffer \r
- );\r
+ return ProcessSection (\r
+ PeiServices,\r
+ SectionType, \r
+ PpiOutput, \r
+ PpiOutputSize, \r
+ OutputBuffer,\r
+ IsFfs3Fv\r
+ );\r
}\r
}\r
\r
Status = EFI_NOT_FOUND;\r
if (Section->Type == EFI_SECTION_GUID_DEFINED) {\r
- Status = PeiServicesLocatePpi (\r
- &((EFI_GUID_DEFINED_SECTION *)Section)->SectionDefinitionGuid, \r
- 0, \r
- NULL, \r
- (VOID **) &GuidSectionPpi\r
- );\r
- if (!EFI_ERROR (Status)) {\r
+ if (IS_SECTION2 (Section)) {\r
+ SectionDefinitionGuid = &((EFI_GUID_DEFINED_SECTION2 *)Section)->SectionDefinitionGuid;\r
+ } else {\r
+ SectionDefinitionGuid = &((EFI_GUID_DEFINED_SECTION *)Section)->SectionDefinitionGuid;\r
+ }\r
+ if (VerifyGuidedSectionGuid (SectionDefinitionGuid, &GuidSectionPpi)) {\r
Status = GuidSectionPpi->ExtractSection (\r
- GuidSectionPpi,\r
- Section,\r
- &PpiOutput,\r
- &PpiOutputSize,\r
- &Authentication\r
- );\r
+ GuidSectionPpi,\r
+ Section,\r
+ &PpiOutput,\r
+ &PpiOutputSize,\r
+ &Authentication\r
+ );\r
}\r
} else if (Section->Type == EFI_SECTION_COMPRESSION) {\r
Status = PeiServicesLocatePpi (&gEfiPeiDecompressPpiGuid, 0, NULL, (VOID **) &DecompressPpi);\r
PrivateData->CacheSection.SectionSize [PrivateData->CacheSection.SectionIndex] = PpiOutputSize;\r
PrivateData->CacheSection.SectionIndex = (PrivateData->CacheSection.SectionIndex + 1)%CACHE_SETION_MAX_NUMBER;\r
\r
- return PeiFfsProcessSection (\r
- PeiServices,\r
- SectionType, \r
- PpiOutput, \r
- PpiOutputSize, \r
- OutputBuffer \r
- );\r
+ return ProcessSection (\r
+ PeiServices,\r
+ SectionType, \r
+ PpiOutput, \r
+ PpiOutputSize, \r
+ OutputBuffer,\r
+ IsFfs3Fv\r
+ );\r
}\r
}\r
\r
+ if (IS_SECTION2 (Section)) {\r
+ SectionLength = SECTION2_SIZE (Section);\r
+ } else {\r
+ SectionLength = SECTION_SIZE (Section);\r
+ }\r
//\r
- // Size is 24 bits wide so mask upper 8 bits. \r
// SectionLength is adjusted it is 4 byte aligned.\r
// Go to the next section\r
//\r
- SectionLength = *(UINT32 *)Section->Size & 0x00FFFFFF;\r
SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
ASSERT (SectionLength != 0);\r
ParsedLength += SectionLength;\r
\r
\r
/**\r
- Given the input file pointer, search for the first matching section in the\r
- FFS volume.\r
+ Searches for the next matching section within the specified file.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
@param SectionType Filter to find only sections of this type.\r
@param SectionData A pointer to the discovered section, if successful.\r
NULL if section not found\r
\r
- @retval EFI_NOT_FOUND No files matching the search criteria were found\r
- @retval EFI_SUCCESS Success to find section data in given file\r
+ @retval EFI_NOT_FOUND The section was not found.\r
+ @retval EFI_SUCCESS The section was found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFindSectionData (\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN EFI_SECTION_TYPE SectionType,\r
IN EFI_PEI_FILE_HANDLE FileHandle,\r
- IN OUT VOID **SectionData\r
+ OUT VOID **SectionData\r
)\r
{\r
- EFI_FFS_FILE_HEADER *FfsFileHeader;\r
- UINT32 FileSize;\r
- EFI_COMMON_SECTION_HEADER *Section;\r
-\r
- FfsFileHeader = (EFI_FFS_FILE_HEADER *)(FileHandle);\r
-\r
- //\r
- // Size is 24 bits wide so mask upper 8 bits. \r
- // Does not include FfsFileHeader header size\r
- // FileSize is adjusted to FileOccupiedSize as it is 8 byte aligned.\r
- //\r
- Section = (EFI_COMMON_SECTION_HEADER *)(FfsFileHeader + 1);\r
- FileSize = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
- FileSize -= sizeof (EFI_FFS_FILE_HEADER);\r
-\r
- return PeiFfsProcessSection (\r
- PeiServices,\r
- SectionType, \r
- Section, \r
- FileSize, \r
- SectionData\r
- );\r
+ PEI_CORE_FV_HANDLE *CoreFvHandle;\r
+ \r
+ CoreFvHandle = FileHandleToVolume (FileHandle);\r
+ if ((CoreFvHandle == NULL) || (CoreFvHandle->FvPpi == NULL)) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ \r
+ return CoreFvHandle->FvPpi->FindSectionByType (CoreFvHandle->FvPpi, SectionType, FileHandle, SectionData);\r
}\r
\r
/**\r
- Given the input file pointer, search for the next matching file in the\r
- FFS volume as defined by SearchType. The search starts from FileHeader inside\r
- the Firmware Volume defined by FwVolHeader.\r
-\r
+ Searches for the next matching file in the firmware volume.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param SearchType Filter to find only files of this type.\r
Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
- @param VolumeHandle Pointer to the FV header of the volume to search.\r
- @param FileHandle Pointer to the current file from which to begin searching.\r
- This pointer will be updated upon return to reflect the file found.\r
- @retval EFI_NOT_FOUND No files matching the search criteria were found\r
- @retval EFI_SUCCESS Success to find next file in given volume\r
+ @param FvHandle Handle of firmware volume in which to search.\r
+ @param FileHandle On entry, points to the current handle from which to begin searching or NULL to start\r
+ at the beginning of the firmware volume. On exit, points the file handle of the next file\r
+ in the volume or NULL if there are no more files.\r
+\r
+ @retval EFI_NOT_FOUND The file was not found.\r
+ @retval EFI_NOT_FOUND The header checksum was not zero.\r
+ @retval EFI_SUCCESS The file was found.\r
\r
**/\r
EFI_STATUS\r
PeiFfsFindNextFile (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN UINT8 SearchType,\r
- IN EFI_PEI_FV_HANDLE VolumeHandle,\r
+ IN EFI_PEI_FV_HANDLE FvHandle,\r
IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r
)\r
{\r
- return PeiFindFileEx (VolumeHandle, NULL, SearchType, FileHandle, NULL);\r
+ PEI_CORE_FV_HANDLE *CoreFvHandle;\r
+ \r
+ CoreFvHandle = FvHandleToCoreHandle (FvHandle);\r
+ \r
+ //\r
+ // To make backward compatiblity, if can not find corresponding the handle of FV\r
+ // then treat FV as build-in FFS2/FFS3 format and memory mapped FV that FV handle is pointed\r
+ // to the address of first byte of FV.\r
+ //\r
+ if ((CoreFvHandle == NULL) && FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {\r
+ return FindFileEx (FvHandle, NULL, SearchType, FileHandle, NULL);\r
+ } \r
+ \r
+ if ((CoreFvHandle == NULL) || CoreFvHandle->FvPpi == NULL) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ \r
+ return CoreFvHandle->FvPpi->FindFileByType (CoreFvHandle->FvPpi, SearchType, FvHandle, FileHandle);\r
}\r
\r
\r
Search the firmware volumes by index\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
- @param Instance Instance of FV to find\r
- @param VolumeHandle Pointer to found Volume.\r
+ @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware\r
+ Volume (BFV).\r
+ @param VolumeHandle On exit, points to the next volume handle or NULL if it does not exist.\r
\r
- @retval EFI_INVALID_PARAMETER FwVolHeader is NULL\r
- @retval EFI_SUCCESS Firmware volume instance successfully found.\r
+ @retval EFI_INVALID_PARAMETER VolumeHandle is NULL\r
+ @retval EFI_NOT_FOUND The volume was not found.\r
+ @retval EFI_SUCCESS The volume was found.\r
\r
**/\r
EFI_STATUS \r
EFIAPI\r
-PeiFvFindNextVolume (\r
+PeiFfsFindNextVolume (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN UINTN Instance,\r
IN OUT EFI_PEI_FV_HANDLE *VolumeHandle\r
)\r
{\r
- PEI_CORE_INSTANCE *Private;\r
- UINTN Index;\r
- BOOLEAN Match;\r
- EFI_HOB_FIRMWARE_VOLUME *FvHob;\r
-\r
- Private = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
+ PEI_CORE_INSTANCE *Private;\r
+ PEI_CORE_FV_HANDLE *CoreFvHandle;\r
+ \r
if (VolumeHandle == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
+ return EFI_INVALID_PARAMETER;\r
}\r
\r
- //\r
- // Handle Framework FvHob and Install FvInfo Ppi for it.\r
- //\r
- if (FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {\r
- //\r
- // Loop to search the wanted FirmwareVolume which supports FFS\r
- //\r
- FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetFirstHob (EFI_HOB_TYPE_FV);\r
- while (FvHob != NULL) {\r
- for (Index = 0, Match = FALSE; Index < Private->AllFvCount; Index++) {\r
- if ((EFI_PEI_FV_HANDLE)(UINTN)FvHob->BaseAddress == Private->AllFv[Index]) {\r
- Match = TRUE;\r
- break;\r
- }\r
- }\r
- //\r
- // If Not Found, Install FvInfo Ppi for it.\r
- //\r
- if (!Match) {\r
- PeiServicesInstallFvInfoPpi (\r
- NULL,\r
- (VOID *)(UINTN)FvHob->BaseAddress,\r
- (UINT32)FvHob->Length,\r
- NULL,\r
- NULL\r
- );\r
- }\r
- FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetNextHob (EFI_HOB_TYPE_FV, (VOID *)((UINTN)FvHob + FvHob->Header.HobLength)); \r
- }\r
- }\r
-\r
- if (Instance >= Private->AllFvCount) {\r
- VolumeHandle = NULL;\r
- return EFI_NOT_FOUND;\r
+ Private = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
+ \r
+ CoreFvHandle = FindNextCoreFvHandle (Private, Instance);\r
+ if (CoreFvHandle == NULL) {\r
+ *VolumeHandle = NULL;\r
+ return EFI_NOT_FOUND;\r
}\r
-\r
- *VolumeHandle = Private->AllFv[Instance];\r
+ \r
+ *VolumeHandle = CoreFvHandle->FvHandle;\r
+ \r
return EFI_SUCCESS;\r
}\r
\r
OUT EFI_PEI_FILE_HANDLE *FileHandle\r
)\r
{\r
- EFI_STATUS Status;\r
+ PEI_CORE_FV_HANDLE *CoreFvHandle;\r
+ \r
if ((VolumeHandle == NULL) || (FileName == NULL) || (FileHandle == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- Status = PeiFindFileEx (VolumeHandle, FileName, 0, FileHandle, NULL);\r
- if (Status == EFI_NOT_FOUND) {\r
- *FileHandle = NULL;\r
+ \r
+ CoreFvHandle = FvHandleToCoreHandle (VolumeHandle);\r
+ if ((CoreFvHandle == NULL) || (CoreFvHandle->FvPpi == NULL)) {\r
+ return EFI_NOT_FOUND;\r
}\r
- return Status;\r
+ \r
+ return CoreFvHandle->FvPpi->FindFileByName (CoreFvHandle->FvPpi, FileName, &VolumeHandle, FileHandle);\r
}\r
\r
/**\r
-\r
Returns information about a specific file.\r
\r
+ @param FileHandle Handle of the file.\r
+ @param FileInfo Upon exit, points to the file's information.\r
\r
- @param FileHandle - The handle to file.\r
- @param FileInfo - Pointer to the file information.\r
-\r
- @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.\r
- @retval EFI_SUCCESS Success to collect file info.\r
+ @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
+ @retval EFI_INVALID_PARAMETER If FileHandle does not represent a valid file.\r
+ @retval EFI_SUCCESS File information returned.\r
\r
**/\r
EFI_STATUS\r
OUT EFI_FV_FILE_INFO *FileInfo\r
)\r
{\r
- UINT8 FileState;\r
- UINT8 ErasePolarity;\r
- EFI_FFS_FILE_HEADER *FileHeader;\r
- EFI_PEI_FV_HANDLE VolumeHandle;\r
-\r
+ PEI_CORE_FV_HANDLE *CoreFvHandle;\r
+ \r
if ((FileHandle == NULL) || (FileInfo == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- VolumeHandle = 0;\r
//\r
// Retrieve the FirmwareVolume which the file resides in.\r
//\r
- if (!PeiFileHandleToVolume(FileHandle, &VolumeHandle)) {\r
+ CoreFvHandle = FileHandleToVolume (FileHandle);\r
+ if ((CoreFvHandle == NULL) || (CoreFvHandle->FvPpi == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- if (((EFI_FIRMWARE_VOLUME_HEADER*)VolumeHandle)->Attributes & EFI_FVB2_ERASE_POLARITY) {\r
- ErasePolarity = 1;\r
- } else {\r
- ErasePolarity = 0;\r
- }\r
-\r
- //\r
- // Get FileState which is the highest bit of the State \r
- //\r
- FileState = GetFileState (ErasePolarity, (EFI_FFS_FILE_HEADER*)FileHandle);\r
-\r
- switch (FileState) {\r
- case EFI_FILE_DATA_VALID:\r
- case EFI_FILE_MARKED_FOR_UPDATE:\r
- break; \r
- default:\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- FileHeader = (EFI_FFS_FILE_HEADER *)FileHandle;\r
- CopyMem (&FileInfo->FileName, &FileHeader->Name, sizeof(EFI_GUID));\r
- FileInfo->FileType = FileHeader->Type;\r
- FileInfo->FileAttributes = FileHeader->Attributes;\r
- FileInfo->BufferSize = ((*(UINT32 *)FileHeader->Size) & 0x00FFFFFF) - sizeof (EFI_FFS_FILE_HEADER);\r
- FileInfo->Buffer = (FileHeader + 1);\r
- return EFI_SUCCESS;\r
+ return CoreFvHandle->FvPpi->GetFileInfo (CoreFvHandle->FvPpi, FileHandle, FileInfo);\r
}\r
\r
\r
/**\r
+ Returns information about the specified volume.\r
+\r
+ This function returns information about a specific firmware\r
+ volume, including its name, type, attributes, starting address\r
+ and size.\r
\r
- Collect information of given Fv Volume.\r
+ @param VolumeHandle Handle of the volume.\r
+ @param VolumeInfo Upon exit, points to the volume's information.\r
\r
- @param VolumeHandle - The handle to Fv Volume.\r
- @param VolumeInfo - The pointer to volume information.\r
+ @retval EFI_SUCCESS Volume information returned.\r
+ @retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.\r
+ @retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.\r
+ @retval EFI_SUCCESS Information successfully returned.\r
+ @retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.\r
\r
- @retval EFI_INVALID_PARAMETER VolumeInfo is NULL\r
- @retval EFI_SUCCESS Success to collect fv info.\r
**/\r
EFI_STATUS\r
EFIAPI \r
OUT EFI_FV_INFO *VolumeInfo\r
)\r
{\r
- EFI_FIRMWARE_VOLUME_HEADER FwVolHeader;\r
- EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExHeaderInfo;\r
-\r
- if (VolumeInfo == NULL) {\r
+ PEI_CORE_FV_HANDLE *CoreHandle;\r
+ \r
+ if ((VolumeInfo == NULL) || (VolumeHandle == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- //\r
- // VolumeHandle may not align at 8 byte, \r
- // but FvLength is UINT64 type, which requires FvHeader align at least 8 byte. \r
- // So, Copy FvHeader into the local FvHeader structure.\r
- //\r
- CopyMem (&FwVolHeader, VolumeHandle, sizeof (EFI_FIRMWARE_VOLUME_HEADER));\r
- //\r
- // Check Fv Image Signature\r
- //\r
- if (FwVolHeader.Signature != EFI_FVH_SIGNATURE) {\r
+ CoreHandle = FvHandleToCoreHandle (VolumeHandle);\r
+ \r
+ if ((CoreHandle == NULL) || (CoreHandle->FvPpi == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- ZeroMem (VolumeInfo, sizeof (EFI_FV_INFO));\r
- VolumeInfo->FvAttributes = FwVolHeader.Attributes;\r
- VolumeInfo->FvStart = (VOID *) VolumeHandle;\r
- VolumeInfo->FvSize = FwVolHeader.FvLength;\r
- CopyMem (&VolumeInfo->FvFormat, &FwVolHeader.FileSystemGuid, sizeof(EFI_GUID));\r
-\r
- if (FwVolHeader.ExtHeaderOffset != 0) {\r
- FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER*)(((UINT8 *)VolumeHandle) + FwVolHeader.ExtHeaderOffset);\r
- CopyMem (&VolumeInfo->FvName, &FwVolExHeaderInfo->FvName, sizeof(EFI_GUID));\r
- }\r
- return EFI_SUCCESS;\r
+ \r
+ return CoreHandle->FvPpi->GetVolumeInfo (CoreHandle->FvPpi, VolumeHandle, VolumeInfo);\r
}\r
\r
/**\r
Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- @param ParentFvHandle Fv handle to parent Fv image that contain this Fv image.\r
+ @param ParentFvCoreHandle Pointer of EFI_CORE_FV_HANDLE to parent Fv image that contain this Fv image.\r
@param ParentFvFileHandle File handle of a Fv type file that contain this Fv image.\r
- @param AuthenticationState Pointer to attestation authentication state of image.\r
-\r
\r
@retval EFI_NOT_FOUND FV image can't be found.\r
@retval EFI_SUCCESS Successfully to process it.\r
**/\r
EFI_STATUS\r
ProcessFvFile (\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN EFI_PEI_FV_HANDLE ParentFvHandle,\r
- IN EFI_PEI_FILE_HANDLE ParentFvFileHandle,\r
- OUT UINT32 *AuthenticationState\r
+ IN PEI_CORE_FV_HANDLE *ParentFvCoreHandle,\r
+ IN EFI_PEI_FILE_HANDLE ParentFvFileHandle\r
)\r
{\r
- EFI_STATUS Status;\r
- EFI_PEI_FV_HANDLE FvImageHandle;\r
- EFI_FV_INFO FvImageInfo;\r
- EFI_FV_INFO ParentFvImageInfo;\r
- UINT32 FvAlignment;\r
- VOID *FvBuffer;\r
- EFI_PEI_HOB_POINTERS HobPtr;\r
-\r
- FvBuffer = NULL;\r
- *AuthenticationState = 0;\r
-\r
+ EFI_STATUS Status;\r
+ EFI_FV_INFO ParentFvImageInfo;\r
+ UINT32 FvAlignment;\r
+ VOID *NewFvBuffer;\r
+ EFI_PEI_HOB_POINTERS HobPtr;\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI *ParentFvPpi;\r
+ EFI_PEI_FV_HANDLE ParentFvHandle;\r
+ EFI_FIRMWARE_VOLUME_HEADER *FvHeader;\r
+ EFI_FV_FILE_INFO FileInfo;\r
+ UINT64 FvLength;\r
+ \r
//\r
// Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already\r
// been extracted.\r
//\r
// this FILE has been dispatched, it will not be dispatched again.\r
//\r
+ DEBUG ((EFI_D_INFO, "FV file %p has been dispatched!\r\n", ParentFvFileHandle));\r
return EFI_SUCCESS;\r
}\r
HobPtr.Raw = GET_NEXT_HOB (HobPtr);\r
}\r
\r
+ ParentFvHandle = ParentFvCoreHandle->FvHandle;\r
+ ParentFvPpi = ParentFvCoreHandle->FvPpi;\r
+ \r
//\r
// Find FvImage in FvFile\r
//\r
- Status = PeiFfsFindSectionData (\r
- PeiServices,\r
- EFI_SECTION_FIRMWARE_VOLUME_IMAGE,\r
- ParentFvFileHandle,\r
- (VOID **)&FvImageHandle\r
- );\r
-\r
+ Status = ParentFvPpi->FindSectionByType (\r
+ ParentFvPpi,\r
+ EFI_SECTION_FIRMWARE_VOLUME_IMAGE,\r
+ ParentFvFileHandle,\r
+ (VOID **)&FvHeader\r
+ );\r
+ \r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
//\r
- // Collect Parent FvImage Info.\r
- //\r
- Status = PeiFfsGetVolumeInfo (ParentFvHandle, &ParentFvImageInfo);\r
- ASSERT_EFI_ERROR (Status); \r
- \r
- //\r
- // Collect FvImage Info.\r
- //\r
- Status = PeiFfsGetVolumeInfo (FvImageHandle, &FvImageInfo);\r
- ASSERT_EFI_ERROR (Status);\r
- \r
- //\r
- // FvAlignment must be more than 8 bytes required by FvHeader structure.\r
- //\r
- FvAlignment = 1 << ((FvImageInfo.FvAttributes & EFI_FVB2_ALIGNMENT) >> 16);\r
- if (FvAlignment < 8) {\r
- FvAlignment = 8;\r
- }\r
- \r
+ // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume\r
+ // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from\r
+ // its initial linked location and maintain its alignment.\r
//\r
- // Check FvImage\r
- //\r
- if ((UINTN) FvImageInfo.FvStart % FvAlignment != 0) {\r
- FvBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINT32) FvImageInfo.FvSize), FvAlignment);\r
- if (FvBuffer == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
+ if ((ReadUnaligned32 (&FvHeader->Attributes) & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) {\r
+ //\r
+ // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.\r
+ //\r
+ FvAlignment = 1 << ((ReadUnaligned32 (&FvHeader->Attributes) & EFI_FVB2_ALIGNMENT) >> 16);\r
+ if (FvAlignment < 8) {\r
+ FvAlignment = 8;\r
}\r
- CopyMem (FvBuffer, FvImageInfo.FvStart, (UINTN) FvImageInfo.FvSize);\r
+\r
//\r
- // Update FvImageInfo after reload FvImage to new aligned memory\r
+ // Check FvImage\r
//\r
- Status = PeiFfsGetVolumeInfo ((EFI_PEI_FV_HANDLE) FvBuffer, &FvImageInfo);\r
- ASSERT_EFI_ERROR (Status);\r
+ if ((UINTN) FvHeader % FvAlignment != 0) {\r
+ FvLength = ReadUnaligned64 (&FvHeader->FvLength);\r
+ NewFvBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINT32) FvLength), FvAlignment);\r
+ if (NewFvBuffer == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ CopyMem (NewFvBuffer, FvHeader, (UINTN) FvLength);\r
+ FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) NewFvBuffer;\r
+ }\r
}\r
\r
+ Status = ParentFvPpi->GetVolumeInfo (ParentFvPpi, ParentFvHandle, &ParentFvImageInfo);\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ Status = ParentFvPpi->GetFileInfo (ParentFvPpi, ParentFvFileHandle, &FileInfo);\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
//\r
// Install FvPpi and Build FvHob\r
//\r
PeiServicesInstallFvInfoPpi (\r
- NULL,\r
- FvImageInfo.FvStart,\r
- (UINT32) FvImageInfo.FvSize,\r
+ &FvHeader->FileSystemGuid,\r
+ (VOID**) FvHeader,\r
+ (UINT32) FvHeader->FvLength,\r
&ParentFvImageInfo.FvName,\r
- &(((EFI_FFS_FILE_HEADER*)ParentFvFileHandle)->Name)\r
+ &FileInfo.FileName\r
);\r
\r
//\r
// Inform the extracted FvImage to Fv HOB consumer phase, i.e. DXE phase\r
//\r
BuildFvHob (\r
- (EFI_PHYSICAL_ADDRESS) (UINTN) FvImageInfo.FvStart,\r
- FvImageInfo.FvSize\r
+ (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,\r
+ FvHeader->FvLength\r
);\r
\r
//\r
// encapsulated file again.\r
//\r
BuildFv2Hob (\r
- (EFI_PHYSICAL_ADDRESS) (UINTN) FvImageInfo.FvStart,\r
- FvImageInfo.FvSize,\r
+ (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,\r
+ FvHeader->FvLength,\r
&ParentFvImageInfo.FvName,\r
- &(((EFI_FFS_FILE_HEADER *)ParentFvFileHandle)->Name)\r
+ &FileInfo.FileName\r
);\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Process a firmware volume and create a volume handle.\r
+\r
+ Create a volume handle from the information in the buffer. For\r
+ memory-mapped firmware volumes, Buffer and BufferSize refer to\r
+ the start of the firmware volume and the firmware volume size.\r
+ For non memory-mapped firmware volumes, this points to a\r
+ buffer which contains the necessary information for creating\r
+ the firmware volume handle. Normally, these values are derived\r
+ from the EFI_FIRMWARE_VOLUME_INFO_PPI.\r
+ \r
+ \r
+ @param This Points to this instance of the\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ @param Buffer Points to the start of the buffer.\r
+ @param BufferSize Size of the buffer.\r
+ @param FvHandle Points to the returned firmware volume\r
+ handle. The firmware volume handle must\r
+ be unique within the system. \r
+\r
+ @retval EFI_SUCCESS Firmware volume handle created.\r
+ @retval EFI_VOLUME_CORRUPTED Volume was corrupt.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiFfsFvPpiProcessVolume (\r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+ IN VOID *Buffer,\r
+ IN UINTN BufferSize,\r
+ OUT EFI_PEI_FV_HANDLE *FvHandle\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ \r
+ ASSERT (FvHandle != NULL);\r
+ \r
+ if (Buffer == NULL) {\r
+ return EFI_VOLUME_CORRUPTED;\r
+ }\r
+ \r
+ //\r
+ // The build-in EFI_PEI_FIRMWARE_VOLUME_PPI for FFS2/FFS3 support memory-mapped\r
+ // FV image and the handle is pointed to Fv image's buffer.\r
+ //\r
+ *FvHandle = (EFI_PEI_FV_HANDLE) Buffer;\r
+ \r
+ //\r
+ // Do verify for given FV buffer.\r
+ //\r
+ Status = VerifyFv ((EFI_FIRMWARE_VOLUME_HEADER*) Buffer);\r
+ if (EFI_ERROR(Status)) {\r
+ DEBUG ((EFI_D_ERROR, "Fail to verify FV which address is 0x%11p", Buffer));\r
+ return EFI_VOLUME_CORRUPTED;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+} \r
+\r
+/**\r
+ Finds the next file of the specified type.\r
+\r
+ This service enables PEI modules to discover additional firmware files. \r
+ The FileHandle must be unique within the system.\r
+\r
+ @param This Points to this instance of the\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ @param SearchType A filter to find only files of this type. Type\r
+ EFI_FV_FILETYPE_ALL causes no filtering to be\r
+ done.\r
+ @param FvHandle Handle of firmware volume in which to\r
+ search.\r
+ @param FileHandle Points to the current handle from which to\r
+ begin searching or NULL to start at the\r
+ beginning of the firmware volume. Updated\r
+ upon return to reflect the file found.\r
+\r
+ @retval EFI_SUCCESS The file was found.\r
+ @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiFfsFvPpiFindFileByType (\r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+ IN EFI_FV_FILETYPE SearchType,\r
+ IN EFI_PEI_FV_HANDLE FvHandle,\r
+ IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r
+ )\r
+{ \r
+ return FindFileEx (FvHandle, NULL, SearchType, FileHandle, NULL);\r
+}\r
+\r
+/**\r
+ Find a file within a volume by its name. \r
+ \r
+ This service searches for files with a specific name, within\r
+ either the specified firmware volume or all firmware volumes.\r
+\r
+ @param This Points to this instance of the\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ @param FileName A pointer to the name of the file to find\r
+ within the firmware volume.\r
+ @param FvHandle Upon entry, the pointer to the firmware\r
+ volume to search or NULL if all firmware\r
+ volumes should be searched. Upon exit, the\r
+ actual firmware volume in which the file was\r
+ found.\r
+ @param FileHandle Upon exit, points to the found file's\r
+ handle or NULL if it could not be found.\r
+\r
+ @retval EFI_SUCCESS File was found.\r
+ @retval EFI_NOT_FOUND File was not found.\r
+ @retval EFI_INVALID_PARAMETER FvHandle or FileHandle or\r
+ FileName was NULL.\r
+\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiFfsFvPpiFindFileByName (\r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+ IN CONST EFI_GUID *FileName,\r
+ IN EFI_PEI_FV_HANDLE *FvHandle,\r
+ OUT EFI_PEI_FILE_HANDLE *FileHandle \r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PEI_CORE_INSTANCE *PrivateData;\r
+ UINTN Index;\r
+ \r
+ if ((FvHandle == NULL) || (FileName == NULL) || (FileHandle == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ \r
+ if (*FvHandle != NULL) {\r
+ Status = FindFileEx (*FvHandle, FileName, 0, FileHandle, NULL);\r
+ if (Status == EFI_NOT_FOUND) {\r
+ *FileHandle = NULL;\r
+ }\r
+ } else { \r
+ //\r
+ // If *FvHandle = NULL, so search all FV for given filename\r
+ //\r
+ Status = EFI_NOT_FOUND;\r
+ \r
+ PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer());\r
+ for (Index = 0; Index < PrivateData->FvCount; Index ++) {\r
+ //\r
+ // Only search the FV which is associated with a EFI_PEI_FIRMWARE_VOLUME_PPI instance.\r
+ //\r
+ if (PrivateData->Fv[Index].FvPpi != NULL) {\r
+ Status = FindFileEx (PrivateData->Fv[Index].FvHandle, FileName, 0, FileHandle, NULL);\r
+ if (!EFI_ERROR (Status)) {\r
+ *FvHandle = PrivateData->Fv[Index].FvHandle;\r
+ break;\r
+ }\r
+ }\r
+ }\r
+ }\r
+ \r
+ return Status; \r
+} \r
+\r
+/**\r
+ Returns information about a specific file.\r
+\r
+ This function returns information about a specific\r
+ file, including its file name, type, attributes, starting\r
+ address and size. \r
+ \r
+ @param This Points to this instance of the\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ @param FileHandle Handle of the file.\r
+ @param FileInfo Upon exit, points to the file's\r
+ information.\r
+\r
+ @retval EFI_SUCCESS File information returned.\r
+ @retval EFI_INVALID_PARAMETER If FileHandle does not\r
+ represent a valid file.\r
+ @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
+ \r
+**/ \r
+EFI_STATUS\r
+EFIAPI\r
+PeiFfsFvPpiGetFileInfo (\r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, \r
+ IN EFI_PEI_FILE_HANDLE FileHandle, \r
+ OUT EFI_FV_FILE_INFO *FileInfo\r
+ )\r
+{\r
+ UINT8 FileState;\r
+ UINT8 ErasePolarity;\r
+ EFI_FFS_FILE_HEADER *FileHeader;\r
+ PEI_CORE_FV_HANDLE *CoreFvHandle;\r
+ PEI_FW_VOL_INSTANCE *FwVolInstance;\r
+\r
+ if ((FileHandle == NULL) || (FileInfo == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Retrieve the FirmwareVolume which the file resides in.\r
+ //\r
+ CoreFvHandle = FileHandleToVolume (FileHandle);\r
+ if (CoreFvHandle == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ FwVolInstance = PEI_FW_VOL_INSTANCE_FROM_FV_THIS (This);\r
+\r
+ if ((CoreFvHandle->FvHeader->Attributes & EFI_FVB2_ERASE_POLARITY) != 0) {\r
+ ErasePolarity = 1;\r
+ } else {\r
+ ErasePolarity = 0;\r
+ }\r
+\r
+ //\r
+ // Get FileState which is the highest bit of the State \r
+ //\r
+ FileState = GetFileState (ErasePolarity, (EFI_FFS_FILE_HEADER*)FileHandle);\r
+\r
+ switch (FileState) {\r
+ case EFI_FILE_DATA_VALID:\r
+ case EFI_FILE_MARKED_FOR_UPDATE:\r
+ break; \r
+ default:\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ FileHeader = (EFI_FFS_FILE_HEADER *)FileHandle;\r
+ CopyMem (&FileInfo->FileName, &FileHeader->Name, sizeof(EFI_GUID));\r
+ FileInfo->FileType = FileHeader->Type;\r
+ FileInfo->FileAttributes = FfsAttributes2FvFileAttributes (FileHeader->Attributes);\r
+ if ((CoreFvHandle->FvHeader->Attributes & EFI_FVB2_MEMORY_MAPPED) == EFI_FVB2_MEMORY_MAPPED) {\r
+ FileInfo->FileAttributes |= EFI_FV_FILE_ATTRIB_MEMORY_MAPPED;\r
+ }\r
+ if (IS_FFS_FILE2 (FileHeader)) {\r
+ ASSERT (FFS_FILE2_SIZE (FileHeader) > 0x00FFFFFF);\r
+ if (!FwVolInstance->IsFfs3Fv) {\r
+ DEBUG ((EFI_D_ERROR, "It is a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &FileHeader->Name));\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ FileInfo->BufferSize = FFS_FILE2_SIZE (FileHeader) - sizeof (EFI_FFS_FILE_HEADER2);\r
+ FileInfo->Buffer = (UINT8 *) FileHeader + sizeof (EFI_FFS_FILE_HEADER2);\r
+ } else {\r
+ FileInfo->BufferSize = FFS_FILE_SIZE (FileHeader) - sizeof (EFI_FFS_FILE_HEADER);\r
+ FileInfo->Buffer = (UINT8 *) FileHeader + sizeof (EFI_FFS_FILE_HEADER);\r
+ }\r
+ return EFI_SUCCESS; \r
+} \r
+ \r
+/**\r
+ This function returns information about the firmware volume.\r
+ \r
+ @param This Points to this instance of the\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ @param FvHandle Handle to the firmware handle.\r
+ @param VolumeInfo Points to the returned firmware volume\r
+ information.\r
+\r
+ @retval EFI_SUCCESS Information returned successfully.\r
+ @retval EFI_INVALID_PARAMETER FvHandle does not indicate a valid\r
+ firmware volume or VolumeInfo is NULL.\r
+\r
+**/ \r
+EFI_STATUS\r
+EFIAPI\r
+PeiFfsFvPpiGetVolumeInfo (\r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, \r
+ IN EFI_PEI_FV_HANDLE FvHandle, \r
+ OUT EFI_FV_INFO *VolumeInfo\r
+ )\r
+{\r
+ EFI_FIRMWARE_VOLUME_HEADER FwVolHeader;\r
+ EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExHeaderInfo;\r
+\r
+ if ((VolumeInfo == NULL) || (FvHandle == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ \r
+ //\r
+ // VolumeHandle may not align at 8 byte, \r
+ // but FvLength is UINT64 type, which requires FvHeader align at least 8 byte. \r
+ // So, Copy FvHeader into the local FvHeader structure.\r
+ //\r
+ CopyMem (&FwVolHeader, FvHandle, sizeof (EFI_FIRMWARE_VOLUME_HEADER));\r
+\r
+ //\r
+ // Check Fv Image Signature\r
+ //\r
+ if (FwVolHeader.Signature != EFI_FVH_SIGNATURE) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ ZeroMem (VolumeInfo, sizeof (EFI_FV_INFO));\r
+ VolumeInfo->FvAttributes = FwVolHeader.Attributes;\r
+ VolumeInfo->FvStart = (VOID *) FvHandle;\r
+ VolumeInfo->FvSize = FwVolHeader.FvLength;\r
+ CopyMem (&VolumeInfo->FvFormat, &FwVolHeader.FileSystemGuid, sizeof(EFI_GUID));\r
+\r
+ if (FwVolHeader.ExtHeaderOffset != 0) {\r
+ FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER*)(((UINT8 *)FvHandle) + FwVolHeader.ExtHeaderOffset);\r
+ CopyMem (&VolumeInfo->FvName, &FwVolExHeaderInfo->FvName, sizeof(EFI_GUID));\r
+ }\r
+ \r
+ return EFI_SUCCESS; \r
+} \r
+\r
+/**\r
+ Find the next matching section in the firmware file.\r
+ \r
+ This service enables PEI modules to discover sections\r
+ of a given type within a valid file.\r
+ \r
+ @param This Points to this instance of the\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ @param SearchType A filter to find only sections of this\r
+ type.\r
+ @param FileHandle Handle of firmware file in which to\r
+ search.\r
+ @param SectionData Updated upon return to point to the\r
+ section found.\r
+ \r
+ @retval EFI_SUCCESS Section was found.\r
+ @retval EFI_NOT_FOUND Section of the specified type was not\r
+ found. SectionData contains NULL.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiFfsFvPpiFindSectionByType (\r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+ IN EFI_SECTION_TYPE SearchType,\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ OUT VOID **SectionData\r
+ )\r
+{\r
+ EFI_FFS_FILE_HEADER *FfsFileHeader;\r
+ UINT32 FileSize;\r
+ EFI_COMMON_SECTION_HEADER *Section;\r
+ PEI_FW_VOL_INSTANCE *FwVolInstance;\r
+\r
+ FwVolInstance = PEI_FW_VOL_INSTANCE_FROM_FV_THIS (This);\r
+\r
+ FfsFileHeader = (EFI_FFS_FILE_HEADER *)(FileHandle);\r
\r
+ if (IS_FFS_FILE2 (FfsFileHeader)) {\r
+ ASSERT (FFS_FILE2_SIZE (FfsFileHeader) > 0x00FFFFFF);\r
+ if (!FwVolInstance->IsFfs3Fv) {\r
+ DEBUG ((EFI_D_ERROR, "It is a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &FfsFileHeader->Name));\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ Section = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER2));\r
+ FileSize = FFS_FILE2_SIZE (FfsFileHeader) - sizeof (EFI_FFS_FILE_HEADER2);\r
+ } else {\r
+ Section = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER));\r
+ FileSize = FFS_FILE_SIZE (FfsFileHeader) - sizeof (EFI_FFS_FILE_HEADER);\r
+ }\r
+\r
+ return ProcessSection (\r
+ GetPeiServicesTablePointer (),\r
+ SearchType, \r
+ Section, \r
+ FileSize, \r
+ SectionData,\r
+ FwVolInstance->IsFfs3Fv\r
+ ); \r
+} \r
+\r
+/**\r
+ Convert the handle of FV to pointer of corresponding PEI_CORE_FV_HANDLE.\r
+ \r
+ @param FvHandle The handle of a FV.\r
+ \r
+ @retval NULL if can not find.\r
+ @return Pointer of corresponding PEI_CORE_FV_HANDLE. \r
+**/\r
+PEI_CORE_FV_HANDLE *\r
+FvHandleToCoreHandle (\r
+ IN EFI_PEI_FV_HANDLE FvHandle\r
+ )\r
+{\r
+ UINTN Index;\r
+ PEI_CORE_INSTANCE *PrivateData;\r
+ \r
+ PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer()); \r
+ for (Index = 0; Index < PrivateData->FvCount; Index ++) {\r
+ if (FvHandle == PrivateData->Fv[Index].FvHandle) {\r
+ return &PrivateData->Fv[Index];\r
+ }\r
+ }\r
+ \r
+ return NULL;\r
+} \r
+\r
+/**\r
+ Get instance of PEI_CORE_FV_HANDLE for next volume according to given index.\r
+ \r
+ This routine also will install FvInfo ppi for FV hob in PI ways.\r
+ \r
+ @param Private Pointer of PEI_CORE_INSTANCE\r
+ @param Instance The index of FV want to be searched.\r
+ \r
+ @return Instance of PEI_CORE_FV_HANDLE.\r
+**/\r
+PEI_CORE_FV_HANDLE *\r
+FindNextCoreFvHandle (\r
+ IN PEI_CORE_INSTANCE *Private,\r
+ IN UINTN Instance\r
+ )\r
+{\r
+ UINTN Index;\r
+ BOOLEAN Match;\r
+ EFI_HOB_FIRMWARE_VOLUME *FvHob;\r
+ \r
+ //\r
+ // Handle Framework FvHob and Install FvInfo Ppi for it.\r
+ //\r
+ if (FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {\r
+ //\r
+ // Loop to search the wanted FirmwareVolume which supports FFS\r
+ //\r
+ FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetFirstHob (EFI_HOB_TYPE_FV);\r
+ while (FvHob != NULL) {\r
+ //\r
+ // Search whether FvHob has been installed into PeiCore's FV database.\r
+ // If found, no need install new FvInfoPpi for it.\r
+ //\r
+ for (Index = 0, Match = FALSE; Index < Private->FvCount; Index++) {\r
+ if ((EFI_PEI_FV_HANDLE)(UINTN)FvHob->BaseAddress == Private->Fv[Index].FvHeader) {\r
+ Match = TRUE;\r
+ break;\r
+ }\r
+ }\r
+ \r
+ //\r
+ // Search whether FvHob has been cached into PeiCore's Unknown FV database.\r
+ // If found, no need install new FvInfoPpi for it.\r
+ //\r
+ if (!Match) {\r
+ for (Index = 0; Index < Private->UnknownFvInfoCount; Index ++) {\r
+ if ((UINTN)FvHob->BaseAddress == (UINTN)Private->UnknownFvInfo[Index].FvInfo) {\r
+ Match = TRUE;\r
+ break;\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // If the Fv in FvHob has not been installed into PeiCore's FV database and has\r
+ // not been cached into PeiCore's Unknown FV database, install a new FvInfoPpi\r
+ // for it then PeiCore will dispatch it in callback of FvInfoPpi.\r
+ //\r
+ if (!Match) {\r
+ PeiServicesInstallFvInfoPpi (\r
+ &(((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)FvHob->BaseAddress)->FileSystemGuid),\r
+ (VOID *)(UINTN)FvHob->BaseAddress,\r
+ (UINT32)FvHob->Length,\r
+ NULL,\r
+ NULL\r
+ );\r
+ }\r
+ \r
+ FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetNextHob (EFI_HOB_TYPE_FV, (VOID *)((UINTN)FvHob + FvHob->Header.HobLength)); \r
+ }\r
+ }\r
+\r
+ ASSERT (Private->FvCount <= FixedPcdGet32 (PcdPeiCoreMaxFvSupported));\r
+ if (Instance >= Private->FvCount) {\r
+ return NULL;\r
+ }\r
+\r
+ return &Private->Fv[Instance];\r
+} \r
+\r
+/**\r
+ After PeiCore image is shadowed into permanent memory, all build-in FvPpi should\r
+ be re-installed with the instance in permanent memory and all cached FvPpi pointers in \r
+ PrivateData->Fv[] array should be fixed up to be pointed to the one in permenant\r
+ memory.\r
+ \r
+ @param PrivateData Pointer to PEI_CORE_INSTANCE.\r
+**/ \r
+VOID\r
+PeiReinitializeFv (\r
+ IN PEI_CORE_INSTANCE *PrivateData\r
+ )\r
+{\r
+ VOID *OldFfsFvPpi;\r
+ EFI_PEI_PPI_DESCRIPTOR *OldDescriptor;\r
+ UINTN Index;\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Locate old build-in Ffs2 EFI_PEI_FIRMWARE_VOLUME_PPI which\r
+ // in flash.\r
+ //\r
+ Status = PeiServicesLocatePpi (\r
+ &gEfiFirmwareFileSystem2Guid,\r
+ 0,\r
+ &OldDescriptor,\r
+ &OldFfsFvPpi\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Re-install the EFI_PEI_FIRMWARE_VOLUME_PPI for build-in Ffs2\r
+ // which is shadowed from flash to permanent memory within PeiCore image.\r
+ //\r
+ Status = PeiServicesReInstallPpi (OldDescriptor, &mPeiFfs2FvPpiList);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Fixup all FvPpi pointers for the implementation in flash to permanent memory.\r
+ //\r
+ for (Index = 0; Index < FixedPcdGet32 (PcdPeiCoreMaxFvSupported); Index ++) {\r
+ if (PrivateData->Fv[Index].FvPpi == OldFfsFvPpi) {\r
+ PrivateData->Fv[Index].FvPpi = &mPeiFfs2FwVol.Fv;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Locate old build-in Ffs3 EFI_PEI_FIRMWARE_VOLUME_PPI which\r
+ // in flash.\r
+ //\r
+ Status = PeiServicesLocatePpi (\r
+ &gEfiFirmwareFileSystem3Guid,\r
+ 0,\r
+ &OldDescriptor,\r
+ &OldFfsFvPpi\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Re-install the EFI_PEI_FIRMWARE_VOLUME_PPI for build-in Ffs3\r
+ // which is shadowed from flash to permanent memory within PeiCore image.\r
+ //\r
+ Status = PeiServicesReInstallPpi (OldDescriptor, &mPeiFfs3FvPpiList);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Fixup all FvPpi pointers for the implementation in flash to permanent memory.\r
+ //\r
+ for (Index = 0; Index < FixedPcdGet32 (PcdPeiCoreMaxFvSupported); Index ++) {\r
+ if (PrivateData->Fv[Index].FvPpi == OldFfsFvPpi) {\r
+ PrivateData->Fv[Index].FvPpi = &mPeiFfs3FwVol.Fv;\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+ Report the information for a new discoveried FV in unknown third-party format.\r
+ \r
+ If the EFI_PEI_FIRMWARE_VOLUME_PPI has not been installed for third-party FV format, but\r
+ the FV in this format has been discoveried, then this FV's information will be cached into \r
+ PEI_CORE_INSTANCE's UnknownFvInfo array.\r
+ Also a notification would be installed for unknown third-party FV format guid, if EFI_PEI_FIRMWARE_VOLUME_PPI\r
+ is installed later by platform's PEIM, the original unknown third-party FV will be processed by\r
+ using new installed EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ \r
+ @param PrivateData Point to instance of PEI_CORE_INSTANCE\r
+ @param Format Point to the unknown third-party format guid.\r
+ @param FvInfo Point to FvInfo buffer.\r
+ @param FvInfoSize The size of FvInfo buffer.\r
+ \r
+ @retval EFI_OUT_OF_RESOURCES The FV info array in PEI_CORE_INSTANCE has no more spaces.\r
+ @retval EFI_SUCCESS Success to add the information for unknown FV.\r
+**/\r
+EFI_STATUS\r
+AddUnknownFormatFvInfo (\r
+ IN PEI_CORE_INSTANCE *PrivateData,\r
+ IN EFI_GUID *Format,\r
+ IN VOID *FvInfo,\r
+ IN UINT32 FvInfoSize\r
+ )\r
+{\r
+ PEI_CORE_UNKNOW_FORMAT_FV_INFO *NewUnknownFv;\r
+ \r
+ if (PrivateData->UnknownFvInfoCount + 1 >= FixedPcdGet32 (PcdPeiCoreMaxFvSupported)) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ \r
+ NewUnknownFv = &PrivateData->UnknownFvInfo[PrivateData->UnknownFvInfoCount];\r
+ PrivateData->UnknownFvInfoCount ++;\r
+ \r
+ CopyGuid (&NewUnknownFv->FvFormat, Format);\r
+ NewUnknownFv->FvInfo = FvInfo;\r
+ NewUnknownFv->FvInfoSize = FvInfoSize;\r
+ NewUnknownFv->NotifyDescriptor.Flags = (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST);\r
+ NewUnknownFv->NotifyDescriptor.Guid = &NewUnknownFv->FvFormat;\r
+ NewUnknownFv->NotifyDescriptor.Notify = ThirdPartyFvPpiNotifyCallback;\r
+ \r
+ PeiServicesNotifyPpi (&NewUnknownFv->NotifyDescriptor);\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Find the FV information according to third-party FV format guid.\r
+ \r
+ This routine also will remove the FV information found by given FV format guid from\r
+ PrivateData->UnknownFvInfo[].\r
+ \r
+ @param PrivateData Point to instance of PEI_CORE_INSTANCE\r
+ @param Format Point to given FV format guid\r
+ @param FvInfo On return, the pointer of FV information buffer\r
+ @param FvInfoSize On return, the size of FV information buffer.\r
+ \r
+ @retval EFI_NOT_FOUND The FV is not found for new installed EFI_PEI_FIRMWARE_VOLUME_PPI\r
+ @retval EFI_SUCCESS Success to find a FV which could be processed by new installed EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+**/\r
+EFI_STATUS\r
+FindUnknownFormatFvInfo (\r
+ IN PEI_CORE_INSTANCE *PrivateData,\r
+ IN EFI_GUID *Format,\r
+ OUT VOID **FvInfo,\r
+ OUT UINT32 *FvInfoSize\r
+ )\r
+{\r
+ UINTN Index;\r
+ UINTN Index2;\r
+\r
+ Index = 0;\r
+ for (; Index < PrivateData->UnknownFvInfoCount; Index ++) {\r
+ if (CompareGuid (Format, &PrivateData->UnknownFvInfo[Index].FvFormat)) {\r
+ break;\r
+ }\r
+ }\r
+ \r
+ if (Index == PrivateData->UnknownFvInfoCount) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ \r
+ *FvInfo = PrivateData->UnknownFvInfo[Index].FvInfo;\r
+ *FvInfoSize = PrivateData->UnknownFvInfo[Index].FvInfoSize;\r
+ \r
+ //\r
+ // Remove an entry from UnknownFvInfo array.\r
+ //\r
+ Index2 = Index + 1;\r
+ for (;Index2 < PrivateData->UnknownFvInfoCount; Index2 ++, Index ++) {\r
+ CopyMem (&PrivateData->UnknownFvInfo[Index], &PrivateData->UnknownFvInfo[Index2], sizeof (PEI_CORE_UNKNOW_FORMAT_FV_INFO));\r
+ }\r
+ PrivateData->UnknownFvInfoCount --;\r
+ return EFI_SUCCESS;\r
+} \r
+\r
+/**\r
+ Notification callback function for EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+ \r
+ When a EFI_PEI_FIRMWARE_VOLUME_PPI is installed to support new FV format, this \r
+ routine is called to process all discoveried FVs in this format.\r
+ \r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
+ @param NotifyDescriptor Address of the notification descriptor data structure.\r
+ @param Ppi Address of the PPI that was installed.\r
+ \r
+ @retval EFI_SUCCESS The notification callback is processed correctly.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ThirdPartyFvPpiNotifyCallback (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
+ IN VOID *Ppi\r
+ )\r
+{\r
+ PEI_CORE_INSTANCE *PrivateData;\r
+ EFI_PEI_FIRMWARE_VOLUME_PPI *FvPpi;\r
+ VOID *FvInfo;\r
+ UINT32 FvInfoSize;\r
+ EFI_STATUS Status;\r
+ EFI_PEI_FV_HANDLE FvHandle;\r
+ BOOLEAN IsProcessed;\r
+ UINTN FvIndex;\r
+ EFI_PEI_FILE_HANDLE FileHandle;\r
+ VOID *DepexData; \r
+ \r
+ PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
+ FvPpi = (EFI_PEI_FIRMWARE_VOLUME_PPI*) Ppi;\r
+ \r
+ do {\r
+ Status = FindUnknownFormatFvInfo (PrivateData, NotifyDescriptor->Guid, &FvInfo, &FvInfoSize);\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_SUCCESS;\r
+ }\r
+ \r
+ //\r
+ // Process new found FV and get FV handle.\r
+ //\r
+ Status = FvPpi->ProcessVolume (FvPpi, FvInfo, FvInfoSize, &FvHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((EFI_D_ERROR, "Fail to process the FV 0x%p, FV may be corrupted!\n", FvInfo));\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Check whether the FV has already been processed.\r
+ //\r
+ IsProcessed = FALSE;\r
+ for (FvIndex = 0; FvIndex < PrivateData->FvCount; FvIndex ++) {\r
+ if (PrivateData->Fv[FvIndex].FvHandle == FvHandle) {\r
+ DEBUG ((EFI_D_INFO, "The Fv %p has already been processed!\n", FvInfo));\r
+ IsProcessed = TRUE;\r
+ break;\r
+ }\r
+ }\r
+ \r
+ if (IsProcessed) {\r
+ continue;\r
+ }\r
+ \r
+ if (PrivateData->FvCount >= FixedPcdGet32 (PcdPeiCoreMaxFvSupported)) {\r
+ DEBUG ((EFI_D_ERROR, "The number of Fv Images (%d) exceed the max supported FVs (%d) in Pei", PrivateData->FvCount + 1, FixedPcdGet32 (PcdPeiCoreMaxFvSupported)));\r
+ DEBUG ((EFI_D_ERROR, "PcdPeiCoreMaxFvSupported value need be reconfigurated in DSC"));\r
+ ASSERT (FALSE);\r
+ }\r
+ \r
+ //\r
+ // Update internal PEI_CORE_FV array.\r
+ //\r
+ PrivateData->Fv[PrivateData->FvCount].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) FvInfo;\r
+ PrivateData->Fv[PrivateData->FvCount].FvPpi = FvPpi;\r
+ PrivateData->Fv[PrivateData->FvCount].FvHandle = FvHandle;\r
+ DEBUG ((\r
+ EFI_D_INFO, \r
+ "The %dth FV start address is 0x%11p, size is 0x%08x, handle is 0x%p\n", \r
+ (UINT32) PrivateData->FvCount, \r
+ (VOID *) FvInfo, \r
+ FvInfoSize,\r
+ FvHandle\r
+ )); \r
+ PrivateData->FvCount ++;\r
+\r
+ //\r
+ // Scan and process the new discoveried FV for EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE \r
+ //\r
+ FileHandle = NULL;\r
+ do {\r
+ Status = FvPpi->FindFileByType (\r
+ FvPpi,\r
+ EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE,\r
+ FvHandle,\r
+ &FileHandle\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = FvPpi->FindSectionByType (\r
+ FvPpi,\r
+ EFI_SECTION_PEI_DEPEX,\r
+ FileHandle,\r
+ (VOID**)&DepexData\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ if (!PeimDispatchReadiness (PeiServices, DepexData)) {\r
+ //\r
+ // Dependency is not satisfied.\r
+ //\r
+ continue;\r
+ }\r
+ }\r
+ \r
+ DEBUG ((EFI_D_INFO, "Found firmware volume Image File %p in FV[%d] %p\n", FileHandle, PrivateData->FvCount - 1, FvHandle));\r
+ ProcessFvFile (&PrivateData->Fv[PrivateData->FvCount - 1], FileHandle);\r
+ }\r
+ } while (FileHandle != NULL);\r
+ } while (TRUE);\r
+}\r
projects / mirror_edk2.git / blobdiff