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

/** @file\r
*  Main file supporting the SEC Phase for Versatile Express\r
*\r
*  Copyright (c) 2011, ARM Limited. All rights reserved.\r
*\r
*  This program and the accompanying materials\r
*  are licensed and made available under the terms and conditions of the BSD License\r
*  which accompanies this distribution.  The full text of the license may be found at\r
*  http://opensource.org/licenses/bsd-license.php\r
*\r
*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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
/**\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
\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
  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*)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
      case CODEVIEW_SIGNATURE_RSDS:\r
        ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);\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 Libary 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 intialized 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 PrePi or PrePeiCore module (defined as SEC type module)\r
    //\r
    Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER*)PcdGet32(PcdSecureFdBaseAddress), 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*)PcdGet32(PcdNormalFvBaseAddress), 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*)PcdGet32(PcdNormalFvBaseAddress), 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
\r
Commit	Line	Data
65cd89d0	1	/** @file\r
	2	* Main file supporting the SEC Phase for Versatile Express\r
	3	*\r
	4	* Copyright (c) 2011, ARM Limited. All rights reserved.\r
	5	*\r
	6	* This program and the accompanying materials\r
	7	* are licensed and made available under the terms and conditions of the BSD License\r
	8	* which accompanies this distribution. The full text of the license may be found at\r
	9	* http://opensource.org/licenses/bsd-license.php\r
	10	*\r
	11	* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	*\r
	14	**/\r
	15	\r
	16	#include <Uefi.h>\r
	17	#include <Library/BaseLib.h>\r
	18	#include <Library/BaseMemoryLib.h>\r
	19	#include <Library/DebugLib.h>\r
	20	#include <Library/DebugAgentLib.h>\r
	21	#include <Library/PcdLib.h>\r
	22	#include <Library/PeCoffExtraActionLib.h>\r
	23	#include <Library/PeCoffLib.h>\r
	24	\r
	25	#include <Pi/PiFirmwareFile.h>\r
	26	#include <Pi/PiFirmwareVolume.h>\r
	27	\r
	28	#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
	29	(ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1))\r
	30	\r
	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
	55	FileState = (EFI_FFS_FILE_STATE)~FileState;\r
	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
81	UINT8 Sum;\r
82	\r
83	// Calculate the sum of the header\r
84	Sum = CalculateSum8 ((CONST VOID*)FileHeader,sizeof(EFI_FFS_FILE_HEADER));\r
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
97	IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader,\r
98	IN EFI_FV_FILETYPE FileType,\r
99	OUT EFI_FFS_FILE_HEADER **FileHeader\r
100	)\r
101	{\r
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
109	\r
110	ASSERT (FwVolHeader->Signature == EFI_FVH_SIGNATURE);\r
111	\r
112	FvLength = FwVolHeader->FvLength;\r
113	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FwVolHeader + FwVolHeader->HeaderLength);\r
114	FileOffset = FwVolHeader->HeaderLength;\r
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
127	\r
128	case EFI_FILE_HEADER_INVALID:\r
129	FileOffset += sizeof(EFI_FFS_FILE_HEADER);\r
130	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + sizeof(EFI_FFS_FILE_HEADER));\r
131	break;\r
132	\r
133	case EFI_FILE_DATA_VALID:\r
134	case EFI_FILE_MARKED_FOR_UPDATE:\r
135	if (CalculateHeaderChecksum (FfsFileHeader) != 0) {\r
136	ASSERT (FALSE);\r
137	return EFI_NOT_FOUND;\r
138	}\r
139	\r
140	if (FfsFileHeader->Type == FileType) {\r
141	*FileHeader = FfsFileHeader;\r
142	return EFI_SUCCESS;\r
143	}\r
144	\r
145	FileLength = (UINT32 )(FfsFileHeader->Size) & 0x00FFFFFF;\r
146	FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r
147	\r
148	FileOffset += FileOccupiedSize;\r
149	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + FileOccupiedSize);\r
150	break;\r
151	\r
152	case EFI_FILE_DELETED:\r
153	FileLength = (UINT32 )(FfsFileHeader->Size) & 0x00FFFFFF;\r
154	FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r
155	FileOffset += FileOccupiedSize;\r
156	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + FileOccupiedSize);\r
157	break;\r
158	\r
159	default:\r
160	return EFI_NOT_FOUND;\r
161	}\r
162	}\r
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
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
184	SectionSize -= sizeof (EFI_FFS_FILE_HEADER);\r
185	ParsedLength = 0;\r
186	EfiImage = NULL;\r
187	\r
188	while (ParsedLength < SectionSize) {\r
189	if ((Section->Type == EFI_SECTION_PE32) \|\| (Section->Type == EFI_SECTION_TE)) {\r
190	EfiImage = (EFI_IMAGE_OPTIONAL_HEADER_UNION*)(Section + 1);\r
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
203	Section = (EFI_COMMON_SECTION_HEADER )((UINT8 )Section + SectionLength);\r
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
216	if (!EFI_ERROR(Status) && ((VOID*)ImageContext->DebugDirectoryEntryRva != NULL)) {\r
217	ImageAddress = ImageContext->ImageAddress;\r
218	if (ImageContext->IsTeImage) {\r
219	ImageAddress += sizeof (EFI_TE_IMAGE_HEADER) - ((EFI_TE_IMAGE_HEADER*)EfiImage)->StrippedSize;\r
220	}\r
221	\r
222	DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY*)(ImageAddress + ImageContext->DebugDirectoryEntryRva);\r
223	if (DebugEntry->Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
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	case CODEVIEW_SIGNATURE_RSDS:\r
229	ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);\r
230	case CODEVIEW_SIGNATURE_MTOC:\r
231	ImageContext->PdbPointer = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY);\r
232	break;\r
233	default:\r
234	break;\r
235	}\r
236	}\r
237	}\r
238	\r
239	return Status;\r
240	}\r
241	\r
242	/**\r
243	Initialize debug agent.\r
244	\r
245	This function is used to set up debug environment to support source level debugging.\r
246	If certain Debug Agent Library instance has to save some private data in the stack,\r
247	this function must work on the mode that doesn't return to the caller, then\r
248	the caller needs to wrap up all rest of logic after InitializeDebugAgent() into one\r
249	function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is\r
250	responsible to invoke the passing-in function at the end of InitializeDebugAgent().\r
251	\r
252	If the parameter Function is not NULL, Debug Agent Libary instance will invoke it by\r
253	passing in the Context to be its parameter.\r
254	\r
255	If Function() is NULL, Debug Agent Library instance will return after setup debug\r
256	environment.\r
257	\r
258	@param[in] InitFlag Init flag is used to decide the initialize process.\r
259	@param[in] Context Context needed according to InitFlag; it was optional.\r
260	@param[in] Function Continue function called by debug agent library; it was\r
261	optional.\r
262	\r
263	**/\r
264	VOID\r
265	EFIAPI\r
266	InitializeDebugAgent (\r
267	IN UINT32 InitFlag,\r
268	IN VOID *Context, OPTIONAL\r
269	IN DEBUG_AGENT_CONTINUE Function OPTIONAL\r
270	)\r
271	{\r
272	EFI_STATUS Status;\r
273	EFI_FFS_FILE_HEADER *FfsHeader;\r
274	PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
275	\r
276	// We use InitFlag to know if DebugAgent has been intialized from\r
277	// Sec (DEBUG_AGENT_INIT_PREMEM_SEC) or PrePi (DEBUG_AGENT_INIT_POSTMEM_SEC)\r
278	// modules\r
279	if (InitFlag == DEBUG_AGENT_INIT_PREMEM_SEC) {\r
280	//\r
281	// Get the PrePi or PrePeiCore module (defined as SEC type module)\r
282	//\r
283	Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER*)PcdGet32(PcdSecureFdBaseAddress), EFI_FV_FILETYPE_SECURITY_CORE, &FfsHeader);\r
284	if (!EFI_ERROR(Status)) {\r
285	Status = GetImageContext (FfsHeader,&ImageContext);\r
286	if (!EFI_ERROR(Status)) {\r
287	PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
288	}\r
289	}\r
290	} else if (InitFlag == DEBUG_AGENT_INIT_POSTMEM_SEC) {\r
291	//\r
292	// Get the PrePi or PrePeiCore module (defined as SEC type module)\r
293	//\r
294	Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER*)PcdGet32(PcdNormalFvBaseAddress), EFI_FV_FILETYPE_SECURITY_CORE, &FfsHeader);\r
295	if (!EFI_ERROR(Status)) {\r
296	Status = GetImageContext (FfsHeader,&ImageContext);\r
297	if (!EFI_ERROR(Status)) {\r
298	PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
299	}\r
300	}\r
301	\r
302	//\r
303	// Get the PeiCore module (defined as PEI_CORE type module)\r
304	//\r
305	Status = GetFfsFile ((EFI_FIRMWARE_VOLUME_HEADER*)PcdGet32(PcdNormalFvBaseAddress), EFI_FV_FILETYPE_PEI_CORE, &FfsHeader);\r
306	if (!EFI_ERROR(Status)) {\r
307	Status = GetImageContext (FfsHeader,&ImageContext);\r
308	if (!EFI_ERROR(Status)) {\r
309	PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r
310	}\r
311	}\r
312	}\r
313	}\r
314	\r
315	/**\r
316	Enable/Disable the interrupt of debug timer and return the interrupt state\r
317	prior to the operation.\r
318	\r
319	If EnableStatus is TRUE, enable the interrupt of debug timer.\r
320	If EnableStatus is FALSE, disable the interrupt of debug timer.\r
321	\r
322	@param[in] EnableStatus Enable/Disable.\r
323	\r
324	@return FALSE always.\r
325	\r
326	**/\r
327	BOOLEAN\r
328	EFIAPI\r
329	SaveAndSetDebugTimerInterrupt (\r
330	IN BOOLEAN EnableStatus\r
331	)\r
332	{\r
333	return FALSE;\r
334	}\r
335	\r