[mirror_edk2.git] / ArmPkg / Library / DebugAgentSymbolsBaseLib / DebugAgentSymbolsBaseLib.c

/** @file\r
*  Main file supporting the SEC Phase for Versatile Express\r
*\r
*  Copyright (c) 2011-2014, ARM Limited. All rights reserved.\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/DebugAgentLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PeCoffExtraActionLib.h>\r
#include <Library/PeCoffLib.h>\r
\r
#include <Pi/PiFirmwareFile.h>\r
#include <Pi/PiFirmwareVolume.h>\r
\r
#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
  (ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1))\r
\r
// Vector Table for Sec Phase\r
VOID\r
DebugAgentVectorTable (\r
  VOID\r
  );\r
\r
/**\r
  Returns the highest bit set of the State field\r
\r
  @param ErasePolarity   Erase Polarity  as defined by EFI_FVB2_ERASE_POLARITY\r
                         in the Attributes field.\r
  @param FfsHeader       Pointer to FFS File Header\r
\r
\r
  @retval the highest bit in the State field\r
\r
**/\r
STATIC\r
EFI_FFS_FILE_STATE\r
GetFileState (\r
  IN UINT8                ErasePolarity,\r
  IN EFI_FFS_FILE_HEADER  *FfsHeader\r
  )\r
{\r
  EFI_FFS_FILE_STATE  FileState;\r
  EFI_FFS_FILE_STATE  HighestBit;\r
\r
  FileState = FfsHeader->State;\r
\r
  if (ErasePolarity != 0) {\r
    FileState = (EFI_FFS_FILE_STATE) ~FileState;\r
  }\r
\r
  HighestBit = 0x80;\r
  while (HighestBit != 0 && (HighestBit & FileState) == 0) {\r
    HighestBit >>= 1;\r
  }\r
\r
  return HighestBit;\r
}\r
\r
/**\r
  Calculates the checksum of the header of a file.\r
  The header is a zero byte checksum, so zero means header is good\r
\r
  @param FfsHeader       Pointer to FFS File Header\r
\r
  @retval Checksum of the header\r
\r
**/\r
STATIC\r
UINT8\r
CalculateHeaderChecksum (\r
  IN EFI_FFS_FILE_HEADER  *FileHeader\r
  )\r
{\r
  UINT8  Sum;\r
\r
  // Calculate the sum of the header\r
  Sum = CalculateSum8 ((CONST VOID *)FileHeader, sizeof (EFI_FFS_FILE_HEADER));\r
\r
  // State field (since this indicates the different state of file).\r
  Sum = (UINT8)(Sum - FileHeader->State);\r
\r
  // Checksum field of the file is not part of the header checksum.\r
  Sum = (UINT8)(Sum - FileHeader->IntegrityCheck.Checksum.File);\r
\r
  return Sum;\r
}\r
\r
EFI_STATUS\r
GetFfsFile (\r
  IN  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader,\r
  IN  EFI_FV_FILETYPE             FileType,\r
  OUT EFI_FFS_FILE_HEADER         **FileHeader\r
  )\r
{\r
  UINT64               FvLength;\r
  UINTN                FileOffset;\r
  EFI_FFS_FILE_HEADER  *FfsFileHeader;\r
  UINT8                ErasePolarity;\r
  UINT8                FileState;\r
  UINT32               FileLength;\r
  UINT32               FileOccupiedSize;\r
\r
  ASSERT (FwVolHeader->Signature == EFI_FVH_SIGNATURE);\r
\r
  FvLength      = FwVolHeader->FvLength;\r
  FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FwVolHeader + FwVolHeader->HeaderLength);\r
  FileOffset    = FwVolHeader->HeaderLength;\r
\r
  if (FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {\r
    ErasePolarity = 1;\r
  } else {\r
    ErasePolarity = 0;\r
  }\r
\r
  while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {\r
    // Get FileState which is the highest bit of the State\r
    FileState = GetFileState (ErasePolarity, FfsFileHeader);\r
\r
    switch (FileState) {\r
      case EFI_FILE_HEADER_INVALID:\r
        FileOffset   += sizeof (EFI_FFS_FILE_HEADER);\r
        FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER));\r
        break;\r
\r
      case EFI_FILE_DATA_VALID:\r
      case EFI_FILE_MARKED_FOR_UPDATE:\r
        if (CalculateHeaderChecksum (FfsFileHeader) != 0) {\r
          ASSERT (FALSE);\r
          return EFI_NOT_FOUND;\r
        }\r
\r
        if (FfsFileHeader->Type == FileType) {\r
          *FileHeader = FfsFileHeader;\r
          return EFI_SUCCESS;\r
        }\r
\r
        FileLength       = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
        FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
\r
        FileOffset   += FileOccupiedSize;\r
        FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r
        break;\r
\r
      case EFI_FILE_DELETED:\r
        FileLength       = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
        FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
        FileOffset      += FileOccupiedSize;\r
        FfsFileHeader    = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r
        break;\r
\r
      default:\r
        return EFI_NOT_FOUND;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
EFI_STATUS\r
GetImageContext (\r
  IN  EFI_FFS_FILE_HEADER           *FfsHeader,\r
  OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  UINTN                            ParsedLength;\r
  UINTN                            SectionSize;\r
  UINTN                            SectionLength;\r
  EFI_COMMON_SECTION_HEADER        *Section;\r
  VOID                             *EfiImage;\r
  UINTN                            ImageAddress;\r
  EFI_IMAGE_DEBUG_DIRECTORY_ENTRY  *DebugEntry;\r
  VOID                             *CodeViewEntryPointer;\r
\r
  Section      = (EFI_COMMON_SECTION_HEADER *)(FfsHeader + 1);\r
  SectionSize  = *(UINT32 *)(FfsHeader->Size) & 0x00FFFFFF;\r
  SectionSize -= sizeof (EFI_FFS_FILE_HEADER);\r
  ParsedLength = 0;\r
  EfiImage     = NULL;\r
\r
  while (ParsedLength < SectionSize) {\r
    if ((Section->Type == EFI_SECTION_PE32) || (Section->Type == EFI_SECTION_TE)) {\r
      EfiImage = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(Section + 1);\r
      break;\r
    }\r
\r
    //\r
    // Size is 24 bits wide so mask upper 8 bits.\r
    // SectionLength is adjusted it is 4 byte aligned.\r
    // Go to the next section\r
    //\r
    SectionLength = *(UINT32 *)Section->Size & 0x00FFFFFF;\r
    SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
    ASSERT (SectionLength != 0);\r
    ParsedLength += SectionLength;\r
    Section       = (EFI_COMMON_SECTION_HEADER *)((UINT8 *)Section + SectionLength);\r
  }\r
\r
  if (EfiImage == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  // Initialize the Image Context\r
  ZeroMem (ImageContext, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT));\r
  ImageContext->Handle    = EfiImage;\r
  ImageContext->ImageRead = PeCoffLoaderImageReadFromMemory;\r
\r
  Status =  PeCoffLoaderGetImageInfo (ImageContext);\r
  if (!EFI_ERROR (Status) && ((VOID *)(UINTN)ImageContext->DebugDirectoryEntryRva != NULL)) {\r
    ImageAddress = ImageContext->ImageAddress;\r
    if (ImageContext->IsTeImage) {\r
      ImageAddress += sizeof (EFI_TE_IMAGE_HEADER) - ((EFI_TE_IMAGE_HEADER *)EfiImage)->StrippedSize;\r
    }\r
\r
    DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *)(ImageAddress + ImageContext->DebugDirectoryEntryRva);\r
    if (DebugEntry->Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
      CodeViewEntryPointer = (VOID *)(ImageAddress + (UINTN)DebugEntry->RVA);\r
      switch (*(UINT32 *)CodeViewEntryPointer) {\r
        case CODEVIEW_SIGNATURE_NB10:\r
          ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);\r
          break;\r
        case CODEVIEW_SIGNATURE_RSDS:\r
          ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);\r
          break;\r
        case CODEVIEW_SIGNATURE_MTOC:\r
          ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY);\r
          break;\r
        default:\r
          break;\r
      }\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Initialize debug agent.\r
\r
  This function is used to set up debug environment to support source level debugging.\r
  If certain Debug Agent Library instance has to save some private data in the stack,\r
  this function must work on the mode that doesn't return to the caller, then\r
  the caller needs to wrap up all rest of logic after InitializeDebugAgent() into one\r
  function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is\r
  responsible to invoke the passing-in function at the end of InitializeDebugAgent().\r
\r
  If the parameter Function is not NULL, Debug Agent Library instance will invoke it by\r
  passing in the Context to be its parameter.\r
\r
  If Function() is NULL, Debug Agent Library instance will return after setup debug\r
  environment.\r
\r
  @param[in] InitFlag     Init flag is used to decide the initialize process.\r
  @param[in] Context      Context needed according to InitFlag; it was optional.\r
  @param[in] Function     Continue function called by debug agent library; it was\r
                          optional.\r
\r
**/\r
VOID\r
EFIAPI\r
InitializeDebugAgent (\r
  IN UINT32                InitFlag,\r
  IN VOID                  *Context  OPTIONAL,\r
  IN DEBUG_AGENT_CONTINUE  Function  OPTIONAL\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_FFS_FILE_HEADER           *FfsHeader;\r
  PE_COFF_LOADER_IMAGE_CONTEXT  ImageContext;\r
\r
  // We use InitFlag to know if DebugAgent has been initialized from\r
  // Sec (DEBUG_AGENT_INIT_PREMEM_SEC) or PrePi (DEBUG_AGENT_INIT_POSTMEM_SEC)\r
  // modules\r
  if (InitFlag == DEBUG_AGENT_INIT_PREMEM_SEC) {\r
    //\r
    // Get the Sec or PrePeiCore module (defined as SEC type module)\r
    //\r
    Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet64 (PcdSecureFvBaseAddress), EFI_FV_FILETYPE_SECURITY_CORE, &FfsHeader);\r
    if (!EFI_ERROR (Status)) {\r
      Status = GetImageContext (FfsHeader, &ImageContext);\r
      if (!EFI_ERROR (Status)) {\r
        PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
      }\r
    }\r
  } else if (InitFlag == DEBUG_AGENT_INIT_POSTMEM_SEC) {\r
    //\r
    // Get the PrePi or PrePeiCore module (defined as SEC type module)\r
    //\r
    Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet64 (PcdFvBaseAddress), EFI_FV_FILETYPE_SECURITY_CORE, &FfsHeader);\r
    if (!EFI_ERROR (Status)) {\r
      Status = GetImageContext (FfsHeader, &ImageContext);\r
      if (!EFI_ERROR (Status)) {\r
        PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
      }\r
    }\r
\r
    //\r
    // Get the PeiCore module (defined as PEI_CORE type module)\r
    //\r
    Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet64 (PcdFvBaseAddress), EFI_FV_FILETYPE_PEI_CORE, &FfsHeader);\r
    if (!EFI_ERROR (Status)) {\r
      Status = GetImageContext (FfsHeader, &ImageContext);\r
      if (!EFI_ERROR (Status)) {\r
        PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
      }\r
    }\r
  }\r
}\r
\r
/**\r
  Enable/Disable the interrupt of debug timer and return the interrupt state\r
  prior to the operation.\r
\r
  If EnableStatus is TRUE, enable the interrupt of debug timer.\r
  If EnableStatus is FALSE, disable the interrupt of debug timer.\r
\r
  @param[in] EnableStatus    Enable/Disable.\r
\r
  @return FALSE always.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
SaveAndSetDebugTimerInterrupt (\r
  IN BOOLEAN  EnableStatus\r
  )\r
{\r
  return FALSE;\r
}\r
Commit	Line	Data
65cd89d0	1	/** @file\r
	2	* Main file supporting the SEC Phase for Versatile Express\r
	3	*\r
6d0ca257	4	* Copyright (c) 2011-2014, ARM Limited. All rights reserved.\r
65cd89d0	5	*\r
4059386c	6	* SPDX-License-Identifier: BSD-2-Clause-Patent\r
65cd89d0	7	*\r
	8	**/\r
	9	\r
	10	#include <Uefi.h>\r
	11	#include <Library/BaseLib.h>\r
	12	#include <Library/BaseMemoryLib.h>\r
	13	#include <Library/DebugLib.h>\r
	14	#include <Library/DebugAgentLib.h>\r
	15	#include <Library/PcdLib.h>\r
	16	#include <Library/PeCoffExtraActionLib.h>\r
	17	#include <Library/PeCoffLib.h>\r
	18	\r
	19	#include <Pi/PiFirmwareFile.h>\r
	20	#include <Pi/PiFirmwareVolume.h>\r
	21	\r
	22	#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
	23	(ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1))\r
	24	\r
9d6b024d	25	// Vector Table for Sec Phase\r
	26	VOID\r
	27	DebugAgentVectorTable (\r
	28	VOID\r
	29	);\r
	30	\r
65cd89d0	31	/**\r
	32	Returns the highest bit set of the State field\r
	33	\r
	34	@param ErasePolarity Erase Polarity as defined by EFI_FVB2_ERASE_POLARITY\r
	35	in the Attributes field.\r
	36	@param FfsHeader Pointer to FFS File Header\r
	37	\r
	38	\r
	39	@retval the highest bit in the State field\r
	40	\r
	41	**/\r
	42	STATIC\r
	43	EFI_FFS_FILE_STATE\r
	44	GetFileState (\r
	45	IN UINT8 ErasePolarity,\r
	46	IN EFI_FFS_FILE_HEADER *FfsHeader\r
	47	)\r
	48	{\r
	49	EFI_FFS_FILE_STATE FileState;\r
	50	EFI_FFS_FILE_STATE HighestBit;\r
	51	\r
	52	FileState = FfsHeader->State;\r
	53	\r
	54	if (ErasePolarity != 0) {\r
429309e0	55	FileState = (EFI_FFS_FILE_STATE) ~FileState;\r
65cd89d0	56	}\r
	57	\r
	58	HighestBit = 0x80;\r
	59	while (HighestBit != 0 && (HighestBit & FileState) == 0) {\r
	60	HighestBit >>= 1;\r
	61	}\r
	62	\r
	63	return HighestBit;\r
	64	}\r
	65	\r
	66	/**\r
	67	Calculates the checksum of the header of a file.\r
	68	The header is a zero byte checksum, so zero means header is good\r
	69	\r
	70	@param FfsHeader Pointer to FFS File Header\r
	71	\r
	72	@retval Checksum of the header\r
	73	\r
	74	**/\r
	75	STATIC\r
	76	UINT8\r
	77	CalculateHeaderChecksum (\r
	78	IN EFI_FFS_FILE_HEADER *FileHeader\r
	79	)\r
	80	{\r
429309e0	81	UINT8 Sum;\r
65cd89d0	82	\r
65cd89d0	83	// Calculate the sum of the header\r
429309e0	84	Sum = CalculateSum8 ((CONST VOID *)FileHeader, sizeof (EFI_FFS_FILE_HEADER));\r
65cd89d0	85	\r
	86	// State field (since this indicates the different state of file).\r
	87	Sum = (UINT8)(Sum - FileHeader->State);\r
	88	\r
	89	// Checksum field of the file is not part of the header checksum.\r
	90	Sum = (UINT8)(Sum - FileHeader->IntegrityCheck.Checksum.File);\r
	91	\r
	92	return Sum;\r
	93	}\r
	94	\r
	95	EFI_STATUS\r
	96	GetFfsFile (\r
429309e0 MK	97	IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader,\r
	98	IN EFI_FV_FILETYPE FileType,\r
	99	OUT EFI_FFS_FILE_HEADER **FileHeader\r
65cd89d0	100	)\r
65cd89d0	101	{\r
429309e0 MK	102	UINT64 FvLength;\r
	103	UINTN FileOffset;\r
	104	EFI_FFS_FILE_HEADER *FfsFileHeader;\r
	105	UINT8 ErasePolarity;\r
	106	UINT8 FileState;\r
	107	UINT32 FileLength;\r
	108	UINT32 FileOccupiedSize;\r
65cd89d0	109	\r
	110	ASSERT (FwVolHeader->Signature == EFI_FVH_SIGNATURE);\r
	111	\r
429309e0	112	FvLength = FwVolHeader->FvLength;\r
65cd89d0	113	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FwVolHeader + FwVolHeader->HeaderLength);\r
429309e0	114	FileOffset = FwVolHeader->HeaderLength;\r
65cd89d0	115	\r
	116	if (FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {\r
	117	ErasePolarity = 1;\r
	118	} else {\r
	119	ErasePolarity = 0;\r
	120	}\r
	121	\r
	122	while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {\r
	123	// Get FileState which is the highest bit of the State\r
	124	FileState = GetFileState (ErasePolarity, FfsFileHeader);\r
	125	\r
	126	switch (FileState) {\r
429309e0 MK	127	case EFI_FILE_HEADER_INVALID:\r
	128	FileOffset += sizeof (EFI_FFS_FILE_HEADER);\r
	129	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER));\r
	130	break;\r
65cd89d0	131	\r
429309e0 MK	132	case EFI_FILE_DATA_VALID:\r
	133	case EFI_FILE_MARKED_FOR_UPDATE:\r
	134	if (CalculateHeaderChecksum (FfsFileHeader) != 0) {\r
	135	ASSERT (FALSE);\r
	136	return EFI_NOT_FOUND;\r
	137	}\r
65cd89d0	138	\r
429309e0 MK	139	if (FfsFileHeader->Type == FileType) {\r
	140	*FileHeader = FfsFileHeader;\r
	141	return EFI_SUCCESS;\r
	142	}\r
65cd89d0	143	\r
429309e0 MK	144	FileLength = (UINT32 )(FfsFileHeader->Size) & 0x00FFFFFF;\r
429309e0 MK	145	FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
65cd89d0	146	\r
429309e0 MK	147	FileOffset += FileOccupiedSize;\r
	148	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + FileOccupiedSize);\r
	149	break;\r
65cd89d0	150	\r
429309e0 MK	151	case EFI_FILE_DELETED:\r
	152	FileLength = (UINT32 )(FfsFileHeader->Size) & 0x00FFFFFF;\r
	153	FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
	154	FileOffset += FileOccupiedSize;\r
	155	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + FileOccupiedSize);\r
	156	break;\r
65cd89d0	157	\r
429309e0 MK	158	default:\r
429309e0 MK	159	return EFI_NOT_FOUND;\r
65cd89d0	160	}\r
65cd89d0	161	}\r
429309e0	162	\r
65cd89d0	163	return EFI_NOT_FOUND;\r
	164	}\r
	165	\r
	166	EFI_STATUS\r
	167	GetImageContext (\r
	168	IN EFI_FFS_FILE_HEADER *FfsHeader,\r
	169	OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
	170	)\r
	171	{\r
429309e0 MK	172	EFI_STATUS Status;\r
	173	UINTN ParsedLength;\r
	174	UINTN SectionSize;\r
	175	UINTN SectionLength;\r
	176	EFI_COMMON_SECTION_HEADER *Section;\r
	177	VOID *EfiImage;\r
	178	UINTN ImageAddress;\r
	179	EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *DebugEntry;\r
	180	VOID *CodeViewEntryPointer;\r
	181	\r
	182	Section = (EFI_COMMON_SECTION_HEADER *)(FfsHeader + 1);\r
	183	SectionSize = (UINT32 )(FfsHeader->Size) & 0x00FFFFFF;\r
65cd89d0	184	SectionSize -= sizeof (EFI_FFS_FILE_HEADER);\r
65cd89d0	185	ParsedLength = 0;\r
429309e0	186	EfiImage = NULL;\r
65cd89d0	187	\r
	188	while (ParsedLength < SectionSize) {\r
	189	if ((Section->Type == EFI_SECTION_PE32) \|\| (Section->Type == EFI_SECTION_TE)) {\r
429309e0	190	EfiImage = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(Section + 1);\r
65cd89d0	191	break;\r
	192	}\r
	193	\r
	194	//\r
	195	// Size is 24 bits wide so mask upper 8 bits.\r
	196	// SectionLength is adjusted it is 4 byte aligned.\r
	197	// Go to the next section\r
	198	//\r
	199	SectionLength = (UINT32 )Section->Size & 0x00FFFFFF;\r
	200	SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
	201	ASSERT (SectionLength != 0);\r
	202	ParsedLength += SectionLength;\r
429309e0	203	Section = (EFI_COMMON_SECTION_HEADER )((UINT8 )Section + SectionLength);\r
65cd89d0	204	}\r
	205	\r
	206	if (EfiImage == NULL) {\r
	207	return EFI_NOT_FOUND;\r
	208	}\r
	209	\r
	210	// Initialize the Image Context\r
	211	ZeroMem (ImageContext, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT));\r
	212	ImageContext->Handle = EfiImage;\r
	213	ImageContext->ImageRead = PeCoffLoaderImageReadFromMemory;\r
	214	\r
	215	Status = PeCoffLoaderGetImageInfo (ImageContext);\r
429309e0	216	if (!EFI_ERROR (Status) && ((VOID *)(UINTN)ImageContext->DebugDirectoryEntryRva != NULL)) {\r
65cd89d0	217	ImageAddress = ImageContext->ImageAddress;\r
65cd89d0	218	if (ImageContext->IsTeImage) {\r
429309e0	219	ImageAddress += sizeof (EFI_TE_IMAGE_HEADER) - ((EFI_TE_IMAGE_HEADER *)EfiImage)->StrippedSize;\r
65cd89d0	220	}\r
65cd89d0	221	\r
429309e0	222	DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *)(ImageAddress + ImageContext->DebugDirectoryEntryRva);\r
65cd89d0	223	if (DebugEntry->Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
429309e0 MK	224	CodeViewEntryPointer = (VOID *)(ImageAddress + (UINTN)DebugEntry->RVA);\r
	225	switch ((UINT32 )CodeViewEntryPointer) {\r
	226	case CODEVIEW_SIGNATURE_NB10:\r
	227	ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);\r
	228	break;\r
	229	case CODEVIEW_SIGNATURE_RSDS:\r
	230	ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);\r
	231	break;\r
	232	case CODEVIEW_SIGNATURE_MTOC:\r
	233	ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY);\r
	234	break;\r
	235	default:\r
	236	break;\r
65cd89d0	237	}\r
	238	}\r
	239	}\r
	240	\r
	241	return Status;\r
	242	}\r
	243	\r
	244	/**\r
	245	Initialize debug agent.\r
	246	\r
	247	This function is used to set up debug environment to support source level debugging.\r
	248	If certain Debug Agent Library instance has to save some private data in the stack,\r
	249	this function must work on the mode that doesn't return to the caller, then\r
	250	the caller needs to wrap up all rest of logic after InitializeDebugAgent() into one\r
	251	function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is\r
	252	responsible to invoke the passing-in function at the end of InitializeDebugAgent().\r
	253	\r
d0d8a17d	254	If the parameter Function is not NULL, Debug Agent Library instance will invoke it by\r
65cd89d0	255	passing in the Context to be its parameter.\r
	256	\r
	257	If Function() is NULL, Debug Agent Library instance will return after setup debug\r
	258	environment.\r
	259	\r
	260	@param[in] InitFlag Init flag is used to decide the initialize process.\r
	261	@param[in] Context Context needed according to InitFlag; it was optional.\r
	262	@param[in] Function Continue function called by debug agent library; it was\r
	263	optional.\r
	264	\r
	265	**/\r
	266	VOID\r
	267	EFIAPI\r
	268	InitializeDebugAgent (\r
	269	IN UINT32 InitFlag,\r
1871d28e	270	IN VOID *Context OPTIONAL,\r
65cd89d0	271	IN DEBUG_AGENT_CONTINUE Function OPTIONAL\r
	272	)\r
	273	{\r
429309e0 MK	274	EFI_STATUS Status;\r
429309e0 MK	275	EFI_FFS_FILE_HEADER *FfsHeader;\r
65cd89d0	276	PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
65cd89d0	277	\r
d0d8a17d	278	// We use InitFlag to know if DebugAgent has been initialized from\r
65cd89d0	279	// Sec (DEBUG_AGENT_INIT_PREMEM_SEC) or PrePi (DEBUG_AGENT_INIT_POSTMEM_SEC)\r
	280	// modules\r
	281	if (InitFlag == DEBUG_AGENT_INIT_PREMEM_SEC) {\r
	282	//\r
cc1e8149	283	// Get the Sec or PrePeiCore module (defined as SEC type module)\r
65cd89d0	284	//\r
429309e0 MK	285	Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet64 (PcdSecureFvBaseAddress), EFI_FV_FILETYPE_SECURITY_CORE, &FfsHeader);\r
	286	if (!EFI_ERROR (Status)) {\r
	287	Status = GetImageContext (FfsHeader, &ImageContext);\r
	288	if (!EFI_ERROR (Status)) {\r
65cd89d0	289	PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
	290	}\r
	291	}\r
	292	} else if (InitFlag == DEBUG_AGENT_INIT_POSTMEM_SEC) {\r
	293	//\r
	294	// Get the PrePi or PrePeiCore module (defined as SEC type module)\r
	295	//\r
429309e0 MK	296	Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet64 (PcdFvBaseAddress), EFI_FV_FILETYPE_SECURITY_CORE, &FfsHeader);\r
	297	if (!EFI_ERROR (Status)) {\r
	298	Status = GetImageContext (FfsHeader, &ImageContext);\r
	299	if (!EFI_ERROR (Status)) {\r
65cd89d0	300	PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
	301	}\r
	302	}\r
	303	\r
	304	//\r
	305	// Get the PeiCore module (defined as PEI_CORE type module)\r
	306	//\r
429309e0 MK	307	Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet64 (PcdFvBaseAddress), EFI_FV_FILETYPE_PEI_CORE, &FfsHeader);\r
	308	if (!EFI_ERROR (Status)) {\r
	309	Status = GetImageContext (FfsHeader, &ImageContext);\r
	310	if (!EFI_ERROR (Status)) {\r
65cd89d0	311	PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
	312	}\r
	313	}\r
	314	}\r
	315	}\r
	316	\r
	317	/**\r
	318	Enable/Disable the interrupt of debug timer and return the interrupt state\r
	319	prior to the operation.\r
	320	\r
	321	If EnableStatus is TRUE, enable the interrupt of debug timer.\r
	322	If EnableStatus is FALSE, disable the interrupt of debug timer.\r
	323	\r
	324	@param[in] EnableStatus Enable/Disable.\r
	325	\r
	326	@return FALSE always.\r
	327	\r
	328	**/\r
	329	BOOLEAN\r
	330	EFIAPI\r
	331	SaveAndSetDebugTimerInterrupt (\r
429309e0	332	IN BOOLEAN EnableStatus\r
65cd89d0	333	)\r
	334	{\r
	335	return FALSE;\r
	336	}\r