4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Switch Stack functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include "BaseLibInternals.h"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Transfers control to a function starting with a new stack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Transfers control to the function specified by EntryPoint using the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync new stack specified by NewStack and passing in the parameters specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by Context1 and Context2. Context1 and Context2 are optional and may
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be NULL. The function EntryPoint must never return. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supports a variable number of arguments following the NewStack parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync These additional arguments are ignored on IA-32, x64, and EBC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPF CPUs expect one additional parameter of type VOID * that specifies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the new backing store pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EntryPoint is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NewStack is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryPoint A pointer to function to call with the new stack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context1 A pointer to the context to pass into the EntryPoint
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context2 A pointer to the context to pass into the EntryPoint
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NewStack A pointer to the new stack to use for the EntryPoint
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ... This variable argument list is ignored for IA32, x64, and EBC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For IPF, this variable argument list is expected to contain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a single parameter of type VOID * that specifies the new backing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync store pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSwitchStack (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN SWITCH_STACK_ENTRY_POINT EntryPoint,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context1, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context2, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *NewStack,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VA_LIST Marker;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (EntryPoint != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (NewStack != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // New stack must be aligned with CPU_STACK_ALIGNMENT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (((UINTN)NewStack & (CPU_STACK_ALIGNMENT - 1)) == 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VA_START (Marker, NewStack);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InternalSwitchStack (EntryPoint, Context1, Context2, NewStack, Marker);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VA_END (Marker);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // InternalSwitchStack () will never return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (FALSE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}