Add comments and DoxyGen format for these files.

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

/** @file\r
\r
  Load File protocol.\r
\r
  Load file protocol exists to supports the addition of new boot devices,\r
  and to support booting from devices that do not map well to file system.\r
  Network boot is done via a LoadFile protocol.\r
\r
  UEFI 2.0 can boot from any device that produces a LoadFile protocol.\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
#ifndef __LOAD_PE32_IMAGE_H__\r
#define __LOAD_PE32_IMAGE_H__\r
\r
#define PE32_IMAGE_PROTOCOL_GUID  \\r
  {0x5cb5c776,0x60d5,0x45ee,{0x88,0x3c,0x45,0x27,0x8,0xcd,0x74,0x3f }}\r
\r
#define EFI_LOAD_PE_IMAGE_ATTRIBUTE_NONE                                 0x00\r
#define EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION                 0x01\r
#define EFI_LOAD_PE_IMAGE_ATTRIBUTE_DEBUG_IMAGE_INFO_TABLE_REGISTRATION  0x02\r
\r
typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;\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 loaded.\r
  @param  SourceBuffer        If not NULL, a pointer to the memory location containing a copy of\r
                              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 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  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
  @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 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 resources.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *LOAD_PE_IMAGE) (\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
  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
typedef\r
EFI_STATUS\r
(EFIAPI *UNLOAD_PE_IMAGE) (\r
  IN EFI_PE32_IMAGE_PROTOCOL          *This,\r
  IN EFI_HANDLE                       ImageHandle\r
  );\r
\r
struct _EFI_PE32_IMAGE_PROTOCOL {\r
  LOAD_PE_IMAGE     LoadPeImage;\r
  UNLOAD_PE_IMAGE  UnLoadPeImage;\r
};\r
\r
extern EFI_GUID gEfiLoadPeImageProtocolGuid;\r
\r
#endif\r
\r