From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by mx.groups.io with SMTP id smtpd.web12.1375.1630456491871937882 for ; Tue, 31 Aug 2021 17:34:52 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@intel.onmicrosoft.com header.s=selector2-intel-onmicrosoft-com header.b=Ak4X0K5m; spf=pass (domain: intel.com, ip: 192.55.52.136, mailfrom: chasel.chiu@intel.com) X-IronPort-AV: E=McAfee;i="6200,9189,10093"; a="198156252" X-IronPort-AV: E=Sophos;i="5.84,367,1620716400"; d="scan'208";a="198156252" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 31 Aug 2021 17:34:50 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.84,367,1620716400"; d="scan'208";a="541269322" Received: from orsmsx604.amr.corp.intel.com ([10.22.229.17]) by fmsmga002.fm.intel.com with ESMTP; 31 Aug 2021 17:34:50 -0700 Received: from orsmsx607.amr.corp.intel.com (10.22.229.20) by ORSMSX604.amr.corp.intel.com (10.22.229.17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.10; Tue, 31 Aug 2021 17:34:49 -0700 Received: from orsmsx602.amr.corp.intel.com (10.22.229.15) by ORSMSX607.amr.corp.intel.com (10.22.229.20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.10; Tue, 31 Aug 2021 17:34:49 -0700 Received: from ORSEDG602.ED.cps.intel.com (10.7.248.7) by orsmsx602.amr.corp.intel.com (10.22.229.15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.12 via Frontend Transport; Tue, 31 Aug 2021 17:34:49 -0700 Received: from NAM12-DM6-obe.outbound.protection.outlook.com (104.47.59.177) by edgegateway.intel.com (134.134.137.103) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2242.10; Tue, 31 Aug 2021 17:34:49 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=hDq+zmKlO+9CznDKWy005XT/41I2HJYkSCYItk0aQfdzTWJEl0QGeJmzF0n1TM6/524SwPi8NrvwNQUL1s8vKZSPFBKT8+yf+/YQE11fsJwsCY2RFDXu10K8/nL1DDpa0br5e0x6QOqIJWJNQaWnEYhls9Iijl8Be70E9wTOUiD5sLn8MAcPzkMDOxDXOd/Oal5TmjvDS5piiuynfY3IbxodSYtg3iqSMqeMNbHXtqbqLEaqHDKaDvsPbNIo5CnvWscA99mVN3kyIuuaDLlGlaY1olguHzT6On3KuwJZsHbXCtLOZkh6zkHlb/BpGYUW9vMBlbnehuUlgCq6Np1VGQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=k+04PyJ6eJf18VKMYGPfQLb4xGVT1mZRfE3QrlgEldw=; b=CchTKHNoAKee2QKBl/N2Dp6cyBJkdO42jjPEODGL9dHpKyNIV+dVHuaXtBc234+eGH4ABQeYUYsYDB82UZHk68zmmClAUB4XNmRbhSBIo59qPpHd1x0oSooHjHZ7hoJV08/AKfSsHwLt42JLhgIy727NHdqDHY7p/i1ZVB9pEyJY5iv1WyaIuVGNqcKj9zxks5P3m72/ph46S7EkTMI+t9/lKfqcqtSivgV3NnUCbTCMU1JDTUWx4ZGV+mZHNdYtt/frPrMtBHtBFT0AmgCm3qGzRBeV206fBU3Vy4zNaEYa42i9txmQuWPogYVO8XYnxHTUOZxeAb3rk2xivT2UxA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=k+04PyJ6eJf18VKMYGPfQLb4xGVT1mZRfE3QrlgEldw=; b=Ak4X0K5mf78ug3JCDyjEdS/AOts1SMVLQBcw5kBU9alT5Cvl+e8PsaVigRrrAHQ0eOnuE1ftgRv2bTTgjnJBy5NiTvpcgbpO80mPo87AWr5hR1DbOPjxe8joLGKl7BUedfVetUEZ0gqBJ8pl6bPklEC1QmHI+sWxLIq2soVLfI0= Received: from BN9PR11MB5483.namprd11.prod.outlook.com (2603:10b6:408:104::10) by BN9PR11MB5353.namprd11.prod.outlook.com (2603:10b6:408:11a::6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4478.17; Wed, 1 Sep 2021 00:34:48 +0000 Received: from BN9PR11MB5483.namprd11.prod.outlook.com ([fe80::882:4e40:b0e4:239e]) by BN9PR11MB5483.namprd11.prod.outlook.com ([fe80::882:4e40:b0e4:239e%6]) with mapi id 15.20.4457.024; Wed, 1 Sep 2021 00:34:48 +0000 From: "Chiu, Chasel" To: "Desimone, Nathaniel L" , "devel@edk2.groups.io" CC: Michael Kubacki , Benjamin Doron Subject: Re: [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value Thread-Topic: [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value Thread-Index: AQHXmi5HIMZXNkPjb06V3OThwva0Y6uOXeOQ Date: Wed, 1 Sep 2021 00:34:48 +0000 Message-ID: References: <20210826035546.1771-1-nathaniel.l.desimone@intel.com> In-Reply-To: <20210826035546.1771-1-nathaniel.l.desimone@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-reaction: no-action dlp-version: 11.6.200.16 authentication-results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=intel.com; x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 92653325-419f-4c61-97ea-08d96ce04df9 x-ms-traffictypediagnostic: BN9PR11MB5353: x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:1227; x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: wzsT+BtPwe9WZwTR2zjrQmMG2Hfx1GeD29jqAMM7xKgVkyiHE5233wkHboDGibJyVum9EfNFrHU+Hsn0mDVIhdvRxFHEDWe59Qqf1fcUQkzbZkkCqvkD9CKToYpjkzYSIBSjdi2s1A55U3KOi0aLpfVJkdmYtVP3QdKLVdLrVcpsWD7xrb/bsCkoBY61PPk0Mtuaw78tJzggSksLGS9i2lXk2euFjqIbVquqdAYxr545Ev8vTdJBFECIb2VYe+3ooniebKhZiPIi3PjFzT03s0WyFSvraMLOg/K9F1es9bt2n3dFCIaq8SWvkFQtB1zdhucTqRsf1SM+Wq3zRZkecQ1if89/xVkuO3a68uxjFdHRK93GuP/CzPBouCZ8Ad6h2PL5BFQ0R9MCnJeyp9keAOplm80RpmuzMYaVw1cc1FGx3RtKXRmu1O8cqeQjXeJgQtWQhYXRfpwO+NsbGspQfvXvV3WxPSX/juMG1mUd1doTPp2hEQWrLOoUUjXr0QNjlLZb7WkKo9LGuYSUR2s5JvpCzzf4gHAQ0SlJql33qb5z5k+igygZGOQ9H/sZBEfK6veGq7BHH9NA86ATW086POT+ikoLWUe1JUsiUlgNu1cMKkQxcaN5MzvR8hWzPYu34V98rdTuxBHtiN7A4XlG5Fpjf56YIkpOrju7Ry2g33121RNMVeqjA2Hedpgdcj4R4wjbq9+6H8bD8vu8oVlTwQ== x-forefront-antispam-report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:BN9PR11MB5483.namprd11.prod.outlook.com;PTR:;CAT:NONE;SFS:(6029001)(4636009)(366004)(38070700005)(2906002)(53546011)(66446008)(6506007)(7696005)(316002)(508600001)(122000001)(8676002)(8936002)(4326008)(66556008)(5660300002)(64756008)(66476007)(52536014)(66946007)(26005)(71200400001)(186003)(76116006)(38100700002)(9686003)(55016002)(110136005)(54906003)(83380400001)(33656002)(86362001);DIR:OUT;SFP:1102; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?EDayVa01ufwtIvl6nClqN5MrZ7m0MCuf/h9+hVTE/MjHki292V4qQD/2uT85?= =?us-ascii?Q?mhC8+IuILAPDsBt0H9mPHN+ZBjUXtr+2S4nUcQhebVwcEmTt4BedzyVpBn1L?= =?us-ascii?Q?kVa67Z2GXRIUJAU1Psu9sABVhsoKZpmxIWE5yq/QUKfb91kMSQXGtwyrvZHn?= =?us-ascii?Q?QadZN2e7xjUh2bCIr7A5hvnAtx/ICf//5S9eql2hwML9viemc+Xkcx3w7PKf?= =?us-ascii?Q?W4j+4ShHgvYzWZL+E3tjPguzCbq/jnKBVDHBockhKilj2dYyBDoxrgVGK8Ux?= =?us-ascii?Q?2Nvvx8WYl8l5RwPohX2kPJABxmYfynzyf6w/H9lOrcvQ/6hvLmIyVGbQ9IIy?= =?us-ascii?Q?IdiTVn9G0/IFf/4946+QUr7Xc92RL3tmqOHNlGukXohQOacQ1Zp69RQiNKL5?= =?us-ascii?Q?Yv8N18a0EmgMutaxVseYnaqv82b/klpD0SeHVE5m2cJuDmeaAL6AElhQItco?= =?us-ascii?Q?dYfkSWCW7I58dCdRzKMO2c1eQD31WiY8fuxRJvBSTFe5xSXY8DJ1mYJ0UDXF?= =?us-ascii?Q?IiwBQQHFfeDi3md1pXLlJf5OzZibZmSwXfzhsJkQLDDDBETMTHRJDFvmx5ns?= =?us-ascii?Q?pBpLQ9CwvDGYti/qv3t8y1ng2OPmOnAsVYDLqOqKeB5OiNePPuxsMj4RPkqt?= =?us-ascii?Q?j/eou1M+07/NevskiZnG6z8JG/TQRwmkJTzuHlVC4eDj/UHl44DjvZxCcrJN?= =?us-ascii?Q?FuFdhBoRplXQc3mup3evhl/PUFfUevhnGSAhOsxh6g5cPqa7+eJJVb8ZnwH4?= =?us-ascii?Q?HowcEPVhwgLDF1nTAkK3O4r7yzZD9klMiGzLM7WDoea86lVvRHEsF+8ypOJB?= =?us-ascii?Q?xNCo+kragpNz8TYbD/OWDCDh16f1JwP/b1Bcuyloaq8Bk2l/VjHCvuPE4/VF?= =?us-ascii?Q?91SYf/HupVCaX4Z6kcz938nODyuMMGA7kO2jJZcF4gDGzW5ERgJ8Rn9eOYUE?= =?us-ascii?Q?MigO7S+/LJyeEW2uVf4U11Po5bcLo/QWHtmTOnsnKVirQjPKnK1FVtFcn8A+?= =?us-ascii?Q?BNl0jLVVFjcRBZ5nbzOUGDhBnUI1ng/L0j6RF4RkXncUwiCCRM1BfGRmETH8?= =?us-ascii?Q?Ni9HWk0T4/EuUh/2zgDY+q4XE1t5jFI7qgYN1oWbGbgUqydQ9HIFz+HtY8JZ?= =?us-ascii?Q?5Km1Ylnp1a1OewzIdxT//O92whQW516QQTGcKCDD5iSSgV/+VQmyYM2uczoQ?= =?us-ascii?Q?nWyRgUiPKWABh4COf/QB8+uyvhcMEB5HwN2uRot0KykiO0sNzvPPDcTyacFG?= =?us-ascii?Q?+giGnQS4/MzBrbqHWh/xlf884Vqx/1uegDv2mgLF5x28zsVJUBGi0EmENTxD?= =?us-ascii?Q?CyKDTUHxYZP/1DlOJYk3bWFu?= MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: BN9PR11MB5483.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 92653325-419f-4c61-97ea-08d96ce04df9 X-MS-Exchange-CrossTenant-originalarrivaltime: 01 Sep 2021 00:34:48.4938 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: jCJelfGqJs6XZSJHSESe1FMtF5Dgdm4hwrFQVTsAuZaYRzvuWHbJBD99cxHs/p12KpHokwsKU2Aymnul45s89w== X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN9PR11MB5353 Return-Path: chasel.chiu@intel.com X-OriginatorOrg: intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Chasel Chiu > -----Original Message----- > From: Desimone, Nathaniel L > Sent: Thursday, August 26, 2021 11:56 AM > To: devel@edk2.groups.io > Cc: Chiu, Chasel ; Michael Kubacki > ; Benjamin Doron > > Subject: [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib > return value >=20 > Added EFI_INVALID_PARAMETER to the EcRead() function's list of return val= ues. >=20 > 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(-) >=20 > 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 dependen= cies, > use > restrictions, etc). >=20 > -Copyright (c) 2019, Intel Corporation. All rights reserved.
> +Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.
> SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -109,9 +109,10 @@ LpcEcInterface ( > @param[in] Address Address to read > @param[out] Data Data received >=20 > - @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. >=20 > -Copyright (c) 2019, Intel Corporation. All rights reserved.
> +Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.
> SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -16,9 +16,10 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > @param[in] Address Address to read > @param[out] Data Data received >=20 > - @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