From: rsun3 <rsun3@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Thu, 7 Jan 2010 13:43:40 +0000 (+0000)
Subject: Coding style fix.
X-Git-Tag: edk2-stable201903~16635
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=17d2c9a3af2febc5ff4e22715014f63a5a77d9dc

Coding style fix.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9689 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/EdkCompatibilityPkg/Compatibility/SmmBaseHelper/SmmBaseHelper.c b/EdkCompatibilityPkg/Compatibility/SmmBaseHelper/SmmBaseHelper.c
index 3443ac63ab..d03fcd3be4 100644
--- a/EdkCompatibilityPkg/Compatibility/SmmBaseHelper/SmmBaseHelper.c
+++ b/EdkCompatibilityPkg/Compatibility/SmmBaseHelper/SmmBaseHelper.c
@@ -304,8 +304,8 @@ Error:
 /** 
   Thunk service of EFI_SMM_BASE_PROTOCOL.Register().
 
-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
-*/
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
+**/
 VOID
 Register (
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData
@@ -329,8 +329,8 @@ Register (
 /** 
   Thunk service of EFI_SMM_BASE_PROTOCOL.UnRegister().
 
-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
-*/
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
+**/
 VOID
 UnRegister (
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData
@@ -347,7 +347,7 @@ UnRegister (
 
   @param[in] DispatchHandle  The unique handle assigned by SmiHandlerRegister().  
 
-  @return  Pointer to CALLBACK_INFO.
+  @return  Pointer to CALLBACK_INFO. If NULL, no callback info record is found.
 **/
 CALLBACK_INFO *
 GetCallbackInfo (
@@ -492,8 +492,8 @@ CallbackThunk (
 /** 
   Thunk service of EFI_SMM_BASE_PROTOCOL.RegisterCallback().
 
-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
-*/
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
+**/
 VOID
 RegisterCallback (
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData
@@ -545,8 +545,8 @@ RegisterCallback (
 /** 
   Thunk service of EFI_SMM_BASE_PROTOCOL.SmmAllocatePool().
 
-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
-*/
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
+**/
 VOID
 HelperAllocatePool (
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData
@@ -562,8 +562,8 @@ HelperAllocatePool (
 /** 
   Thunk service of EFI_SMM_BASE_PROTOCOL.SmmFreePool().
 
-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
-*/
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.
+**/
 VOID
 HelperFreePool (
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData
@@ -653,7 +653,7 @@ SmmBaseHelperMain (
   EFI_HANDLE  Handle = NULL;
 
   ///
-  /// Locate SMM CPU Protocol which is used later to update CPU Save States
+  /// Locate SMM CPU Protocol which is used later to retrieve/update CPU Save States
   ///
   Status = gSmst->SmmLocateProtocol (&gEfiSmmCpuProtocolGuid, NULL, (VOID **) &mSmmCpu);
   ASSERT_EFI_ERROR (Status);
diff --git a/EdkCompatibilityPkg/Compatibility/SmmBaseOnSmmBase2Thunk/SmmBaseOnSmmBase2Thunk.c b/EdkCompatibilityPkg/Compatibility/SmmBaseOnSmmBase2Thunk/SmmBaseOnSmmBase2Thunk.c
index fe6024af52..e7f13d41d8 100644
--- a/EdkCompatibilityPkg/Compatibility/SmmBaseOnSmmBase2Thunk/SmmBaseOnSmmBase2Thunk.c
+++ b/EdkCompatibilityPkg/Compatibility/SmmBaseOnSmmBase2Thunk/SmmBaseOnSmmBase2Thunk.c
@@ -42,6 +42,12 @@ EFI_SMM_BASE2_PROTOCOL             *mSmmBase2 = NULL;
 EFI_SMM_COMMUNICATION_PROTOCOL     *mSmmCommunication = NULL;
 EFI_SMM_BASE_HELPER_READY_PROTOCOL *mSmmBaseHelperReady = NULL;
 
+/**
+  Determine if in SMM mode.
+
+  @retval TRUE   In SMM mode.
+  @retval FALSE  Not in SMM mode.
+**/
 BOOLEAN
 IsInSmm (
   VOID