[PATCH] Silicon/IntelSiliconPkg: Update the comment format

[PATCH] Silicon/IntelSiliconPkg: Update the comment format

[Zhang, Shenglei]

To make the comments in IntelSiliconPkg consistent with those in other
packages, update "@exception" to "@retval" and remove "@result"

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        | 2 +-
 .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h        | 6 ++----
 .../Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h    | 6 ++----
 4 files changed, 7 insertions(+), 13 deletions(-)

diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
index da141cfa..2310e611 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
@@ -234,10 +234,8 @@ 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.
+    A module to install a PPI for controlling SMM mode memory access basically for S3 resume usage
+    and publish _EFI_PEI_MM_ACCESS_PPI.
 
     @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/SmmAccessDriver.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
index 3d3c4ab2..bdcacac5 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
@@ -18,7 +18,7 @@ static SMM_ACCESS_PRIVATE_DATA  mSmmAccess;
   @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.
 **/
diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
index c0ff3a25..647b3a07 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
@@ -58,9 +58,7 @@ typedef struct {
     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.
-
-  - @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
+    This driver 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.
@@ -69,7 +67,7 @@ typedef struct {
   @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
 **/
 EFI_STATUS
 EFIAPI
diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h
index f658bac6..cf99df56 100644
--- a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h
+++ b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h
@@ -11,10 +11,8 @@
 /**
   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.
+    A module to install a PPI for controlling SMM mode memory access basically for S3 resume usage
+    and publish _PEI_MM_ACCESS_PPI.
 
     @retval EFI_SUCCESS           - Ppi successfully started and installed.
     @retval EFI_NOT_FOUND         - Ppi can't be found.
-- 
2.18.0.windows.1

[PATCH] IntelSiliconPkg/SmmAccess: Update the parameters in comments

[Zhang, Shenglei]

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

[PATCH] BoardModulePkg/CmosAccessLib: Remove white ending line

[Zhang, Shenglei]

Cc: Eric Dong <eric.dong@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
 .../BoardModulePkg/Library/CmosAccessLib/CmosAccessLib.inf      | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Platform/Intel/BoardModulePkg/Library/CmosAccessLib/CmosAccessLib.inf b/Platform/Intel/BoardModulePkg/Library/CmosAccessLib/CmosAccessLib.inf
index 77ea219f..64ae65c4 100644
--- a/Platform/Intel/BoardModulePkg/Library/CmosAccessLib/CmosAccessLib.inf
+++ b/Platform/Intel/BoardModulePkg/Library/CmosAccessLib/CmosAccessLib.inf
@@ -25,4 +25,4 @@
 
 [Packages]
   MdePkg/MdePkg.dec
-  BoardModulePkg/BoardModulePkg.dec
\ No newline at end of file
+  BoardModulePkg/BoardModulePkg.dec
\ No newline at end of file
-- 
2.18.0.windows.1

[PATCH] UserInterfaceFeaturePkg:Remove white ending line in DSC file

[Zhang, Shenglei]

Cc: Dandan Bi <dandan.bi@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
 .../Intel/UserInterfaceFeaturePkg/UserInterfaceFeaturePkg.dsc   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Platform/Intel/UserInterfaceFeaturePkg/UserInterfaceFeaturePkg.dsc b/Platform/Intel/UserInterfaceFeaturePkg/UserInterfaceFeaturePkg.dsc
index e97bed53..95c26766 100644
--- a/Platform/Intel/UserInterfaceFeaturePkg/UserInterfaceFeaturePkg.dsc
+++ b/Platform/Intel/UserInterfaceFeaturePkg/UserInterfaceFeaturePkg.dsc
@@ -77,4 +77,4 @@
   UserInterfaceFeaturePkg/UserAuthentication/UserAuthenticationSmm.inf
 
 [BuildOptions]
-  *_*_*_CC_FLAGS = -D DISABLE_NEW_DEPRECATED_INTERFACES
\ No newline at end of file
+  *_*_*_CC_FLAGS = -D DISABLE_NEW_DEPRECATED_INTERFACES
\ No newline at end of file
-- 
2.18.0.windows.1

[PATCH] DebugFeaturePkg: Remove white space and white ending line

[Zhang, Shenglei]

Cc: Eric Dong <eric.dong@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
 Platform/Intel/DebugFeaturePkg/AcpiDebug/AcpiDebug.c | 3 +--
 Platform/Intel/DebugFeaturePkg/DebugFeaturePkg.dsc   | 2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/Platform/Intel/DebugFeaturePkg/AcpiDebug/AcpiDebug.c b/Platform/Intel/DebugFeaturePkg/AcpiDebug/AcpiDebug.c
index f9cd8bcb..5ad8d259 100644
--- a/Platform/Intel/DebugFeaturePkg/AcpiDebug/AcpiDebug.c
+++ b/Platform/Intel/DebugFeaturePkg/AcpiDebug/AcpiDebug.c
@@ -487,7 +487,7 @@ InitializeAcpiDebugSmm (
   if (EFI_ERROR (Status)) {
     return Status;
   }
-  
+
   Status = SmmBase2->InSmm (SmmBase2, &InSmm);
   ASSERT_EFI_ERROR (Status);
   if (EFI_ERROR (Status)) {
@@ -519,4 +519,3 @@ InitializeAcpiDebugSmm (
 
   return Status;
 }
-
diff --git a/Platform/Intel/DebugFeaturePkg/DebugFeaturePkg.dsc b/Platform/Intel/DebugFeaturePkg/DebugFeaturePkg.dsc
index 30f57d5d..61046f7a 100644
--- a/Platform/Intel/DebugFeaturePkg/DebugFeaturePkg.dsc
+++ b/Platform/Intel/DebugFeaturePkg/DebugFeaturePkg.dsc
@@ -98,4 +98,4 @@
   DebugFeaturePkg/AcpiDebug/AcpiDebugSmm.inf
 
 [BuildOptions]
-  *_*_*_CC_FLAGS = -D DISABLE_NEW_DEPRECATED_INTERFACES
\ No newline at end of file
+  *_*_*_CC_FLAGS = -D DISABLE_NEW_DEPRECATED_INTERFACES
\ No newline at end of file
-- 
2.18.0.windows.1