2 Declaration of internal functions in PE/COFF Lib.
4 Copyright (c) 2006, Intel Corporation<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: BasePeCoffLibInternals.h
17 #ifndef __BASE_PECOFF_LIB_INTERNALS__
18 #define __BASE_PECOFF_LIB_INTERNALS__
21 // Include common header file for this module.
23 #include "CommonHeader.h"
26 Performs an Itanium-based specific relocation fixup and is a no-op on other
29 @param Reloc Pointer to the relocation record.
30 @param Fixup Pointer to the address to fix up.
31 @param FixupData Pointer to a buffer to log the fixups.
32 @param Adjust The offset to adjust the fixup.
38 PeCoffLoaderRelocateImageEx (
41 IN OUT CHAR8
**FixupData
,
47 Performs an Itanium-based specific re-relocation fixup and is a no-op on other
48 instruction sets. This is used to re-relocated the image into the EFI virtual
49 space for runtime calls.
51 @param Reloc Pointer to the relocation record.
52 @param Fixup Pointer to the address to fix up.
53 @param FixupData Pointer to a buffer to log the fixups.
54 @param Adjust The offset to adjust the fixup.
60 PeHotRelocateImageEx (
63 IN OUT CHAR8
**FixupData
,
69 Returns TRUE if the machine type of PE/COFF image is supported. Supported
70 does not mean the image can be executed it means the PE/COFF loader supports
71 loading and relocating of the image type. It's up to the caller to support
74 @param Machine Machine type from the PE Header.
76 @return TRUE if this PE/COFF loader can load the image
80 PeCoffLoaderImageFormatSupported (
85 Retrieves the magic value from the PE/COFF header.
87 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
89 @return EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC - Image is PE32
90 @return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC - Image is PE32+
94 PeCoffLoaderGetPeHeaderMagicValue (
95 IN EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
99 Retrieves the PE or TE Header from a PE/COFF or TE image.
101 @param ImageContext The context of the image being loaded.
102 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
104 @retval RETURN_SUCCESS The PE or TE Header is read.
105 @retval Other The error status from reading the PE/COFF or TE image using the ImageRead function.
109 PeCoffLoaderGetPeHeader (
110 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
111 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
115 Converts an image address to the loaded address.
117 @param ImageContext The context of the image being loaded.
118 @param Address The address to be converted to the loaded address.
120 @return The converted address or NULL if the address can not be converted.
124 PeCoffLoaderImageAddress (
125 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,