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 3443ac63ab4f57d80c94f547b9edcd462f7516b4..d03fcd3be443dd13c77da838a667cc99083bfa30 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/SmmBaseHelper/SmmBaseHelper.c
+++ b/EdkCompatibilityPkg/Compatibility/SmmBaseHelper/SmmBaseHelper.c
@@ -304,8 +304,8 @@ Error:
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.Register().\r
 \r
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.Register().\r
 \r

-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
-*/\r
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
+**/\r

 VOID\r
 Register (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r
 VOID\r
 Register (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r


@@ -329,8 +329,8 @@ Register (
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.UnRegister().\r
 \r
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.UnRegister().\r
 \r

-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
-*/\r
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
+**/\r

 VOID\r
 UnRegister (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r
 VOID\r
 UnRegister (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r


@@ -347,7 +347,7 @@ UnRegister (
 \r
   @param[in] DispatchHandle  The unique handle assigned by SmiHandlerRegister().  \r
 \r
 \r
   @param[in] DispatchHandle  The unique handle assigned by SmiHandlerRegister().  \r
 \r

-  @return  Pointer to CALLBACK_INFO.\r
+  @return  Pointer to CALLBACK_INFO. If NULL, no callback info record is found.\r

 **/\r
 CALLBACK_INFO *\r
 GetCallbackInfo (\r
 **/\r
 CALLBACK_INFO *\r
 GetCallbackInfo (\r


@@ -492,8 +492,8 @@ CallbackThunk (
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.RegisterCallback().\r
 \r
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.RegisterCallback().\r
 \r

-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
-*/\r
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
+**/\r

 VOID\r
 RegisterCallback (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r
 VOID\r
 RegisterCallback (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r


@@ -545,8 +545,8 @@ RegisterCallback (
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.SmmAllocatePool().\r
 \r
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.SmmAllocatePool().\r
 \r

-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
-*/\r
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
+**/\r

 VOID\r
 HelperAllocatePool (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r
 VOID\r
 HelperAllocatePool (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r


@@ -562,8 +562,8 @@ HelperAllocatePool (
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.SmmFreePool().\r
 \r
 /** \r
   Thunk service of EFI_SMM_BASE_PROTOCOL.SmmFreePool().\r
 \r

-  @param[in] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
-*/\r
+  @param[in, out] FunctionData  Pointer to SMMBASE_FUNCTION_DATA.\r
+**/\r

 VOID\r
 HelperFreePool (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r
 VOID\r
 HelperFreePool (\r
   IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r


@@ -653,7 +653,7 @@ SmmBaseHelperMain (
   EFI_HANDLE  Handle = NULL;\r
 \r
   ///\r
   EFI_HANDLE  Handle = NULL;\r
 \r
   ///\r

-  /// Locate SMM CPU Protocol which is used later to update CPU Save States\r
+  /// Locate SMM CPU Protocol which is used later to retrieve/update CPU Save States\r

   ///\r
   Status = gSmst->SmmLocateProtocol (&gEfiSmmCpuProtocolGuid, NULL, (VOID **) &mSmmCpu);\r
   ASSERT_EFI_ERROR (Status);\r
   ///\r
   Status = gSmst->SmmLocateProtocol (&gEfiSmmCpuProtocolGuid, NULL, (VOID **) &mSmmCpu);\r
   ASSERT_EFI_ERROR (Status);\r

diff --git a/EdkCompatibilityPkg/Compatibility/SmmBaseOnSmmBase2Thunk/SmmBaseOnSmmBase2Thunk.c b/EdkCompatibilityPkg/Compatibility/SmmBaseOnSmmBase2Thunk/SmmBaseOnSmmBase2Thunk.c
index fe6024af529aff26e4cfe3b475356f0017396342..e7f13d41d8eba8a08ff80d00ca038907a15b70f8 100644 (file)
--- 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;\r
 EFI_SMM_BASE_HELPER_READY_PROTOCOL *mSmmBaseHelperReady = NULL;\r
 \r
 EFI_SMM_COMMUNICATION_PROTOCOL     *mSmmCommunication = NULL;\r
 EFI_SMM_BASE_HELPER_READY_PROTOCOL *mSmmBaseHelperReady = NULL;\r
 \r

+/**\r
+  Determine if in SMM mode.\r
+\r
+  @retval TRUE   In SMM mode.\r
+  @retval FALSE  Not in SMM mode.\r
+**/\r

 BOOLEAN\r
 IsInSmm (\r
   VOID\r
 BOOLEAN\r
 IsInSmm (\r
   VOID\r