1. Replace PeCoffLoader library by PeCoff lib for PeiCore, DxeIpl and DxeMain.

[mirror_edk2.git] / MdePkg / Include / Library / PeCoffLib.h

diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h
index 2bb9db58cf65825e8fe7264bfd1a035b9f142523..2b0050474be3e68cd24f3370e8eb619cc73fa0b9 100644 (file)
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@@ -10,15 +10,12 @@
   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
 \r
-  Module Name:  PeCoffLib.h\r
-\r
 **/\r
 \r
 #ifndef __BASE_PE_COFF_LIB_H__\r
 #define __BASE_PE_COFF_LIB_H__\r
 \r
-#include <Common/PeCoffLoaderImageContext.h>\r
-\r
+#include <IndustryStandard/PeImage.h>\r
 //\r
 // Return status codes from the PE/COFF Loader services\r
 // BUGBUG: Find where used and see if can be replaced by RETURN_STATUS codes\r
@@ -35,6 +32,44 @@
 #define IMAGE_ERROR_FAILED_RELOCATION            9\r
 #define IMAGE_ERROR_FAILED_ICACHE_FLUSH          10\r
 \r
+//\r
+// PE/COFF Loader Read Function passed in by caller\r
+//\r
+typedef\r
+RETURN_STATUS\r
+(EFIAPI *PE_COFF_LOADER_READ_FILE) (\r
+  IN     VOID   *FileHandle,\r
+  IN     UINTN  FileOffset,\r
+  IN OUT UINTN  *ReadSize,\r
+  OUT    VOID   *Buffer\r
+  );\r
+\r
+//\r
+// Context structure used while PE/COFF image is being loaded and relocated\r
+//\r
+typedef struct {\r
+  PHYSICAL_ADDRESS                  ImageAddress;\r
+  UINT64                            ImageSize;\r
+  PHYSICAL_ADDRESS                  DestinationAddress;\r
+  PHYSICAL_ADDRESS                  EntryPoint;\r
+  PE_COFF_LOADER_READ_FILE          ImageRead;\r
+  VOID                              *Handle;\r
+  VOID                              *FixupData;\r
+  UINT32                            SectionAlignment;\r
+  UINT32                            PeCoffHeaderOffset;\r
+  UINT32                            DebugDirectoryEntryRva;\r
+  VOID                              *CodeView;\r
+  CHAR8                             *PdbPointer;\r
+  UINTN                             SizeOfHeaders;\r
+  UINT32                            ImageCodeMemoryType;\r
+  UINT32                            ImageDataMemoryType;\r
+  UINT32                            ImageError;\r
+  UINTN                             FixupDataSize;\r
+  UINT16                            Machine;\r
+  UINT16                            ImageType;\r
+  BOOLEAN                           RelocationsStripped;\r
+  BOOLEAN                           IsTeImage;\r
+} PE_COFF_LOADER_IMAGE_CONTEXT;\r
 \r
 /**\r
   Retrieves information about a PE/COFF image.\r
@@ -167,5 +202,22 @@ PeCoffLoaderRelocateImageForRuntime (
   )\r
 ;\r
 \r
+/**\r
+  Unloads a loaded PE/COFF image from memory and releases its taken resource.\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
+  this function can simply return RETURN_SUCCESS.\r
+\r
+  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
+                                    image to be unloaded.\r
 \r
+  @retval RETURN_SUCCESS            The PE/COFF image was unloaded successfully.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PeCoffLoaderUnloadImage (\r
+  IN PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
+  )\r
+;\r
 #endif\r