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 - 2017, 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
23 // 0.4: Packet compression and decompression.
25 #define DEBUG_AGENT_REVISION_03 ((0 << 16) | 03)
26 #define DEBUG_AGENT_REVISION_04 ((0 << 16) | 04)
27 #define DEBUG_AGENT_CAPABILITIES 0
30 // Definitions for the (A)ttach command
32 #define DEBUG_STARTING_SYMBOL_ATTACH (0xFA)
35 // Definition for starting symbol of a normal debug packet. Choose a non-ASCII to avoid conflict with other serial output.
37 #define DEBUG_STARTING_SYMBOL_NORMAL (0xFE)
40 // Definition for starting symbol of a (C)ompressed debug packet. Choose a non-ASCII to avoid conflict with other serial output.
42 #define DEBUG_STARTING_SYMBOL_COMPRESS (0xFC)
47 // Definition for debug packet header for debug packets (not including attach command)
52 UINT8 Length
; // Length of Debug Packet including header and payload in byte
55 } DEBUG_PACKET_HEADER
;
58 // Definition for Command field for debug packets
60 #define DEBUG_COMMAND_REQUEST (0 << 7)
61 #define DEBUG_COMMAND_RESPONSE (1 << 7)
63 #define IS_REQUEST(x) (((x)->Command & DEBUG_COMMAND_RESPONSE) == 0)
66 // HOST initiated commands
68 #define DEBUG_COMMAND_RESET (DEBUG_COMMAND_REQUEST | 0x00)
69 #define DEBUG_COMMAND_GO (DEBUG_COMMAND_REQUEST | 0x01)
70 #define DEBUG_COMMAND_BREAK_CAUSE (DEBUG_COMMAND_REQUEST | 0x02)
71 #define DEBUG_COMMAND_SET_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x03)
72 #define DEBUG_COMMAND_CLEAR_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x04)
73 #define DEBUG_COMMAND_SINGLE_STEPPING (DEBUG_COMMAND_REQUEST | 0x05)
74 #define DEBUG_COMMAND_SET_SW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x06)
75 #define DEBUG_COMMAND_READ_MEMORY (DEBUG_COMMAND_REQUEST | 0x07)
76 #define DEBUG_COMMAND_WRITE_MEMORY (DEBUG_COMMAND_REQUEST | 0x08)
77 #define DEBUG_COMMAND_READ_IO (DEBUG_COMMAND_REQUEST | 0x09)
78 #define DEBUG_COMMAND_WRITE_IO (DEBUG_COMMAND_REQUEST | 0x0A)
79 #define DEBUG_COMMAND_READ_REGISTER (DEBUG_COMMAND_REQUEST | 0x0B)
80 #define DEBUG_COMMAND_WRITE_REGISTER (DEBUG_COMMAND_REQUEST | 0x0C)
81 #define DEBUG_COMMAND_READ_ALL_REGISTERS (DEBUG_COMMAND_REQUEST | 0x0D)
82 #define DEBUG_COMMAND_ARCH_MODE (DEBUG_COMMAND_REQUEST | 0x0E)
83 #define DEBUG_COMMAND_READ_MSR (DEBUG_COMMAND_REQUEST | 0x0F)
84 #define DEBUG_COMMAND_WRITE_MSR (DEBUG_COMMAND_REQUEST | 0x10)
85 #define DEBUG_COMMAND_SET_DEBUG_SETTING (DEBUG_COMMAND_REQUEST | 0x11)
86 #define DEBUG_COMMAND_GET_REVISION (DEBUG_COMMAND_REQUEST | 0x12)
87 #define DEBUG_COMMAND_GET_EXCEPTION (DEBUG_COMMAND_REQUEST | 0x13)
88 #define DEBUG_COMMAND_SET_VIEWPOINT (DEBUG_COMMAND_REQUEST | 0x14)
89 #define DEBUG_COMMAND_GET_VIEWPOINT (DEBUG_COMMAND_REQUEST | 0x15)
90 #define DEBUG_COMMAND_DETACH (DEBUG_COMMAND_REQUEST | 0x16)
91 #define DEBUG_COMMAND_CPUID (DEBUG_COMMAND_REQUEST | 0x17)
92 #define DEBUG_COMMAND_SEARCH_SIGNATURE (DEBUG_COMMAND_REQUEST | 0x18)
93 #define DEBUG_COMMAND_HALT (DEBUG_COMMAND_REQUEST | 0x19)
96 // TARGET initiated commands
98 #define DEBUG_COMMAND_INIT_BREAK (DEBUG_COMMAND_REQUEST | 0x3F)
99 #define DEBUG_COMMAND_BREAK_POINT (DEBUG_COMMAND_REQUEST | 0x3E)
100 #define DEBUG_COMMAND_MEMORY_READY (DEBUG_COMMAND_REQUEST | 0x3D)
101 #define DEBUG_COMMAND_PRINT_MESSAGE (DEBUG_COMMAND_REQUEST | 0x3C)
102 #define DEBUG_COMMAND_ATTACH_BREAK (DEBUG_COMMAND_REQUEST | 0x3B)
107 #define DEBUG_COMMAND_OK (DEBUG_COMMAND_RESPONSE | 0x00)
108 #define DEBUG_COMMAND_RESEND (DEBUG_COMMAND_RESPONSE | 0x01)
109 #define DEBUG_COMMAND_ABORT (DEBUG_COMMAND_RESPONSE | 0x02)
111 // The below 2 commands are used when transferring big data (like > ~250 bytes).
115 // <= IN_PROGRESS with partial data
117 // (could have multiple IN_PROGRESS and CONTINUE interactions)
118 // <= OK with the last part of data
119 // OK (no data as ACK) =>
121 #define DEBUG_COMMAND_IN_PROGRESS (DEBUG_COMMAND_RESPONSE | 0x03)
122 #define DEBUG_COMMAND_CONTINUE (DEBUG_COMMAND_RESPONSE | 0x04)
124 // The below 2 commands are used to support deferred halt:
125 // TARGET returns HALT_DEFERRED when it receives a HALT request in inter-active mode.
126 // TARGET returns HALT_PROCESSED when it receives a GO request and has a pending HALT request.
128 #define DEBUG_COMMAND_HALT_DEFERRED (DEBUG_COMMAND_RESPONSE | 0x05)
129 #define DEBUG_COMMAND_HALT_PROCESSED (DEBUG_COMMAND_RESPONSE | 0x06)
131 #define DEBUG_COMMAND_TIMEOUT (DEBUG_COMMAND_RESPONSE | 0x07)
132 #define DEBUG_COMMAND_NOT_SUPPORTED (DEBUG_COMMAND_RESPONSE | 0x0F)
135 // Definition for data field for debug packets
137 #define DEBUG_DATA_UPPER_LIMIT 0xff // Upper limit for the data size, by the limit of the packet header definition.
139 #define DEBUG_DATA_MAXIMUM_REAL_DATA (DEBUG_DATA_UPPER_LIMIT - sizeof (DEBUG_PACKET_HEADER))
142 // Response data for DEBUG_COMMAND_BREAK_CAUSE
147 } DEBUG_DATA_RESPONSE_BREAK_CAUSE
;
149 // Break type defintions for DEBUG_DATA_BREAK_CAUSE
151 #define DEBUG_DATA_BREAK_CAUSE_UNKNOWN 0
152 #define DEBUG_DATA_BREAK_CAUSE_HW_BREAKPOINT 1
153 #define DEBUG_DATA_BREAK_CAUSE_STEPPING 2
154 #define DEBUG_DATA_BREAK_CAUSE_SW_BREAKPOINT 3
155 #define DEBUG_DATA_BREAK_CAUSE_USER_HALT 4
156 #define DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD 5
157 #define DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD 6
158 #define DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET 7
159 #define DEBUG_DATA_BREAK_CAUSE_EXCEPTION 8
160 #define DEBUG_DATA_BREAK_CAUSE_MEMORY_READY 9
163 // Response data for DEBUG_COMMAND_ARCH_MODE, defined as SOFT_DEBUGGER_PROCESSOR_...
167 } DEBUG_DATA_RESPONSE_ARCH_MODE
;
169 // Cpu architecture defintions for DEBUG_DATA_RESPONSE_ARCH_MODE
171 #define DEBUG_DATA_BREAK_CPU_ARCH_IA16 0
172 #define DEBUG_DATA_BREAK_CPU_ARCH_IA32 1
173 #define DEBUG_DATA_BREAK_CPU_ARCH_X64 2
176 UINT8 Length
:2; // Refer to below DEBUG_DATA_BREAKPOINT_LENGTH_XX macros
177 UINT8 Access
:2; // Refer to below DEBUG_DATA_BREAKPOINT_ACCESS_XX macros
178 UINT8 Index
:2; // Index of debug register
180 } DEBUG_DATA_BREAKPOINT_TYPE
;
181 #define DEBUG_DATA_BREAKPOINT_MEMORY_ACCESS (0x3)
182 #define DEBUG_DATA_BREAKPOINT_IO_ACCESS (0x2)
183 #define DEBUG_DATA_BREAKPOINT_MEMORY_WRITE (0x1)
184 #define DEBUG_DATA_BREAKPOINT_MEMORY_EXECUTE (0x0)
185 #define DEBUG_DATA_BREAKPOINT_LENGTH_32 (0x3)
186 #define DEBUG_DATA_BREAKPOINT_LENGTH_64 (0x2)
187 #define DEBUG_DATA_BREAKPOINT_LENGTH_16 (0x1)
188 #define DEBUG_DATA_BREAKPOINT_LENGTH_8 (0x0)
191 // Request data for DEBUG_COMMAND_SET_HW_BREAKPOINT
194 DEBUG_DATA_BREAKPOINT_TYPE Type
;
196 } DEBUG_DATA_SET_HW_BREAKPOINT
;
199 // Request data for DEBUG_COMMAND_CLEAR_HW_BREAKPOINT
202 UINT8 IndexMask
; // 0x0f will clear all hw breakpoints
203 } DEBUG_DATA_CLEAR_HW_BREAKPOINT
;
206 // Request and response data for DEBUG_COMMAND_SET_SW_BREAKPOINT
210 } DEBUG_DATA_SET_SW_BREAKPOINT
;
214 } DEBUG_DATA_RESPONSE_SET_SW_BREAKPOINT
;
217 // Request data for DEBUG_COMMAND_READ_MEMORY
223 } DEBUG_DATA_READ_MEMORY
;
226 // Request data for DEBUG_COMMAND_WRITE_MEMORY
232 UINT8 Data
[1]; // The actual length is (Width * Count)
233 } DEBUG_DATA_WRITE_MEMORY
;
236 // Request and response data for DEBUG_COMMAND_READ_IO
241 } DEBUG_DATA_READ_IO
;
244 UINT8 Data
[1]; // The actual length depends on the packet header
245 } DEBUG_DATA_RESPONSE_READ_IO
;
248 // Request data for DEBUG_COMMAND_WRITE_IO
253 UINT8 Data
[1]; // The actual length is Width
254 } DEBUG_DATA_WRITE_IO
;
257 // Request data for DEBUG_COMMAND_READ_REGISTER
260 UINT8 Index
; // defined as SOFT_DEBUGGER_REGISTER_XX
261 } DEBUG_DATA_READ_REGISTER
;
264 // Request data for DEBUG_COMMAND_WRITE_REGISTER
267 UINT8 Index
; // defined as SOFT_DEBUGGER_REGISTER_XX
269 UINT8 Data
[1]; // The actual length is Length
270 } DEBUG_DATA_WRITE_REGISTER
;
273 // Request and response data for DEBUG_COMMAND_READ_MSR
277 } DEBUG_DATA_READ_MSR
;
281 } DEBUG_DATA_RESPONSE_READ_MSR
;
284 // Request data for DEBUG_COMMAND_WRITE_MSR
289 } DEBUG_DATA_WRITE_MSR
;
292 // Response data for DEBUG_COMMAND_GET_REVISION
297 } DEBUG_DATA_RESPONSE_GET_REVISION
;
300 // Response data for DEBUG_COMMAND_GET_EXCEPTION
304 UINT32 ExceptionData
;
305 } DEBUG_DATA_RESPONSE_GET_EXCEPTION
;
308 // Request data for DEBUG_DATA_SET_DEBUG_SETTING
313 } DEBUG_DATA_SET_DEBUG_SETTING
;
317 #define DEBUG_AGENT_SETTING_SMM_ENTRY_BREAK 1
318 #define DEBUG_AGENT_SETTING_PRINT_ERROR_LEVEL 2
319 #define DEBUG_AGENT_SETTING_BOOT_SCRIPT_ENTRY_BREAK 3
321 // Bitmask of print error level for debug message
323 #define DEBUG_AGENT_ERROR BIT0
324 #define DEBUG_AGENT_WARNING BIT1
325 #define DEBUG_AGENT_INFO BIT2
326 #define DEBUG_AGENT_VERBOSE BIT3
329 // Request data for DEBUG_COMMAND_SET_VIEWPOINT
332 UINT32 ViewPoint
; // The index of viewpoint will be set
333 } DEBUG_DATA_SET_VIEWPOINT
;
336 // Response data for DEBUG_COMMAND_GET_VIEWPOINT
339 UINT32 ViewPoint
; // The index of viewpoint will be returned
340 } DEBUG_DATA_RESPONSE_GET_VIEWPOINT
;
343 // Request and response data for DEBUG_COMMAND_CPUID
346 UINT32 Eax
; // The value of EAX prior to invoking the CPUID instruction
347 UINT32 Ecx
; // The value of ECX prior to invoking the CPUID instruction
351 UINT32 Eax
; // The value of EAX returned by the CPUID instruction
352 UINT32 Ebx
; // The value of EBX returned by the CPUID instruction
353 UINT32 Ecx
; // The value of ECX returned by the CPUID instruction
354 UINT32 Edx
; // The value of EDX returned by the CPUID instruction
355 } DEBUG_DATA_RESPONSE_CPUID
;
358 // Request and response data for DEBUG_COMMAND_SEARCH_SIGNATURE
364 BOOLEAN Positive
; // TRUE to search in higher address memory
367 } DEBUG_DATA_SEARCH_SIGNATURE
;
370 UINT64 Address
; // -1 indicates not found
371 } DEBUG_DATA_RESPONSE_SEARCH_SIGNATURE
;