IntelFsp2Pkg/FspApi.h: Add comment for structure definition.
authorJiewen Yao <jiewen.yao@intel.com>
Fri, 20 May 2016 00:46:58 +0000 (08:46 +0800)
committerJiewen Yao <jiewen.yao@intel.com>
Fri, 20 May 2016 00:46:58 +0000 (08:46 +0800)
Add doxygen style comment for structure definition.

Cc: Giri P Mudusuru <giri.p.mudusuru@intel.com>
Cc: Satya P Yarlagadda <satya.p.yarlagadda@intel.com>
Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Ravi P Rangarajan <ravi.p.rangarajan@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Giri P Mudusuru <giri.p.mudusuru@intel.com>
IntelFsp2Pkg/Include/FspEas/FspApi.h

index f7c7168..b9c2851 100644 (file)
@@ -17,6 +17,9 @@
 #define _FSP_API_H_\r
 \r
 #pragma pack(1)\r
+///\r
+/// FSP_UPD_HEADER Configuration.\r
+///\r
 typedef struct {\r
   ///\r
   /// UPD Region Signature. This signature will be\r
@@ -33,6 +36,9 @@ typedef struct {
   UINT8                       Reserved[23];\r
 } FSP_UPD_HEADER;\r
 \r
+///\r
+/// FSPM_ARCH_UPD Configuration.\r
+///\r
 typedef struct {\r
   ///\r
   /// Revision of the structure. For FSP v2.0 value is 1.\r
@@ -66,19 +72,43 @@ typedef struct {
   UINT8                       Reserved1[8];\r
 } FSPM_ARCH_UPD;\r
 \r
+///\r
+/// FSPT_UPD_COMMON Configuration.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// FSP_UPD_HEADER Configuration.\r
+  ///\r
   FSP_UPD_HEADER              FspUpdHeader;\r
 } FSPT_UPD_COMMON;\r
 \r
+///\r
+/// FSPM_UPD_COMMON Configuration.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// FSP_UPD_HEADER Configuration.\r
+  ///\r
   FSP_UPD_HEADER              FspUpdHeader;\r
+  ///\r
+  /// FSPM_ARCH_UPD Configuration.\r
+  ///\r
   FSPM_ARCH_UPD               FspmArchUpd;\r
 } FSPM_UPD_COMMON;\r
 \r
+///\r
+/// FSPS_UPD_COMMON Configuration.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// FSP_UPD_HEADER Configuration.\r
+  ///\r
   FSP_UPD_HEADER              FspUpdHeader;\r
 } FSPS_UPD_COMMON;\r
 \r
+///\r
+/// Enumeration of FSP_INIT_PHASE for NOTIFY_PHASE.\r
+///\r
 typedef enum {\r
   ///\r
   /// This stage is notified when the bootloader completes the\r
@@ -99,6 +129,9 @@ typedef enum {
   EnumInitPhaseEndOfFirmware       = 0xF0\r
 } FSP_INIT_PHASE;\r
 \r
+///\r
+/// Definition of NOTIFY_PHASE_PARAMS.\r
+///\r
 typedef struct {\r
   ///\r
   /// Notification phase used for NotifyPhase API\r