Update minor comments for Smbus, PcdLib, PeiServicesLib library instance. And change...

[mirror_edk2.git] / MdePkg / Library / UefiRuntimeLib / RuntimeLib.c

diff --git a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
index 39be3cb0cfe53000851d5a18bd002c1b46f48637..818cd66e4a82574fef23274b254bb46f1b7ce18a 100644 (file)
--- a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
+++ b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
@@ -1,7 +1,7 @@
-/**@file\r
-  Library utility functions for Runtime driver.\r
+/** @file\r
+  UEFI Runtime Library implementation for non IPF processor types.\r
 \r
-Copyright (c) 2006 Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -12,25 +12,24 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#include <RuntimeLibInternal.h>\r
+#include "RuntimeLibInternal.h"\r
 \r
 ///\r
 /// Driver Lib Module Globals\r
 ///\r
 \r
-STATIC EFI_EVENT              mEfiVirtualNotifyEvent;\r
-STATIC EFI_EVENT              mEfiExitBootServicesEvent;\r
-STATIC BOOLEAN                mEfiGoneVirtual         = FALSE;\r
-STATIC BOOLEAN                mEfiAtRuntime           = FALSE;\r
+EFI_EVENT              mEfiVirtualNotifyEvent;\r
+EFI_EVENT              mEfiExitBootServicesEvent;\r
+BOOLEAN                mEfiGoneVirtual         = FALSE;\r
+BOOLEAN                mEfiAtRuntime           = FALSE;\r
 EFI_RUNTIME_SERVICES          *mRT;\r
 \r
 /**\r
-  Set AtRuntime flag as TRUE after ExitBootServices\r
+  Set AtRuntime flag as TRUE after ExitBootServices.\r
 \r
   @param[in]  Event   The Event that is being processed\r
   @param[in]  Context Event Context\r
 **/\r
-STATIC\r
 VOID\r
 EFIAPI\r
 RuntimeLibExitBootServicesEvent (\r
@@ -54,7 +53,6 @@ RuntimeLibExitBootServicesEvent (
   @param[in]    Event   The Event that is being processed\r
   @param[in]    Context Event Context\r
 **/\r
-STATIC\r
 VOID\r
 EFIAPI\r
 RuntimeLibVirtualNotifyEvent (\r
@@ -72,6 +70,8 @@ RuntimeLibVirtualNotifyEvent (
 \r
 /**\r
   Intialize runtime Driver Lib if it has not yet been initialized.\r
+  It will ASSERT() if gRT is NULL or gBS is NULL.\r
+  It will ASSERT() if that operation fails.\r
 \r
   @param[in]  ImageHandle   The firmware allocated handle for the EFI image.\r
   @param[in]  SystemTable   A pointer to the EFI System Table.\r
@@ -87,13 +87,13 @@ RuntimeDriverLibConstruct (
 {\r
   EFI_STATUS  Status;\r
 \r
+  ASSERT (gRT != NULL);\r
+  ASSERT (gBS != NULL);\r
+\r
   mRT = gRT;\r
-  ASSERT (mRT != NULL);\r
-  \r
   //\r
   // Register SetVirtualAddressMap () notify function\r
   //\r
-  ASSERT (gBS != NULL);\r
   Status = gBS->CreateEvent (\r
                   EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r
                   TPL_NOTIFY,\r
@@ -118,9 +118,13 @@ RuntimeDriverLibConstruct (
 }\r
 \r
 /**\r
-  This routine will free some resources which have been allocated in\r
-  EfiInitializeRuntimeDriverLib(). If a runtime driver exits with an error,\r
-  it must call this routine to free the allocated resource before the exiting.\r
+  If a runtime driver exits with an error, it must call this routine \r
+  to free the allocated resource before the exiting.\r
+  It will ASSERT() if gBS is NULL.\r
+  It will ASSERT() if that operation fails.\r
+\r
+  @param[in]  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param[in]  SystemTable   A pointer to the EFI System Table.\r
 \r
   @retval     EFI_SUCCESS       Shutdown the Runtime Driver Lib successfully\r
   @retval     EFI_UNSUPPORTED   Runtime Driver lib was not initialized at all\r
@@ -148,7 +152,7 @@ RuntimeDriverLibDeconstruct (
 }\r
 \r
 /**\r
-  Return TRUE if ExitBootServices () has been called\r
+  Return TRUE if ExitBootServices () has been called.\r
 \r
   @retval TRUE If ExitBootServices () has been called\r
 **/\r
@@ -162,7 +166,7 @@ EfiAtRuntime (
 }\r
 \r
 /**\r
-  Return TRUE if SetVirtualAddressMap () has been called\r
+  Return TRUE if SetVirtualAddressMap () has been called.\r
 \r
   @retval TRUE  If SetVirtualAddressMap () has been called\r
 **/\r