118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff/** @file 218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff Transfer protocol defintions used by debug agent and host. It is only 318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff intended to be used by Debug related module implementation. 418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 5d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR> 618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff This program and the accompanying materials 718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff are licensed and made available under the terms and conditions of the BSD License 818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff which accompanies this distribution. The full text of the license may be found at 918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff http://opensource.org/licenses/bsd-license.php. 1018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 1118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 1218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 1318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 1418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff**/ 1518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 1618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#ifndef __TRANSFER_PROTOCOL_H__ 1718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define __TRANSFER_PROTOCOL_H__ 1818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 1918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#include "ProcessorContext.h" 2093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff 2193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 2293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Current revision of transfer protocol 23d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni// 0.4: Packet compression and decompression. 2493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 25d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni#define DEBUG_AGENT_REVISION_03 ((0 << 16) | 03) 26d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni#define DEBUG_AGENT_REVISION_04 ((0 << 16) | 04) 27be73a0c4839f93de43b4db64f874cfe61a55acc0Ruiyu Ni#define DEBUG_AGENT_REVISION DEBUG_AGENT_REVISION_04 2893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_AGENT_CAPABILITIES 0 2918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 3018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 31d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni// Definitions for the (A)ttach command 3293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 33b422b62c01a490e7892864c04280d430a2566e3fvanjeff#define DEBUG_STARTING_SYMBOL_ATTACH (0xFA) 3418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 3518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 3693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Definition for starting symbol of a normal debug packet. Choose a non-ASCII to avoid conflict with other serial output. 3718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 3818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_STARTING_SYMBOL_NORMAL (0xFE) 3918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 40d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni// 41d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni// Definition for starting symbol of a (C)ompressed debug packet. Choose a non-ASCII to avoid conflict with other serial output. 42d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni// 43d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni#define DEBUG_STARTING_SYMBOL_COMPRESS (0xFC) 44d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni 4518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#pragma pack(1) 4618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 4718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 48d9044ec5553c946e20154b7b5c61cd3979472f60Ruiyu Ni// Definition for debug packet header for debug packets (not including attach command) 4918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 5018b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 5118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 StartSymbol; 5218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Command; 5393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Length; // Length of Debug Packet including header and payload in byte 54b422b62c01a490e7892864c04280d430a2566e3fvanjeff UINT8 SequenceNo; 55b422b62c01a490e7892864c04280d430a2566e3fvanjeff UINT16 Crc; 5693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_PACKET_HEADER; 5718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 5818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 5918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Definition for Command field for debug packets 6018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 6118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_COMMAND_REQUEST (0 << 7) 6218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_COMMAND_RESPONSE (1 << 7) 6318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 64ace354f10ba7ca424a96512b634ebee8225014f1Ruiyu Ni#define IS_REQUEST(x) (((x)->Command & DEBUG_COMMAND_RESPONSE) == 0) 65ace354f10ba7ca424a96512b634ebee8225014f1Ruiyu Ni 6618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 6793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// HOST initiated commands 6893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 6993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_RESET (DEBUG_COMMAND_REQUEST | 0x00) 7093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_GO (DEBUG_COMMAND_REQUEST | 0x01) 7193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_BREAK_CAUSE (DEBUG_COMMAND_REQUEST | 0x02) 7293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_SET_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x03) 7393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_CLEAR_HW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x04) 7493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_SINGLE_STEPPING (DEBUG_COMMAND_REQUEST | 0x05) 7593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_SET_SW_BREAKPOINT (DEBUG_COMMAND_REQUEST | 0x06) 7693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_READ_MEMORY (DEBUG_COMMAND_REQUEST | 0x07) 7793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_WRITE_MEMORY (DEBUG_COMMAND_REQUEST | 0x08) 7893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_READ_IO (DEBUG_COMMAND_REQUEST | 0x09) 7993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_WRITE_IO (DEBUG_COMMAND_REQUEST | 0x0A) 8093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_READ_REGISTER (DEBUG_COMMAND_REQUEST | 0x0B) 8193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_WRITE_REGISTER (DEBUG_COMMAND_REQUEST | 0x0C) 8293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_READ_ALL_REGISTERS (DEBUG_COMMAND_REQUEST | 0x0D) 8393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_ARCH_MODE (DEBUG_COMMAND_REQUEST | 0x0E) 8493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_READ_MSR (DEBUG_COMMAND_REQUEST | 0x0F) 8593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_WRITE_MSR (DEBUG_COMMAND_REQUEST | 0x10) 8693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_SET_DEBUG_SETTING (DEBUG_COMMAND_REQUEST | 0x11) 8793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_GET_REVISION (DEBUG_COMMAND_REQUEST | 0x12) 8893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_GET_EXCEPTION (DEBUG_COMMAND_REQUEST | 0x13) 8993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_SET_VIEWPOINT (DEBUG_COMMAND_REQUEST | 0x14) 9093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_GET_VIEWPOINT (DEBUG_COMMAND_REQUEST | 0x15) 9193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_DETACH (DEBUG_COMMAND_REQUEST | 0x16) 9293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_CPUID (DEBUG_COMMAND_REQUEST | 0x17) 9393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_SEARCH_SIGNATURE (DEBUG_COMMAND_REQUEST | 0x18) 94b422b62c01a490e7892864c04280d430a2566e3fvanjeff#define DEBUG_COMMAND_HALT (DEBUG_COMMAND_REQUEST | 0x19) 9593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff 9693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 9793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// TARGET initiated commands 9893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 9993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_INIT_BREAK (DEBUG_COMMAND_REQUEST | 0x3F) 10093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_BREAK_POINT (DEBUG_COMMAND_REQUEST | 0x3E) 10193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_MEMORY_READY (DEBUG_COMMAND_REQUEST | 0x3D) 10293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_PRINT_MESSAGE (DEBUG_COMMAND_REQUEST | 0x3C) 103b422b62c01a490e7892864c04280d430a2566e3fvanjeff#define DEBUG_COMMAND_ATTACH_BREAK (DEBUG_COMMAND_REQUEST | 0x3B) 10493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff 10593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 10693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Response commands 10793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 10893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_OK (DEBUG_COMMAND_RESPONSE | 0x00) 10993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_RESEND (DEBUG_COMMAND_RESPONSE | 0x01) 11093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_ABORT (DEBUG_COMMAND_RESPONSE | 0x02) 11193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 11293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// The below 2 commands are used when transferring big data (like > ~250 bytes). 11393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// The sequence is: 11493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// HOST TARGET 11593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request => 11693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// <= IN_PROGRESS with partial data 11793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// CONTINUE => 11893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// (could have multiple IN_PROGRESS and CONTINUE interactions) 11993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// <= OK with the last part of data 12093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// OK (no data as ACK) => 12193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 12293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_IN_PROGRESS (DEBUG_COMMAND_RESPONSE | 0x03) 12393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_CONTINUE (DEBUG_COMMAND_RESPONSE | 0x04) 12493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 12593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// The below 2 commands are used to support deferred halt: 12693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// TARGET returns HALT_DEFERRED when it receives a HALT request in inter-active mode. 12793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// TARGET returns HALT_PROCESSED when it receives a GO request and has a pending HALT request. 12893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 12993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_HALT_DEFERRED (DEBUG_COMMAND_RESPONSE | 0x05) 13093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_HALT_PROCESSED (DEBUG_COMMAND_RESPONSE | 0x06) 13193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff 13293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_TIMEOUT (DEBUG_COMMAND_RESPONSE | 0x07) 13393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_COMMAND_NOT_SUPPORTED (DEBUG_COMMAND_RESPONSE | 0x0F) 13418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 13518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 13618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Definition for data field for debug packets 13718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 13893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_UPPER_LIMIT 0xff // Upper limit for the data size, by the limit of the packet header definition. 13918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 14093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_MAXIMUM_REAL_DATA (DEBUG_DATA_UPPER_LIMIT - sizeof (DEBUG_PACKET_HEADER)) 14118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 14218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 14318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Response data for DEBUG_COMMAND_BREAK_CAUSE 14418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 14518b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 14618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Cause; 14718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT64 StopAddress; 14818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_BREAK_CAUSE; 14918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 15018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Break type defintions for DEBUG_DATA_BREAK_CAUSE 15118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 15218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_UNKNOWN 0 15318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_HW_BREAKPOINT 1 15418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_STEPPING 2 15518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_SW_BREAKPOINT 3 15618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_USER_HALT 4 15718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD 5 15818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD 6 15918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET 7 16018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_EXCEPTION 8 16118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CAUSE_MEMORY_READY 9 16218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 16318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 16418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Response data for DEBUG_COMMAND_ARCH_MODE, defined as SOFT_DEBUGGER_PROCESSOR_... 16518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 16618b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 16718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 CpuMode; 16818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_ARCH_MODE; 16918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 17018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Cpu architecture defintions for DEBUG_DATA_RESPONSE_ARCH_MODE 17118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 17218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CPU_ARCH_IA16 0 17318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CPU_ARCH_IA32 1 17418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#define DEBUG_DATA_BREAK_CPU_ARCH_X64 2 17518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 17618b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 17718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Length:2; // Refer to below DEBUG_DATA_BREAKPOINT_LENGTH_XX macros 17818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Access:2; // Refer to below DEBUG_DATA_BREAKPOINT_ACCESS_XX macros 17918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Index:2; // Index of debug register 18018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Reserved:2; 18118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_BREAKPOINT_TYPE; 18293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_MEMORY_ACCESS (0x3) 18393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_IO_ACCESS (0x2) 18493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_MEMORY_WRITE (0x1) 18593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_MEMORY_EXECUTE (0x0) 18693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_LENGTH_32 (0x3) 18793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_LENGTH_64 (0x2) 18893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_LENGTH_16 (0x1) 18993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_DATA_BREAKPOINT_LENGTH_8 (0x0) 19018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 19118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 19293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_SET_HW_BREAKPOINT 19318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 19418b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 19518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff DEBUG_DATA_BREAKPOINT_TYPE Type; 19618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT64 Address; 19718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_SET_HW_BREAKPOINT; 19818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 19918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 20093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_CLEAR_HW_BREAKPOINT 20118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 20218b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 20318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 IndexMask; // 0x0f will clear all hw breakpoints 20418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_CLEAR_HW_BREAKPOINT; 20518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 20618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 20793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request and response data for DEBUG_COMMAND_SET_SW_BREAKPOINT 20818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 20918b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 21018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT64 Address; 21118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_SET_SW_BREAKPOINT; 21218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 21318b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 21418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 OriginalData; 21518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_SET_SW_BREAKPOINT; 21618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 21718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 21893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_READ_MEMORY 21918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 22018b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 22118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT64 Address; 22293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Width; 22318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT16 Count; 22493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_DATA_READ_MEMORY; 22518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 22618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 22793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_WRITE_MEMORY 22818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 22918b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 23018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT64 Address; 23193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Width; 23218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT16 Count; 23393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Data[1]; // The actual length is (Width * Count) 23493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_DATA_WRITE_MEMORY; 23518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 23618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 23793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request and response data for DEBUG_COMMAND_READ_IO 23818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 23918b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 24093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT64 Port; 24118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Width; 24218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_READ_IO; 24318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 24418b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 24593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Data[1]; // The actual length depends on the packet header 24618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_READ_IO; 24718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 24818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 24993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_WRITE_IO 25018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 25118b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 25293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT64 Port; 25318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 Width; 25493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Data[1]; // The actual length is Width 25518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_WRITE_IO; 25618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 25718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 25893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_READ_REGISTER 25918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 26018b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 26193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Index; // defined as SOFT_DEBUGGER_REGISTER_XX 26218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_READ_REGISTER; 26318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 26418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 26593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_WRITE_REGISTER 26618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 26718b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 26893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Index; // defined as SOFT_DEBUGGER_REGISTER_XX 26993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Length; 27093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Data[1]; // The actual length is Length 27118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_WRITE_REGISTER; 27218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 27318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 27493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request and response data for DEBUG_COMMAND_READ_MSR 27518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 27618b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 27718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT32 Index; 27818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_READ_MSR; 27918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 28018b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 28118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT64 Value; 28218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_READ_MSR; 28318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 28418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 28593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_WRITE_MSR 28618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 28718b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 28818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT32 Index; 28918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT64 Value; 29018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_WRITE_MSR; 29118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 29218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 29318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Response data for DEBUG_COMMAND_GET_REVISION 29418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 29518b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 29618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT32 Revision; 29718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT32 Capabilities; 29818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_GET_REVISION; 29918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 30018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 30118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Response data for DEBUG_COMMAND_GET_EXCEPTION 30218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 30318b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 30418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT8 ExceptionNum; 30593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 ExceptionData; 30618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_GET_EXCEPTION; 30718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 30818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 30993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_DATA_SET_DEBUG_SETTING 31018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 31118b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 31293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Key; 31393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Value; 31493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_DATA_SET_DEBUG_SETTING; 31593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 31693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Supported keys 31793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 318b422b62c01a490e7892864c04280d430a2566e3fvanjeff#define DEBUG_AGENT_SETTING_SMM_ENTRY_BREAK 1 319b422b62c01a490e7892864c04280d430a2566e3fvanjeff#define DEBUG_AGENT_SETTING_PRINT_ERROR_LEVEL 2 320b422b62c01a490e7892864c04280d430a2566e3fvanjeff#define DEBUG_AGENT_SETTING_BOOT_SCRIPT_ENTRY_BREAK 3 32193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 32293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Bitmask of print error level for debug message 32393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 32493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_AGENT_ERROR BIT0 32593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_AGENT_WARNING BIT1 32693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_AGENT_INFO BIT2 32793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#define DEBUG_AGENT_VERBOSE BIT3 32818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 32918b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 33093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request data for DEBUG_COMMAND_SET_VIEWPOINT 33118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 33218b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 33318b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT32 ViewPoint; // The index of viewpoint will be set 33418b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_SET_VIEWPOINT; 33518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 33618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 33718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// Response data for DEBUG_COMMAND_GET_VIEWPOINT 33818b144ea424e476f14839e9d9d3b81fb4820a613vanjeff// 33918b144ea424e476f14839e9d9d3b81fb4820a613vanjefftypedef struct { 34018b144ea424e476f14839e9d9d3b81fb4820a613vanjeff UINT32 ViewPoint; // The index of viewpoint will be returned 34118b144ea424e476f14839e9d9d3b81fb4820a613vanjeff} DEBUG_DATA_RESPONSE_GET_VIEWPOINT; 34218b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 34393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 34493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request and response data for DEBUG_COMMAND_CPUID 34593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 34693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjefftypedef struct { 34793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Eax; // The value of EAX prior to invoking the CPUID instruction 34893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Ecx; // The value of ECX prior to invoking the CPUID instruction 34993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_DATA_CPUID; 35093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff 35193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjefftypedef struct { 35293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Eax; // The value of EAX returned by the CPUID instruction 35393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Ebx; // The value of EBX returned by the CPUID instruction 35493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Ecx; // The value of ECX returned by the CPUID instruction 35593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Edx; // The value of EDX returned by the CPUID instruction 35693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_DATA_RESPONSE_CPUID; 35718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 35893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 35993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// Request and response data for DEBUG_COMMAND_SEARCH_SIGNATURE 36093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff// 36193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjefftypedef struct { 36293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT64 Start; 36393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Count; 36493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT32 Alignment; 36593c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff BOOLEAN Positive; // TRUE to search in higher address memory 36693c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 DataLength; 36793c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT8 Data[1]; 36893c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_DATA_SEARCH_SIGNATURE; 36993c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff 37093c0bdec2807cd968a89a0ac01a379a90fa50f93vanjefftypedef struct { 37193c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff UINT64 Address; // -1 indicates not found 37293c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff} DEBUG_DATA_RESPONSE_SEARCH_SIGNATURE; 37393c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff 37493c0bdec2807cd968a89a0ac01a379a90fa50f93vanjeff#pragma pack() 37518b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 37618b144ea424e476f14839e9d9d3b81fb4820a613vanjeff#endif 37718b144ea424e476f14839e9d9d3b81fb4820a613vanjeff 378