[PATCH] IntelFsp2Pkg: Support FSP API mode indicator

[PATCH] IntelFsp2Pkg: Support FSP API mode indicator

[Chasel, Chiu]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1241

FSP will support both API and DISPATCH mode and require one
field from Global Data Structure to tell which mode is
selected by boot loader.
Use one reserved byte for FSP API mode indicator -
FspApiModeEnabled and maintain backward compatibility:
1. If platform FSP supports DISPATCH mode, it must
   initialize this new field.
2. If platform FSP does not support DISPATCH mode,
   this new field has no effect/not used.

Test: Verified compiling without issue.

Cc: Jiewen Yao <Jiewen.yao@intel.com>
Cc: Desimone Nathaniel L <nathaniel.l.desimone@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
---
 IntelFsp2Pkg/Include/FspGlobalData.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/IntelFsp2Pkg/Include/FspGlobalData.h b/IntelFsp2Pkg/Include/FspGlobalData.h
index 7de26606a7..ccc9ecd78a 100644
--- a/IntelFsp2Pkg/Include/FspGlobalData.h
+++ b/IntelFsp2Pkg/Include/FspGlobalData.h
@@ -1,6 +1,6 @@
 /** @file
 
-  Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>
   This program and the accompanying materials
   are licensed and made available under the terms and conditions of the BSD License
   which accompanies this distribution.  The full text of the license may be found at
@@ -54,7 +54,8 @@ typedef struct  {
    VOID               *MemoryInitUpdPtr;
    VOID               *SiliconInitUpdPtr;
    UINT8              ApiIdx;
-   UINT8              Reserved3[31];
+   UINT8              FspApiModeEnabled; // 1: API mode; 0: DISPATCH mode
+   UINT8              Reserved3[30];
    UINT32             PerfSig;
    UINT16             PerfLen;
    UINT16             Reserved4;
-- 
2.13.3.windows.1

Re: [PATCH] IntelFsp2Pkg: Support FSP API mode indicator

[Yao, Jiewen]

Thanks Chasel.
I suggest we test the real function besides just pass build.

Please make sure your test below combination:
1) FSP wrapper with this change + FSP binary with this change.
2) FSP wrapper with this change + FSP binary without this change.

Thank you
Yao Jiewen

> -----Original Message-----
> From: Chiu, Chasel
> Sent: Thursday, October 11, 2018 9:35 PM
> To: edk2-devel@lists.01.org
> Cc: Yao, Jiewen <jiewen.yao@intel.com>; Desimone, Nathaniel L
> <nathaniel.l.desimone@intel.com>; Chiu, Chasel <chasel.chiu@intel.com>
> Subject: [PATCH] IntelFsp2Pkg: Support FSP API mode indicator
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1241
> 
> FSP will support both API and DISPATCH mode and require one
> field from Global Data Structure to tell which mode is
> selected by boot loader.
> Use one reserved byte for FSP API mode indicator -
> FspApiModeEnabled and maintain backward compatibility:
> 1. If platform FSP supports DISPATCH mode, it must
>    initialize this new field.
> 2. If platform FSP does not support DISPATCH mode,
>    this new field has no effect/not used.
> 
> Test: Verified compiling without issue.
> 
> Cc: Jiewen Yao <Jiewen.yao@intel.com>
> Cc: Desimone Nathaniel L <nathaniel.l.desimone@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
> ---
>  IntelFsp2Pkg/Include/FspGlobalData.h | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/IntelFsp2Pkg/Include/FspGlobalData.h
> b/IntelFsp2Pkg/Include/FspGlobalData.h
> index 7de26606a7..ccc9ecd78a 100644
> --- a/IntelFsp2Pkg/Include/FspGlobalData.h
> +++ b/IntelFsp2Pkg/Include/FspGlobalData.h
> @@ -1,6 +1,6 @@
>  /** @file
> 
> -  Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>
>    This program and the accompanying materials
>    are licensed and made available under the terms and conditions of the
> BSD License
>    which accompanies this distribution.  The full text of the license may be
> found at
> @@ -54,7 +54,8 @@ typedef struct  {
>     VOID               *MemoryInitUpdPtr;
>     VOID               *SiliconInitUpdPtr;
>     UINT8              ApiIdx;
> -   UINT8              Reserved3[31];
> +   UINT8              FspApiModeEnabled; // 1: API mode; 0:
> DISPATCH mode
> +   UINT8              Reserved3[30];
>     UINT32             PerfSig;
>     UINT16             PerfLen;
>     UINT16             Reserved4;
> --
> 2.13.3.windows.1

Re: [PATCH] IntelFsp2Pkg: Support FSP API mode indicator

[Chiu, Chasel]

Hi Jiewen,

This one just adding a new field in FspGlobalData structure which never been consumed in current code base.
I'm checking if we should combine DISPATCH mode support code together instead of just header change.

Thanks!
Chasel


-----Original Message-----
From: Yao, Jiewen 
Sent: Thursday, October 11, 2018 9:41 PM
To: Chiu, Chasel <chasel.chiu@intel.com>; edk2-devel@lists.01.org
Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>
Subject: RE: [PATCH] IntelFsp2Pkg: Support FSP API mode indicator

Thanks Chasel.
I suggest we test the real function besides just pass build.

Please make sure your test below combination:
1) FSP wrapper with this change + FSP binary with this change.
2) FSP wrapper with this change + FSP binary without this change.

Thank you
Yao Jiewen

> -----Original Message-----
> From: Chiu, Chasel
> Sent: Thursday, October 11, 2018 9:35 PM
> To: edk2-devel@lists.01.org
> Cc: Yao, Jiewen <jiewen.yao@intel.com>; Desimone, Nathaniel L 
> <nathaniel.l.desimone@intel.com>; Chiu, Chasel <chasel.chiu@intel.com>
> Subject: [PATCH] IntelFsp2Pkg: Support FSP API mode indicator
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1241
> 
> FSP will support both API and DISPATCH mode and require one field from 
> Global Data Structure to tell which mode is selected by boot loader.
> Use one reserved byte for FSP API mode indicator - FspApiModeEnabled 
> and maintain backward compatibility:
> 1. If platform FSP supports DISPATCH mode, it must
>    initialize this new field.
> 2. If platform FSP does not support DISPATCH mode,
>    this new field has no effect/not used.
> 
> Test: Verified compiling without issue.
> 
> Cc: Jiewen Yao <Jiewen.yao@intel.com>
> Cc: Desimone Nathaniel L <nathaniel.l.desimone@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
> ---
>  IntelFsp2Pkg/Include/FspGlobalData.h | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/IntelFsp2Pkg/Include/FspGlobalData.h
> b/IntelFsp2Pkg/Include/FspGlobalData.h
> index 7de26606a7..ccc9ecd78a 100644
> --- a/IntelFsp2Pkg/Include/FspGlobalData.h
> +++ b/IntelFsp2Pkg/Include/FspGlobalData.h
> @@ -1,6 +1,6 @@
>  /** @file
> 
> -  Copyright (c) 2014 - 2016, Intel Corporation. All rights 
> reserved.<BR>
> +  Copyright (c) 2014 - 2018, Intel Corporation. All rights 
> + reserved.<BR>
>    This program and the accompanying materials
>    are licensed and made available under the terms and conditions of 
> the BSD License
>    which accompanies this distribution.  The full text of the license 
> may be found at @@ -54,7 +54,8 @@ typedef struct  {
>     VOID               *MemoryInitUpdPtr;
>     VOID               *SiliconInitUpdPtr;
>     UINT8              ApiIdx;
> -   UINT8              Reserved3[31];
> +   UINT8              FspApiModeEnabled; // 1: API mode; 0:
> DISPATCH mode
> +   UINT8              Reserved3[30];
>     UINT32             PerfSig;
>     UINT16             PerfLen;
>     UINT16             Reserved4;
> --
> 2.13.3.windows.1