\r
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
Portions copyright (c) 2010, Apple Inc. All rights reserved.<BR>\r
- 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
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define PE_COFF_LOADER_PROTOCOL_GUID \\r
{ 0xB323179B, 0x97FB, 0x477E, { 0xB0, 0xFE, 0xD8, 0x85, 0x91, 0xFA, 0x11, 0xAB } }\r
\r
-\r
typedef struct _PE_COFF_LOADER_PROTOCOL PE_COFF_LOADER_PROTOCOL;\r
\r
-\r
-\r
/**\r
Retrieves information about a PE/COFF image.\r
\r
- Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, \r
- DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and \r
- DebugDirectoryEntryRva fields of the ImageContext structure. \r
- If ImageContext is NULL, then return RETURN_INVALID_PARAMETER. \r
- If the PE/COFF image accessed through the ImageRead service in the ImageContext \r
- structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED. \r
- If any errors occur while computing the fields of ImageContext, \r
- then the error status is returned in the ImageError field of ImageContext. \r
+ Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,\r
+ DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and\r
+ DebugDirectoryEntryRva fields of the ImageContext structure.\r
+ If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.\r
+ If the PE/COFF image accessed through the ImageRead service in the ImageContext\r
+ structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.\r
+ If any errors occur while computing the fields of ImageContext,\r
+ then the error status is returned in the ImageError field of ImageContext.\r
If the image is a TE image, then SectionAlignment is set to 0.\r
- The ImageRead and Handle fields of ImageContext structure must be valid prior \r
+ The ImageRead and Handle fields of ImageContext structure must be valid prior\r
to invoking this service.\r
\r
@param ImageContext Pointer to the image context structure that describes the PE/COFF\r
**/\r
typedef\r
RETURN_STATUS\r
-(EFIAPI *PE_COFF_LOADER_GET_IMAGE_INFO) (\r
+(EFIAPI *PE_COFF_LOADER_GET_IMAGE_INFO)(\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
-\r
/**\r
Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().\r
\r
ImageContext as the relocation base address. Otherwise, use the DestinationAddress field\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
- ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, \r
- DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of \r
+\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
+\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
**/\r
typedef\r
RETURN_STATUS\r
-(EFIAPI *PE_COFF_LOADER_RELOCATE_IMAGE) (\r
+(EFIAPI *PE_COFF_LOADER_RELOCATE_IMAGE)(\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
-\r
/**\r
Loads a PE/COFF image into memory.\r
\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, 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
+ 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
+\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
**/\r
typedef\r
RETURN_STATUS\r
-(EFIAPI *PE_COFF_LOADER_LOAD_IMAGE) (\r
+(EFIAPI *PE_COFF_LOADER_LOAD_IMAGE)(\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
-\r
-\r
/**\r
Reads contents of a PE/COFF image from a buffer in system memory.\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
- PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. \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
+ 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
+\r
If FileHandle is NULL, then ASSERT().\r
If ReadSize is NULL, then ASSERT().\r
If Buffer is NULL, then ASSERT().\r
\r
@param FileHandle Pointer to base of the input stream\r
@param FileOffset Offset into the PE/COFF image to begin the read operation.\r
- @param ReadSize On input, the size in bytes of the requested read operation. \r
+ @param ReadSize On input, the size in bytes of the requested read operation.\r
On output, the number of bytes actually read.\r
@param Buffer Output buffer that contains the data read from the PE/COFF image.\r
\r
- @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into \r
+ @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into\r
the buffer.\r
**/\r
typedef\r
RETURN_STATUS\r
-(EFIAPI *PE_COFF_LOADER_READ_FROM_MEMORY) (\r
+(EFIAPI *PE_COFF_LOADER_READ_FROM_MEMORY)(\r
IN VOID *FileHandle,\r
IN UINTN FileOffset,\r
IN OUT UINTN *ReadSize,\r
OUT VOID *Buffer\r
);\r
\r
-\r
-\r
/**\r
- Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
- runtime. \r
- \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
+ Reapply fixups on a fixed up PE32/PE32+ image to allow virtual calling at EFI\r
+ runtime.\r
+\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 FixupData 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
+ @param ImageBase Base address of a PE/COFF image that has been loaded\r
and relocated into system memory.\r
@param VirtImageBase The request virtual address that the PE/COFF image is to\r
be fixed up for.\r
@param ImageSize The size, in bytes, of the PE/COFF image.\r
- @param RelocationData A pointer to the relocation data that was collected when the PE/COFF \r
+ @param RelocationData A pointer to the relocation data that was collected when the PE/COFF\r
image was relocated using PeCoffLoaderRelocateImage().\r
- \r
+\r
**/\r
typedef\r
VOID\r
-(EFIAPI *PE_COFF_LOADER_RELOCATE_IMAGE_FOR_RUNTIME) (\r
+(EFIAPI *PE_COFF_LOADER_RELOCATE_IMAGE_FOR_RUNTIME)(\r
IN PHYSICAL_ADDRESS ImageBase,\r
IN PHYSICAL_ADDRESS VirtImageBase,\r
IN UINTN ImageSize,\r
IN VOID *RelocationData\r
);\r
\r
-\r
-\r
/**\r
Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
- Releases any environment specific resources that were allocated when the image \r
- specified by ImageContext was loaded using PeCoffLoaderLoadImage(). \r
- \r
+ Releases any environment specific resources that were allocated when the image\r
+ specified by ImageContext was loaded using PeCoffLoaderLoadImage().\r
+\r
For NT32 emulator, the PE/COFF image loaded by system needs to release.\r
- For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r
+ For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,\r
this function can simply return RETURN_SUCCESS.\r
- \r
+\r
If ImageContext is NULL, then ASSERT().\r
- \r
+\r
@param ImageContext Pointer to the image context structure that describes the PE/COFF\r
image to be unloaded.\r
\r
**/\r
typedef\r
RETURN_STATUS\r
-(EFIAPI *PE_COFF_LOADER_UNLOAD_IMAGE) (\r
+(EFIAPI *PE_COFF_LOADER_UNLOAD_IMAGE)(\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
-\r
struct _PE_COFF_LOADER_PROTOCOL {\r
- PE_COFF_LOADER_GET_IMAGE_INFO GetImageInfo;\r
- PE_COFF_LOADER_LOAD_IMAGE LoadImage;\r
- PE_COFF_LOADER_RELOCATE_IMAGE RelocateImage;\r
- PE_COFF_LOADER_READ_FROM_MEMORY ReadFromMemory;\r
- PE_COFF_LOADER_RELOCATE_IMAGE_FOR_RUNTIME RelocateImageForRuntime;\r
- PE_COFF_LOADER_UNLOAD_IMAGE UnloadImage;\r
+ PE_COFF_LOADER_GET_IMAGE_INFO GetImageInfo;\r
+ PE_COFF_LOADER_LOAD_IMAGE LoadImage;\r
+ PE_COFF_LOADER_RELOCATE_IMAGE RelocateImage;\r
+ PE_COFF_LOADER_READ_FROM_MEMORY ReadFromMemory;\r
+ PE_COFF_LOADER_RELOCATE_IMAGE_FOR_RUNTIME RelocateImageForRuntime;\r
+ PE_COFF_LOADER_UNLOAD_IMAGE UnloadImage;\r
};\r
\r
-\r
-extern EFI_GUID gPeCoffLoaderProtocolGuid;\r
-\r
+extern EFI_GUID gPeCoffLoaderProtocolGuid;\r
\r
#endif\r
-\r
projects / mirror_edk2.git / blobdiff