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>
#define _FSP_API_H_\r
\r
#pragma pack(1)\r
#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
typedef struct {\r
///\r
/// UPD Region Signature. This signature will be\r
UINT8 Reserved[23];\r
} FSP_UPD_HEADER;\r
\r
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
typedef struct {\r
///\r
/// Revision of the structure. For FSP v2.0 value is 1.\r
UINT8 Reserved1[8];\r
} FSPM_ARCH_UPD;\r
\r
UINT8 Reserved1[8];\r
} FSPM_ARCH_UPD;\r
\r
+///\r
+/// FSPT_UPD_COMMON Configuration.\r
+///\r
+ ///\r
+ /// FSP_UPD_HEADER Configuration.\r
+ ///\r
FSP_UPD_HEADER FspUpdHeader;\r
} FSPT_UPD_COMMON;\r
\r
FSP_UPD_HEADER FspUpdHeader;\r
} FSPT_UPD_COMMON;\r
\r
+///\r
+/// FSPM_UPD_COMMON Configuration.\r
+///\r
+ ///\r
+ /// FSP_UPD_HEADER Configuration.\r
+ ///\r
FSP_UPD_HEADER FspUpdHeader;\r
FSP_UPD_HEADER FspUpdHeader;\r
+ ///\r
+ /// FSPM_ARCH_UPD Configuration.\r
+ ///\r
FSPM_ARCH_UPD FspmArchUpd;\r
} FSPM_UPD_COMMON;\r
\r
FSPM_ARCH_UPD FspmArchUpd;\r
} FSPM_UPD_COMMON;\r
\r
+///\r
+/// FSPS_UPD_COMMON Configuration.\r
+///\r
+ ///\r
+ /// FSP_UPD_HEADER Configuration.\r
+ ///\r
FSP_UPD_HEADER FspUpdHeader;\r
} FSPS_UPD_COMMON;\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
typedef enum {\r
///\r
/// This stage is notified when the bootloader completes the\r
EnumInitPhaseEndOfFirmware = 0xF0\r
} FSP_INIT_PHASE;\r
\r
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
typedef struct {\r
///\r
/// Notification phase used for NotifyPhase API\r