From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.43; helo=mga05.intel.com; envelope-from=hao.a.wu@intel.com; receiver=edk2-devel@lists.01.org Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 8C8D0211CCD59 for ; Wed, 20 Feb 2019 16:25:01 -0800 (PST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 20 Feb 2019 16:25:01 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,392,1544515200"; d="scan'208";a="140297305" Received: from shwdeopenpsi014.ccr.corp.intel.com ([10.239.9.8]) by orsmga001.jf.intel.com with ESMTP; 20 Feb 2019 16:25:00 -0800 From: Hao Wu To: edk2-devel@lists.01.org Cc: Hao Wu Date: Thu, 21 Feb 2019 08:24:39 +0800 Message-Id: <20190221002440.2272-13-hao.a.wu@intel.com> X-Mailer: git-send-email 2.12.0.windows.1 In-Reply-To: <20190221002440.2272-1-hao.a.wu@intel.com> References: <20190221002440.2272-1-hao.a.wu@intel.com> Subject: [PATCH v6 12/13] OvmfPkg/LockBoxLib: Update the comments for API UpdateLockBox() X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 21 Feb 2019 00:25:01 -0000 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 Reviewed-by: Laszlo Ersek Reviewed-by: Ray Ni --- OvmfPkg/Library/LockBoxLib/LockBoxLib.c | 11 ++++++++--- 1 file 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.
+ Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.
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 -- 2.12.0.windows.1