[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Image.h

/** @file \r
  \r
  Data structure and functions to load and unload PeImage.\r
  \r
Copyright (c) 2006 - 2008, 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
**/\r
\r
\r
#ifndef _IMAGE_H_\r
#define _IMAGE_H_\r
\r
\r
\r
#define LOADED_IMAGE_PRIVATE_DATA_SIGNATURE   EFI_SIGNATURE_32('l','d','r','i')\r
\r
typedef struct {\r
    UINTN                       Signature;\r
    EFI_HANDLE                  Handle;         // Image handle\r
    UINTN                       Type;           // Image type\r
\r
    BOOLEAN                     Started;        // If entrypoint has been called\r
\r
    EFI_IMAGE_ENTRY_POINT       EntryPoint;     // The image's entry point\r
    EFI_LOADED_IMAGE_PROTOCOL   Info;           // loaded image protocol\r
\r
    EFI_PHYSICAL_ADDRESS        ImageBasePage;  // Location in memory\r
    UINTN                       NumberOfPages;  // Number of pages\r
\r
    CHAR8                       *FixupData;     // Original fixup data\r
\r
    EFI_TPL                     Tpl;            // Tpl of started image\r
    EFI_STATUS                  Status;         // Status returned by started image\r
\r
    UINTN                       ExitDataSize;   // Size of ExitData from started image\r
    VOID                        *ExitData;      // Pointer to exit data from started image\r
    VOID                        *JumpBuffer;    // Pointer to pool allocation for context save/retore\r
    BASE_LIBRARY_JUMP_BUFFER    *JumpContext;   // Pointer to buffer for context save/retore\r
    UINT16                      Machine;        // Machine type from PE image\r
\r
    EFI_EBC_PROTOCOL            *Ebc;           // EBC Protocol pointer\r
\r
    EFI_RUNTIME_IMAGE_ENTRY     *RuntimeData;   // Runtime image list\r
\r
    EFI_DEVICE_PATH_PROTOCOL    *LoadedImageDevicePath;  // Pointer to Loaded Image Device Path Protocl\r
\r
    PE_COFF_LOADER_IMAGE_CONTEXT  ImageContext; // PeCoffLoader ImageContext\r
\r
} LOADED_IMAGE_PRIVATE_DATA;\r
\r
#define LOADED_IMAGE_PRIVATE_DATA_FROM_THIS(a) \\r
          CR(a, LOADED_IMAGE_PRIVATE_DATA, Info, LOADED_IMAGE_PRIVATE_DATA_SIGNATURE)\r
\r
\r
\r
#define LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE  EFI_SIGNATURE_32('l','p','e','i')\r
\r
typedef struct {\r
    UINTN                       Signature;\r
    EFI_HANDLE                  Handle;         // Image handle\r
    EFI_PE32_IMAGE_PROTOCOL     Pe32Image;\r
} LOAD_PE32_IMAGE_PRIVATE_DATA;\r
\r
#define LOAD_PE32_IMAGE_PRIVATE_DATA_FROM_THIS(a) \\r
          CR(a, LOAD_PE32_IMAGE_PRIVATE_DATA, Pe32Image, LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE)\r
\r
\r
\r
//\r
// Private Data Types\r
//\r
#define IMAGE_FILE_HANDLE_SIGNATURE       EFI_SIGNATURE_32('i','m','g','f')\r
typedef struct {\r
  UINTN               Signature;\r
  BOOLEAN             FreeBuffer;\r
  VOID                *Source;\r
  UINTN               SourceSize;\r
} IMAGE_FILE_HANDLE;\r
\r
\r
//\r
// Abstractions for reading image contents\r
//\r
\r
EFI_STATUS\r
CoreOpenImageFile (\r
  IN BOOLEAN                        BootPolicy,\r
  IN VOID                           *SourceBuffer   OPTIONAL,\r
  IN UINTN                          SourceSize,\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL   **FilePath,\r
  OUT EFI_HANDLE                    *DeviceHandle,\r
  IN IMAGE_FILE_HANDLE              *ImageFileHandle,\r
  OUT UINT32                        *AuthenticationStatus\r
  )\r
/*++\r
\r
Routine Description:\r
\r
    Opens a file for (simple) reading.  The simple read abstraction\r
    will access the file either from a memory copy, from a file\r
    system interface, or from the load file interface.\r
\r
Arguments:\r
\r
  BootPolicy    - Policy for Open Image File.\r
  SourceBuffer  - Pointer to the memory location containing copy\r
                  of the image to be loaded.\r
  SourceSize    - The size in bytes of SourceBuffer.\r
  FilePath      - The specific file path from which the image is loaded\r
  DeviceHandle  - Pointer to the return device handle.\r
  ImageFileHandle      - Pointer to the image file handle.\r
  AuthenticationStatus - Pointer to a caller-allocated UINT32 in which the authentication status is returned.\r
\r
Returns:\r
\r
    A handle to access the file\r
\r
--*/\r
;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
CoreReadImageFile (\r
  IN     VOID     *UserHandle,\r
  IN     UINTN    Offset,\r
  IN OUT UINTN    *ReadSize,\r
  OUT     VOID    *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Read image file (specified by UserHandle) into user specified buffer with specified offset\r
  and length.\r
\r
Arguments:\r
\r
  UserHandle      - Image file handle\r
\r
  Offset          - Offset to the source file\r
\r
  ReadSize        - For input, pointer of size to read;\r
                    For output, pointer of size actually read.\r
\r
  Buffer          - Buffer to write into\r
\r
Returns:\r
\r
  EFI_SUCCESS     - Successfully read the specified part of file into buffer.\r
\r
--*/\r
;\r
\r
VOID\r
EFIAPI\r
CoreCloseImageFile (\r
  IN IMAGE_FILE_HANDLE *ImageFileHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  A function out of date, should be removed.\r
\r
Arguments:\r
\r
  ImageFileHandle    - Handle of the file to close\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
;\r
\r
//\r
// Image processing worker functions\r
//\r
EFI_STATUS\r
CoreDevicePathToInterface (\r
  IN EFI_GUID                     *Protocol,\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r
  OUT VOID                        **Interface,\r
  OUT EFI_HANDLE                  *Handle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Search a handle to a device on a specified device path that supports a specified protocol,\r
  interface of that protocol on that handle is another output.\r
\r
Arguments:\r
\r
  Protocol      - The protocol to search for\r
\r
  FilePath      - The specified device path\r
\r
  Interface     - Interface of the protocol on the handle\r
\r
  Handle        - The handle to the device on the specified device path that supports the protocol.\r
\r
Returns:\r
\r
  Status code.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
CoreLoadPeImage (\r
  IN  BOOLEAN                    BootPolicy,\r
  IN  VOID                       *Pe32Handle,\r
  IN  LOADED_IMAGE_PRIVATE_DATA  *Image,\r
  IN  EFI_PHYSICAL_ADDRESS       DstBuffer   OPTIONAL,\r
  OUT EFI_PHYSICAL_ADDRESS       *EntryPoint  OPTIONAL,\r
  IN  UINT32                     Attribute\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Loads, relocates, and invokes a PE/COFF image\r
\r
Arguments:\r
\r
  BootPolicy       - Policy for Open Image File.\r
  Pe32Handle       - The handle of PE32 image\r
  Image            - PE image to be loaded\r
  DstBuffer        - The buffer to store the image\r
  EntryPoint       - A pointer to the entry point\r
  Attribute        - The bit mask of attributes to set for the load PE image\r
\r
Returns:\r
\r
  EFI_SUCCESS           - The file was loaded, relocated, and invoked\r
\r
  EFI_OUT_OF_RESOURCES  - There was not enough memory to load and relocate the PE/COFF file\r
\r
  EFI_INVALID_PARAMETER - Invalid parameter\r
\r
  EFI_BUFFER_TOO_SMALL  - Buffer for image is too small\r
\r
--*/\r
;\r
\r
LOADED_IMAGE_PRIVATE_DATA *\r
CoreLoadedImageInfo (\r
  IN EFI_HANDLE  ImageHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ImageHandle - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
CoreUnloadAndCloseImage (\r
  IN LOADED_IMAGE_PRIVATE_DATA  *Image,\r
  IN BOOLEAN                    FreePage\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Unloads EFI image from memory.\r
\r
Arguments:\r
\r
  Image      - EFI image\r
  FreePage   - Free allocated pages\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
;\r
\r
\r
//\r
// Exported Image functions\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
CoreLoadImageEx (\r
  IN EFI_PE32_IMAGE_PROTOCOL           *This,\r
  IN  EFI_HANDLE                       ParentImageHandle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL         *FilePath,\r
  IN  VOID                             *SourceBuffer       OPTIONAL,\r
  IN  UINTN                            SourceSize,\r
  IN  EFI_PHYSICAL_ADDRESS             DstBuffer           OPTIONAL,\r
  OUT UINTN                            *NumberOfPages      OPTIONAL,\r
  OUT EFI_HANDLE                       *ImageHandle,\r
  OUT EFI_PHYSICAL_ADDRESS             *EntryPoint         OPTIONAL,\r
  IN  UINT32                           Attribute\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
\r
Arguments:\r
\r
  ParentImageHandle   - The caller's image handle.\r
  FilePath            - The specific file path from which the image is loaded.\r
  SourceBuffer        - If not NULL, a pointer to the memory location containing a copy of\r
                        the image to be loaded.\r
  SourceSize          - The size in bytes of SourceBuffer.\r
  DstBuffer           - The buffer to store the image.\r
  NumberOfPages       - For input, specifies the space size of the image by caller if not NULL.\r
                        For output, specifies the actual space size needed.\r
  ImageHandle         - Image handle for output.\r
  EntryPoint          - Image entry point for output.\r
  Attribute           - The bit mask of attributes to set for the load PE image.\r
\r
Returns:\r
\r
  EFI_SUCCESS            - The image was loaded into memory.\r
  EFI_NOT_FOUND          - The FilePath was not found.\r
  EFI_INVALID_PARAMETER  - One of the parameters has an invalid value.\r
  EFI_UNSUPPORTED        - The image type is not supported, or the device path cannot be\r
                           parsed to locate the proper protocol for loading the file.\r
  EFI_OUT_OF_RESOURCES   - Image was not loaded due to insufficient resources.\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
CoreUnloadImageEx (\r
  IN EFI_PE32_IMAGE_PROTOCOL            *This,\r
  IN EFI_HANDLE                         ImageHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Unload the specified image.\r
\r
Arguments:\r
\r
  This              - Indicates the calling context.\r
\r
  ImageHandle       - The specified image handle.\r
\r
Returns:\r
\r
  EFI_INVALID_PARAMETER       - Image handle is NULL.\r
\r
  EFI_UNSUPPORTED             - Attempt to unload an unsupported image.\r
\r
  EFI_SUCCESS                 - Image successfully unloaded.\r
\r
--*/\r
;\r
#endif\r
Commit	Line	Data
504214c4 LG	1	/** @file \r
	2	\r
	3	Data structure and functions to load and unload PeImage.\r
	4	\r
	5	Copyright (c) 2006 - 2008, Intel Corporation\r
28a00297	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
504214c4	14	**/\r
28a00297	15	\r
	16	\r
	17	#ifndef _IMAGE_H_\r
	18	#define _IMAGE_H_\r
	19	\r
	20	\r
	21	\r
	22	#define LOADED_IMAGE_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32('l','d','r','i')\r
	23	\r
	24	typedef struct {\r
	25	UINTN Signature;\r
	26	EFI_HANDLE Handle; // Image handle\r
	27	UINTN Type; // Image type\r
	28	\r
	29	BOOLEAN Started; // If entrypoint has been called\r
	30	\r
	31	EFI_IMAGE_ENTRY_POINT EntryPoint; // The image's entry point\r
	32	EFI_LOADED_IMAGE_PROTOCOL Info; // loaded image protocol\r
	33	\r
	34	EFI_PHYSICAL_ADDRESS ImageBasePage; // Location in memory\r
	35	UINTN NumberOfPages; // Number of pages\r
	36	\r
	37	CHAR8 *FixupData; // Original fixup data\r
	38	\r
	39	EFI_TPL Tpl; // Tpl of started image\r
	40	EFI_STATUS Status; // Status returned by started image\r
	41	\r
	42	UINTN ExitDataSize; // Size of ExitData from started image\r
	43	VOID *ExitData; // Pointer to exit data from started image\r
	44	VOID *JumpBuffer; // Pointer to pool allocation for context save/retore\r
	45	BASE_LIBRARY_JUMP_BUFFER *JumpContext; // Pointer to buffer for context save/retore\r
	46	UINT16 Machine; // Machine type from PE image\r
	47	\r
	48	EFI_EBC_PROTOCOL *Ebc; // EBC Protocol pointer\r
	49	\r
	50	EFI_RUNTIME_IMAGE_ENTRY *RuntimeData; // Runtime image list\r
	51	\r
ba39e316	52	EFI_DEVICE_PATH_PROTOCOL *LoadedImageDevicePath; // Pointer to Loaded Image Device Path Protocl\r
85658066	53	\r
28a00297	54	PE_COFF_LOADER_IMAGE_CONTEXT ImageContext; // PeCoffLoader ImageContext\r
	55	\r
	56	} LOADED_IMAGE_PRIVATE_DATA;\r
	57	\r
	58	#define LOADED_IMAGE_PRIVATE_DATA_FROM_THIS(a) \\r
	59	CR(a, LOADED_IMAGE_PRIVATE_DATA, Info, LOADED_IMAGE_PRIVATE_DATA_SIGNATURE)\r
	60	\r
	61	\r
	62	\r
	63	#define LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32('l','p','e','i')\r
	64	\r
	65	typedef struct {\r
	66	UINTN Signature;\r
	67	EFI_HANDLE Handle; // Image handle\r
	68	EFI_PE32_IMAGE_PROTOCOL Pe32Image;\r
	69	} LOAD_PE32_IMAGE_PRIVATE_DATA;\r
	70	\r
	71	#define LOAD_PE32_IMAGE_PRIVATE_DATA_FROM_THIS(a) \\r
	72	CR(a, LOAD_PE32_IMAGE_PRIVATE_DATA, Pe32Image, LOAD_PE32_IMAGE_PRIVATE_DATA_SIGNATURE)\r
	73	\r
	74	\r
	75	\r
	76	//\r
	77	// Private Data Types\r
	78	//\r
	79	#define IMAGE_FILE_HANDLE_SIGNATURE EFI_SIGNATURE_32('i','m','g','f')\r
	80	typedef struct {\r
	81	UINTN Signature;\r
	82	BOOLEAN FreeBuffer;\r
	83	VOID *Source;\r
	84	UINTN SourceSize;\r
	85	} IMAGE_FILE_HANDLE;\r
	86	\r
	87	\r
	88	//\r
	89	// Abstractions for reading image contents\r
	90	//\r
	91	\r
	92	EFI_STATUS\r
	93	CoreOpenImageFile (\r
	94	IN BOOLEAN BootPolicy,\r
	95	IN VOID *SourceBuffer OPTIONAL,\r
	96	IN UINTN SourceSize,\r
cfe9de52	97	IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r
28a00297	98	OUT EFI_HANDLE *DeviceHandle,\r
	99	IN IMAGE_FILE_HANDLE *ImageFileHandle,\r
	100	OUT UINT32 *AuthenticationStatus\r
	101	)\r
	102	/*++\r
	103	\r
	104	Routine Description:\r
	105	\r
	106	Opens a file for (simple) reading. The simple read abstraction\r
	107	will access the file either from a memory copy, from a file\r
	108	system interface, or from the load file interface.\r
	109	\r
	110	Arguments:\r
	111	\r
	112	BootPolicy - Policy for Open Image File.\r
	113	SourceBuffer - Pointer to the memory location containing copy\r
	114	of the image to be loaded.\r
	115	SourceSize - The size in bytes of SourceBuffer.\r
	116	FilePath - The specific file path from which the image is loaded\r
	117	DeviceHandle - Pointer to the return device handle.\r
	118	ImageFileHandle - Pointer to the image file handle.\r
	119	AuthenticationStatus - Pointer to a caller-allocated UINT32 in which the authentication status is returned.\r
	120	\r
	121	Returns:\r
	122	\r
	123	A handle to access the file\r
	124	\r
	125	--*/\r
	126	;\r
	127	\r
	128	\r
	129	EFI_STATUS\r
	130	EFIAPI\r
	131	CoreReadImageFile (\r
	132	IN VOID *UserHandle,\r
	133	IN UINTN Offset,\r
	134	IN OUT UINTN *ReadSize,\r
	135	OUT VOID *Buffer\r
	136	)\r
	137	/*++\r
	138	\r
	139	Routine Description:\r
	140	\r
	141	Read image file (specified by UserHandle) into user specified buffer with specified offset\r
	142	and length.\r
	143	\r
	144	Arguments:\r
	145	\r
	146	UserHandle - Image file handle\r
	147	\r
	148	Offset - Offset to the source file\r
	149	\r
	150	ReadSize - For input, pointer of size to read;\r
	151	For output, pointer of size actually read.\r
	152	\r
	153	Buffer - Buffer to write into\r
	154	\r
	155	Returns:\r
	156	\r
	157	EFI_SUCCESS - Successfully read the specified part of file into buffer.\r
	158	\r
	159	--*/\r
	160	;\r
	161	\r
162	VOID\r
163	EFIAPI\r
164	CoreCloseImageFile (\r
165	IN IMAGE_FILE_HANDLE *ImageFileHandle\r
166	)\r
167	/*++\r
168	\r
169	Routine Description:\r
170	\r
171	A function out of date, should be removed.\r
172	\r
173	Arguments:\r
174	\r
175	ImageFileHandle - Handle of the file to close\r
176	\r
177	Returns:\r
178	\r
179	None\r
180	\r
181	--*/\r
182	;\r
183	\r
184	//\r
185	// Image processing worker functions\r
186	//\r
187	EFI_STATUS\r
188	CoreDevicePathToInterface (\r
189	IN EFI_GUID *Protocol,\r
190	IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r
191	OUT VOID **Interface,\r
192	OUT EFI_HANDLE *Handle\r
193	)\r
194	/*++\r
195	\r
196	Routine Description:\r
197	\r
198	Search a handle to a device on a specified device path that supports a specified protocol,\r
199	interface of that protocol on that handle is another output.\r
200	\r
201	Arguments:\r
202	\r
203	Protocol - The protocol to search for\r
204	\r
205	FilePath - The specified device path\r
206	\r
207	Interface - Interface of the protocol on the handle\r
208	\r
209	Handle - The handle to the device on the specified device path that supports the protocol.\r
210	\r
211	Returns:\r
212	\r
213	Status code.\r
214	\r
215	--*/\r
216	;\r
217	\r
218	EFI_STATUS\r
219	CoreLoadPeImage (\r
822360ee	220	IN BOOLEAN BootPolicy,\r
28a00297	221	IN VOID *Pe32Handle,\r
	222	IN LOADED_IMAGE_PRIVATE_DATA *Image,\r
	223	IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL,\r
	224	OUT EFI_PHYSICAL_ADDRESS *EntryPoint OPTIONAL,\r
	225	IN UINT32 Attribute\r
	226	)\r
	227	/*++\r
	228	\r
	229	Routine Description:\r
	230	\r
	231	Loads, relocates, and invokes a PE/COFF image\r
	232	\r
	233	Arguments:\r
	234	\r
822360ee	235	BootPolicy - Policy for Open Image File.\r
28a00297	236	Pe32Handle - The handle of PE32 image\r
	237	Image - PE image to be loaded\r
	238	DstBuffer - The buffer to store the image\r
	239	EntryPoint - A pointer to the entry point\r
	240	Attribute - The bit mask of attributes to set for the load PE image\r
	241	\r
	242	Returns:\r
	243	\r
	244	EFI_SUCCESS - The file was loaded, relocated, and invoked\r
	245	\r
	246	EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file\r
	247	\r
	248	EFI_INVALID_PARAMETER - Invalid parameter\r
	249	\r
	250	EFI_BUFFER_TOO_SMALL - Buffer for image is too small\r
	251	\r
	252	--*/\r
	253	;\r
	254	\r
	255	LOADED_IMAGE_PRIVATE_DATA *\r
	256	CoreLoadedImageInfo (\r
	257	IN EFI_HANDLE ImageHandle\r
	258	)\r
	259	/*++\r
	260	\r
	261	Routine Description:\r
	262	\r
	263	TODO: Add function description\r
	264	\r
	265	Arguments:\r
	266	\r
	267	ImageHandle - TODO: add argument description\r
	268	\r
	269	Returns:\r
	270	\r
	271	TODO: add return values\r
	272	\r
	273	--*/\r
	274	;\r
	275	\r
	276	VOID\r
	277	CoreUnloadAndCloseImage (\r
	278	IN LOADED_IMAGE_PRIVATE_DATA *Image,\r
	279	IN BOOLEAN FreePage\r
	280	)\r
	281	/*++\r
	282	\r
	283	Routine Description:\r
	284	\r
	285	Unloads EFI image from memory.\r
	286	\r
	287	Arguments:\r
	288	\r
	289	Image - EFI image\r
	290	FreePage - Free allocated pages\r
	291	\r
	292	Returns:\r
	293	\r
	294	None\r
	295	\r
	296	--*/\r
	297	;\r
	298	\r
	299	\r
300	//\r
301	// Exported Image functions\r
302	//\r
303	\r
304	EFI_STATUS\r
305	EFIAPI\r
306	CoreLoadImageEx (\r
307	IN EFI_PE32_IMAGE_PROTOCOL *This,\r
308	IN EFI_HANDLE ParentImageHandle,\r
309	IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
310	IN VOID *SourceBuffer OPTIONAL,\r
311	IN UINTN SourceSize,\r
312	IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL,\r
313	OUT UINTN *NumberOfPages OPTIONAL,\r
314	OUT EFI_HANDLE *ImageHandle,\r
315	OUT EFI_PHYSICAL_ADDRESS *EntryPoint OPTIONAL,\r
316	IN UINT32 Attribute\r
317	)\r
318	/*++\r
319	\r
320	Routine Description:\r
321	\r
322	Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
323	\r
324	Arguments:\r
325	\r
326	ParentImageHandle - The caller's image handle.\r
327	FilePath - The specific file path from which the image is loaded.\r
328	SourceBuffer - If not NULL, a pointer to the memory location containing a copy of\r
329	the image to be loaded.\r
330	SourceSize - The size in bytes of SourceBuffer.\r
331	DstBuffer - The buffer to store the image.\r
332	NumberOfPages - For input, specifies the space size of the image by caller if not NULL.\r
333	For output, specifies the actual space size needed.\r
334	ImageHandle - Image handle for output.\r
335	EntryPoint - Image entry point for output.\r
336	Attribute - The bit mask of attributes to set for the load PE image.\r
337	\r
338	Returns:\r
339	\r
340	EFI_SUCCESS - The image was loaded into memory.\r
341	EFI_NOT_FOUND - The FilePath was not found.\r
342	EFI_INVALID_PARAMETER - One of the parameters has an invalid value.\r
343	EFI_UNSUPPORTED - The image type is not supported, or the device path cannot be\r
344	parsed to locate the proper protocol for loading the file.\r
345	EFI_OUT_OF_RESOURCES - Image was not loaded due to insufficient resources.\r
346	--*/\r
347	;\r
348	\r
349	EFI_STATUS\r
350	EFIAPI\r
351	CoreUnloadImageEx (\r
352	IN EFI_PE32_IMAGE_PROTOCOL *This,\r
353	IN EFI_HANDLE ImageHandle\r
354	)\r
355	/*++\r
356	\r
357	Routine Description:\r
358	\r
359	Unload the specified image.\r
360	\r
361	Arguments:\r
362	\r
363	This - Indicates the calling context.\r
364	\r
365	ImageHandle - The specified image handle.\r
366	\r
367	Returns:\r
368	\r
369	EFI_INVALID_PARAMETER - Image handle is NULL.\r
370	\r
371	EFI_UNSUPPORTED - Attempt to unload an unsupported image.\r
372	\r
373	EFI_SUCCESS - Image successfully unloaded.\r
374	\r
375	--*/\r
376	;\r
377	#endif\r