From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mx.groups.io with SMTP id smtpd.web10.26097.1629950150118424816 for ; Wed, 25 Aug 2021 20:55:50 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.151, mailfrom: nathaniel.l.desimone@intel.com) X-IronPort-AV: E=McAfee;i="6200,9189,10087"; a="197897575" X-IronPort-AV: E=Sophos;i="5.84,352,1620716400"; d="scan'208";a="197897575" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 25 Aug 2021 20:55:49 -0700 X-IronPort-AV: E=Sophos;i="5.84,352,1620716400"; d="scan'208";a="494904496" Received: from nldesimo-desk1.amr.corp.intel.com ([10.209.35.181]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 25 Aug 2021 20:55:49 -0700 From: "Nate DeSimone" To: devel@edk2.groups.io Cc: Chasel Chiu , Michael Kubacki , Benjamin Doron Subject: [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value Date: Wed, 25 Aug 2021 20:55:46 -0700 Message-Id: <20210826035546.1771-1-nathaniel.l.desimone@intel.com> X-Mailer: git-send-email 2.27.0.windows.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Added EFI_INVALID_PARAMETER to the EcRead() function's list of return values. Cc: Chasel Chiu Cc: Michael Kubacki Cc: Benjamin Doron Signed-off-by: Nate DeSimone --- .../Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h | 9 +++++---- .../KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h b/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h index 7c58e592d9..e95accc465 100644 --- a/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h +++ b/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h @@ -7,7 +7,7 @@ Make sure you meet the requirements for the library (protocol dependencies, use restrictions, etc). -Copyright (c) 2019, Intel Corporation. All rights reserved.
+Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -109,9 +109,10 @@ LpcEcInterface ( @param[in] Address Address to read @param[out] Data Data received - @retval EFI_SUCCESS Command success - @retval EFI_DEVICE_ERROR Command error - @retval EFI_TIMEOUT Command timeout + @retval EFI_SUCCESS Command success + @retval EFI_INVALID_PARAMETER Data is NULL + @retval EFI_DEVICE_ERROR Command error + @retval EFI_TIMEOUT Command timeout **/ EFI_STATUS EcRead ( diff --git a/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c b/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c index d14edb75de..14a746172b 100644 --- a/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c +++ b/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c @@ -1,7 +1,7 @@ /** @file Common EC commands. -Copyright (c) 2019, Intel Corporation. All rights reserved.
+Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -16,9 +16,10 @@ SPDX-License-Identifier: BSD-2-Clause-Patent @param[in] Address Address to read @param[out] Data Data received - @retval EFI_SUCCESS Command success - @retval EFI_DEVICE_ERROR Command error - @retval EFI_TIMEOUT Command timeout + @retval EFI_SUCCESS Command success + @retval EFI_INVALID_PARAMETER Data is NULL + @retval EFI_DEVICE_ERROR Command error + @retval EFI_TIMEOUT Command timeout **/ EFI_STATUS EcRead ( -- 2.27.0.windows.1