ArmVirtPkg/ArmVirtQemu: hook NvVarStoreFormattedLib into VariableRuntimeDxe

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

diff --git a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
index 4ab1a90b338b65d4f76e0cae4cbbb9c8b7798c0d..ba8b8621fb811103980c186318084178a63e60d4 100644 (file)
--- a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
+++ b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
@@ -6,11 +6,11 @@
   OS virtual address space. All pointer values are different for a virtual \r
   mapping than from the normal physical mapping at boot services time.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
 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
-http://opensource.org/licenses/bsd-license.php\r
+http://opensource.org/licenses/bsd-license.php.\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
@@ -36,8 +36,8 @@ EFI_RUNTIME_SERVICES   *mInternalRT;
 /**\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
+  @param[in]  Event   The Event that is being processed.\r
+  @param[in]  Context The Event Context.\r
 \r
 **/\r
 VOID\r
@@ -55,8 +55,8 @@ RuntimeLibExitBootServicesEvent (
   Call the passed in Child Notify event and convert any pointers in\r
   lib to virtual mode.\r
 \r
-  @param[in]    Event   The Event that is being processed\r
-  @param[in]    Context Event Context\r
+  @param[in]    Event   The Event that is being processed.\r
+  @param[in]    Context The Event Context.\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -133,8 +133,8 @@ RuntimeDriverLibConstruct (
   @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
+  @retval     EFI_SUCCESS       The Runtime Driver Lib shutdown successfully.\r
+  @retval     EFI_UNSUPPORTED   Runtime Driver lib was not initialized.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -320,7 +320,7 @@ EfiSetTime (
   @param  Time     The current alarm setting. Type EFI_TIME is defined in the GetTime()\r
                    function description.\r
 \r
-  @retval  EFI_SUCCESS           The alarm settings were returned.\r
+  @retval  EFI_SUCCESS            The alarm settings were returned.\r
   @retval  EFI_INVALID_PARAMETER  Enabled is NULL.\r
   @retval  EFI_INVALID_PARAMETER  Pending is NULL.\r
   @retval  EFI_INVALID_PARAMETER  Time is NULL.\r
@@ -466,13 +466,13 @@ EfiGetNextVariableName (
   Variables are stored by the firmware and may maintain their values across power cycles. Each vendor\r
   may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.\r
 \r
-  @param  VariableName the name of the vendor's variable, it's a\r
-                       Null-Terminated Unicode String\r
+  @param  VariableName The name of the vendor's variable; it's a Null-Terminated \r
+                       Unicode String\r
   @param  VendorGuid   Unify identifier for vendor.\r
-  @param  Attributes   Point to memory location to return the attributes of variable. If the point\r
+  @param  Attributes   Points to a memory location to return the attributes of variable. If the point\r
                        is NULL, the parameter would be ignored.\r
   @param  DataSize     The size in bytes of Data-Buffer.\r
-  @param  Data         Point to the content of the variable.\r
+  @param  Data         Points to the content of the variable.\r
 \r
   @retval  EFI_SUCCESS            The firmware has successfully stored the variable and its data as\r
                                   defined by the Attributes.\r
@@ -483,7 +483,7 @@ EfiGetNextVariableName (
   @retval  EFI_DEVICE_ERROR       The variable could not be saved due to a hardware failure.\r
   @retval  EFI_WRITE_PROTECTED    The variable in question is read-only.\r
   @retval  EFI_WRITE_PROTECTED    The variable in question cannot be deleted.\r
-  @retval  EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r
+  @retval  EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\r
                                   set but the AuthInfo does NOT pass the validation check carried\r
                                   out by the firmware.\r
   @retval  EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.\r
@@ -766,7 +766,7 @@ EfiUpdateCapsule (
                                 Undefined on input.\r
   @param  ResetType             Returns the type of reset required for the capsule update.\r
 \r
-  @retval EFI_SUCCESS           Valid answer returned.\r
+  @retval EFI_SUCCESS           A valid answer was returned.\r
   @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r
   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform, and\r
                                 MaximumCapsuleSize and ResetType are undefined.\r
@@ -817,7 +817,7 @@ EfiQueryCapsuleCapabilities (
   @param  MaximumVariableSize   Returns the maximum size of the individual EFI\r
                                 variables associated with the attributes specified.\r
 \r
-  @retval EFI_SUCCESS           Valid answer returned.\r
+  @retval EFI_SUCCESS           A valid answer was returned.\r
   @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r
   @retval EFI_UNSUPPORTED       EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r
                                 MaximumVariableStorageSize,\r