Update copyright for files modified in this year

[mirror_edk2.git] / MdePkg / Include / Guid / DebugImageInfoTable.h

diff --git a/MdePkg/Include/Guid/DebugImageInfoTable.h b/MdePkg/Include/Guid/DebugImageInfoTable.h
index 0ab4248f0f38a666e29f98d56f4a5cf461096a41..ee3ff90e398afe871ea0739ef5833f3ec382db9d 100644 (file)
--- a/MdePkg/Include/Guid/DebugImageInfoTable.h
+++ b/MdePkg/Include/Guid/DebugImageInfoTable.h
@@ -1,7 +1,7 @@
 /** @file\r
   GUID and related data structures used with the Debug Image Info Table.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  DebugImageInfoTable.h\r
-\r
   @par Revision Reference:\r
   GUID defined in UEFI 2.0 spec.\r
 \r
@@ -20,27 +18,40 @@
 #ifndef __DEBUG_IMAGE_INFO_GUID_H__\r
 #define __DEBUG_IMAGE_INFO_GUID_H__\r
 \r
+#include <Protocol/LoadedImage.h>\r
+\r
+///\r
+/// EFI_DEBUG_IMAGE_INFO_TABLE configuration table GUID declaration.\r
+///\r
 #define EFI_DEBUG_IMAGE_INFO_TABLE_GUID \\r
   { \\r
     0x49152e77, 0x1ada, 0x4764, {0xb7, 0xa2, 0x7a, 0xfe, 0xfe, 0xd9, 0x5e, 0x8b } \\r
   }\r
 \r
-extern EFI_GUID gEfiDebugImageInfoTableGuid;\r
-\r
 #define EFI_DEBUG_IMAGE_INFO_UPDATE_IN_PROGRESS 0x01\r
 #define EFI_DEBUG_IMAGE_INFO_TABLE_MODIFIED     0x02\r
-#define EFI_DEBUG_IMAGE_INFO_INITIAL_SIZE       (EFI_PAGE_SIZE / sizeof (UINTN))\r
+\r
 #define EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL        0x01\r
 \r
 typedef struct {\r
-  UINT64                Signature;\r
-  EFI_PHYSICAL_ADDRESS  EfiSystemTableBase;\r
-  UINT32                Crc32;\r
+  UINT64                Signature;          ///< A constant UINT64 that has the value EFI_SYSTEM_TABLE_SIGNATURE\r
+  EFI_PHYSICAL_ADDRESS  EfiSystemTableBase; ///< The physical address of the EFI system table. \r
+  UINT32                Crc32;              ///< A 32-bit CRC value that is used to verify the EFI_SYSTEM_TABLE_POINTER structure is valid.\r
 } EFI_SYSTEM_TABLE_POINTER;\r
 \r
 typedef struct {\r
+  ///\r
+  /// Indicates the type of image info structure. For PE32 EFI images,\r
+  /// this is set to EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL.\r
+  ///\r
   UINT32                     ImageInfoType;\r
+  ///\r
+  /// A pointer to an instance of the loaded image protocol for the associated image.\r
+  ///\r
   EFI_LOADED_IMAGE_PROTOCOL  *LoadedImageProtocolInstance;\r
+  ///\r
+  /// Indicates the image handle of the associated image.\r
+  ///\r
   EFI_HANDLE                 ImageHandle;\r
 } EFI_DEBUG_IMAGE_INFO_NORMAL;\r
 \r
@@ -50,9 +61,20 @@ typedef union {
 } EFI_DEBUG_IMAGE_INFO;\r
 \r
 typedef struct {\r
+  ///\r
+  /// UpdateStatus is used by the system to indicate the state of the debug image info table.\r
+  ///\r
   volatile UINT32       UpdateStatus;\r
+  ///\r
+  /// The number of EFI_DEBUG_IMAGE_INFO elements in the array pointed to by EfiDebugImageInfoTable.\r
+  ///\r
   UINT32                TableSize;\r
+  ///\r
+  /// A pointer to the first element of an array of EFI_DEBUG_IMAGE_INFO structures.\r
+  ///\r
   EFI_DEBUG_IMAGE_INFO  *EfiDebugImageInfoTable;\r
 } EFI_DEBUG_IMAGE_INFO_TABLE_HEADER;\r
 \r
+extern EFI_GUID gEfiDebugImageInfoTableGuid;\r
+\r
 #endif\r