From nobody Thu Apr 25 19:38:32 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+53123+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+53123+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1578633634; cv=none; d=zohomail.com; s=zohoarc; b=LncWHAnPNv3lUP/KT60IMMo7siy/qtVObDXCHkV0ASEME3A95v3TnQ/l9yy4udMLLmQ3zJ8UgvGmUMRW9+fxGijXY9mvfgb9zEUQFP9Ws/eoIDAmd3F6fuBtUhPNOa7IyLFhph6zprUot5jBWsFkaxY1v/gxWx7fzWYrZY6gNM8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1578633634; h=Cc:Date:From:List-Id:List-Unsubscribe:Message-ID:Reply-To:Sender:Subject:To; bh=vmAbcADndAStoLvd9L4TRMfrEAFer9tOBa+doczyDkU=; b=etHdqFOT4vq3wroDv790Bkj44RSVCfcF1XxUNTDb+0mvE/roysjYMDmxXlXtSacIfgH4vf2n/7qhi0mB0q2Aduz2D5SS0/923iwCgsOenbJmLnKfqsYrn7u5v3WNL4sb6FArJaUcruW8pojDdBCEumF2lTPeRVjMQR+495GyzUo= 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+53123+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 1578633634791654.4130975015298; Thu, 9 Jan 2020 21:20:34 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id 8ALiYY1788612xrKVJG4SXNV; Thu, 09 Jan 2020 21:20:34 -0800 X-Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mx.groups.io with SMTP id smtpd.web10.6206.1578633632823680837 for ; Thu, 09 Jan 2020 21:20:33 -0800 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 09 Jan 2020 21:20:32 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,415,1571727600"; d="scan'208";a="223610632" X-Received: from unknown (HELO chenmarc-MOBL.gar.corp.intel.com) ([10.5.245.35]) by orsmga006.jf.intel.com with ESMTP; 09 Jan 2020 21:20:29 -0800 From: "Marc W Chen" To: devel@edk2.groups.io Cc: Michael Kubacki , Sai Chaganty , Ray Ni , Liming Gao , Shenglei Zhang , Marc Chen Subject: [edk2-devel][edk2-platforms][PATCH v5] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Doxygen comment Date: Fri, 10 Jan 2020 13:20:23 +0800 Message-Id: <20200110052023.3928-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: Zs6UTlDAYV0PUPrX654QSfzmx1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1578633634; bh=OnDwLrmqw5izIWjzBWOL3pDCykAcqBfgor/cVZfuGW4=; h=Cc:Date:From:Reply-To:Subject:To; b=Ib4YExb9akjh3hd5/MgRF/ASY3m7tzqqm+L/KFoSp8x4UU4DCPsU5lUWv9gUiQujqTs ikYnXxitJ/fBLRzWN2HAq1T7UV2r/xv6Udywtusjvh60bVX9GJF9YZoxrflpf6Mu/NU40 xkHc4JNlaFsRpU4OdbHZph0/0Js0X6AoL80= 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 Fixed some doxygen comment that does not follow correct doxygen format. Updated some description of some functions. Notes: v1: - Initial version of code change. v2: - Update some description of some functions. v3: - Update some description of some functions. v4: - Change "post" to "POST". v5: - Fixed typo of subject from "Doxcgen" to "Doxygen". Cc: Michael Kubacki Cc: Sai Chaganty Cc: Ray Ni Cc: Liming Gao Cc: Shenglei Zhang Signed-off-by: Marc Chen Reviewed-by: Ray Ni Reviewed-by: Sai Chaganty --- .../Library/PeiSmmAccessLib/PeiSmmAccessLib.c | 37 +++++++++---------- .../SmmAccess/SmmAccessDxe/SmmAccessDriver.c | 35 +++++++++++------- .../SmmAccess/SmmAccessDxe/SmmAccessDriver.h | 41 ++++++++++--------= ---- .../IntelSiliconPkg/Include/Library/SmmAccessLib.h | 7 ++-- 4 files changed, 60 insertions(+), 60 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..d9bf4fba98 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessL= ib/PeiSmmAccessLib.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessL= ib/PeiSmmAccessLib.c @@ -1,7 +1,7 @@ /** @file This is to publish the SMM Access Ppi instance. =20 - Copyright (c) 2019, Intel Corporation. All rights reserved.
+ Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent =20 **/ @@ -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] 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. + @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. =20 @retval EFI_SUCCESS - The region was successfully opened. @retval EFI_DEVICE_ERROR - The region could not be opened because= locked by @@ -89,9 +89,9 @@ Open ( This routine accepts a request to "close" a region of SMRAM. This is va= lid for compatible SMRAM region. =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 Close. + @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 Close. =20 @retval EFI_SUCCESS - The region was successfully closed. @retval EFI_DEVICE_ERROR - The region could not be closed because= locked by @@ -151,9 +151,9 @@ Close ( The use of "lock" means that the memory can no longer be opened to PEIM. =20 - @param[in] PeiServices - General purpose services available to ever= y PEIM. - @param[in] This - Pointer to the SMM Access Interface. - @param[in] DescriptorIndex - Region of SMRAM to Lock. + @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 Lock. =20 @retval EFI_SUCCESS - The region was successfully locked. @retval EFI_DEVICE_ERROR - The region could not be locked because= at least @@ -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 an instance of EFI_PEI_MM_ACCESS_PPI. This PPI is co= mmonly used to control SMM mode memory access for S3 resume. =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..1cbce1907c 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.c @@ -2,7 +2,7 @@ This is the driver that publishes the SMM Access Protocol instance for System Agent. =20 - Copyright (c) 2019, Intel Corporation. All rights reserved.
+ Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent =20 **/ @@ -11,14 +11,24 @@ static SMM_ACCESS_PRIVATE_DATA mSmmAccess; =20 /** - This is the standard EFI driver point that - installs an SMM Access Protocol - - @param[in] ImageHandle - Handle for the image of this driver - @param[in] SystemTable - Pointer to the EFI System Table + SMM Access Driver Entry Point + This driver installs an SMM Access Protocol + - Introduction \n + This module publishes the SMM access protocol. The protocol is used b= y the SMM Base driver to access the SMRAM region when the processor is not = in SMM. + The SMM Base driver uses the services provided by the SMM access proto= col to open SMRAM during POST and copy the SMM handler. + SMM access protocol is also used to close the SMRAM region once the co= pying is done. + Finally, the SMM access protocol provides services to "Lock" the SMRAM= region. + 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. + + - 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. + + @param[in] ImageHandle - Handle for the image of this driver + @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. **/ @@ -108,8 +118,7 @@ SmmAccessDriverEntryPoint ( @param[in] This - Pointer to the SMM Access Interface. =20 @retval EFI_SUCCESS - The region was successfully opened. - @retval EFI_DEVICE_ERROR - The region could not be opened because l= ocked by - chipset. + @retval EFI_DEVICE_ERROR - The region could not be opened because l= ocked by chipset. @retval EFI_INVALID_PARAMETER - The descriptor index was out of bounds. **/ EFI_STATUS @@ -229,13 +238,13 @@ 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. - @retval EFI_SUCCESS - The user provided a sufficiently-sized b= uffer. + @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient= buffer. + @retval EFI_SUCCESS - The user provided a sufficiently-size= d buffer. **/ EFI_STATUS EFIAPI diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/S= mmAccessDriver.h b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAcces= sDxe/SmmAccessDriver.h index c0ff3a250b..bcdaef7ba6 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h @@ -1,7 +1,7 @@ /** @file Header file for SMM Access Driver. =20 - Copyright (c) 2019, Intel Corporation. All rights reserved.
+ Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent =20 **/ @@ -53,23 +53,22 @@ typedef struct { This driver installs an SMM Access Protocol - Introduction \n This module publishes the SMM access protocol. The protocol is used b= y the SMM Base driver to access the SMRAM region when the processor is not = in SMM. - The SMM Base driver uses the services provided by the SMM access proto= col to open SMRAM during post and copy the SMM handler. + The SMM Base driver uses the services provided by the SMM access proto= col to open SMRAM during POST and copy the SMM handler. SMM access protocol is also used to close the SMRAM region once the co= pying is done. Finally, the SMM access protocol provides services to "Lock" the SMRAM= region. 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 - @param[in] ImageHandle - Handle for the image of this driver - @param[in] SystemTable - Pointer to the EFI System Table + @param[in] ImageHandle - Handle for the image of this driver + @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_SUCCESS - Protocol was installed successfully + @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. **/ EFI_STATUS EFIAPI @@ -87,8 +86,7 @@ SmmAccessDriverEntryPoint ( @param[in] This - Pointer to the SMM Access Interface. =20 @retval EFI_SUCCESS - The region was successfully opened. - @retval EFI_DEVICE_ERROR - The region could not be opened because l= ocked by - chipset. + @retval EFI_DEVICE_ERROR - The region could not be opened because l= ocked by chipset. @retval EFI_INVALID_PARAMETER - The descriptor index was out of bounds. **/ EFI_STATUS @@ -103,11 +101,10 @@ Open ( The use of "close" means that the memory is only visible from SMM agents, not from BS or RT code. =20 - @param[in] This - Pointer to the SMM Access Interface. + @param[in] This - Pointer to the SMM Access Interface. =20 @retval EFI_SUCCESS - The region was successfully closed. - @retval EFI_DEVICE_ERROR - The region could not be closed because l= ocked by - chipset. + @retval EFI_DEVICE_ERROR - The region could not be closed because l= ocked by chipset. @retval EFI_INVALID_PARAMETER - The descriptor index was out of bounds. **/ EFI_STATUS @@ -122,11 +119,11 @@ Close ( The use of "lock" means that the memory can no longer be opened to BS state.. =20 - @param[in] This - Pointer to the SMM Access Interface. + @param[in] This - Pointer to the SMM Access Interface. =20 @retval EFI_SUCCESS - The region was successfully locked. @retval EFI_DEVICE_ERROR - The region could not be locked because a= t least - one range is still open. + one range is still open. @retval EFI_INVALID_PARAMETER - The descriptor index was out of bounds. **/ EFI_STATUS @@ -142,13 +139,13 @@ 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. + @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient= buffer. + @retval EFI_SUCCESS - The user provided a sufficiently-size= d buffer. **/ EFI_STATUS EFIAPI diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h b= /Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h index f658bac68c..9792bc4099 100644 --- a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h +++ b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h @@ -1,7 +1,7 @@ /** @file Header file for SMM Access Driver. =20 - Copyright (c) 2019, Intel Corporation. All rights reserved.
+ Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent =20 **/ @@ -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 an instance of EFI_PEI_MM_ACCESS_PPI. This PPI is co= mmonly used to control SMM mode memory access for S3 resume. =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 (#53123): https://edk2.groups.io/g/devel/message/53123 Mute This Topic: https://groups.io/mt/69595519/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-