ECC clean up.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6405 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@ -1,4 +1,4 @@
|
||||
/**@file
|
||||
/** @file
|
||||
X64 specific debug support functions
|
||||
|
||||
Copyright (c) 2006 - 2007, Intel Corporation
|
||||
@ -23,25 +23,24 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
IDT_ENTRY *IdtEntryTable = NULL;
|
||||
DESCRIPTOR NullDesc = {0, 0};
|
||||
|
||||
/**
|
||||
Allocate pool for a new IDT entry stub.
|
||||
|
||||
Copy the generic stub into the new buffer and fixup the vector number
|
||||
and jump target address.
|
||||
|
||||
@param ExceptionType This is the exception type that the new stub will be created
|
||||
for.
|
||||
@param Stub On successful exit, *Stub contains the newly allocated entry stub.
|
||||
|
||||
@retval EFI_SUCCESS Always.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
CreateEntryStub (
|
||||
IN EFI_EXCEPTION_TYPE ExceptionType,
|
||||
OUT VOID **Stub
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description: Allocate pool for a new IDT entry stub. Copy the generic
|
||||
stub into the new buffer and fixup the vector number and jump target address.
|
||||
|
||||
Arguments:
|
||||
ExceptionType - This is the exception type that the new stub will be created
|
||||
for.
|
||||
Stub - On successful exit, *Stub contains the newly allocated entry stub.
|
||||
Returns:
|
||||
Typically EFI_SUCCESS
|
||||
other possibilities are passed through from AllocatePool
|
||||
|
||||
--*/
|
||||
{
|
||||
UINT8 *StubCopy;
|
||||
|
||||
@ -71,14 +70,7 @@ Returns:
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
EFI_STATUS
|
||||
HookEntry (
|
||||
IN EFI_EXCEPTION_TYPE ExceptionType,
|
||||
IN VOID (*NewCallback) ()
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
/**
|
||||
Creates a nes entry stub. Then saves the current IDT entry and replaces it
|
||||
with an interrupt gate for the new entry point. The IdtEntryTable is updated
|
||||
with the new registered function.
|
||||
@ -86,15 +78,17 @@ Routine Description:
|
||||
This code executes in boot services context. The stub entry executes in interrupt
|
||||
context.
|
||||
|
||||
Arguments:
|
||||
ExceptionType - specifies which vector to hook.
|
||||
NewCallback - a pointer to the new function to be registered.
|
||||
@param ExceptionType Specifies which vector to hook.
|
||||
@param NewCallback A pointer to the new function to be registered.
|
||||
|
||||
Returns:
|
||||
EFI_SUCCESS
|
||||
Other possibilities are passed through by CreateEntryStub
|
||||
@retval EFI_SUCCESS Always.
|
||||
|
||||
--*/
|
||||
**/
|
||||
EFI_STATUS
|
||||
HookEntry (
|
||||
IN EFI_EXCEPTION_TYPE ExceptionType,
|
||||
IN VOID (*NewCallback) ()
|
||||
)
|
||||
{
|
||||
BOOLEAN OldIntFlagState;
|
||||
EFI_STATUS Status;
|
||||
@ -102,7 +96,7 @@ Returns:
|
||||
Status = CreateEntryStub (ExceptionType, (VOID **) &IdtEntryTable[ExceptionType].StubEntry);
|
||||
if (Status == EFI_SUCCESS) {
|
||||
OldIntFlagState = WriteInterruptFlag (0);
|
||||
ReadIdt (ExceptionType, &(IdtEntryTable[ExceptionType].OrigDesc));
|
||||
READ_IDT (ExceptionType, &(IdtEntryTable[ExceptionType].OrigDesc));
|
||||
|
||||
((UINT16 *) &IdtEntryTable[ExceptionType].OrigVector)[0] = ((UINT16 *) &IdtEntryTable[ExceptionType].OrigDesc.Low)[0];
|
||||
((UINT16 *) &IdtEntryTable[ExceptionType].OrigVector)[1] = ((UINT16 *) &IdtEntryTable[ExceptionType].OrigDesc.Low)[3];
|
||||
@ -110,73 +104,64 @@ Returns:
|
||||
|
||||
Vect2Desc (&IdtEntryTable[ExceptionType].NewDesc, IdtEntryTable[ExceptionType].StubEntry);
|
||||
IdtEntryTable[ExceptionType].RegisteredCallback = NewCallback;
|
||||
WriteIdt (ExceptionType, &(IdtEntryTable[ExceptionType].NewDesc));
|
||||
WRITE_IDT (ExceptionType, &(IdtEntryTable[ExceptionType].NewDesc));
|
||||
WriteInterruptFlag (OldIntFlagState);
|
||||
}
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
/**
|
||||
Undoes HookEntry. This code executes in boot services context.
|
||||
|
||||
@param ExceptionType Specifies which entry to unhook
|
||||
|
||||
@retval EFI_SUCCESS Always.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
UnhookEntry (
|
||||
IN EFI_EXCEPTION_TYPE ExceptionType
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
Undoes HookEntry. This code executes in boot services context.
|
||||
|
||||
Arguments:
|
||||
ExceptionType - specifies which entry to unhook
|
||||
|
||||
Returns:
|
||||
EFI_SUCCESS
|
||||
|
||||
--*/
|
||||
{
|
||||
BOOLEAN OldIntFlagState;
|
||||
|
||||
OldIntFlagState = WriteInterruptFlag (0);
|
||||
WriteIdt (ExceptionType, &(IdtEntryTable[ExceptionType].OrigDesc));
|
||||
WRITE_IDT (ExceptionType, &(IdtEntryTable[ExceptionType].OrigDesc));
|
||||
WriteInterruptFlag (OldIntFlagState);
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
EFI_STATUS
|
||||
ManageIdtEntryTable (
|
||||
VOID (*NewCallback)(),
|
||||
EFI_EXCEPTION_TYPE ExceptionType
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
/**
|
||||
This is the main worker function that manages the state of the interrupt
|
||||
handlers. It both installs and uninstalls interrupt handlers based on the
|
||||
value of NewCallback. If NewCallback is NULL, then uninstall is indicated.
|
||||
If NewCallback is non-NULL, then install is indicated.
|
||||
|
||||
Arguments:
|
||||
NewCallback - If non-NULL, NewCallback specifies the new handler to register.
|
||||
If NULL, specifies that the previously registered handler should
|
||||
be uninstalled.
|
||||
ExceptionType - Indicates which entry to manage
|
||||
@param NewCallback If non-NULL, NewCallback specifies the new handler to register.
|
||||
If NULL, specifies that the previously registered handler should
|
||||
be uninstalled.
|
||||
@param ExceptionType Indicates which entry to manage.
|
||||
|
||||
Returns:
|
||||
EFI_SUCCESS
|
||||
EFI_INVALID_PARAMETER - requested uninstalling a handler from a vector that has
|
||||
no handler registered for it
|
||||
EFI_ALREADY_STARTED - requested install to a vector that already has a handler registered.
|
||||
@retval EFI_SUCCESS Process is ok.
|
||||
@retval EFI_INVALID_PARAMETER Requested uninstalling a handler from a vector that has
|
||||
no handler registered for it
|
||||
@retval EFI_ALREADY_STARTED Requested install to a vector that already has a handler registered.
|
||||
@retval others Possible return values are passed through from UnHookEntry and HookEntry.
|
||||
|
||||
Other possible return values are passed through from UnHookEntry and HookEntry.
|
||||
|
||||
--*/
|
||||
**/
|
||||
EFI_STATUS
|
||||
ManageIdtEntryTable (
|
||||
VOID (*NewCallback)(),
|
||||
EFI_EXCEPTION_TYPE ExceptionType
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
||||
Status = EFI_SUCCESS;
|
||||
|
||||
if (CompareDescriptor (&IdtEntryTable[ExceptionType].NewDesc, &NullDesc)) {
|
||||
if (COMPARE_DESCRIPTOR (&IdtEntryTable[ExceptionType].NewDesc, &NullDesc)) {
|
||||
//
|
||||
// we've already installed to this vector
|
||||
//
|
||||
@ -205,29 +190,38 @@ Returns:
|
||||
return Status;
|
||||
}
|
||||
|
||||
/**
|
||||
This is a DebugSupport protocol member function, hard
|
||||
coded to support only 1 processor for now.
|
||||
|
||||
@param This The DebugSupport instance
|
||||
@param MaxProcessorIndex The maximuim supported processor index
|
||||
|
||||
@retval EFI_SUCCESS Always returned with **MaxProcessorIndex set to 0.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
GetMaximumProcessorIndex (
|
||||
IN EFI_DEBUG_SUPPORT_PROTOCOL *This,
|
||||
OUT UINTN *MaxProcessorIndex
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description: This is a DebugSupport protocol member function.
|
||||
|
||||
Arguments:
|
||||
This - The DebugSupport instance
|
||||
MaxProcessorIndex - The maximuim supported processor index
|
||||
|
||||
Returns:
|
||||
Always returns EFI_SUCCESS with *MaxProcessorIndex set to 0
|
||||
|
||||
--*/
|
||||
{
|
||||
*MaxProcessorIndex = 0;
|
||||
return (EFI_SUCCESS);
|
||||
}
|
||||
|
||||
/**
|
||||
DebugSupport protocol member function.
|
||||
|
||||
@param This The DebugSupport instance
|
||||
@param ProcessorIndex Which processor the callback applies to.
|
||||
@param PeriodicCallback Callback function
|
||||
|
||||
@retval EFI_SUCCESS Indicates the callback was registered.
|
||||
@retval others Callback was not registered.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RegisterPeriodicCallback (
|
||||
@ -235,29 +229,24 @@ RegisterPeriodicCallback (
|
||||
IN UINTN ProcessorIndex,
|
||||
IN EFI_PERIODIC_CALLBACK PeriodicCallback
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description: This is a DebugSupport protocol member function.
|
||||
|
||||
Arguments:
|
||||
This - The DebugSupport instance
|
||||
ProcessorIndex - Which processor the callback applies to.
|
||||
PeriodicCallback - Callback function
|
||||
|
||||
Returns:
|
||||
|
||||
EFI_SUCCESS
|
||||
EFI_INVALID_PARAMETER - requested uninstalling a handler from a vector that has
|
||||
no handler registered for it
|
||||
EFI_ALREADY_STARTED - requested install to a vector that already has a handler registered.
|
||||
|
||||
Other possible return values are passed through from UnHookEntry and HookEntry.
|
||||
|
||||
--*/
|
||||
{
|
||||
return ManageIdtEntryTable (PeriodicCallback, SYSTEM_TIMER_VECTOR);
|
||||
}
|
||||
|
||||
/**
|
||||
DebugSupport protocol member function.
|
||||
|
||||
This code executes in boot services context.
|
||||
|
||||
@param This The DebugSupport instance
|
||||
@param ProcessorIndex Which processor the callback applies to.
|
||||
@param NewCallback Callback function
|
||||
@param ExceptionType Which exception to hook
|
||||
|
||||
@retval EFI_SUCCESS Indicates the callback was registered.
|
||||
@retval others Callback was not registered.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
RegisterExceptionCallback (
|
||||
@ -266,33 +255,21 @@ RegisterExceptionCallback (
|
||||
IN EFI_EXCEPTION_CALLBACK NewCallback,
|
||||
IN EFI_EXCEPTION_TYPE ExceptionType
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
This is a DebugSupport protocol member function.
|
||||
|
||||
This code executes in boot services context.
|
||||
|
||||
Arguments:
|
||||
This - The DebugSupport instance
|
||||
ProcessorIndex - Which processor the callback applies to.
|
||||
NewCallback - Callback function
|
||||
ExceptionType - Which exception to hook
|
||||
|
||||
Returns:
|
||||
|
||||
EFI_SUCCESS
|
||||
EFI_INVALID_PARAMETER - requested uninstalling a handler from a vector that has
|
||||
no handler registered for it
|
||||
EFI_ALREADY_STARTED - requested install to a vector that already has a handler registered.
|
||||
|
||||
Other possible return values are passed through from UnHookEntry and HookEntry.
|
||||
|
||||
--*/
|
||||
{
|
||||
return ManageIdtEntryTable (NewCallback, ExceptionType);
|
||||
}
|
||||
|
||||
/**
|
||||
DebugSupport protocol member function. Calls assembly routine to flush cache.
|
||||
|
||||
@param This The DebugSupport instance
|
||||
@param ProcessorIndex Which processor the callback applies to.
|
||||
@param Start Physical base of the memory range to be invalidated
|
||||
@param Length mininum number of bytes in instruction cache to invalidate
|
||||
|
||||
@retval EFI_SUCCESS Always returned.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
InvalidateInstructionCache (
|
||||
@ -301,49 +278,27 @@ InvalidateInstructionCache (
|
||||
IN VOID *Start,
|
||||
IN UINT64 Length
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
This is a DebugSupport protocol member function.
|
||||
Calls assembly routine to flush cache.
|
||||
|
||||
Arguments:
|
||||
This - The DebugSupport instance
|
||||
ProcessorIndex - Which processor the callback applies to.
|
||||
Start - Physical base of the memory range to be invalidated
|
||||
Length - mininum number of bytes in instruction cache to invalidate
|
||||
|
||||
Returns:
|
||||
|
||||
EFI_SUCCESS - always return success
|
||||
|
||||
--*/
|
||||
{
|
||||
AsmWbinvd ();
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
Initializes driver's handler registration databas.
|
||||
|
||||
This code executes in boot services context
|
||||
Must be public because it's referenced from DebugSupport.c
|
||||
|
||||
@retval EFI_UNSUPPORTED If x64 processor does not support FXSTOR/FXRSTOR instructions,
|
||||
the context save will fail, so these processor's are not supported.
|
||||
@retval EFI_OUT_OF_RESOURCES Fails to allocate memory.
|
||||
@retval EFI_SUCCESS Initializes successfully.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
plInitializeDebugSupportDriver (
|
||||
PlInitializeDebugSupportDriver (
|
||||
VOID
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
Initializes driver's handler registration database.
|
||||
|
||||
This code executes in boot services context.
|
||||
|
||||
Arguments:
|
||||
None
|
||||
|
||||
Returns:
|
||||
EFI_SUCCESS
|
||||
EFI_UNSUPPORTED - if X64 processor does not support FXSTOR/FXRSTOR instructions,
|
||||
the context save will fail, so these processor's are not supported.
|
||||
EFI_OUT_OF_RESOURCES - not resource to finish initialization
|
||||
|
||||
--*/
|
||||
{
|
||||
EFI_EXCEPTION_TYPE ExceptionType;
|
||||
|
||||
@ -378,28 +333,21 @@ ErrorCleanup:
|
||||
return EFI_OUT_OF_RESOURCES;
|
||||
}
|
||||
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
plUnloadDebugSupportDriver (
|
||||
IN EFI_HANDLE ImageHandle
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description:
|
||||
/**
|
||||
This is the callback that is written to the LoadedImage protocol instance
|
||||
on the image handle. It uninstalls all registered handlers and frees all entry
|
||||
stub memory.
|
||||
|
||||
This code executes in boot services context.
|
||||
@param ImageHandle The firmware allocated handle for the EFI image.
|
||||
|
||||
Arguments:
|
||||
ImageHandle - The image handle of the unload handler
|
||||
@retval EFI_SUCCESS Always.
|
||||
|
||||
Returns:
|
||||
|
||||
EFI_SUCCESS - always return success
|
||||
|
||||
--*/
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
PlUnloadDebugSupportDriver (
|
||||
IN EFI_HANDLE ImageHandle
|
||||
)
|
||||
{
|
||||
EFI_EXCEPTION_TYPE ExceptionType;
|
||||
|
||||
@ -411,26 +359,20 @@ Returns:
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
Common piece of code that invokes the registered handlers.
|
||||
|
||||
This code executes in exception context so no efi calls are allowed.
|
||||
|
||||
@param ExceptionType Exception type
|
||||
@param ContextRecord System context
|
||||
|
||||
**/
|
||||
VOID
|
||||
InterruptDistrubutionHub (
|
||||
EFI_EXCEPTION_TYPE ExceptionType,
|
||||
EFI_SYSTEM_CONTEXT_IA32 *ContextRecord
|
||||
)
|
||||
/*++
|
||||
|
||||
Routine Description: Common piece of code that invokes the registered handlers.
|
||||
|
||||
This code executes in exception context so no efi calls are allowed.
|
||||
|
||||
Arguments:
|
||||
ExceptionType - exception type
|
||||
ContextRecord - system context
|
||||
|
||||
Returns:
|
||||
|
||||
None
|
||||
|
||||
--*/
|
||||
{
|
||||
if (IdtEntryTable[ExceptionType].RegisteredCallback != NULL) {
|
||||
if (ExceptionType != SYSTEM_TIMER_VECTOR) {
|
||||
|
Reference in New Issue
Block a user