This revision can only work with Intel(c) UDK Debugger Tool version 1.2 or greater...

[mirror_edk2.git] / SourceLevelDebugPkg / Library / DebugAgent / SmmDebugAgent / SmmDebugAgentLib.c

/** @file\r
  Debug Agent library implementition.\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
#include "SmmDebugAgentLib.h"\r
\r
DEBUG_AGENT_MAILBOX         *mMailboxPointer = NULL;\r
DEBUG_AGENT_MAILBOX         mLocalMailbox;\r
UINTN                       mSavedDebugRegisters[6];\r
CONST BOOLEAN               MultiProcessorDebugSupport = FALSE;\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
  // Smm instance has no debug timer to poll break symbol.\r
  //\r
  return EFI_NOT_FOUND;\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
  return mMailboxPointer;\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
  return (DEBUG_PORT_HANDLE) (UINTN)(mMailboxPointer->DebugPortHandle);\r
}\r
\r
/**\r
  Store debug register when SMI exit.\r
\r
**/\r
VOID\r
SaveDebugRegister (\r
  VOID\r
  )\r
{\r
  mSavedDebugRegisters[0] = AsmReadDr0 ();\r
  mSavedDebugRegisters[1] = AsmReadDr1 ();\r
  mSavedDebugRegisters[2] = AsmReadDr2 ();\r
  mSavedDebugRegisters[3] = AsmReadDr3 ();\r
  mSavedDebugRegisters[4] = AsmReadDr6 ();\r
  mSavedDebugRegisters[5] = AsmReadDr7 ();\r
}\r
\r
/**\r
  Restore debug register when SMI exit.\r
\r
**/\r
VOID\r
RestoreDebugRegister (\r
  VOID\r
  )\r
{\r
  AsmWriteDr7 (0);\r
  AsmWriteDr0 (mSavedDebugRegisters[0]);\r
  AsmWriteDr1 (mSavedDebugRegisters[1]);\r
  AsmWriteDr2 (mSavedDebugRegisters[2]);\r
  AsmWriteDr3 (mSavedDebugRegisters[3]);\r
  AsmWriteDr6 (mSavedDebugRegisters[4]);\r
  AsmWriteDr7 (mSavedDebugRegisters[5]);\r
}\r
\r
/**\r
  Initialize debug agent.\r
\r
  This function is used to set up debug enviroment for source level debug\r
  in SMM code.\r
\r
  If InitFlag is DEBUG_AGENT_INIT_SMM, it will overirde IDT table entries\r
  and initialize debug port. It will get debug agent Mailbox from GUIDed HOB,\r
  it it exists, debug agent wiil copied it into the local Mailbox in SMM space.\r
  it will overirde IDT table entries and initialize debug port. Context will be\r
  NULL.\r
  If InitFlag is DEBUG_AGENT_INIT_ENTER_SMI, debug agent will save Debug\r
  Registers and get local Mailbox in SMM space. Context will be NULL.\r
  If InitFlag is DEBUG_AGENT_INIT_EXIT_SMI, debug agent will restore Debug\r
  Registers. Context will be NULL.\r
\r
  @param[in] InitFlag     Init flag is used to decide initialize process.\r
  @param[in] Context      Context needed according to InitFlag.\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
  UINT64                   DebugPortHandle;\r
\r
  switch (InitFlag) {\r
  case DEBUG_AGENT_INIT_SMM:\r
    Status = EfiGetSystemConfigurationTable (&gEfiDebugAgentGuid, (VOID **) &mMailboxPointer);\r
    if (EFI_ERROR (Status) || mMailboxPointer == NULL) {\r
      ZeroMem (&mLocalMailbox, sizeof (DEBUG_AGENT_MAILBOX));\r
      mMailboxPointer = &mLocalMailbox;\r
    }\r
\r
    break;\r
\r
  case DEBUG_AGENT_INIT_ENTER_SMI:\r
    SaveDebugRegister ();\r
    InitializeDebugIdt ();\r
\r
    if (mMailboxPointer != NULL) {\r
      //\r
      // Initialize debug communication port\r
      //\r
      DebugPortHandle = (UINT64) (UINTN)DebugPortInitialize ((DEBUG_PORT_HANDLE) (UINTN)mMailboxPointer->DebugPortHandle, NULL);\r
      mMailboxPointer->DebugPortHandle = DebugPortHandle;\r
\r
      if (mMailboxPointer->DebugFlag.BreakOnNextSmi == 1) {\r
        //\r
        // If SMM entry break is set, SMM code will be break at here.\r
        //\r
        CpuBreakpoint ();\r
      }\r
    }\r
    break;\r
\r
  case DEBUG_AGENT_INIT_EXIT_SMI:\r
    RestoreDebugRegister ();\r
    break;\r
  }\r
}\r
\r