MdeModulePkg/EbcDxe: Add comments for functions

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

diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.c b/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.c
index 1594cecf1650831cacf219c1514a73e3dd84b229..c5a19342f6749375fe92522c6131f228480e89f7 100644 (file)
--- a/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.c
+++ b/MdeModulePkg/Universal/EbcDxe/EbcDebuggerHook.c
@@ -18,6 +18,14 @@
 \r
 #include "EbcDebuggerHook.h"\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
@@ -27,6 +35,11 @@ EbcDebuggerHookInit (
   return;\r
 }\r
 \r
+/**\r
+\r
+The hook in UnloadImage for EBC Interpreter.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookUnload (\r
   VOID\r
@@ -35,6 +48,14 @@ EbcDebuggerHookUnload (
   return;\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
@@ -43,6 +64,13 @@ EbcDebuggerHookEbcUnloadImage (
   return;\r
 }\r
 \r
+/**\r
+\r
+  The hook in ExecuteEbcImageEntryPoint.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookExecuteEbcImageEntryPoint (\r
   IN VM_CONTEXT *VmPtr\r
@@ -51,6 +79,13 @@ EbcDebuggerHookExecuteEbcImageEntryPoint (
   return;\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
@@ -59,6 +94,12 @@ EbcDebuggerHookEbcInterpret (
   return;\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
@@ -67,6 +108,12 @@ EbcDebuggerHookExecuteStart (
   return;\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
@@ -75,6 +122,13 @@ EbcDebuggerHookExecuteEnd (
   return;\r
 }\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
@@ -83,6 +137,13 @@ EbcDebuggerHookCALLStart (
   return;\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
@@ -91,6 +152,13 @@ EbcDebuggerHookCALLEnd (
   return;\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
@@ -99,6 +167,13 @@ EbcDebuggerHookCALLEXStart (
   return;\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
@@ -107,6 +182,13 @@ EbcDebuggerHookCALLEXEnd (
   return;\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
@@ -115,6 +197,13 @@ EbcDebuggerHookRETStart (
   return;\r
 }\r
 \r
+/**\r
+\r
+  The hook in ExecuteRET, after move IP.\r
+\r
+  @param  VmPtr - pointer to VM context.\r
+\r
+**/\r
 VOID\r
 EbcDebuggerHookRETEnd (\r
   IN VM_CONTEXT *VmPtr\r
@@ -123,6 +212,13 @@ EbcDebuggerHookRETEnd (
   return;\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
@@ -131,6 +227,13 @@ EbcDebuggerHookJMPStart (
   return;\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
@@ -139,6 +242,13 @@ EbcDebuggerHookJMPEnd (
   return;\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
@@ -147,6 +257,13 @@ EbcDebuggerHookJMP8Start (
   return;\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