[mirror_edk2.git] / BaseTools / Source / C / GenFv / GenFvInternalLib.h

/** @file\r
This file contains describes the public interfaces to the GenFvImage Library.\r
The basic purpose of the library is to create Firmware Volume images.\r
\r
Copyright (c) 2004 - 2018, 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
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
**/\r
\r
#ifndef _EFI_GEN_FV_INTERNAL_LIB_H\r
#define _EFI_GEN_FV_INTERNAL_LIB_H\r
\r
//\r
// Include files\r
//\r
#include <stdlib.h>\r
\r
#include <Common/UefiBaseTypes.h>\r
#include <Common/UefiCapsule.h>\r
\r
#include <Common/PiFirmwareFile.h>\r
#include <Common/PiFirmwareVolume.h>\r
#include <Guid/PiFirmwareFileSystem.h>\r
#include <IndustryStandard/PeImage.h>\r
\r
#include "CommonLib.h"\r
#include "ParseInf.h"\r
#include "EfiUtilityMsgs.h"\r
\r
//\r
// Different file separater for Linux and Windows\r
//\r
#define FILE_SEP_CHAR '/'\r
\r
//\r
// The maximum number of Pad file guid entries.\r
//\r
#define MAX_NUMBER_OF_PAD_FILE_GUIDS    1024\r
\r
//\r
// The maximum number of block map entries supported by the library\r
//\r
#define MAX_NUMBER_OF_FV_BLOCKS         100\r
\r
//\r
// The maximum number of files in the FV supported by the library\r
//\r
#define MAX_NUMBER_OF_FILES_IN_FV       1000\r
#define MAX_NUMBER_OF_FILES_IN_CAP      1000\r
#define EFI_FFS_FILE_HEADER_ALIGNMENT   8\r
//\r
// INF file strings\r
//\r
#define OPTIONS_SECTION_STRING                "[options]"\r
#define ATTRIBUTES_SECTION_STRING             "[attributes]"\r
#define FILES_SECTION_STRING                  "[files]"\r
#define FV_BASE_ADDRESS_STRING                "[FV_BASE_ADDRESS]"\r
\r
//\r
// Options section\r
//\r
#define EFI_FV_BASE_ADDRESS_STRING        "EFI_BASE_ADDRESS"\r
#define EFI_FV_FILE_NAME_STRING           "EFI_FILE_NAME"\r
#define EFI_NUM_BLOCKS_STRING             "EFI_NUM_BLOCKS"\r
#define EFI_BLOCK_SIZE_STRING             "EFI_BLOCK_SIZE"\r
#define EFI_GUID_STRING                   "EFI_GUID"\r
#define EFI_FV_FILESYSTEMGUID_STRING      "EFI_FV_GUID"\r
#define EFI_FV_NAMEGUID_STRING            "EFI_FVNAME_GUID"\r
#define EFI_CAPSULE_GUID_STRING           "EFI_CAPSULE_GUID"\r
#define EFI_CAPSULE_HEADER_SIZE_STRING    "EFI_CAPSULE_HEADER_SIZE"\r
#define EFI_CAPSULE_FLAGS_STRING          "EFI_CAPSULE_FLAGS"\r
#define EFI_OEM_CAPSULE_FLAGS_STRING      "EFI_OEM_CAPSULE_FLAGS"\r
#define EFI_CAPSULE_VERSION_STRING        "EFI_CAPSULE_VERSION"\r
\r
#define EFI_FV_TOTAL_SIZE_STRING    "EFI_FV_TOTAL_SIZE"\r
#define EFI_FV_TAKEN_SIZE_STRING    "EFI_FV_TAKEN_SIZE"\r
#define EFI_FV_SPACE_SIZE_STRING    "EFI_FV_SPACE_SIZE"\r
\r
//\r
// Attributes section\r
//\r
#define EFI_FVB2_READ_DISABLED_CAP_STRING  "EFI_READ_DISABLED_CAP"\r
#define EFI_FVB2_READ_ENABLED_CAP_STRING   "EFI_READ_ENABLED_CAP"\r
#define EFI_FVB2_READ_STATUS_STRING        "EFI_READ_STATUS"\r
\r
#define EFI_FVB2_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"\r
#define EFI_FVB2_WRITE_ENABLED_CAP_STRING  "EFI_WRITE_ENABLED_CAP"\r
#define EFI_FVB2_WRITE_STATUS_STRING       "EFI_WRITE_STATUS"\r
\r
#define EFI_FVB2_LOCK_CAP_STRING           "EFI_LOCK_CAP"\r
#define EFI_FVB2_LOCK_STATUS_STRING        "EFI_LOCK_STATUS"\r
\r
#define EFI_FVB2_STICKY_WRITE_STRING       "EFI_STICKY_WRITE"\r
#define EFI_FVB2_MEMORY_MAPPED_STRING      "EFI_MEMORY_MAPPED"\r
#define EFI_FVB2_ERASE_POLARITY_STRING     "EFI_ERASE_POLARITY"\r
\r
#define EFI_FVB2_READ_LOCK_CAP_STRING      "EFI_READ_LOCK_CAP"\r
#define EFI_FVB2_READ_LOCK_STATUS_STRING   "EFI_READ_LOCK_STATUS"\r
#define EFI_FVB2_WRITE_LOCK_CAP_STRING     "EFI_WRITE_LOCK_CAP"\r
#define EFI_FVB2_WRITE_LOCK_STATUS_STRING  "EFI_WRITE_LOCK_STATUS"\r
\r
#define EFI_FVB2_ALIGNMENT_1_STRING       "EFI_FVB2_ALIGNMENT_1"\r
#define EFI_FVB2_ALIGNMENT_2_STRING       "EFI_FVB2_ALIGNMENT_2"\r
#define EFI_FVB2_ALIGNMENT_4_STRING       "EFI_FVB2_ALIGNMENT_4"\r
#define EFI_FVB2_ALIGNMENT_8_STRING       "EFI_FVB2_ALIGNMENT_8"\r
#define EFI_FVB2_ALIGNMENT_16_STRING      "EFI_FVB2_ALIGNMENT_16"\r
#define EFI_FVB2_ALIGNMENT_32_STRING      "EFI_FVB2_ALIGNMENT_32"\r
#define EFI_FVB2_ALIGNMENT_64_STRING      "EFI_FVB2_ALIGNMENT_64"\r
#define EFI_FVB2_ALIGNMENT_128_STRING     "EFI_FVB2_ALIGNMENT_128"\r
#define EFI_FVB2_ALIGNMENT_256_STRING     "EFI_FVB2_ALIGNMENT_256"\r
#define EFI_FVB2_ALIGNMENT_512_STRING     "EFI_FVB2_ALIGNMENT_512"\r
#define EFI_FVB2_ALIGNMENT_1K_STRING      "EFI_FVB2_ALIGNMENT_1K"\r
#define EFI_FVB2_ALIGNMENT_2K_STRING      "EFI_FVB2_ALIGNMENT_2K"\r
#define EFI_FVB2_ALIGNMENT_4K_STRING      "EFI_FVB2_ALIGNMENT_4K"\r
#define EFI_FVB2_ALIGNMENT_8K_STRING      "EFI_FVB2_ALIGNMENT_8K"\r
#define EFI_FVB2_ALIGNMENT_16K_STRING     "EFI_FVB2_ALIGNMENT_16K"\r
#define EFI_FVB2_ALIGNMENT_32K_STRING     "EFI_FVB2_ALIGNMENT_32K"\r
#define EFI_FVB2_ALIGNMENT_64K_STRING     "EFI_FVB2_ALIGNMENT_64K"\r
#define EFI_FVB2_ALIGNMENT_128K_STRING    "EFI_FVB2_ALIGNMENT_128K"\r
#define EFI_FVB2_ALIGNMENT_256K_STRING    "EFI_FVB2_ALIGNMENT_256K"\r
#define EFI_FVB2_ALIGNMENT_512K_STRING    "EFI_FVB2_ALIGNMENT_512K"\r
#define EFI_FVB2_ALIGNMENT_1M_STRING      "EFI_FVB2_ALIGNMENT_1M"\r
#define EFI_FVB2_ALIGNMENT_2M_STRING      "EFI_FVB2_ALIGNMENT_2M"\r
#define EFI_FVB2_ALIGNMENT_4M_STRING      "EFI_FVB2_ALIGNMENT_4M"\r
#define EFI_FVB2_ALIGNMENT_8M_STRING      "EFI_FVB2_ALIGNMENT_8M"\r
#define EFI_FVB2_ALIGNMENT_16M_STRING     "EFI_FVB2_ALIGNMENT_16M"\r
#define EFI_FVB2_ALIGNMENT_32M_STRING     "EFI_FVB2_ALIGNMENT_32M"\r
#define EFI_FVB2_ALIGNMENT_64M_STRING     "EFI_FVB2_ALIGNMENT_64M"\r
#define EFI_FVB2_ALIGNMENT_128M_STRING    "EFI_FVB2_ALIGNMENT_128M"\r
#define EFI_FVB2_ALIGNMENT_256M_STRING    "EFI_FVB2_ALIGNMENT_256M"\r
#define EFI_FVB2_ALIGNMENT_512M_STRING    "EFI_FVB2_ALIGNMENT_512M"\r
#define EFI_FVB2_ALIGNMENT_1G_STRING      "EFI_FVB2_ALIGNMENT_1G"\r
#define EFI_FVB2_ALIGNMENT_2G_STRING      "EFI_FVB2_ALIGNMENT_2G"\r
\r
#define EFI_FV_WEAK_ALIGNMENT_STRING      "EFI_WEAK_ALIGNMENT"\r
\r
//\r
// File sections\r
//\r
#define EFI_FILE_NAME_STRING      "EFI_FILE_NAME"\r
\r
#define ONE_STRING                "1"\r
#define ZERO_STRING               "0"\r
#define TRUE_STRING               "TRUE"\r
#define FALSE_STRING              "FALSE"\r
#define NULL_STRING               "NULL"\r
\r
//\r
//\r
//\r
#define EFI_FV_EXT_HEADER_FILE_NAME     "EFI_FV_EXT_HEADER_FILE_NAME"\r
\r
\r
//\r
// VTF (Firmware Volume Top File) signatures\r
//\r
#define IA32_X64_VTF_SIGNATURE_OFFSET    0x14\r
#define IA32_X64_VTF0_SIGNATURE SIGNATURE_32('V','T','F',0)\r
\r
//\r
// Defines to calculate the offset for PEI CORE entry points\r
//\r
#define IA32_PEI_CORE_ENTRY_OFFSET    0x20\r
\r
//\r
// Defines to calculate the offset for IA32 SEC CORE entry point\r
//\r
#define IA32_SEC_CORE_ENTRY_OFFSET     0xD\r
\r
//\r
// Symbol file definitions, current max size if 512K\r
//\r
#define SYMBOL_FILE_SIZE              0x80000\r
\r
#define FV_IMAGES_TOP_ADDRESS         0x100000000ULL\r
\r
//\r
// Following definition is used for FIT in IPF\r
//\r
#define COMP_TYPE_FIT_PEICORE 0x10\r
#define COMP_TYPE_FIT_UNUSED  0x7F\r
\r
#define FIT_TYPE_MASK         0x7F\r
#define CHECKSUM_BIT_MASK     0x80\r
\r
//\r
// Private data types\r
//\r
//\r
// Component information\r
//\r
typedef struct {\r
  UINTN Size;\r
  CHAR8 ComponentName[MAX_LONG_FILE_PATH];\r
} COMPONENT_INFO;\r
\r
//\r
// FV and capsule information holder\r
//\r
typedef struct {\r
  BOOLEAN                 BaseAddressSet;\r
  EFI_PHYSICAL_ADDRESS    BaseAddress;\r
  EFI_GUID                FvFileSystemGuid;\r
  BOOLEAN                 FvFileSystemGuidSet;\r
  EFI_GUID                FvNameGuid;\r
  BOOLEAN                 FvNameGuidSet;\r
  CHAR8                   FvExtHeaderFile[MAX_LONG_FILE_PATH];\r
  UINTN                   Size;\r
  EFI_FVB_ATTRIBUTES_2    FvAttributes;\r
  CHAR8                   FvName[MAX_LONG_FILE_PATH];\r
  EFI_FV_BLOCK_MAP_ENTRY  FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];\r
  CHAR8                   FvFiles[MAX_NUMBER_OF_FILES_IN_FV][MAX_LONG_FILE_PATH];\r
  UINT32                  SizeofFvFiles[MAX_NUMBER_OF_FILES_IN_FV];\r
  BOOLEAN                 IsPiFvImage;\r
  INT8                    ForceRebase;\r
} FV_INFO;\r
\r
typedef struct {\r
  EFI_GUID                CapGuid;\r
  UINT32                  HeaderSize;\r
  UINT32                  Flags;\r
  CHAR8                   CapName[MAX_LONG_FILE_PATH];\r
  CHAR8                   CapFiles[MAX_NUMBER_OF_FILES_IN_CAP][MAX_LONG_FILE_PATH];\r
} CAP_INFO;\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT64  CompAddress;\r
  UINT32  CompSize;\r
  UINT16  CompVersion;\r
  UINT8   CvAndType;\r
  UINT8   CheckSum;\r
} FIT_TABLE;\r
\r
#pragma pack()\r
\r
#define FV_DEFAULT_ATTRIBUTE  0x0004FEFF\r
extern FV_INFO    mFvDataInfo;\r
extern CAP_INFO   mCapDataInfo;\r
extern EFI_GUID   mEfiFirmwareFileSystem2Guid;\r
extern EFI_GUID   mEfiFirmwareFileSystem3Guid;\r
extern UINT32     mFvTotalSize;\r
extern UINT32     mFvTakenSize;\r
\r
extern EFI_PHYSICAL_ADDRESS mFvBaseAddress[];\r
extern UINT32               mFvBaseAddressNumber;\r
//\r
// Local function prototypes\r
//\r
EFI_STATUS\r
ParseFvInf (\r
  IN  MEMORY_FILE  *InfFile,\r
  OUT FV_INFO      *FvInfo\r
  )\r
;\r
\r
EFI_STATUS\r
UpdatePeiCoreEntryInFit (\r
  IN FIT_TABLE     *FitTablePtr,\r
  IN UINT64        PeiCorePhysicalAddress\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from\r
  Sec to Pei Core\r
\r
Arguments:\r
\r
  FitTablePtr             - The pointer of FIT_TABLE.\r
  PeiCorePhysicalAddress  - The address of Pei Core entry.\r
\r
Returns:\r
\r
  EFI_SUCCESS             - The PEI_CORE FIT entry was updated successfully.\r
  EFI_NOT_FOUND           - Not found the PEI_CORE FIT entry.\r
\r
--*/\r
;\r
\r
VOID\r
UpdateFitCheckSum (\r
  IN FIT_TABLE   *FitTablePtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function is used to update the checksum for FIT.\r
\r
\r
Arguments:\r
\r
  FitTablePtr             - The pointer of FIT_TABLE.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
GetPe32Info (\r
  IN UINT8                  *Pe32,\r
  OUT UINT32                *EntryPoint,\r
  OUT UINT32                *BaseOfCode,\r
  OUT UINT16                *MachineType\r
  );\r
\r
EFI_STATUS\r
ParseCapInf (\r
  IN  MEMORY_FILE  *InfFile,\r
  OUT CAP_INFO     *CapInfo\r
  );\r
\r
EFI_STATUS\r
FindApResetVectorPosition (\r
  IN  MEMORY_FILE  *FvImage,\r
  OUT UINT8        **Pointer\r
  );\r
\r
EFI_STATUS\r
CalculateFvSize (\r
  FV_INFO *FvInfoPtr\r
  );\r
\r
EFI_STATUS\r
FfsRebase (\r
  IN OUT  FV_INFO               *FvInfo,\r
  IN      CHAR8                 *FileName,\r
  IN OUT  EFI_FFS_FILE_HEADER   *FfsFile,\r
  IN      UINTN                 XipOffset,\r
  IN      FILE                  *FvMapFile\r
  );\r
\r
//\r
// Exported function prototypes\r
//\r
EFI_STATUS\r
GenerateCapImage (\r
  IN CHAR8                *InfFileImage,\r
  IN UINTN                InfFileSize,\r
  IN CHAR8                *CapFileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This is the main function which will be called from application to\r
  generate UEFI Capsule image.\r
\r
Arguments:\r
\r
  InfFileImage   Buffer containing the INF file contents.\r
  InfFileSize    Size of the contents of the InfFileImage buffer.\r
  CapFileName    Requested name for the Cap file.\r
\r
Returns:\r
\r
  EFI_SUCCESS             Function completed successfully.\r
  EFI_OUT_OF_RESOURCES    Could not allocate required resources.\r
  EFI_ABORTED             Error encountered.\r
  EFI_INVALID_PARAMETER   A required parameter was NULL.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
GenerateFvImage (\r
  IN CHAR8                *InfFileImage,\r
  IN UINTN                InfFileSize,\r
  IN CHAR8                *FvFileName,\r
  IN CHAR8                *MapFileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This is the main function which will be called from application to\r
  generate Firmware Image conforms to PI spec.\r
\r
Arguments:\r
\r
  InfFileImage   Buffer containing the INF file contents.\r
  InfFileSize    Size of the contents of the InfFileImage buffer.\r
  FvFileName     Requested name for the FV file.\r
  MapFileName    Fv map file to log fv driver information.\r
\r
Returns:\r
\r
  EFI_SUCCESS             Function completed successfully.\r
  EFI_OUT_OF_RESOURCES    Could not allocate required resources.\r
  EFI_ABORTED             Error encountered.\r
  EFI_INVALID_PARAMETER   A required parameter was NULL.\r
\r
--*/\r
;\r
\r
#endif\r
Commit	Line	Data
30fdf114	1	/** @file\r
97fa0ee9 YL	2	This file contains describes the public interfaces to the GenFvImage Library.\r
97fa0ee9 YL	3	The basic purpose of the library is to create Firmware Volume images.\r
f7496d71 LG	4	\r
	5	Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
30fdf114	13	\r
30fdf114 LG	14	**/\r
	15	\r
	16	#ifndef _EFI_GEN_FV_INTERNAL_LIB_H\r
	17	#define _EFI_GEN_FV_INTERNAL_LIB_H\r
	18	\r
	19	//\r
	20	// Include files\r
	21	//\r
	22	#include <stdlib.h>\r
	23	\r
	24	#include <Common/UefiBaseTypes.h>\r
	25	#include <Common/UefiCapsule.h>\r
	26	\r
	27	#include <Common/PiFirmwareFile.h>\r
	28	#include <Common/PiFirmwareVolume.h>\r
	29	#include <Guid/PiFirmwareFileSystem.h>\r
	30	#include <IndustryStandard/PeImage.h>\r
	31	\r
	32	#include "CommonLib.h"\r
	33	#include "ParseInf.h"\r
	34	#include "EfiUtilityMsgs.h"\r
	35	\r
	36	//\r
	37	// Different file separater for Linux and Windows\r
	38	//\r
	39	#define FILE_SEP_CHAR '/'\r
	40	\r
	41	//\r
	42	// The maximum number of Pad file guid entries.\r
	43	//\r
	44	#define MAX_NUMBER_OF_PAD_FILE_GUIDS 1024\r
	45	\r
	46	//\r
	47	// The maximum number of block map entries supported by the library\r
	48	//\r
	49	#define MAX_NUMBER_OF_FV_BLOCKS 100\r
	50	\r
	51	//\r
	52	// The maximum number of files in the FV supported by the library\r
	53	//\r
	54	#define MAX_NUMBER_OF_FILES_IN_FV 1000\r
	55	#define MAX_NUMBER_OF_FILES_IN_CAP 1000\r
	56	#define EFI_FFS_FILE_HEADER_ALIGNMENT 8\r
30fdf114 LG	57	//\r
	58	// INF file strings\r
	59	//\r
b303ea72 LG	60	#define OPTIONS_SECTION_STRING "[options]"\r
	61	#define ATTRIBUTES_SECTION_STRING "[attributes]"\r
	62	#define FILES_SECTION_STRING "[files]"\r
52302d4d	63	#define FV_BASE_ADDRESS_STRING "[FV_BASE_ADDRESS]"\r
30fdf114 LG	64	\r
	65	//\r
	66	// Options section\r
	67	//\r
	68	#define EFI_FV_BASE_ADDRESS_STRING "EFI_BASE_ADDRESS"\r
	69	#define EFI_FV_FILE_NAME_STRING "EFI_FILE_NAME"\r
	70	#define EFI_NUM_BLOCKS_STRING "EFI_NUM_BLOCKS"\r
	71	#define EFI_BLOCK_SIZE_STRING "EFI_BLOCK_SIZE"\r
	72	#define EFI_GUID_STRING "EFI_GUID"\r
	73	#define EFI_FV_FILESYSTEMGUID_STRING "EFI_FV_GUID"\r
f7496d71	74	#define EFI_FV_NAMEGUID_STRING "EFI_FVNAME_GUID"\r
30fdf114 LG	75	#define EFI_CAPSULE_GUID_STRING "EFI_CAPSULE_GUID"\r
	76	#define EFI_CAPSULE_HEADER_SIZE_STRING "EFI_CAPSULE_HEADER_SIZE"\r
	77	#define EFI_CAPSULE_FLAGS_STRING "EFI_CAPSULE_FLAGS"\r
e8a47801	78	#define EFI_OEM_CAPSULE_FLAGS_STRING "EFI_OEM_CAPSULE_FLAGS"\r
30fdf114	79	#define EFI_CAPSULE_VERSION_STRING "EFI_CAPSULE_VERSION"\r
30fdf114 LG	80	\r
	81	#define EFI_FV_TOTAL_SIZE_STRING "EFI_FV_TOTAL_SIZE"\r
	82	#define EFI_FV_TAKEN_SIZE_STRING "EFI_FV_TAKEN_SIZE"\r
	83	#define EFI_FV_SPACE_SIZE_STRING "EFI_FV_SPACE_SIZE"\r
	84	\r
	85	//\r
	86	// Attributes section\r
	87	//\r
	88	#define EFI_FVB2_READ_DISABLED_CAP_STRING "EFI_READ_DISABLED_CAP"\r
	89	#define EFI_FVB2_READ_ENABLED_CAP_STRING "EFI_READ_ENABLED_CAP"\r
	90	#define EFI_FVB2_READ_STATUS_STRING "EFI_READ_STATUS"\r
	91	\r
	92	#define EFI_FVB2_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"\r
	93	#define EFI_FVB2_WRITE_ENABLED_CAP_STRING "EFI_WRITE_ENABLED_CAP"\r
	94	#define EFI_FVB2_WRITE_STATUS_STRING "EFI_WRITE_STATUS"\r
	95	\r
	96	#define EFI_FVB2_LOCK_CAP_STRING "EFI_LOCK_CAP"\r
	97	#define EFI_FVB2_LOCK_STATUS_STRING "EFI_LOCK_STATUS"\r
	98	\r
	99	#define EFI_FVB2_STICKY_WRITE_STRING "EFI_STICKY_WRITE"\r
	100	#define EFI_FVB2_MEMORY_MAPPED_STRING "EFI_MEMORY_MAPPED"\r
	101	#define EFI_FVB2_ERASE_POLARITY_STRING "EFI_ERASE_POLARITY"\r
	102	\r
	103	#define EFI_FVB2_READ_LOCK_CAP_STRING "EFI_READ_LOCK_CAP"\r
	104	#define EFI_FVB2_READ_LOCK_STATUS_STRING "EFI_READ_LOCK_STATUS"\r
	105	#define EFI_FVB2_WRITE_LOCK_CAP_STRING "EFI_WRITE_LOCK_CAP"\r
	106	#define EFI_FVB2_WRITE_LOCK_STATUS_STRING "EFI_WRITE_LOCK_STATUS"\r
	107	\r
f7496d71 LG	108	#define EFI_FVB2_ALIGNMENT_1_STRING "EFI_FVB2_ALIGNMENT_1"\r
	109	#define EFI_FVB2_ALIGNMENT_2_STRING "EFI_FVB2_ALIGNMENT_2"\r
	110	#define EFI_FVB2_ALIGNMENT_4_STRING "EFI_FVB2_ALIGNMENT_4"\r
	111	#define EFI_FVB2_ALIGNMENT_8_STRING "EFI_FVB2_ALIGNMENT_8"\r
	112	#define EFI_FVB2_ALIGNMENT_16_STRING "EFI_FVB2_ALIGNMENT_16"\r
	113	#define EFI_FVB2_ALIGNMENT_32_STRING "EFI_FVB2_ALIGNMENT_32"\r
	114	#define EFI_FVB2_ALIGNMENT_64_STRING "EFI_FVB2_ALIGNMENT_64"\r
	115	#define EFI_FVB2_ALIGNMENT_128_STRING "EFI_FVB2_ALIGNMENT_128"\r
	116	#define EFI_FVB2_ALIGNMENT_256_STRING "EFI_FVB2_ALIGNMENT_256"\r
	117	#define EFI_FVB2_ALIGNMENT_512_STRING "EFI_FVB2_ALIGNMENT_512"\r
	118	#define EFI_FVB2_ALIGNMENT_1K_STRING "EFI_FVB2_ALIGNMENT_1K"\r
	119	#define EFI_FVB2_ALIGNMENT_2K_STRING "EFI_FVB2_ALIGNMENT_2K"\r
	120	#define EFI_FVB2_ALIGNMENT_4K_STRING "EFI_FVB2_ALIGNMENT_4K"\r
	121	#define EFI_FVB2_ALIGNMENT_8K_STRING "EFI_FVB2_ALIGNMENT_8K"\r
	122	#define EFI_FVB2_ALIGNMENT_16K_STRING "EFI_FVB2_ALIGNMENT_16K"\r
	123	#define EFI_FVB2_ALIGNMENT_32K_STRING "EFI_FVB2_ALIGNMENT_32K"\r
	124	#define EFI_FVB2_ALIGNMENT_64K_STRING "EFI_FVB2_ALIGNMENT_64K"\r
30fdf114 LG	125	#define EFI_FVB2_ALIGNMENT_128K_STRING "EFI_FVB2_ALIGNMENT_128K"\r
30fdf114 LG	126	#define EFI_FVB2_ALIGNMENT_256K_STRING "EFI_FVB2_ALIGNMENT_256K"\r
2bcc713e	127	#define EFI_FVB2_ALIGNMENT_512K_STRING "EFI_FVB2_ALIGNMENT_512K"\r
f7496d71 LG	128	#define EFI_FVB2_ALIGNMENT_1M_STRING "EFI_FVB2_ALIGNMENT_1M"\r
	129	#define EFI_FVB2_ALIGNMENT_2M_STRING "EFI_FVB2_ALIGNMENT_2M"\r
	130	#define EFI_FVB2_ALIGNMENT_4M_STRING "EFI_FVB2_ALIGNMENT_4M"\r
	131	#define EFI_FVB2_ALIGNMENT_8M_STRING "EFI_FVB2_ALIGNMENT_8M"\r
	132	#define EFI_FVB2_ALIGNMENT_16M_STRING "EFI_FVB2_ALIGNMENT_16M"\r
	133	#define EFI_FVB2_ALIGNMENT_32M_STRING "EFI_FVB2_ALIGNMENT_32M"\r
	134	#define EFI_FVB2_ALIGNMENT_64M_STRING "EFI_FVB2_ALIGNMENT_64M"\r
30fdf114 LG	135	#define EFI_FVB2_ALIGNMENT_128M_STRING "EFI_FVB2_ALIGNMENT_128M"\r
	136	#define EFI_FVB2_ALIGNMENT_256M_STRING "EFI_FVB2_ALIGNMENT_256M"\r
	137	#define EFI_FVB2_ALIGNMENT_512M_STRING "EFI_FVB2_ALIGNMENT_512M"\r
f7496d71 LG	138	#define EFI_FVB2_ALIGNMENT_1G_STRING "EFI_FVB2_ALIGNMENT_1G"\r
f7496d71 LG	139	#define EFI_FVB2_ALIGNMENT_2G_STRING "EFI_FVB2_ALIGNMENT_2G"\r
30fdf114	140	\r
e8a47801 LG	141	#define EFI_FV_WEAK_ALIGNMENT_STRING "EFI_WEAK_ALIGNMENT"\r
e8a47801 LG	142	\r
30fdf114 LG	143	//\r
	144	// File sections\r
	145	//\r
	146	#define EFI_FILE_NAME_STRING "EFI_FILE_NAME"\r
	147	\r
	148	#define ONE_STRING "1"\r
	149	#define ZERO_STRING "0"\r
	150	#define TRUE_STRING "TRUE"\r
	151	#define FALSE_STRING "FALSE"\r
	152	#define NULL_STRING "NULL"\r
	153	\r
b303ea72 LG	154	//\r
	155	//\r
	156	//\r
	157	#define EFI_FV_EXT_HEADER_FILE_NAME "EFI_FV_EXT_HEADER_FILE_NAME"\r
	158	\r
	159	\r
30fdf114 LG	160	//\r
	161	// VTF (Firmware Volume Top File) signatures\r
	162	//\r
	163	#define IA32_X64_VTF_SIGNATURE_OFFSET 0x14\r
2bc3256c	164	#define IA32_X64_VTF0_SIGNATURE SIGNATURE_32('V','T','F',0)\r
30fdf114 LG	165	\r
	166	//\r
	167	// Defines to calculate the offset for PEI CORE entry points\r
	168	//\r
	169	#define IA32_PEI_CORE_ENTRY_OFFSET 0x20\r
	170	\r
	171	//\r
	172	// Defines to calculate the offset for IA32 SEC CORE entry point\r
	173	//\r
	174	#define IA32_SEC_CORE_ENTRY_OFFSET 0xD\r
	175	\r
30fdf114 LG	176	//\r
	177	// Symbol file definitions, current max size if 512K\r
	178	//\r
	179	#define SYMBOL_FILE_SIZE 0x80000\r
	180	\r
	181	#define FV_IMAGES_TOP_ADDRESS 0x100000000ULL\r
	182	\r
	183	//\r
	184	// Following definition is used for FIT in IPF\r
	185	//\r
	186	#define COMP_TYPE_FIT_PEICORE 0x10\r
	187	#define COMP_TYPE_FIT_UNUSED 0x7F\r
	188	\r
	189	#define FIT_TYPE_MASK 0x7F\r
	190	#define CHECKSUM_BIT_MASK 0x80\r
	191	\r
30fdf114 LG	192	//\r
	193	// Private data types\r
	194	//\r
	195	//\r
	196	// Component information\r
	197	//\r
	198	typedef struct {\r
	199	UINTN Size;\r
1be2ed90	200	CHAR8 ComponentName[MAX_LONG_FILE_PATH];\r
30fdf114 LG	201	} COMPONENT_INFO;\r
	202	\r
	203	//\r
	204	// FV and capsule information holder\r
	205	//\r
	206	typedef struct {\r
	207	BOOLEAN BaseAddressSet;\r
	208	EFI_PHYSICAL_ADDRESS BaseAddress;\r
30fdf114 LG	209	EFI_GUID FvFileSystemGuid;\r
	210	BOOLEAN FvFileSystemGuidSet;\r
	211	EFI_GUID FvNameGuid;\r
	212	BOOLEAN FvNameGuidSet;\r
1be2ed90	213	CHAR8 FvExtHeaderFile[MAX_LONG_FILE_PATH];\r
30fdf114	214	UINTN Size;\r
2bcc713e	215	EFI_FVB_ATTRIBUTES_2 FvAttributes;\r
1be2ed90	216	CHAR8 FvName[MAX_LONG_FILE_PATH];\r
30fdf114	217	EFI_FV_BLOCK_MAP_ENTRY FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];\r
1be2ed90	218	CHAR8 FvFiles[MAX_NUMBER_OF_FILES_IN_FV][MAX_LONG_FILE_PATH];\r
30fdf114 LG	219	UINT32 SizeofFvFiles[MAX_NUMBER_OF_FILES_IN_FV];\r
30fdf114 LG	220	BOOLEAN IsPiFvImage;\r
79b74a03	221	INT8 ForceRebase;\r
30fdf114 LG	222	} FV_INFO;\r
	223	\r
	224	typedef struct {\r
	225	EFI_GUID CapGuid;\r
	226	UINT32 HeaderSize;\r
	227	UINT32 Flags;\r
1be2ed90 HC	228	CHAR8 CapName[MAX_LONG_FILE_PATH];\r
1be2ed90 HC	229	CHAR8 CapFiles[MAX_NUMBER_OF_FILES_IN_CAP][MAX_LONG_FILE_PATH];\r
30fdf114 LG	230	} CAP_INFO;\r
	231	\r
	232	#pragma pack(1)\r
	233	\r
	234	typedef struct {\r
	235	UINT64 CompAddress;\r
	236	UINT32 CompSize;\r
	237	UINT16 CompVersion;\r
	238	UINT8 CvAndType;\r
	239	UINT8 CheckSum;\r
	240	} FIT_TABLE;\r
	241	\r
	242	#pragma pack()\r
	243	\r
	244	#define FV_DEFAULT_ATTRIBUTE 0x0004FEFF\r
	245	extern FV_INFO mFvDataInfo;\r
	246	extern CAP_INFO mCapDataInfo;\r
	247	extern EFI_GUID mEfiFirmwareFileSystem2Guid;\r
e8a47801	248	extern EFI_GUID mEfiFirmwareFileSystem3Guid;\r
30fdf114 LG	249	extern UINT32 mFvTotalSize;\r
30fdf114 LG	250	extern UINT32 mFvTakenSize;\r
52302d4d LG	251	\r
	252	extern EFI_PHYSICAL_ADDRESS mFvBaseAddress[];\r
	253	extern UINT32 mFvBaseAddressNumber;\r
30fdf114 LG	254	//\r
	255	// Local function prototypes\r
	256	//\r
	257	EFI_STATUS\r
	258	ParseFvInf (\r
	259	IN MEMORY_FILE *InfFile,\r
	260	OUT FV_INFO *FvInfo\r
	261	)\r
	262	;\r
	263	\r
	264	EFI_STATUS\r
	265	UpdatePeiCoreEntryInFit (\r
	266	IN FIT_TABLE *FitTablePtr,\r
	267	IN UINT64 PeiCorePhysicalAddress\r
	268	)\r
	269	/*++\r
	270	\r
	271	Routine Description:\r
	272	\r
	273	This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from\r
	274	Sec to Pei Core\r
	275	\r
	276	Arguments:\r
	277	\r
	278	FitTablePtr - The pointer of FIT_TABLE.\r
	279	PeiCorePhysicalAddress - The address of Pei Core entry.\r
	280	\r
	281	Returns:\r
	282	\r
	283	EFI_SUCCESS - The PEI_CORE FIT entry was updated successfully.\r
	284	EFI_NOT_FOUND - Not found the PEI_CORE FIT entry.\r
	285	\r
	286	--*/\r
	287	;\r
	288	\r
	289	VOID\r
	290	UpdateFitCheckSum (\r
	291	IN FIT_TABLE *FitTablePtr\r
	292	)\r
	293	/*++\r
	294	\r
	295	Routine Description:\r
	296	\r
	297	This function is used to update the checksum for FIT.\r
	298	\r
	299	\r
	300	Arguments:\r
	301	\r
	302	FitTablePtr - The pointer of FIT_TABLE.\r
	303	\r
	304	Returns:\r
	305	\r
	306	None.\r
	307	\r
	308	--*/\r
	309	;\r
	310	\r
	311	EFI_STATUS\r
	312	GetPe32Info (\r
	313	IN UINT8 *Pe32,\r
	314	OUT UINT32 *EntryPoint,\r
	315	OUT UINT32 *BaseOfCode,\r
	316	OUT UINT16 *MachineType\r
	317	);\r
318	\r
319	EFI_STATUS\r
320	ParseCapInf (\r
321	IN MEMORY_FILE *InfFile,\r
322	OUT CAP_INFO *CapInfo\r
323	);\r
324	\r
325	EFI_STATUS\r
326	FindApResetVectorPosition (\r
327	IN MEMORY_FILE *FvImage,\r
328	OUT UINT8 **Pointer\r
f7496d71	329	);\r
30fdf114 LG	330	\r
	331	EFI_STATUS\r
	332	CalculateFvSize (\r
	333	FV_INFO *FvInfoPtr\r
	334	);\r
	335	\r
	336	EFI_STATUS\r
f7496d71 LG	337	FfsRebase (\r
	338	IN OUT FV_INFO *FvInfo,\r
	339	IN CHAR8 *FileName,\r
30fdf114 LG	340	IN OUT EFI_FFS_FILE_HEADER *FfsFile,\r
	341	IN UINTN XipOffset,\r
	342	IN FILE *FvMapFile\r
	343	);\r
	344	\r
	345	//\r
	346	// Exported function prototypes\r
	347	//\r
	348	EFI_STATUS\r
	349	GenerateCapImage (\r
	350	IN CHAR8 *InfFileImage,\r
	351	IN UINTN InfFileSize,\r
	352	IN CHAR8 *CapFileName\r
	353	)\r
	354	/*++\r
	355	\r
	356	Routine Description:\r
	357	\r
f7496d71	358	This is the main function which will be called from application to\r
30fdf114 LG	359	generate UEFI Capsule image.\r
	360	\r
	361	Arguments:\r
	362	\r
	363	InfFileImage Buffer containing the INF file contents.\r
	364	InfFileSize Size of the contents of the InfFileImage buffer.\r
	365	CapFileName Requested name for the Cap file.\r
	366	\r
	367	Returns:\r
	368	\r
	369	EFI_SUCCESS Function completed successfully.\r
	370	EFI_OUT_OF_RESOURCES Could not allocate required resources.\r
	371	EFI_ABORTED Error encountered.\r
	372	EFI_INVALID_PARAMETER A required parameter was NULL.\r
	373	\r
	374	--*/\r
	375	;\r
	376	\r
	377	EFI_STATUS\r
	378	GenerateFvImage (\r
	379	IN CHAR8 *InfFileImage,\r
	380	IN UINTN InfFileSize,\r
f7496d71	381	IN CHAR8 *FvFileName,\r
30fdf114 LG	382	IN CHAR8 *MapFileName\r
	383	)\r
	384	/*++\r
	385	\r
	386	Routine Description:\r
	387	\r
f7496d71	388	This is the main function which will be called from application to\r
30fdf114 LG	389	generate Firmware Image conforms to PI spec.\r
	390	\r
	391	Arguments:\r
	392	\r
	393	InfFileImage Buffer containing the INF file contents.\r
	394	InfFileSize Size of the contents of the InfFileImage buffer.\r
	395	FvFileName Requested name for the FV file.\r
	396	MapFileName Fv map file to log fv driver information.\r
f7496d71	397	\r
30fdf114	398	Returns:\r
f7496d71	399	\r
30fdf114 LG	400	EFI_SUCCESS Function completed successfully.\r
	401	EFI_OUT_OF_RESOURCES Could not allocate required resources.\r
	402	EFI_ABORTED Error encountered.\r
	403	EFI_INVALID_PARAMETER A required parameter was NULL.\r
	404	\r
	405	--*/\r
	406	;\r
	407	\r
	408	#endif\r