[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / DxeIpl.h

/** @file\r
  Master header file for DxeIpl PEIM. All source files in this module should\r
  include this file for common defininitions.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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_DXEIPL_H__\r
#define __PEI_DXEIPL_H__\r
\r
#include <PiPei.h>\r
#include <Ppi/DxeIpl.h>\r
#include <Ppi/EndOfPeiPhase.h>\r
#include <Ppi/MemoryDiscovered.h>\r
#include <Ppi/ReadOnlyVariable2.h>\r
#include <Ppi/Decompress.h>\r
#include <Ppi/FirmwareVolumeInfo.h>\r
#include <Ppi/GuidedSectionExtraction.h>\r
\r
#include <Guid/MemoryTypeInformation.h>\r
#include <Guid/MemoryAllocationHob.h>\r
#include <Guid/FirmwareFileSystem2.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/CacheMaintenanceLib.h>\r
#include <Library/UefiDecompressLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PeCoffLib.h>\r
#include <Library/S3Lib.h>\r
#include <Library/RecoveryLib.h>\r
\r
#define STACK_SIZE      0x20000\r
#define BSP_STORE_SIZE  0x4000\r
\r
\r
//\r
// This macro aligns the ActualSize with a given alignment and is used to \r
// calculate the size an image occupies.\r
//\r
#define GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize + (Alignment - 1)) & ~(Alignment - 1))\r
\r
//\r
// Indicate whether DxeIpl has been shadowed to memory.\r
//\r
extern BOOLEAN gInMemory;\r
\r
/**\r
   Loads and relocates a PE/COFF image into memory.\r
\r
   @param FileHandle        The image file handle\r
   @param ImageAddress      The base address of the relocated PE/COFF image\r
   @param ImageSize         The size of the relocated PE/COFF image\r
   @param EntryPoint        The entry point of the relocated PE/COFF image\r
   \r
   @return EFI_SUCCESS           The file was loaded and relocated\r
   @return EFI_OUT_OF_RESOURCES  There was not enough memory to load and relocate the PE/COFF file\r
\r
**/\r
EFI_STATUS\r
PeiLoadFile (\r
  IN  EFI_PEI_FILE_HANDLE                       FileHandle,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  );\r
\r
\r
\r
/**\r
   Find DxeCore driver from all First Volumes.\r
\r
   @param FileHandle    Pointer to FFS file to search.\r
   \r
   @return EFI_SUCESS   Success to find the FFS in specificed FV\r
   @return others       Fail to find the FFS in specificed FV\r
\r
**/\r
EFI_STATUS\r
DxeIplFindDxeCore (\r
  OUT EFI_PEI_FILE_HANDLE   *FileHandle\r
  );\r
\r
\r
\r
/**\r
   This function simply retrieves the function pointer of ImageRead in\r
   ImageContext structure.\r
    \r
   @param ImageContext       A pointer to the structure of \r
                             PE_COFF_LOADER_IMAGE_CONTEXT\r
   \r
   @retval EFI_SUCCESS       This function always return EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
GetImageReadFunction (\r
  IN      PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
  );\r
\r
\r
/**\r
   Main entry point to last PEIM \r
    \r
   @param This          Entry point for DXE IPL PPI\r
   @param PeiServices   General purpose services available to every PEIM.\r
   @param HobList       Address to the Pei HOB list\r
   \r
   @return EFI_SUCCESS              DXE core was successfully loaded. \r
   @return EFI_OUT_OF_RESOURCES     There are not enough resources to load DXE core.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeLoadCore (\r
  IN EFI_DXE_IPL_PPI       *This,\r
  IN EFI_PEI_SERVICES      **PeiServices,\r
  IN EFI_PEI_HOB_POINTERS  HobList\r
  );\r
\r
\r
\r
/**\r
   Transfers control to DxeCore.\r
\r
   This function performs a CPU architecture specific operations to execute\r
   the entry point of DxeCore with the parameters of HobList.\r
   It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
\r
   @param DxeCoreEntryPoint         The entrypoint of DxeCore.\r
   @param HobList                   The start of HobList passed to DxeCore.\r
   @param EndOfPeiSignal            The PPI descriptor for EFI_END_OF_PEI_PPI.\r
\r
**/\r
VOID\r
HandOffToDxeCore (\r
  IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,\r
  IN EFI_PEI_HOB_POINTERS   HobList,\r
  IN EFI_PEI_PPI_DESCRIPTOR *EndOfPeiSignal\r
  );\r
\r
\r
\r
/**\r
   Updates the Stack HOB passed to DXE phase.\r
\r
   This function traverses the whole HOB list and update the stack HOB to\r
   reflect the real stack that is used by DXE core.\r
\r
   @param BaseAddress           The lower address of stack used by DxeCore.\r
   @param Length                The length of stack used by DxeCore.\r
\r
**/\r
VOID\r
UpdateStackHob (\r
  IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
  IN UINT64                      Length\r
  );\r
\r
/**\r
  The ExtractSection() function processes the input section and\r
  returns a pointer to the section contents. If the section being\r
  extracted does not require processing (if the section\r
  GuidedSectionHeader.Attributes has the\r
  EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
  OutputBuffer is just updated to point to the start of the\r
  section's contents. Otherwise, *Buffer must be allocated\r
  from PEI permanent memory.\r
\r
  @param This                   Indicates the\r
                                EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
                                Buffer containing the input GUIDed section to be\r
                                processed. OutputBuffer OutputBuffer is\r
                                allocated from PEI permanent memory and contains\r
                                the new section stream.\r
  @param InputSection           A pointer to the input buffer, which contains\r
                                the input section to be processed.\r
  @param OutputBuffer           A pointer to a caller-allocated buffer, whose\r
                                size is specified by the contents of OutputSize.\r
  @param OutputSize             A pointer to a caller-allocated\r
                                UINTN in which the size of *OutputBuffer\r
                                allocation is stored. If the function\r
                                returns anything other than EFI_SUCCESS,\r
                                the value of OutputSize is undefined.\r
  @param AuthenticationStatus   A pointer to a caller-allocated\r
                                UINT32 that indicates the\r
                                authentication status of the\r
                                output buffer. If the input\r
                                section's GuidedSectionHeader.\r
                                Attributes field has the\r
                                EFI_GUIDED_SECTION_AUTH_STATUS_VALID \r
                                bit as clear,\r
                                AuthenticationStatus must return\r
                                zero. These bits reflect the\r
                                status of the extraction\r
                                operation. If the function\r
                                returns anything other than\r
                                EFI_SUCCESS, the value of\r
                                AuthenticationStatus is\r
                                undefined.\r
  \r
  @retval EFI_SUCCESS           The InputSection was\r
                                successfully processed and the\r
                                section contents were returned.\r
  \r
  @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
                                resources to process the request.\r
  \r
  @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
                                not match this instance of the\r
                                GUIDed Section Extraction PPI.\r
\r
**/\r
EFI_STATUS\r
CustomGuidedSectionExtract (\r
  IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
  IN CONST  VOID                                  *InputSection,\r
  OUT       VOID                                  **OutputBuffer,\r
  OUT       UINTN                                 *OutputSize,\r
  OUT       UINT32                                *AuthenticationStatus\r
  );\r
\r
\r
/**\r
   Decompresses a section to the output buffer.\r
\r
   This function lookes up the compression type field in the input section and\r
   applies the appropriate compression algorithm to compress the section to a\r
   callee allocated buffer.\r
    \r
   @param  This                  Points to this instance of the\r
                                 EFI_PEI_DECOMPRESS_PEI PPI.\r
   @param  CompressionSection    Points to the compressed section.\r
   @param  OutputBuffer          Holds the returned pointer to the decompressed\r
                                 sections.\r
   @param  OutputSize            Holds the returned size of the decompress\r
                                 section streams.\r
   \r
   @retval EFI_SUCCESS           The section was decompressed successfully.\r
                                 OutputBuffer contains the resulting data and\r
                                 OutputSize contains the resulting size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI \r
Decompress (\r
  IN CONST  EFI_PEI_DECOMPRESS_PPI  *This,\r
  IN CONST  EFI_COMPRESSION_SECTION *CompressionSection,\r
  OUT       VOID                    **OutputBuffer,\r
  OUT       UINTN                   *OutputSize\r
  );\r
\r
/**\r
  Initializes the Dxe Ipl PPI\r
\r
  @param  FfsHandle   The handle of FFS file.\r
  @param  PeiServices General purpose services available to\r
                      every PEIM.\r
  @return EFI_SUCESS\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeDxeIpl (\r
  IN EFI_PEI_FILE_HANDLE       FfsHandle,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  );\r
\r
\r
#endif\r
Commit	Line	Data
96226baa	1	/** @file\r
fbc81c1e	2	Master header file for DxeIpl PEIM. All source files in this module should\r
f45af90b	3	include this file for common defininitions.\r
95276127	4	\r
96226baa	5	Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
95276127	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
797a9d67	14	**/\r
95276127	15	\r
	16	#ifndef __PEI_DXEIPL_H__\r
	17	#define __PEI_DXEIPL_H__\r
	18	\r
859b72fa A	19	#include <PiPei.h>\r
859b72fa A	20	#include <Ppi/DxeIpl.h>\r
859b72fa	21	#include <Ppi/EndOfPeiPhase.h>\r
859b72fa	22	#include <Ppi/MemoryDiscovered.h>\r
b74350e9	23	#include <Ppi/ReadOnlyVariable2.h>\r
b0d803fe	24	#include <Ppi/Decompress.h>\r
b0d803fe	25	#include <Ppi/FirmwareVolumeInfo.h>\r
b98da1b1	26	#include <Ppi/GuidedSectionExtraction.h>\r
b0d803fe	27	\r
b98da1b1	28	#include <Guid/MemoryTypeInformation.h>\r
30c8f861	29	#include <Guid/MemoryAllocationHob.h>\r
b0d803fe	30	#include <Guid/FirmwareFileSystem2.h>\r
b0d803fe	31	\r
859b72fa A	32	#include <Library/DebugLib.h>\r
	33	#include <Library/PeimEntryPoint.h>\r
	34	#include <Library/BaseLib.h>\r
	35	#include <Library/HobLib.h>\r
	36	#include <Library/PeiServicesLib.h>\r
	37	#include <Library/ReportStatusCodeLib.h>\r
	38	#include <Library/CacheMaintenanceLib.h>\r
859b72fa	39	#include <Library/UefiDecompressLib.h>\r
18fd8d65	40	#include <Library/ExtractGuidedSectionLib.h>\r
859b72fa A	41	#include <Library/PeiServicesTablePointerLib.h>\r
	42	#include <Library/BaseMemoryLib.h>\r
	43	#include <Library/MemoryAllocationLib.h>\r
	44	#include <Library/PcdLib.h>\r
	45	#include <Library/PeCoffLib.h>\r
4fb31c2c	46	#include <Library/S3Lib.h>\r
4fb31c2c	47	#include <Library/RecoveryLib.h>\r
95276127	48	\r
	49	#define STACK_SIZE 0x20000\r
	50	#define BSP_STORE_SIZE 0x4000\r
	51	\r
b98da1b1	52	\r
	53	//\r
	54	// This macro aligns the ActualSize with a given alignment and is used to \r
	55	// calculate the size an image occupies.\r
	56	//\r
95276127	57	#define GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize + (Alignment - 1)) & ~(Alignment - 1))\r
95276127	58	\r
b98da1b1	59	//\r
	60	// Indicate whether DxeIpl has been shadowed to memory.\r
	61	//\r
95276127	62	extern BOOLEAN gInMemory;\r
95276127	63	\r
91d92e25	64	/**\r
	65	Loads and relocates a PE/COFF image into memory.\r
	66	\r
	67	@param FileHandle The image file handle\r
	68	@param ImageAddress The base address of the relocated PE/COFF image\r
	69	@param ImageSize The size of the relocated PE/COFF image\r
	70	@param EntryPoint The entry point of the relocated PE/COFF image\r
	71	\r
	72	@return EFI_SUCCESS The file was loaded and relocated\r
	73	@return EFI_OUT_OF_RESOURCES There was not enough memory to load and relocate the PE/COFF file\r
	74	\r
	75	**/\r
95276127	76	EFI_STATUS\r
95276127	77	PeiLoadFile (\r
b0d803fe	78	IN EFI_PEI_FILE_HANDLE FileHandle,\r
95276127	79	OUT EFI_PHYSICAL_ADDRESS *ImageAddress,\r
	80	OUT UINT64 *ImageSize,\r
	81	OUT EFI_PHYSICAL_ADDRESS *EntryPoint\r
f45af90b	82	);\r
95276127	83	\r
91d92e25	84	\r
	85	\r
	86	/**\r
	87	Find DxeCore driver from all First Volumes.\r
	88	\r
	89	@param FileHandle Pointer to FFS file to search.\r
	90	\r
	91	@return EFI_SUCESS Success to find the FFS in specificed FV\r
	92	@return others Fail to find the FFS in specificed FV\r
	93	\r
	94	**/\r
b0d803fe	95	EFI_STATUS\r
288f9b38	96	DxeIplFindDxeCore (\r
b0d803fe	97	OUT EFI_PEI_FILE_HANDLE *FileHandle\r
f45af90b	98	);\r
95276127	99	\r
91d92e25	100	\r
	101	\r
	102	/**\r
	103	This function simply retrieves the function pointer of ImageRead in\r
	104	ImageContext structure.\r
	105	\r
	106	@param ImageContext A pointer to the structure of \r
	107	PE_COFF_LOADER_IMAGE_CONTEXT\r
	108	\r
	109	@retval EFI_SUCCESS This function always return EFI_SUCCESS.\r
	110	\r
	111	**/\r
95276127	112	EFI_STATUS\r
	113	GetImageReadFunction (\r
	114	IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
f45af90b	115	);\r
95276127	116	\r
91d92e25	117	\r
91d92e25	118	/**\r
	119	Main entry point to last PEIM \r
	120	\r
	121	@param This Entry point for DXE IPL PPI\r
	122	@param PeiServices General purpose services available to every PEIM.\r
	123	@param HobList Address to the Pei HOB list\r
	124	\r
	125	@return EFI_SUCCESS DXE core was successfully loaded. \r
	126	@return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core.\r
	127	\r
	128	**/\r
95276127	129	EFI_STATUS\r
	130	EFIAPI\r
	131	DxeLoadCore (\r
	132	IN EFI_DXE_IPL_PPI *This,\r
	133	IN EFI_PEI_SERVICES **PeiServices,\r
	134	IN EFI_PEI_HOB_POINTERS HobList\r
	135	);\r
	136	\r
91d92e25	137	\r
	138	\r
	139	/**\r
	140	Transfers control to DxeCore.\r
	141	\r
	142	This function performs a CPU architecture specific operations to execute\r
	143	the entry point of DxeCore with the parameters of HobList.\r
	144	It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
	145	\r
	146	@param DxeCoreEntryPoint The entrypoint of DxeCore.\r
	147	@param HobList The start of HobList passed to DxeCore.\r
	148	@param EndOfPeiSignal The PPI descriptor for EFI_END_OF_PEI_PPI.\r
	149	\r
	150	**/\r
95276127	151	VOID\r
	152	HandOffToDxeCore (\r
	153	IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint,\r
	154	IN EFI_PEI_HOB_POINTERS HobList,\r
	155	IN EFI_PEI_PPI_DESCRIPTOR *EndOfPeiSignal\r
	156	);\r
	157	\r
91d92e25	158	\r
	159	\r
	160	/**\r
	161	Updates the Stack HOB passed to DXE phase.\r
	162	\r
	163	This function traverses the whole HOB list and update the stack HOB to\r
	164	reflect the real stack that is used by DXE core.\r
	165	\r
	166	@param BaseAddress The lower address of stack used by DxeCore.\r
	167	@param Length The length of stack used by DxeCore.\r
	168	\r
	169	**/\r
30c8f861	170	VOID\r
	171	UpdateStackHob (\r
	172	IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
	173	IN UINT64 Length\r
	174	);\r
	175	\r
b98da1b1	176	/**\r
	177	The ExtractSection() function processes the input section and\r
	178	returns a pointer to the section contents. If the section being\r
	179	extracted does not require processing (if the section\r
	180	GuidedSectionHeader.Attributes has the\r
	181	EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
	182	OutputBuffer is just updated to point to the start of the\r
	183	section's contents. Otherwise, *Buffer must be allocated\r
	184	from PEI permanent memory.\r
	185	\r
	186	@param This Indicates the\r
	187	EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
	188	Buffer containing the input GUIDed section to be\r
	189	processed. OutputBuffer OutputBuffer is\r
	190	allocated from PEI permanent memory and contains\r
	191	the new section stream.\r
	192	@param InputSection A pointer to the input buffer, which contains\r
	193	the input section to be processed.\r
	194	@param OutputBuffer A pointer to a caller-allocated buffer, whose\r
	195	size is specified by the contents of OutputSize.\r
	196	@param OutputSize A pointer to a caller-allocated\r
	197	UINTN in which the size of *OutputBuffer\r
	198	allocation is stored. If the function\r
	199	returns anything other than EFI_SUCCESS,\r
	200	the value of OutputSize is undefined.\r
	201	@param AuthenticationStatus A pointer to a caller-allocated\r
	202	UINT32 that indicates the\r
	203	authentication status of the\r
	204	output buffer. If the input\r
	205	section's GuidedSectionHeader.\r
	206	Attributes field has the\r
	207	EFI_GUIDED_SECTION_AUTH_STATUS_VALID \r
	208	bit as clear,\r
	209	AuthenticationStatus must return\r
	210	zero. These bits reflect the\r
	211	status of the extraction\r
	212	operation. If the function\r
	213	returns anything other than\r
	214	EFI_SUCCESS, the value of\r
	215	AuthenticationStatus is\r
	216	undefined.\r
	217	\r
	218	@retval EFI_SUCCESS The InputSection was\r
	219	successfully processed and the\r
	220	section contents were returned.\r
	221	\r
	222	@retval EFI_OUT_OF_RESOURCES The system has insufficient\r
	223	resources to process the request.\r
	224	\r
	225	@retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
	226	not match this instance of the\r
	227	GUIDed Section Extraction PPI.\r
91d92e25	228	\r
b98da1b1	229	**/\r
	230	EFI_STATUS\r
	231	CustomGuidedSectionExtract (\r
	232	IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
	233	IN CONST VOID *InputSection,\r
	234	OUT VOID **OutputBuffer,\r
	235	OUT UINTN *OutputSize,\r
	236	OUT UINT32 *AuthenticationStatus\r
	237	);\r
	238	\r
	239	\r
	240	/**\r
	241	Decompresses a section to the output buffer.\r
	242	\r
	243	This function lookes up the compression type field in the input section and\r
	244	applies the appropriate compression algorithm to compress the section to a\r
	245	callee allocated buffer.\r
	246	\r
	247	@param This Points to this instance of the\r
	248	EFI_PEI_DECOMPRESS_PEI PPI.\r
	249	@param CompressionSection Points to the compressed section.\r
	250	@param OutputBuffer Holds the returned pointer to the decompressed\r
	251	sections.\r
	252	@param OutputSize Holds the returned size of the decompress\r
	253	section streams.\r
	254	\r
	255	@retval EFI_SUCCESS The section was decompressed successfully.\r
	256	OutputBuffer contains the resulting data and\r
	257	OutputSize contains the resulting size.\r
	258	\r
	259	**/\r
	260	EFI_STATUS\r
	261	EFIAPI \r
	262	Decompress (\r
	263	IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r
	264	IN CONST EFI_COMPRESSION_SECTION *CompressionSection,\r
	265	OUT VOID **OutputBuffer,\r
	266	OUT UINTN *OutputSize\r
	267	);\r
91d92e25	268	\r
	269	/**\r
	270	Initializes the Dxe Ipl PPI\r
	271	\r
	272	@param FfsHandle The handle of FFS file.\r
	273	@param PeiServices General purpose services available to\r
	274	every PEIM.\r
	275	@return EFI_SUCESS\r
	276	\r
	277	**/\r
95276127	278	EFI_STATUS\r
	279	EFIAPI\r
	280	PeimInitializeDxeIpl (\r
b0d803fe	281	IN EFI_PEI_FILE_HANDLE FfsHandle,\r
95276127	282	IN EFI_PEI_SERVICES **PeiServices\r
f45af90b	283	);\r
95276127	284	\r
	285	\r
	286	#endif\r