SecurityPkg/Pkcs7Verify: Add the comments to address security problem

[mirror_edk2.git] / MdePkg / Include / Library / UefiRuntimeLib.h

diff --git a/MdePkg/Include/Library/UefiRuntimeLib.h b/MdePkg/Include/Library/UefiRuntimeLib.h
index 02be8ea5e4b28c5d446fd29cafc21bd77ba703cd..0bca416a4bebf974210cbf616658843f0a42d985 100644 (file)
--- a/MdePkg/Include/Library/UefiRuntimeLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeLib.h
@@ -2,11 +2,11 @@
   Provides library functions for each of the UEFI Runtime Services.\r
   Only available to DXE and UEFI module types.\r
 \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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\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
@@ -120,7 +120,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
@@ -329,9 +329,8 @@ EfiGetNextHighMonotonicCount (
                       Null-terminated Unicode string, optionally followed by additional binary data. The string is a\r
                       description that the caller may use to further indicate the reason for the system reset. ResetData\r
                       is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical\r
-                      address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string\r
-                      that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.\r
-\r
+                      address. For a ResetType of EfiResetPlatformSpecific the data buffer also starts with a Null-terminated\r
+                      string that is followed by an EFI_GUID that describes the specific type of reset to perform.\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -442,7 +441,7 @@ EfiSetVirtualAddressMap (
   @param  DebugDisposition   Supplies type information for the pointer being converted.\r
   @param  ListHead           Head of linked list to convert.\r
 \r
-  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  EFI_SUCCESS  Successfully executed the function.\r
   @retval  !EFI_SUCCESS Failed to execute the function.\r
 \r
 **/\r
@@ -478,9 +477,10 @@ EfiConvertList (
                                 CapsuleHeaderArray. This parameter is only referenced if\r
                                 the capsules are defined to persist across system reset.\r
 \r
-  @retval EFI_SUCCESS           Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r
+  @retval EFI_SUCCESS           A valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r
                                 the capsule has been successfully processed by the firmware.\r
-  @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.\r
+  @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were\r
+                                set in the capsule header.\r
   @retval EFI_INVALID_PARAMETER CapsuleCount is 0\r
   @retval EFI_DEVICE_ERROR      The capsule update was started, but failed due to a device error.\r
   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform.\r
@@ -523,7 +523,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
@@ -562,11 +562,11 @@ EfiQueryCapsuleCapabilities (
   @param  RemainingVariableStorageSize\r
                                 Returns the remaining size of the storage space\r
                                 available for the EFI variables associated with the\r
-                                attributes specified..\r
+                                attributes specified.\r
   @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