]> git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/Guid/DebugImageInfoTable.h
Clarify some definitions in HII Configure Routine Protocol
[mirror_edk2.git] / MdePkg / Include / Guid / DebugImageInfoTable.h
1 /** @file
2 GUID and related data structures used with the Debug Image Info Table.
3
4 Copyright (c) 2006 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 @par Revision Reference:
14 GUID defined in UEFI 2.0 spec.
15
16 **/
17
18 #ifndef __DEBUG_IMAGE_INFO_GUID_H__
19 #define __DEBUG_IMAGE_INFO_GUID_H__
20
21 #include <Protocol/LoadedImage.h>
22
23 ///
24 /// EFI_DEBUG_IMAGE_INFO_TABLE configuration table GUID declaration.
25 ///
26 #define EFI_DEBUG_IMAGE_INFO_TABLE_GUID \
27 { \
28 0x49152e77, 0x1ada, 0x4764, {0xb7, 0xa2, 0x7a, 0xfe, 0xfe, 0xd9, 0x5e, 0x8b } \
29 }
30
31 #define EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS 0x01
32 #define EFI_DEBUG_IMAGE_INFO_TABLE_MODIFIED 0x02
33
34 #define EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL 0x01
35
36 typedef struct {
37 UINT64 Signature; ///< A constant UINT64 that has the value EFI_SYSTEM_TABLE_SIGNATURE
38 EFI_PHYSICAL_ADDRESS EfiSystemTableBase; ///< The physical address of the EFI system table.
39 UINT32 Crc32; ///< A 32-bit CRC value that is used to verify the EFI_SYSTEM_TABLE_POINTER structure is valid.
40 } EFI_SYSTEM_TABLE_POINTER;
41
42 typedef struct {
43 ///
44 /// Indicates the type of image info structure. For PE32 EFI images,
45 /// this is set to EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL.
46 ///
47 UINT32 ImageInfoType;
48 ///
49 /// A pointer to an instance of the loaded image protocol for the associated image.
50 ///
51 EFI_LOADED_IMAGE_PROTOCOL *LoadedImageProtocolInstance;
52 ///
53 /// Indicates the image handle of the associated image.
54 ///
55 EFI_HANDLE ImageHandle;
56 } EFI_DEBUG_IMAGE_INFO_NORMAL;
57
58 typedef union {
59 UINT32 *ImageInfoType;
60 EFI_DEBUG_IMAGE_INFO_NORMAL *NormalImage;
61 } EFI_DEBUG_IMAGE_INFO;
62
63 typedef struct {
64 ///
65 /// UpdateStatus is used by the system to indicate the state of the debug image info table.
66 ///
67 volatile UINT32 UpdateStatus;
68 ///
69 /// The number of EFI_DEBUG_IMAGE_INFO elements in the array pointed to by EfiDebugImageInfoTable.
70 ///
71 UINT32 TableSize;
72 ///
73 /// A pointer to the first element of an array of EFI_DEBUG_IMAGE_INFO structures.
74 ///
75 EFI_DEBUG_IMAGE_INFO *EfiDebugImageInfoTable;
76 } EFI_DEBUG_IMAGE_INFO_TABLE_HEADER;
77
78 extern EFI_GUID gEfiDebugImageInfoTableGuid;
79
80 #endif