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