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 **/
  17
  18 #ifndef __LOADED_IMAGE_PROTOCOL_H__
  19 #define __LOADED_IMAGE_PROTOCOL_H__
  20
  21 #include <Protocol/DevicePath.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 // Protocol GUID defined in EFI1.1.
  30 //
  31 #define LOADED_IMAGE_PROTOCOL   EFI_LOADED_IMAGE_PROTOCOL_GUID
  32
  33 //
  34 // EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h
  35 //
  36 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION  0x1000
  37
  38 //
  39 // Revision defined in EFI1.1.
  40 //
  41 #define EFI_LOADED_IMAGE_INFORMATION_REVISION    EFI_LOADED_IMAGE_PROTOCOL_REVISION
  42
  43
  44 typedef struct {
  45   UINT32                    Revision;
  46   EFI_HANDLE                ParentHandle;
  47   EFI_SYSTEM_TABLE          *SystemTable;
  48
  49   //
  50   // Source location of image
  51   //
  52   EFI_HANDLE                DeviceHandle;
  53   EFI_DEVICE_PATH_PROTOCOL  *FilePath;
  54   VOID                      *Reserved;
  55
  56   //
  57   // Images load options
  58   //
  59   UINT32                    LoadOptionsSize;
  60   VOID                      *LoadOptions;
  61
  62   //
  63   // Location of where image was loaded
  64   //
  65   VOID                      *ImageBase;
  66   UINT64                    ImageSize;
  67   EFI_MEMORY_TYPE           ImageCodeType;
  68   EFI_MEMORY_TYPE           ImageDataType;
  69
  70   //
  71   // If the driver image supports a dynamic unload request
  72   //
  73   EFI_IMAGE_UNLOAD          Unload;
  74
  75 } EFI_LOADED_IMAGE_PROTOCOL;
  76
  77 //
  78 // For backward-compatible with EFI1.1.
  79 //
  80 typedef EFI_LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE;
  81
  82 extern EFI_GUID gEfiLoadedImageProtocolGuid;
  83
  84 #endif