2 UEFI 2.0 Loaded image protocol definition.
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.
7 Copyright (c) 2006 - 2008, 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
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.
18 #ifndef __LOADED_IMAGE_PROTOCOL_H__
19 #define __LOADED_IMAGE_PROTOCOL_H__
21 #include <Protocol/DevicePath.h>
23 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
25 0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \
28 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
30 0xbc62157e, 0x3e33, 0x4fec, {0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf } \
34 /// Protocol GUID defined in EFI1.1.
36 #define LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE_PROTOCOL_GUID
39 /// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h
41 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
44 /// Revision defined in EFI1.1.
46 #define EFI_LOADED_IMAGE_INFORMATION_REVISION EFI_LOADED_IMAGE_PROTOCOL_REVISION
49 @par Protocol Description:
50 Can be used on any image handle to obtain information about the loaded image.
53 Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure.
54 All future revisions will be backward compatible to the current revision.
57 Parent image's image handle. NULL if the image is loaded directly from
58 the firmware's boot manager.
61 The image's EFI system table pointer.
64 The device handle that the EFI Image was loaded from.
67 A pointer to the file path portion specific to DeviceHandle
68 that the EFI Image was loaded from.
73 @param LoadOptionsSize
74 The size in bytes of LoadOptions.
77 A pointer to the image's binary load options.
80 The base address at which the image was loaded.
83 The size in bytes of the loaded image.
92 Function that unloads the image.
97 EFI_HANDLE ParentHandle
;
98 EFI_SYSTEM_TABLE
*SystemTable
;
101 // Source location of image
103 EFI_HANDLE DeviceHandle
;
104 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
108 // Images load options
110 UINT32 LoadOptionsSize
;
114 // Location of where image was loaded
118 EFI_MEMORY_TYPE ImageCodeType
;
119 EFI_MEMORY_TYPE ImageDataType
;
122 // If the driver image supports a dynamic unload request
124 EFI_IMAGE_UNLOAD Unload
;
126 } EFI_LOADED_IMAGE_PROTOCOL
;
129 // For backward-compatible with EFI1.1.
131 typedef EFI_LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE
;
133 extern EFI_GUID gEfiLoadedImageProtocolGuid
;
134 extern EFI_GUID gEfiLoadedImageDevicePathProtocolGuid
;