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

["Dong, Eric" <eric.dong@intel.com>]

Hi Shenglei,

> -----Original Message-----
> From: Zhang, Shenglei
> Sent: Tuesday, July 30, 2019 2:40 PM
> To: devel@edk2.groups.io
> Cc: Dong, Eric <eric.dong@intel.com>; Ni, Ray <ray.ni@intel.com>; Laszlo
> Ersek <lersek@redhat.com>; Zhang, Shenglei <shenglei.zhang@intel.com>
> Subject: [PATCH] UefiCpuPkg/PiSmmCpuDxeSmm: Make comments
> consistent with code
> 
> 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>
> ---
>  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 ef16997547..990dfe6826 100644
> --- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> @@ -1398,7 +1398,7 @@ InternalSmmStartupAllAPs (
> 
>    Wrapper for Procedures.
> 
> -  @param[in]  Buffer              Pointer to PROCEDURE_WRAPPER buffer.
> +  @param[in,out]  Buffer          Pointer to PROCEDURE_WRAPPER buffer.

1.  Please remove "out" attribute for " Buffer" parameter in function header.

> 
>  **/
>  EFI_STATUS
> diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> index 186809f431..c73f13e3c8 100644
> --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> @@ -1295,7 +1295,7 @@ RestoreCr2 (
>    @param[in]       Procedure                The address of the procedure to run
>    @param[in]       CpuIndex                 Target CPU Index
>    @param[in,out]   ProcArguments            The parameter to pass to the
> procedure
> -  @param[in,out]   Token                    This is an optional parameter that allows
> the caller to execute the
> +  @param[in]       Token                    This is an optional parameter that allows

2. Please add "out" attribute for " Token" parameter in function header.

Thanks,
Eric
> the caller to execute the
>                                              procedure in a blocking or non-blocking fashion. If it is
> NULL the
>                                              call is blocking, and the call will not return until the AP
> has
>                                              completed the procedure. If the token is not NULL, the
> call will @@ -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