DebugAgentLib.h File Reference

Data Structures
struct	DEBUG_AGENT_CONTEXT_POSTMEM_SEC

Macros
#define	DEBUG_AGENT_INIT_PREMEM_SEC   1
#define	DEBUG_AGENT_INIT_POSTMEM_SEC   2
#define	DEBUG_AGENT_INIT_DXE_CORE   3
#define	DEBUG_AGENT_INIT_SMM   4
#define	DEBUG_AGENT_INIT_ENTER_SMI   5
#define	DEBUG_AGENT_INIT_EXIT_SMI   6
#define	DEBUG_AGENT_INIT_S3   7
#define	DEBUG_AGENT_INIT_DXE_AP   8
#define	DEBUG_AGENT_INIT_PEI   9
#define	DEBUG_AGENT_INIT_DXE_LOAD   10
#define	DEBUG_AGENT_INIT_DXE_UNLOAD   11
#define	DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64   12

Typedefs
typedef VOID(EFIAPI *	DEBUG_AGENT_CONTINUE )(IN VOID *Context)

Functions
VOID EFIAPI	InitializeDebugAgent (IN UINT32 InitFlag, IN VOID *Context, IN DEBUG_AGENT_CONTINUE Function)
BOOLEAN EFIAPI	SaveAndSetDebugTimerInterrupt (IN BOOLEAN EnableStatus)

Detailed Description

Debug Agent Library provide source-level debug capability.

Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define DEBUG_AGENT_INIT_DXE_AP   8

#define DEBUG_AGENT_INIT_DXE_CORE   3

#define DEBUG_AGENT_INIT_DXE_LOAD   10

#define DEBUG_AGENT_INIT_DXE_UNLOAD   11

#define DEBUG_AGENT_INIT_ENTER_SMI   5

#define DEBUG_AGENT_INIT_EXIT_SMI   6

#define DEBUG_AGENT_INIT_PEI   9

#define DEBUG_AGENT_INIT_POSTMEM_SEC   2

#define DEBUG_AGENT_INIT_PREMEM_SEC   1

#define DEBUG_AGENT_INIT_S3   7

#define DEBUG_AGENT_INIT_SMM   4

#define DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64   12

Typedef Documentation

typedef VOID(EFIAPI * DEBUG_AGENT_CONTINUE)(IN VOID *Context)

Caller provided function to be invoked at the end of InitializeDebugAgent().

Refer to the description for InitializeDebugAgent() for more details.

Parameters

[in]

Context

The first input parameter of InitializeDebugAgent().

Function Documentation

VOID EFIAPI InitializeDebugAgent	(	IN UINT32	InitFlag,
		IN VOID *	Context,
		IN DEBUG_AGENT_CONTINUE	Function
	)

Initialize debug agent.

This function is used to set up debug environment to support source level debugging. If certain Debug Agent Library instance has to save some private data in the stack, this function must work on the mode that doesn't return to the caller, then the caller needs to wrap up all rest of logic after InitializeDebugAgent() into one function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is responsible to invoke the passing-in function at the end of InitializeDebugAgent().

If the parameter Function is not NULL, Debug Agent Library instance will invoke it by passing in the Context to be its parameter.

If Function() is NULL, Debug Agent Library instance will return after setup debug environment.

Parameters

[in]	InitFlag	Init flag is used to decide the initialize process.
[in]	Context	Context needed according to InitFlag; it was optional.
[in]	Function	Continue function called by debug agent library; it was optional.

BOOLEAN EFIAPI SaveAndSetDebugTimerInterrupt

(

IN BOOLEAN

EnableStatus

)

Enable/Disable the interrupt of debug timer and return the interrupt state prior to the operation.

If EnableStatus is TRUE, enable the interrupt of debug timer. If EnableStatus is FALSE, disable the interrupt of debug timer.

Parameters

[in]

EnableStatus

Enable/Disable.

Return values

TRUE	Debug timer interrupt were enabled on entry to this call.
FALSE	Debug timer interrupt were disabled on entry to this call.