Update comments

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Guid / MemoryStatusCodeRecord.h

diff --git a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
index 4f623b5de6dcbea69d2a28687b8f5684731d1f3c..c435aab8f937d93dbe2d8634c5d94d7674b69378 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
@@ -1,46 +1,82 @@
 /** @file\r
   GUID used to identify status code records HOB that originate from the PEI status code    \r
   \r
-Copyright (c) 2006, 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
-http://opensource.org/licenses/bsd-license.php                                            \r
-                                                                                          \r
-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
+  Copyright (c) 2006 - 2009, 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
+  http://opensource.org/licenses/bsd-license.php                                            \r
+                                                                                            \r
+  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
 **/\r
 \r
 #ifndef __MEMORY_STATUS_CODE_RECORD_H__\r
 #define __MEMORY_STATUS_CODE_RECORD_H__\r
 \r
+///\r
+/// Global ID used to identify GUIDed HOBs that start with a structure of type \r
+/// MEMORY_STATUSCODE_PACKET_HEADER followed by an arry of structures of type \r
+/// MEMORY_STATUSCODE_RECORD.  These GUIDed HOBs record all the information \r
+/// passed into the ReportStatusCode() service of PEI Services Table.\r
+///\r
+///  <pre>\r
+///  Memory status code records packet structure :\r
+///  +---------------+----------+----------+-----+----------+-----+----------+\r
+///  | Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |\r
+///  +---------------+----------+----------+-----+----------+-----+----------+\r
+///                  ^                                 ^                     ^\r
+///                  +--------- RecordIndex -----------+                     |\r
+///                  +---------------- MaxRecordsNumber----------------------+\r
+///  </pre>\r
+///\r
 #define MEMORY_STATUS_CODE_RECORD_GUID \\r
   { \\r
     0x60cc026, 0x4c0d, 0x4dda, {0x8f, 0x41, 0x59, 0x5f, 0xef, 0x0, 0xa5, 0x2} \\r
   }\r
 \r
-/**\r
-  Memory status code records packet structure :\r
-  +---------------+----------+----------+-----+----------+-----+----------+\r
-  | Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |\r
-  +---------------+----------+----------+-----+----------+-----+----------+\r
-                  ^                                 ^                     ^\r
-                  +--------- RecordIndex -----------+                     |\r
-                  +---------------- MaxRecordsNumber----------------------+\r
-**/\r
+///\r
+/// A header structure that is followed by an array of records that contain the \r
+/// parameters passed into the ReportStatusCode() service in the PEI Services Table.\r
+///\r
 typedef struct {\r
-  UINT16                  PacketIndex;          // Index of the Packet.\r
-  UINT16                  RecordIndex;          // Index of record in the packet.\r
-  UINT32                  MaxRecordsNumber;     // Max number of records in the packet.\r
+  ///\r
+  /// Index of the packet\r
+  ///\r
+  UINT16  PacketIndex;\r
+  ///\r
+  /// The number of active records in the packet\r
+  ///\r
+  UINT16  RecordIndex;\r
+  ///\r
+  /// The maximum number of records that the packet can store\r
+  ///\r
+  UINT32  MaxRecordsNumber;\r
 } MEMORY_STATUSCODE_PACKET_HEADER;\r
 \r
+///\r
+/// A structure that contains the parameters passed into the ReportStatusCode() \r
+/// service in the PEI Services Table.\r
+///\r
 typedef struct {\r
-  EFI_STATUS_CODE_TYPE    CodeType;\r
-  EFI_STATUS_CODE_VALUE   Value;\r
-  UINT32                  Instance;\r
-} MEMORY_STATUSCODE_RECORD;\r
+  ///\r
+  /// Status Code type to be reported.\r
+  ///\r
+  EFI_STATUS_CODE_TYPE   CodeType;\r
 \r
+  ///\r
+  /// Valu information about the class and subclass is used to\r
+  /// classify the hardware and software entity as well as an operation.\r
+  ///\r
+  EFI_STATUS_CODE_VALUE  Value;\r
+\r
+  ///\r
+  /// The enumeration of a hardware or software entity within\r
+  /// the system. Valid instance numbers start with 1\r
+  ///\r
+  UINT32                 Instance;\r
+} MEMORY_STATUSCODE_RECORD;\r
 \r
 extern EFI_GUID gMemoryStatusCodeRecordGuid;\r
 \r