Update copyright for files modified in this year

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

diff --git a/MdePkg/Library/BasePeCoffLib/Ipf/PeCoffLoaderEx.c b/MdePkg/Library/BasePeCoffLib/Ipf/PeCoffLoaderEx.c
index babf7ca3a2367574fae874d0605795304d77b097..cac3732722bdf04b42177c032c51e75b638c062d 100644 (file)
--- a/MdePkg/Library/BasePeCoffLib/Ipf/PeCoffLoaderEx.c
+++ b/MdePkg/Library/BasePeCoffLib/Ipf/PeCoffLoaderEx.c
@@ -1,7 +1,7 @@
 /** @file\r
   Fixes Intel Itanium(TM) specific relocation types.\r
 \r
-  Copyright (c) 2006, 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
@@ -10,11 +10,9 @@
   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
 \r
-  Module Name:  PeCoffLoaderEx.c\r
-\r
 **/\r
 \r
-\r
+#include "BasePeCoffLibInternals.h"\r
 \r
 \r
 \r
@@ -45,20 +43,20 @@
 #define IMM64_IC_INST_WORD_POS_X        12\r
 #define IMM64_IC_VAL_POS_X              21\r
 \r
-#define IMM64_IMM41a_INST_WORD_X        1\r
-#define IMM64_IMM41a_SIZE_X             10\r
-#define IMM64_IMM41a_INST_WORD_POS_X    14\r
-#define IMM64_IMM41a_VAL_POS_X          22\r
+#define IMM64_IMM41A_INST_WORD_X        1\r
+#define IMM64_IMM41A_SIZE_X             10\r
+#define IMM64_IMM41A_INST_WORD_POS_X    14\r
+#define IMM64_IMM41A_VAL_POS_X          22\r
 \r
-#define IMM64_IMM41b_INST_WORD_X        1\r
-#define IMM64_IMM41b_SIZE_X             8\r
-#define IMM64_IMM41b_INST_WORD_POS_X    24\r
-#define IMM64_IMM41b_VAL_POS_X          32\r
+#define IMM64_IMM41B_INST_WORD_X        1\r
+#define IMM64_IMM41B_SIZE_X             8\r
+#define IMM64_IMM41B_INST_WORD_POS_X    24\r
+#define IMM64_IMM41B_VAL_POS_X          32\r
 \r
-#define IMM64_IMM41c_INST_WORD_X        2\r
-#define IMM64_IMM41c_SIZE_X             23\r
-#define IMM64_IMM41c_INST_WORD_POS_X    0\r
-#define IMM64_IMM41c_VAL_POS_X          40\r
+#define IMM64_IMM41C_INST_WORD_X        2\r
+#define IMM64_IMM41C_SIZE_X             23\r
+#define IMM64_IMM41C_INST_WORD_POS_X    0\r
+#define IMM64_IMM41C_VAL_POS_X          40\r
 \r
 #define IMM64_SIGN_INST_WORD_X          3\r
 #define IMM64_SIGN_SIZE_X               1\r
@@ -73,7 +71,8 @@
   @param  FixupData   Pointer to a buffer to log the fixups.\r
   @param  Adjust      The offset to adjust the fixup.\r
 \r
-  @return Status code.\r
+  @retval RETURN_SUCCESS Succeed to fix the relocation entry.\r
+  @retval RETURN_UNSUPPOTED Unrecoganized relocation entry.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -84,7 +83,7 @@ PeCoffLoaderRelocateImageEx (
   IN UINT64      Adjust\r
   )\r
 {\r
-  UINT64      *F64;\r
+  UINT64      *Fixup64;\r
   UINT64      FixupVal;\r
 \r
   switch ((*Reloc) >> 12) {\r
@@ -130,10 +129,10 @@ PeCoffLoaderRelocateImageEx (
                 );\r
 \r
       EXT_IMM64(FixupVal,\r
-                (UINT32 *)Fixup + IMM64_IMM41a_INST_WORD_X,\r
-                IMM64_IMM41a_SIZE_X,\r
-                IMM64_IMM41a_INST_WORD_POS_X,\r
-                IMM64_IMM41a_VAL_POS_X\r
+                (UINT32 *)Fixup + IMM64_IMM41A_INST_WORD_X,\r
+                IMM64_IMM41A_SIZE_X,\r
+                IMM64_IMM41A_INST_WORD_POS_X,\r
+                IMM64_IMM41A_VAL_POS_X\r
                 );\r
 \r
       //\r
@@ -173,24 +172,24 @@ PeCoffLoaderRelocateImageEx (
                 );\r
 \r
       INS_IMM64(FixupVal,\r
-                ((UINT32 *)Fixup + IMM64_IMM41a_INST_WORD_X),\r
-                IMM64_IMM41a_SIZE_X,\r
-                IMM64_IMM41a_INST_WORD_POS_X,\r
-                IMM64_IMM41a_VAL_POS_X\r
+                ((UINT32 *)Fixup + IMM64_IMM41A_INST_WORD_X),\r
+                IMM64_IMM41A_SIZE_X,\r
+                IMM64_IMM41A_INST_WORD_POS_X,\r
+                IMM64_IMM41A_VAL_POS_X\r
                 );\r
 \r
       INS_IMM64(FixupVal,\r
-                ((UINT32 *)Fixup + IMM64_IMM41b_INST_WORD_X),\r
-                IMM64_IMM41b_SIZE_X,\r
-                IMM64_IMM41b_INST_WORD_POS_X,\r
-                IMM64_IMM41b_VAL_POS_X\r
+                ((UINT32 *)Fixup + IMM64_IMM41B_INST_WORD_X),\r
+                IMM64_IMM41B_SIZE_X,\r
+                IMM64_IMM41B_INST_WORD_POS_X,\r
+                IMM64_IMM41B_VAL_POS_X\r
                 );\r
 \r
       INS_IMM64(FixupVal,\r
-                ((UINT32 *)Fixup + IMM64_IMM41c_INST_WORD_X),\r
-                IMM64_IMM41c_SIZE_X,\r
-                IMM64_IMM41c_INST_WORD_POS_X,\r
-                IMM64_IMM41c_VAL_POS_X\r
+                ((UINT32 *)Fixup + IMM64_IMM41C_INST_WORD_X),\r
+                IMM64_IMM41C_SIZE_X,\r
+                IMM64_IMM41C_INST_WORD_POS_X,\r
+                IMM64_IMM41C_VAL_POS_X\r
                 );\r
 \r
       INS_IMM64(FixupVal,\r
@@ -200,10 +199,10 @@ PeCoffLoaderRelocateImageEx (
                 IMM64_SIGN_VAL_POS_X\r
                 );\r
 \r
-      F64 = (UINT64 *) Fixup;\r
+      Fixup64 = (UINT64 *) Fixup;\r
       if (*FixupData != NULL) {\r
         *FixupData = ALIGN_POINTER(*FixupData, sizeof(UINT64));\r
-        *(UINT64 *)(*FixupData) = *F64;\r
+        *(UINT64 *)(*FixupData) = *Fixup64;\r
         *FixupData = *FixupData + sizeof(UINT64);\r
       }\r
       break;\r
@@ -222,13 +221,14 @@ PeCoffLoaderRelocateImageEx (
   the entry point.\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
+  & x64 images. Calling the entry point in a correct mannor is up to the\r
   consumer of this library. This version also supports the special relocations\r
   for Itanium.\r
 \r
   @param  Machine   Machine type from the PE Header.\r
 \r
   @return TRUE if this PE/COFF loader can load the image\r
+  @return FALSE unrecoganized machine type of image.\r
 \r
 **/\r
 BOOLEAN\r
@@ -256,6 +256,8 @@ PeCoffLoaderImageFormatSupported (
 \r
   @retval RETURN_SUCCESS    Data is read from FileOffset from the Handle into\r
                             the buffer.\r
+  @retval RETURN_UNSUPPORTED Un-recoganized relocation entry\r
+                             type.\r
 **/\r
 RETURN_STATUS\r
 PeHotRelocateImageEx (\r
@@ -265,24 +267,24 @@ PeHotRelocateImageEx (
   IN UINT64      Adjust\r
   )\r
 {\r
-  UINT64  *F64;\r
+  UINT64  *Fixup64;\r
   UINT64  FixupVal;\r
 \r
   switch ((*Reloc) >> 12) {\r
   case EFI_IMAGE_REL_BASED_DIR64:\r
-    F64         = (UINT64 *) Fixup;\r
+    Fixup64     = (UINT64 *) Fixup;\r
     *FixupData  = ALIGN_POINTER (*FixupData, sizeof (UINT64));\r
-    if (*(UINT64 *) (*FixupData) == *F64) {\r
-      *F64 = *F64 + (UINT64) Adjust;\r
+    if (*(UINT64 *) (*FixupData) == *Fixup64) {\r
+      *Fixup64 = *Fixup64 + (UINT64) Adjust;\r
     }\r
 \r
     *FixupData = *FixupData + sizeof (UINT64);\r
     break;\r
 \r
   case EFI_IMAGE_REL_BASED_IA64_IMM64:\r
-    F64         = (UINT64 *) Fixup;\r
+    Fixup64     = (UINT64 *) Fixup;\r
     *FixupData  = ALIGN_POINTER (*FixupData, sizeof (UINT64));\r
-    if (*(UINT64 *) (*FixupData) == *F64) {\r
+    if (*(UINT64 *) (*FixupData) == *Fixup64) {\r
       //\r
       // Align it to bundle address before fixing up the\r
       // 64-bit immediate value of the movl instruction.\r
@@ -328,10 +330,10 @@ PeHotRelocateImageEx (
 \r
       EXT_IMM64 (\r
         FixupVal,\r
-        (UINT32 *) Fixup + IMM64_IMM41a_INST_WORD_X,\r
-        IMM64_IMM41a_SIZE_X,\r
-        IMM64_IMM41a_INST_WORD_POS_X,\r
-        IMM64_IMM41a_VAL_POS_X\r
+        (UINT32 *) Fixup + IMM64_IMM41A_INST_WORD_X,\r
+        IMM64_IMM41A_SIZE_X,\r
+        IMM64_IMM41A_INST_WORD_POS_X,\r
+        IMM64_IMM41A_VAL_POS_X\r
         );\r
 \r
       //\r
@@ -376,26 +378,26 @@ PeHotRelocateImageEx (
 \r
       INS_IMM64 (\r
         FixupVal,\r
-        ((UINT32 *) Fixup + IMM64_IMM41a_INST_WORD_X),\r
-        IMM64_IMM41a_SIZE_X,\r
-        IMM64_IMM41a_INST_WORD_POS_X,\r
-        IMM64_IMM41a_VAL_POS_X\r
+        ((UINT32 *) Fixup + IMM64_IMM41A_INST_WORD_X),\r
+        IMM64_IMM41A_SIZE_X,\r
+        IMM64_IMM41A_INST_WORD_POS_X,\r
+        IMM64_IMM41A_VAL_POS_X\r
         );\r
 \r
       INS_IMM64 (\r
         FixupVal,\r
-        ((UINT32 *) Fixup + IMM64_IMM41b_INST_WORD_X),\r
-        IMM64_IMM41b_SIZE_X,\r
-        IMM64_IMM41b_INST_WORD_POS_X,\r
-        IMM64_IMM41b_VAL_POS_X\r
+        ((UINT32 *) Fixup + IMM64_IMM41B_INST_WORD_X),\r
+        IMM64_IMM41B_SIZE_X,\r
+        IMM64_IMM41B_INST_WORD_POS_X,\r
+        IMM64_IMM41B_VAL_POS_X\r
         );\r
 \r
       INS_IMM64 (\r
         FixupVal,\r
-        ((UINT32 *) Fixup + IMM64_IMM41c_INST_WORD_X),\r
-        IMM64_IMM41c_SIZE_X,\r
-        IMM64_IMM41c_INST_WORD_POS_X,\r
-        IMM64_IMM41c_VAL_POS_X\r
+        ((UINT32 *) Fixup + IMM64_IMM41C_INST_WORD_X),\r
+        IMM64_IMM41C_SIZE_X,\r
+        IMM64_IMM41C_INST_WORD_POS_X,\r
+        IMM64_IMM41C_VAL_POS_X\r
         );\r
 \r
       INS_IMM64 (\r
@@ -406,7 +408,7 @@ PeHotRelocateImageEx (
         IMM64_SIGN_VAL_POS_X\r
         );\r
 \r
-      *(UINT64 *) (*FixupData) = *F64;\r
+      *(UINT64 *) (*FixupData) = *Fixup64;\r
     }\r
 \r
     *FixupData = *FixupData + sizeof (UINT64);\r