Removed MdePkg usage of ModuleName: in file headers

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

diff --git a/MdePkg/Library/BaseLib/SwitchStack.c b/MdePkg/Library/BaseLib/SwitchStack.c
index 353efa8f6e56a31bf426495bbe0dceb36d1129c1..acc0e715ca7c13888881ee0e9348c97d383fc968 100644 (file)
--- a/MdePkg/Library/BaseLib/SwitchStack.c
+++ b/MdePkg/Library/BaseLib/SwitchStack.c
@@ -1,7 +1,7 @@
 /** @file\r
   Switch Stack functions.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2007, Intel Corporation<BR>\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
@@ -10,19 +10,26 @@
   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:  SwitchStack.c\r
-\r
 **/\r
 \r
+//\r
+// Include common header file for this module.\r
+//\r
+\r
+\r
 #include <BaseLibInternals.h>\r
 \r
 /**\r
   Transfers control to a function starting with a new stack.\r
 \r
-  Transfers control to the function specified by EntryPoint using the new stack\r
-  specified by NewStack and passing in the parameters specified by Context1 and\r
-  Context2. Context1 and Context2 are optional and may be NULL. The function\r
-  EntryPoint must never return.\r
+  Transfers control to the function specified by EntryPoint using the\r
+  new stack specified by NewStack and passing in the parameters specified\r
+  by Context1 and Context2.  Context1 and Context2 are optional and may\r
+  be NULL.  The function EntryPoint must never return.  This function\r
+  supports a variable number of arguments following the NewStack parameter.\r
+  These additional arguments are ignored on IA-32, x64, and EBC.\r
+  IPF CPUs expect one additional parameter of type VOID * that specifies\r
+  the new backing store pointer.\r
 \r
   If EntryPoint is NULL, then ASSERT().\r
   If NewStack is NULL, then ASSERT().\r
@@ -40,16 +47,23 @@ VOID
 EFIAPI\r
 SwitchStack (\r
   IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
-  IN      VOID                      *Context1,\r
-  IN      VOID                      *Context2,\r
-  IN      VOID                      *NewStack\r
+  IN      VOID                      *Context1,  OPTIONAL\r
+  IN      VOID                      *Context2,  OPTIONAL\r
+  IN      VOID                      *NewStack,\r
+  ...\r
   )\r
 {\r
-  ASSERT (EntryPoint != NULL && NewStack != NULL);\r
+  VA_LIST    Marker;\r
+\r
+  ASSERT (EntryPoint != NULL);\r
+  ASSERT (NewStack != NULL);\r
+\r
+  VA_START (Marker, NewStack);\r
 \r
-#ifdef MDE_CPU_IPF\r
-  ASSERT (((UINTN)NewStack & 0xf) == 0);\r
-#endif\r
+  InternalSwitchStack (EntryPoint, Context1, Context2, NewStack, Marker);\r
 \r
-  InternalSwitchStack (EntryPoint, Context1, Context2, NewStack);\r
+  //\r
+  // InternalSwitchStack () will never return\r
+  //\r
+  ASSERT (FALSE);\r
 }\r