[mirror_edk2.git] / IntelFspPkg / Include / Library / FspSwitchStackLib.h

/** @file\r
\r
  Copyright (c) 2014, 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
\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
#ifndef _FSP_SWITCH_STACK_LIB_H_\r
#define _FSP_SWITCH_STACK_LIB_H_\r
\r
/**\r
\r
  This function will switch the current stack to the previous saved stack.\r
  Before calling the previous stack has to be set in  FSP_GLOBAL_DATA.CoreStack.\r
                    EIP\r
                    FLAGS  16 bit  FLAGS  16 bit\r
                    EDI\r
                    ESI\r
                    EBP\r
                    ESP\r
                    EBX\r
                    EDX\r
                    ECX\r
                    EAX\r
                    DWORD     IDT base1\r
  StackPointer:     DWORD     IDT base2\r
\r
  @return ReturnKey          After switching to the saved stack,\r
                             this value will be saved in eax before returning.\r
\r
\r
**/\r
UINT32\r
EFIAPI\r
Pei2LoaderSwitchStack (\r
  VOID\r
  );\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	\r
	3	Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>\r
	4	This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php.\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	**/\r
	13	\r
	14	#ifndef _FSP_SWITCH_STACK_LIB_H_\r
	15	#define _FSP_SWITCH_STACK_LIB_H_\r
	16	\r
	17	/**\r
	18	\r
	19	This function will switch the current stack to the previous saved stack.\r
	20	Before calling the previous stack has to be set in FSP_GLOBAL_DATA.CoreStack.\r
	21	EIP\r
	22	FLAGS 16 bit FLAGS 16 bit\r
	23	EDI\r
	24	ESI\r
	25	EBP\r
	26	ESP\r
	27	EBX\r
	28	EDX\r
	29	ECX\r
	30	EAX\r
	31	DWORD IDT base1\r
	32	StackPointer: DWORD IDT base2\r
	33	\r
	34	@return ReturnKey After switching to the saved stack,\r
	35	this value will be saved in eax before returning.\r
	36	\r
	37	\r
	38	**/\r
	39	UINT32\r
	40	EFIAPI\r
	41	Pei2LoaderSwitchStack (\r
	42	VOID\r
	43	);\r
	44	\r
	45	#endif\r