MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Library / BaseLib / Arm / SetJumpLongJump.S

#------------------------------------------------------------------------------\r
#\r
# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
#------------------------------------------------------------------------------\r
.text\r
.p2align 2\r
\r
GCC_ASM_EXPORT(SetJump)\r
GCC_ASM_EXPORT(InternalLongJump)\r
\r
#/**\r
#  Saves the current CPU context that can be restored with a call to LongJump() and returns 0.#\r
#\r
#  Saves the current CPU context in the buffer specified by JumpBuffer and returns 0.  The initial\r
#  call to SetJump() must always return 0.  Subsequent calls to LongJump() cause a non-zero\r
#  value to be returned by SetJump().\r
#\r
#  If JumpBuffer is NULL, then ASSERT().\r
#  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().\r
#\r
#  @param  JumpBuffer    A pointer to CPU context buffer.\r
#\r
#**/\r
#\r
#UINTN\r
#EFIAPI\r
#SetJump (\r
#  IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer  // R0\r
#  );\r
#\r
ASM_PFX(SetJump):\r
  mov   r3, r13\r
  stmia r0, {r3-r12,r14}\r
  eor   r0, r0, r0\r
  bx    lr\r
\r
#/**\r
#  Restores the CPU context that was saved with SetJump().#\r
#\r
#  Restores the CPU context from the buffer specified by JumpBuffer.\r
#  This function never returns to the caller.\r
#  Instead is resumes execution based on the state of JumpBuffer.\r
#\r
#  @param  JumpBuffer    A pointer to CPU context buffer.\r
#  @param  Value         The value to return when the SetJump() context is restored.\r
#\r
#**/\r
#VOID\r
#EFIAPI\r
#InternalLongJump (\r
#  IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer,  // R0\r
#  IN      UINTN                     Value         // R1\r
#  );\r
#\r
ASM_PFX(InternalLongJump):\r
  ldmia  r0, {r3-r12,r14}\r
  mov    r13, r3\r
  mov    r0, r1\r
  bx     lr\r
\r
ASM_FUNCTION_REMOVE_IF_UNREFERENCED\r