supply comments on data structure to follow spec.
authoreric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 7 Jul 2009 06:36:42 +0000 (06:36 +0000)
committereric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 7 Jul 2009 06:36:42 +0000 (06:36 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8779 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkPkg/Include/Guid/StatusCodeDataTypeId.h

index 6019b0f09feb5f6a42a3b4256ed5bc46fe5df4e4..ce82e4ff3f106d159138c96429da50eb3798886c 100644 (file)
 #pragma pack(1)\r
 \r
 typedef enum {\r
+  ///\r
+  /// A NULL-terminated ASCII string.\r
+  ///\r
   EfiStringAscii,\r
+  ///\r
+  /// A double NULL-terminated Unicode string.\r
+  ///\r
   EfiStringUnicode,\r
+  ///\r
+  /// An EFI_STATUS_CODE_STRING_TOKEN representing the string. The actual string\r
+  /// can be obtained by querying the HII Database.\r
+  ///\r
   EfiStringToken\r
 } EFI_STRING_TYPE;\r
 \r
 typedef struct {\r
+  ///\r
+  /// The HII handle of the string pack, which can be used to retrieve the string. \r
+  /// It is a dynamic value that may not be the same for different boots.\r
+  ///\r
   FRAMEWORK_EFI_HII_HANDLE  Handle;\r
+  ///\r
+  /// When combined with the HII handle, the string token can be used to retrieve the\r
+  /// string. \r
+  ///\r
   STRING_REF      Token;\r
 } EFI_STATUS_CODE_STRING_TOKEN;\r
 \r
 typedef union {\r
+  ///\r
+  /// ASCII formatted string.\r
+  ///\r
   CHAR8                         *Ascii;\r
+  ///\r
+  /// Unicode formatted string.\r
+  ///\r
   CHAR16                        *Unicode;\r
+  ///\r
+  /// HII handle/token pair.\r
+  ///\r
   EFI_STATUS_CODE_STRING_TOKEN  Hii;\r
 } EFI_STATUS_CODE_STRING;\r
 \r
 typedef struct {\r
+  ///\r
+  /// The data header identifying the data. The HeaderSize should be sizeof\r
+  /// (EFI_STATUS_CODE_DATA).\r
+  /// The Size should be sizeof(EFI_STATUS_CODE_STRING_DATA) - HeaderSize.\r
+  /// The Type should be EFI_STATUS_CODE_DATA_TYPE_STRING_GUID.\r
+  ///\r
   EFI_STATUS_CODE_DATA                          DataHeader;\r
+  ///\r
+  /// Specifies if the string is ASCII or Unicode.\r
+  ///\r
   EFI_STRING_TYPE                               StringType;\r
+  ///\r
+  /// A pointer to a null-terminated ASCII or Unicode string.\r
+  ///\r
   EFI_STATUS_CODE_STRING                        String;\r
 } EFI_STATUS_CODE_STRING_DATA;\r
 #pragma pack()\r
@@ -78,12 +117,18 @@ typedef struct {
   EFI_HANDLE            Handle;\r
 } EFI_DEVICE_HANDLE_EXTENDED_DATA;\r
 \r
-\r
+///\r
+/// Extended data about the device path, which is used for many errors and \r
+/// progress codes to point to the device.\r
+///\r
 typedef struct {\r
   EFI_STATUS_CODE_DATA                 DataHeader;\r
   UINT8                                *DevicePath;\r
 } EFI_DEVICE_PATH_EXTENDED_DATA;\r
 \r
+///\r
+/// This structure defines extended data describing a PCI resource allocation error.\r
+///\r
 typedef struct {\r
   EFI_STATUS_CODE_DATA               DataHeader;\r
   UINT32                             Bar;\r