2 X64 specific debug support macros, typedefs and prototypes.
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _PLDEBUG_SUPPORT_H
16 #define _PLDEBUG_SUPPORT_H
21 #include <Protocol/DebugSupport.h>
22 #include <Protocol/LoadedImage.h>
24 #include <Library/DebugLib.h>
25 #include <Library/UefiDriverEntryPoint.h>
26 #include <Library/BaseMemoryLib.h>
27 #include <Library/MemoryAllocationLib.h>
28 #include <Library/UefiBootServicesTableLib.h>
29 #include <Library/BaseLib.h>
31 #include <Library/PcdLib.h>
32 #define NUM_IDT_ENTRIES 0x78
33 #define SYSTEM_TIMER_VECTOR 0x68
34 #define VECTOR_ENTRY_PAGES 1
35 #define CopyDescriptor(Dest, Src) CopyMem ((Dest), (Src), sizeof (DESCRIPTOR))
36 #define ZeroDescriptor(Dest) CopyDescriptor ((Dest), &NullDesc)
37 #define ReadIdt(Vector, Dest) CopyDescriptor ((Dest), &((GetIdtr ())[(Vector)]))
38 #define WriteIdt(Vector, Src) CopyDescriptor (&((GetIdtr ())[(Vector)]), (Src))
39 #define CompareDescriptor(Desc1, Desc2) CompareMem ((Desc1), (Desc2), sizeof (DESCRIPTOR))
40 #define EFI_ISA IsaX64
41 #define FF_FXSR (1 << 24)
56 DEBUG_PROC OrigVector
;
59 VOID (*RegisteredCallback
) ();
62 extern EFI_SYSTEM_CONTEXT SystemContext
;
63 extern UINT8 InterruptEntryStub
[];
64 extern UINT32 StubSize
;
65 extern VOID (*OrigVector
) (VOID
);
97 Check whether FXSTOR is supported
106 FALSE - not supported
119 Return the physical address of IDTR
127 The physical address of IDTR
134 DESCRIPTOR
* DestDesc
,
135 VOID (*Vector
) (VOID
)
141 Encodes an IDT descriptor with the given physical address
145 DestDesc - The IDT descriptor address
146 Vector - The interrupt vector entry
163 Programs interrupt flag to the requested state and returns previous
168 NewState - New interrupt status
178 plInitializeDebugSupportDriver (
184 Initializes driver's handler registration database.
186 This code executes in boot services context.
193 EFI_UNSUPPORTED - if X64 processor does not support FXSTOR/FXRSTOR instructions,
194 the context save will fail, so these processor's are not supported.
195 EFI_OUT_OF_RESOURCES - not resource to finish initialization
202 plUnloadDebugSupportDriver (
203 IN EFI_HANDLE ImageHandle
208 This is the callback that is written to the LoadedImage protocol instance
209 on the image handle. It uninstalls all registered handlers and frees all entry
212 This code executes in boot services context.
215 ImageHandle - The image handle of the unload handler
219 EFI_SUCCESS - always return success
225 // DebugSupport protocol member functions
229 GetMaximumProcessorIndex (
230 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
231 OUT UINTN
*MaxProcessorIndex
235 Routine Description: This is a DebugSupport protocol member function.
238 This - The DebugSupport instance
239 MaxProcessorIndex - The maximuim supported processor index
242 Always returns EFI_SUCCESS with *MaxProcessorIndex set to 0
249 RegisterPeriodicCallback (
250 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
251 IN UINTN ProcessorIndex
,
252 IN EFI_PERIODIC_CALLBACK PeriodicCallback
256 Routine Description: This is a DebugSupport protocol member function.
259 This - The DebugSupport instance
260 ProcessorIndex - Which processor the callback applies to.
261 PeriodicCallback - Callback function
266 EFI_INVALID_PARAMETER - requested uninstalling a handler from a vector that has
267 no handler registered for it
268 EFI_ALREADY_STARTED - requested install to a vector that already has a handler registered.
270 Other possible return values are passed through from UnHookEntry and HookEntry.
277 RegisterExceptionCallback (
278 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
279 IN UINTN ProcessorIndex
,
280 IN EFI_EXCEPTION_CALLBACK NewCallback
,
281 IN EFI_EXCEPTION_TYPE ExceptionType
286 This is a DebugSupport protocol member function.
288 This code executes in boot services context.
291 This - The DebugSupport instance
292 ProcessorIndex - Which processor the callback applies to.
293 NewCallback - Callback function
294 ExceptionType - Which exception to hook
299 EFI_INVALID_PARAMETER - requested uninstalling a handler from a vector that has
300 no handler registered for it
301 EFI_ALREADY_STARTED - requested install to a vector that already has a handler registered.
303 Other possible return values are passed through from UnHookEntry and HookEntry.
310 InvalidateInstructionCache (
311 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
312 IN UINTN ProcessorIndex
,
319 This is a DebugSupport protocol member function.
320 Calls assembly routine to flush cache.
323 This - The DebugSupport instance
324 ProcessorIndex - Which processor the callback applies to.
325 Start - Physical base of the memory range to be invalidated
326 Length - mininum number of bytes in instruction cache to invalidate
330 EFI_SUCCESS - always return success