[PATCH v2 1/1] UefiCpuPkg/PiSmmCpuDxeSmm: Make code consistent with comments

[PATCH v2 1/1] UefiCpuPkg/PiSmmCpuDxeSmm: Make code consistent with comments

[Zhang, Shenglei]

From: shenglei <shenglei.zhang@intel.com>

1.Remove "out" attribute for " Buffer" parameter in function header.
2.Add "out" attribute for " Token" parameter in function header.
3.Update ProcedureArgument to ProcedureArguments.

Cc: Eric Dong <eric.dong@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
v2:In v1 update comments consistent with code
   In v2 update code consistent with comments
 UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c      | 2 +-
 UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
index ef16997547b8..328d7ae53a49 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
@@ -1404,7 +1404,7 @@ InternalSmmStartupAllAPs (
 EFI_STATUS
 EFIAPI
 ProcedureWrapper (
-  IN OUT VOID *Buffer
+  IN     VOID *Buffer
   )
 {
   PROCEDURE_WRAPPER *Wrapper;
diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
index 186809f43119..a0e59f20886b 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
@@ -1329,7 +1329,7 @@ InternalSmmStartupThisAp (
   IN      EFI_AP_PROCEDURE2              Procedure,
   IN      UINTN                          CpuIndex,
   IN OUT  VOID                           *ProcArguments OPTIONAL,
-  IN      MM_COMPLETION                  *Token,
+  IN OUT  MM_COMPLETION                  *Token,
   IN      UINTN                          TimeoutInMicroseconds,
   IN OUT  EFI_STATUS                     *CpuStatus
   );
@@ -1387,7 +1387,7 @@ IsPresentAp (
   @param[in]     TimeoutInMicroseconds   Indicates the time limit in microseconds for
                                          APs to return from Procedure, either for
                                          blocking or non-blocking mode.
-  @param[in,out] ProcedureArgument       The parameter passed into Procedure for
+  @param[in,out] ProcedureArguments      The parameter passed into Procedure for
                                          all APs.
   @param[in,out] Token                   This is an optional parameter that allows the caller to execute the
                                          procedure in a blocking or non-blocking fashion. If it is NULL the
-- 
2.18.0.windows.1

Re: [PATCH v2 1/1] UefiCpuPkg/PiSmmCpuDxeSmm: Make code consistent with comments

[Dong, Eric]

Reviewed-by: Eric Dong <eric.dong@intel.com>

> -----Original Message-----
> From: Zhang, Shenglei
> Sent: Wednesday, July 31, 2019 11:38 AM
> To: devel@edk2.groups.io
> Cc: Zhang, Shenglei <shenglei.zhang@intel.com>; Dong, Eric
> <eric.dong@intel.com>; Ni, Ray <ray.ni@intel.com>; Laszlo Ersek
> <lersek@redhat.com>
> Subject: [PATCH v2 1/1] UefiCpuPkg/PiSmmCpuDxeSmm: Make code
> consistent with comments
> 
> From: shenglei <shenglei.zhang@intel.com>
> 
> 1.Remove "out" attribute for " Buffer" parameter in function header.
> 2.Add "out" attribute for " Token" parameter in function header.
> 3.Update ProcedureArgument to ProcedureArguments.
> 
> Cc: Eric Dong <eric.dong@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
> ---
> v2:In v1 update comments consistent with code
>    In v2 update code consistent with comments
>  UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c      | 2 +-
>  UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> index ef16997547b8..328d7ae53a49 100644
> --- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> @@ -1404,7 +1404,7 @@ InternalSmmStartupAllAPs (  EFI_STATUS  EFIAPI
> ProcedureWrapper (
> -  IN OUT VOID *Buffer
> +  IN     VOID *Buffer
>    )
>  {
>    PROCEDURE_WRAPPER *Wrapper;
> diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> index 186809f43119..a0e59f20886b 100644
> --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> @@ -1329,7 +1329,7 @@ InternalSmmStartupThisAp (
>    IN      EFI_AP_PROCEDURE2              Procedure,
>    IN      UINTN                          CpuIndex,
>    IN OUT  VOID                           *ProcArguments OPTIONAL,
> -  IN      MM_COMPLETION                  *Token,
> +  IN OUT  MM_COMPLETION                  *Token,
>    IN      UINTN                          TimeoutInMicroseconds,
>    IN OUT  EFI_STATUS                     *CpuStatus
>    );
> @@ -1387,7 +1387,7 @@ IsPresentAp (
>    @param[in]     TimeoutInMicroseconds   Indicates the time limit in
> microseconds for
>                                           APs to return from Procedure, either for
>                                           blocking or non-blocking mode.
> -  @param[in,out] ProcedureArgument       The parameter passed into
> Procedure for
> +  @param[in,out] ProcedureArguments      The parameter passed into
> Procedure for
>                                           all APs.
>    @param[in,out] Token                   This is an optional parameter that allows
> the caller to execute the
>                                           procedure in a blocking or non-blocking fashion. If it is
> NULL the
> --
> 2.18.0.windows.1