Provides services to load and relocate a PE/COFF image.\r
\r
The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for\r
- IA-32, x86, IPF, and EBC processor types. The library functions are memory based \r
+ IA-32, x86, IPF, and EBC processor types. The library functions are memory-based \r
and can be ported easily to any environment.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation \r
+Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. 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
**/\r
typedef\r
RETURN_STATUS\r
-(EFIAPI *PE_COFF_LOADER_READ_FILE) (\r
+(EFIAPI *PE_COFF_LOADER_READ_FILE)(\r
IN VOID *FileHandle,\r
IN UINTN FileOffset,\r
IN OUT UINTN *ReadSize,\r
/// Initialization Core Interface Specification.\r
///\r
BOOLEAN IsTeImage;\r
+ ///\r
+ /// Set by PeCoffLoaderLoadImage() to the HII resource offset\r
+ /// if the image contains a custom PE/COFF resource with the type 'HII';\r
+ /// otherwise, the entry remains to be 0.\r
+ ///\r
+ PHYSICAL_ADDRESS HiiResourceData;\r
} PE_COFF_LOADER_IMAGE_CONTEXT;\r
\r
/**\r
of ImageContext as the relocation base address. The caller must allocate the relocation\r
fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.\r
\r
- The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, \r
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, \r
ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, \r
DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of \r
the ImageContext structure must be valid prior to invoking this service.\r
\r
If ImageContext is NULL, then ASSERT().\r
\r
+ Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
+ cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
+ prior to transferring control to a PE/COFF image that is loaded using this library.\r
+\r
@param ImageContext Pointer to the image context structure that describes the PE/COFF\r
image that is being relocated.\r
\r
Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer\r
specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate\r
the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.\r
- The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.\r
- The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, \r
+ The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.\r
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, \r
DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva \r
fields of the ImageContext structure must be valid prior to invoking this service.\r
\r
If ImageContext is NULL, then ASSERT().\r
\r
+ Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
+ cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
+ prior to transferring control to a PE/COFF image that is loaded using this library.\r
+\r
@param ImageContext Pointer to the image context structure that describes the PE/COFF\r
image that is being loaded.\r
\r
This is the default implementation of a PE_COFF_LOADER_READ_FILE function \r
that assumes FileHandle pointer to the beginning of a PE/COFF image. \r
This function reads contents of the PE/COFF image that starts at the system memory \r
- address specified by FileHandle. The read operation copies ReadSize bytes from the \r
+ address specified by FileHandle. The read operation copies ReadSize bytes from the \r
PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. \r
The size of the buffer actually read is returned in ReadSize.\r
\r
Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
runtime. \r
\r
- PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply\r
- the fixups with a virtual mapping.\r
+ This function reapplies relocation fixups to the PE/COFF image specified by ImageBase \r
+ and ImageSize so the image will execute correctly when the PE/COFF image is mapped \r
+ to the address specified by VirtualImageBase. RelocationData must be identical \r
+ to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure \r
+ after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().\r
\r
+ Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
+ cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
+ prior to transferring control to a PE/COFF image that is loaded using this library.\r
\r
@param ImageBase Base address of a PE/COFF image that has been loaded \r
and relocated into system memory.\r
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderUnloadImage (\r
- IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
+ IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
#endif\r
projects / mirror_edk2.git / blobdiff