X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FProtocol%2FLoadPe32Image.h;h=f71e92ca0b5c46a7361e2822d2b2edbafa69d9ab;hb=9d510e61fceee7b92955ef9a3c20343752d8ce3f;hp=1ea29896b8114045f89ca0320d30917c2eaffce0;hpb=d8a43975d902b901ecccc32cda1160c47c804bd8;p=mirror_edk2.git

diff --git a/MdeModulePkg/Include/Protocol/LoadPe32Image.h b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
index 1ea29896b8..f71e92ca0b 100644
--- a/MdeModulePkg/Include/Protocol/LoadPe32Image.h
+++ b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
@@ -1,27 +1,12 @@
-/*++
+/** @file
 
-Copyright (c) 2006, Intel Corporation
-All rights reserved. This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+  Load Pe32 Image protocol enables loading and unloading EFI images into memory and executing those images.
+  This protocol uses File Device Path to get an EFI image.
 
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+SPDX-License-Identifier: BSD-2-Clause-Patent
 
-Module Name:
-  LoadPe32Image.h
-
-Abstract:
-  Load File protocol as defined in the EFI 1.0 specification.
-
-  Load file protocol exists to supports the addition of new boot devices,
-  and to support booting from devices that do not map well to file system.
-  Network boot is done via a LoadFile protocol.
-
-  EFI 1.0 can boot from any device that produces a LoadFile protocol.
-
---*/
+**/
 
 #ifndef __LOAD_PE32_IMAGE_H__
 #define __LOAD_PE32_IMAGE_H__
@@ -35,31 +20,75 @@ Abstract:
 
 typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
 
+/**
+
+  Loads an EFI image into memory and returns a handle to the image with extended parameters.
+
+  @param  This                The pointer to the LoadPe32Image protocol instance
+  @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         The image handle for output.
+  @param  EntryPoint          The 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  The image was not loaded due to insufficient memory resources.
+  @retval EFI_LOAD_ERROR        Image was not loaded because the image format was corrupt or not
+                                understood.
+  @retval EFI_DEVICE_ERROR      Image was not loaded because the device returned a read error.
+  @retval EFI_ACCESS_DENIED     Image was not loaded because the platform policy prohibits the
+                                image from being loaded. NULL is returned in *ImageHandle.
+  @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
+                                valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
+                                platform policy specifies that the image should not be started.
+**/
 typedef
 EFI_STATUS
-(EFIAPI *LOAD_PE_IMAGE) (
+(EFIAPI *LOAD_PE_IMAGE)(
   IN EFI_PE32_IMAGE_PROTOCOL           *This,
   IN  EFI_HANDLE                       ParentImageHandle,
   IN  EFI_DEVICE_PATH_PROTOCOL         *FilePath,
   IN  VOID                             *SourceBuffer       OPTIONAL,
   IN  UINTN                            SourceSize,
   IN  EFI_PHYSICAL_ADDRESS             DstBuffer           OPTIONAL,
-  OUT UINTN                            *NumberOfPages      OPTIONAL,
+  IN OUT UINTN                         *NumberOfPages      OPTIONAL,
   OUT EFI_HANDLE                       *ImageHandle,
   OUT EFI_PHYSICAL_ADDRESS             *EntryPoint         OPTIONAL,
   IN  UINT32                           Attribute
   );
 
+/**
+
+  Unload the specified image.
+
+  @param  This             The pointer to the LoadPe32Image protocol instance
+  @param  ImageHandle      The specified image handle to be unloaded.
+
+  @retval EFI_INVALID_PARAMETER Image handle is NULL.
+  @retval EFI_UNSUPPORTED       Attempted to unload an unsupported image.
+  @retval EFI_SUCCESS           The image successfully unloaded.
+
+--*/
 typedef
 EFI_STATUS
-(EFIAPI *UNLOAD_PE_IMAGE) (
+(EFIAPI *UNLOAD_PE_IMAGE)(
   IN EFI_PE32_IMAGE_PROTOCOL          *This,
   IN EFI_HANDLE                       ImageHandle
   );
 
 struct _EFI_PE32_IMAGE_PROTOCOL {
   LOAD_PE_IMAGE     LoadPeImage;
-  UNLOAD_PE_IMAGE  UnLoadPeImage;
+  UNLOAD_PE_IMAGE   UnLoadPeImage;
 };
 
 extern EFI_GUID gEfiLoadPeImageProtocolGuid;