summaryrefslogtreecommitdiff
path: root/MdeModulePkg/Core/Dxe/Image.h
diff options
context:
space:
mode:
authorqhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524>2008-07-24 02:54:45 +0000
committerqhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524>2008-07-24 02:54:45 +0000
commit022c6d45ef78605c173023f53984e4dfaf7b11f4 (patch)
treeb0e51fb630da1ded7af48ba85a60c643037da22e /MdeModulePkg/Core/Dxe/Image.h
parent11c11e4ecf4c3bb41ede73fe88ac29dc67195aa9 (diff)
downloadedk2-platforms-022c6d45ef78605c173023f53984e4dfaf7b11f4.tar.xz
Code Scrub for Dxe Core.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5560 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Core/Dxe/Image.h')
-rw-r--r--MdeModulePkg/Core/Dxe/Image.h142
1 files changed, 71 insertions, 71 deletions
diff --git a/MdeModulePkg/Core/Dxe/Image.h b/MdeModulePkg/Core/Dxe/Image.h
index e84a05f632..b2f8b88b79 100644
--- a/MdeModulePkg/Core/Dxe/Image.h
+++ b/MdeModulePkg/Core/Dxe/Image.h
@@ -94,21 +94,21 @@ typedef struct {
will access the file either from a memory copy, from a file
system interface, or from the load file interface.
- @param BootPolicy Policy for Open Image File.
- @param SourceBuffer Pointer to the memory location containing copy
- of the image to be loaded.
- @param SourceSize The size in bytes of SourceBuffer.
- @param FilePath The specific file path from which the image is
- loaded
- @param DeviceHandle Pointer to the return device handle.
- @param ImageFileHandle Pointer to the image file handle.
- @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which
- the authentication status is returned.
-
- @retval EFI_SUCCESS Image file successfully opened.
- @retval EFI_LOAD_ERROR If the caller passed a copy of the file, and
- SourceSize is 0.
- @retval EFI_INVALID_PARAMETER File path is not valid.
+ @param BootPolicy Policy for Open Image File.
+ @param SourceBuffer Pointer to the memory location containing copy
+ of the image to be loaded.
+ @param SourceSize The size in bytes of SourceBuffer.
+ @param FilePath The specific file path from which the image is
+ loaded
+ @param DeviceHandle Pointer to the return device handle.
+ @param ImageFileHandle Pointer to the image file handle.
+ @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which
+ the authentication status is returned.
+
+ @retval EFI_SUCCESS Image file successfully opened.
+ @retval EFI_LOAD_ERROR If the caller passed a copy of the file, and
+ SourceSize is 0.
+ @retval EFI_INVALID_PARAMETER File path is not valid.
@retval EFI_NOT_FOUND File not found.
**/
@@ -129,13 +129,13 @@ CoreOpenImageFile (
Read image file (specified by UserHandle) into user specified buffer with specified offset
and length.
- @param UserHandle Image file handle
- @param Offset Offset to the source file
- @param ReadSize For input, pointer of size to read; For output,
- pointer of size actually read.
- @param Buffer Buffer to write into
+ @param UserHandle Image file handle
+ @param Offset Offset to the source file
+ @param ReadSize For input, pointer of size to read; For output,
+ pointer of size actually read.
+ @param Buffer Buffer to write into
- @retval EFI_SUCCESS Successfully read the specified part of file
+ @retval EFI_SUCCESS Successfully read the specified part of file
into buffer.
**/
@@ -169,11 +169,11 @@ CoreCloseImageFile (
Search a handle to a device on a specified device path that supports a specified protocol,
interface of that protocol on that handle is another output.
- @param Protocol The protocol to search for
- @param FilePath The specified device path
- @param Interface Interface of the protocol on the handle
- @param Handle The handle to the device on the specified device
- path that supports the protocol.
+ @param Protocol The protocol to search for
+ @param FilePath The specified device path
+ @param Interface Interface of the protocol on the handle
+ @param Handle The handle to the device on the specified device
+ path that supports the protocol.
@return Status code.
@@ -190,27 +190,27 @@ CoreDevicePathToInterface (
/**
Loads, relocates, and invokes a PE/COFF image
- @param BootPolicy If TRUE, indicates that the request originates
- from the boot manager, and that the boot
- manager is attempting to load FilePath as a
- boot selection.
- @param Pe32Handle The handle of PE32 image
- @param Image PE image to be loaded
- @param DstBuffer The buffer to store the image
- @param EntryPoint A pointer to the entry point
- @param Attribute The bit mask of attributes to set for the load
- PE image
-
- @retval EFI_SUCCESS The file was loaded, relocated, and invoked
- @retval EFI_OUT_OF_RESOURCES There was not enough memory to load and
- relocate the PE/COFF file
- @retval EFI_INVALID_PARAMETER Invalid parameter
+ @param BootPolicy If TRUE, indicates that the request originates
+ from the boot manager, and that the boot
+ manager is attempting to load FilePath as a
+ boot selection.
+ @param Pe32Handle The handle of PE32 image
+ @param Image PE image to be loaded
+ @param DstBuffer The buffer to store the image
+ @param EntryPoint A pointer to the entry point
+ @param Attribute The bit mask of attributes to set for the load
+ PE image
+
+ @retval EFI_SUCCESS The file was loaded, relocated, and invoked
+ @retval EFI_OUT_OF_RESOURCES There was not enough memory to load and
+ relocate the PE/COFF file
+ @retval EFI_INVALID_PARAMETER Invalid parameter
@retval EFI_BUFFER_TOO_SMALL Buffer for image is too small
**/
EFI_STATUS
CoreLoadPeImage (
- IN BOOLEAN BootPolicy,
+ IN BOOLEAN BootPolicy,
IN VOID *Pe32Handle,
IN LOADED_IMAGE_PRIVATE_DATA *Image,
IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL,
@@ -222,7 +222,7 @@ CoreLoadPeImage (
/**
Get the image's private data from its handle.
- @param ImageHandle The image handle
+ @param ImageHandle The image handle
@return Return the image private data associated with ImageHandle.
@@ -236,7 +236,7 @@ CoreLoadedImageInfo (
/**
Unloads EFI image from memory.
- @param Image EFI image
+ @param Image EFI image
@param FreePage Free allocated pages
**/
@@ -255,29 +255,29 @@ CoreUnloadAndCloseImage (
/**
Loads an EFI image into memory and returns a handle to the image with extended parameters.
- @param This Calling context
- @param ParentImageHandle The caller's image handle.
- @param FilePath The specific file path from which the image is
- loaded.
- @param SourceBuffer If not NULL, a pointer to the memory location
- containing a copy of the image to be loaded.
- @param SourceSize The size in bytes of SourceBuffer.
- @param DstBuffer The buffer to store the image.
- @param NumberOfPages For input, specifies the space size of the
- image by caller if not NULL. For output,
- specifies the actual space size needed.
- @param ImageHandle Image handle for output.
- @param EntryPoint Image entry point for output.
- @param Attribute The bit mask of attributes to set for the load
- PE image.
-
- @retval EFI_SUCCESS The image was loaded into memory.
- @retval EFI_NOT_FOUND The FilePath was not found.
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
- @retval EFI_UNSUPPORTED The image type is not supported, or the device
- path cannot be parsed to locate the proper
- protocol for loading the file.
- @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
+ @param This Calling context
+ @param ParentImageHandle The caller's image handle.
+ @param FilePath The specific file path from which the image is
+ loaded.
+ @param SourceBuffer If not NULL, a pointer to the memory location
+ containing a copy of the image to be loaded.
+ @param SourceSize The size in bytes of SourceBuffer.
+ @param DstBuffer The buffer to store the image.
+ @param NumberOfPages For input, specifies the space size of the
+ image by caller if not NULL. For output,
+ specifies the actual space size needed.
+ @param ImageHandle Image handle for output.
+ @param EntryPoint Image entry point for output.
+ @param Attribute The bit mask of attributes to set for the load
+ PE image.
+
+ @retval EFI_SUCCESS The image was loaded into memory.
+ @retval EFI_NOT_FOUND The FilePath was not found.
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
+ @retval EFI_UNSUPPORTED The image type is not supported, or the device
+ path cannot be parsed to locate the proper
+ protocol for loading the file.
+ @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
resources.
**/
@@ -300,11 +300,11 @@ CoreLoadImageEx (
/**
Unload the specified image.
- @param This Indicates the calling context.
- @param ImageHandle The specified image handle.
+ @param This Indicates the calling context.
+ @param ImageHandle The specified image handle.
- @retval EFI_INVALID_PARAMETER Image handle is NULL.
- @retval EFI_UNSUPPORTED Attempt to unload an unsupported image.
+ @retval EFI_INVALID_PARAMETER Image handle is NULL.
+ @retval EFI_UNSUPPORTED Attempt to unload an unsupported image.
@retval EFI_SUCCESS Image successfully unloaded.
**/