2 Transfer protocol defintions used by debug agent and host. It is only
3 intended to be used by Debug related module implementation.
5 Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __TRANSFER_PROTOCOL_H__
17 #define __TRANSFER_PROTOCOL_H__
19 #include "ProcessorContext.h"
22 // Current revision of transfer protocol
24 #define DEBUG_AGENT_REVISION ((0 << 16) | 03)
25 #define DEBUG_AGENT_CAPABILITIES 0
28 // Definitions for attach command
30 #define DEBUG_STARTING_SYMBOL_ATTACH (0xFA)
33 // Definition for starting symbol of a normal debug packet. Choose a non-ASCII to avoid conflict with other serial output.
35 #define DEBUG_STARTING_SYMBOL_NORMAL (0xFE)
40 // Definition for debug packet header for normal debug packets (not including break/attach command)
45 UINT8 Length
; // Length of Debug Packet including header and payload in byte
48 } DEBUG_PACKET_HEADER
;
51 // Definition for Command field for debug packets
53 #define DEBUG_COMMAND_REQUEST (0 << 7)
54 #define DEBUG_COMMAND_RESPONSE (1 << 7)
57 // HOST initiated commands
59 #define DEBUG_COMMAND_RESET (DEBUG_COMMAND_REQUEST | 0x00)
60 #define DEBUG_COMMAND_GO (DEBUG_COMMAND_REQUEST | 0x01)
61 #define DEBUG_COMMAND_BREAK_CAUSE (DEBUG_COMMAND_REQUEST | 0x02)
62 #define DEBUG_COMMAND_SET_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x03)
63 #define DEBUG_COMMAND_CLEAR_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x04)
64 #define DEBUG_COMMAND_SINGLE_STEPPING (DEBUG_COMMAND_REQUEST | 0x05)
65 #define DEBUG_COMMAND_SET_SW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x06)
66 #define DEBUG_COMMAND_READ_MEMORY (DEBUG_COMMAND_REQUEST | 0x07)
67 #define DEBUG_COMMAND_WRITE_MEMORY (DEBUG_COMMAND_REQUEST | 0x08)
68 #define DEBUG_COMMAND_READ_IO (DEBUG_COMMAND_REQUEST | 0x09)
69 #define DEBUG_COMMAND_WRITE_IO (DEBUG_COMMAND_REQUEST | 0x0A)
70 #define DEBUG_COMMAND_READ_REGISTER (DEBUG_COMMAND_REQUEST | 0x0B)
71 #define DEBUG_COMMAND_WRITE_REGISTER (DEBUG_COMMAND_REQUEST | 0x0C)
72 #define DEBUG_COMMAND_READ_ALL_REGISTERS (DEBUG_COMMAND_REQUEST | 0x0D)
73 #define DEBUG_COMMAND_ARCH_MODE (DEBUG_COMMAND_REQUEST | 0x0E)
74 #define DEBUG_COMMAND_READ_MSR (DEBUG_COMMAND_REQUEST | 0x0F)
75 #define DEBUG_COMMAND_WRITE_MSR (DEBUG_COMMAND_REQUEST | 0x10)
76 #define DEBUG_COMMAND_SET_DEBUG_SETTING (DEBUG_COMMAND_REQUEST | 0x11)
77 #define DEBUG_COMMAND_GET_REVISION (DEBUG_COMMAND_REQUEST | 0x12)
78 #define DEBUG_COMMAND_GET_EXCEPTION (DEBUG_COMMAND_REQUEST | 0x13)
79 #define DEBUG_COMMAND_SET_VIEWPOINT (DEBUG_COMMAND_REQUEST | 0x14)
80 #define DEBUG_COMMAND_GET_VIEWPOINT (DEBUG_COMMAND_REQUEST | 0x15)
81 #define DEBUG_COMMAND_DETACH (DEBUG_COMMAND_REQUEST | 0x16)
82 #define DEBUG_COMMAND_CPUID (DEBUG_COMMAND_REQUEST | 0x17)
83 #define DEBUG_COMMAND_SEARCH_SIGNATURE (DEBUG_COMMAND_REQUEST | 0x18)
84 #define DEBUG_COMMAND_HALT (DEBUG_COMMAND_REQUEST | 0x19)
87 // TARGET initiated commands
89 #define DEBUG_COMMAND_INIT_BREAK (DEBUG_COMMAND_REQUEST | 0x3F)
90 #define DEBUG_COMMAND_BREAK_POINT (DEBUG_COMMAND_REQUEST | 0x3E)
91 #define DEBUG_COMMAND_MEMORY_READY (DEBUG_COMMAND_REQUEST | 0x3D)
92 #define DEBUG_COMMAND_PRINT_MESSAGE (DEBUG_COMMAND_REQUEST | 0x3C)
93 #define DEBUG_COMMAND_ATTACH_BREAK (DEBUG_COMMAND_REQUEST | 0x3B)
98 #define DEBUG_COMMAND_OK (DEBUG_COMMAND_RESPONSE | 0x00)
99 #define DEBUG_COMMAND_RESEND (DEBUG_COMMAND_RESPONSE | 0x01)
100 #define DEBUG_COMMAND_ABORT (DEBUG_COMMAND_RESPONSE | 0x02)
102 // The below 2 commands are used when transferring big data (like > ~250 bytes).
106 // <= IN_PROGRESS with partial data
108 // (could have multiple IN_PROGRESS and CONTINUE interactions)
109 // <= OK with the last part of data
110 // OK (no data as ACK) =>
112 #define DEBUG_COMMAND_IN_PROGRESS (DEBUG_COMMAND_RESPONSE | 0x03)
113 #define DEBUG_COMMAND_CONTINUE (DEBUG_COMMAND_RESPONSE | 0x04)
115 // The below 2 commands are used to support deferred halt:
116 // TARGET returns HALT_DEFERRED when it receives a HALT request in inter-active mode.
117 // TARGET returns HALT_PROCESSED when it receives a GO request and has a pending HALT request.
119 #define DEBUG_COMMAND_HALT_DEFERRED (DEBUG_COMMAND_RESPONSE | 0x05)
120 #define DEBUG_COMMAND_HALT_PROCESSED (DEBUG_COMMAND_RESPONSE | 0x06)
122 #define DEBUG_COMMAND_TIMEOUT (DEBUG_COMMAND_RESPONSE | 0x07)
123 #define DEBUG_COMMAND_NOT_SUPPORTED (DEBUG_COMMAND_RESPONSE | 0x0F)
126 // Definition for data field for debug packets
128 #define DEBUG_DATA_UPPER_LIMIT 0xff // Upper limit for the data size, by the limit of the packet header definition.
130 #define DEBUG_DATA_MAXIMUM_REAL_DATA (DEBUG_DATA_UPPER_LIMIT - sizeof (DEBUG_PACKET_HEADER))
133 // Response data for DEBUG_COMMAND_BREAK_CAUSE
138 } DEBUG_DATA_RESPONSE_BREAK_CAUSE
;
140 // Break type defintions for DEBUG_DATA_BREAK_CAUSE
142 #define DEBUG_DATA_BREAK_CAUSE_UNKNOWN 0
143 #define DEBUG_DATA_BREAK_CAUSE_HW_BREAKPOINT 1
144 #define DEBUG_DATA_BREAK_CAUSE_STEPPING 2
145 #define DEBUG_DATA_BREAK_CAUSE_SW_BREAKPOINT 3
146 #define DEBUG_DATA_BREAK_CAUSE_USER_HALT 4
147 #define DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD 5
148 #define DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD 6
149 #define DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET 7
150 #define DEBUG_DATA_BREAK_CAUSE_EXCEPTION 8
151 #define DEBUG_DATA_BREAK_CAUSE_MEMORY_READY 9
154 // Response data for DEBUG_COMMAND_ARCH_MODE, defined as SOFT_DEBUGGER_PROCESSOR_...
158 } DEBUG_DATA_RESPONSE_ARCH_MODE
;
160 // Cpu architecture defintions for DEBUG_DATA_RESPONSE_ARCH_MODE
162 #define DEBUG_DATA_BREAK_CPU_ARCH_IA16 0
163 #define DEBUG_DATA_BREAK_CPU_ARCH_IA32 1
164 #define DEBUG_DATA_BREAK_CPU_ARCH_X64 2
167 UINT8 Length
:2; // Refer to below DEBUG_DATA_BREAKPOINT_LENGTH_XX macros
168 UINT8 Access
:2; // Refer to below DEBUG_DATA_BREAKPOINT_ACCESS_XX macros
169 UINT8 Index
:2; // Index of debug register
171 } DEBUG_DATA_BREAKPOINT_TYPE
;
172 #define DEBUG_DATA_BREAKPOINT_MEMORY_ACCESS (0x3)
173 #define DEBUG_DATA_BREAKPOINT_IO_ACCESS (0x2)
174 #define DEBUG_DATA_BREAKPOINT_MEMORY_WRITE (0x1)
175 #define DEBUG_DATA_BREAKPOINT_MEMORY_EXECUTE (0x0)
176 #define DEBUG_DATA_BREAKPOINT_LENGTH_32 (0x3)
177 #define DEBUG_DATA_BREAKPOINT_LENGTH_64 (0x2)
178 #define DEBUG_DATA_BREAKPOINT_LENGTH_16 (0x1)
179 #define DEBUG_DATA_BREAKPOINT_LENGTH_8 (0x0)
182 // Request data for DEBUG_COMMAND_SET_HW_BREAKPOINT
185 DEBUG_DATA_BREAKPOINT_TYPE Type
;
187 } DEBUG_DATA_SET_HW_BREAKPOINT
;
190 // Request data for DEBUG_COMMAND_CLEAR_HW_BREAKPOINT
193 UINT8 IndexMask
; // 0x0f will clear all hw breakpoints
194 } DEBUG_DATA_CLEAR_HW_BREAKPOINT
;
197 // Request and response data for DEBUG_COMMAND_SET_SW_BREAKPOINT
201 } DEBUG_DATA_SET_SW_BREAKPOINT
;
205 } DEBUG_DATA_RESPONSE_SET_SW_BREAKPOINT
;
208 // Request data for DEBUG_COMMAND_READ_MEMORY
214 } DEBUG_DATA_READ_MEMORY
;
217 // Request data for DEBUG_COMMAND_WRITE_MEMORY
223 UINT8 Data
[1]; // The actual length is (Width * Count)
224 } DEBUG_DATA_WRITE_MEMORY
;
227 // Request and response data for DEBUG_COMMAND_READ_IO
232 } DEBUG_DATA_READ_IO
;
235 UINT8 Data
[1]; // The actual length depends on the packet header
236 } DEBUG_DATA_RESPONSE_READ_IO
;
239 // Request data for DEBUG_COMMAND_WRITE_IO
244 UINT8 Data
[1]; // The actual length is Width
245 } DEBUG_DATA_WRITE_IO
;
248 // Request data for DEBUG_COMMAND_READ_REGISTER
251 UINT8 Index
; // defined as SOFT_DEBUGGER_REGISTER_XX
252 } DEBUG_DATA_READ_REGISTER
;
255 // Request data for DEBUG_COMMAND_WRITE_REGISTER
258 UINT8 Index
; // defined as SOFT_DEBUGGER_REGISTER_XX
260 UINT8 Data
[1]; // The actual length is Length
261 } DEBUG_DATA_WRITE_REGISTER
;
264 // Request and response data for DEBUG_COMMAND_READ_MSR
268 } DEBUG_DATA_READ_MSR
;
272 } DEBUG_DATA_RESPONSE_READ_MSR
;
275 // Request data for DEBUG_COMMAND_WRITE_MSR
280 } DEBUG_DATA_WRITE_MSR
;
283 // Response data for DEBUG_COMMAND_GET_REVISION
288 } DEBUG_DATA_RESPONSE_GET_REVISION
;
291 // Response data for DEBUG_COMMAND_GET_EXCEPTION
295 UINT32 ExceptionData
;
296 } DEBUG_DATA_RESPONSE_GET_EXCEPTION
;
299 // Request data for DEBUG_DATA_SET_DEBUG_SETTING
304 } DEBUG_DATA_SET_DEBUG_SETTING
;
308 #define DEBUG_AGENT_SETTING_SMM_ENTRY_BREAK 1
309 #define DEBUG_AGENT_SETTING_PRINT_ERROR_LEVEL 2
310 #define DEBUG_AGENT_SETTING_BOOT_SCRIPT_ENTRY_BREAK 3
312 // Bitmask of print error level for debug message
314 #define DEBUG_AGENT_ERROR BIT0
315 #define DEBUG_AGENT_WARNING BIT1
316 #define DEBUG_AGENT_INFO BIT2
317 #define DEBUG_AGENT_VERBOSE BIT3
320 // Request data for DEBUG_COMMAND_SET_VIEWPOINT
323 UINT32 ViewPoint
; // The index of viewpoint will be set
324 } DEBUG_DATA_SET_VIEWPOINT
;
327 // Response data for DEBUG_COMMAND_GET_VIEWPOINT
330 UINT32 ViewPoint
; // The index of viewpoint will be returned
331 } DEBUG_DATA_RESPONSE_GET_VIEWPOINT
;
334 // Request and response data for DEBUG_COMMAND_CPUID
337 UINT32 Eax
; // The value of EAX prior to invoking the CPUID instruction
338 UINT32 Ecx
; // The value of ECX prior to invoking the CPUID instruction
342 UINT32 Eax
; // The value of EAX returned by the CPUID instruction
343 UINT32 Ebx
; // The value of EBX returned by the CPUID instruction
344 UINT32 Ecx
; // The value of ECX returned by the CPUID instruction
345 UINT32 Edx
; // The value of EDX returned by the CPUID instruction
346 } DEBUG_DATA_RESPONSE_CPUID
;
349 // Request and response data for DEBUG_COMMAND_SEARCH_SIGNATURE
355 BOOLEAN Positive
; // TRUE to search in higher address memory
358 } DEBUG_DATA_SEARCH_SIGNATURE
;
361 UINT64 Address
; // -1 indicates not found
362 } DEBUG_DATA_RESPONSE_SEARCH_SIGNATURE
;