.pytool/Plugin/UncrustifyCheck: Add Azure DevOps UI debug instructions

[mirror_edk2.git] / UefiPayloadPkg / PayloadLoaderPeim / ElfLib.h

/** @file\r
  ELF library\r
\r
  Copyright (c) 2018 - 2021, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef ELF_LIB_H_\r
#define ELF_LIB_H_\r
\r
#include <PiPei.h>\r
\r
#define  ELF_CLASS32  1\r
#define  ELF_CLASS64  2\r
\r
#define  ELF_PT_LOAD  1\r
\r
typedef struct {\r
  RETURN_STATUS    ParseStatus;            ///< Return the status after ParseElfImage().\r
  UINT8            *FileBase;              ///< The source location in memory.\r
  UINTN            FileSize;               ///< The size including sections that don't require loading.\r
  UINT8            *PreferredImageAddress; ///< The preferred image to be loaded. No relocation is needed if loaded to this address.\r
  BOOLEAN          ReloadRequired;         ///< The image needs a new memory location for running.\r
  UINT8            *ImageAddress;          ///< The destination memory address set by caller.\r
  UINTN            ImageSize;              ///< The memory size for loading and execution.\r
  UINT32           EiClass;\r
  UINT32           ShNum;\r
  UINT32           PhNum;\r
  UINTN            ShStrOff;\r
  UINTN            ShStrLen;\r
  UINTN            EntryPoint;           ///< Return the actual entry point after LoadElfImage().\r
} ELF_IMAGE_CONTEXT;\r
\r
typedef struct {\r
  UINT32    PtType;\r
  UINTN     Offset;\r
  UINTN     Length;\r
  UINTN     MemLen;\r
  UINTN     MemAddr;\r
  UINTN     Alignment;\r
} SEGMENT_INFO;\r
\r
/**\r
  Parse the ELF image info.\r
\r
  @param[in]  ImageBase      Memory address of an image.\r
  @param[out] ElfCt          The EFL image context pointer.\r
\r
  @retval EFI_INVALID_PARAMETER   Input parameters are not valid.\r
  @retval EFI_UNSUPPORTED         Unsupported binary type.\r
  @retval EFI_LOAD_ERROR          ELF binary loading error.\r
  @retval EFI_SUCCESS             ELF binary is loaded successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ParseElfImage (\r
  IN  VOID               *ImageBase,\r
  OUT ELF_IMAGE_CONTEXT  *ElfCt\r
  );\r
\r
/**\r
  Load the ELF segments to specified address in ELF header.\r
\r
  This function loads ELF image segments into memory address specified\r
  in ELF program header.\r
\r
  @param[in]  ElfCt               ELF image context pointer.\r
\r
  @retval EFI_INVALID_PARAMETER   Input parameters are not valid.\r
  @retval EFI_UNSUPPORTED         Unsupported binary type.\r
  @retval EFI_LOAD_ERROR          ELF binary loading error.\r
  @retval EFI_SUCCESS             ELF binary is loaded successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
LoadElfImage (\r
  IN  ELF_IMAGE_CONTEXT  *ElfCt\r
  );\r
\r
/**\r
  Get a ELF section name from its index.\r
\r
  @param[in]  ElfCt               ELF image context pointer.\r
  @param[in]  SectionIndex        ELF section index.\r
  @param[out] SectionName         The pointer to the section name.\r
\r
  @retval EFI_INVALID_PARAMETER   ElfCt or SecName is NULL.\r
  @retval EFI_NOT_FOUND           Could not find the section.\r
  @retval EFI_SUCCESS             Section name was filled successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetElfSectionName (\r
  IN  ELF_IMAGE_CONTEXT  *ElfCt,\r
  IN  UINT32             SectionIndex,\r
  OUT CHAR8              **SectionName\r
  );\r
\r
/**\r
  Get the offset and size of x-th ELF section.\r
\r
  @param[in]  ElfCt               ELF image context pointer.\r
  @param[in]  Index               ELF section index.\r
  @param[out] Offset              Return the offset of the specific section.\r
  @param[out] Size                Return the size of the specific section.\r
\r
  @retval EFI_INVALID_PARAMETER   ImageBase, Offset or Size is NULL.\r
  @retval EFI_INVALID_PARAMETER   EiClass doesn't equal to ELFCLASS32 or ELFCLASS64.\r
  @retval EFI_NOT_FOUND           Could not find the section.\r
  @retval EFI_SUCCESS             Offset and Size are returned.\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetElfSectionPos (\r
  IN  ELF_IMAGE_CONTEXT  *ElfCt,\r
  IN  UINT32             Index,\r
  OUT UINTN              *Offset,\r
  OUT UINTN              *Size\r
  );\r
\r
#endif /* ELF_LIB_H_ */\r