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

2. Added SwitchIplStacks() function to DxeIplPeim to encapsulate arch details on stack switching.
3. Added PeiSwitchStacks() function to PeiMain to encapsulate arch details on stack switching.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1328 6f19259b-4bc3-4df7-8a09-765794883524

EdkModulePkg/Core/DxeIplPeim/DxeIpl.h

@@ -25,15 +25,37 @@ Abstract:
 
 extern BOOLEAN gInMemory;
 
+/**
+  Transfers control to a function starting with a new stack.
+
+  Transfers control to the function specified by EntryPoint using the new stack
+  specified by NewStack and passing in the parameters specified by Context1 and
+  Context2. Context1 and Context2 are optional and may be NULL. The function
+  EntryPoint must never return.
+
+  If EntryPoint is NULL, then ASSERT().
+  If NewStack is NULL, then ASSERT().
+
+  @param  EntryPoint  A pointer to function to call with the new stack.
+  @param  Context1    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  Context2    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint
+                      function.
+  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's
+                      Reserved on other architectures.
+
+**/
 VOID
+EFIAPI
 SwitchIplStacks (
-  VOID  *EntryPoint,
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
-  UINTN Parameter1,
+  IN      VOID                      *Context1,  OPTIONAL
-  UINTN Parameter2,
+  IN      VOID                      *Context2,  OPTIONAL
-  VOID  *NewStack,
+  IN      VOID                      *NewStack,
-  VOID  *NewBsp
+  IN      VOID                      *NewBsp
-  )
+  );
-;
 
 EFI_STATUS
 PeiFindFile (

EdkModulePkg/Core/DxeIplPeim/DxeLoad.c

@@ -396,11 +396,12 @@ Returns:
     );
 
   DEBUG ((EFI_D_INFO, "DXE Core Entry\n"));
-  SwitchStack (
+  SwitchIplStacks (
     (SWITCH_STACK_ENTRY_POINT)(UINTN)DxeCoreEntryPoint,
     HobList.Raw,
-    (VOID *) (UINTN) BspStore,
+    NULL,
-    TopOfStack
+    TopOfStack,
+    (VOID *) (UINTN) BspStore
     );
 
   //

EdkModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c

@@ -49,3 +49,38 @@ Returns:
   *BspStore = 0;
   return EFI_SUCCESS;
 }
+
+/**
+  Transfers control to a function starting with a new stack.
+
+  Transfers control to the function specified by EntryPoint using the new stack
+  specified by NewStack and passing in the parameters specified by Context1 and
+  Context2. Context1 and Context2 are optional and may be NULL. The function
+  EntryPoint must never return.
+
+  If EntryPoint is NULL, then ASSERT().
+  If NewStack is NULL, then ASSERT().
+
+  @param  EntryPoint  A pointer to function to call with the new stack.
+  @param  Context1    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  Context2    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint
+                      function.
+  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's
+                      Reserved on other architectures.
+
+**/
+VOID
+EFIAPI
+SwitchIplStacks (
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
+  IN      VOID                      *Context1,  OPTIONAL
+  IN      VOID                      *Context2,  OPTIONAL
+  IN      VOID                      *NewStack,
+  IN      VOID                      *NewBsp
+  )
+{
+  SwitchStack (EntryPoint, Context1, Context2, NewStack);
+}

EdkModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c

@@ -68,3 +68,44 @@ Returns:
 
   return EFI_SUCCESS;
 }
+
+/**
+  Transfers control to a function starting with a new stack.
+
+  Transfers control to the function specified by EntryPoint using the new stack
+  specified by NewStack and passing in the parameters specified by Context1 and
+  Context2. Context1 and Context2 are optional and may be NULL. The function
+  EntryPoint must never return.
+
+  If EntryPoint is NULL, then ASSERT().
+  If NewStack is NULL, then ASSERT().
+
+  @param  EntryPoint  A pointer to function to call with the new stack.
+  @param  Context1    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  Context2    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint
+                      function.
+  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's
+                      Reserved on other architectures.
+
+**/
+VOID
+EFIAPI
+SwitchIplStacks (
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
+  IN      VOID                      *Context1,  OPTIONAL
+  IN      VOID                      *Context2,  OPTIONAL
+  IN      VOID                      *NewStack,
+  IN      VOID                      *NewBsp
+  )
+{
+  AsmSwitchStackAndBackingStore (
+    EntryPoint,
+    Context1,
+    Context2,
+    NewStack,
+    NewBsp
+    );
+}

EdkModulePkg/Core/Pei/Dispatcher/Dispatcher.c

@@ -208,11 +208,12 @@ Returns:
                 //in order to provide buffer protection against possible illegal stack
                 //access that might corrupt the stack.
                 //
-                SwitchStack (
+                PeiSwitchStacks (
                   (SWITCH_STACK_ENTRY_POINT)(UINTN)TempPtr.Raw,
                   PeiStartupDescriptor,
                   (VOID*)PrivateDataInMem,
-                  (VOID*)((UINTN)PrivateData->StackBase + (UINTN)PrivateData->StackSize)
+                  (VOID*)((UINTN)PrivateData->StackBase + (UINTN)PrivateData->StackSize),
+                  (VOID*)(UINTN)PrivateData->StackBase
                   );
               }
             }

EdkModulePkg/Core/Pei/Dispatcher/Stack.c

@@ -0,0 +1,50 @@
+/** @file
+  PeiSwitchStacks() function for PEI dispatcher.
+
+  Copyright (c) 2006, Intel Corporation<BR>
+  All rights reserved. This program and the accompanying materials
+  are licensed and made available under the terms and conditions of the BSD License
+  which accompanies this distribution.  The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+  Module Name:  String.c
+
+**/
+
+/**
+  Transfers control to a function starting with a new stack.
+
+  Transfers control to the function specified by EntryPoint using the new stack
+  specified by NewStack and passing in the parameters specified by Context1 and
+  Context2. Context1 and Context2 are optional and may be NULL. The function
+  EntryPoint must never return.
+
+  If EntryPoint is NULL, then ASSERT().
+  If NewStack is NULL, then ASSERT().
+
+  @param  EntryPoint  A pointer to function to call with the new stack.
+  @param  Context1    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  Context2    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint
+                      function.
+  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's
+                      Reserved on other architectures.
+
+**/
+VOID
+EFIAPI
+PeiSwitchStacks (
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
+  IN      VOID                      *Context1,  OPTIONAL
+  IN      VOID                      *Context2,  OPTIONAL
+  IN      VOID                      *NewStack,
+  IN      VOID                      *NewBsp
+  )
+{
+  SwitchStack (EntryPoint, Context1, Context2, NewStack);
+}

EdkModulePkg/Core/Pei/Ipf/Stack.c

@@ -0,0 +1,58 @@
+/** @file
+  PeiSwitchStacks() function for PEI dispatcher.
+
+  Copyright (c) 2006, Intel Corporation<BR>
+  All rights reserved. This program and the accompanying materials
+  are licensed and made available under the terms and conditions of the BSD License
+  which accompanies this distribution.  The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+  Module Name:  String.c
+
+**/
+
+#include <PeiMain.h>
+
+/**
+  Transfers control to a function starting with a new stack.
+
+  Transfers control to the function specified by EntryPoint using the new stack
+  specified by NewStack and passing in the parameters specified by Context1 and
+  Context2. Context1 and Context2 are optional and may be NULL. The function
+  EntryPoint must never return.
+
+  If EntryPoint is NULL, then ASSERT().
+  If NewStack is NULL, then ASSERT().
+
+  @param  EntryPoint  A pointer to function to call with the new stack.
+  @param  Context1    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  Context2    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint
+                      function.
+  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's
+                      Reserved on other architectures.
+
+**/
+VOID
+EFIAPI
+PeiSwitchStacks (
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
+  IN      VOID                      *Context1,  OPTIONAL
+  IN      VOID                      *Context2,  OPTIONAL
+  IN      VOID                      *NewStack,
+  IN      VOID                      *NewBsp
+  )
+{
+  AsmSwitchStackAndBackingStore (
+    EntryPoint,
+    Context1,
+    Context2,
+    NewStack,
+    NewBsp
+    );
+}

EdkModulePkg/Core/Pei/PeiMain.h

@@ -1115,4 +1115,36 @@ Returns:
 --*/
 ;
 
+/**
+  Transfers control to a function starting with a new stack.
+
+  Transfers control to the function specified by EntryPoint using the new stack
+  specified by NewStack and passing in the parameters specified by Context1 and
+  Context2. Context1 and Context2 are optional and may be NULL. The function
+  EntryPoint must never return.
+
+  If EntryPoint is NULL, then ASSERT().
+  If NewStack is NULL, then ASSERT().
+
+  @param  EntryPoint  A pointer to function to call with the new stack.
+  @param  Context1    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  Context2    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint
+                      function.
+  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's
+                      Reserved on other architectures.
+
+**/
+VOID
+EFIAPI
+PeiSwitchStacks (
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
+  IN      VOID                      *Context1,  OPTIONAL
+  IN      VOID                      *Context2,  OPTIONAL
+  IN      VOID                      *NewStack,
+  IN      VOID                      *NewBsp
+  );
+
 #endif

EdkModulePkg/Core/Pei/PeiMain.msa

@@ -71,9 +71,11 @@
     <Filename>Reset/Reset.c</Filename>
     <Filename>Security/Security.c</Filename>
     <Filename>StatusCode/StatusCode.c</Filename>
-    <Filename SupArchList="IPF">ipf/SwitchToCacheMode.c</Filename>
+    <Filename SupArchList="IPF">Ipf/SwitchToCacheMode.c</Filename>
-    <Filename SupArchList="IPF">ipf/IpfCpuCore.i</Filename>
+    <Filename SupArchList="IPF">Ipf/IpfCpuCore.i</Filename>
-    <Filename SupArchList="IPF">ipf/IpfCpuCore.s</Filename>
+    <Filename SupArchList="IPF">Ipf/IpfCpuCore.s</Filename>
+    <Filename SupArchList="IPF">Ipf/Stack.c</Filename>
+    <Filename SupArchList="IA32 X64 EBC">Dispatcher/Stack.c</Filename>
   </SourceFiles>
   <PackageDependencies>
     <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>

MdePkg/Library/BaseLib/BaseLib.msa

@@ -410,6 +410,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
     <Filename SupArchList="IPF">Ipf/CpuPause.s</Filename>
     <Filename SupArchList="IPF">Ipf/CpuFlushTlb.s</Filename>
     <Filename SupArchList="IPF">Ipf/GetInterruptState.s</Filename>
+    <Filename SupArchList="IPF">Ipf/Non-existing.c</Filename>
     <Filename SupArchList="EBC">Math64.c</Filename>
     <Filename SupArchList="EBC">Unaligned.c</Filename>
     <Filename SupArchList="EBC">Ebc/SwitchStack.c</Filename>

MdePkg/Library/BaseLib/Ipf/Non-existing.c

@@ -0,0 +1,53 @@
+/** @file
+  Non-existing BaseLib functions on Ipf
+
+  Copyright (c) 2006, Intel Corporation
+  All rights reserved. This program and the accompanying materials
+  are licensed and made available under the terms and conditions of the BSD License
+  which accompanies this distribution.  The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+  Module Name:  Non-existing.c
+
+**/
+
+#include "../BaseLibInternals.h"
+/**
+  Transfers control to a function starting with a new stack.
+
+  Transfers control to the function specified by EntryPoint using the new stack
+  specified by NewStack and passing in the parameters specified by Context1 and
+  Context2. Context1 and Context2 are optional and may be NULL. The function
+  EntryPoint must never return.
+
+  If EntryPoint is NULL, then ASSERT().
+  If NewStack is NULL, then ASSERT().
+
+  @param  EntryPoint  A pointer to function to call with the new stack.
+  @param  Context1    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  Context2    A pointer to the context to pass into the EntryPoint
+                      function.
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint
+                      function.
+
+**/
+VOID
+EFIAPI
+InternalSwitchStack (
+  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
+  IN      VOID                      *Context1,  OPTIONAL
+  IN      VOID                      *Context2,  OPTIONAL
+  IN      VOID                      *NewStack
+  )
+{
+  //
+  // This version of this function does not actually change the stack pointer
+  // This is to support compilation of CPU types that do not support assemblers
+  // such as EBC
+  //
+  ASSERT (FALSE);
+}