[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
\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
  @param  BootPolicy             Policy for Open Image File. \r
  @param  SourceBuffer           Pointer to the memory location containing copy \r
                                 of the image to be loaded. \r
  @param  SourceSize             The size in bytes of SourceBuffer. \r
  @param  FilePath               The specific file path from which the image is \r
                                 loaded \r
  @param  DeviceHandle           Pointer to the return device handle. \r
  @param  ImageFileHandle        Pointer to the image file handle. \r
  @param  AuthenticationStatus   Pointer to a caller-allocated UINT32 in which \r
                                 the authentication status is returned. \r
\r
  @retval EFI_SUCCESS            Image file successfully opened. \r
  @retval EFI_LOAD_ERROR         If the caller passed a copy of the file, and \r
                                 SourceSize is 0. \r
  @retval EFI_INVALID_PARAMETER  File path is not valid. \r
  @retval EFI_NOT_FOUND          File not found.\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
\r
\r
/**\r
  Read image file (specified by UserHandle) into user specified buffer with specified offset\r
  and length.\r
\r
  @param  UserHandle             Image file handle \r
  @param  Offset                 Offset to the source file \r
  @param  ReadSize               For input, pointer of size to read; For output, \r
                                 pointer of size actually read. \r
  @param  Buffer                 Buffer to write into \r
\r
  @retval EFI_SUCCESS            Successfully read the specified part of file \r
                                 into buffer.\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
\r
/**\r
  A function out of date, should be removed.\r
\r
  @param  ImageFileHandle        Handle of the file to close\r
\r
**/\r
VOID\r
EFIAPI\r
CoreCloseImageFile (\r
  IN IMAGE_FILE_HANDLE *ImageFileHandle\r
  )\r
;\r
\r
//\r
// Image processing worker functions\r
//\r
\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
  @param  Protocol               The protocol to search for \r
  @param  FilePath               The specified device path \r
  @param  Interface              Interface of the protocol on the handle \r
  @param  Handle                 The handle to the device on the specified device \r
                                 path that supports the protocol. \r
\r
  @return Status code.\r
\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
\r
/**\r
  Loads, relocates, and invokes a PE/COFF image\r
\r
  @param  BootPolicy              If TRUE, indicates that the request originates \r
                                  from the boot manager, and that the boot \r
                                  manager is attempting to load FilePath as a \r
                                  boot selection. \r
  @param  Pe32Handle              The handle of PE32 image \r
  @param  Image                   PE image to be loaded \r
  @param  DstBuffer               The buffer to store the image \r
  @param  EntryPoint              A pointer to the entry point \r
  @param  Attribute               The bit mask of attributes to set for the load \r
                                  PE image \r
\r
  @retval EFI_SUCCESS             The file was loaded, relocated, and invoked \r
  @retval EFI_OUT_OF_RESOURCES    There was not enough memory to load and \r
                                  relocate the PE/COFF file \r
  @retval EFI_INVALID_PARAMETER   Invalid parameter \r
  @retval EFI_BUFFER_TOO_SMALL    Buffer for image is too small\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
\r
/**\r
  Get the image's private data from its handle.\r
\r
  @param  ImageHandle             The image handle \r
\r
  @return Return the image private data associated with ImageHandle.\r
\r
**/\r
LOADED_IMAGE_PRIVATE_DATA *\r
CoreLoadedImageInfo (\r
  IN EFI_HANDLE  ImageHandle\r
  )\r
;\r
\r
\r
/**\r
  Unloads EFI image from memory.\r
\r
  @param  Image                   EFI image \r
  @param  FreePage                Free allocated pages\r
\r
**/\r
VOID\r
CoreUnloadAndCloseImage (\r
  IN LOADED_IMAGE_PRIVATE_DATA  *Image,\r
  IN BOOLEAN                    FreePage\r
  )\r
;\r
\r
\r
//\r
// Exported Image functions\r
//\r
\r
\r
/**\r
  Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
\r
  @param  This                    Calling context \r
  @param  ParentImageHandle       The caller's image handle. \r
  @param  FilePath                The specific file path from which the image is \r
                                  loaded. \r
  @param  SourceBuffer            If not NULL, a pointer to the memory location \r
                                  containing a copy of the image to be loaded. \r
  @param  SourceSize              The size in bytes of SourceBuffer. \r
  @param  DstBuffer               The buffer to store the image. \r
  @param  NumberOfPages           For input, specifies the space size of the \r
                                  image by caller if not NULL. For output, \r
                                  specifies the actual space size needed. \r
  @param  ImageHandle             Image handle for output. \r
  @param  EntryPoint              Image entry point for output. \r
  @param  Attribute               The bit mask of attributes to set for the load \r
                                  PE image. \r
\r
  @retval EFI_SUCCESS             The image was loaded into memory. \r
  @retval EFI_NOT_FOUND           The FilePath was not found. \r
  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value. \r
  @retval EFI_UNSUPPORTED         The image type is not supported, or the device \r
                                  path cannot be parsed to locate the proper \r
                                  protocol for loading the file. \r
  @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient \r
                                  resources.\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
\r
/**\r
  Unload the specified image.\r
\r
  @param  This                    Indicates the calling context. \r
  @param  ImageHandle             The specified image handle. \r
\r
  @retval EFI_INVALID_PARAMETER   Image handle is NULL. \r
  @retval EFI_UNSUPPORTED         Attempt to unload an unsupported image. \r
  @retval EFI_SUCCESS             Image successfully unloaded.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CoreUnloadImageEx (\r
  IN EFI_PE32_IMAGE_PROTOCOL            *This,\r
  IN EFI_HANDLE                         ImageHandle\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
162ed594	92	\r
	93	/**\r
	94	Opens a file for (simple) reading. The simple read abstraction\r
	95	will access the file either from a memory copy, from a file\r
	96	system interface, or from the load file interface.\r
	97	\r
	98	@param BootPolicy Policy for Open Image File. \r
	99	@param SourceBuffer Pointer to the memory location containing copy \r
	100	of the image to be loaded. \r
	101	@param SourceSize The size in bytes of SourceBuffer. \r
	102	@param FilePath The specific file path from which the image is \r
	103	loaded \r
	104	@param DeviceHandle Pointer to the return device handle. \r
	105	@param ImageFileHandle Pointer to the image file handle. \r
	106	@param AuthenticationStatus Pointer to a caller-allocated UINT32 in which \r
	107	the authentication status is returned. \r
	108	\r
	109	@retval EFI_SUCCESS Image file successfully opened. \r
	110	@retval EFI_LOAD_ERROR If the caller passed a copy of the file, and \r
	111	SourceSize is 0. \r
	112	@retval EFI_INVALID_PARAMETER File path is not valid. \r
	113	@retval EFI_NOT_FOUND File not found.\r
	114	\r
	115	**/\r
28a00297	116	EFI_STATUS\r
	117	CoreOpenImageFile (\r
	118	IN BOOLEAN BootPolicy,\r
	119	IN VOID *SourceBuffer OPTIONAL,\r
	120	IN UINTN SourceSize,\r
cfe9de52	121	IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r
28a00297	122	OUT EFI_HANDLE *DeviceHandle,\r
	123	IN IMAGE_FILE_HANDLE *ImageFileHandle,\r
	124	OUT UINT32 *AuthenticationStatus\r
	125	)\r
162ed594	126	;\r
28a00297	127	\r
28a00297	128	\r
28a00297	129	\r
162ed594	130	/**\r
	131	Read image file (specified by UserHandle) into user specified buffer with specified offset\r
	132	and length.\r
28a00297	133	\r
162ed594	134	@param UserHandle Image file handle \r
	135	@param Offset Offset to the source file \r
	136	@param ReadSize For input, pointer of size to read; For output, \r
	137	pointer of size actually read. \r
	138	@param Buffer Buffer to write into \r
28a00297	139	\r
162ed594	140	@retval EFI_SUCCESS Successfully read the specified part of file \r
162ed594	141	into buffer.\r
28a00297	142	\r
162ed594	143	**/\r
28a00297	144	EFI_STATUS\r
	145	EFIAPI\r
	146	CoreReadImageFile (\r
	147	IN VOID *UserHandle,\r
	148	IN UINTN Offset,\r
	149	IN OUT UINTN *ReadSize,\r
	150	OUT VOID *Buffer\r
	151	)\r
162ed594	152	;\r
28a00297	153	\r
28a00297	154	\r
162ed594	155	/**\r
162ed594	156	A function out of date, should be removed.\r
28a00297	157	\r
162ed594	158	@param ImageFileHandle Handle of the file to close\r
28a00297	159	\r
162ed594	160	**/\r
28a00297	161	VOID\r
	162	EFIAPI\r
	163	CoreCloseImageFile (\r
	164	IN IMAGE_FILE_HANDLE *ImageFileHandle\r
	165	)\r
28a00297	166	;\r
	167	\r
	168	//\r
	169	// Image processing worker functions\r
	170	//\r
162ed594	171	\r
	172	/**\r
	173	Search a handle to a device on a specified device path that supports a specified protocol,\r
	174	interface of that protocol on that handle is another output.\r
	175	\r
	176	@param Protocol The protocol to search for \r
	177	@param FilePath The specified device path \r
	178	@param Interface Interface of the protocol on the handle \r
	179	@param Handle The handle to the device on the specified device \r
	180	path that supports the protocol. \r
	181	\r
	182	@return Status code.\r
	183	\r
	184	**/\r
28a00297	185	EFI_STATUS\r
	186	CoreDevicePathToInterface (\r
	187	IN EFI_GUID *Protocol,\r
	188	IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r
	189	OUT VOID **Interface,\r
	190	OUT EFI_HANDLE *Handle\r
	191	)\r
162ed594	192	;\r
28a00297	193	\r
28a00297	194	\r
162ed594	195	/**\r
162ed594	196	Loads, relocates, and invokes a PE/COFF image\r
28a00297	197	\r
162ed594	198	@param BootPolicy If TRUE, indicates that the request originates \r
	199	from the boot manager, and that the boot \r
	200	manager is attempting to load FilePath as a \r
	201	boot selection. \r
	202	@param Pe32Handle The handle of PE32 image \r
	203	@param Image PE image to be loaded \r
	204	@param DstBuffer The buffer to store the image \r
	205	@param EntryPoint A pointer to the entry point \r
	206	@param Attribute The bit mask of attributes to set for the load \r
	207	PE image \r
	208	\r
	209	@retval EFI_SUCCESS The file was loaded, relocated, and invoked \r
	210	@retval EFI_OUT_OF_RESOURCES There was not enough memory to load and \r
	211	relocate the PE/COFF file \r
	212	@retval EFI_INVALID_PARAMETER Invalid parameter \r
	213	@retval EFI_BUFFER_TOO_SMALL Buffer for image is too small\r
28a00297	214	\r
162ed594	215	**/\r
28a00297	216	EFI_STATUS\r
28a00297	217	CoreLoadPeImage (\r
822360ee	218	IN BOOLEAN BootPolicy,\r
28a00297	219	IN VOID *Pe32Handle,\r
	220	IN LOADED_IMAGE_PRIVATE_DATA *Image,\r
	221	IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL,\r
	222	OUT EFI_PHYSICAL_ADDRESS *EntryPoint OPTIONAL,\r
	223	IN UINT32 Attribute\r
	224	)\r
162ed594	225	;\r
28a00297	226	\r
28a00297	227	\r
162ed594	228	/**\r
162ed594	229	Get the image's private data from its handle.\r
28a00297	230	\r
162ed594	231	@param ImageHandle The image handle \r
28a00297	232	\r
162ed594	233	@return Return the image private data associated with ImageHandle.\r
28a00297	234	\r
162ed594	235	**/\r
28a00297	236	LOADED_IMAGE_PRIVATE_DATA *\r
	237	CoreLoadedImageInfo (\r
	238	IN EFI_HANDLE ImageHandle\r
	239	)\r
162ed594	240	;\r
28a00297	241	\r
28a00297	242	\r
162ed594	243	/**\r
162ed594	244	Unloads EFI image from memory.\r
28a00297	245	\r
162ed594	246	@param Image EFI image \r
162ed594	247	@param FreePage Free allocated pages\r
28a00297	248	\r
162ed594	249	**/\r
28a00297	250	VOID\r
	251	CoreUnloadAndCloseImage (\r
	252	IN LOADED_IMAGE_PRIVATE_DATA *Image,\r
	253	IN BOOLEAN FreePage\r
	254	)\r
28a00297	255	;\r
	256	\r
	257	\r
	258	//\r
	259	// Exported Image functions\r
	260	//\r
	261	\r
162ed594	262	\r
	263	/**\r
	264	Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
	265	\r
	266	@param This Calling context \r
	267	@param ParentImageHandle The caller's image handle. \r
	268	@param FilePath The specific file path from which the image is \r
	269	loaded. \r
	270	@param SourceBuffer If not NULL, a pointer to the memory location \r
	271	containing a copy of the image to be loaded. \r
	272	@param SourceSize The size in bytes of SourceBuffer. \r
	273	@param DstBuffer The buffer to store the image. \r
	274	@param NumberOfPages For input, specifies the space size of the \r
	275	image by caller if not NULL. For output, \r
	276	specifies the actual space size needed. \r
	277	@param ImageHandle Image handle for output. \r
	278	@param EntryPoint Image entry point for output. \r
	279	@param Attribute The bit mask of attributes to set for the load \r
	280	PE image. \r
	281	\r
	282	@retval EFI_SUCCESS The image was loaded into memory. \r
	283	@retval EFI_NOT_FOUND The FilePath was not found. \r
	284	@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. \r
	285	@retval EFI_UNSUPPORTED The image type is not supported, or the device \r
	286	path cannot be parsed to locate the proper \r
	287	protocol for loading the file. \r
	288	@retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient \r
	289	resources.\r
	290	\r
	291	**/\r
28a00297	292	EFI_STATUS\r
	293	EFIAPI\r
	294	CoreLoadImageEx (\r
	295	IN EFI_PE32_IMAGE_PROTOCOL *This,\r
	296	IN EFI_HANDLE ParentImageHandle,\r
	297	IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
	298	IN VOID *SourceBuffer OPTIONAL,\r
	299	IN UINTN SourceSize,\r
	300	IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL,\r
	301	OUT UINTN *NumberOfPages OPTIONAL,\r
	302	OUT EFI_HANDLE *ImageHandle,\r
	303	OUT EFI_PHYSICAL_ADDRESS *EntryPoint OPTIONAL,\r
	304	IN UINT32 Attribute\r
	305	)\r
162ed594	306	;\r
28a00297	307	\r
28a00297	308	\r
162ed594	309	/**\r
162ed594	310	Unload the specified image.\r
28a00297	311	\r
162ed594	312	@param This Indicates the calling context. \r
	313	@param ImageHandle The specified image handle. \r
	314	\r
	315	@retval EFI_INVALID_PARAMETER Image handle is NULL. \r
	316	@retval EFI_UNSUPPORTED Attempt to unload an unsupported image. \r
	317	@retval EFI_SUCCESS Image successfully unloaded.\r
28a00297	318	\r
162ed594	319	**/\r
28a00297	320	EFI_STATUS\r
	321	EFIAPI\r
	322	CoreUnloadImageEx (\r
	323	IN EFI_PE32_IMAGE_PROTOCOL *This,\r
	324	IN EFI_HANDLE ImageHandle\r
	325	)\r
28a00297	326	;\r
28a00297	327	#endif\r