From: "Kubacki, Michael A" <michael.a.kubacki@intel.com>
To: "Chen, Marc W" <marc.w.chen@intel.com>,
"devel@edk2.groups.io" <devel@edk2.groups.io>
Cc: "Chaganty, Rangasai V" <rangasai.v.chaganty@intel.com>,
"Ni, Ray" <ray.ni@intel.com>,
"Gao, Liming" <liming.gao@intel.com>,
"Zhang, Shenglei" <shenglei.zhang@intel.com>
Subject: Re: [edk2-devel][edk2-platforms][PATCH v3] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment
Date: Thu, 9 Jan 2020 16:15:28 +0000 [thread overview]
Message-ID: <BY5PR11MB448412D523D1A3F7FF1F395AB5390@BY5PR11MB4484.namprd11.prod.outlook.com> (raw)
In-Reply-To: <20200109090904.20340-1-marc.w.chen@intel.com>
Reviewed-by: Michael Kubacki <michael.a.kubacki@intel.com>
> -----Original Message-----
> From: Chen, Marc W <marc.w.chen@intel.com>
> Sent: Thursday, January 9, 2020 1:09 AM
> To: devel@edk2.groups.io
> Cc: Kubacki, Michael A <michael.a.kubacki@intel.com>; Chaganty, Rangasai V
> <rangasai.v.chaganty@intel.com>; Ni, Ray <ray.ni@intel.com>; Gao, Liming
> <liming.gao@intel.com>; Zhang, Shenglei <shenglei.zhang@intel.com>;
> Chen, Marc W <marc.w.chen@intel.com>
> Subject: [edk2-devel][edk2-platforms][PATCH v3]
> IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment
>
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2436
>
> Cc: Michael Kubacki <michael.a.kubacki@intel.com>
> Cc: Sai Chaganty <rangasai.v.chaganty@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Shenglei Zhang <shenglei.zhang@intel.com>
> Signed-off-by: Marc Chen <marc.w.chen@intel.com>
> ---
> .../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/PeiSmmAccessLi
> b/PeiSmmAccessLib.c
> b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi
> b/PeiSmmAccessLib.c
> index da141cfa0e..d9bf4fba98 100644
> ---
> a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi
> b/PeiSmmAccessLib.c
> +++
> b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi
> b/PeiSmmAccessLib.c
> @@ -1,7 +1,7 @@
> /** @file
> This is to publish the SMM Access Ppi instance.
>
> - Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> + Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
> SPDX-License-Identifier: BSD-2-Clause-Patent
>
> **/
> @@ -46,9 +46,9 @@ typedef struct {
> The use of "open" means that the memory is visible from all PEIM
> and SMM agents.
>
> - @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 every
> 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.
>
> @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 valid
> for
> compatible SMRAM region.
>
> - @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.
> + @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.
>
> @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.
>
> - @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.
> + @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.
>
> @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.
>
> - @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 information.
> - @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 size
> of the
> + buffer to contain the description information.
> + @param[in, out] SmramMap - Buffer containing the data describing the
> Smram
> + region descriptors.
>
> @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient
> buffer.
> @retval EFI_SUCCESS - The user provided a sufficiently-sized buffer.
> @@ -234,10 +234,7 @@ GetCapabilities (
> /**
> This function is to install an SMM Access PPI
> - <b>Introduction</b> \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.
>
> @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/SmmAc
> cessDriver.c
> b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc
> cessDriver.c
> index 3d3c4ab206..1a52ed4aac 100644
> ---
> a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc
> cessDriver.c
> +++
> b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc
> cessDriver.c
> @@ -2,7 +2,7 @@
> This is the driver that publishes the SMM Access Protocol
> instance for System Agent.
>
> - Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> + Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
> SPDX-License-Identifier: BSD-2-Clause-Patent
>
> **/
> @@ -11,14 +11,24 @@
> static SMM_ACCESS_PRIVATE_DATA mSmmAccess;
>
> /**
> - 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
> + <b>SMM Access Driver Entry Point</b>
> + This driver installs an SMM Access Protocol
> + - <b>Introduction</b> \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 SMRAM
> 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.
> +
> + - <b>Porting Recommendations</b> \n
> + No modification of this module is recommended. Any modification
> should 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
>
> @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.
>
> @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.
>
> @param[in] This - Pointer to the SMRAM Access Interface.
> - @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 information.
> - @param[in] SmramMap - Buffer containing the data describing the
> Smram
> + @param[in, out] SmramMap - Buffer containing the data describing
> the Smram
> region descriptors.
>
> - @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 sufficient
> buffer.
> + @retval EFI_SUCCESS - The user provided a sufficiently-sized buffer.
> **/
> EFI_STATUS
> EFIAPI
> diff --git
> a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc
> cessDriver.h
> b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc
> cessDriver.h
> index c0ff3a250b..bdf43b8158 100644
> ---
> a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc
> cessDriver.h
> +++
> b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAc
> cessDriver.h
> @@ -1,7 +1,7 @@
> /** @file
> Header file for SMM Access Driver.
>
> - Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> + Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
> SPDX-License-Identifier: BSD-2-Clause-Patent
>
> **/
> @@ -59,17 +59,16 @@ typedef struct {
> 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.
>
> - - @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
> -
> - <b>Porting Recommendations</b> \n
> No modification of this module is recommended. Any modification should
> 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
> + @param[in] ImageHandle - Handle for the image of this driver
> + @param[in] SystemTable - Pointer to the EFI System Table
>
> - @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.
>
> @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 agents,
> not from BS or RT code.
>
> - @param[in] This - Pointer to the SMM Access Interface.
> + @param[in] This - Pointer to the SMM Access Interface.
>
> @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..
>
> - @param[in] This - Pointer to the SMM Access Interface.
> + @param[in] This - Pointer to the SMM Access Interface.
>
> @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.
>
> @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 information.
> - @param[in] SmramMap - Buffer containing the data describing the
> Smram
> - region descriptors.
> + @param[in, out] SmramMapSize - Pointer to the variable containing size
> of the
> + buffer to contain the description information.
> + @param[in, out] SmramMap - Buffer containing the data describing
> the Smram
> + region descriptors.
>
> - @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 sufficient
> buffer.
> + @retval EFI_SUCCESS - The user provided a sufficiently-sized 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.
>
> - Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> + Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
> SPDX-License-Identifier: BSD-2-Clause-Patent
>
> **/
> @@ -11,10 +11,7 @@
> /**
> This function is to install an SMM Access PPI
> - <b>Introduction</b> \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.
>
> @retval EFI_SUCCESS - Ppi successfully started and installed.
> @retval EFI_NOT_FOUND - Ppi can't be found.
> --
> 2.16.2.windows.1
prev parent reply other threads:[~2020-01-09 16:15 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-09 9:09 [edk2-devel][edk2-platforms][PATCH v3] IntelSiliconPkg/Feature/SmmAccess/*: Fix incorrect Docygen comment Marc W Chen
2020-01-09 16:15 ` Kubacki, Michael A [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=BY5PR11MB448412D523D1A3F7FF1F395AB5390@BY5PR11MB4484.namprd11.prod.outlook.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox