1. Merger generic functions into one file.
2. Use the basic definitions in BaseLib.h, instead of local definitions git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6986 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff
308
MdeModulePkg/Universal/DebugSupportDxe/Ia32/DebugSupport.h
Normal file
308
MdeModulePkg/Universal/DebugSupportDxe/Ia32/DebugSupport.h
Normal file
@@ -0,0 +1,308 @@
|
||||
/** @file
|
||||
Generic debug support macros, typedefs and prototypes for IA32/x64.
|
||||
|
||||
Copyright (c) 2006 - 2008, Intel Corporation
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
#ifndef _DEBUG_SUPPORT_H_
|
||||
#define _DEBUG_SUPPORT_H_
|
||||
|
||||
|
||||
#include <Uefi.h>
|
||||
|
||||
#include <Protocol/DebugSupport.h>
|
||||
#include <Protocol/LoadedImage.h>
|
||||
|
||||
#include <Library/DebugLib.h>
|
||||
#include <Library/UefiDriverEntryPoint.h>
|
||||
#include <Library/BaseMemoryLib.h>
|
||||
#include <Library/MemoryAllocationLib.h>
|
||||
#include <Library/UefiBootServicesTableLib.h>
|
||||
#include <Library/BaseLib.h>
|
||||
#include <Library/PcdLib.h>
|
||||
|
||||
#define NUM_IDT_ENTRIES 0x78
|
||||
#define SYSTEM_TIMER_VECTOR 0x68
|
||||
#define VECTOR_ENTRY_PAGES 1
|
||||
|
||||
#define FF_FXSR (1 << 24)
|
||||
|
||||
typedef
|
||||
VOID
|
||||
(*DEBUG_PROC) (
|
||||
VOID
|
||||
);
|
||||
|
||||
typedef struct {
|
||||
IA32_IDT_GATE_DESCRIPTOR OrigDesc;
|
||||
DEBUG_PROC OrigVector;
|
||||
IA32_IDT_GATE_DESCRIPTOR NewDesc;
|
||||
DEBUG_PROC StubEntry;
|
||||
VOID (*RegisteredCallback) ();
|
||||
} IDT_ENTRY;
|
||||
|
||||
extern EFI_SYSTEM_CONTEXT SystemContext;
|
||||
extern UINT8 InterruptEntryStub[];
|
||||
extern UINT32 StubSize;
|
||||
extern VOID (*OrigVector) (VOID);
|
||||
extern IDT_ENTRY *IdtEntryTable;
|
||||
extern IA32_IDT_GATE_DESCRIPTOR NullDesc;
|
||||
|
||||
/**
|
||||
Generic IDT entry.
|
||||
|
||||
**/
|
||||
VOID
|
||||
CommonIdtEntry (
|
||||
VOID
|
||||
);
|
||||
|
||||
/**
|
||||
Check whether FXSTOR is supported
|
||||
|
||||
@retval TRUE FXSTOR is supported.
|
||||
@retval FALSE FXSTOR is not supported.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
FxStorSupport (
|
||||
VOID
|
||||
);
|
||||
|
||||
/**
|
||||
Encodes an IDT descriptor with the given physical address.
|
||||
|
||||
@param DestDesc The IDT descriptor address.
|
||||
@param Vecotr The interrupt vector entry.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Vect2Desc (
|
||||
IA32_IDT_GATE_DESCRIPTOR * DestDesc,
|
||||
VOID (*Vector) (VOID)
|
||||
);
|
||||
|
||||
/**
|
||||
Programs interrupt flag to the requested state and returns previous
|
||||
state.
|
||||
|
||||
@param NewState New interrupt status.
|
||||
|
||||
@retval TRUE Old interrupt status is TRUE.
|
||||
@retval FALSE Old interrupt status is FALSE
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
WriteInterruptFlag (
|
||||
BOOLEAN NewState
|
||||
);
|
||||
|
||||
/**
|
||||
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 IA32 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 (
|
||||
VOID
|
||||
);
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
@param ImageHandle The firmware allocated handle for the EFI image.
|
||||
|
||||
@retval EFI_SUCCESS Always.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
PlUnloadDebugSupportDriver (
|
||||
IN EFI_HANDLE ImageHandle
|
||||
);
|
||||
|
||||
/**
|
||||
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
|
||||
);
|
||||
|
||||
/**
|
||||
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 (
|
||||
IN EFI_DEBUG_SUPPORT_PROTOCOL *This,
|
||||
IN UINTN ProcessorIndex,
|
||||
IN EFI_PERIODIC_CALLBACK PeriodicCallback
|
||||
);
|
||||
|
||||
/**
|
||||
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 (
|
||||
IN EFI_DEBUG_SUPPORT_PROTOCOL *This,
|
||||
IN UINTN ProcessorIndex,
|
||||
IN EFI_EXCEPTION_CALLBACK NewCallback,
|
||||
IN EFI_EXCEPTION_TYPE 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 (
|
||||
IN EFI_DEBUG_SUPPORT_PROTOCOL *This,
|
||||
IN UINTN ProcessorIndex,
|
||||
IN VOID *Start,
|
||||
IN UINT64 Length
|
||||
);
|
||||
|
||||
/**
|
||||
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
|
||||
);
|
||||
|
||||
/**
|
||||
Get Procedure Entry Point from IDT Gate Descriptor.
|
||||
|
||||
@param IdtGateDecriptor IDT Gate Descriptor.
|
||||
|
||||
@return Procedure Entry Point located in IDT Gate Descriptor.
|
||||
|
||||
**/
|
||||
UINTN GetProcedureEntryPoint (
|
||||
IN IA32_IDT_GATE_DESCRIPTOR *IdtGateDecriptor
|
||||
);
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
@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.
|
||||
|
||||
@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.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
ManageIdtEntryTable (
|
||||
VOID (*NewCallback)(),
|
||||
EFI_EXCEPTION_TYPE ExceptionType
|
||||
);
|
||||
|
||||
/**
|
||||
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.
|
||||
|
||||
This code executes in boot services context. The stub entry executes in interrupt
|
||||
context.
|
||||
|
||||
@param ExceptionType Specifies which vector to hook.
|
||||
@param NewCallback A pointer to the new function to be registered.
|
||||
|
||||
@retval EFI_SUCCESS Always.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
HookEntry (
|
||||
IN EFI_EXCEPTION_TYPE ExceptionType,
|
||||
IN VOID (*NewCallback) ()
|
||||
);
|
||||
|
||||
/**
|
||||
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
|
||||
);
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user