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

2 files changed, 149 insertions, 0 deletions

diff --git a/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.c b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.c
new file mode 100644
index 0000000000..99bb2fdedb
--- /dev/null
+++ b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.c
@@ -0,0 +1,101 @@
+/** @file

+  Initialize Debug Agent in DXE by invoking Debug Agent Library.

+

+Copyright (c) 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        

+http://opensource.org/licenses/bsd-license.php                                            

+                                                                                          

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+**/

+

+#include <PiDxe.h>

+#include <Guid/EventGroup.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/DebugAgentLib.h>

+

+EFI_EVENT       mExitBootServiceEvent; 

+

+/**

+  One notified function to disable Debug Timer interrupt when gBS->ExitBootServices() called.

+

+  @param[in]  Event              Pointer to this event

+  @param[in]  Context            Event hanlder private data

+

+**/

+VOID

+EFIAPI

+DisableDebugTimerExitBootService (

+  EFI_EVENT                      Event,

+  VOID                           *Context

+  )

+

+{

+  SaveAndSetDebugTimerInterrupt (FALSE);

+}

+

+/**

+  The Entry Point for Debug Agent Dxe driver.

+

+  It will invoke Debug Agent Library to enable source debugging feature in DXE phase.

+

+  @param[in] ImageHandle    The firmware allocated handle for the EFI image.

+  @param[in] SystemTable    A pointer to the EFI System Table.

+

+  @retval EFI_SUCCESS       The entry point is executed successfully.

+  @retval other             Some error occurs when initialzed Debug Agent.

+

+**/

+EFI_STATUS

+EFIAPI

+DebugAgentDxeInitialize(

+  IN EFI_HANDLE           ImageHandle,

+  IN EFI_SYSTEM_TABLE     *SystemTable

+  )

+{

+  EFI_STATUS      Status;

+

+  InitializeDebugAgent (DEBUG_AGENT_INIT_DXE_LOAD, &Status, NULL);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+  //

+  // Create event to disable Debug Timer interrupt when exit boot service.

+  //

+  Status = gBS->CreateEventEx (

+                  EVT_NOTIFY_SIGNAL,

+                  TPL_NOTIFY,

+                  DisableDebugTimerExitBootService,

+                  NULL,

+                  &gEfiEventExitBootServicesGuid,

+                  &mExitBootServiceEvent

+                  );

+  return Status;

+}

+

+/**

+  This is the unload handle for Debug Agent Dxe driver.

+

+  It will invoke Debug Agent Library to disable source debugging feature.

+

+  @param[in]  ImageHandle       The drivers' driver image.

+

+  @retval EFI_SUCCESS           The image is unloaded.

+  @retval Others                Failed to unload the image.

+

+**/

+EFI_STATUS

+EFIAPI

+DebugAgentDxeUnload (

+  IN EFI_HANDLE           ImageHandle

+  )

+{

+  EFI_STATUS          Status;

+

+  InitializeDebugAgent (DEBUG_AGENT_INIT_DXE_UNLOAD, &Status, NULL);

+

+  return Status;

+}

diff --git a/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf
new file mode 100644
index 0000000000..114b708a8d
--- /dev/null
+++ b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf
@@ -0,0 +1,48 @@
+## @file

+#  Initialized Debug Agent in one separated DXE driver.

+#

+#  This DXE driver will invoke Debug Agent Library to initialize the debug agent.

+#

+# Copyright (c) 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

+# http://opensource.org/licenses/bsd-license.php

+#

+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = DebugAgentDxe

+  FILE_GUID                      = 9727502C-034E-472b-8E1B-67BB28C6CFDB

+  MODULE_TYPE                    = DXE_DRIVER

+  VERSION_STRING                 = 1.0  

+  ENTRY_POINT                    = DebugAgentDxeInitialize

+  UNLOAD_IMAGE                   = DebugAgentDxeUnload

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64

+#

+

+[Sources]

+  DebugAgentDxe.c

+  

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+[LibraryClasses]

+  UefiDriverEntryPoint

+  UefiBootServicesTableLib

+  DebugAgentLib  

+

+[Guids]

+  gEfiEventExitBootServicesGuid                 ## SOMETIMES_CONSUMES ## Event

+

+[Depex]

+  TRUE