Clean up DEC files:

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / LoadPe32Image.h

diff --git a/MdeModulePkg/Include/Protocol/LoadPe32Image.h b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
index 38cc38acd719f084fd0a991d5d5a86ac33cb2b86..b56dd37ad0aa880f38975d01a7a3181cd9eae564 100644 (file)
--- a/MdeModulePkg/Include/Protocol/LoadPe32Image.h
+++ b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
@@ -1,15 +1,15 @@
 /** @file\r
 \r
   Load Pe32 Image protocol enables loading and unloading EFI images into memory and executing those images.\r
-  This protocol uses File Device Path to get EFI image.\r
+  This protocol uses File Device Path to get an EFI image.\r
 \r
-Copyright (c) 2006 - 2009, 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
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
+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
@@ -30,7 +30,7 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
 \r
   Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
 \r
-  @param  This                Pointer to the LoadPe32Image protocol instance\r
+  @param  This                The pointer to the LoadPe32Image protocol instance\r
   @param  ParentImageHandle   The caller's image handle.\r
   @param  FilePath            The specific file path from which the image is loaded.\r
   @param  SourceBuffer        If not NULL, a pointer to the memory location containing a copy of\r
@@ -39,8 +39,8 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
   @param  DstBuffer           The buffer to store the image.\r
   @param  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
-  @param  ImageHandle         Image handle for output.\r
-  @param  EntryPoint          Image entry point for output.\r
+  @param  ImageHandle         The image handle for output.\r
+  @param  EntryPoint          The image entry point for output.\r
   @param  Attribute           The bit mask of attributes to set for the load PE image.\r
 \r
   @retval EFI_SUCCESS           The image was loaded into memory.\r
@@ -48,7 +48,15 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
   @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 path cannot be\r
                                 parsed to locate the proper protocol for loading the file.\r
-  @retval EFI_OUT_OF_RESOURCES  Image was not loaded due to insufficient memory resources.\r
+  @retval EFI_OUT_OF_RESOURCES  The image was not loaded due to insufficient memory resources.\r
+  @retval EFI_LOAD_ERROR        Image was not loaded because the image format was corrupt or not\r
+                                understood.\r
+  @retval EFI_DEVICE_ERROR      Image was not loaded because the device returned a read error.\r
+  @retval EFI_ACCESS_DENIED     Image was not loaded because the platform policy prohibits the \r
+                                image from being loaded. NULL is returned in *ImageHandle.\r
+  @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a \r
+                                valid EFI_LOADED_IMAGE_PROTOCOL. However, the current \r
+                                platform policy specifies that the image should not be started.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -69,12 +77,12 @@ EFI_STATUS
 \r
   Unload the specified image.\r
 \r
-  @param  This             Pointer to the LoadPe32Image protocol instance\r
+  @param  This             The pointer to the LoadPe32Image protocol instance\r
   @param  ImageHandle      The specified image handle to be unloaded.\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 is successfully unloaded.\r
+  @retval EFI_UNSUPPORTED       Attempted to unload an unsupported image.\r
+  @retval EFI_SUCCESS           The image successfully unloaded.\r
 \r
 --*/\r
 typedef\r