xref: /dflybsd-src/stand/contrib/edk2/MdePkg/Include/Guid/DebugImageInfoTable.h (revision 1370a72311f999d5cc5041717aeea26d08ad6923)
1*1370a723SSascha Wildner /** @file
2*1370a723SSascha Wildner   GUID and related data structures used with the Debug Image Info Table.
3*1370a723SSascha Wildner 
4*1370a723SSascha Wildner   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
5*1370a723SSascha Wildner   SPDX-License-Identifier: BSD-2-Clause-Patent
6*1370a723SSascha Wildner 
7*1370a723SSascha Wildner   @par Revision Reference:
8*1370a723SSascha Wildner   GUID defined in UEFI 2.0 spec.
9*1370a723SSascha Wildner 
10*1370a723SSascha Wildner **/
11*1370a723SSascha Wildner 
12*1370a723SSascha Wildner #ifndef __DEBUG_IMAGE_INFO_GUID_H__
13*1370a723SSascha Wildner #define __DEBUG_IMAGE_INFO_GUID_H__
14*1370a723SSascha Wildner 
15*1370a723SSascha Wildner #include <Protocol/LoadedImage.h>
16*1370a723SSascha Wildner 
17*1370a723SSascha Wildner ///
18*1370a723SSascha Wildner /// EFI_DEBUG_IMAGE_INFO_TABLE configuration table GUID declaration.
19*1370a723SSascha Wildner ///
20*1370a723SSascha Wildner #define EFI_DEBUG_IMAGE_INFO_TABLE_GUID \
21*1370a723SSascha Wildner   { \
22*1370a723SSascha Wildner     0x49152e77, 0x1ada, 0x4764, {0xb7, 0xa2, 0x7a, 0xfe, 0xfe, 0xd9, 0x5e, 0x8b } \
23*1370a723SSascha Wildner   }
24*1370a723SSascha Wildner 
25*1370a723SSascha Wildner #define EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS 0x01
26*1370a723SSascha Wildner #define EFI_DEBUG_IMAGE_INFO_TABLE_MODIFIED     0x02
27*1370a723SSascha Wildner 
28*1370a723SSascha Wildner #define EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL        0x01
29*1370a723SSascha Wildner 
30*1370a723SSascha Wildner typedef struct {
31*1370a723SSascha Wildner   UINT64                Signature;          ///< A constant UINT64 that has the value EFI_SYSTEM_TABLE_SIGNATURE
32*1370a723SSascha Wildner   EFI_PHYSICAL_ADDRESS  EfiSystemTableBase; ///< The physical address of the EFI system table.
33*1370a723SSascha Wildner   UINT32                Crc32;              ///< A 32-bit CRC value that is used to verify the EFI_SYSTEM_TABLE_POINTER structure is valid.
34*1370a723SSascha Wildner } EFI_SYSTEM_TABLE_POINTER;
35*1370a723SSascha Wildner 
36*1370a723SSascha Wildner typedef struct {
37*1370a723SSascha Wildner   ///
38*1370a723SSascha Wildner   /// Indicates the type of image info structure. For PE32 EFI images,
39*1370a723SSascha Wildner   /// this is set to EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL.
40*1370a723SSascha Wildner   ///
41*1370a723SSascha Wildner   UINT32                     ImageInfoType;
42*1370a723SSascha Wildner   ///
43*1370a723SSascha Wildner   /// A pointer to an instance of the loaded image protocol for the associated image.
44*1370a723SSascha Wildner   ///
45*1370a723SSascha Wildner   EFI_LOADED_IMAGE_PROTOCOL  *LoadedImageProtocolInstance;
46*1370a723SSascha Wildner   ///
47*1370a723SSascha Wildner   /// Indicates the image handle of the associated image.
48*1370a723SSascha Wildner   ///
49*1370a723SSascha Wildner   EFI_HANDLE                 ImageHandle;
50*1370a723SSascha Wildner } EFI_DEBUG_IMAGE_INFO_NORMAL;
51*1370a723SSascha Wildner 
52*1370a723SSascha Wildner typedef union {
53*1370a723SSascha Wildner   UINT32                      *ImageInfoType;
54*1370a723SSascha Wildner   EFI_DEBUG_IMAGE_INFO_NORMAL *NormalImage;
55*1370a723SSascha Wildner } EFI_DEBUG_IMAGE_INFO;
56*1370a723SSascha Wildner 
57*1370a723SSascha Wildner typedef struct {
58*1370a723SSascha Wildner   ///
59*1370a723SSascha Wildner   /// UpdateStatus is used by the system to indicate the state of the debug image info table.
60*1370a723SSascha Wildner   ///
61*1370a723SSascha Wildner   volatile UINT32       UpdateStatus;
62*1370a723SSascha Wildner   ///
63*1370a723SSascha Wildner   /// The number of EFI_DEBUG_IMAGE_INFO elements in the array pointed to by EfiDebugImageInfoTable.
64*1370a723SSascha Wildner   ///
65*1370a723SSascha Wildner   UINT32                TableSize;
66*1370a723SSascha Wildner   ///
67*1370a723SSascha Wildner   /// A pointer to the first element of an array of EFI_DEBUG_IMAGE_INFO structures.
68*1370a723SSascha Wildner   ///
69*1370a723SSascha Wildner   EFI_DEBUG_IMAGE_INFO  *EfiDebugImageInfoTable;
70*1370a723SSascha Wildner } EFI_DEBUG_IMAGE_INFO_TABLE_HEADER;
71*1370a723SSascha Wildner 
72*1370a723SSascha Wildner extern EFI_GUID gEfiDebugImageInfoTableGuid;
73*1370a723SSascha Wildner 
74*1370a723SSascha Wildner #endif
75