IntelFsp2Pkg: Add FSPx_ARCH2_UPD support for X64

[mirror_edk2.git] / IntelFsp2Pkg / Include / FspEas / FspApi.h

diff --git a/IntelFsp2Pkg/Include/FspEas/FspApi.h b/IntelFsp2Pkg/Include/FspEas/FspApi.h
index 794f94dc7a7c65a84bd56042d09dc80b9b83ec97..b36bc2b9ae6d0811de5d95d9ab48454597b3a5fe 100644 (file)
--- a/IntelFsp2Pkg/Include/FspEas/FspApi.h
+++ b/IntelFsp2Pkg/Include/FspEas/FspApi.h
@@ -2,7 +2,7 @@
   Intel FSP API definition from Intel Firmware Support Package External\r
   Architecture Specification v2.0 - v2.2\r
 \r
-  Copyright (c) 2014 - 2020, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2014 - 2022, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
@@ -112,12 +112,12 @@ typedef struct {
 ///\r
 typedef struct {\r
   ///\r
-  /// Revision Revision of the structure is 1 for this version of the specification.\r
+  /// Revision of the structure is 1 for this version of the specification.\r
   ///\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
+  /// Length of the structure in bytes. The current value for this field is 32.\r
   ///\r
   UINT32               Length;\r
   ///\r
@@ -128,6 +128,27 @@ typedef struct {
   UINT8                Reserved1[20];\r
 } FSPT_ARCH_UPD;\r
 \r
+///\r
+/// FSPT_ARCH2_UPD Configuration.\r
+///\r
+typedef struct {\r
+  ///\r
+  /// Revision of the structure is 2 for this version of the specification.\r
+  ///\r
+  UINT8                Revision;\r
+  UINT8                Reserved[3];\r
+  ///\r
+  /// Length of the structure in bytes. The current value for this field is 32.\r
+  ///\r
+  UINT32               Length;\r
+  ///\r
+  /// FspDebugHandler Optional debug handler for the bootloader to receive debug messages\r
+  /// occurring during FSP execution.\r
+  ///\r
+  EFI_PHYSICAL_ADDRESS FspDebugHandler;\r
+  UINT8                Reserved1[16];\r
+} FSPT_ARCH2_UPD;\r
+\r
 ///\r
 /// FSPM_ARCH_UPD Configuration.\r
 ///\r
@@ -169,14 +190,57 @@ typedef struct {
   UINT8                Reserved1[4];\r
 } FSPM_ARCH_UPD;\r
 \r
+///\r
+/// FSPM_ARCH2_UPD Configuration.\r
+///\r
+typedef struct {\r
+  ///\r
+  /// Revision of the structure is 3 for this version of the specification.\r
+  ///\r
+  UINT8                Revision;\r
+  UINT8                Reserved[3];\r
+  ///\r
+  /// Length of the structure in bytes. The current value for this field is 64.\r
+  ///\r
+  UINT32               Length;\r
+  ///\r
+  /// Pointer to the temporary stack base address to be\r
+  /// consumed inside FspMemoryInit() API.\r
+  ///\r
+  EFI_PHYSICAL_ADDRESS StackBase;\r
+  ///\r
+  /// Temporary stack size to be consumed inside\r
+  /// FspMemoryInit() API.\r
+  ///\r
+  UINT64               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
+  ///\r
+  /// Current boot mode.\r
+  ///\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
+  EFI_PHYSICAL_ADDRESS FspEventHandler;\r
+  UINT8                Reserved1[24];\r
+} FSPM_ARCH2_UPD;\r
+\r
+///\r
+/// FSPS_ARCH_UPD Configuration.\r
+///\r
 typedef struct {\r
   ///\r
-  /// Revision Revision of the structure is 1 for this version of the specification.\r
+  /// Revision of the structure is 1 for this version of the specification.\r
   ///\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
+  /// Length of the structure in bytes. The current value for this field is 32.\r
   ///\r
   UINT32               Length;\r
   ///\r
@@ -195,6 +259,27 @@ typedef struct {
   UINT8                Reserved1[19];\r
 } FSPS_ARCH_UPD;\r
 \r
+///\r
+/// FSPS_ARCH2_UPD Configuration.\r
+///\r
+typedef struct {\r
+  ///\r
+  /// Revision of the structure is 2 for this version of the specification.\r
+  ///\r
+  UINT8                Revision;\r
+  UINT8                Reserved[3];\r
+  ///\r
+  /// Length of the structure in bytes. The current value for this field is 32.\r
+  ///\r
+  UINT32               Length;\r
+  ///\r
+  /// FspEventHandler Optional event handler for the bootloader to be informed of events\r
+  /// occurring during FSP execution.\r
+  ///\r
+  EFI_PHYSICAL_ADDRESS FspEventHandler;\r
+  UINT8                Reserved1[16];\r
+} FSPS_ARCH2_UPD;\r
+\r
 ///\r
 /// FSPT_UPD_COMMON Configuration.\r
 ///\r
@@ -220,6 +305,21 @@ typedef struct {
   FSPT_ARCH_UPD     FsptArchUpd;\r
 } FSPT_UPD_COMMON_FSP22;\r
 \r
+///\r
+/// FSPT_UPD_COMMON Configuration for FSP spec. 2.4 and above.\r
+///\r
+typedef struct {\r
+  ///\r
+  /// FSP_UPD_HEADER Configuration.\r
+  ///\r
+  FSP_UPD_HEADER    FspUpdHeader;\r
+\r
+  ///\r
+  /// FSPT_ARCH2_UPD Configuration.\r
+  ///\r
+  FSPT_ARCH2_UPD    FsptArchUpd;\r
+} FSPT_UPD_COMMON_FSP24;\r
+\r
 ///\r
 /// FSPM_UPD_COMMON Configuration.\r
 ///\r
@@ -234,6 +334,20 @@ typedef struct {
   FSPM_ARCH_UPD     FspmArchUpd;\r
 } FSPM_UPD_COMMON;\r
 \r
+///\r
+/// FSPM_UPD_COMMON Configuration for FSP spec. 2.4 and above.\r
+///\r
+typedef struct {\r
+  ///\r
+  /// FSP_UPD_HEADER Configuration.\r
+  ///\r
+  FSP_UPD_HEADER    FspUpdHeader;\r
+  ///\r
+  /// FSPM_ARCH2_UPD Configuration.\r
+  ///\r
+  FSPM_ARCH2_UPD    FspmArchUpd;\r
+} FSPM_UPD_COMMON_FSP24;\r
+\r
 ///\r
 /// FSPS_UPD_COMMON Configuration.\r
 ///\r
@@ -259,6 +373,21 @@ typedef struct {
   FSPS_ARCH_UPD     FspsArchUpd;\r
 } FSPS_UPD_COMMON_FSP22;\r
 \r
+///\r
+/// FSPS_UPD_COMMON Configuration for FSP spec. 2.4 and above.\r
+///\r
+typedef struct {\r
+  ///\r
+  /// FSP_UPD_HEADER Configuration.\r
+  ///\r
+  FSP_UPD_HEADER    FspUpdHeader;\r
+\r
+  ///\r
+  /// FSPS_ARCH2_UPD Configuration.\r
+  ///\r
+  FSPS_ARCH2_UPD    FspsArchUpd;\r
+} FSPS_UPD_COMMON_FSP24;\r
+\r
 ///\r
 /// Enumeration of FSP_INIT_PHASE for NOTIFY_PHASE.\r
 ///\r