[PATCH 1/1] UefiCpuPkg/PiSmmCpuDxeSmm: Fix coding style

[PATCH 1/1] UefiCpuPkg/PiSmmCpuDxeSmm: Fix coding style

[Zhang, Shenglei]

1. Update CPUStatus to CpuStatus in comments to align comments
   with code.
2. Add "OUT" attribute for "ProcedureArguments" parameter in function
   header.

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/PiSmmCpuDxeSmm.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
index a0e59f20886b..7b3fbc8b55ec 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
@@ -1311,7 +1311,7 @@ RestoreCr2 (
                                             Note that timeout support is optional. Whether an implementation
                                             supports this feature can be determined via the Attributes data
                                             member.
-  @param[in,out]   CPUStatus                This optional pointer may be used to get the status code returned
+  @param[in,out]   CpuStatus                This optional pointer may be used to get the status code returned
                                             by Procedure when it completes execution on the target AP, or with
                                             EFI_TIMEOUT if the Procedure fails to complete within the optional
                                             timeout. The implementation will update this variable with
@@ -1437,8 +1437,8 @@ InternalSmmStartupAllAPs (
 **/
 EFI_STATUS
 RegisterStartupProcedure (
-  IN EFI_AP_PROCEDURE    Procedure,
-  IN VOID                *ProcedureArguments OPTIONAL
+  IN     EFI_AP_PROCEDURE    Procedure,
+  IN OUT VOID                *ProcedureArguments OPTIONAL
   );
 
 /**
-- 
2.18.0.windows.1

Re: [PATCH 1/1] UefiCpuPkg/PiSmmCpuDxeSmm: Fix coding style

[Laszlo Ersek]

On 08/07/19 04:09, Shenglei Zhang wrote:
> 1. Update CPUStatus to CpuStatus in comments to align comments
>    with code.
> 2. Add "OUT" attribute for "ProcedureArguments" parameter in function
>    header.
> 
> 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/PiSmmCpuDxeSmm.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> index a0e59f20886b..7b3fbc8b55ec 100644
> --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h
> @@ -1311,7 +1311,7 @@ RestoreCr2 (
>                                              Note that timeout support is optional. Whether an implementation
>                                              supports this feature can be determined via the Attributes data
>                                              member.
> -  @param[in,out]   CPUStatus                This optional pointer may be used to get the status code returned
> +  @param[in,out]   CpuStatus                This optional pointer may be used to get the status code returned
>                                              by Procedure when it completes execution on the target AP, or with
>                                              EFI_TIMEOUT if the Procedure fails to complete within the optional
>                                              timeout. The implementation will update this variable with
> @@ -1437,8 +1437,8 @@ InternalSmmStartupAllAPs (
>  **/
>  EFI_STATUS
>  RegisterStartupProcedure (
> -  IN EFI_AP_PROCEDURE    Procedure,
> -  IN VOID                *ProcedureArguments OPTIONAL
> +  IN     EFI_AP_PROCEDURE    Procedure,
> +  IN OUT VOID                *ProcedureArguments OPTIONAL
>    );
>  
>  /**
> 

scrambling to wade through my email backlog after being away for a few
days, so I'm skipping this

thanks
Laszlo