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

1. Define the transfer protocol revision mechanism. Increase the revision number to 0.2 and inform user to use the latest one when the HOST software is too old.
   New HOST software will implement logic to handle all other revision mismatch cases.
2. Define new debug message packet to print the debug agent trace information by debug port channel.
3. Add check sum mechanism in the communication protocol between TARGET/HOST.
4. Introduced one "try" mechanism to avoid Debug Agent crashed by some invalid HOST command.
5. Enable the late-attach feature: Change the break in from "!" to "\xFC". Add a new short symbol "\xFA" for attach and a new debug command for detach.
6. Support Terminal work on debug port by install EFI Serial IO protocol upon Debug Communication Library.
7. Enable CPUID feature.
8. Enable the hardware data breakpoint.
9. add handshake to improve usb debug cable identify stability issue.
10.Refine all the communication protocol packet to improve extensibility and debugging performance.
  a. Use 64bit for IO port address.
  b. Add additional Width field to READ_MEMORY/WRITE_MEMORY.
  c. Add SEARCH_SIGNATURE support to speed the symbol finding for late attach.
  d. Remove READ_GROUP register.
  e. Add READ_ALL_REGISTERS support (WinDbg always requests to read all registers).
11.Move AcquireDebugPortControl () in advance to fix resource collision on IpiSentByApFlag.
12.Fix IO break point does not work issue in PEI phase.
13.Avoid BSP/APs collision when they met break point at the same time.
14.Solve a bug of calculating debug handle in sec phase.
15.Use mailbox content at Dxe phase but not clear it and reinitialize again.
16.Fix FP/MMX/XMM/IO/MSR access issue in both Gdb and WinDbg.

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@13437 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 165 insertions, 204 deletions

diff --git a/SourceLevelDebugPkg/Include/TransferProtocol.h b/SourceLevelDebugPkg/Include/TransferProtocol.h
index af80a7450c..bb7b07b4e2 100644
--- a/SourceLevelDebugPkg/Include/TransferProtocol.h
+++ b/SourceLevelDebugPkg/Include/TransferProtocol.h
@@ -17,16 +17,25 @@
 #define __TRANSFER_PROTOCOL_H__

 

 #include "ProcessorContext.h"

-#include "SoftDebuggerDefinitions.h"

+

+//

+// Current revision of transfer protocol

+//

+#define DEBUG_AGENT_REVISION            ((0 << 16) | 02)

+#define DEBUG_AGENT_CAPABILITIES        0

 

 //

 // Definitions for break command.

 //

-#define DEBUG_STARTING_SYMBOL_BREAK     (0x21)  //  '!'

-#define DEBUG_STARTING_SYMBOL_BREAK_STRING     ("!")

+#define DEBUG_STARTING_SYMBOL_BREAK         (0xFC)

+

+//

+// Definitions for attach command

+//

+#define DEBUG_STARTING_SYMBOL_ATTACH        (0xFA)

 

 //

-//  Definition for starting symbol of a normal debug packet. Choose a non-ASCII to avoid conflict with other serial output.

+// Definition for starting symbol of a normal debug packet. Choose a non-ASCII to avoid conflict with other serial output.

 //

 #define DEBUG_STARTING_SYMBOL_NORMAL    (0xFE)

 

@@ -34,22 +43,14 @@
 #pragma pack(1)

 

 //

-// Definition for common header for normal debug packets (not including break command)

+// Definition for debug packet header for normal debug packets (not including break/attach command)

 //

 typedef struct {

   UINT8                      StartSymbol;

   UINT8                      Command;

-  UINT8                      DataLength;

-} DEBUG_COMMAND_HEADER;

-

-//

-// Structure to facilitate debug packet header parsing or construction

-//

-typedef struct {

-  UINT8                      Command;

-  UINT8                      DataLength;

-} DEBUG_COMMAND_HEADER_NO_START_SYMBOL;

-

+  UINT8                      Length;    // Length of Debug Packet including header and payload in byte

+  UINT8                      CheckSum;

+} DEBUG_PACKET_HEADER;

 

 //

 // Definition for Command field for debug packets

@@ -57,103 +58,79 @@ typedef struct {
 #define DEBUG_COMMAND_REQUEST      (0 << 7)

 #define DEBUG_COMMAND_RESPONSE     (1 << 7)

 

-

-

-#define DEBUG_COMMAND_RESET                       (DEBUG_COMMAND_REQUEST | 0)  // 0

-

-#define DEBUG_COMMAND_GO                          (DEBUG_COMMAND_REQUEST | 1)  // 1

-

-#define DEBUG_COMMAND_BREAK_CAUSE                 (DEBUG_COMMAND_REQUEST | 2)  // 2

-

-#define DEBUG_COMMAND_SET_HW_BREAKPOINT           (DEBUG_COMMAND_REQUEST | 3)  // 3

-#define DEBUG_COMMAND_CLEAR_HW_BREAKPOINT         (DEBUG_COMMAND_REQUEST | 4)  // 4

-

-#define DEBUG_COMMAND_SINGLE_STEPPING             (DEBUG_COMMAND_REQUEST | 5)  // 5

-

-#define DEBUG_COMMAND_SET_SW_BREAKPOINT           (DEBUG_COMMAND_REQUEST | 6)  // 6

-#define DEBUG_COMMAND_CLEAR_SW_BREAKPOINT         (DEBUG_COMMAND_REQUEST | 7)  // 7

-

-#define DEBUG_COMMAND_READ_MEMORY_8               (DEBUG_COMMAND_REQUEST | 8)  // 8

-#define DEBUG_COMMAND_READ_MEMORY_16              (DEBUG_COMMAND_REQUEST | 9)  // 9

-#define DEBUG_COMMAND_READ_MEMORY_32              (DEBUG_COMMAND_REQUEST | 10) // 10

-#define DEBUG_COMMAND_READ_MEMORY_64              (DEBUG_COMMAND_REQUEST | 11) // 11

-

-#define DEBUG_COMMAND_WRITE_MEMORY_8              (DEBUG_COMMAND_REQUEST | 12) // 12

-#define DEBUG_COMMAND_WRITE_MEMORY_16             (DEBUG_COMMAND_REQUEST | 13) // 13

-#define DEBUG_COMMAND_WRITE_MEMORY_32             (DEBUG_COMMAND_REQUEST | 14) // 14

-#define DEBUG_COMMAND_WRITE_MEMORY_64             (DEBUG_COMMAND_REQUEST | 15) // 15

-

-#define DEBUG_COMMAND_READ_IO                     (DEBUG_COMMAND_REQUEST | 16) // 16

-#define DEBUG_COMMAND_WRITE_IO                    (DEBUG_COMMAND_REQUEST | 20) // 20

-

-#define DEBUG_COMMAND_READ_REGISTER               (DEBUG_COMMAND_REQUEST | 24) // 24

-#define DEBUG_COMMAND_WRITE_REGISTER              (DEBUG_COMMAND_REQUEST | 26) // 26

-

-#define DEBUG_COMMAND_STEP_OVER                   (DEBUG_COMMAND_REQUEST | 28) // 28

-#define DEBUG_COMMAND_STEP_OUT                    (DEBUG_COMMAND_REQUEST | 29) // 29

-#define DEBUG_COMMAND_STEP_BRANCH                 (DEBUG_COMMAND_REQUEST | 30) // 30

-

-#define DEBUG_COMMAND_ARCH_MODE                   (DEBUG_COMMAND_REQUEST | 34) // 34

-

-#define DEBUG_COMMAND_READ_MSR                    (DEBUG_COMMAND_REQUEST | 35) // 35

-#define DEBUG_COMMAND_WRITE_MSR                   (DEBUG_COMMAND_REQUEST | 36) // 36

-

-#define DEBUG_COMMAND_READ_REGISTER_GROUP         (DEBUG_COMMAND_REQUEST | 37) // 37

-

-#define DEBUG_COMMAND_SET_DEBUG_FLAG              (DEBUG_COMMAND_REQUEST | 38) // 38

-

-#define DEBUG_COMMAND_GET_REVISION                (DEBUG_COMMAND_REQUEST | 39) // 39

-

-#define DEBUG_COMMAND_GET_EXCEPTION               (DEBUG_COMMAND_REQUEST | 40) // 40

-

-#define DEBUG_COMMAND_SET_VIEWPOINT               (DEBUG_COMMAND_REQUEST | 41) // 41

-

-#define DEBUG_COMMAND_GET_VIEWPOINT               (DEBUG_COMMAND_REQUEST | 42) // 42

-

-//

-// The below are target side initiated commands.

 //

-#define DEBUG_COMMAND_INIT_BREAK                  (DEBUG_COMMAND_REQUEST | 63) // 63

-#define DEBUG_COMMAND_BREAK_POINT                 (DEBUG_COMMAND_REQUEST | 62) // 62

-#define DEBUG_COMMAND_MEMORY_READY                (DEBUG_COMMAND_REQUEST | 61) // 61

-

-#define DEBUG_COMMAND_OK                          (DEBUG_COMMAND_RESPONSE | 0)

-#define DEBUG_COMMAND_RESEND                      (DEBUG_COMMAND_RESPONSE | 1)

-#define DEBUG_COMMAND_ABORT                       (DEBUG_COMMAND_RESPONSE | 2)

-

-//

-// The below 2 commands are used when transferring big data (like > ~250 bytes). The sequence is:

-//  Host Macine                      Target Macine

-//  Request                =>

-//                         <=        IN_PROGRESS with part of the data

-//  CONTINUE               =>

-//  (could have multiple IN_PROGRESS and CONTINUE interactions)

-//                         <=        OK with the last part of data

-//  OK (no data as ACK)    =>

-//

-#define DEBUG_COMMAND_IN_PROGRESS                 (DEBUG_COMMAND_RESPONSE | 3)  // Used when trying to

-#define DEBUG_COMMAND_CONTINUE                    (DEBUG_COMMAND_RESPONSE | 4)  // Used when trying to transfer big data (like > ~250 bytes)

-

-//

-// The below 2 commands are used to support deferred halt. HALT_DEFERRED will be returned when a halt request received while target is already in inter-active mode.

-// HALT_PROCESSED will be return as a possible return value for GO command, if target has a pending halt request.

-//

-#define DEBUG_COMMAND_HALT_DEFERRED               (DEBUG_COMMAND_RESPONSE | 5)

-#define DEBUG_COMMAND_HALT_PROCESSED              (DEBUG_COMMAND_RESPONSE | 6)

-

-#define DEBUG_COMMAND_TIMEOUT                     (DEBUG_COMMAND_RESPONSE | 7)

-#define DEBUG_COMMAND_NOT_SUPPORTED               (DEBUG_COMMAND_RESPONSE | 15)

+// HOST initiated commands

+//

+#define DEBUG_COMMAND_RESET                       (DEBUG_COMMAND_REQUEST | 0x00)

+#define DEBUG_COMMAND_GO                          (DEBUG_COMMAND_REQUEST | 0x01)

+#define DEBUG_COMMAND_BREAK_CAUSE                 (DEBUG_COMMAND_REQUEST | 0x02)

+#define DEBUG_COMMAND_SET_HW_BREAKPOINT           (DEBUG_COMMAND_REQUEST | 0x03)

+#define DEBUG_COMMAND_CLEAR_HW_BREAKPOINT         (DEBUG_COMMAND_REQUEST | 0x04)

+#define DEBUG_COMMAND_SINGLE_STEPPING             (DEBUG_COMMAND_REQUEST | 0x05)

+#define DEBUG_COMMAND_SET_SW_BREAKPOINT           (DEBUG_COMMAND_REQUEST | 0x06)

+#define DEBUG_COMMAND_READ_MEMORY                 (DEBUG_COMMAND_REQUEST | 0x07)

+#define DEBUG_COMMAND_WRITE_MEMORY                (DEBUG_COMMAND_REQUEST | 0x08)

+#define DEBUG_COMMAND_READ_IO                     (DEBUG_COMMAND_REQUEST | 0x09)

+#define DEBUG_COMMAND_WRITE_IO                    (DEBUG_COMMAND_REQUEST | 0x0A)

+#define DEBUG_COMMAND_READ_REGISTER               (DEBUG_COMMAND_REQUEST | 0x0B)

+#define DEBUG_COMMAND_WRITE_REGISTER              (DEBUG_COMMAND_REQUEST | 0x0C)

+#define DEBUG_COMMAND_READ_ALL_REGISTERS          (DEBUG_COMMAND_REQUEST | 0x0D)

+#define DEBUG_COMMAND_ARCH_MODE                   (DEBUG_COMMAND_REQUEST | 0x0E)

+#define DEBUG_COMMAND_READ_MSR                    (DEBUG_COMMAND_REQUEST | 0x0F)

+#define DEBUG_COMMAND_WRITE_MSR                   (DEBUG_COMMAND_REQUEST | 0x10)

+#define DEBUG_COMMAND_SET_DEBUG_SETTING           (DEBUG_COMMAND_REQUEST | 0x11)

+#define DEBUG_COMMAND_GET_REVISION                (DEBUG_COMMAND_REQUEST | 0x12)

+#define DEBUG_COMMAND_GET_EXCEPTION               (DEBUG_COMMAND_REQUEST | 0x13)

+#define DEBUG_COMMAND_SET_VIEWPOINT               (DEBUG_COMMAND_REQUEST | 0x14)

+#define DEBUG_COMMAND_GET_VIEWPOINT               (DEBUG_COMMAND_REQUEST | 0x15)

+#define DEBUG_COMMAND_DETACH                      (DEBUG_COMMAND_REQUEST | 0x16)

+#define DEBUG_COMMAND_CPUID                       (DEBUG_COMMAND_REQUEST | 0x17)

+#define DEBUG_COMMAND_SEARCH_SIGNATURE            (DEBUG_COMMAND_REQUEST | 0x18)

+

+//

+// TARGET initiated commands

+//

+#define DEBUG_COMMAND_INIT_BREAK                  (DEBUG_COMMAND_REQUEST | 0x3F)

+#define DEBUG_COMMAND_BREAK_POINT                 (DEBUG_COMMAND_REQUEST | 0x3E)

+#define DEBUG_COMMAND_MEMORY_READY                (DEBUG_COMMAND_REQUEST | 0x3D)

+#define DEBUG_COMMAND_PRINT_MESSAGE               (DEBUG_COMMAND_REQUEST | 0x3C)

+

+//

+// Response commands

+//

+#define DEBUG_COMMAND_OK                          (DEBUG_COMMAND_RESPONSE | 0x00)

+#define DEBUG_COMMAND_RESEND                      (DEBUG_COMMAND_RESPONSE | 0x01)

+#define DEBUG_COMMAND_ABORT                       (DEBUG_COMMAND_RESPONSE | 0x02)

+//

+// The below 2 commands are used when transferring big data (like > ~250 bytes).

+// The sequence is:

+//   HOST                             TARGET

+//   Request                =>

+//                          <=        IN_PROGRESS with partial data

+//   CONTINUE               =>

+//   (could have multiple IN_PROGRESS and CONTINUE interactions)

+//                          <=        OK with the last part of data

+//   OK (no data as ACK)    =>

+//

+#define DEBUG_COMMAND_IN_PROGRESS                 (DEBUG_COMMAND_RESPONSE | 0x03)

+#define DEBUG_COMMAND_CONTINUE                    (DEBUG_COMMAND_RESPONSE | 0x04)

+//

+// The below 2 commands are used to support deferred halt:

+// TARGET returns HALT_DEFERRED when it receives a HALT request in inter-active mode.

+// TARGET returns HALT_PROCESSED when it receives a GO request and has a pending HALT request.

+//

+#define DEBUG_COMMAND_HALT_DEFERRED               (DEBUG_COMMAND_RESPONSE | 0x05)

+#define DEBUG_COMMAND_HALT_PROCESSED              (DEBUG_COMMAND_RESPONSE | 0x06)

+

+#define DEBUG_COMMAND_TIMEOUT                     (DEBUG_COMMAND_RESPONSE | 0x07)

+#define DEBUG_COMMAND_NOT_SUPPORTED               (DEBUG_COMMAND_RESPONSE | 0x0F)

 

 //

 // Definition for data field for debug packets

 //

-#define DEBUG_DATA_MAXIMUM_LENGTH_FOR_SMALL_COMMANDS     20

-

-#define DEBUG_DATA_UPPER_LIMIT                           0xff  // This is the upper limit for the data size, by the limit of the packet header definition.

-

-#define DEBUG_DATA_MAXIMUM_REAL_DATA                     0xf8

+#define DEBUG_DATA_UPPER_LIMIT                    0xff  // Upper limit for the data size, by the limit of the packet header definition.

 

-#define DEBUG_DEFINITION_MAX_IO_LENGTH                   4

+#define DEBUG_DATA_MAXIMUM_REAL_DATA              (DEBUG_DATA_UPPER_LIMIT - sizeof (DEBUG_PACKET_HEADER))

 

 //

 // Response data for DEBUG_COMMAND_BREAK_CAUSE

@@ -162,7 +139,6 @@ typedef struct {
   UINT8       Cause;

   UINT64      StopAddress;

 } DEBUG_DATA_RESPONSE_BREAK_CAUSE;

-

 //

 // Break type defintions for DEBUG_DATA_BREAK_CAUSE

 //

@@ -183,7 +159,6 @@ typedef struct {
 typedef struct {

   UINT8       CpuMode;

 } DEBUG_DATA_RESPONSE_ARCH_MODE;

-

 //

 // Cpu architecture defintions for DEBUG_DATA_RESPONSE_ARCH_MODE

 //

@@ -191,28 +166,23 @@ typedef struct {
 #define DEBUG_DATA_BREAK_CPU_ARCH_IA32        1

 #define DEBUG_DATA_BREAK_CPU_ARCH_X64         2

 

-//

-// Command and response data for DEBUG_COMMAND_XX_YY_BREAKPOINT

-//

 typedef struct {

   UINT8  Length:2;                   // Refer to below DEBUG_DATA_BREAKPOINT_LENGTH_XX macros

   UINT8  Access:2;                   // Refer to below DEBUG_DATA_BREAKPOINT_ACCESS_XX macros

   UINT8  Index:2;                    // Index of debug register

   UINT8  Reserved:2;

 } DEBUG_DATA_BREAKPOINT_TYPE;

-

-#define DEBUG_DATA_BREAKPOINT_MEMORY_ACCESS    (0x11)

-#define DEBUG_DATA_BREAKPOINT_IO_ACCESS        (0x10)

-#define DEBUG_DATA_BREAKPOINT_MEMORY_WRITE     (0x01)

-#define DEBUG_DATA_BREAKPOINT_MEMORY_EXECUTE   (0x00)

-

-#define DEBUG_DATA_BREAKPOINT_LENGTH_64        (0x11)

-#define DEBUG_DATA_BREAKPOINT_LENGTH_32        (0x10)

-#define DEBUG_DATA_BREAKPOINT_LENGTH_16        (0x01)

-#define DEBUG_DATA_BREAKPOINT_LENGTH_8         (0x00)

+#define DEBUG_DATA_BREAKPOINT_MEMORY_ACCESS    (0x3)

+#define DEBUG_DATA_BREAKPOINT_IO_ACCESS        (0x2)

+#define DEBUG_DATA_BREAKPOINT_MEMORY_WRITE     (0x1)

+#define DEBUG_DATA_BREAKPOINT_MEMORY_EXECUTE   (0x0)

+#define DEBUG_DATA_BREAKPOINT_LENGTH_32        (0x3)

+#define DEBUG_DATA_BREAKPOINT_LENGTH_64        (0x2)

+#define DEBUG_DATA_BREAKPOINT_LENGTH_16        (0x1)

+#define DEBUG_DATA_BREAKPOINT_LENGTH_8         (0x0)

 

 //

-// Command data for DEBUG_COMMAND_SET_HW_BREAKPOINT

+// Request data for DEBUG_COMMAND_SET_HW_BREAKPOINT

 //

 typedef struct {

   DEBUG_DATA_BREAKPOINT_TYPE Type;

@@ -220,119 +190,92 @@ typedef struct {
 } DEBUG_DATA_SET_HW_BREAKPOINT;

 

 //

-// Command data for DEBUG_COMMAND_CLEAR_HW_BREAKPOINT

+// Request data for DEBUG_COMMAND_CLEAR_HW_BREAKPOINT

 //

 typedef struct {

   UINT8                      IndexMask;  // 0x0f will clear all hw breakpoints

 } DEBUG_DATA_CLEAR_HW_BREAKPOINT;

 

 //

-// Command data for DEBUG_COMMAND_SET_SW_BREAKPOINT

+// Request and response data for DEBUG_COMMAND_SET_SW_BREAKPOINT

 //

 typedef struct {

   UINT64                     Address;

 } DEBUG_DATA_SET_SW_BREAKPOINT;

 

-//

-// Response data for DEBUG_COMMAND_SET_SW_BREAKPOINT

-//

 typedef struct {

   UINT8                      OriginalData;

 } DEBUG_DATA_RESPONSE_SET_SW_BREAKPOINT;

 

 //

-// Command data for DEBUG_COMMAND_CLEAR_SW_BREAKPOINT

-//

-typedef  DEBUG_DATA_SET_SW_BREAKPOINT DEBUG_DATA_CLEAR_SW_BREAKPOINT;

-

-//

-// Command data for DEBUG_COMMAND_READ_MEMORY_XX

+// Request data for DEBUG_COMMAND_READ_MEMORY

 //

 typedef struct {

   UINT64                     Address;

+  UINT8                      Width;

   UINT16                     Count;

-} DEBUG_DATA_READ_MEMORY_8;

-

-typedef DEBUG_DATA_READ_MEMORY_8 DEBUG_DATA_READ_MEMORY_16;

-

-typedef DEBUG_DATA_READ_MEMORY_8 DEBUG_DATA_READ_MEMORY_32;

-

-typedef DEBUG_DATA_READ_MEMORY_8 DEBUG_DATA_READ_MEMORY_64;

+} DEBUG_DATA_READ_MEMORY;

 

 //

-// Command data for DEBUG_COMMAND_WRITE_MEMORY_XX

+// Request data for DEBUG_COMMAND_WRITE_MEMORY

 //

 typedef struct {

   UINT64                     Address;

+  UINT8                      Width;

   UINT16                     Count;

-  UINT8                      Data;     // The actual length for this field is decided by Width x Count

-} DEBUG_DATA_WRITE_MEMORY_8;

-

-typedef DEBUG_DATA_WRITE_MEMORY_8 DEBUG_DATA_WRITE_MEMORY_16;

-

-typedef DEBUG_DATA_WRITE_MEMORY_8 DEBUG_DATA_WRITE_MEMORY_32;

-

-typedef DEBUG_DATA_WRITE_MEMORY_8 DEBUG_DATA_WRITE_MEMORY_64;

+  UINT8                      Data[1];  // The actual length is (Width * Count)

+} DEBUG_DATA_WRITE_MEMORY;

 

 //

-// Command data for DEBUG_COMMAND_READ_IO

+// Request and response data for DEBUG_COMMAND_READ_IO

 //

 typedef struct {

-  UINT16                     Port;

+  UINT64                     Port;

   UINT8                      Width;

 } DEBUG_DATA_READ_IO;

 

-//

-// Response data for DEBUG_COMMAND_READ_IO

-//

 typedef struct {

-  UINT8                      Data;  // The actual length of this structure will be adjusted according to the Width field

+  UINT8                      Data[1];  // The actual length depends on the packet header

 } DEBUG_DATA_RESPONSE_READ_IO;

 

 //

-// Command data for DEBUG_COMMAND_WRITE_IO

+// Request data for DEBUG_COMMAND_WRITE_IO

 //

 typedef struct {

-  UINT16                     Port;

+  UINT64                     Port;

   UINT8                      Width;

-  UINT8                      Data; // The actual length of this structure will be adjusted according to the Width field

+  UINT8                      Data[1];  // The actual length is Width

 } DEBUG_DATA_WRITE_IO;

 

 //

-// Command data for DEBUG_COMMAND_READ_REGISTER

+// Request data for DEBUG_COMMAND_READ_REGISTER

 //

 typedef struct {

-  UINT8                      Index;   // defined as DEBUG_DEFINITION_REGISTER_XX

-  UINT8                      Offset:4;

-  UINT8                      Length:4;

+  UINT8                      Index;   // defined as SOFT_DEBUGGER_REGISTER_XX

 } DEBUG_DATA_READ_REGISTER;

 

 //

-// Command data for DEBUG_COMMAND_WRITE_REGISTER

+// Request data for DEBUG_COMMAND_WRITE_REGISTER

 //

 typedef struct {

-  UINT8                      Index;   // defined as DEBUG_DEFINITION_REGISTER_XX

-  UINT8                      Offset:4;

-  UINT8                      Length:4;

-  UINT64                     Value;

+  UINT8                      Index;   // defined as SOFT_DEBUGGER_REGISTER_XX

+  UINT8                      Length;

+  UINT8                      Data[1]; // The actual length is Length

 } DEBUG_DATA_WRITE_REGISTER;

 

 //

-// Command data for DEBUG_COMMAND_READ_MSR

+// Request and response data for DEBUG_COMMAND_READ_MSR

 //

 typedef struct {

   UINT32                     Index;

 } DEBUG_DATA_READ_MSR;

 

-//

-// Response data for DEBUG_COMMAND_READ_MSR

-//

 typedef struct {

   UINT64                     Value;

 } DEBUG_DATA_RESPONSE_READ_MSR;

 

 //

-// Command data for DEBUG_COMMAND_WRITE_MSR

+// Request data for DEBUG_COMMAND_WRITE_MSR

 //

 typedef struct {

   UINT32                     Index;

@@ -340,14 +283,6 @@ typedef struct {
 } DEBUG_DATA_WRITE_MSR;

 

 //

-// Command data for DEBUG_COMMAND_READ_REGISTER_GROUP

-//

-typedef struct {

-  // For possible values, refer to the definition for DEBUG_DEFINITION_REGISTER_GROUP_XXX (in another .h file as it is architecture specific)

-  UINT8                     Index;

-} DEBUG_DATA_READ_REGISTER_GROUP;

-

-//

 // Response data for DEBUG_COMMAND_GET_REVISION

 //

 typedef struct {

@@ -360,24 +295,31 @@ typedef struct {
 //

 typedef struct {

   UINT8                     ExceptionNum;

-  UINT64                    ExceptionData;

+  UINT32                    ExceptionData;

 } DEBUG_DATA_RESPONSE_GET_EXCEPTION;

 

-typedef struct {

-  UINT8                     DRn;    // The index of DR register which to be used as temporary breakpoint

-} DEBUG_DATA_STEP_OVER;

-

 //

-// Command data for DEBUG_COMMAND_SET_DEBUG_FLAG

+// Request data for DEBUG_DATA_SET_DEBUG_SETTING

 //

 typedef struct {

-  UINT32                    DebugFlag;    // The index of DR register which to be used as temporary breakpoint

-} DEBUG_DATA_SET_DEBUG_FLAG;

+  UINT8                    Key;

+  UINT8                    Value;

+} DEBUG_DATA_SET_DEBUG_SETTING;

+//

+// Supported keys

+//

+#define DEBUG_AGENT_SETTING_SMM_ENTRY_BREAK     1

+#define DEBUG_AGENT_SETTING_PRINT_ERROR_LEVEL   2

+//

+// Bitmask of print error level for debug message

+//

+#define DEBUG_AGENT_ERROR     BIT0

+#define DEBUG_AGENT_WARNING   BIT1

+#define DEBUG_AGENT_INFO      BIT2

+#define DEBUG_AGENT_VERBOSE   BIT3

 

 //

-// Command data for DEBUG_COMMAND_SET_VIEWPOINT

-// If viewpoint is changed successfully, DEBUG_COMMAND_OK will be returned.

-// If viewpoint is not availabe, DEBUG_COMMAND_NOT_SUPPORTED will be returned.

+// Request data for DEBUG_COMMAND_SET_VIEWPOINT

 //

 typedef struct {

   UINT32                    ViewPoint;     // The index of viewpoint will be set

@@ -390,19 +332,38 @@ typedef struct {
   UINT32                    ViewPoint;     // The index of viewpoint will be returned

 } DEBUG_DATA_RESPONSE_GET_VIEWPOINT;

 

-#pragma pack()

+//

+// Request and response data for DEBUG_COMMAND_CPUID

+//

+typedef struct {

+  UINT32                    Eax;           // The value of EAX prior to invoking the CPUID instruction

+  UINT32                    Ecx;           // The value of ECX prior to invoking the CPUID instruction

+} DEBUG_DATA_CPUID;

+

+typedef struct {

+  UINT32                    Eax;           // The value of EAX returned by the CPUID instruction

+  UINT32                    Ebx;           // The value of EBX returned by the CPUID instruction

+  UINT32                    Ecx;           // The value of ECX returned by the CPUID instruction

+  UINT32                    Edx;           // The value of EDX returned by the CPUID instruction

+} DEBUG_DATA_RESPONSE_CPUID;

 

-#define DEBUG_PACKET_CONSTRUCTOR_WITH_NO_DATA(DebugPacket,ShortCommandType)                              \

-  ((DEBUG_COMMAND_HEADER *)DebugPacket)->StartSymbol = DEBUG_STARTING_SYMBOL_NORMAL;                     \

-  ((DEBUG_COMMAND_HEADER *)DebugPacket)->Command = DEBUG_COMMAND_##ShortCommandType;                     \

-  ((DEBUG_COMMAND_HEADER *)DebugPacket)->DataLength = 0;

-

-#define DEBUG_PACKET_CONSTRUCTOR_WITH_DATA(DebugPacket,ShortCommandType, DebugPacketDataPointer, PacketLength)         \

-  ((DEBUG_COMMAND_HEADER *)DebugPacket)->StartSymbol = DEBUG_STARTING_SYMBOL_NORMAL;                     \

-  ((DEBUG_COMMAND_HEADER *)DebugPacket)->Command = DEBUG_COMMAND_##ShortCommandType;                     \

-  ((DEBUG_COMMAND_HEADER *)DebugPacket)->DataLength = sizeof (DEBUG_DATA_##ShortCommandType);            \

-  *DebugPacketDataPointer = (DEBUG_DATA_##ShortCommandType *)((DEBUG_COMMAND_HEADER *)DebugPacket+1);    \

-  *PacketLength = sizeof (DEBUG_COMMAND_HEADER) + sizeof (DEBUG_DATA_##ShortCommandType);

+//

+// Request and response data for DEBUG_COMMAND_SEARCH_SIGNATURE

+//

+typedef struct {

+  UINT64                    Start;

+  UINT32                    Count;

+  UINT32                    Alignment;

+  BOOLEAN                   Positive;      // TRUE to search in higher address memory

+  UINT8                     DataLength;

+  UINT8                     Data[1];

+} DEBUG_DATA_SEARCH_SIGNATURE;

+

+typedef struct {

+  UINT64                    Address;       // -1 indicates not found

+} DEBUG_DATA_RESPONSE_SEARCH_SIGNATURE;

+

+#pragma pack()

 

 #endif