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

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

diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h
index 9dab2e453a4ba55cd566b9b370a2a6cb391e5321..ef4a3a4a2f2c8de71ab5d3a582e0915a7c74ca7f 100644 (file)
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@@ -237,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
@@ -267,6 +271,10 @@ PeCoffLoaderRelocateImage (
   \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
@@ -331,6 +339,10 @@ PeCoffLoaderImageReadFromMemory (
   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
   @param  VirtImageBase      The request virtual address that the PE/COFF image is to\r

diff --git a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
index fcdf0c6647c7cdcc066aa9d1142ae6a515d454ce..d9359e98921b04fbf430ed748bfe4b97fe90bed6 100644 (file)
--- a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
+++ b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
@@ -495,6 +495,10 @@ PeCoffLoaderImageAddress (
     \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
@@ -761,6 +765,10 @@ PeCoffLoaderRelocateImage (
   \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
@@ -1231,6 +1239,10 @@ PeCoffLoaderLoadImage (
   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
   @param  VirtImageBase      The request virtual address that the PE/COFF image is to\r