[mirror_edk2.git] / MdePkg / Include / Library / PeiServicesTablePointerLib.h

/** @file\r
  PEI Services Table Pointer Library services\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
\r
**/\r
\r
#ifndef __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
#define __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
\r
/**\r
  The function returns the pointer to PEI services.\r
\r
  The function returns the pointer to PEI services.\r
  It will ASSERT() if the pointer to PEI services is NULL.\r
\r
  @retval  The pointer to PeiServices.\r
\r
**/\r
EFI_PEI_SERVICES **\r
EFIAPI\r
GetPeiServicesTablePointer (\r
  VOID\r
  );\r
\r
/**\r
  The function set the pointer of PEI services immediately preceding the IDT table\r
  according to PI specification.\r
  \r
  @param    PeiServices   The address of PeiServices pointer.\r
**/\r
VOID\r
EFIAPI\r
SetPeiServicesTablePointer (\r
  EFI_PEI_SERVICES ** PeiServicesTablePointer\r
  );\r
\r
/**\r
  After memory initialization in PEI phase, the IDT table in temporary memory should \r
  be migrated to memory, and the address of PeiServicesPointer also need to be updated  \r
  immediately preceding the new IDT table.\r
  \r
  @param    PeiServices   The address of PeiServices pointer.\r
**/\r
VOID\r
EFIAPI\r
MigrateIdtTable (\r
  IN EFI_PEI_SERVICES  **PeiServices\r
  );\r
  \r
#endif\r
\r
Commit	Line	Data
	1	/** @file\r
	2	PEI Services Table Pointer Library services\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
	16	#define __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
	17	\r
	18	/**\r
	19	The function returns the pointer to PEI services.\r
	20	\r
	21	The function returns the pointer to PEI services.\r
	22	It will ASSERT() if the pointer to PEI services is NULL.\r
	23	\r
	24	@retval The pointer to PeiServices.\r
	25	\r
	26	**/\r
	27	EFI_PEI_SERVICES **\r
	28	EFIAPI\r
	29	GetPeiServicesTablePointer (\r
	30	VOID\r
	31	);\r
	32	\r
	33	/**\r
	34	The function set the pointer of PEI services immediately preceding the IDT table\r
	35	according to PI specification.\r
	36	\r
	37	@param PeiServices The address of PeiServices pointer.\r
	38	**/\r
	39	VOID\r
	40	EFIAPI\r
	41	SetPeiServicesTablePointer (\r
	42	EFI_PEI_SERVICES ** PeiServicesTablePointer\r
	43	);\r
	44	\r
	45	/**\r
	46	After memory initialization in PEI phase, the IDT table in temporary memory should \r
	47	be migrated to memory, and the address of PeiServicesPointer also need to be updated \r
	48	immediately preceding the new IDT table.\r
	49	\r
	50	@param PeiServices The address of PeiServices pointer.\r
	51	**/\r
	52	VOID\r
	53	EFIAPI\r
	54	MigrateIdtTable (\r
	55	IN EFI_PEI_SERVICES **PeiServices\r
	56	);\r
	57	\r
	58	#endif\r
	59	\r