Update function header.

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

diff --git a/MdePkg/Library/BaseLib/Ebc/SetJumpLongJump.c b/MdePkg/Library/BaseLib/Ebc/SetJumpLongJump.c
index 44d393f6b40f2a8ac41c2b77049ea32f2bdedbac..96200d1a2bc914e1f79a148986abe95f57fb332a 100644 (file)
--- a/MdePkg/Library/BaseLib/Ebc/SetJumpLongJump.c
+++ b/MdePkg/Library/BaseLib/Ebc/SetJumpLongJump.c
@@ -1,7 +1,10 @@
 /** @file\r
-  Switch Stack functions.\r
+  Implementation of SetJump() and LongJump() on EBC.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  SetJump() and LongJump() are not currently supported for the EBC processor type.\r
+  Implementation for EBC just returns 0 for SetJump(), and ASSERT() for LongJump().\r
+\r
+  Copyright (c) 2006 - 2008, 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
@@ -11,26 +14,8 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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
+#include "BaseLibInternals.h"\r
 \r
 /**\r
   Saves the current CPU context that can be restored with a call to LongJump() and returns 0.\r
@@ -44,11 +29,13 @@ InternalAssertJumpBuffer (
 \r
   @param  JumpBuffer    A pointer to CPU context buffer.\r
 \r
+  @retval 0 Indicates a return from SetJump().\r
+\r
 **/\r
 UINTN\r
 EFIAPI\r
 SetJump (\r
-  IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer\r
+  OUT      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer\r
   )\r
 {\r
   InternalAssertJumpBuffer (JumpBuffer);\r
@@ -60,7 +47,7 @@ SetJump (
 \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
+  Instead it 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