From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=fail (domain: intel.com, ip: , mailfrom: shenglei.zhang@intel.com) 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 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" 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: [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> X-Mailer: git-send-email 2.18.0.windows.1 In-Reply-To: <20190906084709.20192-1-shenglei.zhang@intel.com> References: <20190906084709.20192-1-shenglei.zhang@intel.com> 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/PeiSmmAccessLib/PeiSmmAccessLib.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c index 2310e611..76b1b23b 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c @@ -46,9 +46,9 @@ typedef struct { The use of "open" means that the memory is visible from all PEIM and SMM agents. + @param[in] PeiServices - General purpose services available to every 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 every PEIM. @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 ( @param[in] PeiServices - General purpose services available to every PEIM. @param[in] This - Pointer to the SMRAM Access Interface. - @param[in] SmramMapSize - Pointer to the variable containing size of the + @param[in,out] SmramMapSize - Pointer to the variable containing size 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. @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient buffer. diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c index bdcacac5..253d8015 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c @@ -229,9 +229,9 @@ Lock ( memory controller capabilities. @param[in] This - Pointer to the SMRAM Access Interface. - @param[in] SmramMapSize - Pointer to the variable containing size of the + @param[in,out] SmramMapSize - Pointer to the variable containing size 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. @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient buffer. diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h index 647b3a07..c4d881be 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h @@ -140,9 +140,9 @@ Lock ( memory controller capabilities. @param[in] This - Pointer to the SMRAM Access Interface. - @param[in] SmramMapSize - Pointer to the variable containing size of the + @param[in,out] SmramMapSize - Pointer to the variable containing size 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. @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient buffer. -- 2.18.0.windows.1