BaseTools/GenFw: Enhance GenFw to support PRM GCC build

[mirror_edk2.git] / BaseTools / Source / C / GenFw / ElfConvert.h

/** @file\r
Header file for Elf convert solution\r
\r
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ELF_CONVERT_H_\r
#define _ELF_CONVERT_H_\r
\r
#include "elf_common.h"\r
#include "elf32.h"\r
#include "elf64.h"\r
\r
//\r
// Externally defined variables\r
//\r
extern UINT32 mCoffOffset;\r
extern CHAR8  *mInImageName;\r
extern UINT32 mImageTimeStamp;\r
extern UINT8  *mCoffFile;\r
extern UINT32 mTableOffset;\r
extern UINT32 mOutImageType;\r
extern UINT32 mFileBufferSize;\r
extern BOOLEAN mExportFlag;\r
\r
//\r
// Common EFI specific data.\r
//\r
#define ELF_HII_SECTION_NAME ".hii"\r
#define ELF_STRTAB_SECTION_NAME ".strtab"\r
#define MAX_COFF_ALIGNMENT 0x10000\r
#define ELF_SYMBOL_SECTION_NAME ".symtab"\r
\r
//\r
// Platform Runtime Mechanism (PRM) specific data.\r
//\r
#define PRM_MODULE_EXPORT_SYMBOL_NUM 256\r
\r
// <to-do> to include PRM header directly once PrmPkg is in main repo\r
#define PRM_HANDLER_NAME_MAXIMUM_LENGTH 128\r
\r
#define PRM_MODULE_EXPORT_DESCRIPTOR_NAME         "PrmModuleExportDescriptor"\r
#define PRM_MODULE_EXPORT_DESCRIPTOR_SIGNATURE    SIGNATURE_64 ('P', 'R', 'M', '_', 'M', 'E', 'D', 'T')\r
#define PRM_MODULE_EXPORT_REVISION                0x0\r
\r
//\r
// Platform Runtime Mechanism (PRM) Export Descriptor Structures\r
//\r
#pragma pack(push, 1)\r
\r
typedef struct {\r
  EFI_GUID                              PrmHandlerGuid;\r
  CHAR8                                 PrmHandlerName[PRM_HANDLER_NAME_MAXIMUM_LENGTH];\r
} PRM_HANDLER_EXPORT_DESCRIPTOR_STRUCT;\r
\r
typedef struct {\r
  UINT64                                Signature;\r
  UINT16                                Revision;\r
  UINT16                                NumberPrmHandlers;\r
  EFI_GUID                              PlatformGuid;\r
  EFI_GUID                              ModuleGuid;\r
} PRM_MODULE_EXPORT_DESCRIPTOR_STRUCT_HEADER;\r
\r
typedef struct {\r
  PRM_MODULE_EXPORT_DESCRIPTOR_STRUCT_HEADER  Header;\r
  PRM_HANDLER_EXPORT_DESCRIPTOR_STRUCT        PrmHandlerExportDescriptors[1];\r
} PRM_MODULE_EXPORT_DESCRIPTOR_STRUCT;\r
\r
#pragma pack(pop)\r
\r
//\r
// Filter Types\r
//\r
typedef enum {\r
  SECTION_TEXT,\r
  SECTION_HII,\r
  SECTION_DATA,\r
  SECTION_SYMBOL\r
\r
} SECTION_FILTER_TYPES;\r
\r
//\r
// FunctionTable\r
//\r
typedef struct {\r
  VOID    (*ScanSections) ();\r
  BOOLEAN (*WriteSections) (SECTION_FILTER_TYPES  FilterType);\r
  VOID    (*WriteRelocations) ();\r
  VOID    (*WriteDebug) ();\r
  VOID    (*WriteExport) ();\r
  VOID    (*SetImageSize) ();\r
  VOID    (*CleanUp) ();\r
\r
} ELF_FUNCTION_TABLE;\r
\r
//\r
// Common functions\r
//\r
VOID\r
CoffAddFixup (\r
  UINT32 Offset,\r
  UINT8  Type\r
  );\r
\r
VOID\r
CoffAddFixupEntry (\r
  UINT16 Val\r
  );\r
\r
\r
VOID\r
CreateSectionHeader (\r
  const CHAR8 *Name,\r
  UINT32      Offset,\r
  UINT32      Size,\r
  UINT32      Flags\r
  );\r
\r
#endif\r