X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkModulePkg%2FInclude%2FGuid%2FDataHubStatusCodeRecord.h;h=a03a09712c1c5225c5857697b53febf45b162c1b;hp=34c1fefe373d9be0ba3353fbc166941d28126362;hb=180a5a35cb49699bd249dee19e41cee34c856a58;hpb=ed7752ec44001d317f79c8631dccd9650c396617

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index 34c1fefe37..a03a09712c 100644
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -1,36 +1,61 @@
-/**@file
-  GUID used to identify Data Hub records that originate from the Tiano 
-  ReportStatusCode API.
+/** @file
+  GUID used to identify Data Hub records logged by Status Code Protocol.
   
-Copyright (c) 2006, Intel Corporation                                                         
-All rights reserved. This program and the accompanying materials                          
-are licensed and made available under the terms and conditions of the BSD License         
-which accompanies this distribution.  The full text of the license may be found at        
-http://opensource.org/licenses/bsd-license.php                                            
-                                                                                          
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
+This program and the accompanying materials are licensed and made available under 
+the terms and conditions of the BSD License that accompanies this distribution.  
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.                                          
+    
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
 
 **/
 
+#ifndef __DATA_HUB_STATUS_CODE_RECORD_H__
+#define __DATA_HUB_STATUS_CODE_RECORD_H__
 
-#ifndef __STATUS_CODE_H__
-#define __STATUS_CODE_H__
-
+///
+/// The Global ID used to identify a structure of type DATA_HUB_STATUS_CODE_DATA_RECORD.
+///
 #define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \
   { \
     0xd083e94c, 0x6560, 0x42e4, {0xb6, 0xd4, 0x2d, 0xf7, 0x5a, 0xdf, 0x6a, 0x2a } \
   }
 
+///
+/// The Data Hub data record that is used to store all the parameters passed into
+/// the ReportStatusCode() service of the EFI_STATUS_CODE_PROTOCOL.
+///
 typedef struct {
-  EFI_STATUS_CODE_TYPE  CodeType;
-  EFI_STATUS_CODE_VALUE Value;
-  UINT32                Instance;
-  EFI_GUID              CallerId;
-  EFI_STATUS_CODE_DATA  Data;
+  ///
+  /// Status Code type to be reported.
+  ///
+  EFI_STATUS_CODE_TYPE   CodeType;
+
+  ///
+  /// An operation, plus value information about the class and subclass, used to
+  /// classify the hardware and software entity.
+  ///
+  EFI_STATUS_CODE_VALUE  Value;
+
+  ///
+  /// The enumeration of a hardware or software entity within
+  /// the system.  Valid instance numbers start with 1.
+  ///
+  UINT32                 Instance;
+
+  ///
+  /// Identify the caller.
+  ///
+  EFI_GUID               CallerId;
+
+  ///
+  /// Additional status code data.
+  ///
+  EFI_STATUS_CODE_DATA   Data;
 } DATA_HUB_STATUS_CODE_DATA_RECORD;
 
 extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;
 
-#endif // __STATUS_CODE_H__
-
+#endif