From nobody Sat May 4 08:31:34 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+52577+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+52577+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1577343217; cv=none; d=zohomail.com; s=zohoarc; b=Wn9yYh0PbutlmIV5HyA5wM0kIVhRCc3xg+ABdV+2tHN5TKSvAKSnLAyz+OZ+k/S/eBng19yEs4IZRW2nRukIOJ175rwAfxQ7gtGNlkrHYBH9Xy7zMWacf/29bYyDi9vuKPZ/q9b/mOsmUUhYQRaM+K20ziBxTXh8+tblCeeeqYs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1577343217; h=Cc:Date:From:List-Id:List-Unsubscribe:Message-ID:Reply-To:Sender:Subject:To; bh=vI/4CdxQGkHK5un2/vUZGVXMgNWMiR8CXm31Q6ADSFA=; b=V9D8uv+k8u9f2fTabifBtnGWA2hFP2C5l011Sk9B5j4YA/IXxu9h9WKH54ZGZJZB7tuSJOJG8juxiw89f0Xt6jI+B3oQqYTxaLEr/laWRhufKLlGiuoUqU8wQSXTeAotp7aGcGAaS8CHwrYRZSlpxCLGnKYotcbNHqQLbsZcp68= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+52577+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 1577343217368853.6198194112378; Wed, 25 Dec 2019 22:53:37 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id 5BUtYY1788612xZPASAEgjZI; Wed, 25 Dec 2019 22:53:36 -0800 X-Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mx.groups.io with SMTP id smtpd.web11.18799.1577343215645350914 for ; Wed, 25 Dec 2019 22:53:35 -0800 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 25 Dec 2019 22:53:35 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,358,1571727600"; d="scan'208";a="417955799" X-Received: from unknown (HELO chenmarc-MOBL.gar.corp.intel.com) ([10.5.244.250]) by fmsmga005.fm.intel.com with ESMTP; 25 Dec 2019 22:53:33 -0800 From: "Marc W Chen" To: devel@edk2.groups.io Cc: Michael Kubacki , Sai Chaganty , Liming Gao , Shenglei Zhang , Marc Chen Subject: [edk2-devel][edk2-platforms][PATCH] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Date: Thu, 26 Dec 2019 14:53:08 +0800 Message-Id: <20191226065308.15572-1-marc.w.chen@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,marc.w.chen@intel.com X-Gm-Message-State: coPJiR8CCIQ9hgtShMOjZzA1x1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1577343216; bh=+FnWf/sDEc1TIb396FSj6xGDxp7dBGFq2SzBOV4tcIU=; h=Cc:Date:From:Reply-To:Subject:To; b=YyucBsRGjen5rmDr5F0aZQxOQ7avyGRL/3HXbvh0+okxuJ773lol48l6aCigSiH+T7n nwvDnWj45Zk1Ii5gMOjGU+9hR8vW8xrKDv9o6tluE5dFxt943KbccMC2QetTYyiGsIwPS Ggxhl/28wdA2RmXVkQ520I9AcYZlbnZFVqU= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D2436 Cc: Michael Kubacki Cc: Sai Chaganty Cc: Liming Gao Cc: Shenglei Zhang Signed-off-by: Marc Chen Reviewed-by: Liming Gao Reviewed-by: Michael Kubacki Reviewed-by: Shenglei Zhang --- .../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(-) 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 da141cfa0e..61da7ea0bd 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 @@ -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 P= EIM. - @param[in] This - Pointer to the SMRAM Access Interface. - @param[in] SmramMapSize - Pointer to the variable containing size of t= he - buffer to contain the description informatio= n. - @param[in] SmramMap - Buffer containing the data describing the Sm= ram - region descriptors. + @param[in] PeiServices - General purpose services available to ev= ery PEIM. + @param[in] This - Pointer to the SMRAM Access Interface. + @param[in, out] SmramMapSize - Pointer to the variable containing size= of the + buffer to contain the description infor= mation. + @param[in, out] SmramMap - Buffer containing the data describing t= he Smram + region descriptors. =20 @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient b= uffer. @retval EFI_SUCCESS - The user provided a sufficiently-sized = 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 basic= ally 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 mem= ory access basically for S3 resume usage. =20 @retval EFI_SUCCESS - Ppi successfully started and installed. @retval EFI_NOT_FOUND - Ppi can't be found. diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/S= mmAccessDriver.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAcces= sDxe/SmmAccessDriver.c index 3d3c4ab206..9409345f6b 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.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 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 c0ff3a250b..a2ea6332fa 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h @@ -59,9 +59,6 @@ typedef struct { Please refer the SMM Protocols section in the attached SMM CIS Specifi= cation version 0.9 for further details. This driver is required if SMM is supported. Proper configuration of S= MM registers is recommended even if SMM is not supported. =20 - - @result - Publishes the _EFI_SMM_ACCESS_PROTOCOL: Documented in the System Manag= ement Mode Core Interface Specification, available at the URL: http://www.i= ntel.com/technology/framework/spec.htm - - Porting Recommendations \n No modification of this module is recommended. Any modification shoul= d be done in compliance with the _EFI_SMM_ACCESS_PROTOCOL protocol definiti= on. =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 Interface. - @param[in] 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 - region descriptors. + @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 bu= ffer. @retval EFI_SUCCESS - The user provided a sufficiently-sized b= uffer. 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 basic= ally for S3 resume usage. - - - @result - Publish _PEI_MM_ACCESS_PPI. + An API to install a PEI_MM_ACCESS_PPI PPI for controlling SMM mode mem= ory access basically for S3 resume usage. =20 @retval EFI_SUCCESS - Ppi successfully started and installed. @retval EFI_NOT_FOUND - Ppi can't be found. --=20 2.16.2.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 (#52577): https://edk2.groups.io/g/devel/message/52577 Mute This Topic: https://groups.io/mt/69269074/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-