iPXE
LoadedImage.h
Go to the documentation of this file.
1 /** @file
2  UEFI 2.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 - 2008, Intel Corporation. All rights reserved.<BR>
8  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 FILE_LICENCE ( BSD3 );
22 
23 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
24  { \
25  0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \
26  }
27 
28 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
29  { \
30  0xbc62157e, 0x3e33, 0x4fec, {0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf } \
31  }
32 
33 ///
34 /// Protocol GUID defined in EFI1.1.
35 ///
36 #define LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE_PROTOCOL_GUID
37 
38 ///
39 /// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h
40 ///
41 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
42 
43 ///
44 /// Revision defined in EFI1.1.
45 ///
46 #define EFI_LOADED_IMAGE_INFORMATION_REVISION EFI_LOADED_IMAGE_PROTOCOL_REVISION
47 
48 ///
49 /// Can be used on any image handle to obtain information about the loaded image.
50 ///
51 typedef struct {
52  UINT32 Revision; ///< Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure.
53  ///< All future revisions will be backward compatible to the current revision.
54  EFI_HANDLE ParentHandle; ///< Parent image's image handle. NULL if the image is loaded directly from
55  ///< the firmware's boot manager.
56  EFI_SYSTEM_TABLE *SystemTable; ///< the image's EFI system table pointer.
57 
58  //
59  // Source location of image
60  //
61  EFI_HANDLE DeviceHandle; ///< The device handle that the EFI Image was loaded from.
62  EFI_DEVICE_PATH_PROTOCOL *FilePath; ///< A pointer to the file path portion specific to DeviceHandle
63  ///< that the EFI Image was loaded from.
64  VOID *Reserved; ///< Reserved. DO NOT USE.
65 
66  //
67  // Images load options
68  //
69  UINT32 LoadOptionsSize;///< The size in bytes of LoadOptions.
70  VOID *LoadOptions; ///< A pointer to the image's binary load options.
71 
72  //
73  // Location of where image was loaded
74  //
75  VOID *ImageBase; ///< The base address at which the image was loaded.
76  UINT64 ImageSize; ///< The size in bytes of the loaded image.
77  EFI_MEMORY_TYPE ImageCodeType; ///< The memory type that the code sections were loaded as.
78  EFI_MEMORY_TYPE ImageDataType; ///< The memory type that the data sections were loaded as.
81 
82 //
83 // For backward-compatible with EFI1.1.
84 //
86 
89 
90 #endif
EFI_GUID gEfiLoadedImageProtocolGuid
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
UINT64 ImageSize
The size in bytes of the loaded image.
Definition: LoadedImage.h:76
EFI_DEVICE_PATH_PROTOCOL * FilePath
A pointer to the file path portion specific to DeviceHandle that the EFI Image was loaded from.
Definition: LoadedImage.h:62
unsigned int UINT32
Definition: ProcessorBind.h:56
VOID * ImageBase
The base address at which the image was loaded.
Definition: LoadedImage.h:75
This protocol can be used on any device handle to obtain generic path/location information concerning...
Definition: DevicePath.h:51
EFI_MEMORY_TYPE ImageCodeType
The memory type that the code sections were loaded as.
Definition: LoadedImage.h:77
UINT32 Revision
Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure.
Definition: LoadedImage.h:52
Can be used on any image handle to obtain information about the loaded image.
Definition: LoadedImage.h:51
EFI_MEMORY_TYPE
Enumeration of memory types introduced in UEFI.
VOID * LoadOptions
A pointer to the image's binary load options.
Definition: LoadedImage.h:70
EFI_GUID gEfiLoadedImageDevicePathProtocolGuid
FILE_LICENCE(BSD3)
EFI_MEMORY_TYPE ImageDataType
The memory type that the data sections were loaded as.
Definition: LoadedImage.h:78
EFI_STATUS(EFIAPI * EFI_IMAGE_UNLOAD)(IN EFI_HANDLE ImageHandle)
Unloads an image.
Definition: UefiSpec.h:943
EFI_IMAGE_UNLOAD Unload
Definition: LoadedImage.h:79
EFI System Table.
Definition: UefiSpec.h:1949
#define VOID
Undeclared type.
Definition: Base.h:319
unsigned long long UINT64
Definition: ProcessorBind.h:54
UINT32 LoadOptionsSize
The size in bytes of LoadOptions.
Definition: LoadedImage.h:69
VOID * Reserved
Reserved. DO NOT USE.
Definition: LoadedImage.h:64
EFI_SYSTEM_TABLE * SystemTable
the image's EFI system table pointer.
Definition: LoadedImage.h:56
EFI_HANDLE ParentHandle
Parent image's image handle.
Definition: LoadedImage.h:54
Definition: efi.h:55
EFI_HANDLE DeviceHandle
The device handle that the EFI Image was loaded from.
Definition: LoadedImage.h:61
EFI_LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE
Definition: LoadedImage.h:85