From nobody Tue Apr 23 06:07:59 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+46970+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+46970+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1567759635; cv=none; d=zoho.com; s=zohoarc; b=ScvCuLnaPzZQB5Q2bi8hIFi+ZWVm6uSAtpQcPEWWslanDsnZcwN3DgxPHDeIAmzqjcXCC6qx396v140pfvvmLQdczPnL0ar6WF9ZSikUOcvxucRlHrgW2J86jxhiIGi7XpQjsMa+mlf0t+7lpCHLnGVO9Sojr8IxzqrMVa7aang= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1567759635; h=Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:Message-ID:Reply-To:References:Sender:Subject:To:ARC-Authentication-Results; bh=jZHLF4dgkiFynrD+zlyCnji60eztFlWTgK7NT3U+2+E=; b=jMcAiavto76Ba2IF6FSLS104tRJzz4zCO7KbqtKy24h6xE3Q3jJGYrfRCaLkByAAVJOM3fcnP7XwqPID0gagdNYPg+W4Ntwhmk4tmyhTMVLKEXopxnkUywRIIU0S+lc2HrCuCyjERVXlYvoYDhDGWg1XAfBtoLrtSQHTj16WHlA= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+46970+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1567759635365819.5821019707644; Fri, 6 Sep 2019 01:47:15 -0700 (PDT) Return-Path: X-Received: from mga05.intel.com (mga05.intel.com []) by groups.io with SMTP; Fri, 06 Sep 2019 01:47:14 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 06 Sep 2019 01:47:14 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,472,1559545200"; d="scan'208";a="358728934" X-Received: from shenglei-dev.ccr.corp.intel.com ([10.239.158.52]) by orsmga005.jf.intel.com with ESMTP; 06 Sep 2019 01:47:13 -0700 From: "Zhang, Shenglei" To: devel@edk2.groups.io Cc: Ray Ni , Rangasai V Chaganty Subject: [edk2-devel] [PATCH] IntelSiliconPkg/SmmAccess: Update the parameters in comments Date: Fri, 6 Sep 2019 16:47:06 +0800 Message-Id: <20190906084709.20192-2-shenglei.zhang@intel.com> In-Reply-To: <20190906084709.20192-1-shenglei.zhang@intel.com> References: <20190906084709.20192-1-shenglei.zhang@intel.com> Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,shenglei.zhang@intel.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1567759635; bh=Bv2CBIXVj7q1l2HW5b5EbfPw/tuPYF2V3X5cXu0/7Gw=; h=Cc:Date:From:Reply-To:Subject:To; b=whz2su80ZdKwaLhoM2t7PVYl2e0nNboLsJjCGAO0xMoniF9cnHiLPPBMtNJisZHvurq YJ8vLjpzoAHBuRxO/M3q80uoKlreno5HE3xvH1W5R/Kb1eAHfd8Q+E1IFS1skEJm7hmFR zh/bZrIRCTdjsGKXrHwcZ8uVDJ8MneqrwKg= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Change the order of parameters in comments to match the order in code, in PeiSmmAccessLib.c. Add the attribute "out" for parameters. This is to fix issues reported by ECC. Cc: Ray Ni Cc: Rangasai V Chaganty Signed-off-by: Shenglei Zhang --- .../SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c | 6 +++--- .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c | 4 ++-- .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmm= AccessLib/PeiSmmAccessLib.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAcce= ss/Library/PeiSmmAccessLib/PeiSmmAccessLib.c index 2310e611..76b1b23b 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessL= ib/PeiSmmAccessLib.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessL= ib/PeiSmmAccessLib.c @@ -46,9 +46,9 @@ typedef struct { The use of "open" means that the memory is visible from all PEIM and SMM agents. =20 + @param[in] PeiServices - General purpose services available to eve= ry PEIM. @param[in] This - Pointer to the SMM Access Interface. @param[in] DescriptorIndex - Region of SMRAM to Open. - @param[in] PeiServices - General purpose services available to eve= ry PEIM. =20 @retval EFI_SUCCESS - The region was successfully opened. @retval EFI_DEVICE_ERROR - The region could not be opened because= locked by @@ -195,9 +195,9 @@ Lock ( =20 @param[in] PeiServices - General purpose services available to every P= EIM. @param[in] This - Pointer to the SMRAM Access Interface. - @param[in] SmramMapSize - Pointer to the variable containing size of t= he + @param[in,out] SmramMapSize - Pointer to the variable containing size = of the buffer to contain the description informatio= n. - @param[in] SmramMap - Buffer containing the data describing the Sm= ram + @param[in,out] SmramMap - Buffer containing the data describing th= e Smram region descriptors. =20 @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient b= uffer. diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/S= mmAccessDriver.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAcces= sDxe/SmmAccessDriver.c index bdcacac5..253d8015 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.c @@ -229,9 +229,9 @@ Lock ( memory controller capabilities. =20 @param[in] This - Pointer to the SMRAM Access Interface. - @param[in] SmramMapSize - Pointer to the variable containing si= ze of the + @param[in,out] SmramMapSize - Pointer to the variable containing si= ze of the buffer to contain the description inf= ormation. - @param[in] SmramMap - Buffer containing the data describing= the Smram + @param[in,out] SmramMap - Buffer containing the data describing= the Smram region descriptors. =20 @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient bu= ffer. diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/S= mmAccessDriver.h b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAcces= sDxe/SmmAccessDriver.h index 647b3a07..c4d881be 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h @@ -140,9 +140,9 @@ Lock ( memory controller capabilities. =20 @param[in] This - Pointer to the SMRAM Access Interface. - @param[in] SmramMapSize - Pointer to the variable containing si= ze of the + @param[in,out] SmramMapSize - Pointer to the variable containing si= ze of the buffer to contain the description information. - @param[in] SmramMap - Buffer containing the data describing= the Smram + @param[in,out] SmramMap - Buffer containing the data describing= the Smram region descriptors. =20 @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient bu= ffer. --=20 2.18.0.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46970): https://edk2.groups.io/g/devel/message/46970 Mute This Topic: https://groups.io/mt/33164366/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-