Remove undefined comments for status PCD.

Add comments for DebugImageInfoTable, FileInfo, FileSystemInfo and FileSystemVolumeLabelInfo Guid structure.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6914 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Guid/DebugImageInfoTable.h b/MdePkg/Include/Guid/DebugImageInfoTable.h
index d86e64f02efabb9b520dc075106464e746c233af..4404ace03b9e9b68998238163de438ad808a5293 100644 (file)
--- a/MdePkg/Include/Guid/DebugImageInfoTable.h
+++ b/MdePkg/Include/Guid/DebugImageInfoTable.h
@@ -20,6 +20,9 @@
 \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
@@ -31,14 +34,24 @@
 #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
@@ -48,12 +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
-\r
 extern EFI_GUID gEfiDebugImageInfoTableGuid;\r
 \r
 #endif\r

diff --git a/MdePkg/Include/Guid/FileInfo.h b/MdePkg/Include/Guid/FileInfo.h
index a9f64666f3712542aede8de14f95e9717b669d4c..271005f3098e1734bf5d0f8dfaf205279b83ce9c 100644 (file)
--- a/MdePkg/Include/Guid/FileInfo.h
+++ b/MdePkg/Include/Guid/FileInfo.h
@@ -1,13 +1,9 @@
 /** @file\r
-  SimpleFileSystem guid and data structure as defined in the UEFI 2.0 specification.\r
+  Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo()\r
+  and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.\r
+  This guid is defined in UEFI specification.\r
 \r
-  The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r
-  file system specified in UEFI 2.0. It can also be used to abstract any \r
-  file system other than FAT.\r
-\r
-  UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem\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
@@ -27,13 +23,37 @@
   }\r
 \r
 typedef struct {\r
+  ///\r
+  /// Size of the EFI_FILE_INFO structure, including the Nullterminated Unicode FileName string.\r
+  ///\r
   UINT64    Size;\r
+  ///\r
+  /// The size of the file in bytes.\r
+  ///\r
   UINT64    FileSize;\r
+  ///\r
+  /// PhysicalSize The amount of physical space the file consumes on the file system volume.\r
+  ///\r
   UINT64    PhysicalSize;\r
+  ///\r
+  /// The time the file was created.\r
+  ///\r
   EFI_TIME  CreateTime;\r
+  ///\r
+  /// The time when the file was last accessed.\r
+  ///\r
   EFI_TIME  LastAccessTime;\r
+  ///\r
+  /// The time when the file's contents were last modified.\r
+  ///\r
   EFI_TIME  ModificationTime;\r
+  ///\r
+  /// The attribute bits for the file.\r
+  ///\r
   UINT64    Attribute;\r
+  ///\r
+  /// The Null-terminated Unicode name of the file.\r
+  ///\r
   CHAR16    FileName[1];\r
 } EFI_FILE_INFO;\r
 \r

diff --git a/MdePkg/Include/Guid/FileSystemInfo.h b/MdePkg/Include/Guid/FileSystemInfo.h
index 6ed28b4f20f94b303e510887f08f4eacd85d31f5..d1515a8c2a13105c59889d54b5e9bda85f271a32 100644 (file)
--- a/MdePkg/Include/Guid/FileSystemInfo.h
+++ b/MdePkg/Include/Guid/FileSystemInfo.h
@@ -1,7 +1,9 @@
 /** @file\r
-  FileSystemInfo guid and data structure as defined in the UEFI 2.0 specification.\r
+  Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.GetInfo()\r
+  or EFI_FILE_PROTOCOL.SetInfo() to get or set information about the system's volume.\r
+  This guid is defined in UEFI specification.\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
@@ -21,11 +23,29 @@
   }\r
 \r
 typedef struct {\r
+  ///\r
+  /// Size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated Unicode VolumeLabel string.\r
+  ///\r
   UINT64  Size;\r
+  ///\r
+  /// TRUE if the volume only supports read access.\r
+  ///\r
   BOOLEAN ReadOnly;\r
+  ///\r
+  /// The number of bytes managed by the file system.\r
+  ///\r
   UINT64  VolumeSize;\r
+  ///\r
+  /// The number of available bytes for use by the file system.\r
+  ///\r
   UINT64  FreeSpace;\r
+  ///\r
+  /// The nominal block size by which files are typically grown.\r
+  ///\r
   UINT32  BlockSize;\r
+  ///\r
+  /// The Null-terminated string that is the volume's label.\r
+  ///\r
   CHAR16  VolumeLabel[1];\r
 } EFI_FILE_SYSTEM_INFO;\r
 \r

diff --git a/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h b/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h
index 6413ee7da076368f797ecb8e911adaf005385cd6..b9c2d4d4a52de7e52ac01e308e1041f63e7280a2 100644 (file)
--- a/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h
+++ b/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h
@@ -1,5 +1,7 @@
 /** @file\r
-  FileSystemVolumeLabelInfo guid and data structure as defined in the UEFI 2.0 specification.\r
+  Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.GetInfo()\r
+  or EFI_FILE_PROTOCOL.SetInfo() to get or set the system's volume label.\r
+  This guid is defined in UEFI specification.\r
 \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
@@ -20,13 +22,13 @@
     0xDB47D7D3, 0xFE81, 0x11d3, {0x9A, 0x35, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } \\r
   }\r
 \r
-//\r
-// Protocol Name defined in spec.\r
-//\r
 #define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \\r
         EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID_GUID\r
 \r
 typedef struct {\r
+  ///\r
+  /// The Null-terminated string that is the volume's label.\r
+  ///\r
   CHAR16  VolumeLabel[1];\r
 } EFI_FILE_SYSTEM_VOLUME_LABEL_INFO;\r
 \r

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index c361db3490ac7c89adca0429788a4475cdb56b50..1eb0240fcf66fcebb0a2ad0aaaf37a9ceb6568f8 100644 (file)
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -440,35 +440,27 @@
   gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize|320|UINT32|0x101\r
   \r
   ## Status code value for indicating a watchdog timer is expired\r
-  # EFI_COMPUTING_UNIT_HOST_PROCESSOR | EFI_CU_HP_EC_TIMER_EXPIRED\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueEfiWatchDogTimerExpired|0x00011003|UINT32|0x00000013   \r
 \r
   ## Status code value for indicating the invocation of SetVirtualAddressMap()\r
-  # EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_RS_PC_SET_VIRTUAL_ADDRESS_MAP\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueSetVirtualAddressMap|0x03101004|UINT32|0x00000014\r
 \r
   ## Status code value for indicating the start of memory test\r
-  # EFI_COMPUTING_UNIT_MEMORY | EFI_CU_MEMORY_PC_TEST\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueMemoryTestStarted|0x00051006|UINT32|0x00000015\r
 \r
   ## Status code value for indicating memory error in memory test\r
-  # EFI_COMPUTING_UNIT_MEMORY | EFI_CU_MEMORY_EC_UNCORRECTABLE\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueUncorrectableMemoryError|0x00051003|UINT32|0x00000016\r
 \r
   ## Status code value for indicating the failure of console operation\r
-  # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_CONTROLLER_ERROR\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleError|0x01040006|UINT32|0x00000017\r
 \r
   ## Status code value for indicating the failure of console reset operation\r
-  # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_PC_RESET\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleReset|0x01040001|UINT32|0x00000018\r
 \r
   ## Status code value for indicating the failure of console input operation\r
-  # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_INPUT_ERROR\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleInputError|0x01040007|UINT32|0x00000019\r
 \r
   ## Status code value for indicating the failure of console output operation\r
-  # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_OUTPUT_ERROR\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleOutputError|0x01040008|UINT32|0x0000001a\r
 \r
   ## Status code value for indicating the failure of mouse operation\r
@@ -542,35 +534,27 @@
   gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType|0|UINT8|0x00000024  \r
   \r
   ## Status code value for indicating the handoff from Pei phase to Dxe phase\r
-  # EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_CORE_PC_HANDOFF_TO_NEXT\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValuePeiHandoffToDxe|0x3031001|UINT32|0x3000100d\r
 \r
   ## Status code value for indicating one PEIM is dispatched.\r
-  #  value: EFI_SOFTWARE_PEI_CORE | EFI_SW_PC_INIT_BEGIN\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValuePeimDispatch|0x3020002|UINT32|0x3000100e\r
 \r
   ## Status code value for indicating entering PeiCore\r
-  #  value: EFI_SOFTWARE_PEI_CORE | EFI_SW_PC_INIT\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValuePeiCoreEntry|0x3020000|UINT32|0x3000100f\r
 \r
   ## Status code value for indicating entering DxeCore\r
-  # EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_ENTRY_POINT\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeCoreEntry|0x3041000|UINT32|0x30001010\r
 \r
   ## Status code value for indicating the handoff from DxeCore to Bds\r
-  # EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeCoreHandoffToBds|0x3041001|UINT32|0x30001011\r
 \r
   ## Status code value for indicating the exit of boot service\r
-  # EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_BS_PC_EXIT_BOOT_SERVICES\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueBootServiceExit|0x3100019|UINT32|0x30001012\r
 \r
   ## Status code value for indicating the begin of Dxe driver\r
-  # EFI_SOFTWARE_DXE_CORE | EFI_SW_PC_INIT_BEGIN\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeDriverBegin|0x3040002|UINT32|0x30001013\r
 \r
   ## Status code value for indicating the end of Dxe driver\r
-  # EFI_SOFTWARE_DXE_CORE | EFI_SW_PC_INIT_END\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeDriverEnd|0x3040003|UINT32|0x30001014\r
 \r
 [PcdsFixedAtBuild.IPF]\r
@@ -646,6 +630,3 @@
   \r
   ## This value is used to set the base address of pci express hierarchy\r
   gEfiMdePkgTokenSpaceGuid.PcdPciExpressBaseAddress|0xE0000000|UINT64|0x0000000a\r
-\r
-\r
-\r