[mirror_edk2.git] / EdkNt32Pkg / Include / Ppi / NtPeiLoadFile.h

/*++\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
Module Name:\r
\r
 NtPeiLoadFile.h\r
\r
Abstract:\r
\r
  WinNt Load File PPI.\r
\r
  When the PEI core is done it calls the DXE IPL via PPI\r
\r
--*/\r
\r
#ifndef __NT_PEI_LOAD_FILE_H__\r
#define __NT_PEI_LOAD_FILE_H__\r
\r
#include <WinNtDxe.h>\r
\r
#define NT_PEI_LOAD_FILE_GUID \\r
  { \\r
    0xfd0c65eb, 0x405, 0x4cd2, {0x8a, 0xee, 0xf4, 0x0, 0xef, 0x13, 0xba, 0xc2 } \\r
  }\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *NT_PEI_LOAD_FILE) (\r
  VOID                  *Pe32Data,\r
  EFI_PHYSICAL_ADDRESS  *ImageAddress,\r
  UINT64                *ImageSize,\r
  EFI_PHYSICAL_ADDRESS  *EntryPoint\r
  );\r
\r
/*++\r
\r
Routine Description:\r
  Loads and relocates a PE/COFF image into memory.\r
\r
Arguments:\r
  Pe32Data         - The base address of the PE/COFF file that is to be loaded and relocated\r
  ImageAddress     - The base address of the relocated PE/COFF image\r
  ImageSize        - The size of the relocated PE/COFF image\r
  EntryPoint       - The entry point of the relocated PE/COFF image\r
\r
Returns:\r
  EFI_SUCCESS   - The file was loaded and relocated\r
  EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file\r
\r
--*/\r
typedef struct {\r
  NT_PEI_LOAD_FILE  PeiLoadFileService;\r
} NT_PEI_LOAD_FILE_PPI;\r
\r
extern EFI_GUID gNtPeiLoadFilePpiGuid;\r
\r
#endif\r
Commit	Line	Data
878ddf1f	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	NtPeiLoadFile.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	WinNt Load File PPI.\r
	19	\r
	20	When the PEI core is done it calls the DXE IPL via PPI\r
	21	\r
	22	--*/\r
	23	\r
	24	#ifndef __NT_PEI_LOAD_FILE_H__\r
	25	#define __NT_PEI_LOAD_FILE_H__\r
	26	\r
	27	#include <WinNtDxe.h>\r
	28	\r
	29	#define NT_PEI_LOAD_FILE_GUID \\r
	30	{ \\r
	31	0xfd0c65eb, 0x405, 0x4cd2, {0x8a, 0xee, 0xf4, 0x0, 0xef, 0x13, 0xba, 0xc2 } \\r
	32	}\r
	33	\r
	34	typedef\r
	35	EFI_STATUS\r
	36	(EFIAPI *NT_PEI_LOAD_FILE) (\r
	37	VOID *Pe32Data,\r
	38	EFI_PHYSICAL_ADDRESS *ImageAddress,\r
	39	UINT64 *ImageSize,\r
	40	EFI_PHYSICAL_ADDRESS *EntryPoint\r
	41	);\r
	42	\r
	43	/*++\r
	44	\r
	45	Routine Description:\r
	46	Loads and relocates a PE/COFF image into memory.\r
	47	\r
	48	Arguments:\r
	49	Pe32Data - The base address of the PE/COFF file that is to be loaded and relocated\r
	50	ImageAddress - The base address of the relocated PE/COFF image\r
	51	ImageSize - The size of the relocated PE/COFF image\r
	52	EntryPoint - The entry point of the relocated PE/COFF image\r
	53	\r
	54	Returns:\r
	55	EFI_SUCCESS - The file was loaded and relocated\r
	56	EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file\r
	57	\r
	58	--*/\r
	59	typedef struct {\r
	60	NT_PEI_LOAD_FILE PeiLoadFileService;\r
	61	} NT_PEI_LOAD_FILE_PPI;\r
	62	\r
	63	extern EFI_GUID gNtPeiLoadFilePpiGuid;\r
	64	\r
65	#endif\r