Fix infinite loop bug in secure boot UI driver.

[mirror_edk2.git] / SourceLevelDebugPkg / Library / DebugAgent / DebugAgentCommon / DebugAgent.h

/** @file\r
  Command header of for Debug Agent library instance.\r
\r
  Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\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
#ifndef _DEBUG_AGENT_H_\r
#define _DEBUG_AGENT_H_\r
\r
#include <Register/LocalApic.h>\r
\r
#include <Guid/DebugAgentGuid.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/ResetSystemLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/DebugCommunicationLib.h>\r
#include <Library/DebugAgentLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/SynchronizationLib.h>\r
#include <Library/LocalApicLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PrintLib.h>\r
\r
#include <TransferProtocol.h>\r
#include <ImageDebugSupport.h>\r
\r
#include "DebugMp.h"\r
#include "DebugTimer.h"\r
#include "ArchDebugSupport.h"\r
\r
#define DEBUG_INT1_VECTOR               1\r
#define DEBUG_INT3_VECTOR               3\r
#define DEBUG_TIMER_VECTOR              32\r
#define DEBUG_MAILBOX_VECTOR            33\r
\r
#define SOFT_INTERRUPT_SIGNATURE    SIGNATURE_32('S','O','F','T')\r
#define SYSTEM_RESET_SIGNATURE      SIGNATURE_32('S','Y','S','R')\r
#define MEMORY_READY_SIGNATURE      SIGNATURE_32('M','E','M','R')\r
\r
extern UINTN  Exception0Handle;\r
extern UINTN  TimerInterruptHandle;\r
extern UINT16 ExceptionStubHeaderSize;\r
\r
//\r
// CPU exception information issued by debug agent\r
//\r
typedef struct {\r
  //\r
  // This field is used to save CPU content before executing HOST command\r
  //\r
  BASE_LIBRARY_JUMP_BUFFER            JumpBuffer;\r
  //\r
  // This filed returens the exception information issued by HOST command\r
  //\r
  DEBUG_DATA_RESPONSE_GET_EXCEPTION   ExceptionContent;\r
} DEBUG_AGENT_EXCEPTION_BUFFER;\r
\r
#pragma pack(1)\r
typedef struct {\r
  //\r
  // Lower 32 bits to store the status of DebugAgent\r
  //\r
  UINT32  HostAttached    : 1;   // 1: HOST is attached\r
  UINT32  AgentInProgress : 1;   // 1: Debug Agent is communicating with HOST\r
  UINT32  MemoryReady     : 1;   // 1: Memory is ready\r
  UINT32  SteppingFlag    : 1;   // 1: Agent is running stepping command\r
  UINT32  Reserved1       : 28;\r
\r
  //\r
  // Higher 32bits to control the behavior of DebugAgent\r
  //\r
  UINT32  BreakOnNextSmi  : 1;   // 1: Break on next SMI\r
  UINT32  PrintErrorLevel : 8;   // Bitmask of print error level for debug message\r
  UINT32  Reserved2       : 23;\r
} DEBUG_AGENT_FLAG;\r
\r
typedef struct {\r
  DEBUG_AGENT_FLAG           DebugFlag;\r
  UINT64                     DebugPortHandle;\r
  //\r
  // Pointer to DEBUG_AGENT_EXCEPTION_BUFFER\r
  //\r
  UINT64                     ExceptionBufferPointer;\r
} DEBUG_AGENT_MAILBOX;\r
#pragma pack()\r
\r
typedef union {\r
  struct {\r
    UINT32  LimitLow    : 16;\r
    UINT32  BaseLow     : 16;\r
    UINT32  BaseMid     : 8;\r
    UINT32  Type        : 4;\r
    UINT32  System      : 1;\r
    UINT32  Dpl         : 2;\r
    UINT32  Present     : 1;\r
    UINT32  LimitHigh   : 4;\r
    UINT32  Software    : 1;\r
    UINT32  Reserved    : 1;\r
    UINT32  DefaultSize : 1;\r
    UINT32  Granularity : 1;\r
    UINT32  BaseHigh    : 8;\r
  } Bits;\r
  UINT64  Uint64;\r
} IA32_GDT;\r
\r
/**\r
  Caller provided function to be invoked at the end of DebugPortInitialize().\r
\r
  Refer to the descrption for DebugPortInitialize() for more details.\r
\r
  @param[in] Context           The first input argument of DebugPortInitialize().\r
  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Libary.\r
\r
**/\r
VOID\r
EFIAPI\r
InitializeDebugAgentPhase2 (\r
  IN VOID                  *Context,\r
  IN DEBUG_PORT_HANDLE     DebugPortHandle\r
  );\r
\r
/**\r
  Initialize IDT entries to support source level debug.\r
\r
**/\r
VOID\r
InitializeDebugIdt (\r
  VOID\r
  );\r
\r
/**\r
  Read register value from saved CPU context.\r
\r
  @param[in] CpuContext         Pointer to saved CPU context.\r
  @param[in] Index              Register index value.\r
  @param[in] Width              Data width to read.\r
\r
  @return The address of register value.\r
\r
**/\r
UINT8 *\r
ArchReadRegisterBuffer (\r
  IN DEBUG_CPU_CONTEXT               *CpuContext,\r
  IN UINT8                           Index,\r
  IN UINT8                           *Width\r
  );\r
\r
/**\r
  Send packet with response data to HOST.\r
\r
  @param[in] Data        Pointer to response data buffer.\r
  @param[in] DataSize    Size of response data in byte.\r
\r
  @retval RETURN_SUCCESS      Response data was sent successfully.\r
  @retval RETURN_DEVICE_ERROR Cannot receive DEBUG_COMMAND_OK from HOST.\r
\r
**/\r
RETURN_STATUS\r
SendDataResponsePacket (\r
  IN UINT8                *Data,\r
  IN UINT16               DataSize\r
  );\r
\r
/**\r
  Check if HOST is attached based on Mailbox.\r
\r
  @retval TRUE        HOST is attached.\r
  @retval FALSE       HOST is not attached.\r
\r
**/\r
BOOLEAN\r
IsHostAttached (\r
  VOID\r
  );\r
\r
/**\r
  Get Debug Agent Mailbox pointer.\r
\r
  @return Mailbox pointer.\r
\r
**/\r
DEBUG_AGENT_MAILBOX *\r
GetMailboxPointer (\r
  VOID\r
  );\r
\r
/**\r
  Get debug port handle.\r
\r
  @return Debug port handle.\r
\r
**/\r
DEBUG_PORT_HANDLE\r
GetDebugPortHandle (\r
  VOID\r
  );\r
\r
/**\r
  Read the Attach/Break-in symbols from the debug port.\r
\r
  @param[in]  Handle         Pointer to Debug Port handle.\r
  @param[out] BreakSymbol    Returned break symbol.\r
\r
  @retval EFI_SUCCESS        Read the symbol in BreakSymbol.\r
  @retval EFI_NOT_FOUND      No read the break symbol.\r
\r
**/\r
EFI_STATUS\r
DebugReadBreakSymbol (\r
  IN  DEBUG_PORT_HANDLE      Handle,\r
  OUT UINT8                  *BreakSymbol\r
  );\r
\r
/**\r
  Prints a debug message to the debug port if the specified error level is enabled.\r
\r
  If any bit in ErrorLevel is also set in Mainbox, then print the message specified\r
  by Format and the associated variable argument list to the debug port.\r
\r
  @param[in] ErrorLevel  The error level of the debug message.\r
  @param[in] Format      Format string for the debug message to print.\r
  @param[in] ...         Variable argument list whose contents are accessed \r
                         based on the format string specified by Format.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugAgentMsgPrint (\r
  IN UINT8         ErrorLevel,\r
  IN CHAR8         *Format,\r
  ...\r
  );\r
#endif\r
\r