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