MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Library / BaseLib / LongJump.c

/** @file\r
  Long Jump functions.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
\r
\r
#include "BaseLibInternals.h"\r
\r
/**\r
  Restores the CPU context that was saved with SetJump().\r
\r
  Restores the CPU context from the buffer specified by JumpBuffer. This\r
  function never returns to the caller. Instead is resumes execution based on\r
  the state of JumpBuffer.\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
  If Value is 0, then ASSERT().\r
\r
  @param  JumpBuffer  A pointer to CPU context buffer.\r
  @param  Value       The value to return when the SetJump() context is\r
                      restored and must be non-zero.\r
\r
**/\r
VOID\r
EFIAPI\r
LongJump (\r
  IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer,\r
  IN      UINTN                     Value\r
  )\r
{\r
  InternalAssertJumpBuffer (JumpBuffer);\r
  ASSERT (Value != 0);\r
\r
  InternalLongJump (JumpBuffer, Value);\r
}\r