From: Jeff Fan <jeff.fan@intel.com>
Date: Mon, 27 Apr 2015 05:26:03 +0000 (+0000)
Subject: SourceLevelDebugPkg/DebugAgent: Add some comments and debug message
X-Git-Tag: edk2-stable201903~10008
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=bbeacc5816fd474937dd35d44c91fbf24403c374;p=mirror_edk2.git

SourceLevelDebugPkg/DebugAgent: Add some comments and debug message

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17206 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
index 7f597352f1..3daa6336cb 100644
--- a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
+++ b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
@@ -1335,8 +1335,12 @@ GetBreakCause (
       if ((CpuContext->Dr6 & BIT14) != 0) {
         Cause = DEBUG_DATA_BREAK_CAUSE_STEPPING;
         //
-        // If it's single step, no need to check DR0, to ensure single step work in PeCoffExtraActionLib
-        // (right after triggering a breakpoint to report image load/unload).
+        // DR6.BIT14 Indicates (when set) that the debug exception was
+        // triggered by the single step execution mode.
+        // The single-step mode is the highest priority debug exception.
+        // This is single step, no need to check DR0, to ensure single step
+        // work in PeCoffExtraActionLib (right after triggering a breakpoint
+        // to report image load/unload).
         //
         return Cause;
 
@@ -2392,9 +2396,16 @@ InterruptProcess (
     // Check if this exception is issued by Debug Agent itself
     // If yes, fill the debug agent exception buffer and LongJump() back to
     // the saved CPU content in CommandCommunication()
+    // If exception is issued when executing Stepping, will be handled in
+    // exception handle procedure.
     //
     if (GetDebugFlag (DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS) == 1) {
-      DebugAgentMsgPrint (DEBUG_AGENT_ERROR, "Debug agent meet one Exception, ExceptionNum is %d, EIP = 0x%x.\n", Vector, (UINTN)CpuContext->Eip);
+      DebugAgentMsgPrint (
+        DEBUG_AGENT_ERROR,
+        "Debug agent meet one Exception, ExceptionNum is %d, EIP = 0x%x.\n",
+        Vector,
+        (UINTN)CpuContext->Eip
+        );
       ExceptionBuffer = (DEBUG_AGENT_EXCEPTION_BUFFER *) (UINTN) GetMailboxPointer()->ExceptionBufferPointer;
       ExceptionBuffer->ExceptionContent.ExceptionNum  = (UINT8) Vector;
       ExceptionBuffer->ExceptionContent.ExceptionData = (UINT32) CpuContext->ExceptionData;
@@ -2604,9 +2615,16 @@ InterruptProcess (
 
   default:
     if (Vector <= DEBUG_EXCEPT_SIMD) {
+      DebugAgentMsgPrint (
+        DEBUG_AGENT_ERROR,
+        "Exception happened, ExceptionNum is %d, EIP = 0x%x.\n",
+        Vector,
+        (UINTN) CpuContext->Eip
+        );
       if (BreakCause == DEBUG_DATA_BREAK_CAUSE_STEPPING) {
         //
-        // Stepping is finished, send Ack package.
+        // If exception happened when executing Stepping, send Ack package.
+        // HOST consider Stepping command was finished.
         //
         if (MultiProcessorDebugSupport()) {
           mDebugMpContext.BreakAtCpuIndex = ProcessorIndex;