]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFsp2Pkg/Include/FspEas/FspApi.h
IntelFsp2Pkg: Apply uncrustify changes
[mirror_edk2.git] / IntelFsp2Pkg / Include / FspEas / FspApi.h
index 5e488c452a853b81610a74e6b262002db89b61ce..794f94dc7a7c65a84bd56042d09dc80b9b83ec97 100644 (file)
 /// FSP Reset Status code\r
 /// These are defined in FSP EAS v2.0 section 11.2.2 - OEM Status Code\r
 /// @{\r
-#define FSP_STATUS_RESET_REQUIRED_COLD         0x40000001\r
-#define FSP_STATUS_RESET_REQUIRED_WARM         0x40000002\r
-#define FSP_STATUS_RESET_REQUIRED_3            0x40000003\r
-#define FSP_STATUS_RESET_REQUIRED_4            0x40000004\r
-#define FSP_STATUS_RESET_REQUIRED_5            0x40000005\r
-#define FSP_STATUS_RESET_REQUIRED_6            0x40000006\r
-#define FSP_STATUS_RESET_REQUIRED_7            0x40000007\r
-#define FSP_STATUS_RESET_REQUIRED_8            0x40000008\r
+#define FSP_STATUS_RESET_REQUIRED_COLD  0x40000001\r
+#define FSP_STATUS_RESET_REQUIRED_WARM  0x40000002\r
+#define FSP_STATUS_RESET_REQUIRED_3     0x40000003\r
+#define FSP_STATUS_RESET_REQUIRED_4     0x40000004\r
+#define FSP_STATUS_RESET_REQUIRED_5     0x40000005\r
+#define FSP_STATUS_RESET_REQUIRED_6     0x40000006\r
+#define FSP_STATUS_RESET_REQUIRED_7     0x40000007\r
+#define FSP_STATUS_RESET_REQUIRED_8     0x40000008\r
 /// @}\r
 \r
 ///\r
 /// FSP Event related definition.\r
 ///\r
-#define FSP_EVENT_CODE   0xF5000000\r
-#define FSP_POST_CODE    (FSP_EVENT_CODE | 0x00F80000)\r
+#define FSP_EVENT_CODE  0xF5000000\r
+#define FSP_POST_CODE   (FSP_EVENT_CODE | 0x00F80000)\r
 \r
 /*\r
   FSP may optionally include the capability of generating events messages to aid in the debugging of firmware issues.\r
@@ -60,7 +60,7 @@
 */\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FSP_EVENT_HANDLER) (\r
+(EFIAPI *FSP_EVENT_HANDLER)(\r
   IN          EFI_STATUS_CODE_TYPE   Type,\r
   IN          EFI_STATUS_CODE_VALUE  Value,\r
   IN          UINT32                 Instance,\r
@@ -80,8 +80,8 @@ EFI_STATUS
 */\r
 typedef\r
 UINT32\r
-(EFIAPI *FSP_DEBUG_HANDLER) (\r
-  IN CHAR8*                 DebugMessage,\r
+(EFIAPI *FSP_DEBUG_HANDLER)(\r
+  IN CHAR8 *DebugMessage,\r
   IN UINT32                 MessageLength\r
   );\r
 \r
@@ -97,14 +97,14 @@ typedef struct {
   /// "XXXXXX_S" for FSP-S\r
   /// Where XXXXXX is an unique signature\r
   ///\r
-  UINT64                      Signature;\r
+  UINT64    Signature;\r
   ///\r
   /// Revision of the Data structure.\r
   ///   For FSP spec 2.0/2.1 value is 1.\r
   ///   For FSP spec 2.2 value is 2.\r
   ///\r
-  UINT8                       Revision;\r
-  UINT8                       Reserved[23];\r
+  UINT8     Revision;\r
+  UINT8     Reserved[23];\r
 } FSP_UPD_HEADER;\r
 \r
 ///\r
@@ -114,18 +114,18 @@ typedef struct {
   ///\r
   /// Revision Revision of the structure is 1 for this version of the specification.\r
   ///\r
-  UINT8                       Revision;\r
-  UINT8                       Reserved[3];\r
+  UINT8                Revision;\r
+  UINT8                Reserved[3];\r
   ///\r
   /// Length Length of the structure in bytes. The current value for this field is 32.\r
   ///\r
-  UINT32                      Length;\r
+  UINT32               Length;\r
   ///\r
   /// FspDebugHandler Optional debug handler for the bootloader to receive debug messages\r
   /// occurring during FSP execution.\r
   ///\r
-  FSP_DEBUG_HANDLER           FspDebugHandler;\r
-  UINT8                       Reserved1[20];\r
+  FSP_DEBUG_HANDLER    FspDebugHandler;\r
+  UINT8                Reserved1[20];\r
 } FSPT_ARCH_UPD;\r
 \r
 ///\r
@@ -135,55 +135,55 @@ typedef struct {
   ///\r
   /// Revision of the structure. For FSP v2.0 value is 1.\r
   ///\r
-  UINT8                       Revision;\r
-  UINT8                       Reserved[3];\r
+  UINT8                Revision;\r
+  UINT8                Reserved[3];\r
   ///\r
   /// Pointer to the non-volatile storage (NVS) data buffer.\r
   /// If it is NULL it indicates the NVS data is not available.\r
   ///\r
-  VOID                        *NvsBufferPtr;\r
+  VOID                 *NvsBufferPtr;\r
   ///\r
   /// Pointer to the temporary stack base address to be\r
   /// consumed inside FspMemoryInit() API.\r
   ///\r
-  VOID                        *StackBase;\r
+  VOID                 *StackBase;\r
   ///\r
   /// Temporary stack size to be consumed inside\r
   /// FspMemoryInit() API.\r
   ///\r
-  UINT32                      StackSize;\r
+  UINT32               StackSize;\r
   ///\r
   /// Size of memory to be reserved by FSP below "top\r
   /// of low usable memory" for bootloader usage.\r
   ///\r
-  UINT32                      BootLoaderTolumSize;\r
+  UINT32               BootLoaderTolumSize;\r
   ///\r
   /// Current boot mode.\r
   ///\r
-  UINT32                      BootMode;\r
+  UINT32               BootMode;\r
   ///\r
   /// Optional event handler for the bootloader to be informed of events occurring during FSP execution.\r
   /// This value is only valid if Revision is >= 2.\r
   ///\r
-  FSP_EVENT_HANDLER           *FspEventHandler;\r
-  UINT8                       Reserved1[4];\r
+  FSP_EVENT_HANDLER    *FspEventHandler;\r
+  UINT8                Reserved1[4];\r
 } FSPM_ARCH_UPD;\r
 \r
 typedef struct {\r
   ///\r
   /// Revision Revision of the structure is 1 for this version of the specification.\r
   ///\r
-  UINT8                      Revision;\r
-  UINT8                      Reserved[3];\r
+  UINT8                Revision;\r
+  UINT8                Reserved[3];\r
   ///\r
   /// Length Length of the structure in bytes. The current value for this field is 32.\r
   ///\r
-  UINT32                      Length;\r
+  UINT32               Length;\r
   ///\r
   /// FspEventHandler Optional event handler for the bootloader to be informed of events\r
   /// occurring during FSP execution.\r
   ///\r
-  FSP_EVENT_HANDLER           FspEventHandler;\r
+  FSP_EVENT_HANDLER    FspEventHandler;\r
   ///\r
   /// A FSP binary may optionally implement multi-phase silicon initialization,\r
   /// This is only supported if the FspMultiPhaseSiInitEntryOffset field in FSP_INFO_HEADER\r
@@ -191,8 +191,8 @@ typedef struct {
   /// To enable multi-phase silicon initialization, the bootloader must set\r
   /// EnableMultiPhaseSiliconInit to a non-zero value.\r
   ///\r
-  UINT8                       EnableMultiPhaseSiliconInit;\r
-  UINT8                       Reserved1[19];\r
+  UINT8                EnableMultiPhaseSiliconInit;\r
+  UINT8                Reserved1[19];\r
 } FSPS_ARCH_UPD;\r
 \r
 ///\r
@@ -202,7 +202,7 @@ typedef struct {
   ///\r
   /// FSP_UPD_HEADER Configuration.\r
   ///\r
-  FSP_UPD_HEADER              FspUpdHeader;\r
+  FSP_UPD_HEADER    FspUpdHeader;\r
 } FSPT_UPD_COMMON;\r
 \r
 ///\r
@@ -212,12 +212,12 @@ typedef struct {
   ///\r
   /// FSP_UPD_HEADER Configuration.\r
   ///\r
-  FSP_UPD_HEADER              FspUpdHeader;\r
+  FSP_UPD_HEADER    FspUpdHeader;\r
 \r
   ///\r
   /// FSPT_ARCH_UPD Configuration.\r
   ///\r
-  FSPT_ARCH_UPD               FsptArchUpd;\r
+  FSPT_ARCH_UPD     FsptArchUpd;\r
 } FSPT_UPD_COMMON_FSP22;\r
 \r
 ///\r
@@ -227,11 +227,11 @@ typedef struct {
   ///\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_ARCH_UPD     FspmArchUpd;\r
 } FSPM_UPD_COMMON;\r
 \r
 ///\r
@@ -241,7 +241,7 @@ typedef struct {
   ///\r
   /// FSP_UPD_HEADER Configuration.\r
   ///\r
-  FSP_UPD_HEADER              FspUpdHeader;\r
+  FSP_UPD_HEADER    FspUpdHeader;\r
 } FSPS_UPD_COMMON;\r
 \r
 ///\r
@@ -251,12 +251,12 @@ typedef struct {
   ///\r
   /// FSP_UPD_HEADER Configuration.\r
   ///\r
-  FSP_UPD_HEADER              FspUpdHeader;\r
+  FSP_UPD_HEADER    FspUpdHeader;\r
 \r
   ///\r
   /// FSPS_ARCH_UPD Configuration.\r
   ///\r
-  FSPS_ARCH_UPD               FspsArchUpd;\r
+  FSPS_ARCH_UPD     FspsArchUpd;\r
 } FSPS_UPD_COMMON_FSP22;\r
 \r
 ///\r
@@ -273,13 +273,13 @@ typedef enum {
   /// This stage is notified just before the bootloader hand-off\r
   /// to the OS loader.\r
   ///\r
-  EnumInitPhaseReadyToBoot         = 0x40,\r
+  EnumInitPhaseReadyToBoot = 0x40,\r
   ///\r
   /// This stage is notified just before the firmware/Preboot\r
   /// environment transfers management of all system resources\r
   /// to the OS or next level execution environment.\r
   ///\r
-  EnumInitPhaseEndOfFirmware       = 0xF0\r
+  EnumInitPhaseEndOfFirmware = 0xF0\r
 } FSP_INIT_PHASE;\r
 \r
 ///\r
@@ -289,15 +289,15 @@ typedef struct {
   ///\r
   /// Notification phase used for NotifyPhase API\r
   ///\r
-  FSP_INIT_PHASE     Phase;\r
+  FSP_INIT_PHASE    Phase;\r
 } NOTIFY_PHASE_PARAMS;\r
 \r
 ///\r
 /// Action definition for FspMultiPhaseSiInit API\r
 ///\r
 typedef enum {\r
-  EnumMultiPhaseGetNumberOfPhases  = 0x0,\r
-  EnumMultiPhaseExecutePhase       = 0x1\r
+  EnumMultiPhaseGetNumberOfPhases = 0x0,\r
+  EnumMultiPhaseExecutePhase      = 0x1\r
 } FSP_MULTI_PHASE_ACTION;\r
 \r
 ///\r
@@ -305,8 +305,8 @@ typedef enum {
 /// FspMultiPhaseSiInit API with action 0 (EnumMultiPhaseGetNumberOfPhases)\r
 ///\r
 typedef struct {\r
-  UINT32                         NumberOfPhases;\r
-  UINT32                         PhasesExecuted;\r
+  UINT32    NumberOfPhases;\r
+  UINT32    PhasesExecuted;\r
 } FSP_MULTI_PHASE_GET_NUMBER_OF_PHASES_PARAMS;\r
 \r
 ///\r
@@ -321,9 +321,9 @@ typedef struct {
 ///   - MultiPhaseParamPtr shall be NULL.\r
 ///\r
 typedef struct {\r
-  IN     FSP_MULTI_PHASE_ACTION  MultiPhaseAction;\r
-  IN     UINT32                  PhaseIndex;\r
-  IN OUT VOID                    *MultiPhaseParamPtr;\r
+  IN     FSP_MULTI_PHASE_ACTION    MultiPhaseAction;\r
+  IN     UINT32                    PhaseIndex;\r
+  IN OUT VOID                      *MultiPhaseParamPtr;\r
 } FSP_MULTI_PHASE_PARAMS;\r
 \r
 #pragma pack()\r
@@ -359,7 +359,7 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FSP_TEMP_RAM_INIT) (\r
+(EFIAPI *FSP_TEMP_RAM_INIT)(\r
   IN  VOID    *FsptUpdDataPtr\r
   );\r
 \r
@@ -379,7 +379,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FSP_NOTIFY_PHASE) (\r
+(EFIAPI *FSP_NOTIFY_PHASE)(\r
   IN NOTIFY_PHASE_PARAMS *NotifyPhaseParamPtr\r
   );\r
 \r
@@ -407,12 +407,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FSP_MEMORY_INIT) (\r
+(EFIAPI *FSP_MEMORY_INIT)(\r
   IN  VOID    *FspmUpdDataPtr,\r
   OUT VOID    **HobListPtr\r
   );\r
 \r
-\r
 /**\r
   This FSP API is called after FspMemoryInit API. This FSP API tears down the temporary\r
   memory setup by TempRamInit API. This FSP API accepts a pointer to a data structure\r
@@ -433,11 +432,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FSP_TEMP_RAM_EXIT) (\r
+(EFIAPI *FSP_TEMP_RAM_EXIT)(\r
   IN  VOID    *TempRamExitParamPtr\r
   );\r
 \r
-\r
 /**\r
   This FSP API is called after TempRamExit API.\r
   FspMemoryInit, TempRamExit and FspSiliconInit APIs provide an alternate method to complete the\r
@@ -454,7 +452,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FSP_SILICON_INIT) (\r
+(EFIAPI *FSP_SILICON_INIT)(\r
   IN  VOID    *FspsUpdDataPtr\r
   );\r
 \r
@@ -478,8 +476,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FSP_MULTI_PHASE_SI_INIT) (\r
+(EFIAPI *FSP_MULTI_PHASE_SI_INIT)(\r
   IN FSP_MULTI_PHASE_PARAMS     *MultiPhaseSiInitParamPtr\r
-);\r
+  );\r
 \r
 #endif\r