]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Update comments
authormdkinney <mdkinney@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 3 Jul 2009 22:40:21 +0000 (22:40 +0000)
committermdkinney <mdkinney@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 3 Jul 2009 22:40:21 +0000 (22:40 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8744 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
IntelFrameworkModulePkg/Include/Guid/IntelFrameworkModulePkgTokenSpace.h
IntelFrameworkModulePkg/Include/Guid/LzmaDecompress.h
IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
IntelFrameworkModulePkg/Include/Guid/TianoDecompress.h

index 0f11c7a8b6f5c1a595117db87e777eb302859f74..8ebc3697940839e5d8653eb240d3335921b03c9e 100644 (file)
@@ -1,53 +1,59 @@
 /** @file\r
-  GUID used to identify Data Hub records logged by Status Code Runtime Protocol.\r
+  GUID used to identify Data Hub records logged by Status Code Protocol.\r
   \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
+  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
-\r
 #ifndef __DATA_HUB_STATUS_CODE_RECORD_H__\r
 #define __DATA_HUB_STATUS_CODE_RECORD_H__\r
 \r
+///\r
+/// Global ID used to identify a structure of type DATA_HUB_STATUS_CODE_DATA_RECORD\r
+///\r
 #define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \\r
   { \\r
     0xd083e94c, 0x6560, 0x42e4, {0xb6, 0xd4, 0x2d, 0xf7, 0x5a, 0xdf, 0x6a, 0x2a } \\r
   }\r
 \r
+///\r
+/// Data Hub data record that is used to store all the parameters passed into\r
+/// the ReportStatusCode() service of the EFI_STATUS_CODE_PROTOCOL.\r
+///\r
 typedef struct {\r
   ///\r
   /// Status Code type to be reported.\r
   ///\r
-  EFI_STATUS_CODE_TYPE  CodeType;\r
+  EFI_STATUS_CODE_TYPE   CodeType;\r
 \r
   ///\r
-  /// Valu information about the class and subclass is used to\r
+  /// Value 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
+  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
+  /// the system.  Valid instance numbers start with 1\r
   ///\r
-  UINT32                Instance;\r
+  UINT32                 Instance;\r
 \r
   ///\r
   /// Identify the caller.\r
   ///\r
-  EFI_GUID              CallerId;\r
+  EFI_GUID               CallerId;\r
 \r
   ///\r
   /// Additional status code data\r
   ///\r
-  EFI_STATUS_CODE_DATA  Data;\r
+  EFI_STATUS_CODE_DATA   Data;\r
 } DATA_HUB_STATUS_CODE_DATA_RECORD;\r
 \r
 extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;\r
index 00e0bcad7fe59d751a51fb12dabd67af8611d376..ac674b03454affe2ceeacd133c1001c4b4cfbbc4 100644 (file)
@@ -15,6 +15,9 @@
 #ifndef _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_\r
 #define _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_\r
 \r
+///\r
+/// Global ID for the IntelFrameworkModulePkg PCD Token Space \r
+///\r
 #define INTEL_FRAMEWORK_MODULEPKG_TOKEN_SPACE_GUID \\r
   { \\r
     0xD3705011, 0xBC19, 0x4af7, { 0xBE, 0x16, 0xF6, 0x80, 0x30, 0x37, 0x8C, 0x15 } \\r
index 65031abf882487dc6aff0eb311827718cce942b3..554f0c615b9614a66f930e81b339f988f06d5531 100644 (file)
@@ -15,6 +15,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __LZMA_DECOMPRESS_GUID_H__\r
 #define __LZMA_DECOMPRESS_GUID_H__\r
 \r
+///\r
+/// Global ID used to identify a section of an FFS file of type \r
+/// EFI_SECTION_GUID_DEFINED whose contents have been compressed using LZMA.\r
+///\r
 #define LZMA_CUSTOM_DECOMPRESS_GUID  \\r
   { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF } }\r
 \r
index fcc7a0d72e11cc19774ba51437ad13eb209be605..c435aab8f937d93dbe2d8634c5d94d7674b69378 100644 (file)
@@ -1,60 +1,83 @@
 /** @file\r
   GUID used to identify status code records HOB that originate from the PEI status code    \r
   \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
+  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
   ///\r
   /// Status Code type to be reported.\r
   ///\r
-  EFI_STATUS_CODE_TYPE  CodeType;\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
+  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
+  UINT32                 Instance;\r
 } MEMORY_STATUSCODE_RECORD;\r
 \r
-\r
 extern EFI_GUID gMemoryStatusCodeRecordGuid;\r
 \r
 #endif\r
index 28a39a7e7d73d615e4c80fb12e743388c1686dd8..ee679cf0eb7435c9db00734120a2e4fb35de50aa 100644 (file)
 #define EFI_STATUS_CODE_DATA_MAX_SIZE 200\r
 \r
 ///\r
-/// This structire contains the ErrorLevel passed into the DEBUG() macro followed \r
+/// This structure contains the ErrorLevel passed into the DEBUG() macro followed \r
 /// by a 96-byte buffer that contains the variable argument list passed to the \r
 //  DEBUG() macro that has been converted to a BASE_LIST.  The 96-byte buffer is \r
 /// followed by a Null terminated ASCII string that is the Format string passed \r
 /// to the DEBUG() macro.  The maximum size of this structure is defined by \r
-/// EFI_STATUS_CODE_DATAS_MAX_SIZE.\r
+/// EFI_STATUS_CODE_DATA_MAX_SIZE.\r
 ///\r
 typedef struct {\r
   ///\r
index c59ae5f0b0a998eebafc7d07baedec47b5e80487..7b978890507dac1cd1a7a06928b97f79104f375f 100644 (file)
@@ -15,6 +15,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __TIANO_CUSTOM_DECOMPRESS_GUID_H__\r
 #define __TIANO_CUSTOM_DECOMPRESS_GUID_H__\r
 \r
+///\r
+/// Global ID used to identify a section of an FFS file of type \r
+/// EFI_SECTION_GUID_DEFINED whose contents have been compressed using \r
+/// Tiano Custom compression.\r
+///\r
 #define TIANO_CUSTOM_DECOMPRESS_GUID  \\r
   { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 } }\r
 \r