From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mx.groups.io with SMTP id smtpd.web09.419.1577773077915485738 for ; Mon, 30 Dec 2019 22:17:58 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.65, mailfrom: shenglei.zhang@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 30 Dec 2019 22:17:57 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,378,1571727600"; d="scan'208";a="209214232" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by orsmga007.jf.intel.com with ESMTP; 30 Dec 2019 22:17:56 -0800 Received: from fmsmsx157.amr.corp.intel.com (10.18.116.73) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.439.0; Mon, 30 Dec 2019 22:17:56 -0800 Received: from shsmsx103.ccr.corp.intel.com (10.239.4.69) by FMSMSX157.amr.corp.intel.com (10.18.116.73) with Microsoft SMTP Server (TLS) id 14.3.439.0; Mon, 30 Dec 2019 22:17:56 -0800 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.197]) by SHSMSX103.ccr.corp.intel.com ([169.254.4.245]) with mapi id 14.03.0439.000; Tue, 31 Dec 2019 14:17:54 +0800 From: "Zhang, Shenglei" To: "Chen, Marc W" , "devel@edk2.groups.io" CC: "Kubacki, Michael A" , "Chaganty, Rangasai V" , "Gao, Liming" Subject: Re: [edk2-devel][edk2-platforms][PATCH] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Thread-Topic: [edk2-devel][edk2-platforms][PATCH] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Thread-Index: AQHVu7k4mdR699YvaEqfCePbba3oGKfTy4DQ Date: Tue, 31 Dec 2019 06:17:53 +0000 Message-ID: References: <20191226065308.15572-1-marc.w.chen@intel.com> In-Reply-To: <20191226065308.15572-1-marc.w.chen@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Return-Path: shenglei.zhang@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Shenglei Zhang > -----Original Message----- > From: Chen, Marc W > Sent: Thursday, December 26, 2019 2:53 PM > To: devel@edk2.groups.io > Cc: Kubacki, Michael A ; Chaganty, Rangasai = V > ; Gao, Liming ; > Zhang, Shenglei ; Chen, Marc W > > Subject: [edk2-devel][edk2-platforms][PATCH] > IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment >=20 > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D2436 >=20 > Cc: Michael Kubacki > Cc: Sai Chaganty > Cc: Liming Gao > Cc: Shenglei Zhang > Signed-off-by: Marc Chen > --- > .../Library/PeiSmmAccessLib/PeiSmmAccessLib.c | 19 ++++++++-----= ----- > - > .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c | 6 +++--- > .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h | 13 +++++---- > ---- > .../IntelSiliconPkg/Include/Library/SmmAccessLib.h | 5 +---- > 4 files changed, 17 insertions(+), 26 deletions(-) >=20 > diff --git > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi > b/PeiSmmAccessLib.c > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi > b/PeiSmmAccessLib.c > index da141cfa0e..61da7ea0bd 100644 > --- > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi > b/PeiSmmAccessLib.c > +++ > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi > b/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 e= very > 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 e= very > PEIM. >=20 > @retval EFI_SUCCESS - The region was successfully opened. > @retval EFI_DEVICE_ERROR - The region could not be opened becau= se > locked by > @@ -193,12 +193,12 @@ Lock ( > ranges that are possible for SMRAM access, based upon the > memory controller capabilities. >=20 > - @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 > - buffer to contain the description informat= ion. > - @param[in] SmramMap - Buffer containing the data describing the > Smram > - region descriptors. > + @param[in] PeiServices - General purpose services available to = every > PEIM. > + @param[in] This - Pointer to the SMRAM Access Interface= . > + @param[in, out] SmramMapSize - Pointer to the variable containing si= ze > of the > + buffer to contain the description inf= ormation. > + @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 > buffer. > @retval EFI_SUCCESS - The user provided a sufficiently-size= d buffer. > @@ -234,10 +234,7 @@ GetCapabilities ( > /** > This function is to install an SMM Access PPI > - Introduction \n > - A module to install a PPI for controlling SMM mode memory access > basically for S3 resume usage. > - > - - @result > - Publish _EFI_PEI_MM_ACCESS_PPI. > + An API to install a PEI_MM_ACCESS_PPI PPI for controlling SMM mode > memory access basically for S3 resume usage. >=20 > @retval EFI_SUCCESS - Ppi successfully started and install= ed. > @retval EFI_NOT_FOUND - Ppi can't be found. > diff --git > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.c > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.c > index 3d3c4ab206..9409345f6b 100644 > --- > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.c > +++ > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.c > @@ -18,7 +18,7 @@ static SMM_ACCESS_PRIVATE_DATA mSmmAccess; > @param[in] SystemTable - Pointer to the EFI System Table >=20 > @retval EFI_SUCCESS - Protocol was installed successfully > - @exception EFI_UNSUPPORTED - Protocol was not installed > + @retval EFI_UNSUPPORTED - Protocol was not installed > @retval EFI_NOT_FOUND - Protocol can't be found. > @retval EFI_OUT_OF_RESOURCES - Protocol does not have enough > resources to initialize the driver. > **/ > @@ -229,9 +229,9 @@ Lock ( > memory controller capabilities. >=20 > @param[in] This - Pointer to the SMRAM Access Interfa= ce. > - @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 i= nformation. > - @param[in] SmramMap - Buffer containing the data describi= ng the > Smram > + @param[in, out] SmramMap - Buffer containing the data describi= ng > the Smram > region descriptors. >=20 > @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient > buffer. > diff --git > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.h > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.h > index c0ff3a250b..a2ea6332fa 100644 > --- > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.h > +++ > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc > cessDriver.h > @@ -59,9 +59,6 @@ typedef struct { > Please refer the SMM Protocols section in the attached SMM CIS > Specification version 0.9 for further details. > This driver is required if SMM is supported. Proper configuration of= SMM > registers is recommended even if SMM is not supported. >=20 > - - @result > - Publishes the _EFI_SMM_ACCESS_PROTOCOL: Documented in the > System Management Mode Core Interface Specification, available at the URL= : > http://www.intel.com/technology/framework/spec.htm > - > - Porting Recommendations \n > No modification of this module is recommended. Any modification sho= uld > be done in compliance with the _EFI_SMM_ACCESS_PROTOCOL protocol > definition. >=20 > @@ -69,7 +66,7 @@ typedef struct { > @param[in] SystemTable - Pointer to the EFI System Table >=20 > @retval EFI_SUCCESS - Protocol was installed successfully > - @exception EFI_UNSUPPORTED - Protocol was not installed > + @retval EFI_UNSUPPORTED - Protocol was not installed > **/ > EFI_STATUS > EFIAPI > @@ -142,10 +139,10 @@ Lock ( > memory controller capabilities. >=20 > @param[in] This - Pointer to the SMRAM Access Interfa= ce. > - @param[in] SmramMapSize - Pointer to the variable containing = size of > the > - buffer to contain the description informatio= n. > - @param[in] SmramMap - Buffer containing the data describi= ng the > Smram > - region descriptors. > + @param[in, out] SmramMapSize - Pointer to the variable containing = size > of the > + buffer to contain the description i= nformation. > + @param[in, out] SmramMap - Buffer containing the data describi= ng > the Smram > + region descriptors. >=20 > @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient > buffer. > @retval EFI_SUCCESS - The user provided a sufficiently-sized= buffer. > diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h > b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h > index f658bac68c..0a287b75b2 100644 > --- a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h > +++ b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h > @@ -11,10 +11,7 @@ > /** > This function is to install an SMM Access PPI > - Introduction \n > - A module to install a PPI for controlling SMM mode memory access > basically for S3 resume usage. > - > - - @result > - Publish _PEI_MM_ACCESS_PPI. > + An API to install a PEI_MM_ACCESS_PPI PPI for controlling SMM mode > memory access basically for S3 resume usage. >=20 > @retval EFI_SUCCESS - Ppi successfully started and install= ed. > @retval EFI_NOT_FOUND - Ppi can't be found. > -- > 2.16.2.windows.1