add internal command header reference

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ebc / SetJumpLongJump.c

/** @file\r
  Switch Stack functions.\r
\r
  Copyright (c) 2006, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
  Module Name:  SetJumpLongJump.c\r
\r
**/\r
//\r
// Include common header file for this module.\r
//\r
#include <BaseLibInternals.h>\r
\r
/**\r
  Worker function that checks ASSERT condition for JumpBuffer\r
\r
  Checks ASSERT condition for 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
\r
  @param  JumpBuffer    A pointer to CPU context buffer.\r
\r
**/\r
VOID\r
InternalAssertJumpBuffer (\r
  IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer\r
  );\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
UINTN\r
EFIAPI\r
SetJump (\r
  IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer\r
  )\r
{\r
  InternalAssertJumpBuffer (JumpBuffer);\r
  return 0;\r
}\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,\r
  IN      UINTN                     Value\r
  )\r
{\r
  //\r
  // This function cannot work on EBC\r
  //\r
  ASSERT (FALSE);\r
}\r