From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by mx.groups.io with SMTP id smtpd.web11.6574.1578636523398960568 for ; Thu, 09 Jan 2020 22:08:43 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@intel.onmicrosoft.com header.s=selector2-intel-onmicrosoft-com header.b=wnGOeg4L; spf=pass (domain: intel.com, ip: 192.55.52.136, mailfrom: rangasai.v.chaganty@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 09 Jan 2020 22:08:43 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,415,1571727600"; d="scan'208";a="423484308" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by fmsmga006.fm.intel.com with ESMTP; 09 Jan 2020 22:08:43 -0800 Received: from FMSMSX110.amr.corp.intel.com (10.18.116.10) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 22:08:42 -0800 Received: from FMSEDG001.ED.cps.intel.com (10.1.192.133) by fmsmsx110.amr.corp.intel.com (10.18.116.10) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 22:08:42 -0800 Received: from NAM12-DM6-obe.outbound.protection.outlook.com (104.47.59.176) by edgegateway.intel.com (192.55.55.68) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 22:08:42 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=AaHnrtp7laertci7tpO8i1nMjO8nUFUculNAmHd6J91tTfQ94kMQ8290o04Tbp9yPwTeFmqaPzFPuVMxXDXMAa7o7k6pZsCiuNcxpghnXbOWvd87CuGeOFBFUMfcso9En4v2NGij1lZlgSv3HA/1NIWtVJj9yfRsuF8cfdHb/Jm+pX5/Rkefg6DVw5q7DybnrBt2a6JO0y5SQO7ublqIQQTbyXptQNT1Mh6e2Re/rC87NhXzXkAQqLMlJglGsxad0GTi0Zx2or/VnhYSC3zAvSGJ/DYj4xBLo832TdE3oU7bvfFOBmwVjDkjHB7G5qmMQmi0FcoHgeTDMijj0b/RCg== 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=zstbTIfN+O0K6b4D3+JB+E9sXlEwChhao4gMhI/9f88=; b=ghyBzmQN+jL2oPTSnHVTzIxn70bIAiHaBUZosIHEjAzetRCD9p2cgTMIbu3ETsPE3JC6vFt8ojOIcHBO/8gpls26Owgm3gPbopHzV4n9nqIYQQJ/dNLKV84KL2G4L/zqn2IU+uvOO1wgWwYnzTsHZFU2tem1k41OlSy8f7cQnPNS+FJ1h43plixFnPjIO9RUmmQSlT38+eMYrQHTKEvIKmCE0x+rGiz+Du4ZO6WKKeV6ukPdg/N1l9pXop7pxB+HchJwEoHJq0hN8hXu2h5JPuL9h/amqA5UuIGSIjDZICkshpt12mZf8lr8bzy8vfsebzHgQQKWqi6EAZief04nsQ== 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=zstbTIfN+O0K6b4D3+JB+E9sXlEwChhao4gMhI/9f88=; b=wnGOeg4LLKpejDocFQ4C5leFUmaYIuzJNidEV/Q6OyWK/83kO2+cR3HJpy/QVR5JcuXg0IRYS8T3qyZaFrdjR1+JyS+PE8E0fsi7dmNCRnVI6z0lsAYZEuqi7fPhc0lI4yK1jqpRDFpfHfT9j6G7SbjNpQU0g39Lmr8ue88TMl0= Received: from MN2PR11MB3759.namprd11.prod.outlook.com (20.178.252.145) by MN2PR11MB4144.namprd11.prod.outlook.com (20.179.150.210) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2623.10; Fri, 10 Jan 2020 06:08:40 +0000 Received: from MN2PR11MB3759.namprd11.prod.outlook.com ([fe80::79e4:57e0:942:f73e]) by MN2PR11MB3759.namprd11.prod.outlook.com ([fe80::79e4:57e0:942:f73e%3]) with mapi id 15.20.2623.011; Fri, 10 Jan 2020 06:08:40 +0000 From: "Chaganty, Rangasai V" To: "Chen, Marc W" , "devel@edk2.groups.io" CC: "Kubacki, Michael A" , "Ni, Ray" , "Gao, Liming" , "Zhang, Shenglei" Subject: Re: [edk2-devel][edk2-platforms][PATCH v5] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Doxygen comment Thread-Topic: [edk2-devel][edk2-platforms][PATCH v5] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Doxygen comment Thread-Index: AQHVx3W73AtbBkv/2E+cajlzo2FSlafjaVsQ Date: Fri, 10 Jan 2020 06:08:40 +0000 Message-ID: References: <20200110052023.3928-1-marc.w.chen@intel.com> In-Reply-To: <20200110052023.3928-1-marc.w.chen@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-reaction: no-action dlp-version: 11.2.0.6 dlp-product: dlpe-windows authentication-results: spf=none (sender IP is ) smtp.mailfrom=rangasai.v.chaganty@intel.com; x-originating-ip: [192.55.52.192] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 32224b53-ef8b-4b26-4b0f-08d7959389ea x-ms-traffictypediagnostic: MN2PR11MB4144: 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:7691; x-forefront-prvs: 02788FF38E x-forefront-antispam-report: SFV:NSPM;SFS:(10019020)(346002)(366004)(376002)(39860400002)(396003)(136003)(199004)(13464003)(189003)(26005)(186003)(6506007)(54906003)(52536014)(2906002)(53546011)(110136005)(66556008)(5660300002)(81156014)(64756008)(66446008)(9686003)(8676002)(8936002)(107886003)(76116006)(81166006)(86362001)(66476007)(55016002)(66946007)(30864003)(19273905006)(71200400001)(4326008)(7696005)(316002)(33656002)(478600001)(966005)(562404015)(563064011);DIR:OUT;SFP:1102;SCL:1;SRVR:MN2PR11MB4144;H:MN2PR11MB3759.namprd11.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;A:1;MX:1; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: hJhuvkEzui/D7fO2A5lqK7BoNasIAFPOIsEaiUyqRN859tkSF7a+pBaD+wxsT47jAA172n2SzcwRCYQ7R8XvHM/unv8AO2oMjrmyZfLcFhTbPi2X+An/WZ7we8ykimx2ceVDPm5/gsNP35Z0JLeY13vAbo8AMtjBYALUvUwp/mu0FYP0PJQxsi+bPglhvCkDnND0TLmS7i6q/TclXglYttA2Py1ekLtsHG+KAp1TkBCfG2r8BJ0ZHLxcqIyYLXIc3m3qJugkh7B2MjusyShhomfpmpDLJepNnMR8AfH65/UO6ljTBiXpDGqFiZ1lEo8WXJybEy/dLrT3dl/rYUjAhuazhsLNaHA637B4Wv+kurWDZq2FNXVkA/4bIzHWSDhnoIx1A5Fsh+HvRjSyJ38WDYdTs2TJAojMw7BLcbwpvVm0XqyYEIS/Bd3npwz3Rvtmb7uMFD2ZECQpMoharNCyil2H+76skhQIIJzGLLk0OaxkVIlEC7dmKTNIUArVBa855mPspnxBm2smGUD3YqjPwWRPibV9d56KjTYSm+nK4NMgHZAKh1S7uC3qhHyCG+4cEWnNjGF3MpfT32btqGQw6w== MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: 32224b53-ef8b-4b26-4b0f-08d7959389ea X-MS-Exchange-CrossTenant-originalarrivaltime: 10 Jan 2020 06:08:40.0929 (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: BKbuRla/dsw1sXgn0/zVOdRwS1nVE2Olb0kxMQ8l0n2UMNsDIzk0nCJezVyVKKbwzAPbIBI9B+wMypHXELg+vi0sof21v3K7jV2Tc2flaWc= X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR11MB4144 Return-Path: rangasai.v.chaganty@intel.com X-OriginatorOrg: intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Sai Chaganty -----Original Message----- From: Chen, Marc W =20 Sent: Thursday, January 09, 2020 9:20 PM To: devel@edk2.groups.io Cc: Kubacki, Michael A ; Chaganty, Rangasai V = ; Ni, Ray ; Gao, Liming ; Zhang, Shenglei ; Chen, Mar= c W Subject: [edk2-devel][edk2-platforms][PATCH v5] IntelSiliconPkg/Feature/Smm= Access/*: Fix incorrect Doxygen comment 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 --- .../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