2 Generic debug support macros, typedefs and prototypes for IA32/x64.
4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _DEBUG_SUPPORT_H_
16 #define _DEBUG_SUPPORT_H_
20 #include <Protocol/DebugSupport.h>
21 #include <Protocol/LoadedImage.h>
23 #include <Library/DebugLib.h>
24 #include <Library/UefiDriverEntryPoint.h>
25 #include <Library/BaseMemoryLib.h>
26 #include <Library/MemoryAllocationLib.h>
27 #include <Library/UefiBootServicesTableLib.h>
28 #include <Library/BaseLib.h>
30 #define NUM_IDT_ENTRIES 0x78
31 #define SYSTEM_TIMER_VECTOR 0x68
41 (EFIAPI
*CALLBACK_FUNC
) (
45 IA32_IDT_GATE_DESCRIPTOR OrigDesc
;
46 DEBUG_PROC OrigVector
;
47 IA32_IDT_GATE_DESCRIPTOR NewDesc
;
49 CALLBACK_FUNC RegisteredCallback
;
52 extern UINT8 InterruptEntryStub
[];
53 extern UINT32 StubSize
;
54 extern VOID (*OrigVector
) (VOID
);
55 extern IDT_ENTRY
*IdtEntryTable
;
56 extern IA32_IDT_GATE_DESCRIPTOR NullDesc
;
68 Check whether FXSTOR is supported
70 @retval TRUE FXSTOR is supported.
71 @retval FALSE FXSTOR is not supported.
80 Encodes an IDT descriptor with the given physical address.
82 @param DestDesc The IDT descriptor address.
83 @param Vecotr The interrupt vector entry.
88 IA32_IDT_GATE_DESCRIPTOR
* DestDesc
,
93 Initializes driver's handler registration database.
95 This code executes in boot services context
96 Must be public because it's referenced from DebugSupport.c
98 @retval EFI_UNSUPPORTED If IA32 processor does not support FXSTOR/FXRSTOR instructions,
99 the context save will fail, so these processor's are not supported.
100 @retval EFI_OUT_OF_RESOURCES Fails to allocate memory.
101 @retval EFI_SUCCESS Initializes successfully.
105 PlInitializeDebugSupportDriver (
110 This is the callback that is written to the LoadedImage protocol instance
111 on the image handle. It uninstalls all registered handlers and frees all entry
114 @param ImageHandle The firmware allocated handle for the EFI image.
116 @retval EFI_SUCCESS Always.
121 PlUnloadDebugSupportDriver (
122 IN EFI_HANDLE ImageHandle
126 Returns the maximum value that may be used for the ProcessorIndex parameter in
127 RegisterPeriodicCallback() and RegisterExceptionCallback().
129 Hard coded to support only 1 processor for now.
131 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
132 @param MaxProcessorIndex Pointer to a caller-allocated UINTN in which the maximum supported
133 processor index is returned. Always 0 returned.
135 @retval EFI_SUCCESS Always returned with **MaxProcessorIndex set to 0.
140 GetMaximumProcessorIndex (
141 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
142 OUT UINTN
*MaxProcessorIndex
146 Registers a function to be called back periodically in interrupt context.
148 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
149 @param ProcessorIndex Specifies which processor the callback function applies to.
150 @param PeriodicCallback A pointer to a function of type PERIODIC_CALLBACK that is the main
151 periodic entry point of the debug agent.
153 @retval EFI_SUCCESS The function completed successfully.
154 @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback
155 function was previously registered.
156 @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback
161 RegisterPeriodicCallback (
162 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
163 IN UINTN ProcessorIndex
,
164 IN EFI_PERIODIC_CALLBACK PeriodicCallback
168 Registers a function to be called when a given processor exception occurs.
170 This code executes in boot services context.
172 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
173 @param ProcessorIndex Specifies which processor the callback function applies to.
174 @param ExceptionCallback A pointer to a function of type EXCEPTION_CALLBACK that is called
175 when the processor exception specified by ExceptionType occurs.
176 @param ExceptionType Specifies which processor exception to hook.
178 @retval EFI_SUCCESS The function completed successfully.
179 @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback
180 function was previously registered.
181 @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback
186 RegisterExceptionCallback (
187 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
188 IN UINTN ProcessorIndex
,
189 IN EFI_EXCEPTION_CALLBACK ExceptionCallback
,
190 IN EFI_EXCEPTION_TYPE ExceptionType
194 Invalidates processor instruction cache for a memory range. Subsequent execution in this range
195 causes a fresh memory fetch to retrieve code to be executed.
197 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
198 @param ProcessorIndex Specifies which processor's instruction cache is to be invalidated.
199 @param Start Specifies the physical base of the memory range to be invalidated.
200 @param Length Specifies the minimum number of bytes in the processor's instruction
203 @retval EFI_SUCCESS Always returned.
208 InvalidateInstructionCache (
209 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
210 IN UINTN ProcessorIndex
,
216 Allocate pool for a new IDT entry stub.
218 Copy the generic stub into the new buffer and fixup the vector number
219 and jump target address.
221 @param ExceptionType This is the exception type that the new stub will be created
223 @param Stub On successful exit, *Stub contains the newly allocated entry stub.
228 IN EFI_EXCEPTION_TYPE ExceptionType
,
233 Get Interrupt Handle from IDT Gate Descriptor.
235 @param IdtGateDecriptor IDT Gate Descriptor.
237 @return Interrupt Handle stored in IDT Gate Descriptor.
241 GetInterruptHandleFromIdt (
242 IN IA32_IDT_GATE_DESCRIPTOR
*IdtGateDecriptor
246 This is the main worker function that manages the state of the interrupt
247 handlers. It both installs and uninstalls interrupt handlers based on the
248 value of NewCallback. If NewCallback is NULL, then uninstall is indicated.
249 If NewCallback is non-NULL, then install is indicated.
251 @param NewCallback If non-NULL, NewCallback specifies the new handler to register.
252 If NULL, specifies that the previously registered handler should
254 @param ExceptionType Indicates which entry to manage.
256 @retval EFI_SUCCESS Process is ok.
257 @retval EFI_INVALID_PARAMETER Requested uninstalling a handler from a vector that has
258 no handler registered for it
259 @retval EFI_ALREADY_STARTED Requested install to a vector that already has a handler registered.
260 @retval others Possible return values are passed through from UnHookEntry and HookEntry.
264 ManageIdtEntryTable (
265 CALLBACK_FUNC NewCallback
,
266 EFI_EXCEPTION_TYPE ExceptionType
270 Creates a nes entry stub. Then saves the current IDT entry and replaces it
271 with an interrupt gate for the new entry point. The IdtEntryTable is updated
272 with the new registered function.
274 This code executes in boot services context. The stub entry executes in interrupt
277 @param ExceptionType Specifies which vector to hook.
278 @param NewCallback A pointer to the new function to be registered.
283 IN EFI_EXCEPTION_TYPE ExceptionType
,
284 IN CALLBACK_FUNC NewCallback
288 Undoes HookEntry. This code executes in boot services context.
290 @param ExceptionType Specifies which entry to unhook
295 IN EFI_EXCEPTION_TYPE ExceptionType