diff options
| author | Jiewen Yao <jiewen.yao@intel.com> | 2016-05-20 08:46:58 +0800 |
|---|---|---|
| committer | Jiewen Yao <jiewen.yao@intel.com> | 2016-05-20 08:46:58 +0800 |
| commit | 6d0ac988257d22d2c17a1f88f26780028bd239c5 (patch) | |
| tree | 7f8bc51eb6b622d7b3eb4af6eb776dd81de40bcf /IntelFsp2Pkg/Include | |
| parent | 4be1fbc287a2972a0cb420bc3a85372426c588b5 (diff) | |
| download | edk2-6d0ac988257d22d2c17a1f88f26780028bd239c5.tar.gz edk2-6d0ac988257d22d2c17a1f88f26780028bd239c5.tar.bz2 edk2-6d0ac988257d22d2c17a1f88f26780028bd239c5.zip | |
IntelFsp2Pkg/FspApi.h: Add comment for structure definition.
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>
Diffstat (limited to 'IntelFsp2Pkg/Include')
| -rw-r--r-- | IntelFsp2Pkg/Include/FspEas/FspApi.h | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/IntelFsp2Pkg/Include/FspEas/FspApi.h b/IntelFsp2Pkg/Include/FspEas/FspApi.h index f7c71681c8..b9c2851442 100644 --- a/IntelFsp2Pkg/Include/FspEas/FspApi.h +++ b/IntelFsp2Pkg/Include/FspEas/FspApi.h @@ -17,6 +17,9 @@ #define _FSP_API_H_
#pragma pack(1)
+///
+/// FSP_UPD_HEADER Configuration.
+///
typedef struct {
///
/// UPD Region Signature. This signature will be
@@ -33,6 +36,9 @@ typedef struct { UINT8 Reserved[23];
} FSP_UPD_HEADER;
+///
+/// FSPM_ARCH_UPD Configuration.
+///
typedef struct {
///
/// Revision of the structure. For FSP v2.0 value is 1.
@@ -66,19 +72,43 @@ typedef struct { UINT8 Reserved1[8];
} FSPM_ARCH_UPD;
+///
+/// FSPT_UPD_COMMON Configuration.
+///
typedef struct {
+ ///
+ /// FSP_UPD_HEADER Configuration.
+ ///
FSP_UPD_HEADER FspUpdHeader;
} FSPT_UPD_COMMON;
+///
+/// FSPM_UPD_COMMON Configuration.
+///
typedef struct {
+ ///
+ /// FSP_UPD_HEADER Configuration.
+ ///
FSP_UPD_HEADER FspUpdHeader;
+ ///
+ /// FSPM_ARCH_UPD Configuration.
+ ///
FSPM_ARCH_UPD FspmArchUpd;
} FSPM_UPD_COMMON;
+///
+/// FSPS_UPD_COMMON Configuration.
+///
typedef struct {
+ ///
+ /// FSP_UPD_HEADER Configuration.
+ ///
FSP_UPD_HEADER FspUpdHeader;
} FSPS_UPD_COMMON;
+///
+/// Enumeration of FSP_INIT_PHASE for NOTIFY_PHASE.
+///
typedef enum {
///
/// This stage is notified when the bootloader completes the
@@ -99,6 +129,9 @@ typedef enum { EnumInitPhaseEndOfFirmware = 0xF0
} FSP_INIT_PHASE;
+///
+/// Definition of NOTIFY_PHASE_PARAMS.
+///
typedef struct {
///
/// Notification phase used for NotifyPhase API
|