add the extra comments into BasePeCoffRelocateImage, BasePeCoffLoadImage and BasePeCoffRelocateImageForRuntime to help user to know the usage model of these APIs.

The comments mainly used to clarify it's caller's responsibility to to perform cache maintenance operations

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8283 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/PeCoffLib.h

@@ -237,6 +237,10 @@ PeCoffLoaderGetImageInfo (
     
   If ImageContext is NULL, then ASSERT().
 
+  Note that if the platform does not maintain coherency between the instruction cache(s) and the data
+  cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
+  prior to transferring control to a PE/COFF image that is loaded using this library.
+
   @param  ImageContext        Pointer to the image context structure that describes the PE/COFF
                               image that is being relocated.
 
@@ -267,6 +271,10 @@ PeCoffLoaderRelocateImage (
   
   If ImageContext is NULL, then ASSERT().
 
+  Note that if the platform does not maintain coherency between the instruction cache(s) and the data
+  cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
+  prior to transferring control to a PE/COFF image that is loaded using this library.
+
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
                                     image that is being loaded.
 
@@ -331,6 +339,10 @@ PeCoffLoaderImageReadFromMemory (
   to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure 
   after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
 
+  Note that if the platform does not maintain coherency between the instruction cache(s) and the data
+  cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
+  prior to transferring control to a PE/COFF image that is loaded using this library.
+
   @param  ImageBase          Base address of a PE/COFF image that has been loaded 
                              and relocated into system memory.
   @param  VirtImageBase      The request virtual address that the PE/COFF image is to

MdePkg/Library/BasePeCoffLib/BasePeCoff.c

@@ -495,6 +495,10 @@ PeCoffLoaderImageAddress (
     
   If ImageContext is NULL, then ASSERT().
 
+  Note that if the platform does not maintain coherency between the instruction cache(s) and the data
+  cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
+  prior to transferring control to a PE/COFF image that is loaded using this library.
+
   @param  ImageContext        Pointer to the image context structure that describes the PE/COFF
                               image that is being relocated.
 
@@ -761,6 +765,10 @@ PeCoffLoaderRelocateImage (
   
   If ImageContext is NULL, then ASSERT().
 
+  Note that if the platform does not maintain coherency between the instruction cache(s) and the data
+  cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
+  prior to transferring control to a PE/COFF image that is loaded using this library.
+
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
                                     image that is being loaded.
 
@@ -1231,6 +1239,10 @@ PeCoffLoaderLoadImage (
   to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure 
   after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
 
+  Note that if the platform does not maintain coherency between the instruction cache(s) and the data
+  cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
+  prior to transferring control to a PE/COFF image that is loaded using this library.
+
   @param  ImageBase          Base address of a PE/COFF image that has been loaded 
                              and relocated into system memory.
   @param  VirtImageBase      The request virtual address that the PE/COFF image is to