[edk2-devel] [PATCH v2 1/5] MdePkg/BaseLib: fix comments in ARM* SetJump/LongJump implementations

Leif Lindholm posted 5 patches 2 years, 4 months ago
[edk2-devel] [PATCH v2 1/5] MdePkg/BaseLib: fix comments in ARM* SetJump/LongJump implementations
Posted by Leif Lindholm 2 years, 4 months ago
Drop redundant comment about IPF (clearly copied across from now deleted
code).

Also change
"Instead is resumes execution" ->
"Instead it resumes execution"

Signed-off-by: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
---
 MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S   | 3 +--
 MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm | 3 +--
 MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S       | 3 +--
 MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm     | 3 +--
 4 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S
index 0d902d94d31c..78db9b3d1e78 100644
--- a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S
+++ b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S
@@ -33,7 +33,6 @@ GCC_ASM_EXPORT(InternalLongJump)
 #  value to be returned by SetJump().
 #
 #  If JumpBuffer is NULL, then ASSERT().
-#  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
 #
 #  @param  JumpBuffer    A pointer to CPU context buffer.
 #
@@ -62,7 +61,7 @@ ASM_PFX(SetJump):
 #
 #  Restores the CPU context from the buffer specified by JumpBuffer.
 #  This function never returns to the caller.
-#  Instead is resumes execution based on the state of JumpBuffer.
+#  Instead it resumes execution based on the state of JumpBuffer.
 #
 #  @param  JumpBuffer    A pointer to CPU context buffer.
 #  @param  Value         The value to return when the SetJump() context is restored.
diff --git a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm
index df70f298998e..d8b267addc1a 100644
--- a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm
+++ b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm
@@ -32,7 +32,6 @@
 ;  value to be returned by SetJump().
 ;
 ;  If JumpBuffer is NULL, then ASSERT().
-;  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
 ;
 ;  @param  JumpBuffer    A pointer to CPU context buffer.
 ;
@@ -60,7 +59,7 @@ SetJump
 ;
 ;  Restores the CPU context from the buffer specified by JumpBuffer.
 ;  This function never returns to the caller.
-;  Instead is resumes execution based on the state of JumpBuffer.
+;  Instead it resumes execution based on the state of JumpBuffer.
 ;
 ;  @param  JumpBuffer    A pointer to CPU context buffer.
 ;  @param  Value         The value to return when the SetJump() context is restored.
diff --git a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S
index 82d94faf61e9..e4c1946a28ff 100644
--- a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S
+++ b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S
@@ -19,7 +19,6 @@ GCC_ASM_EXPORT(InternalLongJump)
 #  value to be returned by SetJump().
 #
 #  If JumpBuffer is NULL, then ASSERT().
-#  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
 #
 #  @param  JumpBuffer    A pointer to CPU context buffer.
 #
@@ -42,7 +41,7 @@ ASM_PFX(SetJump):
 #
 #  Restores the CPU context from the buffer specified by JumpBuffer.
 #  This function never returns to the caller.
-#  Instead is resumes execution based on the state of JumpBuffer.
+#  Instead it resumes execution based on the state of JumpBuffer.
 #
 #  @param  JumpBuffer    A pointer to CPU context buffer.
 #  @param  Value         The value to return when the SetJump() context is restored.
diff --git a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm
index 936f722be60f..e1eff758f7ab 100644
--- a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm
+++ b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm
@@ -19,7 +19,6 @@
 ;  value to be returned by SetJump().
 ;
 ;  If JumpBuffer is NULL, then ASSERT().
-;  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
 ;
 ;  @param  JumpBuffer    A pointer to CPU context buffer.
 ;
@@ -42,7 +41,7 @@ SetJump
 ;
 ;  Restores the CPU context from the buffer specified by JumpBuffer.
 ;  This function never returns to the caller.
-;  Instead is resumes execution based on the state of JumpBuffer.
+;  Instead it resumes execution based on the state of JumpBuffer.
 ;
 ;  @param  JumpBuffer    A pointer to CPU context buffer.
 ;  @param  Value         The value to return when the SetJump() context is restored.
-- 
2.30.2



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109075): https://edk2.groups.io/g/devel/message/109075
Mute This Topic: https://groups.io/mt/101600801/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/3901457/1787277/102458076/xyzzy [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH v2 1/5] MdePkg/BaseLib: fix comments in ARM* SetJump/LongJump implementations
Posted by Sami Mujawar 2 years, 4 months ago
Hi Leif,

Thank you for this patch.

These changes look good to me.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 26/09/2023 06:15 pm, Leif Lindholm wrote:
> Drop redundant comment about IPF (clearly copied across from now deleted
> code).
>
> Also change
> "Instead is resumes execution" ->
> "Instead it resumes execution"
>
> Signed-off-by: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> ---
>   MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S   | 3 +--
>   MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm | 3 +--
>   MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S       | 3 +--
>   MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm     | 3 +--
>   4 files changed, 4 insertions(+), 8 deletions(-)
>
> diff --git a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S
> index 0d902d94d31c..78db9b3d1e78 100644
> --- a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S
> +++ b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.S
> @@ -33,7 +33,6 @@ GCC_ASM_EXPORT(InternalLongJump)
>   #  value to be returned by SetJump().
>   #
>   #  If JumpBuffer is NULL, then ASSERT().
> -#  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
>   #
>   #  @param  JumpBuffer    A pointer to CPU context buffer.
>   #
> @@ -62,7 +61,7 @@ ASM_PFX(SetJump):
>   #
>   #  Restores the CPU context from the buffer specified by JumpBuffer.
>   #  This function never returns to the caller.
> -#  Instead is resumes execution based on the state of JumpBuffer.
> +#  Instead it resumes execution based on the state of JumpBuffer.
>   #
>   #  @param  JumpBuffer    A pointer to CPU context buffer.
>   #  @param  Value         The value to return when the SetJump() context is restored.
> diff --git a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm
> index df70f298998e..d8b267addc1a 100644
> --- a/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm
> +++ b/MdePkg/Library/BaseLib/AArch64/SetJumpLongJump.asm
> @@ -32,7 +32,6 @@
>   ;  value to be returned by SetJump().
>   ;
>   ;  If JumpBuffer is NULL, then ASSERT().
> -;  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
>   ;
>   ;  @param  JumpBuffer    A pointer to CPU context buffer.
>   ;
> @@ -60,7 +59,7 @@ SetJump
>   ;
>   ;  Restores the CPU context from the buffer specified by JumpBuffer.
>   ;  This function never returns to the caller.
> -;  Instead is resumes execution based on the state of JumpBuffer.
> +;  Instead it resumes execution based on the state of JumpBuffer.
>   ;
>   ;  @param  JumpBuffer    A pointer to CPU context buffer.
>   ;  @param  Value         The value to return when the SetJump() context is restored.
> diff --git a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S
> index 82d94faf61e9..e4c1946a28ff 100644
> --- a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S
> +++ b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.S
> @@ -19,7 +19,6 @@ GCC_ASM_EXPORT(InternalLongJump)
>   #  value to be returned by SetJump().
>   #
>   #  If JumpBuffer is NULL, then ASSERT().
> -#  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
>   #
>   #  @param  JumpBuffer    A pointer to CPU context buffer.
>   #
> @@ -42,7 +41,7 @@ ASM_PFX(SetJump):
>   #
>   #  Restores the CPU context from the buffer specified by JumpBuffer.
>   #  This function never returns to the caller.
> -#  Instead is resumes execution based on the state of JumpBuffer.
> +#  Instead it resumes execution based on the state of JumpBuffer.
>   #
>   #  @param  JumpBuffer    A pointer to CPU context buffer.
>   #  @param  Value         The value to return when the SetJump() context is restored.
> diff --git a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm
> index 936f722be60f..e1eff758f7ab 100644
> --- a/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm
> +++ b/MdePkg/Library/BaseLib/Arm/SetJumpLongJump.asm
> @@ -19,7 +19,6 @@
>   ;  value to be returned by SetJump().
>   ;
>   ;  If JumpBuffer is NULL, then ASSERT().
> -;  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
>   ;
>   ;  @param  JumpBuffer    A pointer to CPU context buffer.
>   ;
> @@ -42,7 +41,7 @@ SetJump
>   ;
>   ;  Restores the CPU context from the buffer specified by JumpBuffer.
>   ;  This function never returns to the caller.
> -;  Instead is resumes execution based on the state of JumpBuffer.
> +;  Instead it resumes execution based on the state of JumpBuffer.
>   ;
>   ;  @param  JumpBuffer    A pointer to CPU context buffer.
>   ;  @param  Value         The value to return when the SetJump() context is restored.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109200): https://edk2.groups.io/g/devel/message/109200
Mute This Topic: https://groups.io/mt/101600801/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-