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>
This commit is contained in:
Hao Wu 2019-02-11 15:39:50 +08:00
parent 99383667ab
commit b6de92f74e
1 changed files with 8 additions and 3 deletions

View File

@ -3,7 +3,7 @@
Library implementing the LockBox interface for OVMF Library implementing the LockBox interface for OVMF
Copyright (C) 2013, Red Hat, Inc. 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 This program and the accompanying materials are licensed and made available
under the terms and conditions of the BSD License which accompanies this 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 @retval RETURN_INVALID_PARAMETER the Guid is NULL, or Buffer is NULL, or
Length is 0. Length is 0.
@retval RETURN_NOT_FOUND the requested GUID not found. @retval RETURN_NOT_FOUND the requested GUID not found.
@retval RETURN_BUFFER_TOO_SMALL the original buffer to too small to hold @retval RETURN_BUFFER_TOO_SMALL for lockbox without attribute
new information. 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_ACCESS_DENIED it is too late to invoke this interface
@retval RETURN_NOT_STARTED it is too early 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 @retval RETURN_UNSUPPORTED the service is not supported by