2 Command header of for Debug Agent library instance.
4 Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _DEBUG_AGENT_H_
16 #define _DEBUG_AGENT_H_
18 #include <Register/LocalApic.h>
19 #include <Guid/DebugAgentGuid.h>
20 #include <Guid/VectorHandoffTable.h>
21 #include <Ppi/VectorHandoffInfo.h>
22 #include <Library/BaseLib.h>
23 #include <Library/BaseMemoryLib.h>
24 #include <Library/ResetSystemLib.h>
25 #include <Library/IoLib.h>
26 #include <Library/HobLib.h>
27 #include <Library/DebugCommunicationLib.h>
28 #include <Library/DebugAgentLib.h>
29 #include <Library/PcdLib.h>
30 #include <Library/SynchronizationLib.h>
31 #include <Library/LocalApicLib.h>
32 #include <Library/DebugLib.h>
33 #include <Library/TimerLib.h>
34 #include <Library/PrintLib.h>
35 #include <Library/PeCoffGetEntryPointLib.h>
36 #include <Library/PeCoffExtraActionLib.h>
38 #include <TransferProtocol.h>
39 #include <ImageDebugSupport.h>
42 #include "DebugTimer.h"
43 #include "ArchDebugSupport.h"
44 #include "DebugException.h"
47 // These macros may be already defined in DebugAgentLib.h
49 #define DEBUG_AGENT_INIT_PEI 9
50 #define DEBUG_AGENT_INIT_DXE_LOAD 10
51 #define DEBUG_AGENT_INIT_DXE_UNLOAD 11
52 #define DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64 12
54 #define DEBUG_INT1_VECTOR DEBUG_EXCEPT_DEBUG
55 #define DEBUG_INT3_VECTOR DEBUG_EXCEPT_BREAKPOINT
56 #define DEBUG_TIMER_VECTOR 32
57 #define DEBUG_MAILBOX_VECTOR 33
60 // Timeout value for reading packet (unit is microsecond)
62 #define READ_PACKET_TIMEOUT (500 * 1000)
64 #define SOFT_INTERRUPT_SIGNATURE SIGNATURE_32('S','O','F','T')
65 #define SYSTEM_RESET_SIGNATURE SIGNATURE_32('S','Y','S','R')
66 #define MEMORY_READY_SIGNATURE SIGNATURE_32('M','E','M','R')
68 extern UINTN Exception0Handle
;
69 extern UINTN TimerInterruptHandle
;
70 extern UINT32 ExceptionStubHeaderSize
;
71 extern BOOLEAN mSkipBreakpoint
;
72 extern EFI_VECTOR_HANDOFF_INFO mVectorHandoffInfoDebugAgent
[];
73 extern UINTN mVectorHandoffInfoCount
;
76 // CPU exception information issued by debug agent
80 // This field is used to save CPU content before executing HOST command
82 BASE_LIBRARY_JUMP_BUFFER JumpBuffer
;
84 // This field returns the exception information issued by the HOST command
86 DEBUG_DATA_RESPONSE_GET_EXCEPTION ExceptionContent
;
87 } DEBUG_AGENT_EXCEPTION_BUFFER
;
89 #define DEBUG_AGENT_FLAG_HOST_ATTACHED BIT0
90 #define DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS BIT1
91 #define DEBUG_AGENT_FLAG_MEMORY_READY BIT2
92 #define DEBUG_AGENT_FLAG_STEPPING BIT3
93 #define DEBUG_AGENT_FLAG_CHECK_MAILBOX_IN_HOB BIT4
94 #define DEBUG_AGENT_FLAG_INIT_ARCH BIT5|BIT6
95 #define DEBUG_AGENT_FLAG_BREAK_ON_NEXT_SMI BIT32
96 #define DEBUG_AGENT_FLAG_PRINT_ERROR_LEVEL (BIT33|BIT34|BIT35|BIT36)
97 #define DEBUG_AGENT_FLAG_BREAK_BOOT_SCRIPT BIT37
99 #define DEBUG_MAILBOX_DEBUG_FLAG_INDEX 1
100 #define DEBUG_MAILBOX_DEBUG_PORT_HANDLE_INDEX 2
101 #define DEBUG_MAILBOX_EXCEPTION_BUFFER_POINTER_INDEX 3
102 #define DEBUG_MAILBOX_LAST_ACK 4
103 #define DEBUG_MAILBOX_SEQUENCE_NO_INDEX 5
104 #define DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX 6
110 // Lower 32 bits to store the status of DebugAgent
112 UINT32 HostAttached
: 1; // 1: HOST is attached
113 UINT32 AgentInProgress
: 1; // 1: Debug Agent is communicating with HOST
114 UINT32 MemoryReady
: 1; // 1: Memory is ready
115 UINT32 SteppingFlag
: 1; // 1: Agent is running stepping command
116 UINT32 CheckMailboxInHob
: 1; // 1: Need to check mailbox saved in HOB
117 UINT32 InitArch
: 2; // value of DEBUG_DATA_RESPONSE_ARCH_MODE
118 UINT32 Reserved1
: 25;
120 // Higher 32bits to control the behavior of DebugAgent
122 UINT32 BreakOnNextSmi
: 1; // 1: Break on next SMI
123 UINT32 PrintErrorLevel
: 4; // Bitmask of print error level for debug message
124 UINT32 BreakOnBootScript
: 1; // 1: Break before executing boot script
125 UINT32 Reserved2
: 26;
131 DEBUG_AGENT_FLAG DebugFlag
;
132 UINT64 DebugPortHandle
;
134 // Pointer to DEBUG_AGENT_EXCEPTION_BUFFER
136 UINT64 ExceptionBufferPointer
;
137 UINT8 LastAck
; // The last ack packet type
139 UINT8 HostSequenceNo
;
140 UINT8 CheckSum
; // Mailbox checksum
141 UINT8 ToBeCheckSum
; // To be Mailbox checksum at the next
142 } DEBUG_AGENT_MAILBOX
;
146 /// Byte packed structure for an IA-32 Interrupt Gate Descriptor.
150 UINT32 OffsetLow
:16; ///< Offset bits 15..0.
151 UINT32 Selector
:16; ///< Selector.
152 UINT32 Reserved_0
:8; ///< Reserved.
153 UINT32 GateType
:8; ///< Gate Type. See #defines above.
154 UINT32 OffsetHigh
:16; ///< Offset bits 31..16.
162 UINT32 LimitLow
: 16;
169 UINT32 LimitHigh
: 4;
172 UINT32 DefaultSize
: 1;
173 UINT32 Granularity
: 1;
180 Initialize IDT entries to support source level debug.
189 Read register value from saved CPU context.
191 @param[in] CpuContext Pointer to saved CPU context.
192 @param[in] Index Register index value.
193 @param[in] Width Data width to read.
195 @return The address of register value.
199 ArchReadRegisterBuffer (
200 IN DEBUG_CPU_CONTEXT
*CpuContext
,
206 Send packet with response data to HOST.
208 @param[in] Data Pointer to response data buffer.
209 @param[in] DataSize Size of response data in byte.
211 @retval RETURN_SUCCESS Response data was sent successfully.
212 @retval RETURN_DEVICE_ERROR Cannot receive DEBUG_COMMAND_OK from HOST.
216 SendDataResponsePacket (
222 Check if HOST is attached based on Mailbox.
224 @retval TRUE HOST is attached.
225 @retval FALSE HOST is not attached.
234 Get Debug Agent Mailbox pointer.
236 @return Mailbox pointer.
239 DEBUG_AGENT_MAILBOX
*
245 Get debug port handle.
247 @return Debug port handle.
256 Read the Attach/Break-in symbols from the debug port.
258 @param[in] Handle Pointer to Debug Port handle.
259 @param[out] BreakSymbol Returned break symbol.
261 @retval EFI_SUCCESS Read the symbol in BreakSymbol.
262 @retval EFI_NOT_FOUND No read the break symbol.
266 DebugReadBreakSymbol (
267 IN DEBUG_PORT_HANDLE Handle
,
268 OUT UINT8
*BreakSymbol
272 Prints a debug message to the debug port if the specified error level is enabled.
274 If any bit in ErrorLevel is also set in Mainbox, then print the message specified
275 by Format and the associated variable argument list to the debug port.
277 @param[in] ErrorLevel The error level of the debug message.
278 @param[in] Format Format string for the debug message to print.
279 @param[in] ... Variable argument list whose contents are accessed
280 based on the format string specified by Format.
292 Trigger one software interrupt to debug agent to handle it.
294 @param[in] Signature Software interrupt signature.
298 TriggerSoftInterrupt (
303 Check if debug agent support multi-processor.
305 @retval TRUE Multi-processor is supported.
306 @retval FALSE Multi-processor is not supported.
310 MultiProcessorDebugSupport (
315 Find and report module image info to HOST.
317 @param[in] AlignSize Image aligned size.
321 FindAndReportModuleImageInfo (
326 Read IDT entry to check if IDT entries are setup by Debug Agent.
328 @retval TRUE IDT entries were setup by Debug Agent.
329 @retval FALSE IDT entries were not setup by Debug Agent.
333 IsDebugAgentInitialzed (
338 Caculate Mailbox checksum and update the checksum field.
340 @param[in] Mailbox Debug Agent Mailbox pointer.
344 UpdateMailboxChecksum (
345 IN DEBUG_AGENT_MAILBOX
*Mailbox
349 Verify Mailbox checksum.
351 If checksum error, print debug message and run init dead loop.
353 @param[in] Mailbox Debug Agent Mailbox pointer.
357 VerifyMailboxChecksum (
358 IN DEBUG_AGENT_MAILBOX
*Mailbox
362 Set debug flag in mailbox.
364 @param[in] FlagMask Debug flag mask value.
365 @param[in] FlagValue Debug flag value.
375 Get debug flag in mailbox.
377 @param[in] FlagMask Debug flag mask value.
379 @return Debug flag value.
388 Update Mailbox content by index.
390 @param[in] Mailbox Debug Agent Mailbox pointer.
391 @param[in] Index Mailbox content index.
392 @param[in] Value Value to be set into mail box.
396 UpdateMailboxContent (
397 IN DEBUG_AGENT_MAILBOX
*Mailbox
,
403 Retrieve exception handler from IDT table by ExceptionNum.
405 @param[in] ExceptionNum Exception number
407 @return Exception handler
411 GetExceptionHandlerInIdtEntry (
412 IN UINTN ExceptionNum
416 Set exception handler in IDT table by ExceptionNum.
418 @param[in] ExceptionNum Exception number
419 @param[in] ExceptionHandler Exception Handler to be set
423 SetExceptionHandlerInIdtEntry (
424 IN UINTN ExceptionNum
,
425 IN VOID
*ExceptionHandler
429 Prints a debug message to the debug output device if the specified error level is enabled.
431 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
432 GetDebugPrintErrorLevel (), then print the message specified by Format and the
433 associated variable argument list to the debug output device.
435 If Format is NULL, then ASSERT().
437 @param[in] ErrorLevel The error level of the debug message.
438 @param[in] IsSend Flag of debug message to declare that the data is being sent or being received.
439 @param[in] Data Variable argument list whose contents are accessed
440 @param[in] Length based on the format string specified by Format.
445 DebugAgentDataMsgPrint (
453 Read remaing debug packet except for the start symbol
455 @param[in] Handle Pointer to Debug Port handle.
456 @param[in, out] DebugHeader Debug header buffer including start symbol.
458 @retval EFI_SUCCESS Read the symbol in BreakSymbol.
459 @retval EFI_CRC_ERROR CRC check fail.
460 @retval EFI_TIMEOUT Timeout occurs when reading debug packet.
464 ReadRemainingBreakPacket (
465 IN DEBUG_PORT_HANDLE Handle
,
466 IN OUT DEBUG_PACKET_HEADER
*DebugHeader