Clean up format of comments

[mirror_edk2.git] / MdePkg / Library / BasePeCoffGetEntryPointLib / PeCoffGetEntryPoint.c

diff --git a/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c b/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c
index 36370ba4f71f458c075a797631467eeb3fd9e46d..d91f0584162ae71b0733a28d16ab9c5171844f4e 100644 (file)
--- a/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c
+++ b/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c
@@ -1,7 +1,9 @@
 /** @file\r
-  Tiano PE/COFF loader.\r
+  Provides the services to get the entry point to a PE/COFF image that has either been \r
+  loaded into memory or is executing at it's linked address.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
+  Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>\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
@@ -15,7 +17,6 @@
 \r
 #include <Base.h>\r
 \r
-\r
 #include <Library/PeCoffGetEntryPointLib.h>\r
 #include <Library/DebugLib.h>\r
 \r
@@ -52,7 +53,7 @@ PeCoffLoaderGetEntryPoint (
   ASSERT (EntryPoint != NULL);\r
 \r
   DosHdr = (EFI_IMAGE_DOS_HEADER *)Pe32Data;\r
-  if (EFI_IMAGE_DOS_SIGNATURE == DosHdr->e_magic) {\r
+  if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
     //\r
     // DOS image header is present, so read the PE header after the DOS image header.\r
     //\r
@@ -104,7 +105,7 @@ PeCoffLoaderGetMachineType (
   ASSERT (Pe32Data != NULL);\r
 \r
   DosHdr = (EFI_IMAGE_DOS_HEADER *)Pe32Data;\r
-  if (EFI_IMAGE_DOS_SIGNATURE == DosHdr->e_magic) {\r
+  if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
     //\r
     // DOS image header is present, so read the PE header after the DOS image header.\r
     //\r
@@ -116,9 +117,9 @@ PeCoffLoaderGetMachineType (
     Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)Pe32Data;\r
   }\r
 \r
-  if (EFI_TE_IMAGE_HEADER_SIGNATURE == Hdr.Te->Signature) {\r
+  if (Hdr.Te->Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {\r
     return Hdr.Te->Machine;\r
-  } else if (EFI_IMAGE_NT_SIGNATURE == Hdr.Pe32->Signature)  {\r
+  } else if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE)  {\r
     return Hdr.Pe32->FileHeader.Machine;\r
   }\r
 \r
@@ -127,7 +128,7 @@ PeCoffLoaderGetMachineType (
 \r
 /**\r
   Returns a pointer to the PDB file name for a PE/COFF image that has been\r
-  loaded into system memory with the PE/COFF Loader Library functions.\r
+  loaded into system memory with the PE/COFF Loader Library functions. \r
 \r
   Returns the PDB file name for the PE/COFF image specified by Pe32Data.  If\r
   the PE/COFF image specified by Pe32Data is not a valid, then NULL is\r
@@ -168,7 +169,7 @@ PeCoffLoaderGetPdbPointer (
   NumberOfRvaAndSizes = 0;\r
 \r
   DosHdr = (EFI_IMAGE_DOS_HEADER *)Pe32Data;\r
-  if (EFI_IMAGE_DOS_SIGNATURE == DosHdr->e_magic) {\r
+  if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
     //\r
     // DOS image header is present, so read the PE header after the DOS image header.\r
     //\r
@@ -180,7 +181,7 @@ PeCoffLoaderGetPdbPointer (
     Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)Pe32Data;\r
   }\r
 \r
-  if (EFI_TE_IMAGE_HEADER_SIGNATURE == Hdr.Te->Signature) {\r
+  if (Hdr.Te->Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {\r
     if (Hdr.Te->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress != 0) {\r
       DirectoryEntry  = &Hdr.Te->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG];\r
       TEImageAdjust   = sizeof (EFI_TE_IMAGE_HEADER) - Hdr.Te->StrippedSize;\r
@@ -188,23 +189,23 @@ PeCoffLoaderGetPdbPointer (
                     Hdr.Te->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress +\r
                     TEImageAdjust);\r
     }\r
-  } else if (EFI_IMAGE_NT_SIGNATURE == Hdr.Pe32->Signature) {\r
+  } else if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE) {\r
     //\r
     // NOTE: We use Machine field to identify PE32/PE32+, instead of Magic.\r
     //       It is due to backward-compatibility, for some system might\r
     //       generate PE32+ image with PE32 Magic.\r
     //\r
     switch (Hdr.Pe32->FileHeader.Machine) {\r
-    case EFI_IMAGE_MACHINE_IA32:\r
+    case IMAGE_FILE_MACHINE_I386:\r
       //\r
       // Assume PE32 image with IA32 Machine field.\r
       //\r
       Magic = EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC;\r
       break;\r
-    case EFI_IMAGE_MACHINE_X64:\r
-    case EFI_IMAGE_MACHINE_IPF:\r
+    case IMAGE_FILE_MACHINE_X64:\r
+    case IMAGE_FILE_MACHINE_IA64:\r
       //\r
-      // Assume PE32+ image with X64 or IPF Machine field\r
+      // Assume PE32+ image with x64 or IA64 Machine field\r
       //\r
       Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;\r
       break;\r
@@ -215,7 +216,7 @@ PeCoffLoaderGetPdbPointer (
       Magic = Hdr.Pe32->OptionalHeader.Magic;\r
     }\r
 \r
-    if (EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC == Magic) {\r
+    if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
       //\r
       // Use PE32 offset get Debug Directory Entry\r
       //\r
@@ -239,7 +240,7 @@ PeCoffLoaderGetPdbPointer (
     return NULL;\r
   }\r
 \r
-  if (NULL == DebugEntry || NULL == DirectoryEntry) {\r
+  if (DebugEntry == NULL || DirectoryEntry == NULL) {\r
     return NULL;\r
   }\r
 \r
@@ -247,7 +248,7 @@ PeCoffLoaderGetPdbPointer (
   // Scan the directory to find the debug entry.\r
   // \r
   for (DirCount = 0; DirCount < DirectoryEntry->Size; DirCount += sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY), DebugEntry++) {\r
-    if (EFI_IMAGE_DEBUG_TYPE_CODEVIEW == DebugEntry->Type) {\r
+    if (DebugEntry->Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
       if (DebugEntry->SizeOfData > 0) {\r
         CodeViewEntryPointer = (VOID *) ((UINTN) DebugEntry->RVA + ((UINTN)Pe32Data) + (UINTN)TEImageAdjust);\r
         switch (* (UINT32 *) CodeViewEntryPointer) {\r
@@ -255,6 +256,8 @@ PeCoffLoaderGetPdbPointer (
           return (VOID *) ((CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY));\r
         case CODEVIEW_SIGNATURE_RSDS:\r
           return (VOID *) ((CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY));\r
+        case CODEVIEW_SIGNATURE_MTOC:\r
+          return (VOID *) ((CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY));\r
         default:\r
           break;\r
         }\r