UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

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

/** @file\r
  Provides a service to retrieve the PE/COFF entry point from a PE/COFF image.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __PE_COFF_GET_ENTRY_POINT_LIB_H__\r
#define __PE_COFF_GET_ENTRY_POINT_LIB_H__\r
\r
/**\r
  Retrieves and returns a pointer to the entry point to a PE/COFF image that has been loaded\r
  into system memory with the PE/COFF Loader Library functions.\r
\r
  Retrieves the entry point to the PE/COFF image specified by Pe32Data and returns this entry\r
  point in EntryPoint.  If the entry point could not be retrieved from the PE/COFF image, then\r
  return RETURN_INVALID_PARAMETER.  Otherwise return RETURN_SUCCESS.\r
  If Pe32Data is NULL, then ASSERT().\r
  If EntryPoint is NULL, then ASSERT().\r
\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
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderGetEntryPoint (\r
  IN  VOID  *Pe32Data,\r
  OUT VOID  **EntryPoint\r
  );\r
\r
/**\r
  Returns the machine type of a PE/COFF image.\r
\r
  Returns the machine type from the PE/COFF image specified by Pe32Data.\r
  If Pe32Data is NULL, then ASSERT().\r
\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 image.\r
\r
**/\r
UINT16\r
EFIAPI\r
PeCoffLoaderGetMachineType (\r
  IN VOID  *Pe32Data\r
  );\r
\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
\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
  returned.  If the PE/COFF image specified by Pe32Data does not contain a\r
  debug directory entry, then NULL is returned.  If the debug directory entry\r
  in the PE/COFF image specified by Pe32Data does not contain a PDB file name,\r
  then NULL is returned.\r
  If Pe32Data is NULL, then ASSERT().\r
\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
          if it cannot be retrieved.\r
\r
**/\r
VOID *\r
EFIAPI\r
PeCoffLoaderGetPdbPointer (\r
  IN VOID  *Pe32Data\r
  );\r
\r
/**\r
  Returns the size of the PE/COFF headers\r
\r
  Returns the size of the PE/COFF header specified by Pe32Data.\r
  If Pe32Data is NULL, then ASSERT().\r
\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 image.\r
\r
**/\r
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