UefiCpuPkg/PiSmmCpuDxeSmm: Fix coding style

[edk2-devel] [PATCH v2] UefiCpuPkg/PiSmmCpuDxeSmm: Fix coding style

Posted by Zhang, Shenglei 4 years, 8 months ago

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>
---
v2: Add "OUT" attribute for "ProcedureArguments" parameter in both function
    header and comments,in MpService.c.
 UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c      | 6 +++---
 UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
index 328d7ae53a49..d8d2b6f44461 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
@@ -1967,7 +1967,7 @@ RegisterSmmEntry (
                                        EFI_MP_SERVICES_PROTOCOL.StartupAllAPs.
                                        If caller may pass a value of NULL to deregister any existing
                                        startup procedure.
-  @param[in]      ProcedureArguments   Allows the caller to pass a list of parameters to the code that is
+  @param[in,out]  ProcedureArguments   Allows the caller to pass a list of parameters to the code that is
                                        run by the AP. It is an optional common mailbox between APs and
                                        the caller to share information
 
@@ -1977,8 +1977,8 @@ RegisterSmmEntry (
 **/
 EFI_STATUS
 RegisterStartupProcedure (
-  IN EFI_AP_PROCEDURE    Procedure,
-  IN VOID                *ProcedureArguments OPTIONAL
+  IN     EFI_AP_PROCEDURE    Procedure,
+  IN OUT VOID                *ProcedureArguments OPTIONAL
   )
 {
   if (Procedure == NULL && ProcedureArguments != NULL) {
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


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#45148): https://edk2.groups.io/g/devel/message/45148
Mute This Topic: https://groups.io/mt/32796387/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2] UefiCpuPkg/PiSmmCpuDxeSmm: Fix coding style

Posted by Dong, Eric 4 years, 8 months ago

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

> -----Original Message-----
> From: Zhang, Shenglei
> Sent: Thursday, August 8, 2019 3:55 PM
> To: devel@edk2.groups.io
> Cc: Dong, Eric <eric.dong@intel.com>; Ni, Ray <ray.ni@intel.com>; Laszlo
> Ersek <lersek@redhat.com>
> Subject: [PATCH v2] UefiCpuPkg/PiSmmCpuDxeSmm: Fix coding style
> 
> 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>
> ---
> v2: Add "OUT" attribute for "ProcedureArguments" parameter in both
> function
>     header and comments,in MpService.c.
>  UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c      | 6 +++---
>  UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 6 +++---
>  2 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> index 328d7ae53a49..d8d2b6f44461 100644
> --- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c
> @@ -1967,7 +1967,7 @@ RegisterSmmEntry (
>                                         EFI_MP_SERVICES_PROTOCOL.StartupAllAPs.
>                                         If caller may pass a value of NULL to deregister any
> existing
>                                         startup procedure.
> -  @param[in]      ProcedureArguments   Allows the caller to pass a list of
> parameters to the code that is
> +  @param[in,out]  ProcedureArguments   Allows the caller to pass a list of
> parameters to the code that is
>                                         run by the AP. It is an optional common mailbox between
> APs and
>                                         the caller to share information
> 
> @@ -1977,8 +1977,8 @@ RegisterSmmEntry (  **/  EFI_STATUS
> RegisterStartupProcedure (
> -  IN EFI_AP_PROCEDURE    Procedure,
> -  IN VOID                *ProcedureArguments OPTIONAL
> +  IN     EFI_AP_PROCEDURE    Procedure,
> +  IN OUT VOID                *ProcedureArguments OPTIONAL
>    )
>  {
>    if (Procedure == NULL && ProcedureArguments != NULL) { 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


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#45243): https://edk2.groups.io/g/devel/message/45243
Mute This Topic: https://groups.io/mt/32796387/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-