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