[PATCH 0/1] MdePkg/Library/BaseLib/AArch64: Comment style harmonization

[PATCH 0/1] MdePkg/Library/BaseLib/AArch64: Comment style harmonization

[Pete Batard]

This is a follow up on VS2017/ARM64 support, where we found that the assembly for
SwitchStack did not use the same kind of comments as the other assembly files.

Regards,

/Pete

Pete Batard (1):
  MdePkg/Library/BaseLib/AArch64: Comment style harmonization

 MdePkg/Library/BaseLib/AArch64/SwitchStack.S   | 96 ++++++++++----------
 MdePkg/Library/BaseLib/AArch64/SwitchStack.asm | 96 ++++++++++----------
 2 files changed, 98 insertions(+), 94 deletions(-)

-- 
2.9.3.windows.2

[PATCH 1/1] MdePkg/Library/BaseLib/AArch64: Comment style harmonization

[Pete Batard]

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Pete Batard <pete@akeo.ie>
---
 MdePkg/Library/BaseLib/AArch64/SwitchStack.S   | 96 ++++++++++----------
 MdePkg/Library/BaseLib/AArch64/SwitchStack.asm | 96 ++++++++++----------
 2 files changed, 98 insertions(+), 94 deletions(-)

diff --git a/MdePkg/Library/BaseLib/AArch64/SwitchStack.S b/MdePkg/Library/BaseLib/AArch64/SwitchStack.S
index c3ac8d7e4dfe..c39fa75b2892 100644
--- a/MdePkg/Library/BaseLib/AArch64/SwitchStack.S
+++ b/MdePkg/Library/BaseLib/AArch64/SwitchStack.S
@@ -1,17 +1,17 @@
-//------------------------------------------------------------------------------
-//
-// Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
-// Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
-// Portions copyright (c) 2011 - 2013, ARM Limited. All rights reserved.<BR>
-// This program and the accompanying materials
-// are licensed and made available under the terms and conditions of the BSD License
-// which accompanies this distribution.  The full text of the license may be found at
-// http://opensource.org/licenses/bsd-license.php.
-//
-// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-//
-//------------------------------------------------------------------------------
+#------------------------------------------------------------------------------
+#
+# Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
+# Portions copyright (c) 2011 - 2013, ARM Limited. All rights reserved.<BR>
+# This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD License
+# which accompanies this distribution.  The full text of the license may be found at
+# http://opensource.org/licenses/bsd-license.php.
+#
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+#
+#------------------------------------------------------------------------------
 
 .text
 .align 5
@@ -19,26 +19,27 @@
 GCC_ASM_EXPORT(InternalSwitchStackAsm)
 GCC_ASM_EXPORT(CpuPause)
 
-/**
-//
-//  This allows the caller to switch the stack and goes to the new entry point
-//
-// @param      EntryPoint   The pointer to the location to enter
-// @param      Context      Parameter to pass in
-// @param      Context2     Parameter2 to pass in
-// @param      NewStack     New Location of the stack
-//
-// @return     Nothing. Goes to the Entry Point passing in the new parameters
-//
-VOID
-EFIAPI
-InternalSwitchStackAsm (
-  SWITCH_STACK_ENTRY_POINT EntryPoint,
-  VOID  *Context,
-  VOID  *Context2,
-  VOID  *NewStack
-  );
-**/
+#/**
+#
+#  This allows the caller to switch the stack and goes to the new entry point
+#
+# @param      EntryPoint   The pointer to the location to enter
+# @param      Context      Parameter to pass in
+# @param      Context2     Parameter2 to pass in
+# @param      NewStack     New Location of the stack
+#
+# @return     Nothing. Goes to the Entry Point passing in the new parameters
+#
+#**/
+#VOID
+#EFIAPI
+#InternalSwitchStackAsm (
+#  SWITCH_STACK_ENTRY_POINT EntryPoint,
+#  VOID  *Context,
+#  VOID  *Context2,
+#  VOID  *NewStack
+#  );
+#
 ASM_PFX(InternalSwitchStackAsm):
     mov   x29, #0
     mov   x30, x0
@@ -47,19 +48,20 @@ ASM_PFX(InternalSwitchStackAsm):
     mov   x1, x2
     ret
 
-/**
-//
-//  Requests CPU to pause for a short period of time.
-//
-//  Requests CPU to pause for a short period of time. Typically used in MP
-//  systems to prevent memory starvation while waiting for a spin lock.
-//
-VOID
-EFIAPI
-CpuPause (
-  VOID
-  )
-**/
+#/**
+#
+#  Requests CPU to pause for a short period of time.
+#
+#  Requests CPU to pause for a short period of time. Typically used in MP
+#  systems to prevent memory starvation while waiting for a spin lock.
+#
+#**/
+#VOID
+#EFIAPI
+#CpuPause (
+#  VOID
+#  )
+#
 ASM_PFX(CpuPause):
     nop
     nop
diff --git a/MdePkg/Library/BaseLib/AArch64/SwitchStack.asm b/MdePkg/Library/BaseLib/AArch64/SwitchStack.asm
index c1b2de07e205..2639547c6145 100644
--- a/MdePkg/Library/BaseLib/AArch64/SwitchStack.asm
+++ b/MdePkg/Library/BaseLib/AArch64/SwitchStack.asm
@@ -1,42 +1,43 @@
-//------------------------------------------------------------------------------
-//
-// Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
-// Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
-// Portions copyright (c) 2011 - 2013, ARM Limited. All rights reserved.<BR>
-// This program and the accompanying materials
-// are licensed and made available under the terms and conditions of the BSD License
-// which accompanies this distribution.  The full text of the license may be found at
-// http://opensource.org/licenses/bsd-license.php.
-//
-// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-//
-//------------------------------------------------------------------------------
+;------------------------------------------------------------------------------
+;
+; Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+; Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
+; Portions copyright (c) 2011 - 2013, ARM Limited. All rights reserved.<BR>
+; This program and the accompanying materials
+; are licensed and made available under the terms and conditions of the BSD License
+; which accompanies this distribution.  The full text of the license may be found at
+; http://opensource.org/licenses/bsd-license.php.
+;
+; THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+; WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+;
+;------------------------------------------------------------------------------
 
   EXPORT InternalSwitchStackAsm
   EXPORT CpuPause
   AREA BaseLib_LowLevel, CODE, READONLY
 
-/**
-//
-//  This allows the caller to switch the stack and goes to the new entry point
-//
-// @param      EntryPoint   The pointer to the location to enter
-// @param      Context      Parameter to pass in
-// @param      Context2     Parameter2 to pass in
-// @param      NewStack     New Location of the stack
-//
-// @return     Nothing. Goes to the Entry Point passing in the new parameters
-//
-VOID
-EFIAPI
-InternalSwitchStackAsm (
-  SWITCH_STACK_ENTRY_POINT EntryPoint,
-  VOID  *Context,
-  VOID  *Context2,
-  VOID  *NewStack
-  );
-**/
+;/**
+;
+;  This allows the caller to switch the stack and goes to the new entry point
+;
+; @param      EntryPoint   The pointer to the location to enter
+; @param      Context      Parameter to pass in
+; @param      Context2     Parameter2 to pass in
+; @param      NewStack     New Location of the stack
+;
+; @return     Nothing. Goes to the Entry Point passing in the new parameters
+;
+;**/
+;VOID
+;EFIAPI
+;InternalSwitchStackAsm (
+;  SWITCH_STACK_ENTRY_POINT EntryPoint,
+;  VOID  *Context,
+;  VOID  *Context2,
+;  VOID  *NewStack
+;  );
+;
 InternalSwitchStackAsm
     mov   x29, #0
     mov   x30, x0
@@ -45,19 +46,20 @@ InternalSwitchStackAsm
     mov   x1, x2
     ret
 
-/**
-//
-//  Requests CPU to pause for a short period of time.
-//
-//  Requests CPU to pause for a short period of time. Typically used in MP
-//  systems to prevent memory starvation while waiting for a spin lock.
-//
-VOID
-EFIAPI
-CpuPause (
-  VOID
-  )
-**/
+;/**
+;
+;  Requests CPU to pause for a short period of time.
+;
+;  Requests CPU to pause for a short period of time. Typically used in MP
+;  systems to prevent memory starvation while waiting for a spin lock.
+;
+;**/
+;VOID
+;EFIAPI
+;CpuPause (
+;  VOID
+;  )
+;
 CpuPause
     nop
     nop
-- 
2.9.3.windows.2

Re: [PATCH 0/1] MdePkg/Library/BaseLib/AArch64: Comment style harmonization

[Gao, Liming]

Reviewed-by: Liming Gao <liming.gao@intel.com>

> -----Original Message-----
> From: Pete Batard [mailto:pete@akeo.ie]
> Sent: Monday, March 19, 2018 8:48 PM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming <liming.gao@intel.com>
> Subject: [PATCH 0/1] MdePkg/Library/BaseLib/AArch64: Comment style harmonization
> 
> This is a follow up on VS2017/ARM64 support, where we found that the assembly for
> SwitchStack did not use the same kind of comments as the other assembly files.
> 
> Regards,
> 
> /Pete
> 
> Pete Batard (1):
>   MdePkg/Library/BaseLib/AArch64: Comment style harmonization
> 
>  MdePkg/Library/BaseLib/AArch64/SwitchStack.S   | 96 ++++++++++----------
>  MdePkg/Library/BaseLib/AArch64/SwitchStack.asm | 96 ++++++++++----------
>  2 files changed, 98 insertions(+), 94 deletions(-)
> 
> --
> 2.9.3.windows.2