This revision can only work with Intel(c) UDK Debugger Tool version 1.3 or greater. Detailed change log is as below:

1. Add DebugAgentPei driver to initialize Debug Agent in PEI phase.
   Add DebugAgentDxe driver to initialize Debug Agent in DXE phase.
   DebugAgentDxe driver could be loaded and unloaded in shell.
2. Update the SourceLevelDebugPkg so that the debug agent can be initialized in any phase: SEC, PEI or DXE.
3. Add an enhanced retry algorithm that provides a robust connection when data loss happens in the debug channel.
4. Clear DR7 register in exception handler.
5. Set the default serial port parameter to 0 instead of PCDs.
6. Build pointer of Mailbox in HOB instead of Mailbox itself, since HOB may be moved at DXE entry point function.
7. Raise TPL to prevent recursion from EFI timer interrupts in SerialIo.c.
8. Add one spin lock for accessing Mailbox when MP debugging supported.
9. Use more non-NULL library instances in SourceLevelDebugPkg DSC file, thus DebugAgentDxe.efi built from SourceLevelDebugPkg could work in shell.
10.Separate all operations about IDT table entry from SecDebugAgentLib.c into DebugAgent\DebugAgentCommon's arch sub-directory.
11.Enhance Debug Agent to avoid breaking by hardware SMI during DXE debugging phase.
12.Add supporting on mode switch code debugging.
13.Remove reset Host Controller operation in DebugCommunicationLibUsb.c to avoid impacting EDKII usb stack.
14.Fix debug timer interrupt missing issue after back from legacy code.

Signed-off-by: Jeff Fan <jeff.fan@intel.com>
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Signed-off-by: Feng Tian <feng.tian@intel.com>
Reviewed-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Feng Tian <feng.tian@intel.com>


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@14083 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 178 insertions, 15 deletions

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgent/SmmDebugAgentLib.c b/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgent/SmmDebugAgentLib.c
index 3326c0a05f..145fee0fa5 100644
--- a/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgent/SmmDebugAgentLib.c
+++ b/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgent/SmmDebugAgentLib.c
@@ -1,7 +1,7 @@
 /** @file

   Debug Agent library implementition.

 

-  Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -17,7 +17,25 @@
 DEBUG_AGENT_MAILBOX         *mMailboxPointer = NULL;

 DEBUG_AGENT_MAILBOX         mLocalMailbox;

 UINTN                       mSavedDebugRegisters[6];

-CONST BOOLEAN               MultiProcessorDebugSupport = FALSE;

+IA32_IDT_GATE_DESCRIPTOR    mIdtEntryTable[33];

+BOOLEAN                     mSkipBreakpoint = FALSE;

+

+CHAR8 mWarningMsgIgnoreSmmEntryBreak[] = "Ignore smmentrybreak setting for SMI issued during DXE debugging!\r\n";

+

+/**

+  Check if debug agent support multi-processor.

+

+  @retval TRUE    Multi-processor is supported.

+  @retval FALSE   Multi-processor is not supported.

+

+**/

+BOOLEAN

+MultiProcessorDebugSupport (

+  VOID

+  )

+{

+  return FALSE;

+}

 

 /**

   Read the Attach/Break-in symbols from the debug port.

@@ -42,6 +60,32 @@ DebugReadBreakSymbol (
 }

 

 /**

+  Get the pointer to Mailbox from the GUIDed HOB.

+

+  @return Pointer to Mailbox.

+

+**/

+DEBUG_AGENT_MAILBOX *

+GetMailboxFromHob (

+  VOID

+  )

+{

+  EFI_HOB_GUID_TYPE        *GuidHob;

+  UINT64                   *MailboxLocation;  

+  DEBUG_AGENT_MAILBOX      *Mailbox;

+

+  GuidHob = GetFirstGuidHob (&gEfiDebugAgentGuid);

+  if (GuidHob == NULL) {

+    return NULL;

+  }

+  MailboxLocation = (UINT64 *) (GET_GUID_HOB_DATA(GuidHob));

+  Mailbox = (DEBUG_AGENT_MAILBOX *)(UINTN)(*MailboxLocation);

+  VerifyMailboxChecksum (Mailbox);

+  

+  return Mailbox;

+}

+

+/**

   Get Debug Agent Mailbox pointer.

 

   @return Mailbox pointer.

@@ -52,6 +96,7 @@ GetMailboxPointer (
   VOID

   )

 {

+  VerifyMailboxChecksum (mMailboxPointer);

   return mMailboxPointer;

 }

 

@@ -66,7 +111,7 @@ GetDebugPortHandle (
   VOID

   )

 {

-  return (DEBUG_PORT_HANDLE) (UINTN)(mMailboxPointer->DebugPortHandle);

+  return (DEBUG_PORT_HANDLE) (UINTN)(GetMailboxPointer()->DebugPortHandle);

 }

 

 /**

@@ -134,16 +179,76 @@ InitializeDebugAgent (
   IN DEBUG_AGENT_CONTINUE  Function  OPTIONAL

   )

 {

-  EFI_STATUS               Status;

-  UINT64                   DebugPortHandle;

+  EFI_STATUS                    Status;

+  UINT64                        DebugPortHandle;

+  IA32_IDT_GATE_DESCRIPTOR      IdtEntry[33];

+  IA32_DESCRIPTOR               IdtDescriptor;

+  IA32_DESCRIPTOR               *Ia32Idtr;

+  IA32_IDT_ENTRY                *Ia32IdtEntry;

+  IA32_DESCRIPTOR               Idtr;

+  UINT16                        IdtEntryCount;

+  DEBUG_AGENT_MAILBOX           *Mailbox;

+  UINT64                        *MailboxLocation;

 

   switch (InitFlag) {

   case DEBUG_AGENT_INIT_SMM:

-    Status = EfiGetSystemConfigurationTable (&gEfiDebugAgentGuid, (VOID **) &mMailboxPointer);

-    if (EFI_ERROR (Status) || mMailboxPointer == NULL) {

-      ZeroMem (&mLocalMailbox, sizeof (DEBUG_AGENT_MAILBOX));

-      mMailboxPointer = &mLocalMailbox;

+    //

+    // Check if Debug Agent initialized in DXE phase

+    //

+    Status = EfiGetSystemConfigurationTable (&gEfiDebugAgentGuid, (VOID **) &Mailbox);

+    if (Status == EFI_SUCCESS && Mailbox != NULL) {

+      VerifyMailboxChecksum (Mailbox);

+      mMailboxPointer = Mailbox;

+      break;

     }

+    //

+    // Check if Debug Agent initialized in SEC/PEI phase

+    //

+    Mailbox = GetMailboxFromHob (); 

+    if (Mailbox != NULL) {

+      mMailboxPointer = Mailbox;

+      break;

+    }

+    //

+    // Debug Agent was not initialized before, uset the local mailbox.

+    //

+    ZeroMem (&mLocalMailbox, sizeof (DEBUG_AGENT_MAILBOX));

+    Mailbox = &mLocalMailbox;

+    //

+    // Save original IDT entries

+    //

+    AsmReadIdtr (&IdtDescriptor);      

+    CopyMem (&IdtEntry, (VOID *)IdtDescriptor.Base, 33 * sizeof(IA32_IDT_GATE_DESCRIPTOR));

+    //

+    // Initialized Debug Agent

+    //

+    InitializeDebugIdt ();

+    DebugPortHandle = (UINT64) (UINTN)DebugPortInitialize ((DEBUG_PORT_HANDLE) (UINTN)Mailbox->DebugPortHandle, NULL);

+    UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_DEBUG_PORT_HANDLE_INDEX, DebugPortHandle);

+    mMailboxPointer = Mailbox;

+    //

+    // Trigger one software interrupt to inform HOST

+    //

+    TriggerSoftInterrupt (SYSTEM_RESET_SIGNATURE);

+

+    SetDebugFlag (DEBUG_AGENT_FLAG_MEMORY_READY, 1);

+    //

+    // Memory has been ready

+    //

+    if (IsHostAttached ()) {

+      //

+      // Trigger one software interrupt to inform HOST

+      //

+      TriggerSoftInterrupt (MEMORY_READY_SIGNATURE);

+    }

+    //

+    // Find and report PE/COFF image info to HOST

+    //  

+    FindAndReportModuleImageInfo (SIZE_4KB);

+    //

+    // Restore saved IDT entries

+    //     

+    CopyMem ((VOID *)IdtDescriptor.Base, &IdtEntry, 33 * sizeof(IA32_IDT_GATE_DESCRIPTOR));

 

     break;

 

@@ -151,14 +256,24 @@ InitializeDebugAgent (
     SaveDebugRegister ();

     InitializeDebugIdt ();

 

-    if (mMailboxPointer != NULL) {

+    Mailbox = GetMailboxPointer ();

+    if (GetDebugFlag (DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS) == 1) {

       //

-      // Initialize debug communication port

+      // If Debug Agent has been communicaton state with HOST, we need skip

+      // any break points set in SMM, set Skip Breakpoint flag

       //

-      DebugPortHandle = (UINT64) (UINTN)DebugPortInitialize ((DEBUG_PORT_HANDLE) (UINTN)mMailboxPointer->DebugPortHandle, NULL);

-      mMailboxPointer->DebugPortHandle = DebugPortHandle;

-

-      if (mMailboxPointer->DebugFlag.BreakOnNextSmi == 1) {

+      mSkipBreakpoint = TRUE;

+    }

+    if (GetDebugFlag (DEBUG_AGENT_FLAG_BREAK_ON_NEXT_SMI) == 1) {

+      if (mSkipBreakpoint) {

+        //

+        // Print warning message if ignore smm entry break

+        //

+        DebugPortWriteBuffer ((DEBUG_PORT_HANDLE) (UINTN)Mailbox->DebugPortHandle,

+                               (UINT8 *)mWarningMsgIgnoreSmmEntryBreak,

+                               AsciiStrLen (mWarningMsgIgnoreSmmEntryBreak)

+                               );

+      } else {

         //

         // If SMM entry break is set, SMM code will be break at here.

         //

@@ -168,8 +283,56 @@ InitializeDebugAgent (
     break;

 

   case DEBUG_AGENT_INIT_EXIT_SMI:

+    Mailbox = GetMailboxPointer ();

+    //

+    // Clear Skip Breakpoint flag

+    //

+    mSkipBreakpoint = FALSE;

     RestoreDebugRegister ();

     break;

+

+  case DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64:

+    if (Context == NULL) {

+      DEBUG ((EFI_D_ERROR, "DebugAgent: Input parameter Context cannot be NULL!\n"));

+      CpuDeadLoop ();

+    } else {

+      Ia32Idtr =  (IA32_DESCRIPTOR *) Context;

+      Ia32IdtEntry = (IA32_IDT_ENTRY *)(Ia32Idtr->Base);

+      MailboxLocation = (UINT64 *) (UINTN) (Ia32IdtEntry[DEBUG_MAILBOX_VECTOR].Bits.OffsetLow + 

+                                           (Ia32IdtEntry[DEBUG_MAILBOX_VECTOR].Bits.OffsetHigh << 16));

+      mMailboxPointer = (DEBUG_AGENT_MAILBOX *)(UINTN)(*MailboxLocation);

+      VerifyMailboxChecksum (mMailboxPointer);

+      //

+      // Get original IDT address and size.

+      //

+      AsmReadIdtr ((IA32_DESCRIPTOR *) &Idtr);

+      IdtEntryCount = (UINT16) ((Idtr.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR));

+      if (IdtEntryCount < 33) {

+        Idtr.Limit = (UINT16) (sizeof (IA32_IDT_GATE_DESCRIPTOR) * 33 - 1);

+        Idtr.Base  = (UINTN) &mIdtEntryTable;

+        ZeroMem (&mIdtEntryTable, Idtr.Limit + 1);

+        AsmWriteIdtr ((IA32_DESCRIPTOR *) &Idtr);

+      }

+

+      InitializeDebugIdt ();

+      //

+      // Initialize Debug Timer hardware and enable interrupt.

+      //

+      InitializeDebugTimer ();

+      EnableInterrupts ();

+

+      FindAndReportModuleImageInfo (SIZE_4KB);

+    }

+    break;

+

+  default:

+    //

+    // Only DEBUG_AGENT_INIT_PREMEM_SEC and DEBUG_AGENT_INIT_POSTMEM_SEC are allowed for this 

+    // Debug Agent library instance.

+    //

+    DEBUG ((EFI_D_ERROR, "Debug Agent: The InitFlag value is not allowed!\n"));

+    CpuDeadLoop ();

+    break;    

   }

 }