BaseTools: Fix various typos

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

/** @file\r
\r
 The API to create 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
\r
#ifndef _BINARY_CREATE_H_\r
#define _BINARY_CREATE_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
//1AE42876-008F-4161-B2B7-1C0D15C5EF43\r
#define EFI_FFS_BFV_FOR_MULTIPLATFORM_GUID \\r
  { 0x1ae42876, 0x008f, 0x4161, { 0xb2, 0xb7, 0x1c, 0xd, 0x15, 0xc5, 0xef, 0x43 }}\r
\r
extern EFI_GUID gEfiFfsBfvForMultiPlatformGuid;\r
\r
// {003E7B41-98A2-4BE2-B27A-6C30C7655225}\r
#define EFI_FFS_BFV_FOR_MULTIPLATFORM_GUID2 \\r
  { 0x3e7b41, 0x98a2, 0x4be2, { 0xb2, 0x7a, 0x6c, 0x30, 0xc7, 0x65, 0x52, 0x25 }}\r
\r
extern EFI_GUID gEfiFfsBfvForMultiPlatformGuid2;\r
\r
typedef UINT64 SKU_ID;\r
\r
typedef struct {\r
  UINT32 Offset:24;\r
  UINT32 Value:8;\r
} PCD_DATA_DELTA;\r
\r
typedef struct {\r
  SKU_ID SkuId;\r
  UINT16 DefaultId;\r
  UINT8  Reserved[6];\r
} PCD_DEFAULT_INFO;\r
\r
typedef struct {\r
  //\r
  // Full size, it must be at 8 byte alignment.\r
  //\r
  UINT32 DataSize;\r
  //\r
  // HeaderSize includes HeaderSize fields and DefaultInfo arrays\r
  //\r
  UINT32 HeaderSize;\r
  //\r
  // DefaultInfo arrays those have the same default setting.\r
  //\r
  PCD_DEFAULT_INFO DefaultInfo[1];\r
  //\r
  // Default data is stored as variable storage or the array of DATA_DELTA.\r
  //\r
} PCD_DEFAULT_DATA;\r
\r
#define PCD_NV_STORE_DEFAULT_BUFFER_SIGNATURE SIGNATURE_32('N', 'S', 'D', 'B')\r
\r
typedef struct {\r
  //\r
  // PCD_NV_STORE_DEFAULT_BUFFER_SIGNATURE\r
  //\r
  UINT32    Signature;\r
  //\r
  // Length of the taken default buffer\r
  //\r
  UINT32    Length;\r
  //\r
  // Length of the total reserved buffer\r
  //\r
  UINT32    MaxLength;\r
  //\r
  // Reserved for 8 byte alignment\r
  //\r
  UINT32    Reserved;\r
  // one or more PCD_DEFAULT_DATA\r
} PCD_NV_STORE_DEFAULT_BUFFER_HEADER;\r
\r
//\r
// NvStoreDefaultValueBuffer layout:\r
// +-------------------------------------+\r
// | PCD_NV_STORE_DEFAULT_BUFFER_HEADER  |\r
// +-------------------------------------+\r
// | PCD_DEFAULT_DATA (DEFAULT, Standard)|\r
// +-------------------------------------+\r
// | PCD_DATA_DELTA   (DEFAULT, Standard)|\r
// +-------------------------------------+\r
// | ......                              |\r
// +-------------------------------------+\r
// | PCD_DEFAULT_DATA (SKU A, Standard)  |\r
// +-------------------------------------+\r
// | PCD_DATA_DELTA   (SKU A, Standard)  |\r
// +-------------------------------------+\r
// | ......                              |\r
// +-------------------------------------+\r
//\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT16 Offset;\r
  UINT8  Value;\r
} DATA_DELTA;\r
\r
#pragma pack()\r
\r
/**\r
  Create the Ras section in FFS\r
\r
  @param[in]   InputFilePath   The input file path and name.\r
  @param[in]   OutputFilePath  The output file path and name.\r
\r
  @retval EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
CreateRawSection (\r
  IN CHAR8*     InputFilePath,\r
  IN CHAR8*     OutputFilePath\r
  );\r
\r
/**\r
  Create the Ras type of FFS\r
\r
  @param[in]   InputFilePath   .efi file, it's optional unless process PE/TE section.\r
  @param[in]   OutputFilePath  .te or .pe file\r
\r
  @retval EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
CreateRawFfs (\r
  IN CHAR8**    InputFilePaths,\r
  IN CHAR8*     OutputFilePath,\r
  IN BOOLEAN    SizeOptimized\r
  );\r
\r
#endif\r
\r