PeCoffGetEntryPointLib: Fix spelling issue

[mirror_edk2.git] / MdePkg / Include / Library / PeCoffGetEntryPointLib.h

diff --git a/MdePkg/Include/Library/PeCoffGetEntryPointLib.h b/MdePkg/Include/Library/PeCoffGetEntryPointLib.h
index fe7a6b8e5da442b4a8b5a4def4f4b466a006c232..f211cf54268e96ede7fc297d5af6ffad05c8787f 100644 (file)
--- a/MdePkg/Include/Library/PeCoffGetEntryPointLib.h
+++ b/MdePkg/Include/Library/PeCoffGetEntryPointLib.h
@@ -1,11 +1,11 @@
 /** @file\r
   Provides a service to retrieve the PE/COFF entry point from a PE/COFF image.\r
 \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
-http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -25,8 +25,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   If Pe32Data is NULL, then ASSERT().\r
   If EntryPoint is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data                  Pointer to the PE/COFF image that is loaded in system memory.\r
-  @param  EntryPoint                Pointer to entry point to the PE/COFF image to return.\r
+  @param  Pe32Data                  The pointer to the PE/COFF image that is loaded in system memory.\r
+  @param  EntryPoint                The pointer to entry point to the PE/COFF image to return.\r
 \r
   @retval RETURN_SUCCESS            EntryPoint was returned.\r
   @retval RETURN_INVALID_PARAMETER  The entry point could not be found in the PE/COFF image.\r
@@ -45,10 +45,10 @@ PeCoffLoaderGetEntryPoint (
   Returns the machine type from the PE/COFF image specified by Pe32Data.\r
   If Pe32Data is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
+  @param  Pe32Data   The pointer to the PE/COFF image that is loaded in system\r
                      memory.\r
 \r
-  @return Machine type or zero if not a valid iamge.\r
+  @return Machine type or zero if not a valid image.\r
 \r
 **/\r
 UINT16\r
@@ -69,10 +69,10 @@ PeCoffLoaderGetMachineType (
   then NULL is returned.\r
   If Pe32Data is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
+  @param  Pe32Data   The pointer to the PE/COFF image that is loaded in system\r
                      memory.\r
 \r
-  @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL\r
+  @return The PDB file name for the PE/COFF image specified by Pe32Data, or NULL\r
           if it cannot be retrieved.\r
 \r
 **/\r
@@ -89,16 +89,34 @@ PeCoffLoaderGetPdbPointer (
   Returns the size of the PE/COFF header specified by Pe32Data.\r
   If Pe32Data is NULL, then ASSERT().\r
 \r
-  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
+  @param  Pe32Data   The pointer to the PE/COFF image that is loaded in system\r
                      memory.\r
 \r
-  @return Size of PE/COFF header in bytes or zero if not a valid iamge.\r
+  @return Size of PE/COFF header in bytes, or zero if not a valid image.\r
 \r
 **/\r
-UINT32
-EFIAPI
-PeCoffGetSizeOfHeaders (
-  IN VOID     *Pe32Data
-  );
+UINT32\r
+EFIAPI\r
+PeCoffGetSizeOfHeaders (\r
+  IN VOID     *Pe32Data\r
+  );\r
+\r
+/**\r
+  Returns PE/COFF image base specified by the address in this PE/COFF image.\r
+\r
+  On DEBUG build, searches the PE/COFF image base forward the address in this\r
+  PE/COFF image and returns it.\r
+\r
+  @param  Address    Address located in one PE/COFF image.\r
+\r
+  @retval 0          RELEASE build or cannot find the PE/COFF image base.\r
+  @retval others     PE/COFF image base found.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+PeCoffSearchImageBase (\r
+  IN UINTN    Address\r
+  );\r
 \r
 #endif\r