]> git.proxmox.com Git - mirror_edk2.git/blob - SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
projects / mirror_edk2.git / blob
? search:


7f597352f1f2f8cd59e67d8eee9ac4067eac3b06
[mirror_edk2.git] / SourceLevelDebugPkg / Library / DebugAgent / DebugAgentCommon / DebugAgent.c
1 /** @file
2 Commond Debug Agent library implementition. It mainly includes
3 the first C function called by exception/interrupt handlers,
4 read/write debug packet to communication with HOST based on transfer
5 protocol.
6
7 Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php.
12
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15
16 **/
17
18 #include "DebugAgent.h"
19 #include "Ia32/DebugException.h"
20
21 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 mErrorMsgVersionAlert[] = "\rThe SourceLevelDebugPkg you are using requires a newer version of the Intel(R) UDK Debugger Tool.\r\n";
22 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 mErrorMsgSendInitPacket[] = "\rSend INIT break packet and try to connect the HOST (Intel(R) UDK Debugger Tool v1.4) ...\r\n";
23 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 mErrorMsgConnectOK[] = "HOST connection is successful!\r\n";
24 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 mErrorMsgConnectFail[] = "HOST connection is failed!\r\n";
25 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 mWarningMsgIngoreBreakpoint[] = "Ignore break point in SMM for SMI issued during DXE debugging!\r\n";
26
27 //
28 // Vector Handoff Info list used by Debug Agent for persist
29 //
30 GLOBAL_REMOVE_IF_UNREFERENCED EFI_VECTOR_HANDOFF_INFO mVectorHandoffInfoDebugAgent[] = {
31 {
32 DEBUG_EXCEPT_DIVIDE_ERROR, // Vector 0
33 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
34 EFI_DEBUG_AGENT_GUID
35 },
36 {
37 DEBUG_EXCEPT_DEBUG, // Vector 1
38 EFI_VECTOR_HANDOFF_DO_NOT_HOOK,
39 EFI_DEBUG_AGENT_GUID
40 },
41 {
42 DEBUG_EXCEPT_NMI, // Vector 2
43 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
44 EFI_DEBUG_AGENT_GUID
45 },
46 {
47 DEBUG_EXCEPT_BREAKPOINT, // Vector 3
48 EFI_VECTOR_HANDOFF_DO_NOT_HOOK,
49 EFI_DEBUG_AGENT_GUID
50 },
51 {
52 DEBUG_EXCEPT_OVERFLOW, // Vector 4
53 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
54 EFI_DEBUG_AGENT_GUID
55 },
56 {
57 DEBUG_EXCEPT_BOUND, // Vector 5
58 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
59 EFI_DEBUG_AGENT_GUID
60 },
61 {
62 DEBUG_EXCEPT_INVALID_OPCODE, // Vector 6
63 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
64 EFI_DEBUG_AGENT_GUID
65 },
66 {
67 DEBUG_EXCEPT_DOUBLE_FAULT, // Vector 8
68 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
69 EFI_DEBUG_AGENT_GUID
70 },
71 {
72 DEBUG_EXCEPT_INVALID_TSS, // Vector 10
73 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
74 EFI_DEBUG_AGENT_GUID
75 },
76 {
77 DEBUG_EXCEPT_SEG_NOT_PRESENT, // Vector 11
78 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
79 EFI_DEBUG_AGENT_GUID
80 },
81 {
82 DEBUG_EXCEPT_STACK_FAULT, // Vector 12
83 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
84 EFI_DEBUG_AGENT_GUID
85 },
86 {
87 DEBUG_EXCEPT_GP_FAULT, // Vector 13
88 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
89 EFI_DEBUG_AGENT_GUID
90 },
91 {
92 DEBUG_EXCEPT_PAGE_FAULT, // Vector 14
93 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
94 EFI_DEBUG_AGENT_GUID
95 },
96 {
97 DEBUG_EXCEPT_FP_ERROR, // Vector 16
98 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
99 EFI_DEBUG_AGENT_GUID
100 },
101 {
102 DEBUG_EXCEPT_ALIGNMENT_CHECK, // Vector 17
103 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
104 EFI_DEBUG_AGENT_GUID
105 },
106 {
107 DEBUG_EXCEPT_MACHINE_CHECK, // Vector 18
108 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
109 EFI_DEBUG_AGENT_GUID
110 },
111 {
112 DEBUG_EXCEPT_SIMD, // Vector 19
113 EFI_VECTOR_HANDOFF_HOOK_BEFORE,
114 EFI_DEBUG_AGENT_GUID
115 },
116 {
117 DEBUG_TIMER_VECTOR, // Vector 32
118 EFI_VECTOR_HANDOFF_DO_NOT_HOOK,
119 EFI_DEBUG_AGENT_GUID
120 },
121 {
122 DEBUG_MAILBOX_VECTOR, // Vector 33
123 EFI_VECTOR_HANDOFF_DO_NOT_HOOK,
124 EFI_DEBUG_AGENT_GUID
125 },
126 {
127 0,
128 EFI_VECTOR_HANDOFF_LAST_ENTRY,
129 { 0 }
130 }
131 };
132
133 GLOBAL_REMOVE_IF_UNREFERENCED UINTN mVectorHandoffInfoCount = sizeof (mVectorHandoffInfoDebugAgent) / sizeof (EFI_VECTOR_HANDOFF_INFO);
134
135 /**
136 Calculate CRC16 for target data.
137
138 @param[in] Data The target data.
139 @param[in] DataSize The target data size.
140 @param[in] Crc Initial CRC.
141
142 @return UINT16 The CRC16 value.
143
144 **/
145 UINT16
146 CalculateCrc16 (
147 IN UINT8 *Data,
148 IN UINTN DataSize,
149 IN UINT16 Crc
150 )
151 {
152 UINTN Index;
153 UINTN BitIndex;
154
155 for (Index = 0; Index < DataSize; Index++) {
156 Crc ^= (UINT16)Data[Index];
157 for (BitIndex = 0; BitIndex < 8; BitIndex++) {
158 if ((Crc & 0x8000) != 0) {
159 Crc <<= 1;
160 Crc ^= 0x1021;
161 } else {
162 Crc <<= 1;
163 }
164 }
165 }
166 return Crc;
167 }
168
169
170 /**
171 Read IDT entry to check if IDT entries are setup by Debug Agent.
172
173 @retval TRUE IDT entries were setup by Debug Agent.
174 @retval FALSE IDT entries were not setup by Debug Agent.
175
176 **/
177 BOOLEAN
178 IsDebugAgentInitialzed (
179 VOID
180 )
181 {
182 UINTN InterruptHandler;
183
184 InterruptHandler = (UINTN) GetExceptionHandlerInIdtEntry (0);
185 if (InterruptHandler >= 4 && *(UINT32 *)(InterruptHandler - 4) == AGENT_HANDLER_SIGNATURE) {
186 return TRUE;
187 } else {
188 return FALSE;
189 }
190 }
191
192 /**
193 Find and report module image info to HOST.
194
195 @param[in] AlignSize Image aligned size.
196
197 **/
198 VOID
199 FindAndReportModuleImageInfo (
200 IN UINTN AlignSize
201 )
202 {
203 UINTN Pe32Data;
204 EFI_IMAGE_DOS_HEADER *DosHdr;
205 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
206 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;
207
208 //
209 // Find Image Base
210 //
211 Pe32Data = ((UINTN)mErrorMsgVersionAlert) & ~(AlignSize - 1);
212 while (Pe32Data != 0) {
213 DosHdr = (EFI_IMAGE_DOS_HEADER *) Pe32Data;
214 if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {
215 //
216 // DOS image header is present, so read the PE header after the DOS image header.
217 //
218 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)(Pe32Data + (UINTN) ((DosHdr->e_lfanew) & 0x0ffff));
219 //
220 // Make sure PE header address does not overflow and is less than the initial address.
221 //
222 if (((UINTN)Hdr.Pe32 > Pe32Data) && ((UINTN)Hdr.Pe32 < (UINTN)mErrorMsgVersionAlert)) {
223 if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE) {
224 //
225 // It's PE image.
226 //
227 break;
228 }
229 }
230 } else {
231 //
232 // DOS image header is not present, TE header is at the image base.
233 //
234 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)Pe32Data;
235 if ((Hdr.Te->Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) &&
236 ((Hdr.Te->Machine == IMAGE_FILE_MACHINE_I386) || Hdr.Te->Machine == IMAGE_FILE_MACHINE_X64)) {
237 //
238 // It's TE image, it TE header and Machine type match
239 //
240 break;
241 }
242 }
243
244 //
245 // Not found the image base, check the previous aligned address
246 //
247 Pe32Data -= AlignSize;
248 }
249
250 ImageContext.ImageAddress = Pe32Data;
251 ImageContext.PdbPointer = PeCoffLoaderGetPdbPointer ((VOID*) (UINTN) ImageContext.ImageAddress);
252 PeCoffLoaderRelocateImageExtraAction (&ImageContext);
253 }
254
255 /**
256 Trigger one software interrupt to debug agent to handle it.
257
258 @param[in] Signature Software interrupt signature.
259
260 **/
261 VOID
262 TriggerSoftInterrupt (
263 IN UINT32 Signature
264 )
265 {
266 UINTN Dr0;
267 UINTN Dr1;
268
269 //
270 // Save Debug Register State
271 //
272 Dr0 = AsmReadDr0 ();
273 Dr1 = AsmReadDr1 ();
274
275 //
276 // DR0 = Signature
277 //
278 AsmWriteDr0 (SOFT_INTERRUPT_SIGNATURE);
279 AsmWriteDr1 (Signature);
280
281 //
282 // Do INT3 to communicate with HOST side
283 //
284 CpuBreakpoint ();
285
286 //
287 // Restore Debug Register State only when Host didn't change it inside exception handler.
288 // Dr registers can only be changed by setting the HW breakpoint.
289 //
290 AsmWriteDr0 (Dr0);
291 AsmWriteDr1 (Dr1);
292
293 }
294
295 /**
296 Calculate Mailbox checksum and update the checksum field.
297
298 @param[in] Mailbox Debug Agent Mailbox pointer.
299
300 **/
301 VOID
302 UpdateMailboxChecksum (
303 IN DEBUG_AGENT_MAILBOX *Mailbox
304 )
305 {
306 Mailbox->CheckSum = CalculateCheckSum8 ((UINT8 *)Mailbox, sizeof (DEBUG_AGENT_MAILBOX) - 2);
307 }
308
309 /**
310 Verify Mailbox checksum.
311
312 If checksum error, print debug message and run init dead loop.
313
314 @param[in] Mailbox Debug Agent Mailbox pointer.
315
316 **/
317 VOID
318 VerifyMailboxChecksum (
319 IN DEBUG_AGENT_MAILBOX *Mailbox
320 )
321 {
322 UINT8 CheckSum;
323
324 CheckSum = CalculateCheckSum8 ((UINT8 *) Mailbox, sizeof (DEBUG_AGENT_MAILBOX) - 2);
325 //
326 // The checksum updating process may be disturbed by hardware SMI, we need to check CheckSum field
327 // and ToBeCheckSum field to validate the mail box.
328 //
329 if (CheckSum != Mailbox->CheckSum && CheckSum != Mailbox->ToBeCheckSum) {
330 DEBUG ((EFI_D_ERROR, "DebugAgent: Mailbox checksum error, stack or heap crashed!\n"));
331 DEBUG ((EFI_D_ERROR, "DebugAgent: CheckSum = %x, Mailbox->CheckSum = %x, Mailbox->ToBeCheckSum = %x\n", CheckSum, Mailbox->CheckSum, Mailbox->ToBeCheckSum));
332 CpuDeadLoop ();
333 }
334 }
335
336 /**
337 Update Mailbox content by index.
338
339 @param[in] Mailbox Debug Agent Mailbox pointer.
340 @param[in] Index Mailbox content index.
341 @param[in] Value Value to be set into Mailbox.
342
343 **/
344 VOID
345 UpdateMailboxContent (
346 IN DEBUG_AGENT_MAILBOX *Mailbox,
347 IN UINTN Index,
348 IN UINT64 Value
349 )
350 {
351 AcquireMpSpinLock (&mDebugMpContext.MailboxSpinLock);
352 switch (Index) {
353 case DEBUG_MAILBOX_DEBUG_FLAG_INDEX:
354 Mailbox->ToBeCheckSum = Mailbox->CheckSum + CalculateSum8 ((UINT8 *)&Mailbox->DebugFlag.Uint64, sizeof(UINT64))
355 - CalculateSum8 ((UINT8 *)&Value, sizeof(UINT64));
356 Mailbox->DebugFlag.Uint64 = Value;
357 break;
358 case DEBUG_MAILBOX_DEBUG_PORT_HANDLE_INDEX:
359 Mailbox->ToBeCheckSum = Mailbox->CheckSum + CalculateSum8 ((UINT8 *)&Mailbox->DebugPortHandle, sizeof(UINTN))
360 - CalculateSum8 ((UINT8 *)&Value, sizeof(UINTN));
361 Mailbox->DebugPortHandle = (UINTN) Value;
362 break;
363 case DEBUG_MAILBOX_EXCEPTION_BUFFER_POINTER_INDEX:
364 Mailbox->ToBeCheckSum = Mailbox->CheckSum + CalculateSum8 ((UINT8 *)&Mailbox->ExceptionBufferPointer, sizeof(UINTN))
365 - CalculateSum8 ((UINT8 *)&Value, sizeof(UINTN));
366 Mailbox->ExceptionBufferPointer = (UINTN) Value;
367 break;
368 case DEBUG_MAILBOX_LAST_ACK:
369 Mailbox->ToBeCheckSum = Mailbox->CheckSum + CalculateSum8 ((UINT8 *)&Mailbox->LastAck, sizeof(UINT8))
370 - CalculateSum8 ((UINT8 *)&Value, sizeof(UINT8));
371 Mailbox->LastAck = (UINT8) Value;
372 break;
373 case DEBUG_MAILBOX_SEQUENCE_NO_INDEX:
374 Mailbox->ToBeCheckSum = Mailbox->CheckSum + CalculateSum8 ((UINT8 *)&Mailbox->SequenceNo, sizeof(UINT8))
375 - CalculateSum8 ((UINT8 *)&Value, sizeof(UINT8));
376 Mailbox->SequenceNo = (UINT8) Value;
377 break;
378 case DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX:
379 Mailbox->ToBeCheckSum = Mailbox->CheckSum + CalculateSum8 ((UINT8 *)&Mailbox->HostSequenceNo, sizeof(UINT8))
380 - CalculateSum8 ((UINT8 *)&Value, sizeof(UINT8));
381 Mailbox->HostSequenceNo = (UINT8) Value;
382 break;
383 case DEBUG_MAILBOX_DEBUG_TIMER_FREQUENCY:
384 Mailbox->ToBeCheckSum = Mailbox->CheckSum + CalculateSum8 ((UINT8 *)&Mailbox->DebugTimerFrequency, sizeof(UINT32))
385 - CalculateSum8 ((UINT8 *)&Value, sizeof(UINT32));
386 Mailbox->DebugTimerFrequency = (UINT32) Value;
387 break;
388 }
389 UpdateMailboxChecksum (Mailbox);
390 ReleaseMpSpinLock (&mDebugMpContext.MailboxSpinLock);
391 }
392
393 /**
394 Read data from debug device and save the data in buffer.
395
396 Reads NumberOfBytes data bytes from a debug device into the buffer
397 specified by Buffer. The number of bytes actually read is returned.
398 If the return value is less than NumberOfBytes, then the rest operation failed.
399 If NumberOfBytes is zero, then return 0.
400
401 @param Handle Debug port handle.
402 @param Buffer Pointer to the data buffer to store the data read from the debug device.
403 @param NumberOfBytes Number of bytes which will be read.
404 @param Timeout Timeout value for reading from debug device. It unit is Microsecond.
405
406 @retval 0 Read data failed, no data is to be read.
407 @retval >0 Actual number of bytes read from debug device.
408
409 **/
410 UINTN
411 DebugAgentReadBuffer (
412 IN DEBUG_PORT_HANDLE Handle,
413 IN UINT8 *Buffer,
414 IN UINTN NumberOfBytes,
415 IN UINTN Timeout
416 )
417 {
418 UINTN Index;
419 UINT32 Begin;
420 UINT32 TimeoutTicker;
421 UINT32 TimerRound;
422 UINT32 TimerFrequency;
423 UINT32 TimerCycle;
424
425 Begin = 0;
426 TimeoutTicker = 0;
427 TimerRound = 0;
428 TimerFrequency = GetMailboxPointer()->DebugTimerFrequency;
429 TimerCycle = GetApicTimerInitCount ();
430
431 if (Timeout != 0) {
432 Begin = GetApicTimerCurrentCount ();
433 TimeoutTicker = (UINT32) DivU64x32 (
434 MultU64x64 (
435 TimerFrequency,
436 Timeout
437 ),
438 1000000u
439 );
440 TimerRound = (UINT32) DivU64x32Remainder (TimeoutTicker, TimerCycle / 2, &TimeoutTicker);
441 }
442 Index = 0;
443 while (Index < NumberOfBytes) {
444 if (DebugPortPollBuffer (Handle)) {
445 DebugPortReadBuffer (Handle, Buffer + Index, 1, 0);
446 Index ++;
447 continue;
448 }
449 if (Timeout != 0) {
450 if (TimerRound == 0) {
451 if (IsDebugTimerTimeout (TimerCycle, Begin, TimeoutTicker)) {
452 //
453 // If time out occurs.
454 //
455 return 0;
456 }
457 } else {
458 if (IsDebugTimerTimeout (TimerCycle, Begin, TimerCycle / 2)) {
459 TimerRound --;
460 Begin = GetApicTimerCurrentCount ();
461 }
462 }
463 }
464 }
465
466 return Index;
467 }
468
469 /**
470 Set debug flag in mailbox.
471
472 @param[in] FlagMask Debug flag mask value.
473 @param[in] FlagValue Debug flag value.
474
475 **/
476 VOID
477 SetDebugFlag (
478 IN UINT64 FlagMask,
479 IN UINT32 FlagValue
480 )
481 {
482 DEBUG_AGENT_MAILBOX *Mailbox;
483 UINT64 Data64;
484
485 Mailbox = GetMailboxPointer ();
486 Data64 = (Mailbox->DebugFlag.Uint64 & ~FlagMask) |
487 (LShiftU64 ((UINT64)FlagValue, LowBitSet64 (FlagMask)) & FlagMask);
488 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_DEBUG_FLAG_INDEX, Data64);
489 }
490
491 /**
492 Get debug flag in mailbox.
493
494 @param[in] FlagMask Debug flag mask value.
495
496 @return Debug flag value.
497
498 **/
499 UINT32
500 GetDebugFlag (
501 IN UINT64 FlagMask
502 )
503 {
504 DEBUG_AGENT_MAILBOX *Mailbox;
505 UINT32 DebugFlag;
506
507 Mailbox = GetMailboxPointer ();
508 DebugFlag = (UINT32) RShiftU64 (Mailbox->DebugFlag.Uint64 & FlagMask, LowBitSet64 (FlagMask));
509
510 return DebugFlag;
511 }
512
513 /**
514 Send a debug message packet to the debug port.
515
516 @param[in] Buffer The debug message.
517 @param[in] Length The length of debug message.
518
519 **/
520 VOID
521 SendDebugMsgPacket (
522 IN CHAR8 *Buffer,
523 IN UINTN Length
524 )
525 {
526 DEBUG_PACKET_HEADER DebugHeader;
527 DEBUG_PORT_HANDLE Handle;
528
529 Handle = GetDebugPortHandle();
530
531 DebugHeader.StartSymbol = DEBUG_STARTING_SYMBOL_NORMAL;
532 DebugHeader.Command = DEBUG_COMMAND_PRINT_MESSAGE;
533 DebugHeader.Length = sizeof (DEBUG_PACKET_HEADER) + (UINT8) Length;
534 DebugHeader.SequenceNo = 0xEE;
535 DebugHeader.Crc = 0;
536 DebugHeader.Crc = CalculateCrc16 (
537 (UINT8 *)Buffer, Length,
538 CalculateCrc16 ((UINT8 *)&DebugHeader, sizeof (DEBUG_PACKET_HEADER), 0)
539 );
540
541 DebugPortWriteBuffer (Handle, (UINT8 *)&DebugHeader, sizeof (DEBUG_PACKET_HEADER));
542 DebugPortWriteBuffer (Handle, (UINT8 *)Buffer, Length);
543 }
544
545 /**
546 Prints a debug message to the debug port if the specified error level is enabled.
547
548 If any bit in ErrorLevel is also set in Mainbox, then print the message specified
549 by Format and the associated variable argument list to the debug port.
550
551 @param[in] ErrorLevel The error level of the debug message.
552 @param[in] Format Format string for the debug message to print.
553 @param[in] ... Variable argument list whose contents are accessed
554 based on the format string specified by Format.
555
556 **/
557 VOID
558 EFIAPI
559 DebugAgentMsgPrint (
560 IN UINT8 ErrorLevel,
561 IN CHAR8 *Format,
562 ...
563 )
564 {
565 CHAR8 Buffer[DEBUG_DATA_MAXIMUM_REAL_DATA];
566 VA_LIST Marker;
567
568 //
569 // Check driver debug mask value and global mask
570 //
571 if ((ErrorLevel & GetDebugFlag (DEBUG_AGENT_FLAG_PRINT_ERROR_LEVEL)) == 0) {
572 return;
573 }
574
575 //
576 // Convert the DEBUG() message to an ASCII String
577 //
578 VA_START (Marker, Format);
579 AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);
580 VA_END (Marker);
581
582 SendDebugMsgPacket (Buffer, AsciiStrLen (Buffer));
583 }
584
585 /**
586 Prints a debug message to the debug output device if the specified error level is enabled.
587
588 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
589 GetDebugPrintErrorLevel (), then print the message specified by Format and the
590 associated variable argument list to the debug output device.
591
592 If Format is NULL, then ASSERT().
593
594 @param[in] ErrorLevel The error level of the debug message.
595 @param[in] IsSend Flag of debug message to declare that the data is being sent or being received.
596 @param[in] Data Variable argument list whose contents are accessed
597 @param[in] Length based on the format string specified by Format.
598
599 **/
600 VOID
601 EFIAPI
602 DebugAgentDataMsgPrint (
603 IN UINT8 ErrorLevel,
604 IN BOOLEAN IsSend,
605 IN UINT8 *Data,
606 IN UINT8 Length
607 )
608 {
609 CHAR8 Buffer[DEBUG_DATA_MAXIMUM_REAL_DATA];
610 CHAR8 *DestBuffer;
611 UINTN Index;
612
613 //
614 // Check driver debug mask value and global mask
615 //
616 if ((ErrorLevel & GetDebugFlag (DEBUG_AGENT_FLAG_PRINT_ERROR_LEVEL)) == 0) {
617 return;
618 }
619
620 DestBuffer = Buffer;
621 if (IsSend) {
622 DestBuffer += AsciiSPrint (DestBuffer, DEBUG_DATA_MAXIMUM_REAL_DATA, "Sent data [ ");
623 } else {
624 DestBuffer += AsciiSPrint (DestBuffer, DEBUG_DATA_MAXIMUM_REAL_DATA, "Received data [ ");
625 }
626
627 Index = 0;
628 while (TRUE) {
629 if (DestBuffer - Buffer > DEBUG_DATA_MAXIMUM_REAL_DATA - 6) {
630 //
631 // If there was no enough space in buffer, send out the debug message,
632 // reserving 6 bytes is for the last data and end characters "]\n".
633 //
634 SendDebugMsgPacket (Buffer, DestBuffer - Buffer);
635 DestBuffer = Buffer;
636 }
637 DestBuffer += AsciiSPrint (DestBuffer, DEBUG_DATA_MAXIMUM_REAL_DATA - (DestBuffer - Buffer), "%02x ", Data[Index]);
638 Index ++;
639 if (Index >= Length) {
640 //
641 // The last character of debug message has been foramtted in buffer
642 //
643 DestBuffer += AsciiSPrint(DestBuffer, DEBUG_DATA_MAXIMUM_REAL_DATA - (DestBuffer - Buffer), "]\n");
644 SendDebugMsgPacket (Buffer, DestBuffer - Buffer);
645 break;
646 }
647 }
648 }
649
650 /**
651 Read remaing debug packet except for the start symbol
652
653 @param[in] Handle Pointer to Debug Port handle.
654 @param[in, out] DebugHeader Debug header buffer including start symbol.
655
656 @retval EFI_SUCCESS Read the symbol in BreakSymbol.
657 @retval EFI_CRC_ERROR CRC check fail.
658 @retval EFI_TIMEOUT Timeout occurs when reading debug packet.
659 @retval EFI_DEVICE_ERROR Receive the old or responsed packet.
660
661 **/
662 EFI_STATUS
663 ReadRemainingBreakPacket (
664 IN DEBUG_PORT_HANDLE Handle,
665 IN OUT DEBUG_PACKET_HEADER *DebugHeader
666 )
667 {
668 UINT16 Crc;
669 DEBUG_AGENT_MAILBOX *Mailbox;
670
671 //
672 // Has received start symbol, try to read the rest part
673 //
674 if (DebugAgentReadBuffer (Handle, (UINT8 *)DebugHeader + OFFSET_OF (DEBUG_PACKET_HEADER, Command), sizeof (DEBUG_PACKET_HEADER) - OFFSET_OF (DEBUG_PACKET_HEADER, Command), READ_PACKET_TIMEOUT) == 0) {
675 //
676 // Timeout occur, exit
677 //
678 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Timeout in Debug Timer interrupt\n");
679 return EFI_TIMEOUT;
680 }
681
682 Crc = DebugHeader->Crc;
683 DebugHeader->Crc = 0;
684 if (CalculateCrc16 ((UINT8 *)DebugHeader, DebugHeader->Length, 0) != Crc) {
685 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Debug Timer CRC (%x) against (%x)\n", Crc, CalculateCrc16 ((UINT8 *) &DebugHeader, DebugHeader->Length, 0));
686 DebugAgentDataMsgPrint (DEBUG_AGENT_VERBOSE, FALSE, (UINT8 *)DebugHeader, DebugHeader->Length);
687 return EFI_CRC_ERROR;
688 }
689 Mailbox = GetMailboxPointer();
690 if (IS_REQUEST (DebugHeader)) {
691 if (DebugHeader->SequenceNo == (UINT8) (Mailbox->HostSequenceNo + 1)) {
692 //
693 // Only updagte HostSequenceNo for new command packet
694 //
695 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, DebugHeader->SequenceNo);
696 return EFI_SUCCESS;
697 }
698 if (DebugHeader->SequenceNo == Mailbox->HostSequenceNo) {
699 return EFI_SUCCESS;
700 }
701 }
702
703 return EFI_DEVICE_ERROR;
704 }
705
706 /**
707 Check if HOST is attached based on Mailbox.
708
709 @retval TRUE HOST is attached.
710 @retval FALSE HOST is not attached.
711
712 **/
713 BOOLEAN
714 IsHostAttached (
715 VOID
716 )
717 {
718 return (BOOLEAN) (GetDebugFlag (DEBUG_AGENT_FLAG_HOST_ATTACHED) == 1);
719 }
720
721 /**
722 Set HOST connect flag in Mailbox.
723
724 @param[in] Attached Attach status.
725
726 **/
727 VOID
728 SetHostAttached (
729 IN BOOLEAN Attached
730 )
731 {
732 DebugAgentMsgPrint (DEBUG_AGENT_INFO, "Attach status is %d\n", Attached);
733 SetDebugFlag (DEBUG_AGENT_FLAG_HOST_ATTACHED, (UINT32)Attached);
734 }
735
736 /**
737 Set debug setting of Debug Agent in Mailbox.
738
739 @param DebugSetting Pointer to Debug Setting defined by transfer protocol.
740
741 @retval RETURN_SUCCESS The setting is set successfully.
742 @retval RETURN_UNSUPPORTED The Key value is not supported.
743
744 **/
745 RETURN_STATUS
746 SetDebugSetting (
747 IN DEBUG_DATA_SET_DEBUG_SETTING *DebugSetting
748 )
749 {
750 RETURN_STATUS Status;
751
752 Status = RETURN_SUCCESS;
753 switch (DebugSetting->Key) {
754 case DEBUG_AGENT_SETTING_SMM_ENTRY_BREAK:
755 SetDebugFlag (DEBUG_AGENT_FLAG_BREAK_ON_NEXT_SMI, DebugSetting->Value);
756 break;
757 case DEBUG_AGENT_SETTING_PRINT_ERROR_LEVEL:
758 SetDebugFlag (DEBUG_AGENT_FLAG_PRINT_ERROR_LEVEL, DebugSetting->Value);
759 break;
760 case DEBUG_AGENT_SETTING_BOOT_SCRIPT_ENTRY_BREAK:
761 SetDebugFlag (DEBUG_AGENT_FLAG_BREAK_BOOT_SCRIPT, DebugSetting->Value);
762 break;
763 default:
764 Status = RETURN_UNSUPPORTED;
765 }
766 return Status;
767 }
768
769 /**
770 Exectue GO command.
771
772 @param[in] CpuContext Pointer to saved CPU context.
773
774 **/
775 VOID
776 CommandGo (
777 IN DEBUG_CPU_CONTEXT *CpuContext
778 )
779 {
780 IA32_EFLAGS32 *Eflags;
781
782 Eflags = (IA32_EFLAGS32 *) &CpuContext->Eflags;
783 Eflags->Bits.TF = 0;
784 Eflags->Bits.RF = 1;
785 }
786
787 /**
788 Execute Stepping command.
789
790 @param[in] CpuContext Pointer to saved CPU context.
791
792 **/
793 VOID
794 CommandStepping (
795 IN DEBUG_CPU_CONTEXT *CpuContext
796 )
797 {
798 IA32_EFLAGS32 *Eflags;
799
800 Eflags = (IA32_EFLAGS32 *) &CpuContext->Eflags;
801 Eflags->Bits.TF = 1;
802 Eflags->Bits.RF = 1;
803 //
804 // Save and clear EFLAGS.IF to avoid interrupt happen when executing Stepping
805 //
806 SetDebugFlag (DEBUG_AGENT_FLAG_INTERRUPT_FLAG, Eflags->Bits.IF);
807 Eflags->Bits.IF = 0;
808 //
809 // Set Stepping Flag
810 //
811 SetDebugFlag (DEBUG_AGENT_FLAG_STEPPING, 1);
812 }
813
814 /**
815 Do some cleanup after Stepping command done.
816
817 @param[in] CpuContext Pointer to saved CPU context.
818
819 **/
820 VOID
821 CommandSteppingCleanup (
822 IN DEBUG_CPU_CONTEXT *CpuContext
823 )
824 {
825 IA32_EFLAGS32 *Eflags;
826
827 Eflags = (IA32_EFLAGS32 *) &CpuContext->Eflags;
828 //
829 // Restore EFLAGS.IF
830 //
831 Eflags->Bits.IF = GetDebugFlag (DEBUG_AGENT_FLAG_INTERRUPT_FLAG);
832 //
833 // Clear Stepping flag
834 //
835 SetDebugFlag (DEBUG_AGENT_FLAG_STEPPING, 0);
836 }
837
838 /**
839 Set debug register for hardware breakpoint.
840
841 @param[in] CpuContext Pointer to saved CPU context.
842 @param[in] SetHwBreakpoint Hardware breakpoint to be set.
843
844 **/
845 VOID
846 SetDebugRegister (
847 IN DEBUG_CPU_CONTEXT *CpuContext,
848 IN DEBUG_DATA_SET_HW_BREAKPOINT *SetHwBreakpoint
849 )
850 {
851 UINT8 RegisterIndex;
852 UINTN Dr7Value;
853
854 RegisterIndex = SetHwBreakpoint->Type.Index;
855
856 //
857 // Set debug address
858 //
859 * ((UINTN *) &CpuContext->Dr0 + RegisterIndex) = (UINTN) SetHwBreakpoint->Address;
860
861 Dr7Value = CpuContext->Dr7;
862
863 //
864 // Enable Gx, Lx
865 //
866 Dr7Value |= (UINTN) (0x3 << (RegisterIndex * 2));
867 //
868 // Set RWx and Lenx
869 //
870 Dr7Value &= (UINTN) (~(0xf << (16 + RegisterIndex * 4)));
871 Dr7Value |= (UINTN) ((SetHwBreakpoint->Type.Length << 2) | SetHwBreakpoint->Type.Access) << (16 + RegisterIndex * 4);
872 //
873 // Enable GE, LE
874 //
875 Dr7Value |= 0x300;
876
877 CpuContext->Dr7 = Dr7Value;
878 }
879
880 /**
881 Clear debug register for hardware breakpoint.
882
883 @param[in] CpuContext Pointer to saved CPU context.
884 @param[in] ClearHwBreakpoint Hardware breakpoint to be cleared.
885
886 **/
887 VOID
888 ClearDebugRegister (
889 IN DEBUG_CPU_CONTEXT *CpuContext,
890 IN DEBUG_DATA_CLEAR_HW_BREAKPOINT *ClearHwBreakpoint
891 )
892 {
893 if ((ClearHwBreakpoint->IndexMask & BIT0) != 0) {
894 CpuContext->Dr0 = 0;
895 CpuContext->Dr7 &= (UINTN)(~(0x3 << 0));
896 }
897 if ((ClearHwBreakpoint->IndexMask & BIT1) != 0) {
898 CpuContext->Dr1 = 0;
899 CpuContext->Dr7 &= (UINTN)(~(0x3 << 2));
900 }
901 if ((ClearHwBreakpoint->IndexMask & BIT2) != 0) {
902 CpuContext->Dr2 = 0;
903 CpuContext->Dr7 &= (UINTN)(~(0x3 << 4));
904 }
905 if ((ClearHwBreakpoint->IndexMask & BIT3) != 0) {
906 CpuContext->Dr3 = 0;
907 CpuContext->Dr7 &= (UINTN)(~(0x3 << 6));
908 }
909 }
910
911
912 /**
913 Return the offset of FP / MMX / XMM registers in the FPU saved state by register index.
914
915 @param[in] Index Register index.
916 @param[out] Width Register width returned.
917
918 @return Offset in the FPU Save State.
919
920 **/
921 UINT16
922 ArchReadFxStatOffset (
923 IN UINT8 Index,
924 OUT UINT8 *Width
925 )
926 {
927 if (Index < SOFT_DEBUGGER_REGISTER_ST0) {
928 switch (Index) {
929 case SOFT_DEBUGGER_REGISTER_FP_FCW:
930 *Width = (UINT8) sizeof (UINT16);
931 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Fcw);
932
933 case SOFT_DEBUGGER_REGISTER_FP_FSW:
934 *Width = (UINT8) sizeof (UINT16);
935 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Fsw);
936
937 case SOFT_DEBUGGER_REGISTER_FP_FTW:
938 *Width = (UINT8) sizeof (UINT16);
939 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Ftw);
940
941 case SOFT_DEBUGGER_REGISTER_FP_OPCODE:
942 *Width = (UINT8) sizeof (UINT16);
943 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Opcode);
944
945 case SOFT_DEBUGGER_REGISTER_FP_EIP:
946 *Width = (UINT8) sizeof (UINT32);
947 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Eip);
948
949 case SOFT_DEBUGGER_REGISTER_FP_CS:
950 *Width = (UINT8) sizeof (UINT16);
951 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Cs);
952
953 case SOFT_DEBUGGER_REGISTER_FP_DATAOFFSET:
954 *Width = (UINT8) sizeof (UINT32);
955 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, DataOffset);
956
957 case SOFT_DEBUGGER_REGISTER_FP_DS:
958 *Width = (UINT8) sizeof (UINT16);
959 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Ds);
960
961 case SOFT_DEBUGGER_REGISTER_FP_MXCSR:
962 *Width = (UINT8) sizeof (UINT32);
963 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Mxcsr);
964
965 case SOFT_DEBUGGER_REGISTER_FP_MXCSR_MASK:
966 *Width = (UINT8) sizeof (UINT32);
967 return OFFSET_OF(DEBUG_DATA_FX_SAVE_STATE, Mxcsr_Mask);
968 }
969 }
970
971 if (Index <= SOFT_DEBUGGER_REGISTER_ST7) {
972 *Width = 10;
973 } else if (Index <= SOFT_DEBUGGER_REGISTER_XMM15) {
974 *Width = 16;
975 } else {
976 //
977 // MMX register
978 //
979 *Width = 8;
980 Index -= SOFT_DEBUGGER_REGISTER_MM0 - SOFT_DEBUGGER_REGISTER_ST0;
981 }
982
983 return OFFSET_OF (DEBUG_DATA_FX_SAVE_STATE, St0Mm0) + (Index - SOFT_DEBUGGER_REGISTER_ST0) * 16;
984 }
985
986 /**
987 Return the pointer of the register value in the CPU saved context.
988
989 @param[in] CpuContext Pointer to saved CPU context.
990 @param[in] Index Register index value.
991 @param[out] Width Data width to read.
992
993 @return The pointer in the CPU saved context.
994
995 **/
996 UINT8 *
997 ArchReadRegisterBuffer (
998 IN DEBUG_CPU_CONTEXT *CpuContext,
999 IN UINT8 Index,
1000 OUT UINT8 *Width
1001 )
1002 {
1003 UINT8 *Buffer;
1004
1005 if (Index < SOFT_DEBUGGER_REGISTER_FP_BASE) {
1006 Buffer = (UINT8 *) CpuContext + OFFSET_OF (DEBUG_CPU_CONTEXT, Dr0) + Index * sizeof (UINTN);
1007 *Width = (UINT8) sizeof (UINTN);
1008 } else {
1009 //
1010 // FPU/MMX/XMM registers
1011 //
1012 Buffer = (UINT8 *) CpuContext + OFFSET_OF (DEBUG_CPU_CONTEXT, FxSaveState) + ArchReadFxStatOffset (Index, Width);
1013 }
1014
1015 return Buffer;
1016 }
1017
1018 /**
1019 Send the packet without data to HOST.
1020
1021 @param[in] CommandType Type of Command.
1022 @param[in] SequenceNo Sequence number.
1023
1024 **/
1025 VOID
1026 SendPacketWithoutData (
1027 IN UINT8 CommandType,
1028 IN UINT8 SequenceNo
1029 )
1030 {
1031 DEBUG_PACKET_HEADER DebugHeader;
1032 DEBUG_PORT_HANDLE Handle;
1033
1034 Handle = GetDebugPortHandle();
1035
1036 DebugHeader.StartSymbol = DEBUG_STARTING_SYMBOL_NORMAL;
1037 DebugHeader.Command = CommandType;
1038 DebugHeader.Length = sizeof (DEBUG_PACKET_HEADER);
1039 DebugHeader.SequenceNo = SequenceNo;
1040 DebugHeader.Crc = 0;
1041 DebugHeader.Crc = CalculateCrc16 ((UINT8 *)&DebugHeader, sizeof (DEBUG_PACKET_HEADER), 0);
1042
1043 DebugAgentDataMsgPrint (DEBUG_AGENT_VERBOSE, TRUE, (UINT8 *) &DebugHeader, DebugHeader.Length);
1044 DebugPortWriteBuffer (Handle, (UINT8 *) &DebugHeader, DebugHeader.Length);
1045 }
1046
1047 /**
1048 Send acknowledge packet to HOST.
1049
1050 @param[in] AckCommand Type of Acknowledge packet.
1051
1052 **/
1053 VOID
1054 SendAckPacket (
1055 IN UINT8 AckCommand
1056 )
1057 {
1058 UINT8 SequenceNo;
1059 DEBUG_AGENT_MAILBOX *Mailbox;
1060
1061 if (AckCommand != DEBUG_COMMAND_OK) {
1062 //
1063 // This is not ACK OK packet
1064 //
1065 DebugAgentMsgPrint (DEBUG_AGENT_ERROR, "Send ACK(%d)\n", AckCommand);
1066 }
1067 Mailbox = GetMailboxPointer();
1068 SequenceNo = Mailbox->HostSequenceNo;
1069 DebugAgentMsgPrint (DEBUG_AGENT_INFO, "SendAckPacket: SequenceNo = %x\n", SequenceNo);
1070 SendPacketWithoutData (AckCommand, SequenceNo);
1071 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_LAST_ACK, AckCommand);
1072 }
1073
1074 /**
1075 Decompress the Data in place.
1076
1077 @param[in, out] Data The compressed data buffer.
1078 The buffer is assumed large enough to hold the uncompressed data.
1079 @param[in] Length The length of the compressed data buffer.
1080
1081 @return The length of the uncompressed data buffer.
1082 **/
1083 UINT8
1084 DecompressDataInPlace (
1085 IN OUT UINT8 *Data,
1086 IN UINTN Length
1087 )
1088 {
1089 UINTN Index;
1090 UINT16 LastChar;
1091 UINTN LastCharCount;
1092 UINT8 CurrentChar;
1093
1094 LastChar = (UINT16) -1;
1095 LastCharCount = 0;
1096 for (Index = 0; Index < Length; Index++) {
1097 CurrentChar = Data[Index];
1098 if (LastCharCount == 2) {
1099 LastCharCount = 0;
1100 CopyMem (&Data[Index + CurrentChar], &Data[Index + 1], Length - Index - 1);
1101 SetMem (&Data[Index], CurrentChar, (UINT8) LastChar);
1102 LastChar = (UINT16) -1;
1103 Index += CurrentChar - 1;
1104 Length += CurrentChar - 1;
1105 } else {
1106 if (LastChar != CurrentChar) {
1107 LastCharCount = 0;
1108 }
1109 LastCharCount++;
1110 LastChar = CurrentChar;
1111 }
1112 }
1113
1114 ASSERT (Length <= DEBUG_DATA_MAXIMUM_REAL_DATA);
1115
1116 return (UINT8) Length;
1117 }
1118
1119 /**
1120 Receive valid packet from HOST.
1121
1122 @param[out] InputPacket Buffer to receive packet.
1123 @param[out] BreakReceived TRUE means break-in symbol received.
1124 FALSE means break-in symbol not received.
1125 @param[out] IncompatibilityFlag If IncompatibilityFlag is not NULL, return
1126 TRUE: Compatible packet received.
1127 FALSE: Incompatible packet received.
1128 @param[in] Timeout Time out value to wait for acknowlege from HOST.
1129 The unit is microsecond.
1130 @param[in] SkipStartSymbol TRUE: Skip time out when reading start symbol.
1131 FALSE: Does not Skip time out when reading start symbol.
1132
1133 @retval RETURN_SUCCESS A valid package was reveived in InputPacket.
1134 @retval RETURN_TIMEOUT Timeout occurs.
1135
1136 **/
1137 RETURN_STATUS
1138 ReceivePacket (
1139 OUT UINT8 *InputPacket,
1140 OUT BOOLEAN *BreakReceived,
1141 OUT BOOLEAN *IncompatibilityFlag, OPTIONAL
1142 IN UINTN Timeout,
1143 IN BOOLEAN SkipStartSymbol
1144 )
1145 {
1146 DEBUG_PACKET_HEADER *DebugHeader;
1147 UINTN Received;
1148 DEBUG_PORT_HANDLE Handle;
1149 UINT16 Crc;
1150 UINTN TimeoutForStartSymbol;
1151
1152 Handle = GetDebugPortHandle();
1153 if (SkipStartSymbol) {
1154 TimeoutForStartSymbol = 0;
1155 } else {
1156 TimeoutForStartSymbol = Timeout;
1157 }
1158
1159 DebugHeader = (DEBUG_PACKET_HEADER *) InputPacket;
1160 while (TRUE) {
1161 //
1162 // Find the valid start symbol
1163 //
1164 Received = DebugAgentReadBuffer (Handle, &DebugHeader->StartSymbol, sizeof (DebugHeader->StartSymbol), TimeoutForStartSymbol);
1165 if (Received < sizeof (DebugHeader->StartSymbol)) {
1166 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "DebugAgentReadBuffer(StartSymbol) timeout\n");
1167 return RETURN_TIMEOUT;
1168 }
1169
1170 if ((DebugHeader->StartSymbol != DEBUG_STARTING_SYMBOL_NORMAL) && (DebugHeader->StartSymbol != DEBUG_STARTING_SYMBOL_COMPRESS)) {
1171 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Invalid start symbol received [%02x]\n", DebugHeader->StartSymbol);
1172 continue;
1173 }
1174
1175 //
1176 // Read Package header till field Length
1177 //
1178 Received = DebugAgentReadBuffer (
1179 Handle,
1180 (UINT8 *) DebugHeader + OFFSET_OF (DEBUG_PACKET_HEADER, Command),
1181 OFFSET_OF (DEBUG_PACKET_HEADER, Length) + sizeof (DebugHeader->Length) - sizeof (DebugHeader->StartSymbol),
1182 Timeout
1183 );
1184 if (Received == 0) {
1185 DebugAgentMsgPrint (DEBUG_AGENT_ERROR, "DebugAgentReadBuffer(Command) timeout\n");
1186 return RETURN_TIMEOUT;
1187 }
1188 if (DebugHeader->Length < sizeof (DEBUG_PACKET_HEADER)) {
1189 if (IncompatibilityFlag != NULL) {
1190 //
1191 // This is one old version debug packet format, set Incompatibility flag
1192 //
1193 *IncompatibilityFlag = TRUE;
1194 } else {
1195 //
1196 // Skip the bad small packet
1197 //
1198 continue;
1199 }
1200 } else {
1201 //
1202 // Read the payload data include the CRC field
1203 //
1204 Received = DebugAgentReadBuffer (Handle, &DebugHeader->SequenceNo, (UINT8) (DebugHeader->Length - OFFSET_OF (DEBUG_PACKET_HEADER, SequenceNo)), Timeout);
1205 if (Received == 0) {
1206 DebugAgentMsgPrint (DEBUG_AGENT_ERROR, "DebugAgentReadBuffer(SequenceNo) timeout\n");
1207 return RETURN_TIMEOUT;
1208 }
1209 //
1210 // Calculate the CRC of Debug Packet
1211 //
1212 Crc = DebugHeader->Crc;
1213 DebugHeader->Crc = 0;
1214 if (Crc == CalculateCrc16 ((UINT8 *) DebugHeader, DebugHeader->Length, 0)) {
1215 break;
1216 }
1217 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "CRC Error (received CRC is %x)\n", Crc);
1218 DebugAgentDataMsgPrint (DEBUG_AGENT_VERBOSE, FALSE, (UINT8 *) DebugHeader, DebugHeader->Length);
1219 }
1220 }
1221
1222 DebugAgentDataMsgPrint (DEBUG_AGENT_VERBOSE, FALSE, (UINT8 *) DebugHeader, DebugHeader->Length);
1223
1224 if (DebugHeader->StartSymbol == DEBUG_STARTING_SYMBOL_COMPRESS) {
1225 DebugHeader->StartSymbol = DEBUG_STARTING_SYMBOL_NORMAL;
1226 DebugHeader->Length = DecompressDataInPlace (
1227 (UINT8 *) (DebugHeader + 1), DebugHeader->Length - sizeof (DEBUG_PACKET_HEADER)
1228 ) + sizeof (DEBUG_PACKET_HEADER);
1229 }
1230 return RETURN_SUCCESS;
1231 }
1232
1233 /**
1234 Receive acknowledge packet OK from HOST in specified time.
1235
1236 @param[in] Command The command type issued by TARGET.
1237 @param[in] Timeout Time out value to wait for acknowlege from HOST.
1238 The unit is microsecond.
1239 @param[out] BreakReceived If BreakReceived is not NULL,
1240 TRUE is retured if break-in symbol received.
1241 FALSE is retured if break-in symbol not received.
1242 @param[out] IncompatibilityFlag If IncompatibilityFlag is not NULL, return
1243 TRUE: Compatible packet received.
1244 FALSE: Incompatible packet received.
1245
1246 @retval RETRUEN_SUCCESS Succeed to receive acknowlege packet from HOST,
1247 the type of acknowlege packet saved in Ack.
1248 @retval RETURN_TIMEOUT Specified timeout value was up.
1249
1250 **/
1251 RETURN_STATUS
1252 SendCommandAndWaitForAckOK (
1253 IN UINT8 Command,
1254 IN UINTN Timeout,
1255 OUT BOOLEAN *BreakReceived, OPTIONAL
1256 OUT BOOLEAN *IncompatibilityFlag OPTIONAL
1257 )
1258 {
1259 RETURN_STATUS Status;
1260 UINT8 InputPacketBuffer[DEBUG_DATA_UPPER_LIMIT];
1261 DEBUG_PACKET_HEADER *DebugHeader;
1262 UINT8 SequenceNo;
1263 UINT8 HostSequenceNo;
1264 UINT8 RetryCount;
1265
1266 RetryCount = 3;
1267 DebugHeader = (DEBUG_PACKET_HEADER *) InputPacketBuffer;
1268 Status = RETURN_TIMEOUT;
1269 while (RetryCount > 0) {
1270 SequenceNo = GetMailboxPointer()->SequenceNo;
1271 HostSequenceNo = GetMailboxPointer()->HostSequenceNo;
1272 SendPacketWithoutData (Command, SequenceNo);
1273 Status = ReceivePacket ((UINT8 *) DebugHeader, BreakReceived, IncompatibilityFlag, Timeout, FALSE);
1274 if (Status == RETURN_TIMEOUT) {
1275 if (Command == DEBUG_COMMAND_INIT_BREAK) {
1276 RetryCount--;
1277 } else {
1278 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Timeout when waiting for ACK packet.\n");
1279 }
1280 continue;
1281 }
1282 ASSERT_EFI_ERROR (Status);
1283 //
1284 // Status == RETURN_SUCCESS
1285 //
1286 if (DebugHeader->Command == DEBUG_COMMAND_OK && DebugHeader->SequenceNo == SequenceNo) {
1287 //
1288 // Received Ack OK
1289 //
1290 UpdateMailboxContent (GetMailboxPointer(), DEBUG_MAILBOX_SEQUENCE_NO_INDEX, ++SequenceNo);
1291 return Status;
1292 }
1293 if (DebugHeader->Command == DEBUG_COMMAND_GO && (DebugHeader->SequenceNo == HostSequenceNo || Command == DEBUG_COMMAND_INIT_BREAK)) {
1294 //
1295 // Received Old GO
1296 //
1297 if (Command == DEBUG_COMMAND_INIT_BREAK) {
1298 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Receive GO() in last boot\n");
1299 }
1300 SendPacketWithoutData (DEBUG_COMMAND_OK, DebugHeader->SequenceNo);
1301 }
1302 }
1303
1304 ASSERT (Command == DEBUG_COMMAND_INIT_BREAK);
1305 return Status;
1306 }
1307
1308 /**
1309 Get current break cause.
1310
1311 @param[in] Vector Vector value of exception or interrupt.
1312 @param[in] CpuContext Pointer to save CPU context.
1313
1314 @return The type of break cause defined by XXXX
1315
1316 **/
1317 UINT8
1318 GetBreakCause (
1319 IN UINTN Vector,
1320 IN DEBUG_CPU_CONTEXT *CpuContext
1321 )
1322 {
1323 UINT8 Cause;
1324
1325 Cause = DEBUG_DATA_BREAK_CAUSE_UNKNOWN;
1326
1327 switch (Vector) {
1328 case DEBUG_INT1_VECTOR:
1329 case DEBUG_INT3_VECTOR:
1330
1331 if (Vector == DEBUG_INT1_VECTOR) {
1332 //
1333 // INT 1
1334 //
1335 if ((CpuContext->Dr6 & BIT14) != 0) {
1336 Cause = DEBUG_DATA_BREAK_CAUSE_STEPPING;
1337 //
1338 // If it's single step, no need to check DR0, to ensure single step work in PeCoffExtraActionLib
1339 // (right after triggering a breakpoint to report image load/unload).
1340 //
1341 return Cause;
1342
1343 } else {
1344 Cause = DEBUG_DATA_BREAK_CAUSE_HW_BREAKPOINT;
1345 }
1346 } else {
1347 //
1348 // INT 3
1349 //
1350 Cause = DEBUG_DATA_BREAK_CAUSE_SW_BREAKPOINT;
1351 }
1352
1353 switch (CpuContext->Dr0) {
1354 case IMAGE_LOAD_SIGNATURE:
1355 case IMAGE_UNLOAD_SIGNATURE:
1356
1357 if (CpuContext->Dr3 == IO_PORT_BREAKPOINT_ADDRESS) {
1358
1359 Cause = (UINT8) ((CpuContext->Dr0 == IMAGE_LOAD_SIGNATURE) ?
1360 DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD : DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD);
1361 }
1362 break;
1363
1364 case SOFT_INTERRUPT_SIGNATURE:
1365
1366 if (CpuContext->Dr1 == MEMORY_READY_SIGNATURE) {
1367 Cause = DEBUG_DATA_BREAK_CAUSE_MEMORY_READY;
1368 CpuContext->Dr0 = 0;
1369 } else if (CpuContext->Dr1 == SYSTEM_RESET_SIGNATURE) {
1370 Cause = DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET;
1371 CpuContext->Dr0 = 0;
1372 }
1373 break;
1374
1375 default:
1376 break;
1377
1378 }
1379
1380 break;
1381
1382 case DEBUG_TIMER_VECTOR:
1383 Cause = DEBUG_DATA_BREAK_CAUSE_USER_HALT;
1384 break;
1385
1386 default:
1387 if (Vector < 20) {
1388 if (GetDebugFlag (DEBUG_AGENT_FLAG_STEPPING) == 1) {
1389 //
1390 // If stepping command is executing
1391 //
1392 Cause = DEBUG_DATA_BREAK_CAUSE_STEPPING;
1393 } else {
1394 Cause = DEBUG_DATA_BREAK_CAUSE_EXCEPTION;
1395 }
1396 }
1397 break;
1398 }
1399
1400 return Cause;
1401 }
1402
1403 /**
1404 Copy memory from source to destination with specified width.
1405
1406 @param[out] Dest A pointer to the destination buffer of the memory copy.
1407 @param[in] Src A pointer to the source buffer of the memory copy.
1408 @param[in] Count The number of data with specified width to copy from source to destination.
1409 @param[in] Width Data width in byte.
1410
1411 **/
1412 VOID
1413 CopyMemByWidth (
1414 OUT UINT8 *Dest,
1415 IN UINT8 *Src,
1416 IN UINT16 Count,
1417 IN UINT8 Width
1418 )
1419 {
1420 UINT8 *Destination;
1421 UINT8 *Source;
1422 INT8 Step;
1423
1424 if (Src > Dest) {
1425 Destination = Dest;
1426 Source = Src;
1427 Step = Width;
1428 } else {
1429 //
1430 // Copy memory from tail to avoid memory overlap
1431 //
1432 Destination = Dest + (Count - 1) * Width;
1433 Source = Src + (Count - 1) * Width;
1434 Step = -Width;
1435 }
1436
1437 while (Count-- != 0) {
1438 switch (Width) {
1439 case 1:
1440 *(UINT8 *) Destination = MmioRead8 ((UINTN) Source);
1441 break;
1442 case 2:
1443 *(UINT16 *) Destination = MmioRead16 ((UINTN) Source);
1444 break;
1445 case 4:
1446 *(UINT32 *) Destination = MmioRead32 ((UINTN) Source);
1447 break;
1448 case 8:
1449 *(UINT64 *) Destination = MmioRead64 ((UINTN) Source);
1450 break;
1451 default:
1452 ASSERT (FALSE);
1453 }
1454 Source += Step;
1455 Destination += Step;
1456 }
1457 }
1458
1459 /**
1460 Compress the data buffer but do not modify the original buffer.
1461
1462 The compressed data is directly send to the debug channel.
1463 Compressing in place doesn't work because the data may become larger
1464 during compressing phase. ("3 3 ..." --> "3 3 0 ...")
1465 The routine is expected to be called three times:
1466 1. Compute the length of the compressed data buffer;
1467 2. Compute the CRC of the compressed data buffer;
1468 3. Compress the data and send to the debug channel.
1469
1470 @param[in] Data The data buffer.
1471 @param[in] Length The length of the data buffer.
1472 @param[out] CompressedLength Return the length of the compressed data buffer.
1473 It may be larger than the Length in some cases.
1474 @param[out] CompressedCrc Return the CRC of the compressed data buffer.
1475 @param[in] Handle The debug channel handle to send the compressed data buffer.
1476 **/
1477 VOID
1478 CompressDataThenSend (
1479 IN UINT8 *Data,
1480 IN UINT8 Length,
1481 OUT UINTN *CompressedLength, OPTIONAL
1482 OUT UINT16 *CompressedCrc, OPTIONAL
1483 IN DEBUG_PORT_HANDLE Handle OPTIONAL
1484 )
1485 {
1486 UINTN Index;
1487 UINT8 LastChar;
1488 UINT8 LastCharCount;
1489 UINT8 CurrentChar;
1490 UINTN CompressedIndex;
1491
1492 ASSERT (Length > 0);
1493
1494 LastChar = Data[0] + 1; // Just ensure it's different from the first byte.
1495 LastCharCount = 0;
1496
1497 for (Index = 0, CompressedIndex = 0; Index <= Length; Index++) {
1498 if (Index < Length) {
1499 CurrentChar = Data[Index];
1500 } else {
1501 CurrentChar = (UINT8) LastChar + 1; // just ensure it's different from LastChar
1502 }
1503 if (LastChar != CurrentChar) {
1504 if (LastCharCount == 1) {
1505 CompressedIndex++;
1506 if (CompressedCrc != NULL) {
1507 *CompressedCrc = CalculateCrc16 (&LastChar, 1, *CompressedCrc);
1508 }
1509 if (Handle != NULL) {
1510 DebugPortWriteBuffer (Handle, &LastChar, 1);
1511 }
1512
1513 } else if (LastCharCount >= 2) {
1514 CompressedIndex += 3;
1515 LastCharCount -= 2;
1516 if (CompressedCrc != NULL) {
1517 *CompressedCrc = CalculateCrc16 (&LastChar, 1, *CompressedCrc);
1518 *CompressedCrc = CalculateCrc16 (&LastChar, 1, *CompressedCrc);
1519 *CompressedCrc = CalculateCrc16 (&LastCharCount, 1, *CompressedCrc);
1520 }
1521 if (Handle != NULL) {
1522 DebugPortWriteBuffer (Handle, &LastChar, 1);
1523 DebugPortWriteBuffer (Handle, &LastChar, 1);
1524 DebugPortWriteBuffer (Handle, &LastCharCount, 1);
1525 }
1526 }
1527 LastCharCount = 0;
1528 }
1529 LastCharCount++;
1530 LastChar = CurrentChar;
1531 }
1532
1533 if (CompressedLength != NULL) {
1534 *CompressedLength = CompressedIndex;
1535 }
1536 }
1537
1538 /**
1539 Read memory with speicifed width and send packet with response data to HOST.
1540
1541 @param[in] Data Pointer to response data buffer.
1542 @param[in] Count The number of data with specified Width.
1543 @param[in] Width Data width in byte.
1544 @param[in] DebugHeader Pointer to a buffer for creating response packet and receiving ACK packet,
1545 to minimize the stack usage.
1546
1547 @retval RETURN_SUCCESS Response data was sent successfully.
1548
1549 **/
1550 RETURN_STATUS
1551 ReadMemoryAndSendResponsePacket (
1552 IN UINT8 *Data,
1553 IN UINT16 Count,
1554 IN UINT8 Width,
1555 IN DEBUG_PACKET_HEADER *DebugHeader
1556 )
1557 {
1558 RETURN_STATUS Status;
1559 BOOLEAN LastPacket;
1560 DEBUG_PORT_HANDLE Handle;
1561 UINT8 SequenceNo;
1562 UINTN RemainingDataSize;
1563 UINT8 CurrentDataSize;
1564 UINTN CompressedDataSize;
1565
1566 Handle = GetDebugPortHandle();
1567
1568 RemainingDataSize = Count * Width;
1569 while (TRUE) {
1570 SequenceNo = GetMailboxPointer()->HostSequenceNo;
1571 if (RemainingDataSize <= DEBUG_DATA_MAXIMUM_REAL_DATA) {
1572 //
1573 // If the remaining data is less one real packet size, this is the last data packet
1574 //
1575 CurrentDataSize = (UINT8) RemainingDataSize;
1576 LastPacket = TRUE;
1577 DebugHeader->Command = DEBUG_COMMAND_OK;
1578 } else {
1579 //
1580 // Data is too larger to be sent in one packet, calculate the actual data size could
1581 // be sent in one Maximum data packet
1582 //
1583 CurrentDataSize = (DEBUG_DATA_MAXIMUM_REAL_DATA / Width) * Width;
1584 LastPacket = FALSE;
1585 DebugHeader->Command = DEBUG_COMMAND_IN_PROGRESS;
1586 }
1587 //
1588 // Construct the rest Debug header
1589 //
1590 DebugHeader->StartSymbol = DEBUG_STARTING_SYMBOL_NORMAL;
1591 DebugHeader->Length = CurrentDataSize + sizeof (DEBUG_PACKET_HEADER);
1592 DebugHeader->SequenceNo = SequenceNo;
1593 DebugHeader->Crc = 0;
1594 CopyMemByWidth ((UINT8 *) (DebugHeader + 1), Data, CurrentDataSize / Width, Width);
1595
1596 //
1597 // Compression/decompression support was added since revision 0.4.
1598 // Revision 0.3 shouldn't compress the packet.
1599 //
1600 if (DEBUG_AGENT_REVISION >= DEBUG_AGENT_REVISION_04) {
1601 //
1602 // Get the compressed data size without modifying the packet.
1603 //
1604 CompressDataThenSend (
1605 (UINT8 *) (DebugHeader + 1),
1606 CurrentDataSize,
1607 &CompressedDataSize,
1608 NULL,
1609 NULL
1610 );
1611 } else {
1612 CompressedDataSize = CurrentDataSize;
1613 }
1614 if (CompressedDataSize < CurrentDataSize) {
1615 DebugHeader->Length = (UINT8) CompressedDataSize + sizeof (DEBUG_PACKET_HEADER);
1616 DebugHeader->StartSymbol = DEBUG_STARTING_SYMBOL_COMPRESS;
1617 //
1618 // Compute the CRC of the packet head without modifying the packet.
1619 //
1620 DebugHeader->Crc = CalculateCrc16 ((UINT8 *) DebugHeader, sizeof (DEBUG_PACKET_HEADER), 0);
1621 CompressDataThenSend (
1622 (UINT8 *) (DebugHeader + 1),
1623 CurrentDataSize,
1624 NULL,
1625 &DebugHeader->Crc,
1626 NULL
1627 );
1628 //
1629 // Send out the packet head.
1630 //
1631 DebugPortWriteBuffer (Handle, (UINT8 *) DebugHeader, sizeof (DEBUG_PACKET_HEADER));
1632 //
1633 // Compress and send out the packet data.
1634 //
1635 CompressDataThenSend (
1636 (UINT8 *) (DebugHeader + 1),
1637 CurrentDataSize,
1638 NULL,
1639 NULL,
1640 Handle
1641 );
1642 } else {
1643
1644 //
1645 // Calculate and fill the checksum, DebugHeader->Crc should be 0 before invoking CalculateCrc16 ()
1646 //
1647 DebugHeader->Crc = CalculateCrc16 ((UINT8 *) DebugHeader, DebugHeader->Length, 0);
1648
1649 DebugAgentDataMsgPrint (DEBUG_AGENT_VERBOSE, TRUE, (UINT8 *) DebugHeader, DebugHeader->Length);
1650
1651 DebugPortWriteBuffer (Handle, (UINT8 *) DebugHeader, DebugHeader->Length);
1652 }
1653
1654 while (TRUE) {
1655 Status = ReceivePacket ((UINT8 *) DebugHeader, NULL, NULL, READ_PACKET_TIMEOUT, FALSE);
1656 if (Status == RETURN_TIMEOUT) {
1657 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Timeout in SendDataResponsePacket()\n");
1658 break;
1659 }
1660 if ((DebugHeader->Command == DEBUG_COMMAND_OK) && (DebugHeader->SequenceNo == SequenceNo) && LastPacket) {
1661 //
1662 // If this is the last packet, return RETURN_SUCCESS.
1663 //
1664 return RETURN_SUCCESS;
1665 }
1666 if ((DebugHeader->Command == DEBUG_COMMAND_CONTINUE) && (DebugHeader->SequenceNo == (UINT8) (SequenceNo + 1))) {
1667 //
1668 // Calculate the rest data size
1669 //
1670 Data += CurrentDataSize;
1671 RemainingDataSize -= CurrentDataSize;
1672 UpdateMailboxContent (GetMailboxPointer(), DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, DebugHeader->SequenceNo);
1673 break;
1674 }
1675 if (DebugHeader->SequenceNo >= SequenceNo) {
1676 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Received one old or new command(SequenceNo is %x, last SequenceNo is %x)\n", SequenceNo, DebugHeader->SequenceNo);
1677 break;
1678 }
1679 }
1680 }
1681 }
1682
1683 /**
1684 Send packet with response data to HOST.
1685
1686 @param[in] Data Pointer to response data buffer.
1687 @param[in] DataSize Size of response data in byte.
1688 @param[in, out] DebugHeader Pointer to a buffer for creating response packet and receiving ACK packet,
1689 to minimize the stack usage.
1690
1691 @retval RETURN_SUCCESS Response data was sent successfully.
1692
1693 **/
1694 RETURN_STATUS
1695 SendDataResponsePacket (
1696 IN UINT8 *Data,
1697 IN UINT16 DataSize,
1698 IN OUT DEBUG_PACKET_HEADER *DebugHeader
1699 )
1700 {
1701 return ReadMemoryAndSendResponsePacket (Data, DataSize, 1, DebugHeader);
1702 }
1703
1704 /**
1705 Try to attach the HOST.
1706
1707 Send init break packet to HOST:
1708 If no acknowlege received in specified Timeout, return RETURN_TIMEOUT.
1709 If received acknowlege, check the revision of HOST.
1710 Set Attach Flag if attach successfully.
1711
1712 @param[in] BreakCause Break cause of this break event.
1713 @param[in] Timeout Time out value to wait for acknowlege from HOST.
1714 The unit is microsecond.
1715 @param[out] BreakReceived If BreakReceived is not NULL,
1716 TRUE is retured if break-in symbol received.
1717 FALSE is retured if break-in symbol not received.
1718 **/
1719 RETURN_STATUS
1720 AttachHost (
1721 IN UINT8 BreakCause,
1722 IN UINTN Timeout,
1723 OUT BOOLEAN *BreakReceived
1724 )
1725 {
1726 RETURN_STATUS Status;
1727 DEBUG_PORT_HANDLE Handle;
1728 BOOLEAN IncompatibilityFlag;
1729
1730 IncompatibilityFlag = FALSE;
1731 Handle = GetDebugPortHandle();
1732
1733 //
1734 // Send init break and wait ack in Timeout
1735 //
1736 DebugPortWriteBuffer (Handle, (UINT8 *) mErrorMsgSendInitPacket, AsciiStrLen (mErrorMsgSendInitPacket));
1737 if (BreakCause == DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET) {
1738 Status = SendCommandAndWaitForAckOK (DEBUG_COMMAND_INIT_BREAK, Timeout, BreakReceived, &IncompatibilityFlag);
1739 } else {
1740 Status = SendCommandAndWaitForAckOK (DEBUG_COMMAND_ATTACH_BREAK, Timeout, BreakReceived, &IncompatibilityFlag);
1741 }
1742 if (IncompatibilityFlag) {
1743 //
1744 // If the incompatible Debug Packet received, the HOST should be running transfer protocol before DEBUG_AGENT_REVISION.
1745 // It could be UDK Debugger for Windows v1.1/v1.2 or for Linux v0.8/v1.2.
1746 //
1747 DebugPortWriteBuffer (Handle, (UINT8 *) mErrorMsgVersionAlert, AsciiStrLen (mErrorMsgVersionAlert));
1748 CpuDeadLoop ();
1749 }
1750
1751 if (RETURN_ERROR (Status)) {
1752 DebugPortWriteBuffer (Handle, (UINT8 *) mErrorMsgConnectFail, AsciiStrLen (mErrorMsgConnectFail));
1753 } else {
1754 DebugPortWriteBuffer (Handle, (UINT8 *) mErrorMsgConnectOK, AsciiStrLen (mErrorMsgConnectOK));
1755 //
1756 // Set Attach flag
1757 //
1758 SetHostAttached (TRUE);
1759 }
1760 return Status;
1761 }
1762
1763 /**
1764 Send Break point packet to HOST.
1765
1766 Only the first breaking processor could sent BREAK_POINT packet.
1767
1768 @param[in] BreakCause Break cause of this break event.
1769 @param[in] ProcessorIndex Processor index value.
1770 @param[out] BreakReceived If BreakReceived is not NULL,
1771 TRUE is retured if break-in symbol received.
1772 FALSE is retured if break-in symbol not received.
1773
1774 **/
1775 VOID
1776 SendBreakPacketToHost (
1777 IN UINT8 BreakCause,
1778 IN UINT32 ProcessorIndex,
1779 OUT BOOLEAN *BreakReceived
1780 )
1781 {
1782 UINT8 InputCharacter;
1783 DEBUG_PORT_HANDLE Handle;
1784
1785 Handle = GetDebugPortHandle();
1786
1787 if (IsHostAttached ()) {
1788 DebugAgentMsgPrint (DEBUG_AGENT_INFO, "processor[%x]:Send Break Packet to HOST.\n", ProcessorIndex);
1789 SendCommandAndWaitForAckOK (DEBUG_COMMAND_BREAK_POINT, READ_PACKET_TIMEOUT, BreakReceived, NULL);
1790 } else {
1791 DebugAgentMsgPrint (DEBUG_AGENT_INFO, "processor[%x]:Try to attach HOST.\n", ProcessorIndex);
1792 //
1793 // If HOST is not attached, try to attach it firstly.
1794 //
1795 //
1796 // Poll Attach symbols from HOST and ack OK
1797 //
1798 do {
1799 DebugAgentReadBuffer (Handle, &InputCharacter, 1, 0);
1800 } while (InputCharacter != DEBUG_STARTING_SYMBOL_ATTACH);
1801 SendAckPacket (DEBUG_COMMAND_OK);
1802
1803 //
1804 // Try to attach HOST
1805 //
1806 while (AttachHost (BreakCause, 0, NULL) != RETURN_SUCCESS);
1807
1808 }
1809 }
1810
1811 /**
1812 The main function to process communication with HOST.
1813
1814 It received the command packet from HOST, and sent response data packet to HOST.
1815
1816 @param[in] Vector Vector value of exception or interrutp.
1817 @param[in, out] CpuContext Pointer to saved CPU context.
1818 @param[in] BreakReceived TRUE means break-in symbol received.
1819 FALSE means break-in symbol not received.
1820
1821 **/
1822 VOID
1823 CommandCommunication (
1824 IN UINTN Vector,
1825 IN OUT DEBUG_CPU_CONTEXT *CpuContext,
1826 IN BOOLEAN BreakReceived
1827 )
1828 {
1829 RETURN_STATUS Status;
1830 UINT8 InputPacketBuffer[DEBUG_DATA_UPPER_LIMIT + sizeof (UINT64) - 1];
1831 DEBUG_PACKET_HEADER *DebugHeader;
1832 UINT8 Width;
1833 UINT8 Data8;
1834 UINT32 Data32;
1835 UINT64 Data64;
1836 DEBUG_DATA_READ_MEMORY *MemoryRead;
1837 DEBUG_DATA_WRITE_MEMORY *MemoryWrite;
1838 DEBUG_DATA_READ_IO *IoRead;
1839 DEBUG_DATA_WRITE_IO *IoWrite;
1840 DEBUG_DATA_READ_REGISTER *RegisterRead;
1841 DEBUG_DATA_WRITE_REGISTER *RegisterWrite;
1842 UINT8 *RegisterBuffer;
1843 DEBUG_DATA_READ_MSR *MsrRegisterRead;
1844 DEBUG_DATA_WRITE_MSR *MsrRegisterWrite;
1845 DEBUG_DATA_CPUID *Cpuid;
1846 DEBUG_DATA_RESPONSE_BREAK_CAUSE BreakCause;
1847 DEBUG_DATA_RESPONSE_CPUID CpuidResponse;
1848 DEBUG_DATA_SEARCH_SIGNATURE *SearchSignature;
1849 DEBUG_DATA_RESPONSE_GET_EXCEPTION Exception;
1850 DEBUG_DATA_RESPONSE_GET_REVISION DebugAgentRevision;
1851 DEBUG_DATA_SET_VIEWPOINT *SetViewPoint;
1852 BOOLEAN HaltDeferred;
1853 UINT32 ProcessorIndex;
1854 DEBUG_PORT_HANDLE Handle;
1855 DEBUG_AGENT_EXCEPTION_BUFFER AgentExceptionBuffer;
1856 UINT32 IssuedViewPoint;
1857 DEBUG_AGENT_MAILBOX *Mailbox;
1858 UINT8 *AlignedDataPtr;
1859
1860 ProcessorIndex = 0;
1861 IssuedViewPoint = 0;
1862 HaltDeferred = BreakReceived;
1863
1864 if (MultiProcessorDebugSupport()) {
1865 ProcessorIndex = GetProcessorIndex ();
1866 SetCpuStopFlagByIndex (ProcessorIndex, TRUE);
1867 if (mDebugMpContext.ViewPointIndex == ProcessorIndex) {
1868 //
1869 // Only the current view processor could set AgentInProgress Flag.
1870 //
1871 IssuedViewPoint = ProcessorIndex;
1872 }
1873 }
1874
1875 if (IssuedViewPoint == ProcessorIndex) {
1876 //
1877 // Set AgentInProgress Flag.
1878 //
1879 SetDebugFlag (DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS, 1);
1880 }
1881
1882 Handle = GetDebugPortHandle();
1883
1884 while (TRUE) {
1885
1886 if (MultiProcessorDebugSupport()) {
1887 //
1888 // Check if the current processor is HOST view point
1889 //
1890 if (mDebugMpContext.ViewPointIndex != ProcessorIndex) {
1891 if (mDebugMpContext.RunCommandSet) {
1892 //
1893 // If HOST view point sets RUN flag, run GO command to leave
1894 //
1895 SetCpuStopFlagByIndex (ProcessorIndex, FALSE);
1896 CommandGo (CpuContext);
1897 break;
1898 } else {
1899 //
1900 // Run into loop again
1901 //
1902 CpuPause ();
1903 continue;
1904 }
1905 }
1906 }
1907
1908 AcquireMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
1909
1910 DebugHeader =(DEBUG_PACKET_HEADER *) InputPacketBuffer;
1911
1912 DebugAgentMsgPrint (DEBUG_AGENT_INFO, "TARGET: Try to get command from HOST...\n");
1913 Status = ReceivePacket ((UINT8 *) DebugHeader, &BreakReceived, NULL, READ_PACKET_TIMEOUT, TRUE);
1914 if (Status != RETURN_SUCCESS || !IS_REQUEST (DebugHeader)) {
1915 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Get command[%x] sequenceno[%x] returned status is [%x] \n", DebugHeader->Command, DebugHeader->SequenceNo, Status);
1916 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Get command failed or it's response packet not expected! \n");
1917 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
1918 continue;
1919 }
1920
1921 Mailbox = GetMailboxPointer ();
1922 if (DebugHeader->SequenceNo == Mailbox->HostSequenceNo) {
1923 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Receive one old command[%x] agaist command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);
1924 SendAckPacket (Mailbox->LastAck);
1925 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
1926 continue;
1927 } else if (DebugHeader->SequenceNo == (UINT8) (Mailbox->HostSequenceNo + 1)) {
1928 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, (UINT8) DebugHeader->SequenceNo);
1929 } else {
1930 DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Receive one invalid comamnd[%x] agaist command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);
1931 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
1932 continue;
1933 }
1934
1935 //
1936 // Save CPU content before executing HOST commond
1937 //
1938 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_EXCEPTION_BUFFER_POINTER_INDEX, (UINT64)(UINTN) &AgentExceptionBuffer.JumpBuffer);
1939 if (SetJump (&AgentExceptionBuffer.JumpBuffer) != 0) {
1940 //
1941 // If HOST command failed, continue to wait for HOST's next command
1942 // If needed, agent could send exception info to HOST.
1943 //
1944 SendAckPacket (DEBUG_COMMAND_ABORT);
1945 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
1946 continue;
1947 }
1948
1949 DebugAgentMsgPrint (DEBUG_AGENT_INFO, "Processor[%x]:Received one command(%x)\n", mDebugMpContext.ViewPointIndex, DebugHeader->Command);
1950
1951 switch (DebugHeader->Command) {
1952
1953 case DEBUG_COMMAND_HALT:
1954 SendAckPacket (DEBUG_COMMAND_HALT_DEFERRED);
1955 HaltDeferred = TRUE;
1956 BreakReceived = FALSE;
1957 Status = RETURN_SUCCESS;
1958 break;
1959
1960 case DEBUG_COMMAND_RESET:
1961 SendAckPacket (DEBUG_COMMAND_OK);
1962 SendAckPacket (DEBUG_COMMAND_OK);
1963 SendAckPacket (DEBUG_COMMAND_OK);
1964 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
1965
1966 ResetCold ();
1967 //
1968 // Assume system resets in 2 seconds, otherwise send TIMEOUT packet.
1969 // PCD can be used if 2 seconds isn't long enough for some platforms.
1970 //
1971 MicroSecondDelay (2000000);
1972 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, Mailbox->HostSequenceNo + 1);
1973 SendAckPacket (DEBUG_COMMAND_TIMEOUT);
1974 SendAckPacket (DEBUG_COMMAND_TIMEOUT);
1975 SendAckPacket (DEBUG_COMMAND_TIMEOUT);
1976 break;
1977
1978 case DEBUG_COMMAND_GO:
1979 CommandGo (CpuContext);
1980 //
1981 // Clear Dr0 to avoid to be recognized as IMAGE_LOAD/_UNLOAD again when hitting a breakpoint after GO
1982 // If HOST changed Dr0 before GO, we will not change Dr0 here
1983 //
1984 Data8 = GetBreakCause (Vector, CpuContext);
1985 if (Data8 == DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD || Data8 == DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD) {
1986 CpuContext->Dr0 = 0;
1987 }
1988
1989 if (!HaltDeferred) {
1990 //
1991 // If no HALT command received when being in-active mode
1992 //
1993 if (MultiProcessorDebugSupport()) {
1994 Data32 = FindNextPendingBreakCpu ();
1995 if (Data32 != -1) {
1996 //
1997 // If there are still others processors being in break state,
1998 // send OK packet to HOST to finish this go command
1999 //
2000 SendAckPacket (DEBUG_COMMAND_OK);
2001 CpuPause ();
2002 //
2003 // Set current view to the next breaking processor
2004 //
2005 mDebugMpContext.ViewPointIndex = Data32;
2006 mDebugMpContext.BreakAtCpuIndex = mDebugMpContext.ViewPointIndex;
2007 SetCpuBreakFlagByIndex (mDebugMpContext.ViewPointIndex, FALSE);
2008 //
2009 // Send break packet to HOST to let HOST break again
2010 //
2011 SendBreakPacketToHost (DEBUG_DATA_BREAK_CAUSE_UNKNOWN, mDebugMpContext.BreakAtCpuIndex, &BreakReceived);
2012 //
2013 // Continue to run into loop to read command packet from HOST
2014 //
2015 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2016 break;
2017 }
2018
2019 //
2020 // If no else processor break, set stop bitmask,
2021 // and set Running flag for all processors.
2022 //
2023 SetCpuStopFlagByIndex (ProcessorIndex, FALSE);
2024 SetCpuRunningFlag (TRUE);
2025 CpuPause ();
2026 //
2027 // Wait for all processors are in running state
2028 //
2029 while (TRUE) {
2030 if (IsAllCpuRunning ()) {
2031 break;
2032 }
2033 }
2034 //
2035 // Set BSP to be current view point.
2036 //
2037 SetDebugViewPoint (mDebugMpContext.BspIndex);
2038 CpuPause ();
2039 //
2040 // Clear breaking processor index and running flag
2041 //
2042 mDebugMpContext.BreakAtCpuIndex = (UINT32) (-1);
2043 SetCpuRunningFlag (FALSE);
2044 }
2045
2046 //
2047 // Send OK packet to HOST to finish this go command
2048 //
2049 SendAckPacket (DEBUG_COMMAND_OK);
2050
2051 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2052
2053 if (!IsHostAttached()) {
2054 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_SEQUENCE_NO_INDEX, 0);
2055 UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, 0);
2056 }
2057 return;
2058
2059 } else {
2060 //
2061 // If reveived HALT command, need to defer the GO command
2062 //
2063 SendAckPacket (DEBUG_COMMAND_HALT_PROCESSED);
2064 HaltDeferred = FALSE;
2065
2066 Vector = DEBUG_TIMER_VECTOR;
2067 }
2068 break;
2069
2070 case DEBUG_COMMAND_BREAK_CAUSE:
2071 BreakCause.StopAddress = CpuContext->Eip;
2072 if (MultiProcessorDebugSupport() && ProcessorIndex != mDebugMpContext.BreakAtCpuIndex) {
2073 BreakCause.Cause = GetBreakCause (DEBUG_TIMER_VECTOR, CpuContext);
2074 } else {
2075 BreakCause.Cause = GetBreakCause (Vector, CpuContext);
2076 }
2077 SendDataResponsePacket ((UINT8 *) &BreakCause, (UINT16) sizeof (DEBUG_DATA_RESPONSE_BREAK_CAUSE), DebugHeader);
2078 break;
2079
2080 case DEBUG_COMMAND_SET_HW_BREAKPOINT:
2081 SetDebugRegister (CpuContext, (DEBUG_DATA_SET_HW_BREAKPOINT *) (DebugHeader + 1));
2082 SendAckPacket (DEBUG_COMMAND_OK);
2083 break;
2084
2085 case DEBUG_COMMAND_CLEAR_HW_BREAKPOINT:
2086 ClearDebugRegister (CpuContext, (DEBUG_DATA_CLEAR_HW_BREAKPOINT *) (DebugHeader + 1));
2087 SendAckPacket (DEBUG_COMMAND_OK);
2088 break;
2089
2090 case DEBUG_COMMAND_SINGLE_STEPPING:
2091 CommandStepping (CpuContext);
2092 //
2093 // Clear Dr0 to avoid to be recognized as IMAGE_LOAD/_UNLOAD again when hitting a breakpoint after GO
2094 // If HOST changed Dr0 before GO, we will not change Dr0 here
2095 //
2096 Data8 = GetBreakCause (Vector, CpuContext);
2097 if (Data8 == DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD || Data8 == DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD) {
2098 CpuContext->Dr0 = 0;
2099 }
2100
2101 mDebugMpContext.BreakAtCpuIndex = (UINT32) (-1);
2102 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2103 //
2104 // Executing stepping command directly without sending ACK packet,
2105 // ACK packet will be sent after stepping done.
2106 //
2107 return;
2108
2109 case DEBUG_COMMAND_SET_SW_BREAKPOINT:
2110 Data64 = (UINTN) (((DEBUG_DATA_SET_SW_BREAKPOINT *) (DebugHeader + 1))->Address);
2111 Data8 = *(UINT8 *) (UINTN) Data64;
2112 *(UINT8 *) (UINTN) Data64 = DEBUG_SW_BREAKPOINT_SYMBOL;
2113 Status = SendDataResponsePacket ((UINT8 *) &Data8, (UINT16) sizeof (UINT8), DebugHeader);
2114 break;
2115
2116 case DEBUG_COMMAND_READ_MEMORY:
2117 MemoryRead = (DEBUG_DATA_READ_MEMORY *) (DebugHeader + 1);
2118 Status = ReadMemoryAndSendResponsePacket ((UINT8 *) (UINTN) MemoryRead->Address, MemoryRead->Count, MemoryRead->Width, DebugHeader);
2119 break;
2120
2121 case DEBUG_COMMAND_WRITE_MEMORY:
2122 MemoryWrite = (DEBUG_DATA_WRITE_MEMORY *) (DebugHeader + 1);
2123 //
2124 // Copy data into one memory with 8-byte alignment address
2125 //
2126 AlignedDataPtr = ALIGN_POINTER ((UINT8 *) &MemoryWrite->Data, sizeof (UINT64));
2127 if (AlignedDataPtr != (UINT8 *) &MemoryWrite->Data) {
2128 CopyMem (AlignedDataPtr, (UINT8 *) &MemoryWrite->Data, MemoryWrite->Count * MemoryWrite->Width);
2129 }
2130 CopyMemByWidth ((UINT8 *) (UINTN) MemoryWrite->Address, AlignedDataPtr, MemoryWrite->Count, MemoryWrite->Width);
2131 SendAckPacket (DEBUG_COMMAND_OK);
2132 break;
2133
2134 case DEBUG_COMMAND_READ_IO:
2135 IoRead = (DEBUG_DATA_READ_IO *) (DebugHeader + 1);
2136 switch (IoRead->Width) {
2137 case 1:
2138 Data64 = IoRead8 ((UINTN) IoRead->Port);
2139 break;
2140 case 2:
2141 Data64 = IoRead16 ((UINTN) IoRead->Port);
2142 break;
2143 case 4:
2144 Data64 = IoRead32 ((UINTN) IoRead->Port);
2145 break;
2146 case 8:
2147 Data64 = IoRead64 ((UINTN) IoRead->Port);
2148 break;
2149 default:
2150 Data64 = (UINT64) -1;
2151 }
2152 Status = SendDataResponsePacket ((UINT8 *) &Data64, IoRead->Width, DebugHeader);
2153 break;
2154
2155 case DEBUG_COMMAND_WRITE_IO:
2156 IoWrite = (DEBUG_DATA_WRITE_IO *) (DebugHeader + 1);
2157 switch (IoWrite->Width) {
2158 case 1:
2159 Data64 = IoWrite8 ((UINTN) IoWrite->Port, *(UINT8 *) &IoWrite->Data);
2160 break;
2161 case 2:
2162 Data64 = IoWrite16 ((UINTN) IoWrite->Port, *(UINT16 *) &IoWrite->Data);
2163 break;
2164 case 4:
2165 Data64 = IoWrite32 ((UINTN) IoWrite->Port, *(UINT32 *) &IoWrite->Data);
2166 break;
2167 case 8:
2168 Data64 = IoWrite64 ((UINTN) IoWrite->Port, *(UINT64 *) &IoWrite->Data);
2169 break;
2170 default:
2171 Data64 = (UINT64) -1;
2172 }
2173 SendAckPacket (DEBUG_COMMAND_OK);
2174 break;
2175
2176 case DEBUG_COMMAND_READ_ALL_REGISTERS:
2177 Status = SendDataResponsePacket ((UINT8 *) CpuContext, sizeof (*CpuContext), DebugHeader);
2178 break;
2179
2180 case DEBUG_COMMAND_READ_REGISTER:
2181 RegisterRead = (DEBUG_DATA_READ_REGISTER *) (DebugHeader + 1);
2182
2183 if (RegisterRead->Index <= SOFT_DEBUGGER_REGISTER_MAX) {
2184 RegisterBuffer = ArchReadRegisterBuffer (CpuContext, RegisterRead->Index, &Width);
2185 Status = SendDataResponsePacket (RegisterBuffer, Width, DebugHeader);
2186 } else {
2187 Status = RETURN_UNSUPPORTED;
2188 }
2189 break;
2190
2191 case DEBUG_COMMAND_WRITE_REGISTER:
2192 RegisterWrite = (DEBUG_DATA_WRITE_REGISTER *) (DebugHeader + 1);
2193 if (RegisterWrite->Index <= SOFT_DEBUGGER_REGISTER_MAX) {
2194 RegisterBuffer = ArchReadRegisterBuffer (CpuContext, RegisterWrite->Index, &Width);
2195 ASSERT (Width == RegisterWrite->Length);
2196 CopyMem (RegisterBuffer, RegisterWrite->Data, Width);
2197 SendAckPacket (DEBUG_COMMAND_OK);
2198 } else {
2199 Status = RETURN_UNSUPPORTED;
2200 }
2201 break;
2202
2203 case DEBUG_COMMAND_ARCH_MODE:
2204 Data8 = DEBUG_ARCH_SYMBOL;
2205 Status = SendDataResponsePacket ((UINT8 *) &Data8, (UINT16) sizeof (UINT8), DebugHeader);
2206 break;
2207
2208 case DEBUG_COMMAND_READ_MSR:
2209 MsrRegisterRead = (DEBUG_DATA_READ_MSR *) (DebugHeader + 1);
2210 Data64 = AsmReadMsr64 (MsrRegisterRead->Index);
2211 Status = SendDataResponsePacket ((UINT8 *) &Data64, (UINT16) sizeof (UINT64), DebugHeader);
2212 break;
2213
2214 case DEBUG_COMMAND_WRITE_MSR:
2215 MsrRegisterWrite = (DEBUG_DATA_WRITE_MSR *) (DebugHeader + 1);
2216 AsmWriteMsr64 (MsrRegisterWrite->Index, MsrRegisterWrite->Value);
2217 SendAckPacket (DEBUG_COMMAND_OK);
2218 break;
2219
2220 case DEBUG_COMMAND_SET_DEBUG_SETTING:
2221 Status = SetDebugSetting ((DEBUG_DATA_SET_DEBUG_SETTING *)(DebugHeader + 1));
2222 if (Status == RETURN_SUCCESS) {
2223 SendAckPacket (DEBUG_COMMAND_OK);
2224 }
2225 break;
2226
2227 case DEBUG_COMMAND_GET_REVISION:
2228 DebugAgentRevision.Revision = DEBUG_AGENT_REVISION;
2229 DebugAgentRevision.Capabilities = DEBUG_AGENT_CAPABILITIES;
2230 Status = SendDataResponsePacket ((UINT8 *) &DebugAgentRevision, (UINT16) sizeof (DEBUG_DATA_RESPONSE_GET_REVISION), DebugHeader);
2231 break;
2232
2233 case DEBUG_COMMAND_GET_EXCEPTION:
2234 Exception.ExceptionNum = (UINT8) Vector;
2235 Exception.ExceptionData = (UINT32) CpuContext->ExceptionData;
2236 Status = SendDataResponsePacket ((UINT8 *) &Exception, (UINT16) sizeof (DEBUG_DATA_RESPONSE_GET_EXCEPTION), DebugHeader);
2237 break;
2238
2239 case DEBUG_COMMAND_SET_VIEWPOINT:
2240 SetViewPoint = (DEBUG_DATA_SET_VIEWPOINT *) (DebugHeader + 1);
2241 if (MultiProcessorDebugSupport()) {
2242 if (IsCpuStopped (SetViewPoint->ViewPoint)) {
2243 SetDebugViewPoint (SetViewPoint->ViewPoint);
2244 SendAckPacket (DEBUG_COMMAND_OK);
2245 } else {
2246 //
2247 // If CPU is not halted
2248 //
2249 SendAckPacket (DEBUG_COMMAND_NOT_SUPPORTED);
2250 }
2251 } else if (SetViewPoint->ViewPoint == 0) {
2252 SendAckPacket (DEBUG_COMMAND_OK);
2253
2254 } else {
2255 SendAckPacket (DEBUG_COMMAND_NOT_SUPPORTED);
2256 }
2257
2258 break;
2259
2260 case DEBUG_COMMAND_GET_VIEWPOINT:
2261 Data32 = mDebugMpContext.ViewPointIndex;
2262 SendDataResponsePacket((UINT8 *) &Data32, (UINT16) sizeof (UINT32), DebugHeader);
2263 break;
2264
2265 case DEBUG_COMMAND_MEMORY_READY:
2266 Data8 = (UINT8) GetDebugFlag (DEBUG_AGENT_FLAG_MEMORY_READY);
2267 SendDataResponsePacket (&Data8, (UINT16) sizeof (UINT8), DebugHeader);
2268 break;
2269
2270 case DEBUG_COMMAND_DETACH:
2271 SetHostAttached (FALSE);
2272 SendAckPacket (DEBUG_COMMAND_OK);
2273 break;
2274
2275 case DEBUG_COMMAND_CPUID:
2276 Cpuid = (DEBUG_DATA_CPUID *) (DebugHeader + 1);
2277 AsmCpuidEx (
2278 Cpuid->Eax, Cpuid->Ecx,
2279 &CpuidResponse.Eax, &CpuidResponse.Ebx,
2280 &CpuidResponse.Ecx, &CpuidResponse.Edx
2281 );
2282 SendDataResponsePacket ((UINT8 *) &CpuidResponse, (UINT16) sizeof (CpuidResponse), DebugHeader);
2283 break;
2284
2285 case DEBUG_COMMAND_SEARCH_SIGNATURE:
2286 SearchSignature = (DEBUG_DATA_SEARCH_SIGNATURE *) (DebugHeader + 1);
2287 if ((SearchSignature->Alignment != 0) &&
2288 (SearchSignature->Alignment == GetPowerOfTwo32 (SearchSignature->Alignment))
2289 ) {
2290 if (SearchSignature->Positive) {
2291 for (
2292 Data64 = ALIGN_VALUE ((UINTN) SearchSignature->Start, SearchSignature->Alignment);
2293 Data64 <= SearchSignature->Start + SearchSignature->Count - SearchSignature->DataLength;
2294 Data64 += SearchSignature->Alignment
2295 ) {
2296 if (CompareMem ((VOID *) (UINTN) Data64, &SearchSignature->Data, SearchSignature->DataLength) == 0) {
2297 break;
2298 }
2299 }
2300 if (Data64 > SearchSignature->Start + SearchSignature->Count - SearchSignature->DataLength) {
2301 Data64 = (UINT64) -1;
2302 }
2303 } else {
2304 for (
2305 Data64 = ALIGN_VALUE ((UINTN) SearchSignature->Start - SearchSignature->Alignment, SearchSignature->Alignment);
2306 Data64 >= SearchSignature->Start - SearchSignature->Count;
2307 Data64 -= SearchSignature->Alignment
2308 ) {
2309 if (CompareMem ((VOID *) (UINTN) Data64, &SearchSignature->Data, SearchSignature->DataLength) == 0) {
2310 break;
2311 }
2312 }
2313 if (Data64 < SearchSignature->Start - SearchSignature->Count) {
2314 Data64 = (UINT64) -1;
2315 }
2316 }
2317 SendDataResponsePacket ((UINT8 *) &Data64, (UINT16) sizeof (Data64), DebugHeader);
2318 } else {
2319 Status = RETURN_UNSUPPORTED;
2320 }
2321 break;
2322
2323 default:
2324 SendAckPacket (DEBUG_COMMAND_NOT_SUPPORTED);
2325 break;
2326 }
2327
2328 if (Status == RETURN_UNSUPPORTED) {
2329 SendAckPacket (DEBUG_COMMAND_NOT_SUPPORTED);
2330 } else if (Status != RETURN_SUCCESS) {
2331 SendAckPacket (DEBUG_COMMAND_ABORT);
2332 }
2333
2334 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2335 CpuPause ();
2336 }
2337 }
2338
2339 /**
2340 C function called in interrupt handler.
2341
2342 @param[in] Vector Vector value of exception or interrutp.
2343 @param[in] CpuContext Pointer to save CPU context.
2344
2345 **/
2346 VOID
2347 EFIAPI
2348 InterruptProcess (
2349 IN UINT32 Vector,
2350 IN DEBUG_CPU_CONTEXT *CpuContext
2351 )
2352 {
2353 UINT8 InputCharacter;
2354 UINT8 BreakCause;
2355 UINTN SavedEip;
2356 BOOLEAN BreakReceived;
2357 UINT32 ProcessorIndex;
2358 UINT32 CurrentDebugTimerInitCount;
2359 DEBUG_PORT_HANDLE Handle;
2360 UINT8 Data8;
2361 UINT8 *Al;
2362 UINT32 IssuedViewPoint;
2363 DEBUG_AGENT_EXCEPTION_BUFFER *ExceptionBuffer;
2364
2365 InputCharacter = 0;
2366 ProcessorIndex = 0;
2367 IssuedViewPoint = 0;
2368 BreakReceived = FALSE;
2369
2370 if (mSkipBreakpoint) {
2371 //
2372 // If Skip Breakpoint flag is set, means communication is disturbed by hardware SMI, we need to ignore the break points in SMM
2373 //
2374 if ((Vector == DEBUG_INT1_VECTOR) || (Vector == DEBUG_INT3_VECTOR)) {
2375 DebugPortWriteBuffer (GetDebugPortHandle(), (UINT8 *) mWarningMsgIngoreBreakpoint, AsciiStrLen (mWarningMsgIngoreBreakpoint));
2376 return;
2377 }
2378 }
2379
2380 if (MultiProcessorDebugSupport()) {
2381 ProcessorIndex = GetProcessorIndex ();
2382 //
2383 // If this processor has alreay halted before, need to check it later
2384 //
2385 if (IsCpuStopped (ProcessorIndex)) {
2386 IssuedViewPoint = ProcessorIndex;
2387 }
2388 }
2389
2390 if (IssuedViewPoint == ProcessorIndex && GetDebugFlag (DEBUG_AGENT_FLAG_STEPPING) != 1) {
2391 //
2392 // Check if this exception is issued by Debug Agent itself
2393 // If yes, fill the debug agent exception buffer and LongJump() back to
2394 // the saved CPU content in CommandCommunication()
2395 //
2396 if (GetDebugFlag (DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS) == 1) {
2397 DebugAgentMsgPrint (DEBUG_AGENT_ERROR, "Debug agent meet one Exception, ExceptionNum is %d, EIP = 0x%x.\n", Vector, (UINTN)CpuContext->Eip);
2398 ExceptionBuffer = (DEBUG_AGENT_EXCEPTION_BUFFER *) (UINTN) GetMailboxPointer()->ExceptionBufferPointer;
2399 ExceptionBuffer->ExceptionContent.ExceptionNum = (UINT8) Vector;
2400 ExceptionBuffer->ExceptionContent.ExceptionData = (UINT32) CpuContext->ExceptionData;
2401 LongJump ((BASE_LIBRARY_JUMP_BUFFER *)(UINTN)(ExceptionBuffer), 1);
2402 }
2403 }
2404
2405 if (MultiProcessorDebugSupport()) {
2406 //
2407 // If RUN commmand is executing, wait for it done.
2408 //
2409 while (mDebugMpContext.RunCommandSet) {
2410 CpuPause ();
2411 }
2412 }
2413
2414 Handle = GetDebugPortHandle();
2415 BreakCause = GetBreakCause (Vector, CpuContext);
2416 switch (Vector) {
2417 case DEBUG_INT1_VECTOR:
2418 case DEBUG_INT3_VECTOR:
2419 switch (BreakCause) {
2420 case DEBUG_DATA_BREAK_CAUSE_SYSTEM_RESET:
2421 if (AttachHost (BreakCause, READ_PACKET_TIMEOUT, &BreakReceived) != RETURN_SUCCESS) {
2422 //
2423 // Try to connect HOST, return if fails
2424 //
2425 break;
2426 }
2427 CommandCommunication (Vector, CpuContext, BreakReceived);
2428 break;
2429
2430 case DEBUG_DATA_BREAK_CAUSE_STEPPING:
2431 //
2432 // Stepping is finished, send Ack package.
2433 //
2434 if (MultiProcessorDebugSupport()) {
2435 mDebugMpContext.BreakAtCpuIndex = ProcessorIndex;
2436 }
2437 //
2438 // Clear Stepping Flag and restore EFLAGS.IF
2439 //
2440 CommandSteppingCleanup (CpuContext);
2441 SendAckPacket (DEBUG_COMMAND_OK);
2442 CommandCommunication (Vector, CpuContext, BreakReceived);
2443 break;
2444
2445 case DEBUG_DATA_BREAK_CAUSE_MEMORY_READY:
2446 //
2447 // Memory is ready
2448 //
2449 SendCommandAndWaitForAckOK (DEBUG_COMMAND_MEMORY_READY, READ_PACKET_TIMEOUT, &BreakReceived, NULL);
2450 CommandCommunication (Vector, CpuContext, BreakReceived);
2451 break;
2452
2453 case DEBUG_DATA_BREAK_CAUSE_IMAGE_LOAD:
2454 case DEBUG_DATA_BREAK_CAUSE_IMAGE_UNLOAD:
2455 //
2456 // Set AL to DEBUG_AGENT_IMAGE_CONTINUE
2457 //
2458 Al = ArchReadRegisterBuffer (CpuContext, SOFT_DEBUGGER_REGISTER_AX, &Data8);
2459 *Al = DEBUG_AGENT_IMAGE_CONTINUE;
2460
2461 if (!IsHostAttached ()) {
2462 //
2463 // If HOST is not connected for image load/unload, return
2464 //
2465 break;
2466 }
2467 //
2468 // Continue to run the following common code
2469 //
2470
2471 case DEBUG_DATA_BREAK_CAUSE_HW_BREAKPOINT:
2472 case DEBUG_DATA_BREAK_CAUSE_SW_BREAKPOINT:
2473 default:
2474 //
2475 // Send Break packet to HOST
2476 //
2477 AcquireMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2478 //
2479 // Only the first breaking processor could send BREAK_POINT to HOST
2480 //
2481 if (IsFirstBreakProcessor (ProcessorIndex)) {
2482 SendBreakPacketToHost (BreakCause, ProcessorIndex, &BreakReceived);
2483 }
2484 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2485
2486 if (Vector == DEBUG_INT3_VECTOR) {
2487 //
2488 // go back address located "0xCC"
2489 //
2490 CpuContext->Eip--;
2491 SavedEip = CpuContext->Eip;
2492 CommandCommunication (Vector, CpuContext, BreakReceived);
2493 if ((SavedEip == CpuContext->Eip) &&
2494 (*(UINT8 *) (UINTN) CpuContext->Eip == DEBUG_SW_BREAKPOINT_SYMBOL)) {
2495 //
2496 // If this is not a software breakpoint set by HOST,
2497 // restore EIP
2498 //
2499 CpuContext->Eip++;
2500 }
2501 } else {
2502 CommandCommunication (Vector, CpuContext, BreakReceived);
2503 }
2504 break;
2505 }
2506
2507 break;
2508
2509 case DEBUG_TIMER_VECTOR:
2510
2511 AcquireMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2512
2513 if (MultiProcessorDebugSupport()) {
2514 if (IsBsp (ProcessorIndex)) {
2515 //
2516 // If current processor is BSP, check Apic timer's init count if changed,
2517 // it may be re-written when switching BSP.
2518 // If it changed, re-initialize debug timer
2519 //
2520 CurrentDebugTimerInitCount = GetApicTimerInitCount ();
2521 if (mDebugMpContext.DebugTimerInitCount != CurrentDebugTimerInitCount) {
2522 InitializeDebugTimer (NULL);
2523 }
2524 }
2525
2526 if (!IsBsp (ProcessorIndex) || mDebugMpContext.IpiSentByAp) {
2527 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2528 //
2529 // If current processor is not BSP or this is one IPI sent by AP
2530 //
2531 if (mDebugMpContext.BreakAtCpuIndex != (UINT32) (-1)) {
2532 CommandCommunication (Vector, CpuContext, FALSE);
2533 }
2534
2535 //
2536 // Clear EOI before exiting interrupt process routine.
2537 //
2538 SendApicEoi ();
2539 break;
2540 }
2541 }
2542
2543 //
2544 // Only BSP could run here
2545 //
2546 while (TRUE) {
2547 //
2548 // If there is data in debug port, will check whether it is break(attach/break-in) symbol,
2549 // If yes, go into communication mode with HOST.
2550 // If no, exit interrupt process.
2551 //
2552 if (DebugReadBreakSymbol (Handle, &InputCharacter) == EFI_NOT_FOUND) {
2553 break;
2554 }
2555
2556 if ((!IsHostAttached () && (InputCharacter == DEBUG_STARTING_SYMBOL_ATTACH)) ||
2557 (IsHostAttached () && (InputCharacter == DEBUG_COMMAND_HALT)) ||
2558 (IsHostAttached () && (InputCharacter == DEBUG_COMMAND_GO))
2559 ) {
2560 DebugAgentMsgPrint (DEBUG_AGENT_VERBOSE, "Received data [%02x]\n", InputCharacter);
2561 //
2562 // Ack OK for break-in symbol
2563 //
2564 SendAckPacket (DEBUG_COMMAND_OK);
2565
2566 //
2567 // If receive GO command in Debug Timer, means HOST may lost ACK packet before.
2568 //
2569 if (InputCharacter == DEBUG_COMMAND_GO) {
2570 break;
2571 }
2572
2573 if (!IsHostAttached ()) {
2574 //
2575 // Try to attach HOST, if no ack received after 200ms, return
2576 //
2577 if (AttachHost (BreakCause, READ_PACKET_TIMEOUT, &BreakReceived) != RETURN_SUCCESS) {
2578 break;
2579 }
2580 }
2581
2582 if (MultiProcessorDebugSupport()) {
2583 if(FindNextPendingBreakCpu () != -1) {
2584 SetCpuBreakFlagByIndex (ProcessorIndex, TRUE);
2585 } else {
2586 HaltOtherProcessors (ProcessorIndex);
2587 }
2588 }
2589 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2590 CommandCommunication (Vector, CpuContext, BreakReceived);
2591 AcquireMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2592 break;
2593 }
2594 }
2595
2596 //
2597 // Clear EOI before exiting interrupt process routine.
2598 //
2599 SendApicEoi ();
2600
2601 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2602
2603 break;
2604
2605 default:
2606 if (Vector <= DEBUG_EXCEPT_SIMD) {
2607 if (BreakCause == DEBUG_DATA_BREAK_CAUSE_STEPPING) {
2608 //
2609 // Stepping is finished, send Ack package.
2610 //
2611 if (MultiProcessorDebugSupport()) {
2612 mDebugMpContext.BreakAtCpuIndex = ProcessorIndex;
2613 }
2614 //
2615 // Clear Stepping flag and restore EFLAGS.IF
2616 //
2617 CommandSteppingCleanup (CpuContext);
2618 SendAckPacket (DEBUG_COMMAND_OK);
2619 } else {
2620 //
2621 // Exception occurs, send Break packet to HOST
2622 //
2623 AcquireMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2624 //
2625 // Only the first breaking processor could send BREAK_POINT to HOST
2626 //
2627 if (IsFirstBreakProcessor (ProcessorIndex)) {
2628 SendBreakPacketToHost (BreakCause, ProcessorIndex, &BreakReceived);
2629 }
2630 ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
2631 }
2632
2633 CommandCommunication (Vector, CpuContext, BreakReceived);
2634 }
2635 break;
2636 }
2637
2638 if (MultiProcessorDebugSupport()) {
2639 //
2640 // Clear flag and wait for all processors run here
2641 //
2642 SetIpiSentByApFlag (FALSE);
2643 while (mDebugMpContext.RunCommandSet) {
2644 CpuPause ();
2645 }
2646
2647 //
2648 // Only current (view) processor could clean up AgentInProgress flag.
2649 //
2650 if (mDebugMpContext.ViewPointIndex == ProcessorIndex) {
2651 IssuedViewPoint = mDebugMpContext.ViewPointIndex;
2652 }
2653 }
2654
2655 if (IssuedViewPoint == ProcessorIndex && GetDebugFlag (DEBUG_AGENT_FLAG_STEPPING) != 1) {
2656 //
2657 // If the command is not stepping, clean up AgentInProgress flag
2658 //
2659 SetDebugFlag (DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS, 0);
2660 }
2661
2662 return;
2663 }
2664
EFI Development Kit II mirror for PVE