[mirror_edk2.git] / SourceLevelDebugPkg / Include / TransferProtocol.h

/** @file\r
  Transfer protocol defintions used by debug agent and host. It is only\r
  intended to be used by Debug related module implementation.\r
\r
  Copyright (c) 2010 - 2015, 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
#ifndef __TRANSFER_PROTOCOL_H__\r
#define __TRANSFER_PROTOCOL_H__\r
\r
#include "ProcessorContext.h"\r
\r
//\r
// Current revision of transfer protocol\r
// 0.4: Packet compression and decompression.\r
//\r
#define DEBUG_AGENT_REVISION_03         ((0 << 16) | 03)\r
#define DEBUG_AGENT_REVISION_04         ((0 << 16) | 04)\r
#define DEBUG_AGENT_REVISION            DEBUG_AGENT_REVISION_04\r
#define DEBUG_AGENT_CAPABILITIES        0\r
\r
//\r
// Definitions for the (A)ttach command\r
//\r
#define DEBUG_STARTING_SYMBOL_ATTACH    (0xFA)\r
\r
//\r
// Definition for starting symbol of a normal debug packet. Choose a non-ASCII to avoid conflict with other serial output.\r
//\r
#define DEBUG_STARTING_SYMBOL_NORMAL    (0xFE)\r
\r
//\r
// Definition for starting symbol of a (C)ompressed debug packet. Choose a non-ASCII to avoid conflict with other serial output.\r
//\r
#define DEBUG_STARTING_SYMBOL_COMPRESS  (0xFC)\r
\r
#pragma pack(1)\r
\r
//\r
// Definition for debug packet header for debug packets (not including attach command)\r
//\r
typedef struct {\r
  UINT8                      StartSymbol;\r
  UINT8                      Command;\r
  UINT8                      Length;    // Length of Debug Packet including header and payload in byte\r
  UINT8                      SequenceNo;\r
  UINT16                     Crc;\r
} DEBUG_PACKET_HEADER;\r
\r
//\r
// Definition for Command field for debug packets\r
//\r
#define DEBUG_COMMAND_REQUEST      (0 << 7)\r
#define DEBUG_COMMAND_RESPONSE     (1 << 7)\r
\r
#define IS_REQUEST(x)              (((x)->Command & DEBUG_COMMAND_RESPONSE) == 0)\r
\r
//\r
// HOST initiated commands\r
//\r
#define DEBUG_COMMAND_RESET                       (DEBUG_COMMAND_REQUEST | 0x00)\r
#define DEBUG_COMMAND_GO                          (DEBUG_COMMAND_REQUEST | 0x01)\r
#define DEBUG_COMMAND_BREAK_CAUSE                 (DEBUG_COMMAND_REQUEST | 0x02)\r
#define DEBUG_COMMAND_SET_HW_BREAKPOINT           (DEBUG_COMMAND_REQUEST | 0x03)\r
#define DEBUG_COMMAND_CLEAR_HW_BREAKPOINT         (DEBUG_COMMAND_REQUEST | 0x04)\r
#define DEBUG_COMMAND_SINGLE_STEPPING             (DEBUG_COMMAND_REQUEST | 0x05)\r
#define DEBUG_COMMAND_SET_SW_BREAKPOINT           (DEBUG_COMMAND_REQUEST | 0x06)\r
#define DEBUG_COMMAND_READ_MEMORY                 (DEBUG_COMMAND_REQUEST | 0x07)\r
#define DEBUG_COMMAND_WRITE_MEMORY                (DEBUG_COMMAND_REQUEST | 0x08)\r
#define DEBUG_COMMAND_READ_IO                     (DEBUG_COMMAND_REQUEST | 0x09)\r
#define DEBUG_COMMAND_WRITE_IO                    (DEBUG_COMMAND_REQUEST | 0x0A)\r
#define DEBUG_COMMAND_READ_REGISTER               (DEBUG_COMMAND_REQUEST | 0x0B)\r
#define DEBUG_COMMAND_WRITE_REGISTER              (DEBUG_COMMAND_REQUEST | 0x0C)\r
#define DEBUG_COMMAND_READ_ALL_REGISTERS          (DEBUG_COMMAND_REQUEST | 0x0D)\r
#define DEBUG_COMMAND_ARCH_MODE                   (DEBUG_COMMAND_REQUEST | 0x0E)\r
#define DEBUG_COMMAND_READ_MSR                    (DEBUG_COMMAND_REQUEST | 0x0F)\r
#define DEBUG_COMMAND_WRITE_MSR                   (DEBUG_COMMAND_REQUEST | 0x10)\r
#define DEBUG_COMMAND_SET_DEBUG_SETTING           (DEBUG_COMMAND_REQUEST | 0x11)\r
#define DEBUG_COMMAND_GET_REVISION                (DEBUG_COMMAND_REQUEST | 0x12)\r
#define DEBUG_COMMAND_GET_EXCEPTION               (DEBUG_COMMAND_REQUEST | 0x13)\r
#define DEBUG_COMMAND_SET_VIEWPOINT               (DEBUG_COMMAND_REQUEST | 0x14)\r
#define DEBUG_COMMAND_GET_VIEWPOINT               (DEBUG_COMMAND_REQUEST | 0x15)\r
#define DEBUG_COMMAND_DETACH                      (DEBUG_COMMAND_REQUEST | 0x16)\r
#define DEBUG_COMMAND_CPUID                       (DEBUG_COMMAND_REQUEST | 0x17)\r
#define DEBUG_COMMAND_SEARCH_SIGNATURE            (DEBUG_COMMAND_REQUEST | 0x18)\r
#define DEBUG_COMMAND_HALT                        (DEBUG_COMMAND_REQUEST | 0x19)\r
\r
//\r
// TARGET initiated commands\r
//\r
#define DEBUG_COMMAND_INIT_BREAK                  (DEBUG_COMMAND_REQUEST | 0x3F)\r
#define DEBUG_COMMAND_BREAK_POINT                 (DEBUG_COMMAND_REQUEST | 0x3E)\r
#define DEBUG_COMMAND_MEMORY_READY                (DEBUG_COMMAND_REQUEST | 0x3D)\r
#define DEBUG_COMMAND_PRINT_MESSAGE               (DEBUG_COMMAND_REQUEST | 0x3C)\r
#define DEBUG_COMMAND_ATTACH_BREAK                (DEBUG_COMMAND_REQUEST | 0x3B)\r
\r
//\r
// Response commands\r
//\r
#define DEBUG_COMMAND_OK                          (DEBUG_COMMAND_RESPONSE | 0x00)\r
#define DEBUG_COMMAND_RESEND                      (DEBUG_COMMAND_RESPONSE | 0x01)\r
#define DEBUG_COMMAND_ABORT                       (DEBUG_COMMAND_RESPONSE | 0x02)\r
//\r
// The below 2 commands are used when transferring big data (like > ~250 bytes).\r
// The sequence is:\r
//   HOST                             TARGET\r
//   Request                =>\r
//                          <=        IN_PROGRESS with partial data\r
//   CONTINUE               =>\r
//   (could have multiple IN_PROGRESS and CONTINUE interactions)\r
//                          <=        OK with the last part of data\r
//   OK (no data as ACK)    =>\r
//\r
#define DEBUG_COMMAND_IN_PROGRESS                 (DEBUG_COMMAND_RESPONSE | 0x03)\r
#define DEBUG_COMMAND_CONTINUE                    (DEBUG_COMMAND_RESPONSE | 0x04)\r
//\r
// The below 2 commands are used to support deferred halt:\r
// TARGET returns HALT_DEFERRED when it receives a HALT request in inter-active mode.\r
// TARGET returns HALT_PROCESSED when it receives a GO request and has a pending HALT request.\r
//\r
#define DEBUG_COMMAND_HALT_DEFERRED               (DEBUG_COMMAND_RESPONSE | 0x05)\r
#define DEBUG_COMMAND_HALT_PROCESSED              (DEBUG_COMMAND_RESPONSE | 0x06)\r
\r
#define DEBUG_COMMAND_TIMEOUT                     (DEBUG_COMMAND_RESPONSE | 0x07)\r
#define DEBUG_COMMAND_NOT_SUPPORTED               (DEBUG_COMMAND_RESPONSE | 0x0F)\r
\r
//\r
// Definition for data field for debug packets\r
//\r
#define DEBUG_DATA_UPPER_LIMIT                    0xff  // Upper limit for the data size, by the limit of the packet header definition.\r
\r
#define DEBUG_DATA_MAXIMUM_REAL_DATA              (DEBUG_DATA_UPPER_LIMIT - sizeof (DEBUG_PACKET_HEADER))\r
\r
//\r
// Response data for DEBUG_COMMAND_BREAK_CAUSE\r
//\r
typedef struct {\r
  UINT8       Cause;\r
  UINT64      StopAddress;\r
} DEBUG_DATA_RESPONSE_BREAK_CAUSE;\r
//\r
// Break type defintions for DEBUG_DATA_BREAK_CAUSE\r
//\r
#define DEBUG_DATA_BREAK_CAUSE_UNKNOWN        0\r
#define DEBUG_DATA_BREAK_CAUSE_HW_BREAKPOINT  1\r
#define DEBUG_DATA_BREAK_CAUSE_STEPPING       2\r
#define DEBUG_DATA_BREAK_CAUSE_SW_BREAKPOINT  3\r
#define DEBUG_DATA_BREAK_CAUSE_USER_HALT      4\r
#define DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD     5\r
#define DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD   6\r
#define DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET   7\r
#define DEBUG_DATA_BREAK_CAUSE_EXCEPTION      8\r
#define DEBUG_DATA_BREAK_CAUSE_MEMORY_READY   9\r
\r
//\r
// Response data for DEBUG_COMMAND_ARCH_MODE, defined as SOFT_DEBUGGER_PROCESSOR_...\r
//\r
typedef struct {\r
  UINT8       CpuMode;\r
} DEBUG_DATA_RESPONSE_ARCH_MODE;\r
//\r
// Cpu architecture defintions for DEBUG_DATA_RESPONSE_ARCH_MODE\r
//\r
#define DEBUG_DATA_BREAK_CPU_ARCH_IA16        0\r
#define DEBUG_DATA_BREAK_CPU_ARCH_IA32        1\r
#define DEBUG_DATA_BREAK_CPU_ARCH_X64         2\r
\r
typedef struct {\r
  UINT8  Length:2;                   // Refer to below DEBUG_DATA_BREAKPOINT_LENGTH_XX macros\r
  UINT8  Access:2;                   // Refer to below DEBUG_DATA_BREAKPOINT_ACCESS_XX macros\r
  UINT8  Index:2;                    // Index of debug register\r
  UINT8  Reserved:2;\r
} DEBUG_DATA_BREAKPOINT_TYPE;\r
#define DEBUG_DATA_BREAKPOINT_MEMORY_ACCESS    (0x3)\r
#define DEBUG_DATA_BREAKPOINT_IO_ACCESS        (0x2)\r
#define DEBUG_DATA_BREAKPOINT_MEMORY_WRITE     (0x1)\r
#define DEBUG_DATA_BREAKPOINT_MEMORY_EXECUTE   (0x0)\r
#define DEBUG_DATA_BREAKPOINT_LENGTH_32        (0x3)\r
#define DEBUG_DATA_BREAKPOINT_LENGTH_64        (0x2)\r
#define DEBUG_DATA_BREAKPOINT_LENGTH_16        (0x1)\r
#define DEBUG_DATA_BREAKPOINT_LENGTH_8         (0x0)\r
\r
//\r
// Request data for DEBUG_COMMAND_SET_HW_BREAKPOINT\r
//\r
typedef struct {\r
  DEBUG_DATA_BREAKPOINT_TYPE Type;\r
  UINT64                     Address;\r
} DEBUG_DATA_SET_HW_BREAKPOINT;\r
\r
//\r
// Request data for DEBUG_COMMAND_CLEAR_HW_BREAKPOINT\r
//\r
typedef struct {\r
  UINT8                      IndexMask;  // 0x0f will clear all hw breakpoints\r
} DEBUG_DATA_CLEAR_HW_BREAKPOINT;\r
\r
//\r
// Request and response data for DEBUG_COMMAND_SET_SW_BREAKPOINT\r
//\r
typedef struct {\r
  UINT64                     Address;\r
} DEBUG_DATA_SET_SW_BREAKPOINT;\r
\r
typedef struct {\r
  UINT8                      OriginalData;\r
} DEBUG_DATA_RESPONSE_SET_SW_BREAKPOINT;\r
\r
//\r
// Request data for DEBUG_COMMAND_READ_MEMORY\r
//\r
typedef struct {\r
  UINT64                     Address;\r
  UINT8                      Width;\r
  UINT16                     Count;\r
} DEBUG_DATA_READ_MEMORY;\r
\r
//\r
// Request data for DEBUG_COMMAND_WRITE_MEMORY\r
//\r
typedef struct {\r
  UINT64                     Address;\r
  UINT8                      Width;\r
  UINT16                     Count;\r
  UINT8                      Data[1];  // The actual length is (Width * Count)\r
} DEBUG_DATA_WRITE_MEMORY;\r
\r
//\r
// Request and response data for DEBUG_COMMAND_READ_IO\r
//\r
typedef struct {\r
  UINT64                     Port;\r
  UINT8                      Width;\r
} DEBUG_DATA_READ_IO;\r
\r
typedef struct {\r
  UINT8                      Data[1];  // The actual length depends on the packet header\r
} DEBUG_DATA_RESPONSE_READ_IO;\r
\r
//\r
// Request data for DEBUG_COMMAND_WRITE_IO\r
//\r
typedef struct {\r
  UINT64                     Port;\r
  UINT8                      Width;\r
  UINT8                      Data[1];  // The actual length is Width\r
} DEBUG_DATA_WRITE_IO;\r
\r
//\r
// Request data for DEBUG_COMMAND_READ_REGISTER\r
//\r
typedef struct {\r
  UINT8                      Index;   // defined as SOFT_DEBUGGER_REGISTER_XX\r
} DEBUG_DATA_READ_REGISTER;\r
\r
//\r
// Request data for DEBUG_COMMAND_WRITE_REGISTER\r
//\r
typedef struct {\r
  UINT8                      Index;   // defined as SOFT_DEBUGGER_REGISTER_XX\r
  UINT8                      Length;\r
  UINT8                      Data[1]; // The actual length is Length\r
} DEBUG_DATA_WRITE_REGISTER;\r
\r
//\r
// Request and response data for DEBUG_COMMAND_READ_MSR\r
//\r
typedef struct {\r
  UINT32                     Index;\r
} DEBUG_DATA_READ_MSR;\r
\r
typedef struct {\r
  UINT64                     Value;\r
} DEBUG_DATA_RESPONSE_READ_MSR;\r
\r
//\r
// Request data for DEBUG_COMMAND_WRITE_MSR\r
//\r
typedef struct {\r
  UINT32                     Index;\r
  UINT64                     Value;\r
} DEBUG_DATA_WRITE_MSR;\r
\r
//\r
// Response data for DEBUG_COMMAND_GET_REVISION\r
//\r
typedef struct {\r
  UINT32                    Revision;\r
  UINT32                    Capabilities;\r
} DEBUG_DATA_RESPONSE_GET_REVISION;\r
\r
//\r
// Response data for DEBUG_COMMAND_GET_EXCEPTION\r
//\r
typedef struct {\r
  UINT8                     ExceptionNum;\r
  UINT32                    ExceptionData;\r
} DEBUG_DATA_RESPONSE_GET_EXCEPTION;\r
\r
//\r
// Request data for DEBUG_DATA_SET_DEBUG_SETTING\r
//\r
typedef struct {\r
  UINT8                    Key;\r
  UINT8                    Value;\r
} DEBUG_DATA_SET_DEBUG_SETTING;\r
//\r
// Supported keys\r
//\r
#define DEBUG_AGENT_SETTING_SMM_ENTRY_BREAK          1\r
#define DEBUG_AGENT_SETTING_PRINT_ERROR_LEVEL        2\r
#define DEBUG_AGENT_SETTING_BOOT_SCRIPT_ENTRY_BREAK  3\r
//\r
// Bitmask of print error level for debug message\r
//\r
#define DEBUG_AGENT_ERROR     BIT0\r
#define DEBUG_AGENT_WARNING   BIT1\r
#define DEBUG_AGENT_INFO      BIT2\r
#define DEBUG_AGENT_VERBOSE   BIT3\r
\r
//\r
// Request data for DEBUG_COMMAND_SET_VIEWPOINT\r
//\r
typedef struct {\r
  UINT32                    ViewPoint;     // The index of viewpoint will be set\r
} DEBUG_DATA_SET_VIEWPOINT;\r
\r
//\r
// Response data for DEBUG_COMMAND_GET_VIEWPOINT\r
//\r
typedef struct {\r
  UINT32                    ViewPoint;     // The index of viewpoint will be returned\r
} DEBUG_DATA_RESPONSE_GET_VIEWPOINT;\r
\r
//\r
// Request and response data for DEBUG_COMMAND_CPUID\r
//\r
typedef struct {\r
  UINT32                    Eax;           // The value of EAX prior to invoking the CPUID instruction\r
  UINT32                    Ecx;           // The value of ECX prior to invoking the CPUID instruction\r
} DEBUG_DATA_CPUID;\r
\r
typedef struct {\r
  UINT32                    Eax;           // The value of EAX returned by the CPUID instruction\r
  UINT32                    Ebx;           // The value of EBX returned by the CPUID instruction\r
  UINT32                    Ecx;           // The value of ECX returned by the CPUID instruction\r
  UINT32                    Edx;           // The value of EDX returned by the CPUID instruction\r
} DEBUG_DATA_RESPONSE_CPUID;\r
\r
//\r
// Request and response data for DEBUG_COMMAND_SEARCH_SIGNATURE\r
//\r
typedef struct {\r
  UINT64                    Start;\r
  UINT32                    Count;\r
  UINT32                    Alignment;\r
  BOOLEAN                   Positive;      // TRUE to search in higher address memory\r
  UINT8                     DataLength;\r
  UINT8                     Data[1];\r
} DEBUG_DATA_SEARCH_SIGNATURE;\r
\r
typedef struct {\r
  UINT64                    Address;       // -1 indicates not found\r
} DEBUG_DATA_RESPONSE_SEARCH_SIGNATURE;\r
\r
#pragma pack()\r
\r
#endif\r
\r
Commit	Line	Data
18b144ea	1	/** @file\r
	2	Transfer protocol defintions used by debug agent and host. It is only\r
	3	intended to be used by Debug related module implementation.\r
	4	\r
d9044ec5	5	Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>\r
18b144ea	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php.\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __TRANSFER_PROTOCOL_H__\r
	17	#define __TRANSFER_PROTOCOL_H__\r
	18	\r
	19	#include "ProcessorContext.h"\r
93c0bdec	20	\r
	21	//\r
	22	// Current revision of transfer protocol\r
d9044ec5	23	// 0.4: Packet compression and decompression.\r
93c0bdec	24	//\r
d9044ec5 RN	25	#define DEBUG_AGENT_REVISION_03 ((0 << 16) \| 03)\r
d9044ec5 RN	26	#define DEBUG_AGENT_REVISION_04 ((0 << 16) \| 04)\r
be73a0c4	27	#define DEBUG_AGENT_REVISION DEBUG_AGENT_REVISION_04\r
93c0bdec	28	#define DEBUG_AGENT_CAPABILITIES 0\r
18b144ea	29	\r
93c0bdec	30	//\r
d9044ec5	31	// Definitions for the (A)ttach command\r
93c0bdec	32	//\r
b422b62c	33	#define DEBUG_STARTING_SYMBOL_ATTACH (0xFA)\r
18b144ea	34	\r
18b144ea	35	//\r
93c0bdec	36	// Definition for starting symbol of a normal debug packet. Choose a non-ASCII to avoid conflict with other serial output.\r
18b144ea	37	//\r
	38	#define DEBUG_STARTING_SYMBOL_NORMAL (0xFE)\r
	39	\r
d9044ec5 RN	40	//\r
	41	// Definition for starting symbol of a (C)ompressed debug packet. Choose a non-ASCII to avoid conflict with other serial output.\r
	42	//\r
	43	#define DEBUG_STARTING_SYMBOL_COMPRESS (0xFC)\r
	44	\r
18b144ea	45	#pragma pack(1)\r
	46	\r
	47	//\r
d9044ec5	48	// Definition for debug packet header for debug packets (not including attach command)\r
18b144ea	49	//\r
	50	typedef struct {\r
	51	UINT8 StartSymbol;\r
	52	UINT8 Command;\r
93c0bdec	53	UINT8 Length; // Length of Debug Packet including header and payload in byte\r
b422b62c	54	UINT8 SequenceNo;\r
b422b62c	55	UINT16 Crc;\r
93c0bdec	56	} DEBUG_PACKET_HEADER;\r
18b144ea	57	\r
	58	//\r
	59	// Definition for Command field for debug packets\r
	60	//\r
	61	#define DEBUG_COMMAND_REQUEST (0 << 7)\r
	62	#define DEBUG_COMMAND_RESPONSE (1 << 7)\r
	63	\r
ace354f1 RN	64	#define IS_REQUEST(x) (((x)->Command & DEBUG_COMMAND_RESPONSE) == 0)\r
ace354f1 RN	65	\r
18b144ea	66	//\r
93c0bdec	67	// HOST initiated commands\r
	68	//\r
	69	#define DEBUG_COMMAND_RESET (DEBUG_COMMAND_REQUEST \| 0x00)\r
	70	#define DEBUG_COMMAND_GO (DEBUG_COMMAND_REQUEST \| 0x01)\r
	71	#define DEBUG_COMMAND_BREAK_CAUSE (DEBUG_COMMAND_REQUEST \| 0x02)\r
	72	#define DEBUG_COMMAND_SET_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST \| 0x03)\r
	73	#define DEBUG_COMMAND_CLEAR_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST \| 0x04)\r
	74	#define DEBUG_COMMAND_SINGLE_STEPPING (DEBUG_COMMAND_REQUEST \| 0x05)\r
	75	#define DEBUG_COMMAND_SET_SW_BREAKPOINT (DEBUG_COMMAND_REQUEST \| 0x06)\r
	76	#define DEBUG_COMMAND_READ_MEMORY (DEBUG_COMMAND_REQUEST \| 0x07)\r
	77	#define DEBUG_COMMAND_WRITE_MEMORY (DEBUG_COMMAND_REQUEST \| 0x08)\r
	78	#define DEBUG_COMMAND_READ_IO (DEBUG_COMMAND_REQUEST \| 0x09)\r
	79	#define DEBUG_COMMAND_WRITE_IO (DEBUG_COMMAND_REQUEST \| 0x0A)\r
	80	#define DEBUG_COMMAND_READ_REGISTER (DEBUG_COMMAND_REQUEST \| 0x0B)\r
	81	#define DEBUG_COMMAND_WRITE_REGISTER (DEBUG_COMMAND_REQUEST \| 0x0C)\r
	82	#define DEBUG_COMMAND_READ_ALL_REGISTERS (DEBUG_COMMAND_REQUEST \| 0x0D)\r
	83	#define DEBUG_COMMAND_ARCH_MODE (DEBUG_COMMAND_REQUEST \| 0x0E)\r
	84	#define DEBUG_COMMAND_READ_MSR (DEBUG_COMMAND_REQUEST \| 0x0F)\r
	85	#define DEBUG_COMMAND_WRITE_MSR (DEBUG_COMMAND_REQUEST \| 0x10)\r
	86	#define DEBUG_COMMAND_SET_DEBUG_SETTING (DEBUG_COMMAND_REQUEST \| 0x11)\r
	87	#define DEBUG_COMMAND_GET_REVISION (DEBUG_COMMAND_REQUEST \| 0x12)\r
	88	#define DEBUG_COMMAND_GET_EXCEPTION (DEBUG_COMMAND_REQUEST \| 0x13)\r
	89	#define DEBUG_COMMAND_SET_VIEWPOINT (DEBUG_COMMAND_REQUEST \| 0x14)\r
	90	#define DEBUG_COMMAND_GET_VIEWPOINT (DEBUG_COMMAND_REQUEST \| 0x15)\r
	91	#define DEBUG_COMMAND_DETACH (DEBUG_COMMAND_REQUEST \| 0x16)\r
	92	#define DEBUG_COMMAND_CPUID (DEBUG_COMMAND_REQUEST \| 0x17)\r
	93	#define DEBUG_COMMAND_SEARCH_SIGNATURE (DEBUG_COMMAND_REQUEST \| 0x18)\r
b422b62c	94	#define DEBUG_COMMAND_HALT (DEBUG_COMMAND_REQUEST \| 0x19)\r
93c0bdec	95	\r
	96	//\r
	97	// TARGET initiated commands\r
	98	//\r
	99	#define DEBUG_COMMAND_INIT_BREAK (DEBUG_COMMAND_REQUEST \| 0x3F)\r
	100	#define DEBUG_COMMAND_BREAK_POINT (DEBUG_COMMAND_REQUEST \| 0x3E)\r
	101	#define DEBUG_COMMAND_MEMORY_READY (DEBUG_COMMAND_REQUEST \| 0x3D)\r
	102	#define DEBUG_COMMAND_PRINT_MESSAGE (DEBUG_COMMAND_REQUEST \| 0x3C)\r
b422b62c	103	#define DEBUG_COMMAND_ATTACH_BREAK (DEBUG_COMMAND_REQUEST \| 0x3B)\r
93c0bdec	104	\r
	105	//\r
	106	// Response commands\r
	107	//\r
	108	#define DEBUG_COMMAND_OK (DEBUG_COMMAND_RESPONSE \| 0x00)\r
	109	#define DEBUG_COMMAND_RESEND (DEBUG_COMMAND_RESPONSE \| 0x01)\r
	110	#define DEBUG_COMMAND_ABORT (DEBUG_COMMAND_RESPONSE \| 0x02)\r
	111	//\r
	112	// The below 2 commands are used when transferring big data (like > ~250 bytes).\r
	113	// The sequence is:\r
	114	// HOST TARGET\r
	115	// Request =>\r
	116	// <= IN_PROGRESS with partial data\r
	117	// CONTINUE =>\r
	118	// (could have multiple IN_PROGRESS and CONTINUE interactions)\r
	119	// <= OK with the last part of data\r
	120	// OK (no data as ACK) =>\r
	121	//\r
	122	#define DEBUG_COMMAND_IN_PROGRESS (DEBUG_COMMAND_RESPONSE \| 0x03)\r
	123	#define DEBUG_COMMAND_CONTINUE (DEBUG_COMMAND_RESPONSE \| 0x04)\r
	124	//\r
	125	// The below 2 commands are used to support deferred halt:\r
	126	// TARGET returns HALT_DEFERRED when it receives a HALT request in inter-active mode.\r
	127	// TARGET returns HALT_PROCESSED when it receives a GO request and has a pending HALT request.\r
	128	//\r
	129	#define DEBUG_COMMAND_HALT_DEFERRED (DEBUG_COMMAND_RESPONSE \| 0x05)\r
	130	#define DEBUG_COMMAND_HALT_PROCESSED (DEBUG_COMMAND_RESPONSE \| 0x06)\r
	131	\r
	132	#define DEBUG_COMMAND_TIMEOUT (DEBUG_COMMAND_RESPONSE \| 0x07)\r
	133	#define DEBUG_COMMAND_NOT_SUPPORTED (DEBUG_COMMAND_RESPONSE \| 0x0F)\r
18b144ea	134	\r
	135	//\r
	136	// Definition for data field for debug packets\r
	137	//\r
93c0bdec	138	#define DEBUG_DATA_UPPER_LIMIT 0xff // Upper limit for the data size, by the limit of the packet header definition.\r
18b144ea	139	\r
93c0bdec	140	#define DEBUG_DATA_MAXIMUM_REAL_DATA (DEBUG_DATA_UPPER_LIMIT - sizeof (DEBUG_PACKET_HEADER))\r
18b144ea	141	\r
	142	//\r
	143	// Response data for DEBUG_COMMAND_BREAK_CAUSE\r
	144	//\r
	145	typedef struct {\r
	146	UINT8 Cause;\r
	147	UINT64 StopAddress;\r
	148	} DEBUG_DATA_RESPONSE_BREAK_CAUSE;\r
18b144ea	149	//\r
	150	// Break type defintions for DEBUG_DATA_BREAK_CAUSE\r
	151	//\r
	152	#define DEBUG_DATA_BREAK_CAUSE_UNKNOWN 0\r
	153	#define DEBUG_DATA_BREAK_CAUSE_HW_BREAKPOINT 1\r
	154	#define DEBUG_DATA_BREAK_CAUSE_STEPPING 2\r
	155	#define DEBUG_DATA_BREAK_CAUSE_SW_BREAKPOINT 3\r
	156	#define DEBUG_DATA_BREAK_CAUSE_USER_HALT 4\r
	157	#define DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD 5\r
	158	#define DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD 6\r
	159	#define DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET 7\r
	160	#define DEBUG_DATA_BREAK_CAUSE_EXCEPTION 8\r
	161	#define DEBUG_DATA_BREAK_CAUSE_MEMORY_READY 9\r
	162	\r
	163	//\r
	164	// Response data for DEBUG_COMMAND_ARCH_MODE, defined as SOFT_DEBUGGER_PROCESSOR_...\r
	165	//\r
	166	typedef struct {\r
	167	UINT8 CpuMode;\r
	168	} DEBUG_DATA_RESPONSE_ARCH_MODE;\r
18b144ea	169	//\r
	170	// Cpu architecture defintions for DEBUG_DATA_RESPONSE_ARCH_MODE\r
	171	//\r
	172	#define DEBUG_DATA_BREAK_CPU_ARCH_IA16 0\r
	173	#define DEBUG_DATA_BREAK_CPU_ARCH_IA32 1\r
	174	#define DEBUG_DATA_BREAK_CPU_ARCH_X64 2\r
	175	\r
18b144ea	176	typedef struct {\r
	177	UINT8 Length:2; // Refer to below DEBUG_DATA_BREAKPOINT_LENGTH_XX macros\r
	178	UINT8 Access:2; // Refer to below DEBUG_DATA_BREAKPOINT_ACCESS_XX macros\r
	179	UINT8 Index:2; // Index of debug register\r
	180	UINT8 Reserved:2;\r
	181	} DEBUG_DATA_BREAKPOINT_TYPE;\r
93c0bdec	182	#define DEBUG_DATA_BREAKPOINT_MEMORY_ACCESS (0x3)\r
	183	#define DEBUG_DATA_BREAKPOINT_IO_ACCESS (0x2)\r
	184	#define DEBUG_DATA_BREAKPOINT_MEMORY_WRITE (0x1)\r
	185	#define DEBUG_DATA_BREAKPOINT_MEMORY_EXECUTE (0x0)\r
	186	#define DEBUG_DATA_BREAKPOINT_LENGTH_32 (0x3)\r
	187	#define DEBUG_DATA_BREAKPOINT_LENGTH_64 (0x2)\r
	188	#define DEBUG_DATA_BREAKPOINT_LENGTH_16 (0x1)\r
	189	#define DEBUG_DATA_BREAKPOINT_LENGTH_8 (0x0)\r
18b144ea	190	\r
18b144ea	191	//\r
93c0bdec	192	// Request data for DEBUG_COMMAND_SET_HW_BREAKPOINT\r
18b144ea	193	//\r
	194	typedef struct {\r
	195	DEBUG_DATA_BREAKPOINT_TYPE Type;\r
	196	UINT64 Address;\r
	197	} DEBUG_DATA_SET_HW_BREAKPOINT;\r
	198	\r
	199	//\r
93c0bdec	200	// Request data for DEBUG_COMMAND_CLEAR_HW_BREAKPOINT\r
18b144ea	201	//\r
	202	typedef struct {\r
	203	UINT8 IndexMask; // 0x0f will clear all hw breakpoints\r
	204	} DEBUG_DATA_CLEAR_HW_BREAKPOINT;\r
	205	\r
	206	//\r
93c0bdec	207	// Request and response data for DEBUG_COMMAND_SET_SW_BREAKPOINT\r
18b144ea	208	//\r
	209	typedef struct {\r
	210	UINT64 Address;\r
	211	} DEBUG_DATA_SET_SW_BREAKPOINT;\r
	212	\r
18b144ea	213	typedef struct {\r
	214	UINT8 OriginalData;\r
	215	} DEBUG_DATA_RESPONSE_SET_SW_BREAKPOINT;\r
	216	\r
	217	//\r
93c0bdec	218	// Request data for DEBUG_COMMAND_READ_MEMORY\r
18b144ea	219	//\r
	220	typedef struct {\r
	221	UINT64 Address;\r
93c0bdec	222	UINT8 Width;\r
18b144ea	223	UINT16 Count;\r
93c0bdec	224	} DEBUG_DATA_READ_MEMORY;\r
18b144ea	225	\r
18b144ea	226	//\r
93c0bdec	227	// Request data for DEBUG_COMMAND_WRITE_MEMORY\r
18b144ea	228	//\r
	229	typedef struct {\r
	230	UINT64 Address;\r
93c0bdec	231	UINT8 Width;\r
18b144ea	232	UINT16 Count;\r
93c0bdec	233	UINT8 Data[1]; // The actual length is (Width * Count)\r
93c0bdec	234	} DEBUG_DATA_WRITE_MEMORY;\r
18b144ea	235	\r
18b144ea	236	//\r
93c0bdec	237	// Request and response data for DEBUG_COMMAND_READ_IO\r
18b144ea	238	//\r
18b144ea	239	typedef struct {\r
93c0bdec	240	UINT64 Port;\r
18b144ea	241	UINT8 Width;\r
	242	} DEBUG_DATA_READ_IO;\r
	243	\r
18b144ea	244	typedef struct {\r
93c0bdec	245	UINT8 Data[1]; // The actual length depends on the packet header\r
18b144ea	246	} DEBUG_DATA_RESPONSE_READ_IO;\r
	247	\r
	248	//\r
93c0bdec	249	// Request data for DEBUG_COMMAND_WRITE_IO\r
18b144ea	250	//\r
18b144ea	251	typedef struct {\r
93c0bdec	252	UINT64 Port;\r
18b144ea	253	UINT8 Width;\r
93c0bdec	254	UINT8 Data[1]; // The actual length is Width\r
18b144ea	255	} DEBUG_DATA_WRITE_IO;\r
	256	\r
	257	//\r
93c0bdec	258	// Request data for DEBUG_COMMAND_READ_REGISTER\r
18b144ea	259	//\r
18b144ea	260	typedef struct {\r
93c0bdec	261	UINT8 Index; // defined as SOFT_DEBUGGER_REGISTER_XX\r
18b144ea	262	} DEBUG_DATA_READ_REGISTER;\r
	263	\r
	264	//\r
93c0bdec	265	// Request data for DEBUG_COMMAND_WRITE_REGISTER\r
18b144ea	266	//\r
18b144ea	267	typedef struct {\r
93c0bdec	268	UINT8 Index; // defined as SOFT_DEBUGGER_REGISTER_XX\r
	269	UINT8 Length;\r
	270	UINT8 Data[1]; // The actual length is Length\r
18b144ea	271	} DEBUG_DATA_WRITE_REGISTER;\r
	272	\r
	273	//\r
93c0bdec	274	// Request and response data for DEBUG_COMMAND_READ_MSR\r
18b144ea	275	//\r
	276	typedef struct {\r
	277	UINT32 Index;\r
	278	} DEBUG_DATA_READ_MSR;\r
	279	\r
18b144ea	280	typedef struct {\r
	281	UINT64 Value;\r
	282	} DEBUG_DATA_RESPONSE_READ_MSR;\r
	283	\r
	284	//\r
93c0bdec	285	// Request data for DEBUG_COMMAND_WRITE_MSR\r
18b144ea	286	//\r
	287	typedef struct {\r
	288	UINT32 Index;\r
	289	UINT64 Value;\r
	290	} DEBUG_DATA_WRITE_MSR;\r
	291	\r
18b144ea	292	//\r
	293	// Response data for DEBUG_COMMAND_GET_REVISION\r
	294	//\r
	295	typedef struct {\r
	296	UINT32 Revision;\r
	297	UINT32 Capabilities;\r
	298	} DEBUG_DATA_RESPONSE_GET_REVISION;\r
	299	\r
	300	//\r
	301	// Response data for DEBUG_COMMAND_GET_EXCEPTION\r
	302	//\r
	303	typedef struct {\r
	304	UINT8 ExceptionNum;\r
93c0bdec	305	UINT32 ExceptionData;\r
18b144ea	306	} DEBUG_DATA_RESPONSE_GET_EXCEPTION;\r
18b144ea	307	\r
18b144ea	308	//\r
93c0bdec	309	// Request data for DEBUG_DATA_SET_DEBUG_SETTING\r
18b144ea	310	//\r
18b144ea	311	typedef struct {\r
93c0bdec	312	UINT8 Key;\r
	313	UINT8 Value;\r
	314	} DEBUG_DATA_SET_DEBUG_SETTING;\r
	315	//\r
	316	// Supported keys\r
	317	//\r
b422b62c	318	#define DEBUG_AGENT_SETTING_SMM_ENTRY_BREAK 1\r
	319	#define DEBUG_AGENT_SETTING_PRINT_ERROR_LEVEL 2\r
	320	#define DEBUG_AGENT_SETTING_BOOT_SCRIPT_ENTRY_BREAK 3\r
93c0bdec	321	//\r
	322	// Bitmask of print error level for debug message\r
	323	//\r
	324	#define DEBUG_AGENT_ERROR BIT0\r
	325	#define DEBUG_AGENT_WARNING BIT1\r
	326	#define DEBUG_AGENT_INFO BIT2\r
	327	#define DEBUG_AGENT_VERBOSE BIT3\r
18b144ea	328	\r
18b144ea	329	//\r
93c0bdec	330	// Request data for DEBUG_COMMAND_SET_VIEWPOINT\r
18b144ea	331	//\r
	332	typedef struct {\r
	333	UINT32 ViewPoint; // The index of viewpoint will be set\r
	334	} DEBUG_DATA_SET_VIEWPOINT;\r
	335	\r
	336	//\r
	337	// Response data for DEBUG_COMMAND_GET_VIEWPOINT\r
	338	//\r
	339	typedef struct {\r
	340	UINT32 ViewPoint; // The index of viewpoint will be returned\r
	341	} DEBUG_DATA_RESPONSE_GET_VIEWPOINT;\r
	342	\r
93c0bdec	343	//\r
	344	// Request and response data for DEBUG_COMMAND_CPUID\r
	345	//\r
	346	typedef struct {\r
	347	UINT32 Eax; // The value of EAX prior to invoking the CPUID instruction\r
	348	UINT32 Ecx; // The value of ECX prior to invoking the CPUID instruction\r
	349	} DEBUG_DATA_CPUID;\r
	350	\r
	351	typedef struct {\r
	352	UINT32 Eax; // The value of EAX returned by the CPUID instruction\r
	353	UINT32 Ebx; // The value of EBX returned by the CPUID instruction\r
	354	UINT32 Ecx; // The value of ECX returned by the CPUID instruction\r
	355	UINT32 Edx; // The value of EDX returned by the CPUID instruction\r
	356	} DEBUG_DATA_RESPONSE_CPUID;\r
18b144ea	357	\r
93c0bdec	358	//\r
	359	// Request and response data for DEBUG_COMMAND_SEARCH_SIGNATURE\r
	360	//\r
	361	typedef struct {\r
	362	UINT64 Start;\r
	363	UINT32 Count;\r
	364	UINT32 Alignment;\r
	365	BOOLEAN Positive; // TRUE to search in higher address memory\r
	366	UINT8 DataLength;\r
	367	UINT8 Data[1];\r
	368	} DEBUG_DATA_SEARCH_SIGNATURE;\r
	369	\r
	370	typedef struct {\r
	371	UINT64 Address; // -1 indicates not found\r
	372	} DEBUG_DATA_RESPONSE_SEARCH_SIGNATURE;\r
	373	\r
	374	#pragma pack()\r
18b144ea	375	\r
	376	#endif\r
	377	\r