[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 definitions.\r
\r
Copyright (c) 2006 - 2011, 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_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
#include <Ppi/LoadFile.h>\r
#include <Ppi/S3Resume2.h>\r
#include <Ppi/RecoveryModule.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/UefiDecompressLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/S3Lib.h>\r
#include <Library/RecoveryLib.h>\r
#include <Library/DebugAgentLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
\r
#define STACK_SIZE      0x20000\r
#define BSP_STORE_SIZE  0x4000\r
\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
   Searches DxeCore in all firmware Volumes and loads the first\r
   instance that contains DxeCore.\r
\r
   @return FileHandle of DxeCore to load DxeCore.\r
\r
**/\r
EFI_PEI_FILE_HANDLE\r
DxeIplFindDxeCore (\r
  VOID\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 CONST 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 installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
\r
   @param DxeCoreEntryPoint         The entry point 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
EFIAPI\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 looks 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
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Master header file for DxeIpl PEIM. All source files in this module should\r
	3	include this file for common definitions.\r
	4	\r
	5	Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
	6	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
	14	**/\r
	15	\r
	16	#ifndef __PEI_DXEIPL_H__\r
	17	#define __PEI_DXEIPL_H__\r
	18	\r
	19	#include <PiPei.h>\r
	20	#include <Ppi/DxeIpl.h>\r
	21	#include <Ppi/EndOfPeiPhase.h>\r
	22	#include <Ppi/MemoryDiscovered.h>\r
	23	#include <Ppi/ReadOnlyVariable2.h>\r
	24	#include <Ppi/Decompress.h>\r
	25	#include <Ppi/FirmwareVolumeInfo.h>\r
	26	#include <Ppi/GuidedSectionExtraction.h>\r
	27	#include <Ppi/LoadFile.h>\r
	28	#include <Ppi/S3Resume2.h>\r
	29	#include <Ppi/RecoveryModule.h>\r
	30	\r
	31	#include <Guid/MemoryTypeInformation.h>\r
	32	#include <Guid/MemoryAllocationHob.h>\r
	33	#include <Guid/FirmwareFileSystem2.h>\r
	34	\r
	35	#include <Library/DebugLib.h>\r
	36	#include <Library/PeimEntryPoint.h>\r
	37	#include <Library/BaseLib.h>\r
	38	#include <Library/HobLib.h>\r
	39	#include <Library/PeiServicesLib.h>\r
	40	#include <Library/ReportStatusCodeLib.h>\r
	41	#include <Library/UefiDecompressLib.h>\r
	42	#include <Library/ExtractGuidedSectionLib.h>\r
	43	#include <Library/BaseMemoryLib.h>\r
	44	#include <Library/MemoryAllocationLib.h>\r
	45	#include <Library/PcdLib.h>\r
	46	#include <Library/S3Lib.h>\r
	47	#include <Library/RecoveryLib.h>\r
	48	#include <Library/DebugAgentLib.h>\r
	49	#include <Library/PeiServicesTablePointerLib.h>\r
	50	\r
	51	#define STACK_SIZE 0x20000\r
	52	#define BSP_STORE_SIZE 0x4000\r
	53	\r
	54	\r
	55	//\r
	56	// This PPI is installed to indicate the end of the PEI usage of memory\r
	57	//\r
	58	extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;\r
	59	\r
	60	\r
	61	/**\r
	62	Searches DxeCore in all firmware Volumes and loads the first\r
	63	instance that contains DxeCore.\r
	64	\r
	65	@return FileHandle of DxeCore to load DxeCore.\r
	66	\r
	67	**/\r
	68	EFI_PEI_FILE_HANDLE\r
	69	DxeIplFindDxeCore (\r
	70	VOID\r
	71	);\r
	72	\r
	73	\r
	74	/**\r
	75	Main entry point to last PEIM\r
	76	\r
	77	@param This Entry point for DXE IPL PPI\r
	78	@param PeiServices General purpose services available to every PEIM.\r
	79	@param HobList Address to the Pei HOB list\r
	80	\r
	81	@return EFI_SUCCESS DXE core was successfully loaded.\r
	82	@return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core.\r
	83	\r
	84	**/\r
	85	EFI_STATUS\r
	86	EFIAPI\r
	87	DxeLoadCore (\r
	88	IN CONST EFI_DXE_IPL_PPI *This,\r
	89	IN EFI_PEI_SERVICES **PeiServices,\r
	90	IN EFI_PEI_HOB_POINTERS HobList\r
	91	);\r
	92	\r
	93	\r
	94	\r
	95	/**\r
	96	Transfers control to DxeCore.\r
	97	\r
	98	This function performs a CPU architecture specific operations to execute\r
	99	the entry point of DxeCore with the parameters of HobList.\r
	100	It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
	101	\r
	102	@param DxeCoreEntryPoint The entry point of DxeCore.\r
	103	@param HobList The start of HobList passed to DxeCore.\r
	104	\r
	105	**/\r
	106	VOID\r
	107	HandOffToDxeCore (\r
	108	IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint,\r
	109	IN EFI_PEI_HOB_POINTERS HobList\r
	110	);\r
	111	\r
	112	\r
	113	\r
	114	/**\r
	115	Updates the Stack HOB passed to DXE phase.\r
	116	\r
	117	This function traverses the whole HOB list and update the stack HOB to\r
	118	reflect the real stack that is used by DXE core.\r
	119	\r
	120	@param BaseAddress The lower address of stack used by DxeCore.\r
	121	@param Length The length of stack used by DxeCore.\r
	122	\r
	123	**/\r
	124	VOID\r
	125	UpdateStackHob (\r
	126	IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
	127	IN UINT64 Length\r
	128	);\r
	129	\r
	130	/**\r
	131	The ExtractSection() function processes the input section and\r
	132	returns a pointer to the section contents. If the section being\r
	133	extracted does not require processing (if the section\r
	134	GuidedSectionHeader.Attributes has the\r
	135	EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
	136	OutputBuffer is just updated to point to the start of the\r
	137	section's contents. Otherwise, *Buffer must be allocated\r
	138	from PEI permanent memory.\r
	139	\r
	140	@param This Indicates the\r
	141	EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
	142	Buffer containing the input GUIDed section to be\r
	143	processed. OutputBuffer OutputBuffer is\r
	144	allocated from PEI permanent memory and contains\r
	145	the new section stream.\r
	146	@param InputSection A pointer to the input buffer, which contains\r
	147	the input section to be processed.\r
	148	@param OutputBuffer A pointer to a caller-allocated buffer, whose\r
	149	size is specified by the contents of OutputSize.\r
	150	@param OutputSize A pointer to a caller-allocated\r
	151	UINTN in which the size of *OutputBuffer\r
	152	allocation is stored. If the function\r
	153	returns anything other than EFI_SUCCESS,\r
	154	the value of OutputSize is undefined.\r
	155	@param AuthenticationStatus A pointer to a caller-allocated\r
	156	UINT32 that indicates the\r
	157	authentication status of the\r
	158	output buffer. If the input\r
	159	section's GuidedSectionHeader.\r
	160	Attributes field has the\r
	161	EFI_GUIDED_SECTION_AUTH_STATUS_VALID\r
	162	bit as clear,\r
	163	AuthenticationStatus must return\r
	164	zero. These bits reflect the\r
	165	status of the extraction\r
	166	operation. If the function\r
	167	returns anything other than\r
	168	EFI_SUCCESS, the value of\r
	169	AuthenticationStatus is\r
	170	undefined.\r
	171	\r
	172	@retval EFI_SUCCESS The InputSection was\r
	173	successfully processed and the\r
	174	section contents were returned.\r
	175	\r
	176	@retval EFI_OUT_OF_RESOURCES The system has insufficient\r
	177	resources to process the request.\r
	178	\r
	179	@retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
	180	not match this instance of the\r
	181	GUIDed Section Extraction PPI.\r
	182	\r
	183	**/\r
	184	EFI_STATUS\r
	185	EFIAPI\r
	186	CustomGuidedSectionExtract (\r
	187	IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
	188	IN CONST VOID *InputSection,\r
	189	OUT VOID **OutputBuffer,\r
	190	OUT UINTN *OutputSize,\r
	191	OUT UINT32 *AuthenticationStatus\r
	192	);\r
	193	\r
	194	\r
	195	/**\r
	196	Decompresses a section to the output buffer.\r
	197	\r
	198	This function looks up the compression type field in the input section and\r
	199	applies the appropriate compression algorithm to compress the section to a\r
	200	callee allocated buffer.\r
	201	\r
	202	@param This Points to this instance of the\r
	203	EFI_PEI_DECOMPRESS_PEI PPI.\r
	204	@param CompressionSection Points to the compressed section.\r
	205	@param OutputBuffer Holds the returned pointer to the decompressed\r
	206	sections.\r
	207	@param OutputSize Holds the returned size of the decompress\r
	208	section streams.\r
	209	\r
	210	@retval EFI_SUCCESS The section was decompressed successfully.\r
	211	OutputBuffer contains the resulting data and\r
	212	OutputSize contains the resulting size.\r
	213	\r
	214	**/\r
	215	EFI_STATUS\r
	216	EFIAPI\r
	217	Decompress (\r
	218	IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r
	219	IN CONST EFI_COMPRESSION_SECTION *CompressionSection,\r
	220	OUT VOID **OutputBuffer,\r
	221	OUT UINTN *OutputSize\r
	222	);\r
	223	\r
	224	#endif\r