IntelFsp2Pkg: Add FSPx_ARCH2_UPD support for X64

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3893
1.Added FSPx_ARCH2_UPD structures which support both IA32 and X64.
2.Added FSPx_UPD_COMMON_FSP24 structures.

Cc: Chasel Chiu <chasel.chiu@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Ashraf Ali S <ashraf.ali.s@intel.com>
Signed-off-by: Ted Kuo <ted.kuo@intel.com>
Reviewed-by: Chasel Chiu <chasel.chiu@intel.com>
Reviewed-by: Nate DeSimone <nathaniel.l.desimone@intel.com>

4 files changed, 252 insertions, 24 deletions

diff --git a/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryM.nasm b/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryM.nasm
index e7261b41cd..5dada2af54 100644
--- a/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryM.nasm
+++ b/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryM.nasm
@@ -1,7 +1,7 @@
 ;; @file

 ;  Provide FSP API entry points.

 ;

-; Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.<BR>

+; Copyright (c) 2016 - 2022, Intel Corporation. All rights reserved.<BR>

 ; SPDX-License-Identifier: BSD-2-Clause-Patent

 ;;

 

@@ -32,6 +32,24 @@ struc FSPM_UPD_COMMON
     .size:

 endstruc

 

+struc FSPM_UPD_COMMON_FSP24

+    ; FSP_UPD_HEADER {

+    .FspUpdHeader:              resd  8

+    ; }

+    ; FSPM_ARCH2_UPD {

+    .Revision:                  resb  1

+    .Reserved:                  resb  3

+    .Length                     resd  1

+    .StackBase:                 resq  1

+    .StackSize:                 resq  1

+    .BootLoaderTolumSize:       resd  1

+    .BootMode:                  resd  1

+    .FspEventHandler            resq  1

+    .Reserved1:                 resb 24

+    ; }

+    .size:

+endstruc

+

 ;

 ; Following functions will be provided in C

 ;

@@ -124,12 +142,22 @@ ASM_PFX(FspApiCommonContinue):
   pop    eax

 

 FspStackSetup:

+  mov    ecx, [edx + FSPM_UPD_COMMON.Revision]

+  cmp    ecx, 3

+  jae    FspmUpdCommon2

+

   ;

   ; StackBase = temp memory base, StackSize = temp memory size

   ;

   mov    edi, [edx + FSPM_UPD_COMMON.StackBase]

   mov    ecx, [edx + FSPM_UPD_COMMON.StackSize]

+  jmp    ChkFspHeapSize

+

+FspmUpdCommon2:

+  mov    edi, [edx + FSPM_UPD_COMMON_FSP24.StackBase]

+  mov    ecx, [edx + FSPM_UPD_COMMON_FSP24.StackSize]

 

+ChkFspHeapSize:

   ;

   ; Keep using bootloader stack if heap size % is 0

   ;

@@ -219,7 +247,7 @@ exit:
 global ASM_PFX(FspPeiCoreEntryOff)

 ASM_PFX(FspPeiCoreEntryOff):

    ;

-   ; This value will be pached by the build script

+   ; This value will be patched by the build script

    ;

    DD    0x12345678

 

diff --git a/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryT.nasm b/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryT.nasm
index 7fd3d6d843..61030a843b 100644
--- a/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryT.nasm
+++ b/IntelFsp2Pkg/FspSecCore/Ia32/FspApiEntryT.nasm
@@ -1,7 +1,7 @@
 ;; @file

 ;  Provide FSP API entry points.

 ;

-; Copyright (c) 2016 - 2020, Intel Corporation. All rights reserved.<BR>

+; Copyright (c) 2016 - 2022, Intel Corporation. All rights reserved.<BR>

 ; SPDX-License-Identifier: BSD-2-Clause-Patent

 ;;

 

@@ -84,8 +84,10 @@ struc LoadMicrocodeParamsFsp22
     .FspUpdHeaderRevision:    resb    1

     .FspUpdHeaderReserved:    resb   23

     ; }

-    ; FSPT_ARCH_UPD{

-    .FsptArchUpd:             resd    8

+    ; FSPT_ARCH_UPD {

+    .FsptArchRevision:        resb    1

+    .FsptArchReserved:        resb    3

+    .FsptArchUpd:             resd    7

     ; }

     ; FSPT_CORE_UPD {

     .MicrocodeCodeAddr:       resd    1

@@ -96,6 +98,28 @@ struc LoadMicrocodeParamsFsp22
     .size:

 endstruc

 

+struc LoadMicrocodeParamsFsp24

+    ; FSP_UPD_HEADER {

+    .FspUpdHeaderSignature:   resd    2

+    .FspUpdHeaderRevision:    resb    1

+    .FspUpdHeaderReserved:    resb   23

+    ; }

+    ; FSPT_ARCH2_UPD {

+    .FsptArchRevision:        resb    1

+    .FsptArchReserved:        resb    3

+    .FsptArchLength:          resd    1

+    .FspDebugHandler          resq    1

+    .FsptArchUpd:             resd    4

+    ; }

+    ; FSPT_CORE_UPD {

+    .MicrocodeCodeAddr:       resq    1

+    .MicrocodeCodeSize:       resq    1

+    .CodeRegionBase:          resq    1

+    .CodeRegionSize:          resq    1

+    ; }

+    .size:

+endstruc

+

 ;

 ; Define SSE macros

 ;

@@ -173,8 +197,8 @@ ASM_PFX(LoadMicrocodeDefault):
    ;   Beginning of microcode update region starts on paragraph boundary

 

    ;

-   ;

    ; Save return address to EBP

+   ;

    movd   ebp, mm7

 

    cmp    esp, 0

@@ -188,8 +212,12 @@ ASM_PFX(LoadMicrocodeDefault):
    ; and report error if size is less than 2k

    ; first check UPD header revision

    cmp    byte [esp + LoadMicrocodeParamsFsp22.FspUpdHeaderRevision], 2

-   jae    Fsp22UpdHeader

+   jb     Fsp20UpdHeader

+   cmp    byte [esp + LoadMicrocodeParamsFsp22.FsptArchRevision], 2

+   je     Fsp24UpdHeader

+   jmp    Fsp22UpdHeader

 

+Fsp20UpdHeader:

    ; UPD structure is compliant with FSP spec 2.0/2.1

    mov    eax, dword [esp + LoadMicrocodeParams.MicrocodeCodeSize]

    cmp    eax, 0

@@ -213,6 +241,19 @@ Fsp22UpdHeader:
    mov    esi, dword [esp + LoadMicrocodeParamsFsp22.MicrocodeCodeAddr]

    cmp    esi, 0

    jnz    CheckMainHeader

+   jmp    ParamError

+

+Fsp24UpdHeader:

+   ; UPD structure is compliant with FSP spec 2.4

+   mov    eax, dword [esp + LoadMicrocodeParamsFsp24.MicrocodeCodeSize]

+   cmp    eax, 0

+   jz     Exit2

+   cmp    eax, 0800h

+   jl     ParamError

+

+   mov    esi, dword [esp + LoadMicrocodeParamsFsp24.MicrocodeCodeAddr]

+   cmp    esi, 0

+   jnz    CheckMainHeader

 

 ParamError:

    mov    eax, 080000002h

@@ -308,9 +349,13 @@ AdvanceFixedSize:
 

 CheckAddress:

    ; Check UPD header revision

-   cmp    byte [esp + LoadMicrocodeParamsFsp22.FspUpdHeaderRevision], 2

-   jae    Fsp22UpdHeader1

+   cmp   byte [esp + LoadMicrocodeParamsFsp22.FspUpdHeaderRevision], 2

+   jb     Fsp20UpdHeader1

+   cmp    byte [esp + LoadMicrocodeParamsFsp22.FsptArchRevision], 2

+   je     Fsp24UpdHeader1;

+   jmp    Fsp22UpdHeader1

 

+Fsp20UpdHeader1:

    ; UPD structure is compliant with FSP spec 2.0/2.1

    ; Is automatic size detection ?

    mov   eax, dword [esp + LoadMicrocodeParams.MicrocodeCodeSize]

@@ -336,6 +381,19 @@ Fsp22UpdHeader1:
    jae   Done        ;Jif address is outside of microcode region

    jmp   CheckMainHeader

 

+Fsp24UpdHeader1:

+   ; UPD structure is compliant with FSP spec 2.4

+   ; Is automatic size detection ?

+   mov   eax, dword [esp + LoadMicrocodeParamsFsp24.MicrocodeCodeSize]

+   cmp   eax, 0ffffffffh

+   jz    LoadMicrocodeDefault4

+

+   ; Address >= microcode region address + microcode region size?

+   add   eax, dword [esp + LoadMicrocodeParamsFsp24.MicrocodeCodeAddr]

+   cmp   esi, eax

+   jae   Done        ;Jif address is outside of microcode region

+   jmp   CheckMainHeader

+

 LoadMicrocodeDefault4:

    ; Is valid Microcode start point ?

    cmp   dword [esi + MicrocodeHdr.MicrocodeHdrVersion], 0ffffffffh

@@ -351,7 +409,7 @@ LoadCheck:
    mov   eax, 1

    cpuid

    mov   ecx, MSR_IA32_BIOS_SIGN_ID

-   rdmsr                         ; Get current microcode signature

+   rdmsr                        ; Get current microcode signature

 

    ; Verify this microcode update is not already loaded

    cmp   dword [esi + MicrocodeHdr.MicrocodeHdrRevision], edx

@@ -405,8 +463,12 @@ ASM_PFX(EstablishStackFsp):
 

   ; check UPD structure revision (edx + 8)

   cmp       byte [edx + LoadMicrocodeParamsFsp22.FspUpdHeaderRevision], 2

-  jae       Fsp22UpdHeader2

+  jb        Fsp20UpdHeader2

+  cmp       byte [esp + LoadMicrocodeParamsFsp22.FsptArchRevision], 2

+  je        Fsp24UpdHeader2

+  jmp       Fsp22UpdHeader2

 

+Fsp20UpdHeader2:

   ; UPD structure is compliant with FSP spec 2.0/2.1

   push      dword [edx + LoadMicrocodeParams.CodeRegionSize]     ; Code size       sizeof(FSPT_UPD_COMMON) + 12

   push      dword [edx + LoadMicrocodeParams.CodeRegionBase]     ; Code base       sizeof(FSPT_UPD_COMMON) + 8

@@ -420,6 +482,14 @@ Fsp22UpdHeader2:
   push      dword [edx + LoadMicrocodeParamsFsp22.CodeRegionBase]     ; Code base       sizeof(FSPT_UPD_COMMON) + 8

   push      dword [edx + LoadMicrocodeParamsFsp22.MicrocodeCodeSize]  ; Microcode size  sizeof(FSPT_UPD_COMMON) + 4

   push      dword [edx + LoadMicrocodeParamsFsp22.MicrocodeCodeAddr]  ; Microcode base  sizeof(FSPT_UPD_COMMON) + 0

+  jmp       ContinueAfterUpdPush

+

+Fsp24UpdHeader2:

+  ; UPD structure is compliant with FSP spec 2.4

+  push      dword [edx + LoadMicrocodeParamsFsp24.CodeRegionSize]     ; Code size       sizeof(FSPT_UPD_COMMON) + 24

+  push      dword [edx + LoadMicrocodeParamsFsp24.CodeRegionBase]     ; Code base       sizeof(FSPT_UPD_COMMON) + 16

+  push      dword [edx + LoadMicrocodeParamsFsp24.MicrocodeCodeSize]  ; Microcode size  sizeof(FSPT_UPD_COMMON) + 8

+  push      dword [edx + LoadMicrocodeParamsFsp24.MicrocodeCodeAddr]  ; Microcode base  sizeof(FSPT_UPD_COMMON) + 0

 

 ContinueAfterUpdPush:

   ;

@@ -517,13 +587,13 @@ ASM_PFX(TempRamInitApi):
   cmp       eax, 0

   jnz       TempRamInitExit

 

-  LXMMN      xmm6, eax, 3  ;Restore microcode status if no CAR init error from ECX-SLOT 3 in xmm6.

+  LXMMN     xmm6, eax, 3  ;Restore microcode status if no CAR init error from ECX-SLOT 3 in xmm6.

 

 TempRamInitExit:

-   mov      bl, al                  ; save al data in bl

-   mov      al, 07Fh                ; API exit postcode 7f

-   out      080h, al

-   mov      al, bl                  ; restore al data from bl

+  mov       bl, al                  ; save al data in bl

+  mov       al, 07Fh                ; API exit postcode 7f

+  out       080h, al

+  mov       al, bl                  ; restore al data from bl

 

   ;

   ; Load EBP, EBX, ESI, EDI & ESP from XMM7 & XMM6

diff --git a/IntelFsp2Pkg/Include/FspEas/FspApi.h b/IntelFsp2Pkg/Include/FspEas/FspApi.h
index 794f94dc7a..b36bc2b9ae 100644
--- 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

   Architecture Specification v2.0 - v2.2

 

-  Copyright (c) 2014 - 2020, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2014 - 2022, Intel Corporation. All rights reserved.<BR>

   SPDX-License-Identifier: BSD-2-Clause-Patent

 

 **/

@@ -112,12 +112,12 @@ typedef struct {
 ///

 typedef struct {

   ///

-  /// Revision Revision of the structure is 1 for this version of the specification.

+  /// Revision of the structure is 1 for this version of the specification.

   ///

   UINT8                Revision;

   UINT8                Reserved[3];

   ///

-  /// Length Length of the structure in bytes. The current value for this field is 32.

+  /// Length of the structure in bytes. The current value for this field is 32.

   ///

   UINT32               Length;

   ///

@@ -129,6 +129,27 @@ typedef struct {
 } FSPT_ARCH_UPD;

 

 ///

+/// FSPT_ARCH2_UPD Configuration.

+///

+typedef struct {

+  ///

+  /// Revision of the structure is 2 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;

+  ///

+  /// FspDebugHandler Optional debug handler for the bootloader to receive debug messages

+  /// occurring during FSP execution.

+  ///

+  EFI_PHYSICAL_ADDRESS FspDebugHandler;

+  UINT8                Reserved1[16];

+} FSPT_ARCH2_UPD;

+

+///

 /// FSPM_ARCH_UPD Configuration.

 ///

 typedef struct {

@@ -169,14 +190,57 @@ typedef struct {
   UINT8                Reserved1[4];

 } FSPM_ARCH_UPD;

 

+///

+/// FSPM_ARCH2_UPD Configuration.

+///

+typedef struct {

+  ///

+  /// Revision of the structure is 3 for this version of the specification.

+  ///

+  UINT8                Revision;

+  UINT8                Reserved[3];

+  ///

+  /// Length of the structure in bytes. The current value for this field is 64.

+  ///

+  UINT32               Length;

+  ///

+  /// Pointer to the temporary stack base address to be

+  /// consumed inside FspMemoryInit() API.

+  ///

+  EFI_PHYSICAL_ADDRESS StackBase;

+  ///

+  /// Temporary stack size to be consumed inside

+  /// FspMemoryInit() API.

+  ///

+  UINT64               StackSize;

+  ///

+  /// Size of memory to be reserved by FSP below "top

+  /// of low usable memory" for bootloader usage.

+  ///

+  UINT32               BootLoaderTolumSize;

+  ///

+  /// Current boot mode.

+  ///

+  UINT32               BootMode;

+  ///

+  /// Optional event handler for the bootloader to be informed of events occurring during FSP execution.

+  /// This value is only valid if Revision is >= 2.

+  ///

+  EFI_PHYSICAL_ADDRESS FspEventHandler;

+  UINT8                Reserved1[24];

+} FSPM_ARCH2_UPD;

+

+///

+/// FSPS_ARCH_UPD Configuration.

+///

 typedef struct {

   ///

-  /// Revision Revision of the structure is 1 for this version of the specification.

+  /// Revision of the structure is 1 for this version of the specification.

   ///

   UINT8                Revision;

   UINT8                Reserved[3];

   ///

-  /// Length Length of the structure in bytes. The current value for this field is 32.

+  /// Length of the structure in bytes. The current value for this field is 32.

   ///

   UINT32               Length;

   ///

@@ -196,6 +260,27 @@ typedef struct {
 } FSPS_ARCH_UPD;

 

 ///

+/// FSPS_ARCH2_UPD Configuration.

+///

+typedef struct {

+  ///

+  /// Revision of the structure is 2 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;

+  ///

+  /// FspEventHandler Optional event handler for the bootloader to be informed of events

+  /// occurring during FSP execution.

+  ///

+  EFI_PHYSICAL_ADDRESS FspEventHandler;

+  UINT8                Reserved1[16];

+} FSPS_ARCH2_UPD;

+

+///

 /// FSPT_UPD_COMMON Configuration.

 ///

 typedef struct {

@@ -221,6 +306,21 @@ typedef struct {
 } FSPT_UPD_COMMON_FSP22;

 

 ///

+/// FSPT_UPD_COMMON Configuration for FSP spec. 2.4 and above.

+///

+typedef struct {

+  ///

+  /// FSP_UPD_HEADER Configuration.

+  ///

+  FSP_UPD_HEADER    FspUpdHeader;

+

+  ///

+  /// FSPT_ARCH2_UPD Configuration.

+  ///

+  FSPT_ARCH2_UPD    FsptArchUpd;

+} FSPT_UPD_COMMON_FSP24;

+

+///

 /// FSPM_UPD_COMMON Configuration.

 ///

 typedef struct {

@@ -235,6 +335,20 @@ typedef struct {
 } FSPM_UPD_COMMON;

 

 ///

+/// FSPM_UPD_COMMON Configuration for FSP spec. 2.4 and above.

+///

+typedef struct {

+  ///

+  /// FSP_UPD_HEADER Configuration.

+  ///

+  FSP_UPD_HEADER    FspUpdHeader;

+  ///

+  /// FSPM_ARCH2_UPD Configuration.

+  ///

+  FSPM_ARCH2_UPD    FspmArchUpd;

+} FSPM_UPD_COMMON_FSP24;

+

+///

 /// FSPS_UPD_COMMON Configuration.

 ///

 typedef struct {

@@ -260,6 +374,21 @@ typedef struct {
 } FSPS_UPD_COMMON_FSP22;

 

 ///

+/// FSPS_UPD_COMMON Configuration for FSP spec. 2.4 and above.

+///

+typedef struct {

+  ///

+  /// FSP_UPD_HEADER Configuration.

+  ///

+  FSP_UPD_HEADER    FspUpdHeader;

+

+  ///

+  /// FSPS_ARCH2_UPD Configuration.

+  ///

+  FSPS_ARCH2_UPD    FspsArchUpd;

+} FSPS_UPD_COMMON_FSP24;

+

+///

 /// Enumeration of FSP_INIT_PHASE for NOTIFY_PHASE.

 ///

 typedef enum {

diff --git a/IntelFsp2Pkg/Tools/GenCfgOpt.py b/IntelFsp2Pkg/Tools/GenCfgOpt.py
index 714b2d8b1a..c4fb1f1bb2 100644
--- a/IntelFsp2Pkg/Tools/GenCfgOpt.py
+++ b/IntelFsp2Pkg/Tools/GenCfgOpt.py
@@ -1,6 +1,6 @@
 ## @ GenCfgOpt.py

 #

-# Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2014 - 2022, Intel Corporation. All rights reserved.<BR>

 # SPDX-License-Identifier: BSD-2-Clause-Patent

 #

 ##

@@ -1398,6 +1398,7 @@ EndList
         UpdConfigCheck = ['FSP_T', 'FSP_M', 'FSP_S']  # FSP_X_CONFIG, FSP_X_TEST_CONFIG, FSP_X_RESTRICTED_CONFIG

         UpdSignatureCheck = ['FSPT_UPD_SIGNATURE', 'FSPM_UPD_SIGNATURE', 'FSPS_UPD_SIGNATURE']

         ExcludedSpecificUpd = ['FSPT_ARCH_UPD', 'FSPM_ARCH_UPD', 'FSPS_ARCH_UPD']

+        ExcludedSpecificUpd1 = ['FSPT_ARCH2_UPD', 'FSPM_ARCH2_UPD', 'FSPS_ARCH2_UPD']

 

         IncLines = []

         if InputHeaderFile != '':

@@ -1452,7 +1453,7 @@ EndList
                 if Match:

                     StartIndex = Index - 1

                 Match = re.match("}\s([_A-Z0-9]+);", Line)

-                if Match and (UpdRegionCheck[item] in Match.group(1) or UpdConfigCheck[item] in Match.group(1)) and (ExcludedSpecificUpd[item] not in Match.group(1)):

+                if Match and (UpdRegionCheck[item] in Match.group(1) or UpdConfigCheck[item] in Match.group(1)) and (ExcludedSpecificUpd[item] not in Match.group(1)) and (ExcludedSpecificUpd1[item] not in Match.group(1)):

                     EndIndex = Index

                     StructStart.append(StartIndex)

                     StructEnd.append(EndIndex)

@@ -1695,7 +1696,7 @@ EndList
 

 

 def Usage():

-    print ("GenCfgOpt Version 0.56")

+    print ("GenCfgOpt Version 0.57")

     print ("Usage:")

     print ("    GenCfgOpt  UPDTXT  PlatformDscFile BuildFvDir                 [-D Macros]")

     print ("    GenCfgOpt  HEADER  PlatformDscFile BuildFvDir  InputHFile     [-D Macros]")