[mirror_edk2.git] / MdeModulePkg / Core / Pei / FwVol / FwVol.c

/** @file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
All rights reserved. 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  FwVol.c\r
\r
Abstract:\r
\r
  Pei Core Firmware File System service routines.\r
\r
**/\r
\r
#include <PeiMain.h>\r
\r
STATIC EFI_PEI_NOTIFY_DESCRIPTOR mNotifyOnFvInfoList = {\r
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiFirmwareVolumeInfoPpiGuid,\r
  FirmwareVolmeInfoPpiNotifyCallback \r
};\r
\r
\r
#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
  (ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1))\r
\r
STATIC\r
EFI_FFS_FILE_STATE\r
GetFileState(\r
  IN UINT8                ErasePolarity,\r
  IN EFI_FFS_FILE_HEADER  *FfsHeader\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Returns the highest bit set of the State field\r
\r
Arguments:\r
\r
  ErasePolarity   - Erase Polarity  as defined by EFI_FVB2_ERASE_POLARITY\r
                    in the Attributes field.\r
  FfsHeader       - Pointer to FFS File Header.\r
\r
Returns:\r
  Returns the highest bit in the State field\r
\r
--*/\r
{\r
  EFI_FFS_FILE_STATE  FileState;\r
  EFI_FFS_FILE_STATE  HighestBit;\r
\r
  FileState = FfsHeader->State;\r
\r
  if (ErasePolarity != 0) {\r
    FileState = (EFI_FFS_FILE_STATE)~FileState;\r
  }\r
\r
  HighestBit = 0x80;\r
  while (HighestBit != 0 && (HighestBit & FileState) == 0) {\r
    HighestBit >>= 1;\r
  }\r
\r
  return HighestBit;\r
} \r
\r
STATIC\r
UINT8\r
CalculateHeaderChecksum (\r
  IN EFI_FFS_FILE_HEADER  *FileHeader\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Calculates the checksum of the header of a file.\r
\r
Arguments:\r
\r
  FileHeader       - Pointer to FFS File Header.\r
\r
Returns:\r
  Checksum of the header.\r
  \r
  The header is zero byte checksum.\r
    - Zero means the header is good.\r
    - Non-zero means the header is bad.\r
    \r
  \r
Bugbug: For PEI performance reason, we comments this code at this time.\r
--*/\r
{\r
  UINT8   *ptr;\r
  UINTN   Index;\r
  UINT8   Sum;\r
  \r
  Sum = 0;\r
  ptr = (UINT8 *)FileHeader;\r
\r
  for (Index = 0; Index < sizeof(EFI_FFS_FILE_HEADER) - 3; Index += 4) {\r
    Sum = (UINT8)(Sum + ptr[Index]);\r
    Sum = (UINT8)(Sum + ptr[Index+1]);\r
    Sum = (UINT8)(Sum + ptr[Index+2]);\r
    Sum = (UINT8)(Sum + ptr[Index+3]);\r
  }\r
\r
  for (; Index < sizeof(EFI_FFS_FILE_HEADER); Index++) {\r
    Sum = (UINT8)(Sum + ptr[Index]);\r
  }\r
  \r
  //\r
  // State field (since this indicates the different state of file). \r
  //\r
  Sum = (UINT8)(Sum - FileHeader->State);\r
  //\r
  // Checksum field of the file is not part of the header checksum.\r
  //\r
  Sum = (UINT8)(Sum - FileHeader->IntegrityCheck.Checksum.File);\r
\r
  return Sum;\r
}\r
\r
STATIC\r
BOOLEAN\r
EFIAPI\r
PeiFileHandleToVolume (\r
  IN   EFI_PEI_FILE_HANDLE     FileHandle,\r
  OUT  EFI_PEI_FV_HANDLE       *VolumeHandle\r
  )\r
{\r
  UINTN                       Index;\r
  PEI_CORE_INSTANCE           *PrivateData;\r
  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader;\r
\r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer ());\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
    }\r
  }\r
  return FALSE;\r
}\r
\r
\r
EFI_STATUS\r
PeiFindFileEx (\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
  )\r
/*++\r
\r
Routine Description:\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
Arguments:\r
    PeiServices - Pointer to the PEI Core Services Table.\r
    SearchType - Filter to find only files of this type.\r
      Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
    FwVolHeader - Pointer to the FV header of the volume to search.\r
      This parameter must point to a valid FFS volume.\r
    FileHeader  - Pointer to the current file from which to begin searching.\r
      This pointer will be updated upon return to reflect the file found.\r
    Flag        - Indicator for if this is for PEI Dispath search \r
    \r
Returns:\r
    EFI_NOT_FOUND - No files matching the search criteria were found\r
    EFI_SUCCESS\r
\r
--*/\r
{\r
  EFI_FIRMWARE_VOLUME_HEADER           *FwVolHeader;\r
  EFI_FFS_FILE_HEADER                   **FileHeader;\r
  EFI_FFS_FILE_HEADER                   *FfsFileHeader;\r
  EFI_FIRMWARE_VOLUME_EXT_HEADER        *FwVolExHeaderInfo;\r
  UINT32                                FileLength;\r
  UINT32                                FileOccupiedSize;\r
  UINT32                                FileOffset;\r
  UINT64                                FvLength;\r
  UINT8                                 ErasePolarity;\r
  UINT8                                 FileState;\r
\r
  FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)FvHandle;\r
  FileHeader  = (EFI_FFS_FILE_HEADER **)FileHandle;\r
\r
  FvLength = FwVolHeader->FvLength;\r
  if (FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {\r
    ErasePolarity = 1;\r
  } else {\r
    ErasePolarity = 0;\r
  }\r
  \r
  //\r
  // If FileHeader is not specified (NULL) or FileName is not NULL,\r
  // start with the first file in the firmware volume.  Otherwise,\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
      FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER *)(((UINT8 *)FwVolHeader) + FwVolHeader->ExtHeaderOffset);\r
      FfsFileHeader = (EFI_FFS_FILE_HEADER *)(((UINT8 *)FwVolExHeaderInfo) + FwVolExHeaderInfo->ExtHeaderSize);\r
    }\r
  } else {\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
  \r
  FileOffset = (UINT32) ((UINT8 *)FfsFileHeader - (UINT8 *)FwVolHeader);\r
  ASSERT (FileOffset <= 0xFFFFFFFF);\r
\r
  while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {\r
    //\r
    // Get FileState which is the highest bit of the State \r
    //\r
    FileState = GetFileState (ErasePolarity, FfsFileHeader);\r
    switch (FileState) {\r
\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
      break;\r
        \r
    case EFI_FILE_DATA_VALID:\r
    case EFI_FILE_MARKED_FOR_UPDATE:\r
      if (CalculateHeaderChecksum (FfsFileHeader) != 0) {\r
        ASSERT (FALSE);\r
        *FileHeader = NULL;\r
        return EFI_NOT_FOUND;\r
      }\r
\r
      FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
      FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r
\r
      if (FileName != NULL) {\r
        if (CompareGuid (&FfsFileHeader->Name, (EFI_GUID*)FileName)) {\r
          *FileHeader = FfsFileHeader;\r
          return EFI_SUCCESS;\r
        }\r
      } else if (SearchType == PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE) {\r
        if ((FfsFileHeader->Type == EFI_FV_FILETYPE_PEIM) || \r
            (FfsFileHeader->Type == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER) ||\r
            (FfsFileHeader->Type == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE)) { \r
          \r
          *FileHeader = FfsFileHeader;\r
          return EFI_SUCCESS;\r
        } else if (AprioriFile != NULL) {\r
          if (FfsFileHeader->Type == EFI_FV_FILETYPE_FREEFORM) {\r
            if (CompareGuid (&FfsFileHeader->Name, &gPeiAprioriFileNameGuid)) {\r
              *AprioriFile = FfsFileHeader;\r
            }           \r
          } \r
        }\r
      } else if (((SearchType == FfsFileHeader->Type) || (SearchType == EFI_FV_FILETYPE_ALL)) && \r
                 (FfsFileHeader->Type != EFI_FV_FILETYPE_FFS_PAD)) { \r
        *FileHeader = FfsFileHeader;\r
        return EFI_SUCCESS;\r
      }\r
\r
      FileOffset += FileOccupiedSize; \r
      FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r
      break;\r
    \r
    case EFI_FILE_DELETED:\r
      FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
      FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r
      FileOffset += FileOccupiedSize;\r
      FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r
      break;\r
\r
    default:\r
      *FileHeader = NULL;\r
      return EFI_NOT_FOUND;\r
    } \r
  }\r
  \r
  *FileHeader = NULL;\r
  return EFI_NOT_FOUND;  \r
}\r
\r
VOID \r
PeiInitializeFv (\r
  IN  PEI_CORE_INSTANCE           *PrivateData,\r
  IN CONST EFI_SEC_PEI_HAND_OFF   *SecCoreData\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Initialize PeiCore Fv List.\r
\r
Arguments:\r
  PrivateData     - Pointer to PEI_CORE_INSTANCE.\r
  SecCoreData     - Pointer to EFI_SEC_PEI_HAND_OFF.\r
\r
Returns:\r
  NONE  \r
  \r
--*/  \r
{\r
  EFI_STATUS  Status;\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
  //\r
  PrivateData->FvCount = 1;\r
  PrivateData->Fv[0].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)SecCoreData->BootFirmwareVolumeBase;\r
\r
  PrivateData->AllFvCount = 1;\r
  PrivateData->AllFv[0] = (EFI_PEI_FV_HANDLE)PrivateData->Fv[0].FvHeader;\r
\r
\r
  //\r
  // Post a call-back for the FvInfoPPI services to expose\r
  // additional Fvs to PeiCore.\r
  //\r
  Status = PeiServicesNotifyPpi (&mNotifyOnFvInfoList);\r
  ASSERT_EFI_ERROR (Status);\r
\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
FirmwareVolmeInfoPpiNotifyCallback (\r
  IN EFI_PEI_SERVICES              **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR     *NotifyDescriptor,\r
  IN VOID                          *Ppi\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Process Firmware Volum Information once FvInfoPPI install.\r
\r
Arguments:\r
\r
  PeiServices - General purpose services available to every PEIM.\r
    \r
Returns:\r
\r
  Status -  EFI_SUCCESS if the interface could be successfully\r
            installed\r
\r
--*/\r
{\r
  UINT8                                 FvCount;\r
  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI      *Fv;\r
  PEI_CORE_INSTANCE                     *PrivateData;\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
  if (PrivateData->FvCount >= FixedPcdGet32 (PcdPeiCoreMaxFvSupported)) {\r
    ASSERT (FALSE);\r
  }\r
\r
  Fv = (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *)Ppi;\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
        return EFI_SUCCESS;\r
      }\r
    }\r
    PrivateData->Fv[PrivateData->FvCount++].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Fv->FvInfo;\r
\r
    //\r
    // Only add FileSystem2 Fv to the All list\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%10p and size is 0x%08x\n", PrivateData->AllFvCount, (VOID *) Fv->FvInfo, Fv->FvInfoSize));\r
    //\r
    // Preprocess all FV type files in this new FileSystem2 Fv image\r
    //\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
      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
        if (!EFI_ERROR (Status)) {\r
          if (!PeimDispatchReadiness (PeiServices, DepexData)) {\r
            //\r
            // Dependency is not satisfied.\r
            //\r
            continue;\r
          }\r
        }\r
        //\r
        // Process FvFile to install FvInfo ppi and build FvHob\r
        // \r
        ProcessFvFile (PeiServices, FileHandle, &AuthenticationStatus);\r
      }\r
    } while (FileHandle != NULL);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
PeiFfsProcessSection (\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
  )\r
/*++\r
\r
Routine Description:\r
\r
  Go through the file to search SectionType section,\r
  when meeting an encapsuled section. \r
  \r
Arguments:\r
  PeiServices  - General purpose services available to every PEIM.\r
  SearchType   - Filter to find only section of this type.\r
  Section      - From where to search.\r
  SectionSize  - The file size to search.\r
  OutputBuffer - Pointer to the section to search.\r
\r
Returns:\r
  EFI_STATUS\r
  \r
--*/\r
{\r
  EFI_STATUS                              Status;\r
  UINT32                                  SectionLength;\r
  UINT32                                  ParsedLength;\r
  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   *GuidSectionPpi;\r
  EFI_PEI_DECOMPRESS_PPI                  *DecompressPpi;\r
  VOID                                    *PpiOutput;\r
  UINTN                                   PpiOutputSize;\r
  UINTN                                   Index;\r
  UINT32                                  Authentication;\r
  PEI_CORE_INSTANCE                       *PrivateData;\r
\r
  PrivateData   = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
  *OutputBuffer = NULL;\r
  ParsedLength  = 0;\r
  Index         = 0;\r
  Status        = EFI_NOT_FOUND;\r
  PpiOutput     = NULL;\r
  PpiOutputSize = 0;\r
  while (ParsedLength < SectionSize) {\r
    if (Section->Type == SectionType) {\r
      *OutputBuffer = (VOID *)(Section + 1);\r
      return EFI_SUCCESS;\r
    } else if ((Section->Type == EFI_SECTION_GUID_DEFINED) || (Section->Type == EFI_SECTION_COMPRESSION)) {\r
      //\r
      // Check the encapsulated section is extracted into the cache data.\r
      //\r
      for (Index = 0; Index < PrivateData->CacheSection.AllSectionCount; Index ++) {\r
        if (Section == PrivateData->CacheSection.Section[Index]) {\r
          PpiOutput     = PrivateData->CacheSection.SectionData[Index];\r
          PpiOutputSize = PrivateData->CacheSection.SectionSize[Index];\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
        }\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
          Status = GuidSectionPpi->ExtractSection (\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
        if (!EFI_ERROR (Status)) {\r
          Status = DecompressPpi->Decompress (\r
                                    DecompressPpi,\r
                                    (CONST EFI_COMPRESSION_SECTION*) Section,\r
                                    &PpiOutput,\r
                                    &PpiOutputSize\r
                                    );\r
        }\r
      }\r
      \r
      if (!EFI_ERROR (Status)) {\r
        //\r
        // Update cache section data.\r
        //\r
        if (PrivateData->CacheSection.AllSectionCount < CACHE_SETION_MAX_NUMBER) {\r
          PrivateData->CacheSection.AllSectionCount ++;\r
        }\r
        PrivateData->CacheSection.Section [PrivateData->CacheSection.SectionIndex]     = Section;\r
        PrivateData->CacheSection.SectionData [PrivateData->CacheSection.SectionIndex] = PpiOutput;\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
      }\r
    }\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
    Section = (EFI_COMMON_SECTION_HEADER *)((UINT8 *)Section + SectionLength);\r
  }\r
  \r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFindSectionData (\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
  )\r
/*++\r
\r
Routine Description:\r
    Given the input file pointer, search for the next matching section in the\r
    FFS volume.\r
\r
Arguments:\r
    PeiServices - Pointer to the PEI Core Services Table.\r
    SearchType - Filter to find only sections of this type.\r
    FfsFileHeader  - Pointer to the current file to search.\r
    SectionData - Pointer to the Section matching SectionType in FfsFileHeader.\r
                - NULL if section not found\r
\r
Returns:\r
    EFI_NOT_FOUND - No files matching the search criteria were found\r
    EFI_SUCCESS\r
\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
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFindNextFile (\r
  IN CONST EFI_PEI_SERVICES      **PeiServices,\r
  IN UINT8                       SearchType,\r
  IN EFI_PEI_FV_HANDLE           VolumeHandle,\r
  IN OUT EFI_PEI_FILE_HANDLE     *FileHandle\r
  )\r
/*++\r
\r
Routine Description:\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
Arguments:\r
    PeiServices - Pointer to the PEI Core Services Table.\r
    \r
    SearchType - Filter to find only files of this type.\r
      Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
      \r
    FwVolHeader - Pointer to the FV header of the volume to search.\r
      This parameter must point to a valid FFS volume.\r
      \r
    FileHeader  - Pointer to the current file from which to begin searching.\r
      This pointer will be updated upon return to reflect the file found.\r
  \r
Returns:\r
    EFI_NOT_FOUND - No files matching the search criteria were found\r
    EFI_SUCCESS\r
\r
--*/\r
{\r
  return PeiFindFileEx (VolumeHandle, NULL, SearchType, FileHandle, NULL);\r
}\r
\r
\r
EFI_STATUS \r
EFIAPI\r
PeiFvFindNextVolume (\r
  IN CONST EFI_PEI_SERVICES           **PeiServices,\r
  IN     UINTN                      Instance,\r
  IN OUT EFI_PEI_FV_HANDLE          *VolumeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Return the firmware volumes.\r
\r
  BugBug -- Move this to the location of this code to where the\r
  other FV and FFS support code lives.\r
  Also, update to use FindFV for instances #'s >= 1.\r
\r
Arguments:\r
\r
  PeiServices - The PEI core services table.\r
  Instance    - Instance of FV to find\r
  FwVolHeader - Pointer to contain the data to return\r
\r
Returns:\r
  Pointer to the Firmware Volume instance requested\r
\r
  EFI_INVALID_PARAMETER     - FwVolHeader is NULL\r
  \r
  EFI_SUCCESS               - Firmware volume instance successfully found.\r
\r
--*/\r
{\r
  PEI_CORE_INSTANCE   *Private;\r
\r
  Private = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
  if (VolumeHandle == NULL) {\r
   return EFI_INVALID_PARAMETER;\r
  } \r
\r
  if (Instance >= Private->AllFvCount) {\r
   VolumeHandle = NULL;\r
   return EFI_NOT_FOUND;\r
  }\r
\r
  *VolumeHandle = Private->AllFv[Instance];\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI \r
PeiFfsFindFileByName (\r
  IN  CONST EFI_GUID        *FileName,\r
  IN  EFI_PEI_FV_HANDLE     VolumeHandle,\r
  OUT EFI_PEI_FILE_HANDLE   *FileHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Given the input VolumeHandle, search for the next matching name file.\r
\r
Arguments:\r
\r
  FileName      - File name to search.\r
  VolumeHandle  - The current FV to search.\r
  FileHandle    - Pointer to the file matching name in VolumeHandle.\r
                - NULL if file not found\r
Returns:\r
  EFI_STATUS\r
  \r
--*/  \r
{\r
  EFI_STATUS  Status;\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
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI \r
PeiFfsGetFileInfo (\r
  IN EFI_PEI_FILE_HANDLE  FileHandle,\r
  OUT EFI_FV_FILE_INFO    *FileInfo\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Collect information of given file.\r
\r
Arguments:\r
  FileHandle   - The handle to file.\r
  FileInfo     - Pointer to the file information.\r
\r
Returns:\r
  EFI_STATUS\r
  \r
--*/    \r
{\r
  UINT8                       FileState;\r
  UINT8                       ErasePolarity;\r
  EFI_FFS_FILE_HEADER         *FileHeader;\r
  EFI_PEI_FV_HANDLE           VolumeHandle;\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
    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
}\r
\r
\r
EFI_STATUS\r
EFIAPI \r
PeiFfsGetVolumeInfo (\r
  IN EFI_PEI_FV_HANDLE  VolumeHandle,\r
  OUT EFI_FV_INFO       *VolumeInfo\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Collect information of given Fv Volume.\r
\r
Arguments:\r
  VolumeHandle    - The handle to Fv Volume.\r
  VolumeInfo      - The pointer to volume information.\r
  \r
Returns:\r
  EFI_STATUS\r
  \r
--*/    \r
{\r
  EFI_FIRMWARE_VOLUME_HEADER             FwVolHeader;\r
  EFI_FIRMWARE_VOLUME_EXT_HEADER         *FwVolExHeaderInfo;\r
\r
  if (VolumeInfo == 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
    return EFI_INVALID_PARAMETER;\r
  }\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
\r