tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Jiewen Yao 2016-05-20 08:46:58 +08:00
parent 4be1fbc287
commit 6d0ac98825
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
IntelFsp2Pkg/Include/FspEas/FspApi.h
View File

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