2 Debug Agent library implementition for Dxe Core and Dxr modules.
4 Copyright (c) 2010 - 2017, 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 #include "DxeDebugAgentLib.h"
17 DEBUG_AGENT_MAILBOX mMailbox
;
18 DEBUG_AGENT_MAILBOX
*mMailboxPointer
= NULL
;
19 IA32_IDT_GATE_DESCRIPTOR mIdtEntryTable
[33];
20 BOOLEAN mDxeCoreFlag
= FALSE
;
21 BOOLEAN mMultiProcessorDebugSupport
= FALSE
;
22 VOID
*mSavedIdtTable
= NULL
;
23 UINTN mSaveIdtTableSize
= 0;
24 BOOLEAN mDebugAgentInitialized
= FALSE
;
25 BOOLEAN mSkipBreakpoint
= FALSE
;
28 Check if debug agent support multi-processor.
30 @retval TRUE Multi-processor is supported.
31 @retval FALSE Multi-processor is not supported.
35 MultiProcessorDebugSupport (
39 return mMultiProcessorDebugSupport
;
43 Internal constructor worker function.
45 It will register one callback function on EFI PCD Protocol.
46 It will allocate the NVS memory to store Mailbox and install configuration table
47 in system table to store its pointer.
51 InternalConstructorWorker (
56 EFI_PHYSICAL_ADDRESS Address
;
57 BOOLEAN DebugTimerInterruptState
;
58 DEBUG_AGENT_MAILBOX
*Mailbox
;
59 DEBUG_AGENT_MAILBOX
*NewMailbox
;
60 EFI_HOB_GUID_TYPE
*GuidHob
;
61 EFI_VECTOR_HANDOFF_INFO
*VectorHandoffInfo
;
64 // Check persisted vector handoff info
67 GuidHob
= GetFirstGuidHob (&gEfiVectorHandoffInfoPpiGuid
);
68 if (GuidHob
!= NULL
&& !mDxeCoreFlag
) {
70 // Check if configuration table is installed or not if GUIDed HOB existed,
71 // only when Debug Agent is not linked by DXE Core
73 Status
= EfiGetSystemConfigurationTable (&gEfiVectorHandoffTableGuid
, (VOID
**) &VectorHandoffInfo
);
75 if (GuidHob
== NULL
|| Status
!= EFI_SUCCESS
) {
77 // Install configuration table for persisted vector handoff info if GUIDed HOB cannot be found or
78 // configuration table does not exist
80 Status
= gBS
->InstallConfigurationTable (&gEfiVectorHandoffTableGuid
, (VOID
*) &mVectorHandoffInfoDebugAgent
[0]);
81 if (EFI_ERROR (Status
)) {
82 DEBUG ((EFI_D_ERROR
, "DebugAgent: Cannot install configuration table for persisted vector handoff info!\n"));
88 // Install EFI Serial IO protocol on debug port
93 Status
= gBS
->AllocatePages (
96 EFI_SIZE_TO_PAGES (sizeof(DEBUG_AGENT_MAILBOX
) + PcdGet16(PcdDebugPortHandleBufferSize
)),
99 if (EFI_ERROR (Status
)) {
100 DEBUG ((EFI_D_ERROR
, "DebugAgent: Cannot install configuration table for mailbox!\n"));
104 DebugTimerInterruptState
= SaveAndSetDebugTimerInterrupt (FALSE
);
106 NewMailbox
= (DEBUG_AGENT_MAILBOX
*) (UINTN
) Address
;
108 // Copy Mailbox and Debug Port Handle buffer to new location in ACPI NVS memory, because original Mailbox
109 // and Debug Port Handle buffer may be free at runtime, SMM debug agent needs to access them
111 Mailbox
= GetMailboxPointer ();
112 CopyMem (NewMailbox
, Mailbox
, sizeof (DEBUG_AGENT_MAILBOX
));
113 CopyMem (NewMailbox
+ 1, (VOID
*)(UINTN
)Mailbox
->DebugPortHandle
, PcdGet16(PcdDebugPortHandleBufferSize
));
115 // Update Debug Port Handle in new Mailbox
117 UpdateMailboxContent (NewMailbox
, DEBUG_MAILBOX_DEBUG_PORT_HANDLE_INDEX
, (UINT64
)(UINTN
)(NewMailbox
+ 1));
118 mMailboxPointer
= NewMailbox
;
120 DebugTimerInterruptState
= SaveAndSetDebugTimerInterrupt (DebugTimerInterruptState
);
122 Status
= gBS
->InstallConfigurationTable (&gEfiDebugAgentGuid
, (VOID
*) mMailboxPointer
);
123 if (EFI_ERROR (Status
)) {
124 DEBUG ((EFI_D_ERROR
, "DebugAgent: Failed to install configuration for mailbox!\n"));
130 Debug Agent constructor function.
132 @param[in] ImageHandle The firmware allocated handle for the EFI image.
133 @param[in] SystemTable A pointer to the EFI System Table.
135 @retval RETURN_SUCCESS When this function completed.
140 DxeDebugAgentLibConstructor (
141 IN EFI_HANDLE ImageHandle
,
142 IN EFI_SYSTEM_TABLE
*SystemTable
147 // Invoke internal constructor function only when DXE core links this library instance
149 InternalConstructorWorker ();
152 return RETURN_SUCCESS
;
156 Get the pointer to Mailbox from the configuration table.
158 @return Pointer to Mailbox.
161 DEBUG_AGENT_MAILBOX
*
162 GetMailboxFromConfigurationTable (
167 DEBUG_AGENT_MAILBOX
*Mailbox
;
169 Status
= EfiGetSystemConfigurationTable (&gEfiDebugAgentGuid
, (VOID
**) &Mailbox
);
170 if (Status
== EFI_SUCCESS
&& Mailbox
!= NULL
) {
171 VerifyMailboxChecksum (Mailbox
);
179 Get the pointer to Mailbox from the GUIDed HOB.
181 @param[in] HobStart The starting HOB pointer to search from.
183 @return Pointer to Mailbox.
186 DEBUG_AGENT_MAILBOX
*
191 EFI_HOB_GUID_TYPE
*GuidHob
;
192 UINT64
*MailboxLocation
;
193 DEBUG_AGENT_MAILBOX
*Mailbox
;
195 GuidHob
= GetNextGuidHob (&gEfiDebugAgentGuid
, HobStart
);
196 if (GuidHob
== NULL
) {
199 MailboxLocation
= (UINT64
*) (GET_GUID_HOB_DATA(GuidHob
));
200 Mailbox
= (DEBUG_AGENT_MAILBOX
*)(UINTN
)(*MailboxLocation
);
201 VerifyMailboxChecksum (Mailbox
);
207 Get Debug Agent Mailbox pointer.
209 @return Mailbox pointer.
212 DEBUG_AGENT_MAILBOX
*
217 AcquireMpSpinLock (&mDebugMpContext
.MailboxSpinLock
);
218 VerifyMailboxChecksum (mMailboxPointer
);
219 ReleaseMpSpinLock (&mDebugMpContext
.MailboxSpinLock
);
220 return mMailboxPointer
;
224 Get debug port handle.
226 @return Debug port handle.
234 return (DEBUG_PORT_HANDLE
) (UINTN
)(GetMailboxPointer ()->DebugPortHandle
);
238 Worker function to set up Debug Agent environment.
240 This function will set up IDT table and initialize the IDT entries and
241 initialize CPU LOCAL APIC timer.
242 It also tries to connect HOST if Debug Agent was not initialized before.
244 @param[in] Mailbox Pointer to Mailbox.
248 SetupDebugAgentEnvironment (
249 IN DEBUG_AGENT_MAILBOX
*Mailbox
252 IA32_DESCRIPTOR Idtr
;
253 UINT16 IdtEntryCount
;
254 UINT64 DebugPortHandle
;
255 UINT32 DebugTimerFrequency
;
257 if (mMultiProcessorDebugSupport
) {
258 InitializeSpinLock (&mDebugMpContext
.MpContextSpinLock
);
259 InitializeSpinLock (&mDebugMpContext
.DebugPortSpinLock
);
260 InitializeSpinLock (&mDebugMpContext
.MailboxSpinLock
);
262 // Clear Break CPU index value
264 mDebugMpContext
.BreakAtCpuIndex
= (UINT32
) -1;
268 // Get original IDT address and size.
270 AsmReadIdtr ((IA32_DESCRIPTOR
*) &Idtr
);
271 IdtEntryCount
= (UINT16
) ((Idtr
.Limit
+ 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR
));
272 if (IdtEntryCount
< 33) {
273 ZeroMem (&mIdtEntryTable
, sizeof (IA32_IDT_GATE_DESCRIPTOR
) * 33);
275 // Copy original IDT table into new one
277 CopyMem (&mIdtEntryTable
, (VOID
*) Idtr
.Base
, Idtr
.Limit
+ 1);
279 // Load new IDT table
281 Idtr
.Limit
= (UINT16
) (sizeof (IA32_IDT_GATE_DESCRIPTOR
) * 33 - 1);
282 Idtr
.Base
= (UINTN
) &mIdtEntryTable
;
283 AsmWriteIdtr ((IA32_DESCRIPTOR
*) &Idtr
);
287 // Initialize the IDT table entries to support source level debug.
289 InitializeDebugIdt ();
292 // If mMailboxPointer is not set before, set it
294 if (mMailboxPointer
== NULL
) {
295 if (Mailbox
!= NULL
) {
297 // If Mailbox exists, copy it into one global variable
299 CopyMem (&mMailbox
, Mailbox
, sizeof (DEBUG_AGENT_MAILBOX
));
301 ZeroMem (&mMailbox
, sizeof (DEBUG_AGENT_MAILBOX
));
303 mMailboxPointer
= &mMailbox
;
307 // Initialize Debug Timer hardware and save its initial count and frequency
309 mDebugMpContext
.DebugTimerInitCount
= InitializeDebugTimer (&DebugTimerFrequency
, TRUE
);
310 UpdateMailboxContent (mMailboxPointer
, DEBUG_MAILBOX_DEBUG_TIMER_FREQUENCY
, DebugTimerFrequency
);
312 // Initialize debug communication port
314 DebugPortHandle
= (UINT64
) (UINTN
)DebugPortInitialize ((VOID
*)(UINTN
)mMailboxPointer
->DebugPortHandle
, NULL
);
315 UpdateMailboxContent (mMailboxPointer
, DEBUG_MAILBOX_DEBUG_PORT_HANDLE_INDEX
, DebugPortHandle
);
317 if (Mailbox
== NULL
) {
319 // Trigger one software interrupt to inform HOST
321 TriggerSoftInterrupt (SYSTEM_RESET_SIGNATURE
);
322 SetDebugFlag (DEBUG_AGENT_FLAG_MEMORY_READY
, 1);
324 // Memory has been ready
326 if (IsHostAttached ()) {
328 // Trigger one software interrupt to inform HOST
330 TriggerSoftInterrupt (MEMORY_READY_SIGNATURE
);
337 Initialize debug agent.
339 This function is used to set up debug environment for DXE phase.
341 If this function is called by DXE Core, Context must be the pointer
342 to HOB list which will be used to get GUIDed HOB. It will enable
343 interrupt to support break-in feature.
344 If this function is called by DXE module, Context must be NULL. It
345 will enable interrupt to support break-in feature.
347 @param[in] InitFlag Init flag is used to decide initialize process.
348 @param[in] Context Context needed according to InitFlag.
349 @param[in] Function Continue function called by debug agent library; it was
355 InitializeDebugAgent (
357 IN VOID
*Context
, OPTIONAL
358 IN DEBUG_AGENT_CONTINUE Function OPTIONAL
361 UINT64
*MailboxLocation
;
362 DEBUG_AGENT_MAILBOX
*Mailbox
;
363 BOOLEAN InterruptStatus
;
365 IA32_DESCRIPTOR IdtDescriptor
;
366 IA32_DESCRIPTOR
*Ia32Idtr
;
367 IA32_IDT_ENTRY
*Ia32IdtEntry
;
368 BOOLEAN PeriodicMode
;
371 if (InitFlag
== DEBUG_AGENT_INIT_DXE_AP
) {
373 // Check if CPU APIC Timer is working, otherwise initialize it.
375 InitializeLocalApicSoftwareEnable (TRUE
);
376 GetApicTimerState (NULL
, &PeriodicMode
, NULL
);
377 TimerCycle
= GetApicTimerInitCount ();
378 if (!PeriodicMode
|| TimerCycle
== 0) {
379 InitializeDebugTimer (NULL
, FALSE
);
382 // Invoked by AP, enable interrupt to let AP could receive IPI from other processors
389 // Disable Debug Timer interrupt
391 SaveAndSetDebugTimerInterrupt (FALSE
);
393 // Save and disable original interrupt status
395 InterruptStatus
= SaveAndDisableInterrupts ();
398 // Try to get mailbox firstly
402 MailboxLocation
= NULL
;
406 case DEBUG_AGENT_INIT_DXE_LOAD
:
408 // Check if Debug Agent has been initialized before
410 if (IsDebugAgentInitialzed ()) {
411 DEBUG ((EFI_D_INFO
, "Debug Agent: The former agent will be overwritten by the new one!\n"));
414 mMultiProcessorDebugSupport
= TRUE
;
416 // Save original IDT table
418 AsmReadIdtr (&IdtDescriptor
);
419 mSaveIdtTableSize
= IdtDescriptor
.Limit
+ 1;
420 mSavedIdtTable
= AllocateCopyPool (mSaveIdtTableSize
, (VOID
*) IdtDescriptor
.Base
);
422 // Check if Debug Agent initialized in DXE phase
424 Mailbox
= GetMailboxFromConfigurationTable ();
425 if (Mailbox
== NULL
) {
427 // Try to get mailbox from GUIDed HOB build in PEI
429 HobList
= GetHobList ();
430 Mailbox
= GetMailboxFromHob (HobList
);
433 // Set up Debug Agent Environment and try to connect HOST if required
435 SetupDebugAgentEnvironment (Mailbox
);
437 // For DEBUG_AGENT_INIT_S3, needn't to install configuration table and EFI Serial IO protocol
438 // For DEBUG_AGENT_INIT_DXE_CORE, InternalConstructorWorker() will invoked in Constructor()
440 InternalConstructorWorker ();
442 // Enable Debug Timer interrupt
444 SaveAndSetDebugTimerInterrupt (TRUE
);
446 // Enable interrupt to receive Debug Timer interrupt
450 mDebugAgentInitialized
= TRUE
;
451 FindAndReportModuleImageInfo (SIZE_4KB
);
453 *(EFI_STATUS
*)Context
= EFI_SUCCESS
;
457 case DEBUG_AGENT_INIT_DXE_UNLOAD
:
458 if (mDebugAgentInitialized
) {
459 if (IsHostAttached ()) {
460 *(EFI_STATUS
*)Context
= EFI_ACCESS_DENIED
;
462 // Enable Debug Timer interrupt again
464 SaveAndSetDebugTimerInterrupt (TRUE
);
467 // Restore original IDT table
469 AsmReadIdtr (&IdtDescriptor
);
470 IdtDescriptor
.Limit
= (UINT16
) (mSaveIdtTableSize
- 1);
471 CopyMem ((VOID
*) IdtDescriptor
.Base
, mSavedIdtTable
, mSaveIdtTableSize
);
472 AsmWriteIdtr (&IdtDescriptor
);
473 FreePool (mSavedIdtTable
);
474 mDebugAgentInitialized
= FALSE
;
475 *(EFI_STATUS
*)Context
= EFI_SUCCESS
;
478 *(EFI_STATUS
*)Context
= EFI_NOT_STARTED
;
482 // Restore interrupt state.
484 SetInterruptState (InterruptStatus
);
487 case DEBUG_AGENT_INIT_DXE_CORE
:
489 mMultiProcessorDebugSupport
= TRUE
;
491 // Try to get mailbox from GUIDed HOB build in PEI
494 Mailbox
= GetMailboxFromHob (HobList
);
496 // Set up Debug Agent Environment and try to connect HOST if required
498 SetupDebugAgentEnvironment (Mailbox
);
500 // Enable Debug Timer interrupt
502 SaveAndSetDebugTimerInterrupt (TRUE
);
504 // Enable interrupt to receive Debug Timer interrupt
510 case DEBUG_AGENT_INIT_S3
:
512 if (Context
!= NULL
) {
513 Ia32Idtr
= (IA32_DESCRIPTOR
*) Context
;
514 Ia32IdtEntry
= (IA32_IDT_ENTRY
*)(Ia32Idtr
->Base
);
515 MailboxLocation
= (UINT64
*) ((UINTN
) Ia32IdtEntry
[DEBUG_MAILBOX_VECTOR
].Bits
.OffsetLow
+
516 ((UINTN
) Ia32IdtEntry
[DEBUG_MAILBOX_VECTOR
].Bits
.OffsetHigh
<< 16));
517 Mailbox
= (DEBUG_AGENT_MAILBOX
*)(UINTN
)(*MailboxLocation
);
518 VerifyMailboxChecksum (Mailbox
);
521 // Save Mailbox pointer in global variable
523 mMailboxPointer
= Mailbox
;
525 // Set up Debug Agent Environment and try to connect HOST if required
527 SetupDebugAgentEnvironment (Mailbox
);
531 DisableInterrupts ();
532 FindAndReportModuleImageInfo (SIZE_4KB
);
533 if (GetDebugFlag (DEBUG_AGENT_FLAG_BREAK_BOOT_SCRIPT
) == 1) {
535 // If Boot Script entry break is set, code will be break at here.
543 // Only DEBUG_AGENT_INIT_PREMEM_SEC and DEBUG_AGENT_INIT_POSTMEM_SEC are allowed for this
544 // Debug Agent library instance.
546 DEBUG ((EFI_D_ERROR
, "Debug Agent: The InitFlag value is not allowed!\n"));