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 OPTIONAL, IN DEBUG_AGENT_CONTINUE Function OPTIONAL)

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

Definition in file DebugAgentLib.h.

Macro Definition Documentation

◆ DEBUG_AGENT_INIT_DXE_AP

#define DEBUG_AGENT_INIT_DXE_AP 8

Definition at line 19 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_DXE_CORE

#define DEBUG_AGENT_INIT_DXE_CORE 3

Definition at line 14 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_DXE_LOAD

#define DEBUG_AGENT_INIT_DXE_LOAD 10

Definition at line 21 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_DXE_UNLOAD

#define DEBUG_AGENT_INIT_DXE_UNLOAD 11

Definition at line 22 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_ENTER_SMI

#define DEBUG_AGENT_INIT_ENTER_SMI 5

Definition at line 16 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_EXIT_SMI

#define DEBUG_AGENT_INIT_EXIT_SMI 6

Definition at line 17 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_PEI

#define DEBUG_AGENT_INIT_PEI 9

Definition at line 20 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_POSTMEM_SEC

#define DEBUG_AGENT_INIT_POSTMEM_SEC 2

Definition at line 13 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_PREMEM_SEC

#define DEBUG_AGENT_INIT_PREMEM_SEC 1

Definition at line 12 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_S3

#define DEBUG_AGENT_INIT_S3 7

Definition at line 18 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_SMM

#define DEBUG_AGENT_INIT_SMM 4

Definition at line 15 of file DebugAgentLib.h.

◆ DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64

#define DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64 12

Definition at line 23 of file DebugAgentLib.h.

Typedef Documentation

◆ DEBUG_AGENT_CONTINUE

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().

Definition at line 42 of file DebugAgentLib.h.

Function Documentation

◆ InitializeDebugAgent()

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

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.

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.

If InitFlag is DEBUG_AGENT_INIT_SMM, Context must point to a BOOLEAN if it's not NULL, which indicates SMM Debug Agent supported or not.

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.

Initialize debug agent.

This function is used to set up debug environment for DXE phase.

If this function is called by DXE Core, Context must be the pointer to HOB list which will be used to get GUIDed HOB. It will enable interrupt to support break-in feature. If this function is called by DXE module, Context must be NULL. It will enable interrupt to support break-in feature.

Parameters

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

Initialize debug agent.

This function is used to set up debug environment for SEC and PEI phase.

If InitFlag is DEBUG_AGENT_INIT_PREMEM_SEC, it will override IDT table entries and initialize debug port. It will enable interrupt to support break-in feature. It will set up debug agent Mailbox in cache-as-ramfrom. It will be called before physical memory is ready. If InitFlag is DEBUG_AGENT_INIT_POSTMEM_SEC, debug agent will build one GUIDed HOB to copy debug agent Mailbox. It will be called after physical memory is ready.

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.

Initialize debug agent.

This function is used to set up debug environment for source level debug in SMM code.

If InitFlag is DEBUG_AGENT_INIT_SMM, it will override IDT table entries and initialize debug port. It will get debug agent Mailbox from GUIDed HOB, it it exists, debug agent wiil copied it into the local Mailbox in SMM space. it will override IDT table entries and initialize debug port. Context must point to a BOOLEAN if it's not NULL, which indicates SMM Debug Agent supported or not. If InitFlag is DEBUG_AGENT_INIT_ENTER_SMI, debug agent will save Debug Registers and get local Mailbox in SMM space. Context will be NULL. If InitFlag is DEBUG_AGENT_INIT_EXIT_SMI, debug agent will restore Debug Registers. Context will be NULL.

Parameters

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

Definition at line 268 of file DebugAgentSymbolsBaseLib.c.

◆ SaveAndSetDebugTimerInterrupt()

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.

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.

Returns: FALSE always.

Definition at line 331 of file DebugAgentSymbolsBaseLib.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ DEBUG_AGENT_INIT_DXE_AP

◆ DEBUG_AGENT_INIT_DXE_CORE

◆ DEBUG_AGENT_INIT_DXE_LOAD

◆ DEBUG_AGENT_INIT_DXE_UNLOAD

◆ DEBUG_AGENT_INIT_ENTER_SMI

◆ DEBUG_AGENT_INIT_EXIT_SMI

◆ DEBUG_AGENT_INIT_PEI

◆ DEBUG_AGENT_INIT_POSTMEM_SEC

◆ DEBUG_AGENT_INIT_PREMEM_SEC

◆ DEBUG_AGENT_INIT_S3

◆ DEBUG_AGENT_INIT_SMM

◆ DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64

Typedef Documentation

◆ DEBUG_AGENT_CONTINUE

Function Documentation

◆ InitializeDebugAgent()

◆ SaveAndSetDebugTimerInterrupt()