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

/** @file\r
  Provides a service to retrieve a pointer to the PEI Services Table.\r
\r
Copyright (c) 2006 - 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 __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
#define __PEI_SERVICES_TABLE_POINTER_LIB_H__\r
\r
/**\r
  Retrieves the cached value of the PEI Services Table pointer.\r
\r
  Returns the cached value of the PEI Services Table pointer in a CPU specific manner \r
  as specified in the CPU binding section of the Platform Initialization Pre-EFI \r
  Initialization Core Interface Specification.\r
  \r
  If the cached PEI Services Table pointer is NULL, then ASSERT().\r
\r
  @return  The pointer to PeiServices.\r
\r
**/\r
CONST EFI_PEI_SERVICES **\r
EFIAPI\r
GetPeiServicesTablePointer (\r
  VOID\r
  );\r
\r
/**\r
  Caches a pointer PEI Services Table. \r
 \r
  Caches the pointer to the PEI Services Table specified by PeiServicesTablePointer \r
  in a CPU specific manner as specified in the CPU binding section of the Platform Initialization \r
  Pre-EFI Initialization Core Interface Specification. \r
  \r
  If PeiServicesTablePointer is NULL, then ASSERT().\r
  \r
  @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
**/\r
VOID\r
EFIAPI\r
SetPeiServicesTablePointer (\r
  IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
  );\r
\r
/**\r
  Perform CPU specific actions required to migrate the PEI Services Table \r
  pointer from temporary RAM to permanent RAM.\r
\r
  For IA32 CPUs, the PEI Services Table pointer is stored in the 4 bytes \r
  immediately preceding the Interrupt Descriptor Table (IDT) in memory.\r
  For X64 CPUs, the PEI Services Table pointer is stored in the 8 bytes \r
  immediately preceding the Interrupt Descriptor Table (IDT) in memory.\r
  For Itanium and ARM CPUs, a the PEI Services Table Pointer is stored in\r
  a dedicated CPU register.  This means that there is no memory storage \r
  associated with storing the PEI Services Table pointer, so no additional \r
  migration actions are required for Itanium or ARM CPUs.\r
\r
**/\r
VOID\r
EFIAPI\r
MigratePeiServicesTablePointer (\r
  VOID\r
  );\r
\r
#endif\r
\r
Commit	Line	Data
	1	/** @file\r
	2	Provides a service to retrieve a pointer to the PEI Services Table.\r
	3	\r
	4	Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
	5	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	Retrieves the cached value of the PEI Services Table pointer.\r
	20	\r
	21	Returns the cached value of the PEI Services Table pointer in a CPU specific manner \r
	22	as specified in the CPU binding section of the Platform Initialization Pre-EFI \r
	23	Initialization Core Interface Specification.\r
	24	\r
	25	If the cached PEI Services Table pointer is NULL, then ASSERT().\r
	26	\r
	27	@return The pointer to PeiServices.\r
	28	\r
	29	**/\r
	30	CONST EFI_PEI_SERVICES **\r
	31	EFIAPI\r
	32	GetPeiServicesTablePointer (\r
	33	VOID\r
	34	);\r
	35	\r
	36	/**\r
	37	Caches a pointer PEI Services Table. \r
	38	\r
	39	Caches the pointer to the PEI Services Table specified by PeiServicesTablePointer \r
	40	in a CPU specific manner as specified in the CPU binding section of the Platform Initialization \r
	41	Pre-EFI Initialization Core Interface Specification. \r
	42	\r
	43	If PeiServicesTablePointer is NULL, then ASSERT().\r
	44	\r
	45	@param PeiServicesTablePointer The address of PeiServices pointer.\r
	46	**/\r
	47	VOID\r
	48	EFIAPI\r
	49	SetPeiServicesTablePointer (\r
	50	IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer\r
	51	);\r
	52	\r
	53	/**\r
	54	Perform CPU specific actions required to migrate the PEI Services Table \r
	55	pointer from temporary RAM to permanent RAM.\r
	56	\r
	57	For IA32 CPUs, the PEI Services Table pointer is stored in the 4 bytes \r
	58	immediately preceding the Interrupt Descriptor Table (IDT) in memory.\r
	59	For X64 CPUs, the PEI Services Table pointer is stored in the 8 bytes \r
	60	immediately preceding the Interrupt Descriptor Table (IDT) in memory.\r
	61	For Itanium and ARM CPUs, a the PEI Services Table Pointer is stored in\r
	62	a dedicated CPU register. This means that there is no memory storage \r
	63	associated with storing the PEI Services Table pointer, so no additional \r
	64	migration actions are required for Itanium or ARM CPUs.\r
	65	\r
	66	**/\r
	67	VOID\r
	68	EFIAPI\r
	69	MigratePeiServicesTablePointer (\r
	70	VOID\r
	71	);\r
	72	\r
	73	#endif\r
	74	\r