3 Copyright (c) 2004, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 This file contains describes the public interfaces to the GenFvImage Library.
19 The basic purpose of the library is to create Firmware Volume images.
23 #ifndef _EFI_GEN_FV_IMAGE_LIB_H
24 #define _EFI_GEN_FV_IMAGE_LIB_H
29 #include <Common/UefiBaseTypes.h>
30 #include <Common/MultiPhase.h>
35 // Following definition is used for FIT in IPF
37 #define COMP_TYPE_FIT_PEICORE 0x10
38 #define COMP_TYPE_FIT_UNUSED 0x7F
40 #define FIT_TYPE_MASK 0x7F
41 #define CHECKSUM_BIT_MASK 0x80
55 // Exported function prototypes
59 IN CHAR8
*InfFileImage
,
62 OUT UINTN
*FvImageSize
,
63 OUT CHAR8
**FvFileName
,
65 OUT UINTN
*SymImageSize
,
66 OUT CHAR8
**SymFileName
74 This is the main function which will be called from application.
78 InfFileImage Buffer containing the INF file contents.
79 InfFileSize Size of the contents of the InfFileImage buffer.
80 FvImage Pointer to the FV image created.
81 FvImageSize Size of the FV image created and pointed to by FvImage.
82 FvFileName Requested name for the FV file.
83 SymImage Pointer to the Sym image created.
84 SymImageSize Size of the Sym image created and pointed to by SymImage.
85 SymFileName Requested name for the Sym file.
89 EFI_SUCCESS Function completed successfully.
90 EFI_OUT_OF_RESOURCES Could not allocate required resources.
91 EFI_ABORTED Error encountered.
92 EFI_INVALID_PARAMETER A required parameter was NULL.
96 UpdatePeiCoreEntryInFit (
97 IN FIT_TABLE
*FitTablePtr
,
98 IN UINT64 PeiCorePhysicalAddress
106 This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from
111 FitTablePtr - The pointer of FIT_TABLE.
112 PeiCorePhysicalAddress - The address of Pei Core entry.
116 EFI_SUCCESS - The PEI_CORE FIT entry was updated successfully.
117 EFI_NOT_FOUND - Not found the PEI_CORE FIT entry.
122 IN FIT_TABLE
*FitTablePtr
130 This function is used to update the checksum for FIT.
135 FitTablePtr - The pointer of FIT_TABLE.