OvmfPkg/LockBoxLib: Update the comments for API UpdateLockBox()

[mirror_edk2.git] / OvmfPkg / Library / LockBoxLib / LockBoxLib.c

diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxLib.c b/OvmfPkg/Library/LockBoxLib/LockBoxLib.c
index 45481b9230d2c16de4dfdf616b949b6f368e4dbd..04233059f18b485a02e0a06b1962d2e84e89889e 100644 (file)
--- a/OvmfPkg/Library/LockBoxLib/LockBoxLib.c
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxLib.c
@@ -3,7 +3,7 @@
   Library implementing the LockBox interface for OVMF\r
 \r
   Copyright (C) 2013, Red Hat, Inc.\r
-  Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>\r
 \r
   This program and the accompanying materials are licensed and made available\r
   under the terms and conditions of the BSD License which accompanies this\r
@@ -224,8 +224,13 @@ SetLockBoxAttributes (
   @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or\r
                                     Length is 0.\r
   @retval RETURN_NOT_FOUND          the requested GUID not found.\r
-  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold\r
-                                    new information.\r
+  @retval RETURN_BUFFER_TOO_SMALL   for lockbox without attribute\r
+                                    LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY, the\r
+                                    original buffer to too small to hold new\r
+                                    information.\r
+  @retval RETURN_OUT_OF_RESOURCES   for lockbox with attribute\r
+                                    LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY, no\r
+                                    enough resource to save the information.\r
   @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface\r
   @retval RETURN_NOT_STARTED        it is too early to invoke this interface\r
   @retval RETURN_UNSUPPORTED        the service is not supported by\r