Synchronize MdePkg h files to Library/Base* c files.

[mirror_edk2.git] / MdePkg / Library / BasePeCoffLib / BasePeCoff.c

diff --git a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
index 181c87847a1f74f99e67ef1e9fefde1dc3858043..60f04703190b147d85266218c92b991355f56358 100644 (file)
--- a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
+++ b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
@@ -195,7 +195,7 @@ PeCoffLoaderGetPeHeader (
 RETURN_STATUS\r
 EFIAPI\r
 PeCoffLoaderGetImageInfo (\r
-  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT           *ImageContext\r
+  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
   )\r
 {\r
   RETURN_STATUS                         Status;\r
@@ -487,6 +487,12 @@ PeCoffLoaderImageAddress (
   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
+  the ImageContext structure must be valid prior to invoking this service.\r
+    \r
   If ImageContext is NULL, then ASSERT().\r
 \r
   @param  ImageContext        Pointer to the image context structure that describes the PE/COFF\r
@@ -725,6 +731,10 @@ PeCoffLoaderRelocateImage (
   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
+  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
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
@@ -1117,17 +1127,20 @@ PeCoffLoaderLoadImage (
 \r
 /**\r
   Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
-  runtime.\r
-\r
+  runtime. \r
+  \r
   PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply\r
   the fixups with a virtual mapping.\r
 \r
 \r
-  @param  ImageBase          Base address of relocated image\r
-  @param  VirtImageBase      Virtual mapping for ImageBase\r
-  @param  ImageSize          Size of the image to relocate\r
-  @param  RelocationData     Location to place results of read\r
-\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
+                             image was relocated using PeCoffLoaderRelocateImage().\r
+  \r
 **/\r
 VOID\r
 EFIAPI\r
@@ -1360,11 +1373,15 @@ PeCoffLoaderImageReadFromMemory (
 \r
 /**\r
   Unloads a loaded PE/COFF image from memory and releases its taken resource.\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
   this function can simply return RETURN_SUCCESS.\r
-\r
+  \r
+  If ImageContext is NULL, then ASSERT().\r
+  \r
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
                                     image to be unloaded.\r
 \r