diff options
| author | Dandan Bi <dandan.bi@intel.com> | 2016-12-05 11:33:52 +0800 |
|---|---|---|
| committer | Star Zeng <star.zeng@intel.com> | 2016-12-06 18:40:19 +0800 |
| commit | d138a2e987c51d8225ffaba5b523db82f75269cd (patch) | |
| tree | 4bcd4e64dad79d31409a442536f32ddb08816ea7 /MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h | |
| parent | 532daaed0d585e3c7142b2fb7ee955c599f4c812 (diff) | |
| download | edk2-platforms-d138a2e987c51d8225ffaba5b523db82f75269cd.tar.xz | |
MdeModulePkg/EbcDxe: Add comments for functions
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Pete Batard <pete@akeo.ie>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Jiewen.yao@intel.com
Diffstat (limited to 'MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h')
| -rw-r--r-- | MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h | 129 |
1 files changed, 120 insertions, 9 deletions
diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h b/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h index ad93fd787d..cf81b4ad44 100644 --- a/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h +++ b/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h @@ -38,96 +38,207 @@ EbcDebugSignalException ( IN VM_CONTEXT *VmPtr
);
-//
-// Hooks in EbcInt.c
-//
+/**
+
+ The hook in InitializeEbcDriver.
+
+ @param Handle - The EbcDebugProtocol handle.
+ @param EbcDebugProtocol - The EbcDebugProtocol interface.
+
+**/
VOID
EbcDebuggerHookInit (
IN EFI_HANDLE Handle,
IN EFI_DEBUG_SUPPORT_PROTOCOL *EbcDebugProtocol
);
+/**
+
+The hook in UnloadImage for EBC Interpreter.
+
+**/
VOID
EbcDebuggerHookUnload (
VOID
);
+/**
+
+ The hook in EbcUnloadImage.
+ Currently do nothing here.
+
+ @param Handle The EbcImage handle.
+
+**/
VOID
EbcDebuggerHookEbcUnloadImage (
IN EFI_HANDLE Handle
);
-//
-// Hooks in EbcSupport.c
-//
+
+/**
+
+ Hooks in EbcSupport.c
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookExecuteEbcImageEntryPoint (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteEbcImageEntryPoint.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookEbcInterpret (
IN VM_CONTEXT *VmPtr
);
-//
-// Hooks in EbcExecute.c
-//
+
+/**
+ The hook in EbcExecute, before ExecuteFunction.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookExecuteStart (
IN VM_CONTEXT *VmPtr
);
+/**
+ The hook in EbcExecute, after ExecuteFunction.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookExecuteEnd (
IN VM_CONTEXT *VmPtr
);
+/**
+ The hook in ExecuteCALL, before move IP.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookCALLStart (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteCALL, after move IP.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookCALLEnd (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteCALL, before call EbcLLCALLEX.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookCALLEXStart (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteCALL, after call EbcLLCALLEX.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookCALLEXEnd (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteRET, before move IP.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookRETStart (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteRET, after move IP.
+ It will record trace information.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookRETEnd (
IN VM_CONTEXT *VmPtr
);
+
+/**
+
+ The hook in ExecuteJMP, before move IP.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookJMPStart (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteJMP, after move IP.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookJMPEnd (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteJMP8, before move IP.
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookJMP8Start (
IN VM_CONTEXT *VmPtr
);
+/**
+
+ The hook in ExecuteJMP8, after move IP..
+
+ @param VmPtr - pointer to VM context.
+
+**/
VOID
EbcDebuggerHookJMP8End (
IN VM_CONTEXT *VmPtr
|