From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by mx.groups.io with SMTP id smtpd.web11.5311.1578627427769630284 for ; Thu, 09 Jan 2020 19:37:07 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@intel.onmicrosoft.com header.s=selector2-intel-onmicrosoft-com header.b=ZXc+c7CG; spf=pass (domain: intel.com, ip: 192.55.52.43, mailfrom: michael.a.kubacki@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 09 Jan 2020 19:37:07 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,415,1571727600"; d="scan'208";a="229675369" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by fmsmga001.fm.intel.com with ESMTP; 09 Jan 2020 19:37:07 -0800 Received: from fmsmsx158.amr.corp.intel.com (10.18.116.75) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 19:37:07 -0800 Received: from FMSEDG002.ED.cps.intel.com (10.1.192.134) by fmsmsx158.amr.corp.intel.com (10.18.116.75) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 19:37:06 -0800 Received: from NAM04-SN1-obe.outbound.protection.outlook.com (104.47.44.53) by edgegateway.intel.com (192.55.55.69) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 19:37:06 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=IrHlVk0g2DVR1LfW7d/bDPWIWqn5uvVVlTNl2oshmBqEHw3EyW9gaPox8urZLkVMuM0j7hl/j13Yj/c75JdpeqImTHjc1bXGciR4h2zIGcVmGFfWD1e02RBJY63dVF74vx1VaDaw5Y8jWZgkw95MQRnXYGqqeTB/cNVEMahW8yiIDQinNRp9WB+TKRzR1C3kDrYtDm1C42p4Tg6yg2XhZ7yjFXNAy3nPbi/LcISwjLBy5b5Z1C7N1d2fHsRVubs2jyCCVdmbRocbSnG1jQAuVBUzkWdn5RzDjdQqKJVPFjS5Dk6yD13s3Zs/e+d5GCiH2Dp7cYJB45SEWkZmux79/w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=bXHS/d+piWOVmdMtQh786i4O73izcB+4N61z+isucBk=; b=dmB0NW+t+oxi3hLayTXGrXMXHI+1X4yd/qTgK9RIy607QMHLw/5nqY9QqXFkTaRC4kO6JlVGANaURbvy9ocyyJ8supCACsZtgbcrcALhAYSNaEgLPzBseMYj7HOm40LJV8pTLjegf5Dds2cltAQdDWXaRy6fMfe2JICgz3ml4PlNPX0/7ZoRZs9RwVmghXeVI5CGLgBa4JobdVNXavBmuepD/AbSwKuTCvruAVvjTPqOP8NMVe/qcpJLjOj4seCUwTm7aP+3zvYQIpQpcCKO0ELfCL+kjRl/p0QFlmAdkQa7N3rEmvkVOduIwrZL+qBKbRp0d1K0ojeqxqgzLEvy6Q== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=bXHS/d+piWOVmdMtQh786i4O73izcB+4N61z+isucBk=; b=ZXc+c7CGxG7nx8j7TVbeSG2RxhH7s+ohrA/lr406dtGhxtihp2+whbhmIt8TkXU+maj0PtIH7FaX707bXwHywfyHsJuhGiJPdSiGsFTfM702UHbuKm8URCwR3pUGfZImWVbMO0KCHIcMcwts3rpR9H4IcT4Gezuhc+hhOoVQVLc= Received: from BY5PR11MB4484.namprd11.prod.outlook.com (52.132.254.155) by BY5PR11MB3861.namprd11.prod.outlook.com (10.255.162.77) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2623.9; Fri, 10 Jan 2020 03:36:51 +0000 Received: from BY5PR11MB4484.namprd11.prod.outlook.com ([fe80::b9de:29da:2b58:18b3]) by BY5PR11MB4484.namprd11.prod.outlook.com ([fe80::b9de:29da:2b58:18b3%7]) with mapi id 15.20.2623.011; Fri, 10 Jan 2020 03:36:51 +0000 From: "Kubacki, Michael A" To: "Chen, Marc W" , "devel@edk2.groups.io" CC: "Chaganty, Rangasai V" , "Ni, Ray" , "Gao, Liming" , "Zhang, Shenglei" Subject: Re: [edk2-devel][edk2-platforms][PATCH v4] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Thread-Topic: [edk2-devel][edk2-platforms][PATCH v4] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Thread-Index: AQHVx2YbtxkPCVd120+Dz9ZYwv3dmafjPxvQ Date: Fri, 10 Jan 2020 03:36:51 +0000 Message-ID: References: <20200110032832.2128-1-marc.w.chen@intel.com> In-Reply-To: <20200110032832.2128-1-marc.w.chen@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows x-ctpclassification: CTP_NT x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiOGVhYTc0YTAtNzYzNC00ZmMwLWI2MjMtYzk0N2Q2OGYwODAwIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiUFwvMm1jKzNBdEJFYU9zZStzbW5YWnZHMEJzS3h5aWlPOW1aSStiT1wvQ3FidmZBOVBGbkdXdkZxNFRxWmxiRFlvIn0= dlp-reaction: no-action dlp-version: 11.2.0.6 authentication-results: spf=none (sender IP is ) smtp.mailfrom=michael.a.kubacki@intel.com; x-originating-ip: [134.134.136.217] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: fc8718e5-ebc6-4340-e083-08d7957e5491 x-ms-traffictypediagnostic: BY5PR11MB3861: x-ld-processed: 46c98d88-e344-4ed4-8496-4ed7712e255d,ExtAddr x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:8882; x-forefront-prvs: 02788FF38E x-forefront-antispam-report: SFV:NSPM;SFS:(10019020)(366004)(189003)(13464003)(199004)(66556008)(66476007)(64756008)(66946007)(55016002)(76116006)(66446008)(8936002)(81156014)(110136005)(54906003)(8676002)(81166006)(498600001)(86362001)(966005)(9686003)(5660300002)(19273905006)(7696005)(6506007)(53546011)(26005)(71200400001)(107886003)(33656002)(4326008)(52536014)(30864003)(2906002)(186003)(562404015)(563064011);DIR:OUT;SFP:1102;SCL:1;SRVR:BY5PR11MB3861;H:BY5PR11MB4484.namprd11.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;MX:1;A:1; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: +uEgrhRw+YB5Os0+fRdrcooA2zOPNn8di0mRIeONVok60XQu0tdW7sKmcJiHlzxIysr0Na2Ju9p6WnGPjTV9vbCBCFAq+2o3P2FwlRedRuhp36eaWedKmXKRUEilyXO9lpBhOgPXi5893NyX5IK3XlcO72KY0cJTip8OK+NSv728WleXAUVgTIURBoC/I61VQIc+0mBYBwyl/q3LFLCY43sn2LY1mceiMZPCqqSMXM3abxrXAE3quFZs30z78dpVk6zuuT1sx/BALNWCbiwCL4nCzoBxzcw1P21IvIzgl8TolWqiNhI8+GiFvZ+ALxZVFa4UGYbBvR2qW9HHk/Yx9HOsuVijerkD21EfGqn9THj7mWpnMBttzKx4jyI4O3hXm2yBJO1LJNCYLOlkWyF5OmzG0fBzpDgzzHNZjz2llFr4eEEBosD1GVJ21rJWvcH1x+gxQe0TpGLJY8+h133PH1/Ke69qIt2poQqhYqD6AXEKc119JWKO9Makc/z+mbbA/jBgfIR7gz+hSb6odp2Wd3apE0cn++vrRW1V0ePiYQOlQ9w0wiYQDrnz7ubfnpprFYG40rd/GuxXfRaGTYKJmQ== MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: fc8718e5-ebc6-4340-e083-08d7957e5491 X-MS-Exchange-CrossTenant-originalarrivaltime: 10 Jan 2020 03:36:51.1929 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: VmMxFtd/uQ0coVuUaO/ZVpvpCKEDY1I+h98WfJ2lDRzW7Cs2y7J3Gf4ao5sqHcK0NZ6+rgOqXVTGsr2Kd6xdKkQXtbX442lwP0S6LZAYqRo= X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY5PR11MB3861 Return-Path: michael.a.kubacki@intel.com X-OriginatorOrg: intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi Marc, I already added my R-b in V3, that can be used here. I just wanted to note = that it would be nice in the future if you could include a Git note in the = commit that summarizes the changes between patch versions. Thanks, Michael > -----Original Message----- > From: Chen, Marc W > Sent: Thursday, January 9, 2020 7:29 PM > To: devel@edk2.groups.io > Cc: Kubacki, Michael A ; Chaganty, Rangasai = V > ; Ni, Ray ; Gao, Liming > ; Zhang, Shenglei ; Chen, > Marc W > Subject: [edk2-devel][edk2-platforms][PATCH v4] > 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: Ray Ni > Cc: Liming Gao > Cc: Shenglei Zhang > Signed-off-by: Marc Chen > --- > .../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(-) >=20 > diff --git > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib= /P > eiSmmAccessLib.c > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib= /P > eiSmmAccessLib.c > index da141cfa0e..d9bf4fba98 100644 > --- > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib= /P > eiSmmAccessLib.c > +++ > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib= /P > eiSmmAccessLib.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 e= very > PEIM. > + @param[in] PeiServices - General purpose services available t= o 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 becau= se > locked by > @@ -89,9 +89,9 @@ Open ( > This routine accepts a request to "close" a region of SMRAM. This is = valid for > compatible SMRAM region. >=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 Close. > + @param[in] PeiServices - General purpose services available t= o 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 becau= se > 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 ev= ery > 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= every > 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 becau= se 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= 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 an instance of EFI_PEI_MM_ACCESS_PPI. This PPI is > commonly used to control SMM mode memory access for S3 resume. >=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/SmmAccess > Driver.c > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccess > Driver.c > index 3d3c4ab206..1cbce1907c 100644 > --- > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccess > Driver.c > +++ > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccess > Driver.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= by > 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 > protocol to open SMRAM during POST and copy the SMM handler. > + SMM access protocol is also used to close the SMRAM region once the > copying is done. > + Finally, the SMM access protocol provides services to "Lock" the SMR= AM > region. > + 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. > + > + - 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. > + > + @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 > locked by > - chipset. > + @retval EFI_DEVICE_ERROR - The region could not be opened because > locked 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 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. > - @retval EFI_SUCCESS - The user provided a sufficiently-sized= buffer. > + @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficie= nt > buffer. > + @retval EFI_SUCCESS - The user provided a sufficiently-si= zed buffer. > **/ > EFI_STATUS > EFIAPI > diff --git > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccess > Driver.h > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccess > Driver.h > index c0ff3a250b..bcdaef7ba6 100644 > --- > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccess > Driver.h > +++ > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccess > Driver.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= by 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 > protocol to open SMRAM during post and copy the SMM handler. > + The SMM Base driver uses the services provided by the SMM access > protocol to open SMRAM during POST and copy the SMM handler. > SMM access protocol is also used to close the SMRAM region once the > copying is done. > Finally, the SMM access protocol provides services to "Lock" the SMR= AM > region. > 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 > - @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 > locked by > - chipset. > + @retval EFI_DEVICE_ERROR - The region could not be opened because > locked 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 agen= ts, > 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 > locked by > - chipset. > + @retval EFI_DEVICE_ERROR - The region could not be closed because > locked 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= at > 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 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. > + @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficie= nt > buffer. > + @retval EFI_SUCCESS - The user provided a sufficiently-si= zed 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 > basically 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 > commonly used to control SMM mode memory access for S3 resume. >=20 > @retval EFI_SUCCESS - Ppi successfully started and install= ed. > @retval EFI_NOT_FOUND - Ppi can't be found. > -- > 2.16.2.windows.1