From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mx.groups.io with SMTP id smtpd.web09.6349.1578560352548530814 for ; Thu, 09 Jan 2020 00:59:12 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@intel.onmicrosoft.com header.s=selector2-intel-onmicrosoft-com header.b=fuleyuHf; spf=pass (domain: intel.com, ip: 192.55.52.120, mailfrom: rangasai.v.chaganty@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 09 Jan 2020 00:59:12 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,413,1571727600"; d="scan'208";a="218306994" Received: from orsmsx106.amr.corp.intel.com ([10.22.225.133]) by fmsmga008.fm.intel.com with ESMTP; 09 Jan 2020 00:59:12 -0800 Received: from orsmsx162.amr.corp.intel.com (10.22.240.85) by ORSMSX106.amr.corp.intel.com (10.22.225.133) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 00:59:11 -0800 Received: from ORSEDG001.ED.cps.intel.com (10.7.248.4) by ORSMSX162.amr.corp.intel.com (10.22.240.85) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 00:59:11 -0800 Received: from NAM10-DM6-obe.outbound.protection.outlook.com (104.47.58.106) by edgegateway.intel.com (134.134.137.100) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 9 Jan 2020 00:59:11 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Xv/Q2rhzg/y3jB1ijNzwGJ2NYV1+pJSQSA2Q+1KxZ2C0iVGYkEAdWU/ao2Z9x0ps6XcO+r0cUiIUrsMToBCKZaQJIyaFD0tqB+XoD9RTIFdmvTSwEDHP9ZTvsLHfrdxi08Uzuq48lNNWdL/sphe46JfkzG2nsQmLcn2qcba1DREeEZHM3fZhoDlYwPy/59TBqcU7Khs2ht/A1TXsl/u/wf/tGMT2YR9YO1dk6v7i3sYygHLQm5p4hhTbUf4CnIDGZik+wxV3N2Qb+OVIoeQ9BQeK0utu59rBwt8R22w5W5GbnrGOKY7js8AVpbQMcmxddY5AoNS4UPftpjOKMVaRuA== 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=sMuTVZWCdtrxnqjDSyMzpT9ahG14LUmegg5QAo1ZYYQ=; b=dGzv08MKeHRqL45O7K4ehVE4ZnTITHnNtbQdAdmSmPGXq/FVwTp5gaQmIpAvhemIVQr8bO3mrkIkfETVDiZiQkc3wuQFVaZmtlX1xzfpWS4gNmSUiuVLsvIIKzqDzBBhpuqVgSvIs2dec4r9CKL4lYseJo+xvbQd9bijHqDqimUd5DrAyGO+jvU4Scn5MwTOTEHpduMhFa1UerIkauuU5pFspxb80CJzRmvrmuEb2nck7ElzzzdyjWIG9c77G1h3Z7/1I0SUGlAar+dur+nvYJ8e4hh4NPs6S9SGCdKY9OZMFD7cA/eNZeookbZdMmEcU65sHqctBg6eeEWj48mtVg== 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=sMuTVZWCdtrxnqjDSyMzpT9ahG14LUmegg5QAo1ZYYQ=; b=fuleyuHfKOwjLhpUru0gJHCQ61ub9jZClwyX17SgBA1lXZM5hjE/+ddUKHdhAt3OTKlNhxykYLTRfs73Zdx2wM9mLC44PKrUNPCUNX7XMqH6V6c0Rxl5+l/NjrslQ4JIFSW8l/he9oXfdRQIEurPH8Y9zSaqwbIZPt5dDfqjwQM= Received: from MN2PR11MB3759.namprd11.prod.outlook.com (20.178.252.145) by MN2PR11MB3680.namprd11.prod.outlook.com (20.178.252.218) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2602.13; Thu, 9 Jan 2020 08:59:10 +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.2602.015; Thu, 9 Jan 2020 08:59:09 +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 v2] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Thread-Topic: [edk2-devel][edk2-platforms][PATCH v2] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Thread-Index: AQHVxrxxmmzIyUTvZ0mYsS/+D45Y66fiBwvQ Date: Thu, 9 Jan 2020 08:59:09 +0000 Message-ID: References: <20200109071324.19060-1-marc.w.chen@intel.com> In-Reply-To: <20200109071324.19060-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.200] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 4f16c47e-32b2-43d6-b598-08d794e230e3 x-ms-traffictypediagnostic: MN2PR11MB3680: 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:8273; x-forefront-prvs: 02778BF158 x-forefront-antispam-report: SFV:NSPM;SFS:(10019020)(366004)(136003)(376002)(396003)(346002)(39860400002)(13464003)(199004)(189003)(54906003)(26005)(5660300002)(8936002)(53546011)(6506007)(316002)(7696005)(9686003)(55016002)(186003)(66946007)(81166006)(76116006)(110136005)(8676002)(81156014)(66556008)(2906002)(966005)(478600001)(33656002)(52536014)(4326008)(107886003)(64756008)(86362001)(71200400001)(30864003)(66476007)(19273905006)(66446008)(562404015)(563064011);DIR:OUT;SFP:1102;SCL:1;SRVR:MN2PR11MB3680;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: wDOam1l9M9mDeaSbzePkbnHpbmtt+iJc/2FJa5S1ytWAFE3IDB+MIlWN8L8IisssjlfIao/znBWsDdCLdYR26kX8eAWcbV3Ka0751zYaaS/Lo+nXnb7UBHtaldbx//R6uSEm5Xn+NSAJCrsM7D8h0S4FFLrPHlyxAhfSeQtI63GknkGgd1S0qeAMVWiHY+4xJHGmiNaQ/tZ2s5Vk0sSKKI28bj3ZXfogVO8g3jImelkbOVBsLDOgoVmpGgsVYyqeNW/bgYAq1LbHBoFh15tCjc6yGcAn9Ls18On11YsskyTPDcVjI7KVBk7yvLmffJpbjsjipFZIPy3Uw4B4FJkI1ZHv0LnEym7o85LAQZS+TjOS1SgYoiyGyXbojeqQXv5k0aVfON+/7RF0NwfSpEp2MQxGORynlerarKVztGzrye2gci9dup7q38Zi2C1sq/iKfbNxCOK0oNs6n/AxljK6xeLCk4VO6nw+B3+GJuwynER4JsixpoJwqK1z+gcKedIcisdPltVVgKLUamilhn2NZU1p7wyHm855TIPdttcBCeHi3TXKTfPUTQ/2nANeO1zc8LHtCnF8Vj+UAIBRJ3hwdf+Oy9NTlUqPnTqYUggPJI+SeuFwVONjMySWhdSCqI9K MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: 4f16c47e-32b2-43d6-b598-08d794e230e3 X-MS-Exchange-CrossTenant-originalarrivaltime: 09 Jan 2020 08:59:09.7545 (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: frVrdULJD1z8UE+52ZocZtO0Em8zS/24RugObqoJQxKYcBcygPBU1Dn+77bU2105NKJa2K6zfIuyMrbOYDO+VfGwsROGjNkMx0a31nRdKf0= X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR11MB3680 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 Minor correction in SmmAccessDriver.c, in the introduction section - Change= "post" to POST as shown below. "The SMM Base driver uses the services provided by the SMM access protocol = to open SMRAM during POST and copy the SMM handler." With that update: Reviewed-by: Sai Chaganty =20 Regards, Sai -----Original Message----- From: Chen, Marc W =20 Sent: Wednesday, January 08, 2020 11:13 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 v2] IntelSiliconPkg/Feature/Smm= Access/*: Fix incorrect Docygen comment REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D2436 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 | 39 ++++++++++--------= ---- .../IntelSiliconPkg/Include/Library/SmmAccessLib.h | 7 ++-- 4 files changed, 59 insertions(+), 59 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..1a52ed4aac 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..bdf43b8158 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 **/ @@ -59,17 +59,16 @@ 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 - @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