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

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