add the extra comments into BasePeCoffRelocateImage, BasePeCoffLoadImage and BasePeCo...

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

diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h
index 4f319e4f3e53c8d73b65ae47e128179ee99b9381..ef4a3a4a2f2c8de71ab5d3a582e0915a7c74ca7f 100644 (file)
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@@ -5,7 +5,7 @@
   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
@@ -185,6 +185,12 @@ typedef struct {
   /// 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
@@ -231,6 +237,10 @@ PeCoffLoaderGetImageInfo (
     \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
@@ -254,13 +264,17 @@ PeCoffLoaderRelocateImage (
   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 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
@@ -319,9 +333,15 @@ PeCoffLoaderImageReadFromMemory (
   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
-\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