]>
Commit | Line | Data |
---|---|---|
2832b228 | 1 | /** @file\r |
2 | UEFI 2.2 Deferred Image Load Protocol definition.\r | |
3 | \r | |
9095d37b LG |
4 | This protocol returns information about images whose load was denied because of security\r |
5 | considerations. This information can be used by the Boot Manager or another agent to reevaluate the\r | |
6 | images when the current security profile has been changed, such as when the current user profile\r | |
2832b228 | 7 | changes. There can be more than one instance of this protocol installed.\r |
8 | \r | |
9095d37b | 9 | Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 10 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
2832b228 | 11 | \r |
12 | **/\r | |
13 | \r | |
14 | #ifndef __DEFERRED_IMAGE_LOAD_H__\r | |
15 | #define __DEFERRED_IMAGE_LOAD_H__\r | |
16 | \r | |
17 | ///\r | |
18 | /// Global ID for the Deferred Image Load Protocol\r | |
19 | ///\r | |
20 | #define EFI_DEFERRED_IMAGE_LOAD_PROTOCOL_GUID \\r | |
21 | { \\r | |
22 | 0x15853d7c, 0x3ddf, 0x43e0, { 0xa1, 0xcb, 0xeb, 0xf8, 0x5b, 0x8f, 0x87, 0x2c } \\r | |
23 | };\r | |
24 | \r | |
25 | typedef struct _EFI_DEFERRED_IMAGE_LOAD_PROTOCOL EFI_DEFERRED_IMAGE_LOAD_PROTOCOL;\r | |
26 | \r | |
27 | /**\r | |
28 | Returns information about a deferred image.\r | |
29 | \r | |
9095d37b LG |
30 | This function returns information about a single deferred image. The deferred images are numbered\r |
31 | consecutively, starting with 0. If there is no image which corresponds to ImageIndex, then\r | |
32 | EFI_NOT_FOUND is returned. All deferred images may be returned by iteratively calling this\r | |
2832b228 | 33 | function until EFI_NOT_FOUND is returned.\r |
9095d37b | 34 | Image may be NULL and ImageSize set to 0 if the decision to defer execution was made because\r |
2832b228 | 35 | of the location of the executable image rather than its actual contents. record handle until\r |
9095d37b | 36 | there are no more, at which point UserInfo will point to NULL.\r |
2832b228 | 37 | \r |
7fedcf9d | 38 | @param[in] This Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.\r |
39 | @param[in] ImageIndex Zero-based index of the deferred index.\r | |
9095d37b LG |
40 | @param[out] ImageDevicePath On return, points to a pointer to the device path of the image.\r |
41 | The device path should not be freed by the caller.\r | |
42 | @param[out] Image On return, points to the first byte of the image or NULL if the\r | |
43 | image is not available. The image should not be freed by the caller\r | |
44 | unless LoadImage() has been called successfully.\r | |
7fedcf9d | 45 | @param[out] ImageSize On return, the size of the image, or 0 if the image is not available.\r |
9095d37b LG |
46 | @param[out] BootOption On return, points to TRUE if the image was intended as a boot option\r |
47 | or FALSE if it was not intended as a boot option.\r | |
48 | \r | |
7fedcf9d | 49 | @retval EFI_SUCCESS Image information returned successfully.\r |
50 | @retval EFI_NOT_FOUND ImageIndex does not refer to a valid image.\r | |
9095d37b | 51 | @retval EFI_INVALID_PARAMETER ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or\r |
7fedcf9d | 52 | BootOption is NULL.\r |
2832b228 | 53 | **/\r |
54 | typedef\r | |
55 | EFI_STATUS\r | |
56 | (EFIAPI *EFI_DEFERRED_IMAGE_INFO)(\r | |
57 | IN EFI_DEFERRED_IMAGE_LOAD_PROTOCOL *This,\r | |
58 | IN UINTN ImageIndex,\r | |
59 | OUT EFI_DEVICE_PATH_PROTOCOL **ImageDevicePath,\r | |
60 | OUT VOID **Image,\r | |
61 | OUT UINTN *ImageSize,\r | |
62 | OUT BOOLEAN *BootOption\r | |
63 | );\r | |
64 | \r | |
65 | ///\r | |
66 | /// This protocol returns information about a deferred image.\r | |
67 | ///\r | |
68 | struct _EFI_DEFERRED_IMAGE_LOAD_PROTOCOL {\r | |
69 | EFI_DEFERRED_IMAGE_INFO GetImageInfo;\r | |
70 | };\r | |
71 | \r | |
72 | extern EFI_GUID gEfiDeferredImageLoadProtocolGuid;\r | |
73 | \r | |
74 | #endif\r |