public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Zhang, Shenglei" <shenglei.zhang@intel.com>
To: devel@edk2.groups.io
Cc: Ray Ni <ray.ni@intel.com>,
	Rangasai V Chaganty <rangasai.v.chaganty@intel.com>
Subject: [PATCH] IntelSiliconPkg/SmmAccess: Update the parameters in comments
Date: Fri,  6 Sep 2019 16:47:06 +0800	[thread overview]
Message-ID: <20190906084709.20192-2-shenglei.zhang@intel.com> (raw)
In-Reply-To: <20190906084709.20192-1-shenglei.zhang@intel.com>

Change the order of parameters in comments to match the order in code,
in PeiSmmAccessLib.c. Add the attribute "out" for parameters.
This is to fix issues reported by ECC.

Cc: Ray Ni <ray.ni@intel.com>
Cc: Rangasai V Chaganty <rangasai.v.chaganty@intel.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
 .../SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c     | 6 +++---
 .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c        | 4 ++--
 .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h        | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
index 2310e611..76b1b23b 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
@@ -46,9 +46,9 @@ typedef struct {
   The use of "open" means that the memory is visible from all PEIM
   and SMM agents.
 
+  @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.
-  @param[in] PeiServices      -  General purpose services available to every PEIM.
 
   @retval EFI_SUCCESS            -  The region was successfully opened.
   @retval EFI_DEVICE_ERROR       -  The region could not be opened because locked by
@@ -195,9 +195,9 @@ Lock (
 
   @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
+  @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.
diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
index bdcacac5..253d8015 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
@@ -229,9 +229,9 @@ 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.
diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
index 647b3a07..c4d881be 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
@@ -140,9 +140,9 @@ 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.
-- 
2.18.0.windows.1


  reply	other threads:[~2019-09-06  8:47 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-06  8:47 [PATCH] Silicon/IntelSiliconPkg: Update the comment format Zhang, Shenglei
2019-09-06  8:47 ` Zhang, Shenglei [this message]
2019-09-06  8:47 ` [PATCH] BoardModulePkg/CmosAccessLib: Remove white ending line Zhang, Shenglei
2019-09-06  8:47 ` [PATCH] UserInterfaceFeaturePkg:Remove white ending line in DSC file Zhang, Shenglei
2019-09-06  8:47 ` [PATCH] DebugFeaturePkg: Remove white space and white ending line Zhang, Shenglei

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=20190906084709.20192-2-shenglei.zhang@intel.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