4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Debug Agent Library provide source-level debug capability.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __DEBUG_AGENT_LIB_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __DEBUG_AGENT_LIB_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_PREMEM_SEC 1
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_POSTMEM_SEC 2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_DXE_CORE 3
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_SMM 4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_ENTER_SMI 5
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_EXIT_SMI 6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_S3 7
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DEBUG_AGENT_INIT_DXE_AP 8
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Context for DEBUG_AGENT_INIT_POSTMEM_SEC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN HeapMigrateOffset;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN StackMigrateOffset;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} DEBUG_AGENT_CONTEXT_POSTMEM_SEC;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Caller provided function to be invoked at the end of InitializeDebugAgent().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Refer to the descrption for InitializeDebugAgent() for more details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The first input parameter of InitializeDebugAgent().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI * DEBUG_AGENT_CONTINUE)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize debug agent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to set up debug environment to support source level debugging.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If certain Debug Agent Library instance has to save some private data in the stack,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function must work on the mode that doesn't return to the caller, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the caller needs to wrap up all rest of logic after InitializeDebugAgent() into one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsible to invoke the passing-in function at the end of InitializeDebugAgent().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the parameter Function is not NULL, Debug Agent Libary instance will invoke it by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync passing in the Context to be its parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Function() is NULL, Debug Agent Library instance will return after setup debug
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] InitFlag Init flag is used to decide the initialize process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context Context needed according to InitFlag; it was optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Function Continue function called by debug agent library; it was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncInitializeDebugAgent (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 InitFlag,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN DEBUG_AGENT_CONTINUE Function OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enable/Disable the interrupt of debug timer and return the interrupt state
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prior to the operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EnableStatus is TRUE, enable the interrupt of debug timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EnableStatus is FALSE, disable the interrupt of debug timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] EnableStatus Enable/Disable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Debug timer interrupt were enabled on entry to this call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE Debug timer interrupt were disabled on entry to this call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncBOOLEAN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSaveAndSetDebugTimerInterrupt (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN EnableStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif