Revert "BaseTools/FMMT: Add a tool FMMT"

[mirror_edk2.git] / BaseTools / Source / C / FCE / BinaryParse.h

/** @file\r
\r
 The API to parse the binary.\r
\r
 Copyright (c) 2011-2019, Intel Corporation. All rights reserved.<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#ifndef _BINARY_PARSE_H_\r
#define _BINARY_PARSE_H_ 1\r
\r
#include <FvLib.h>\r
#include "Compress.h"\r
#include "Decompress.h"\r
#include "CommonLib.h"\r
#include "EfiUtilityMsgs.h"\r
#include "FirmwareVolumeBufferLib.h"\r
#include "OsPath.h"\r
#include "ParseGuidedSectionTools.h"\r
#include "StringFuncs.h"\r
#include "ParseInf.h"\r
#include <Common/UefiBaseTypes.h>\r
#include <Common/UefiInternalFormRepresentation.h>\r
#include <Common/UefiCapsule.h>\r
#include <Common/PiFirmwareFile.h>\r
#include <Common/PiFirmwareVolume.h>\r
#include <Guid/PiFirmwareFileSystem.h>\r
#include <IndustryStandard/PeImage.h>\r
#include <Protocol/GuidedSectionExtraction.h>\r
\r
#ifdef __GNUC__\r
#define OS_SEP        '/'\r
#define OS_SEP_STR    "/"\r
#else\r
#define OS_SEP        '\\'\r
#define OS_SEP_STR    "\\"\r
#endif\r
\r
#if defined(_MSC_VER) && _MSC_VER < 1900\r
#define snprintf _snprintf\r
#endif\r
\r
#define TEMP_DIR_NAME                  "Temp"\r
#define MAX_FILENAME_LEN               200\r
#define MAX_MATCH_GUID_NUM             100\r
#define MAX_EFI_IN_FFS_NUM             100\r
\r
typedef struct {\r
  VOID       *Fd;\r
  UINT32     FdSize;\r
  UINTN      EfiVariableAddr;\r
  UINTN      Length[MAX_EFI_IN_FFS_NUM];\r
  VOID      *FfsArray[MAX_EFI_IN_FFS_NUM];\r
  VOID      *StorageFfsInBfv;\r
  VOID      *NvStoreDatabase;\r
  BOOLEAN   ExistNvStoreDatabase;\r
} G_EFI_FD_INFO;\r
\r
///\r
///Define the structure for th sections\r
///\r
typedef struct {\r
  UINTN      BufferBase;\r
  UINTN      UncompressedBuffer[MAX_EFI_IN_FFS_NUM];\r
  UINTN      Length;\r
  UINT8      UnCompressIndex;\r
} EFI_SECTION_STRUCT;\r
\r
// {d0bc7cb4-6a47-495f-aa11-710746da06a2}\r
#define EFI_VFR_ATTRACT_GUID \\r
{ 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } }\r
\r
// {8913C5E0-33F6-4d86-9BF1-43EF89FC0666}\r
#define EFI_UNI_STR_ATTRACT_GUID \\r
{ 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }\r
\r
// {FFF12B8D-7696-4C8B-A985-2747075B4F50}\r
#define EFI_SYSTEM_NVDATA_FV_GUID  \\r
{ 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}\r
\r
/**\r
  Parses FFS Sections, and remove the FFS headers. Tis function olny handle one efi in this FFS.\r
\r
  @param  SectionBuffer     The section base address\r
  @param  BufferLength      The length of FFS.\r
  @param  EfiBufferHeader   The structure dual pointer to the efi informations\r
\r
  @retval  EFI_SUCCESS      The application exited normally.\r
  @retval  EFI_ABORTED       An error occurred.\r
\r
**/\r
EFI_STATUS\r
ParseSection (\r
  IN      BOOLEAN              IsFfsOrEfi,\r
  IN OUT  UINT8                *SectionBuffer,\r
  IN      UINT32               BufferLength,\r
  IN OUT  EFI_SECTION_STRUCT   **EfiBufferHeader\r
  );\r
\r
/**\r
  Search the VfrBin Base address.\r
\r
  According the known GUID gVfrArrayAttractGuid to get the base address from FFS.\r
\r
  @param Fv                    the Pointer to the FFS\r
  @param EfiAddr               the Pointer to the EFI in FFS\r
  @param Length                the length of Fv\r
  @param Offset                the Pointer to the Addr (Offset)\r
  @param NumOfMachingOffset    the number of Addr (Offset)\r
\r
  @retval EFI_SUCCESS          Get the address successfully.\r
**/\r
EFI_STATUS\r
SearchVfrBinInFFS (\r
   IN  VOID      *Fv,\r
   IN  VOID      *EfiAddr,\r
   IN  UINTN     Length,\r
   OUT UINTN    **Offset,\r
   OUT UINT8     *NumOfMachingOffset\r
  );\r
\r
/**\r
  Search the UniBin Base address.\r
\r
  According the known GUID gUniStrArrayAttractGuid to get the base address from FFS.\r
\r
  @param Fv                    the Pointer to the FFS\r
  @param EfiAddr               the Pointer to the EFI in FFS\r
  @param Length                the length of Fv\r
  @param Offset                the Pointer to the Addr (Offset)\r
\r
  @retval Base address         Get the address successfully.\r
**/\r
EFI_STATUS\r
SearchUniBinInFFS (\r
   IN VOID      *Fv,\r
   IN  VOID     *EfiAddr,\r
   IN  UINTN    Length,\r
   OUT UINTN    **Offset\r
  );\r
\r
/**\r
  Read the file to memory.\r
\r
  @param   InputFile        The file that contains the FV image.\r
  @param   Size             The size of the file.\r
\r
  @retval The pointer to the begining position of memory.\r
**/\r
VOID *\r
ReadFileToMemory (\r
  IN CHAR8      *FileName,\r
  OUT UINT32    *Size\r
  );\r
\r
/**\r
  Search the EFI variables address in Fd.\r
\r
  Open and read the *.fd to the memory, initialize the global structure.\r
  Update the EFI variables addr and the begining position of memory.\r
\r
  @retval EFI_SUCCESS          Get the address successfully.\r
**/\r
EFI_STATUS\r
GetEfiVariablesAddr (\r
  BOOLEAN UqiIsSet\r
  );\r
\r
/**\r
  Pick up the FFS which includes IFR section.\r
\r
  Parse all FFS extracted by BfmLib, and save all which includes IFR\r
  Binary to gEfiFdInfo structure.\r
\r
  @retval EFI_SUCCESS          Get the address successfully.\r
  @retval EFI_BUFFER_TOO_SMALL Memory can't be allocated.\r
  @retval EFI_ABORTED          Read FFS Failed.\r
**/\r
EFI_STATUS\r
FindFileInFolder (\r
  IN   CHAR8    *FolderName,\r
  OUT  BOOLEAN  *ExistStorageInBfv,\r
  OUT  BOOLEAN  *SizeOptimized\r
);\r
\r
#endif\r
\r