UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / StandaloneMmPkg / Include / Library / FvLib.h

/** @file\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _FV_LIB_H_\r
#define _FV_LIB_H_\r
\r
#include <Uefi.h>\r
#include <Pi/PiFirmwareVolume.h>\r
#include <Pi/PiFirmwareFile.h>\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
  @param  SearchType  Filter to find only files of this type.\r
                      Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
  @param  FwVolHeader Pointer to the FV header of the volume to search.\r
                      This parameter must point to a valid FFS volume.\r
  @param  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
  @retval EFI_NOT_FOUND  No files matching the search criteria were found\r
  @retval EFI_SUCCESS\r
**/\r
EFI_STATUS\r
EFIAPI\r
FfsFindNextFile (\r
  IN EFI_FV_FILETYPE             SearchType,\r
  IN EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader,\r
  IN OUT EFI_FFS_FILE_HEADER     **FileHeader\r
  );\r
\r
/**\r
  Given the input file pointer, search for the next matching section in the\r
  FFS volume.\r
\r
  @param  SearchType    Filter to find only sections of this type.\r
  @param  FfsFileHeader Pointer to the current file to search.\r
  @param  SectionHeader Pointer to the Section matching SectionType in FfsFileHeader.\r
                        NULL if section not found\r
\r
  @retval  EFI_NOT_FOUND  No files matching the search criteria were found\r
  @retval  EFI_SUCCESS\r
**/\r
EFI_STATUS\r
EFIAPI\r
FfsFindSection (\r
  IN EFI_SECTION_TYPE               SectionType,\r
  IN EFI_FFS_FILE_HEADER            *FfsFileHeader,\r
  IN OUT EFI_COMMON_SECTION_HEADER  **SectionHeader\r
  );\r
\r
/**\r
  Locates a section within a series of sections\r
  with the specified section type.\r
\r
  @param[in]   Sections        The sections to search\r
  @param[in]   SizeOfSections  Total size of all sections\r
  @param[in]   SectionType     The section type to locate\r
  @param[out]  FoundSection    The FFS section if found\r
\r
  @retval EFI_SUCCESS           The file and section was found\r
  @retval EFI_NOT_FOUND         The file and section was not found\r
  @retval EFI_VOLUME_CORRUPTED  The firmware volume was corrupted\r
**/\r
EFI_STATUS\r
EFIAPI\r
FindFfsSectionInSections (\r
  IN  VOID                       *Sections,\r
  IN  UINTN                      SizeOfSections,\r
  IN  EFI_SECTION_TYPE           SectionType,\r
  OUT EFI_COMMON_SECTION_HEADER  **FoundSection\r
  );\r
\r
/**\r
  Given the input file pointer, search for the next matching section in the\r
  FFS volume.\r
\r
  @param  SearchType      Filter to find only sections of this type.\r
  @param  FfsFileHeader   Pointer to the current file to search.\r
  @param  SectionData     Pointer to the Section matching SectionType in FfsFileHeader.\r
                          NULL if section not found\r
  @param  SectionDataSize The size of SectionData\r
\r
  @retval  EFI_NOT_FOUND  No files matching the search criteria were found\r
  @retval  EFI_SUCCESS\r
**/\r
EFI_STATUS\r
EFIAPI\r
FfsFindSectionData (\r
  IN EFI_SECTION_TYPE     SectionType,\r
  IN EFI_FFS_FILE_HEADER  *FfsFileHeader,\r
  OUT VOID                **SectionData,\r
  OUT UINTN               *SectionDataSize\r
  );\r
\r
#endif\r