4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncModule Name:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file contains describes the public interfaces to the GenFvImage Library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The basic purpose of the library is to create Firmware Volume images.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Include files
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Different file separater for Linux and Windows
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The maximum number of Pad file guid entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The maximum number of block map entries supported by the library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The maximum number of files in the FV supported by the library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// INF file strings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Options section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FV_BASE_ADDRESS_STRING "EFI_BASE_ADDRESS"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_CAPSULE_HEADER_SIZE_STRING "EFI_CAPSULE_HEADER_SIZE"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_CAPSULE_FLAGS_STRING "EFI_CAPSULE_FLAGS"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_CAPSULE_VERSION_STRING "EFI_CAPSULE_VERSION"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FV_TOTAL_SIZE_STRING "EFI_FV_TOTAL_SIZE"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FV_TAKEN_SIZE_STRING "EFI_FV_TAKEN_SIZE"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FV_SPACE_SIZE_STRING "EFI_FV_SPACE_SIZE"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Attributes section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_READ_DISABLED_CAP_STRING "EFI_READ_DISABLED_CAP"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_READ_ENABLED_CAP_STRING "EFI_READ_ENABLED_CAP"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_READ_STATUS_STRING "EFI_READ_STATUS"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_WRITE_ENABLED_CAP_STRING "EFI_WRITE_ENABLED_CAP"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_WRITE_STATUS_STRING "EFI_WRITE_STATUS"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_LOCK_STATUS_STRING "EFI_LOCK_STATUS"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_STICKY_WRITE_STRING "EFI_STICKY_WRITE"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_MEMORY_MAPPED_STRING "EFI_MEMORY_MAPPED"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ERASE_POLARITY_STRING "EFI_ERASE_POLARITY"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_READ_LOCK_CAP_STRING "EFI_READ_LOCK_CAP"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_READ_LOCK_STATUS_STRING "EFI_READ_LOCK_STATUS"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_WRITE_LOCK_CAP_STRING "EFI_WRITE_LOCK_CAP"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_WRITE_LOCK_STATUS_STRING "EFI_WRITE_LOCK_STATUS"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_1_STRING "EFI_FVB2_ALIGNMENT_1"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_2_STRING "EFI_FVB2_ALIGNMENT_2"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_4_STRING "EFI_FVB2_ALIGNMENT_4"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_8_STRING "EFI_FVB2_ALIGNMENT_8"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_16_STRING "EFI_FVB2_ALIGNMENT_16"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_32_STRING "EFI_FVB2_ALIGNMENT_32"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_64_STRING "EFI_FVB2_ALIGNMENT_64"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_128_STRING "EFI_FVB2_ALIGNMENT_128"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_256_STRING "EFI_FVB2_ALIGNMENT_256"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_512_STRING "EFI_FVB2_ALIGNMENT_512"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_1K_STRING "EFI_FVB2_ALIGNMENT_1K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_2K_STRING "EFI_FVB2_ALIGNMENT_2K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_4K_STRING "EFI_FVB2_ALIGNMENT_4K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_8K_STRING "EFI_FVB2_ALIGNMENT_8K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_16K_STRING "EFI_FVB2_ALIGNMENT_16K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_32K_STRING "EFI_FVB2_ALIGNMENT_32K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_64K_STRING "EFI_FVB2_ALIGNMENT_64K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_128K_STRING "EFI_FVB2_ALIGNMENT_128K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_256K_STRING "EFI_FVB2_ALIGNMENT_256K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_512K_STRING "EFI_FVB2_ALIGNMENT_512K"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_1M_STRING "EFI_FVB2_ALIGNMENT_1M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_2M_STRING "EFI_FVB2_ALIGNMENT_2M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_4M_STRING "EFI_FVB2_ALIGNMENT_4M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_8M_STRING "EFI_FVB2_ALIGNMENT_8M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_16M_STRING "EFI_FVB2_ALIGNMENT_16M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_32M_STRING "EFI_FVB2_ALIGNMENT_32M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_64M_STRING "EFI_FVB2_ALIGNMENT_64M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_128M_STRING "EFI_FVB2_ALIGNMENT_128M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_256M_STRING "EFI_FVB2_ALIGNMENT_256M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_512M_STRING "EFI_FVB2_ALIGNMENT_512M"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_1G_STRING "EFI_FVB2_ALIGNMENT_1G"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FVB2_ALIGNMENT_2G_STRING "EFI_FVB2_ALIGNMENT_2G"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// File sections
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_FV_EXT_HEADER_FILE_NAME "EFI_FV_EXT_HEADER_FILE_NAME"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VTF (Firmware Volume Top File) signatures
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IA32_X64_VTF0_SIGNATURE EFI_SIGNATURE_32('V','T','F',0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Defines to calculate the offset for PEI CORE entry points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Defines to calculate the offset for IA32 SEC CORE entry point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Defines to calculate the FIT table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Defines to calculate the offset for SALE_ENTRY
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Symbol file definitions, current max size if 512K
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Following definition is used for FIT in IPF
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Private data types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Component information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// FV and capsule information holder
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FV_BLOCK_MAP_ENTRY FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 FvFiles[MAX_NUMBER_OF_FILES_IN_FV][_MAX_PATH];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 CapFiles[MAX_NUMBER_OF_FILES_IN_CAP][_MAX_PATH];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Local function prototypes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sec to Pei Core
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FitTablePtr - The pointer of FIT_TABLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PeiCorePhysicalAddress - The address of Pei Core entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS - The PEI_CORE FIT entry was updated successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_FOUND - Not found the PEI_CORE FIT entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to update the checksum for FIT.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FitTablePtr - The pointer of FIT_TABLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Exported function prototypes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the main function which will be called from application to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync generate UEFI Capsule image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InfFileImage Buffer containing the INF file contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InfFileSize Size of the contents of the InfFileImage buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapFileName Requested name for the Cap file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS Function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_OUT_OF_RESOURCES Could not allocate required resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ABORTED Error encountered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER A required parameter was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the main function which will be called from application to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync generate Firmware Image conforms to PI spec.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InfFileImage Buffer containing the INF file contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InfFileSize Size of the contents of the InfFileImage buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FvFileName Requested name for the FV file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapFileName Fv map file to log fv driver information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS Function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_OUT_OF_RESOURCES Could not allocate required resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ABORTED Error encountered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER A required parameter was NULL.