diff options
| author | Hao Wu <hao.a.wu@intel.com> | 2019-02-11 15:39:50 +0800 |
|---|---|---|
| committer | Hao Wu <hao.a.wu@intel.com> | 2019-02-22 08:20:08 +0800 |
| commit | b6de92f74eca0f36461a5b96117b1428772e2278 (patch) | |
| tree | 875385922fc191c7d41a45296634579bb51036ac /OvmfPkg | |
| parent | 99383667abe1c2f83cc660f98fe7f3aa23bb7aa8 (diff) | |
| download | edk2-b6de92f74eca0f36461a5b96117b1428772e2278.tar.gz edk2-b6de92f74eca0f36461a5b96117b1428772e2278.tar.bz2 edk2-b6de92f74eca0f36461a5b96117b1428772e2278.zip | |
OvmfPkg/LockBoxLib: Update the comments for API UpdateLockBox()
The previous commit:
MdeModulePkg/SmmLockBoxLib: Support LockBox enlarge in UpdateLockBox()
adds the support to enlarge a LockBox when using the LockBoxLib API
UpdateLockBox().
This commit is to sync the API description comment of UpdateLockBox() with
its counterparts in MdeModulePkg.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>
Diffstat (limited to 'OvmfPkg')
| -rw-r--r-- | OvmfPkg/Library/LockBoxLib/LockBoxLib.c | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxLib.c b/OvmfPkg/Library/LockBoxLib/LockBoxLib.c index 45481b9230..04233059f1 100644 --- a/OvmfPkg/Library/LockBoxLib/LockBoxLib.c +++ b/OvmfPkg/Library/LockBoxLib/LockBoxLib.c @@ -3,7 +3,7 @@ Library implementing the LockBox interface for OVMF
Copyright (C) 2013, Red Hat, Inc.
- Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available
under the terms and conditions of the BSD License which accompanies this
@@ -224,8 +224,13 @@ SetLockBoxAttributes ( @retval RETURN_INVALID_PARAMETER the Guid is NULL, or Buffer is NULL, or
Length is 0.
@retval RETURN_NOT_FOUND the requested GUID not found.
- @retval RETURN_BUFFER_TOO_SMALL the original buffer to too small to hold
- new information.
+ @retval RETURN_BUFFER_TOO_SMALL for lockbox without attribute
+ LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY, the
+ original buffer to too small to hold new
+ information.
+ @retval RETURN_OUT_OF_RESOURCES for lockbox with attribute
+ LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY, no
+ enough resource to save the information.
@retval RETURN_ACCESS_DENIED it is too late to invoke this interface
@retval RETURN_NOT_STARTED it is too early to invoke this interface
@retval RETURN_UNSUPPORTED the service is not supported by
|