1. Added Non-existing.c in BaseLib to assert no invocations of SwitchStack() on IPF.

[mirror_edk2.git] / EdkModulePkg / Core / DxeIplPeim / DxeIpl.h

diff --git a/EdkModulePkg/Core/DxeIplPeim/DxeIpl.h b/EdkModulePkg/Core/DxeIplPeim/DxeIpl.h
index 5e350428613f99290cc3e6f88c5392d08838e302..9e626a7dc79f7d3fa72b565863c37b3f263a35ad 100644 (file)
--- a/EdkModulePkg/Core/DxeIplPeim/DxeIpl.h
+++ b/EdkModulePkg/Core/DxeIplPeim/DxeIpl.h
@@ -1,13 +1,13 @@
 /*++\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
+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:\r
 \r
@@ -25,15 +25,37 @@ Abstract:
 \r
 extern BOOLEAN gInMemory;\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
+\r
+  If EntryPoint is NULL, then ASSERT().\r
+  If NewStack is NULL, then ASSERT().\r
+\r
+  @param  EntryPoint  A pointer to function to call with the new stack.\r
+  @param  Context1    A pointer to the context to pass into the EntryPoint\r
+                      function.\r
+  @param  Context2    A pointer to the context to pass into the EntryPoint\r
+                      function.\r
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
+                      function.\r
+  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's\r
+                      Reserved on other architectures.\r
+\r
+**/\r
 VOID\r
+EFIAPI\r
 SwitchIplStacks (\r
-  VOID  *EntryPoint,\r
-  UINTN Parameter1,\r
-  UINTN Parameter2,\r
-  VOID  *NewStack,\r
-  VOID  *NewBsp\r
-  )\r
-;\r
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
+  IN      VOID                      *Context1,  OPTIONAL\r
+  IN      VOID                      *Context2,  OPTIONAL\r
+  IN      VOID                      *NewStack,\r
+  IN      VOID                      *NewBsp\r
+  );\r
 \r
 EFI_STATUS\r
 PeiFindFile (\r
@@ -133,7 +155,7 @@ CreateIdentityMappingPageTables (
 \r
 VOID\r
 ActivateLongMode (\r
-  IN  EFI_PHYSICAL_ADDRESS  PageTables,  \r
+  IN  EFI_PHYSICAL_ADDRESS  PageTables,\r
   IN  EFI_PHYSICAL_ADDRESS  HobStart,\r
   IN  EFI_PHYSICAL_ADDRESS  Stack,\r
   IN  EFI_PHYSICAL_ADDRESS  CodeEntryPoint1,\r