MdeModulePkg: Remove redundant library classes and GUIDs

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebuggerHook.h

diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h b/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h
index ad93fd787d5605f10d57a76ba2d8d3bc66da9b25..cf81b4ad44ac9b7270f3f2833560d87f349f08bd 100644 (file)
--- a/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h
+++ b/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.h
@@ -38,96 +38,207 @@ EbcDebugSignalException (
   IN VM_CONTEXT                           *VmPtr\r
   );\r
 \r
-//\r
-// Hooks in EbcInt.c\r
-//\r
+/**\r
+\r
+  The hook in InitializeEbcDriver.\r
+\r
+  @param Handle           - The EbcDebugProtocol handle.\r
+  @param EbcDebugProtocol - The EbcDebugProtocol interface.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookInit (\r
   IN EFI_HANDLE                  Handle,\r
   IN EFI_DEBUG_SUPPORT_PROTOCOL  *EbcDebugProtocol\r
   );\r
 \r
+/**\r
+\r
+The hook in UnloadImage for EBC Interpreter.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookUnload (\r
   VOID\r
   );\r
 \r
+/**\r
+\r
+  The hook in EbcUnloadImage.\r
+  Currently do nothing here.\r
+\r
+  @param  Handle          The EbcImage handle.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookEbcUnloadImage (\r
   IN EFI_HANDLE                  Handle\r
   );\r
 \r
-//\r
-// Hooks in EbcSupport.c\r
-//\r
+\r
+/**\r
+\r
+  Hooks in EbcSupport.c\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookExecuteEbcImageEntryPoint (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteEbcImageEntryPoint.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookEbcInterpret (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
-//\r
-// Hooks in EbcExecute.c\r
-//\r
+\r
+/**\r
+  The hook in EbcExecute, before ExecuteFunction.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookExecuteStart (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+  The hook in EbcExecute, after ExecuteFunction.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookExecuteEnd (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+  The hook in ExecuteCALL, before move IP.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookCALLStart (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteCALL, after move IP.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookCALLEnd (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteCALL, before call EbcLLCALLEX.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookCALLEXStart (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteCALL, after call EbcLLCALLEX.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookCALLEXEnd (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteRET, before move IP.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookRETStart (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteRET, after move IP.\r
+  It will record trace information.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookRETEnd (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+\r
+/**\r
+\r
+  The hook in ExecuteJMP, before move IP.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookJMPStart (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteJMP, after move IP.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookJMPEnd (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteJMP8, before move IP.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookJMP8Start (\r
   IN VM_CONTEXT *VmPtr\r
   );\r
 \r
+/**\r
+\r
+  The hook in ExecuteJMP8, after move IP..\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookJMP8End (\r
   IN VM_CONTEXT *VmPtr\r