Minor grammatical work--mostly adding periods. Items with ONLY period added did...

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

diff --git a/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c b/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c
index 4014c16baba005ac443c9ebff0d25be9cd8b4c6d..2ed58844d5d4a3b40830a86563b5f956a1a72720 100644 (file)
--- a/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c
+++ b/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c
@@ -1,11 +1,11 @@
 /** @file\r
   Specific relocation fixups for none Itanium architecture.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  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
-  http://opensource.org/licenses/bsd-license.php\r
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   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
@@ -16,14 +16,15 @@
 \r
 \r
 /**\r
-  Performs an IA-32 specific relocation fixup.\r
+  Performs an Itanium-based specific relocation fixup and is a no-op on other\r
+  instruction sets.\r
 \r
-  @param  Reloc       Pointer to the relocation record.\r
-  @param  Fixup       Pointer to the address to fix up.\r
-  @param  FixupData   Pointer to a buffer to log the fixups.\r
+  @param  Reloc       The pointer to the relocation record.\r
+  @param  Fixup       The pointer to the address to fix up.\r
+  @param  FixupData   The pointer to a buffer to log the fixups.\r
   @param  Adjust      The offset to adjust the fixup.\r
 \r
-  @retval EFI_UNSUPPORTED Unsupported now.\r
+  @return Status code.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -38,16 +39,14 @@ PeCoffLoaderRelocateImageEx (
 }\r
 \r
 /**\r
-  Returns TRUE if the machine type of PE/COFF image is supported. Supported \r
+  Returns TRUE if the machine type of PE/COFF image is supported. Supported\r
   does not mean the image can be executed it means the PE/COFF loader supports\r
   loading and relocating of the image type. It's up to the caller to support\r
-  the entry point. \r
+  the entry point.\r
+  \r
+  The IA32/X64 version PE/COFF loader/relocater both support IA32, X64 and EBC images.\r
 \r
-  This function implies the basic PE/COFF loader/relocator supports IA32, EBC,\r
-  & x64 images. Calling the entry point in a correct mannor is up to the \r
-  consumer of this library.\r
-\r
-  @param  Machine   Machine type from the PE Header.\r
+  @param  Machine   The machine type from the PE Header.\r
 \r
   @return TRUE if this PE/COFF loader can load the image\r
 \r
@@ -57,8 +56,8 @@ PeCoffLoaderImageFormatSupported (
   IN  UINT16  Machine\r
   )\r
 {\r
-  if ((Machine == EFI_IMAGE_MACHINE_IA32) || (Machine == EFI_IMAGE_MACHINE_X64) || \r
-      (Machine ==  EFI_IMAGE_MACHINE_EBC)) {\r
+  if ((Machine == IMAGE_FILE_MACHINE_I386) || (Machine == IMAGE_FILE_MACHINE_X64) || \r
+      (Machine ==  IMAGE_FILE_MACHINE_EBC)) {\r
     return TRUE; \r
   }\r
 \r
@@ -70,12 +69,12 @@ PeCoffLoaderImageFormatSupported (
   instruction sets. This is used to re-relocated the image into the EFI virtual\r
   space for runtime calls.\r
 \r
-  @param  Reloc       Pointer to the relocation record.\r
-  @param  Fixup       Pointer to the address to fix up.\r
-  @param  FixupData   Pointer to a buffer to log the fixups.\r
+  @param  Reloc       The pointer to the relocation record.\r
+  @param  Fixup       The pointer to the address to fix up.\r
+  @param  FixupData   The pointer to a buffer to log the fixups.\r
   @param  Adjust      The offset to adjust the fixup.\r
 \r
-  @return Always return UNSUPPORTED.\r
+  @return Status code.\r
 \r
 **/\r
 RETURN_STATUS\r