EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Include/Library/EdkIIGluePeCoffGetEntryPointLib.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12
  13 Module Name:
  14
  15   EdkIIGluePeCoffGetEntryPointLib.h
  16
  17 Abstract:
  18
  19   Public header file for PeCoff Get Entry Point Lib
  20
  21 --*/
  22
  23 #ifndef __EDKII_GLUE_PE_COFF_GET_ENTRY_POINT_LIB_H__
  24 #define __EDKII_GLUE_PE_COFF_GET_ENTRY_POINT_LIB_H__
  25
  26 /**
  27   Retrieves and returns a pointer to the entry point to a PE/COFF image that has been loaded
  28   into system memory with the PE/COFF Loader Library functions.
  29
  30   Retrieves the entry point to the PE/COFF image specified by Pe32Data and returns this entry
  31   point in EntryPoint.  If the entry point could not be retrieved from the PE/COFF image, then
  32   return RETURN_INVALID_PARAMETER.  Otherwise return RETURN_SUCCESS.
  33   If Pe32Data is NULL, then ASSERT().
  34   If EntryPoint is NULL, then ASSERT().
  35
  36   @param  Pe32Data                  Pointer to the PE/COFF image that is loaded in system memory.
  37   @param  EntryPoint                Pointer to entry point to the PE/COFF image to return.
  38
  39   @retval RETURN_SUCCESS            EntryPoint was returned.
  40   @retval RETURN_INVALID_PARAMETER  The entry point could not be found in the PE/COFF image.
  41
  42 **/
  43 RETURN_STATUS
  44 EFIAPI
  45 PeCoffLoaderGetEntryPoint (
  46   IN  VOID  *Pe32Data,
  47   OUT VOID  **EntryPoint
  48   );
  49
  50 /**
  51   Returns the machine type of a PE/COFF image.
  52
  53   Returns the machine type from the PE/COFF image specified by Pe32Data.
  54   If Pe32Data is NULL, then ASSERT().
  55
  56   @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system
  57                      memory.
  58
  59   @return Machine type or zero if not a valid iamge.
  60
  61 **/
  62 UINT16
  63 EFIAPI
  64 PeCoffLoaderGetMachineType (
  65   IN VOID  *Pe32Data
  66   );
  67
  68 /**
  69   Returns a pointer to the PDB file name for a PE/COFF image that has been
  70   loaded into system memory with the PE/COFF Loader Library functions.
  71
  72   Returns the PDB file name for the PE/COFF image specified by Pe32Data.  If
  73   the PE/COFF image specified by Pe32Data is not a valid, then NULL is
  74   returned.  If the PE/COFF image specified by Pe32Data does not contain a
  75   debug directory entry, then NULL is returned.  If the debug directory entry
  76   in the PE/COFF image specified by Pe32Data does not contain a PDB file name,
  77   then NULL is returned.
  78   If Pe32Data is NULL, then ASSERT().
  79
  80   @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system
  81                      memory.
  82
  83   @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL
  84           if it cannot be retrieved.
  85
  86 **/
  87 VOID *
  88 EFIAPI
  89 PeCoffLoaderGetPdbPointer (
  90   IN VOID  *Pe32Data
  91   );
  92
  93 #endif