Re: [PATCH v3] IntelFsp2Pkg: Add FSPI_ARCH_UPD.

["Nate DeSimone" <nathaniel.l.desimone@intel.com>]

Good catch everyone!

The spec has been changed to the following:

typedef struct {
UINT8                Revision;
UINT8                Reserved[3];
UINT32               Length;
EFI_PHYSICAL_ADDRESS BootloaderSmmFvBaseAddress;
UINT64               BootloaderSmmFvLength;
EFI_PHYSICAL_ADDRESS BootloaderSmmFvContextData;
UINT16               BootloaderSmmFvContextDataLength;
UINT8                Reserved1[30];
} FSPI_ARCH_UPD;

-----Original Message-----
From: Zeng, Star <star.zeng@intel.com> 
Sent: Wednesday, July 20, 2022 8:19 PM
To: Chiu, Chasel <chasel.chiu@intel.com>; devel@edk2.groups.io
Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Zeng, Star <star.zeng@intel.com>
Subject: RE: [PATCH v3] IntelFsp2Pkg: Add FSPI_ARCH_UPD.

The spec looks wrong to me.

Thanks,
Star
-----Original Message-----
From: Chiu, Chasel <chasel.chiu@intel.com> 
Sent: Thursday, July 21, 2022 11:16 AM
To: Zeng, Star <star.zeng@intel.com>; devel@edk2.groups.io
Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>
Subject: RE: [PATCH v3] IntelFsp2Pkg: Add FSPI_ARCH_UPD.


Hi Star, this is following current specification.

Thanks,
Chasel


> -----Original Message-----
> From: Zeng, Star <star.zeng@intel.com>
> Sent: Wednesday, July 20, 2022 8:07 PM
> To: Chiu, Chasel <chasel.chiu@intel.com>; devel@edk2.groups.io
> Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Zeng, Star 
> <star.zeng@intel.com>
> Subject: RE: [PATCH v3] IntelFsp2Pkg: Add FSPI_ARCH_UPD.
> 
> Is the reserved bytes number correct for FSPI_ARCH_UPD alignment?
>  UINT16              BootloaderSmmFvContextDataLength;
>  UINT8                Reserved1[24];
> 
> Thanks,
> Star
> -----Original Message-----
> From: Chiu, Chasel <chasel.chiu@intel.com>
> Sent: Thursday, July 21, 2022 10:29 AM
> To: devel@edk2.groups.io
> Cc: Chiu, Chasel <chasel.chiu@intel.com>; Desimone, Nathaniel L 
> <nathaniel.l.desimone@intel.com>; Zeng, Star <star.zeng@intel.com>
> Subject: [PATCH v3] IntelFsp2Pkg: Add FSPI_ARCH_UPD.
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3993
> 
> Adding the missing FSPI_ARCH_UPD, FSP_GLOBAL_DATA_VERSION bumpping up, 
> and some comments for clarification.
> Also fixed a bug in SplitFspBin.py for FSP-I support.
> 
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> Cc: Star Zeng <star.zeng@intel.com>
> Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
> ---
>  IntelFsp2Pkg/Include/FspEas/FspApi.h      | 71
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
> -----
>  IntelFsp2Pkg/Include/FspGlobalData.h      |  2 +-
>  IntelFsp2Pkg/Include/Guid/FspHeaderFile.h | 21 +++++++++++++++++++--
>  IntelFsp2Pkg/Tools/SplitFspBin.py         |  2 +-
>  4 files changed, 85 insertions(+), 11 deletions(-)
> 
> diff --git a/IntelFsp2Pkg/Include/FspEas/FspApi.h
> b/IntelFsp2Pkg/Include/FspEas/FspApi.h
> index bf46f13f73..3f368574e8 100644
> --- a/IntelFsp2Pkg/Include/FspEas/FspApi.h
> +++ b/IntelFsp2Pkg/Include/FspEas/FspApi.h
> @@ -1,6 +1,6 @@
>  /** @file
> 
>    Intel FSP API definition from Intel Firmware Support Package 
> External
> 
> -  Architecture Specification v2.0 - v2.2
> 
> +  Architecture Specification v2.0 and above.
> 
> 
> 
>    Copyright (c) 2014 - 2022, Intel Corporation. All rights 
> reserved.<BR>
> 
>    SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> @@ -100,13 +100,14 @@ typedef struct {
>    /// "XXXXXX_T" for FSP-T
> 
>    /// "XXXXXX_M" for FSP-M
> 
>    /// "XXXXXX_S" for FSP-S
> 
> +  /// "XXXXXX_I" for FSP-I
> 
>    /// Where XXXXXX is an unique signature
> 
>    ///
> 
>    UINT64    Signature;
> 
>    ///
> 
>    /// Revision of the Data structure.
> 
> -  ///   For FSP spec 2.0/2.1 value is 1.
> 
> -  ///   For FSP spec 2.2 value is 2.
> 
> +  ///   For FSP spec 2.0/2.1, this value is 1 and only FSPM_UPD having
> ARCH_UPD.
> 
> +  ///   For FSP spec 2.2 and above, this value is 2 and ARCH_UPD present in all
> UPD structures.
> 
>    ///
> 
>    UINT8     Revision;
> 
>    UINT8     Reserved[23];
> 
> @@ -134,7 +135,7 @@ typedef struct {
>  } FSPT_ARCH_UPD;
> 
> 
> 
>  ///
> 
> -/// FSPT_ARCH2_UPD Configuration.
> 
> +/// FSPT_ARCH2_UPD Configuration for FSP 2.4 and above.
> 
>  ///
> 
>  typedef struct {
> 
>    ///
> 
> @@ -196,7 +197,7 @@ typedef struct {
>  } FSPM_ARCH_UPD;
> 
> 
> 
>  ///
> 
> -/// FSPM_ARCH2_UPD Configuration.
> 
> +/// FSPM_ARCH2_UPD Configuration for FSP 2.4 and above.
> 
>  ///
> 
>  typedef struct {
> 
>    ///
> 
> @@ -209,6 +210,13 @@ typedef struct {
>    ///
> 
>    UINT32                  Length;
> 
>    ///
> 
> +  /// Pointer to the non-volatile storage (NVS) data buffer.
> 
> +  /// If it is NULL it indicates the NVS data is not available.
> 
> +  /// This value is deprecated starting with v2.4 of the FSP 
> + specification,
> 
> +  /// and will be removed in an upcoming version of the FSP specification.
> 
> +  ///
> 
> +  EFI_PHYSICAL_ADDRESS    NvsBufferPtr;
> 
> +  ///
> 
>    /// Pointer to the temporary stack base address to be
> 
>    /// consumed inside FspMemoryInit() API.
> 
>    ///
> 
> @@ -232,7 +240,7 @@ typedef struct {
>    /// This value is only valid if Revision is >= 2.
> 
>    ///
> 
>    EFI_PHYSICAL_ADDRESS    FspEventHandler;
> 
> -  UINT8                   Reserved1[24];
> 
> +  UINT8                   Reserved1[16];
> 
>  } FSPM_ARCH2_UPD;
> 
> 
> 
>  ///
> 
> @@ -265,7 +273,7 @@ typedef struct {
>  } FSPS_ARCH_UPD;
> 
> 
> 
>  ///
> 
> -/// FSPS_ARCH2_UPD Configuration.
> 
> +/// FSPS_ARCH2_UPD Configuration for FSP 2.4 and above.
> 
>  ///
> 
>  typedef struct {
> 
>    ///
> 
> @@ -285,6 +293,40 @@ typedef struct {
>    UINT8                   Reserved1[16];
> 
>  } FSPS_ARCH2_UPD;
> 
> 
> 
> +///
> 
> +/// FSPI_ARCH_UPD Configuration.
> 
> +///
> 
> +typedef struct {
> 
> +  ///
> 
> +  /// Revision of the structure is 1 for this version of the specification.
> 
> +  ///
> 
> +  UINT8                   Revision;
> 
> +  UINT8                   Reserved[3];
> 
> +  ///
> 
> +  /// Length of the structure in bytes. The current value for this field is 32.
> 
> +  ///
> 
> +  UINT32                  Length;
> 
> +  ///
> 
> +  /// The physical memory-mapped base address of the bootloader SMM
> firmware volume (FV).
> 
> +  ///
> 
> +  EFI_PHYSICAL_ADDRESS    BootloaderSmmFvBaseAddress;
> 
> +  ///
> 
> +  /// The length in bytes of the bootloader SMM firmware volume (FV).
> 
> +  ///
> 
> +  UINT64                  BootloaderSmmFvLength;
> 
> +  ///
> 
> +  /// The physical memory-mapped base address of the bootloader SMM 
> + FV
> context data.
> 
> +  /// This data is provided to bootloader SMM drivers through a HOB 
> + by the FSP
> MM Foundation.
> 
> +  ///
> 
> +  EFI_PHYSICAL_ADDRESS    BootloaderSmmFvContextData;
> 
> +  ///
> 
> +  /// The length in bytes of the bootloader SMM FV context data.
> 
> +  /// This data is provided to bootloader SMM drivers through a HOB 
> + by the FSP
> MM Foundation.
> 
> +  ///
> 
> +  UINT16                  BootloaderSmmFvContextDataLength;
> 
> +  UINT8                   Reserved1[24];
> 
> +} FSPI_ARCH_UPD;
> 
> +
> 
>  ///
> 
>  /// FSPT_UPD_COMMON Configuration.
> 
>  ///
> 
> @@ -393,6 +435,21 @@ typedef struct {
>    FSPS_ARCH2_UPD    FspsArchUpd;
> 
>  } FSPS_UPD_COMMON_FSP24;
> 
> 
> 
> +///
> 
> +/// FSPI_UPD_COMMON Configuration.
> 
> +///
> 
> +typedef struct {
> 
> +  ///
> 
> +  /// FSP_UPD_HEADER Configuration.
> 
> +  ///
> 
> +  FSP_UPD_HEADER    FspUpdHeader;
> 
> +
> 
> +  ///
> 
> +  /// FSPI_ARCH_UPD Configuration.
> 
> +  ///
> 
> +  FSPI_ARCH_UPD     FspiArchUpd;
> 
> +} FSPI_UPD_COMMON;
> 
> +
> 
>  ///
> 
>  /// Enumeration of FSP_INIT_PHASE for NOTIFY_PHASE.
> 
>  ///
> 
> diff --git a/IntelFsp2Pkg/Include/FspGlobalData.h
> b/IntelFsp2Pkg/Include/FspGlobalData.h
> index 697b20ed4c..cf94f7b6a5 100644
> --- a/IntelFsp2Pkg/Include/FspGlobalData.h
> +++ b/IntelFsp2Pkg/Include/FspGlobalData.h
> @@ -12,7 +12,7 @@
> 
> 
>  #define FSP_IN_API_MODE          0
> 
>  #define FSP_IN_DISPATCH_MODE     1
> 
> -#define FSP_GLOBAL_DATA_VERSION  1
> 
> +#define FSP_GLOBAL_DATA_VERSION  0x2
> 
> 
> 
>  #pragma pack(1)
> 
> 
> 
> diff --git a/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h
> b/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h
> index c7fb63168f..5381716d81 100644
> --- a/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h
> +++ b/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h
> @@ -52,7 +52,7 @@ typedef struct {
>    UINT8     Reserved1[2];
> 
>    ///
> 
>    /// Byte 0x0A: Indicates compliance with a revision of this 
> specification in the BCD format.
> 
> -  ///            For revision v2.3 the value will be 0x23.
> 
> +  ///            For revision v2.4 the value will be 0x24.
> 
>    ///
> 
>    UINT8     SpecVersion;
> 
>    ///
> 
> @@ -93,11 +93,28 @@ typedef struct {
>    ///   Bit 0: Graphics Support - Set to 1 when FSP supports enabling Graphics
> Display.
> 
>    ///   Bit 1: Dispatch Mode Support - Set to 1 when FSP supports the optional
> Dispatch Mode API defined in Section 7.2 and 9. This bit is only valid 
> if FSP HeaderRevision is >= 4.
> 
>    ///   Bit 2: 64-bit mode support - Set to 1 to indicate FSP supports 64-bit long
> mode interfaces. Set to 0 to indicate FSP supports 32-bit mode 
> interfaces. This bit is only valid if FSP HeaderRevision is >= 7.
> 
> -  ///   Bits 15:3 - Reserved
> 
> +  ///   Bit 3: FSP Variable Services Support - Set to 1 to indicate FSP utilizes the
> FSP Variable Services defined in Section 9.6 to store non-volatile 
> data. This bit is only valid if FSP HeaderRevision is >= 7.
> 
> +  ///   Bits 15:4 - Reserved
> 
>    ///
> 
>    UINT16    ImageAttribute;
> 
>    ///
> 
>    /// Byte 0x22: Attributes of the FSP Component.
> 
> +  ///   Bit 0 - Build Type
> 
> +  ///     0 - Debug Build
> 
> +  ///     1 - Release Build
> 
> +  ///   Bit 1 - Release Type
> 
> +  ///     0 - Test Release
> 
> +  ///     1 - Official Release
> 
> +  ///   Bit 11:2 - Reserved
> 
> +  ///   Bits 15:12 - Component Type
> 
> +  ///     0000 - Reserved
> 
> +  ///     0001 - FSP-T
> 
> +  ///     0010 - FSP-M
> 
> +  ///     0011 - FSP-S
> 
> +  ///     0100 - FSP-I (FSP SMM)
> 
> +  ///     0101 to 0111 - Reserved
> 
> +  ///     1000 - FSP-O
> 
> +  ///     1001 to 1111 - Reserved
> 
>    ///
> 
>    UINT16    ComponentAttribute;
> 
>    ///
> 
> diff --git a/IntelFsp2Pkg/Tools/SplitFspBin.py
> b/IntelFsp2Pkg/Tools/SplitFspBin.py
> index 317d9c1fa0..ddabab7d8c 100644
> --- a/IntelFsp2Pkg/Tools/SplitFspBin.py
> +++ b/IntelFsp2Pkg/Tools/SplitFspBin.py
> @@ -492,7 +492,7 @@ class FspImage:
>          self.FihOffset = fihoff
> 
>          self.Offset    = offset
> 
>          self.FvIdxList = []
> 
> -        self.Type      = "XTMSIXXXXOXXXXXXX"[(fih.ComponentAttribute >> 12) &
> 0x0F]
> 
> +        self.Type      = "XTMSIXXXOXXXXXXX"[(fih.ComponentAttribute >> 12) &
> 0x0F]
> 
>          self.PatchList = patch
> 
>          self.PatchList.append(fihoff + 0x1C)
> 
> 
> 
> --
> 2.35.0.windows.1