MdePkg/Include/Protocol/LoadedImage.h

   1 /** @file
   2   EFI 1.0 Loaded image protocol definition.
   3
   4   Every EFI driver and application is passed an image handle when it is loaded.
   5   This image handle will contain a Loaded Image Protocol.
   6
   7   Copyright (c) 2006, Intel Corporation
   8   All rights reserved. This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   Module Name:  LoadedImage.h
  17
  18 **/
  19
  20 #ifndef __LOADED_IMAGE_PROTOCOL_H__
  21 #define __LOADED_IMAGE_PROTOCOL_H__
  22
  23 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
  24   { \
  25     0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \
  26   }
  27
  28 //
  29 // EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h
  30 //
  31 #define EFI_LOADED_IMAGE_INFORMATION_REVISION 0x1000
  32 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION    EFI_LOADED_IMAGE_INFORMATION_REVISION
  33
  34 typedef struct {
  35   UINT32                    Revision;
  36   EFI_HANDLE                ParentHandle;
  37   EFI_SYSTEM_TABLE          *SystemTable;
  38
  39   //
  40   // Source location of image
  41   //
  42   EFI_HANDLE                DeviceHandle;
  43   EFI_DEVICE_PATH_PROTOCOL  *FilePath;
  44   VOID                      *Reserved;
  45
  46   //
  47   // Images load options
  48   //
  49   UINT32                    LoadOptionsSize;
  50   VOID                      *LoadOptions;
  51
  52   //
  53   // Location of where image was loaded
  54   //
  55   VOID                      *ImageBase;
  56   UINT64                    ImageSize;
  57   EFI_MEMORY_TYPE           ImageCodeType;
  58   EFI_MEMORY_TYPE           ImageDataType;
  59
  60   //
  61   // If the driver image supports a dynamic unload request
  62   //
  63   EFI_IMAGE_UNLOAD          Unload;
  64
  65 } EFI_LOADED_IMAGE_PROTOCOL;
  66
  67 extern EFI_GUID gEfiLoadedImageProtocolGuid;
  68
  69 #endif