Minor grammatical work--mostly adding periods. Sending separately a list of files...

[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 a57d534ae13f3dc51294b7e371ea3b2d0b5876f5..4c0dba55d52f63c2591bd55cf2e2b801218c7cb5 100644 (file)
--- a/MdePkg/Library/BaseLib/Ebc/SetJumpLongJump.c
+++ b/MdePkg/Library/BaseLib/Ebc/SetJumpLongJump.c
@@ -1,35 +1,21 @@
 /** @file\r
-  Switch Stack functions.\r
+  Implementation of SetJump() and LongJump() on EBC.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\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. All rights reserved.<BR>\r
+  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
+  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
 **/\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
-EFIAPI\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
@@ -43,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
@@ -59,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