[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
// This PPI is installed to indicate the end of the PEI usage of memory \r
//\r
extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;\r
\r
\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
   Searches DxeCore in all firmware Volumes and loads the first instance that contains DxeCore.\r
\r
   @param DxeCoreFileName    A Pointer to the EFI_GUID to contain the output DxeCore GUID file name.\r
\r
   @return FileHandle of DxeCore to load DxeCore.\r
   \r
**/\r
EFI_PEI_FILE_HANDLE\r
DxeIplFindDxeCore (\r
  OUT EFI_GUID   *DxeCoreFileName\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
\r
**/\r
VOID\r
HandOffToDxeCore (\r
  IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,\r
  IN EFI_PEI_HOB_POINTERS   HobList\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
9b937a73	64	//\r
	65	// This PPI is installed to indicate the end of the PEI usage of memory \r
	66	//\r
	67	extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;\r
	68	\r
	69	\r
	70	\r
91d92e25	71	/**\r
	72	Loads and relocates a PE/COFF image into memory.\r
	73	\r
	74	@param FileHandle The image file handle\r
	75	@param ImageAddress The base address of the relocated PE/COFF image\r
	76	@param ImageSize The size of the relocated PE/COFF image\r
	77	@param EntryPoint The entry point of the relocated PE/COFF image\r
	78	\r
	79	@return EFI_SUCCESS The file was loaded and relocated\r
	80	@return EFI_OUT_OF_RESOURCES There was not enough memory to load and relocate the PE/COFF file\r
	81	\r
	82	**/\r
95276127	83	EFI_STATUS\r
95276127	84	PeiLoadFile (\r
b0d803fe	85	IN EFI_PEI_FILE_HANDLE FileHandle,\r
95276127	86	OUT EFI_PHYSICAL_ADDRESS *ImageAddress,\r
	87	OUT UINT64 *ImageSize,\r
	88	OUT EFI_PHYSICAL_ADDRESS *EntryPoint\r
f45af90b	89	);\r
95276127	90	\r
91d92e25	91	\r
	92	\r
	93	/**\r
9b937a73	94	Searches DxeCore in all firmware Volumes and loads the first instance that contains DxeCore.\r
91d92e25	95	\r
9b937a73	96	@param DxeCoreFileName A Pointer to the EFI_GUID to contain the output DxeCore GUID file name.\r
91d92e25	97	\r
9b937a73	98	@return FileHandle of DxeCore to load DxeCore.\r
9b937a73	99	\r
91d92e25	100	**/\r
9b937a73	101	EFI_PEI_FILE_HANDLE\r
288f9b38	102	DxeIplFindDxeCore (\r
9b937a73	103	OUT EFI_GUID *DxeCoreFileName\r
f45af90b	104	);\r
95276127	105	\r
91d92e25	106	\r
91d92e25	107	/**\r
	108	This function simply retrieves the function pointer of ImageRead in\r
	109	ImageContext structure.\r
	110	\r
	111	@param ImageContext A pointer to the structure of \r
	112	PE_COFF_LOADER_IMAGE_CONTEXT\r
	113	\r
	114	@retval EFI_SUCCESS This function always return EFI_SUCCESS.\r
	115	\r
	116	**/\r
95276127	117	EFI_STATUS\r
	118	GetImageReadFunction (\r
	119	IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
f45af90b	120	);\r
95276127	121	\r
91d92e25	122	\r
91d92e25	123	/**\r
	124	Main entry point to last PEIM \r
	125	\r
	126	@param This Entry point for DXE IPL PPI\r
	127	@param PeiServices General purpose services available to every PEIM.\r
	128	@param HobList Address to the Pei HOB list\r
	129	\r
	130	@return EFI_SUCCESS DXE core was successfully loaded. \r
	131	@return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core.\r
	132	\r
	133	**/\r
95276127	134	EFI_STATUS\r
	135	EFIAPI\r
	136	DxeLoadCore (\r
	137	IN EFI_DXE_IPL_PPI *This,\r
	138	IN EFI_PEI_SERVICES **PeiServices,\r
	139	IN EFI_PEI_HOB_POINTERS HobList\r
	140	);\r
	141	\r
91d92e25	142	\r
	143	\r
	144	/**\r
	145	Transfers control to DxeCore.\r
	146	\r
	147	This function performs a CPU architecture specific operations to execute\r
	148	the entry point of DxeCore with the parameters of HobList.\r
	149	It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
	150	\r
	151	@param DxeCoreEntryPoint The entrypoint of DxeCore.\r
	152	@param HobList The start of HobList passed to DxeCore.\r
91d92e25	153	\r
91d92e25	154	**/\r
95276127	155	VOID\r
	156	HandOffToDxeCore (\r
	157	IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint,\r
9b937a73	158	IN EFI_PEI_HOB_POINTERS HobList\r
95276127	159	);\r
95276127	160	\r
91d92e25	161	\r
	162	\r
	163	/**\r
	164	Updates the Stack HOB passed to DXE phase.\r
	165	\r
	166	This function traverses the whole HOB list and update the stack HOB to\r
	167	reflect the real stack that is used by DXE core.\r
	168	\r
	169	@param BaseAddress The lower address of stack used by DxeCore.\r
	170	@param Length The length of stack used by DxeCore.\r
	171	\r
	172	**/\r
30c8f861	173	VOID\r
	174	UpdateStackHob (\r
	175	IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
	176	IN UINT64 Length\r
	177	);\r
	178	\r
b98da1b1	179	/**\r
	180	The ExtractSection() function processes the input section and\r
	181	returns a pointer to the section contents. If the section being\r
	182	extracted does not require processing (if the section\r
	183	GuidedSectionHeader.Attributes has the\r
	184	EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
	185	OutputBuffer is just updated to point to the start of the\r
	186	section's contents. Otherwise, *Buffer must be allocated\r
	187	from PEI permanent memory.\r
	188	\r
	189	@param This Indicates the\r
	190	EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
	191	Buffer containing the input GUIDed section to be\r
	192	processed. OutputBuffer OutputBuffer is\r
	193	allocated from PEI permanent memory and contains\r
	194	the new section stream.\r
	195	@param InputSection A pointer to the input buffer, which contains\r
	196	the input section to be processed.\r
	197	@param OutputBuffer A pointer to a caller-allocated buffer, whose\r
	198	size is specified by the contents of OutputSize.\r
	199	@param OutputSize A pointer to a caller-allocated\r
	200	UINTN in which the size of *OutputBuffer\r
	201	allocation is stored. If the function\r
	202	returns anything other than EFI_SUCCESS,\r
	203	the value of OutputSize is undefined.\r
	204	@param AuthenticationStatus A pointer to a caller-allocated\r
	205	UINT32 that indicates the\r
	206	authentication status of the\r
	207	output buffer. If the input\r
	208	section's GuidedSectionHeader.\r
	209	Attributes field has the\r
	210	EFI_GUIDED_SECTION_AUTH_STATUS_VALID \r
	211	bit as clear,\r
	212	AuthenticationStatus must return\r
	213	zero. These bits reflect the\r
	214	status of the extraction\r
	215	operation. If the function\r
	216	returns anything other than\r
	217	EFI_SUCCESS, the value of\r
	218	AuthenticationStatus is\r
	219	undefined.\r
	220	\r
	221	@retval EFI_SUCCESS The InputSection was\r
	222	successfully processed and the\r
	223	section contents were returned.\r
	224	\r
	225	@retval EFI_OUT_OF_RESOURCES The system has insufficient\r
	226	resources to process the request.\r
	227	\r
	228	@retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
	229	not match this instance of the\r
	230	GUIDed Section Extraction PPI.\r
91d92e25	231	\r
b98da1b1	232	**/\r
	233	EFI_STATUS\r
	234	CustomGuidedSectionExtract (\r
	235	IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
	236	IN CONST VOID *InputSection,\r
	237	OUT VOID **OutputBuffer,\r
	238	OUT UINTN *OutputSize,\r
	239	OUT UINT32 *AuthenticationStatus\r
	240	);\r
	241	\r
	242	\r
	243	/**\r
	244	Decompresses a section to the output buffer.\r
	245	\r
	246	This function lookes up the compression type field in the input section and\r
	247	applies the appropriate compression algorithm to compress the section to a\r
	248	callee allocated buffer.\r
	249	\r
	250	@param This Points to this instance of the\r
	251	EFI_PEI_DECOMPRESS_PEI PPI.\r
	252	@param CompressionSection Points to the compressed section.\r
	253	@param OutputBuffer Holds the returned pointer to the decompressed\r
	254	sections.\r
	255	@param OutputSize Holds the returned size of the decompress\r
	256	section streams.\r
	257	\r
	258	@retval EFI_SUCCESS The section was decompressed successfully.\r
	259	OutputBuffer contains the resulting data and\r
	260	OutputSize contains the resulting size.\r
	261	\r
	262	**/\r
	263	EFI_STATUS\r
	264	EFIAPI \r
	265	Decompress (\r
	266	IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r
	267	IN CONST EFI_COMPRESSION_SECTION *CompressionSection,\r
	268	OUT VOID **OutputBuffer,\r
	269	OUT UINTN *OutputSize\r
	270	);\r
91d92e25	271	\r
	272	/**\r
	273	Initializes the Dxe Ipl PPI\r
	274	\r
	275	@param FfsHandle The handle of FFS file.\r
	276	@param PeiServices General purpose services available to\r
	277	every PEIM.\r
	278	@return EFI_SUCESS\r
	279	\r
	280	**/\r
95276127	281	EFI_STATUS\r
	282	EFIAPI\r
	283	PeimInitializeDxeIpl (\r
b0d803fe	284	IN EFI_PEI_FILE_HANDLE FfsHandle,\r
95276127	285	IN EFI_PEI_SERVICES **PeiServices\r
f45af90b	286	);\r
95276127	287	\r
	288	\r
	289	#endif\r