EdkModulePkg/Include/Protocol/LoadPe32Image.h

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13   LoadPe32Image.h
  14
  15 Abstract:
  16   Load File protocol as defined in the EFI 1.0 specification.
  17
  18   Load file protocol exists to supports the addition of new boot devices,
  19   and to support booting from devices that do not map well to file system.
  20   Network boot is done via a LoadFile protocol.
  21
  22   EFI 1.0 can boot from any device that produces a LoadFile protocol.
  23
  24 --*/
  25
  26 #ifndef __LOAD_PE32_IMAGE_H__
  27 #define __LOAD_PE32_IMAGE_H__
  28
  29 #define PE32_IMAGE_PROTOCOL_GUID  \
  30   {0x5cb5c776,0x60d5,0x45ee,{0x88,0x3c,0x45,0x27,0x8,0xcd,0x74,0x3f }}
  31
  32 #define EFI_LOAD_PE_IMAGE_ATTRIBUTE_NONE                                 0x00
  33 #define EFI_LOAD_PE_IMAGE_ATTRIBUTE_RUNTIME_REGISTRATION                 0x01
  34 #define EFI_LOAD_PE_IMAGE_ATTRIBUTE_DEBUG_IMAGE_INFO_TABLE_REGISTRATION  0x02
  35
  36 typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
  37
  38 typedef
  39 EFI_STATUS
  40 (EFIAPI *LOAD_PE_IMAGE) (
  41   IN EFI_PE32_IMAGE_PROTOCOL           *This,
  42   IN  EFI_HANDLE                       ParentImageHandle,
  43   IN  EFI_DEVICE_PATH_PROTOCOL         *FilePath,
  44   IN  VOID                             *SourceBuffer       OPTIONAL,
  45   IN  UINTN                            SourceSize,
  46   IN  EFI_PHYSICAL_ADDRESS             DstBuffer           OPTIONAL,
  47   OUT UINTN                            *NumberOfPages      OPTIONAL,
  48   OUT EFI_HANDLE                       *ImageHandle,
  49   OUT EFI_PHYSICAL_ADDRESS             *EntryPoint         OPTIONAL,
  50   IN  UINT32                           Attribute
  51   );
  52
  53 typedef
  54 EFI_STATUS
  55 (EFIAPI *UNLOAD_PE_IMAGE) (
  56   IN EFI_PE32_IMAGE_PROTOCOL          *This,
  57   IN EFI_HANDLE                       ImageHandle
  58   );
  59
  60 struct _EFI_PE32_IMAGE_PROTOCOL {
  61   LOAD_PE_IMAGE     LoadPeImage;
  62   UNLOAD_PE_IMAGE  UnLoadPeImage;
  63 };
  64
  65 extern EFI_GUID gEfiLoadPeImageProtocolGuid;
  66
  67 #endif
  68