[PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.

[PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.

[Chiu, Chasel]

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

Add header file for FSP_TEMP_RAM_EXIT_PPI which is
defined by FSP 2.1 spec.

Test: Build successfully.

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/Ppi/TempRamExitPpi.h | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
new file mode 100644
index 0000000000..9e728a5d4d
--- /dev/null
+++ b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
@@ -0,0 +1,50 @@
+/** @file
+  This file defines the Silicon Temp Ram Exit PPI which implements the
+  required programming steps for disabling temporary memory.
+
+Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef _FSP_TEMP_RAM_EXIT_PPI_H_
+#define _FSP_TEMP_RAM_EXIT_PPI_H_
+
+///
+/// Global ID for the FSP_TEMP_RAM_EXIT_PPI.
+///
+#define FSP_TEMP_RAM_EXIT_GUID \
+  { \
+    0xbc1cfbdb, 0x7e50, 0x42be, { 0xb4, 0x87, 0x22, 0xe0, 0xa9, 0x0c, 0xb0, 0x52 } \
+  }
+
+//
+// Forward declaration for the FSP_TEMP_RAM_EXIT_PPI.
+//
+typedef struct _FSP_TEMP_RAM_EXIT_PPI FSP_TEMP_RAM_EXIT_PPI;
+
+/**
+  Silicon function for disabling temporary memory.
+  @param[in] TempRamExitParamPtr - Pointer to the TempRamExit parameters structure.
+                                   This structure is normally defined in the Integration
+                                   Guide. If it is not defined in the Integration Guide,
+                                   pass NULL.
+  @retval EFI_SUCCESS            - Execution was completed successfully.
+  @retval Status                 - Error status reported by sub-functions if implemented.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *FSP_TEMP_RAM_EXIT) (
+  IN  VOID    *TempRamExitParamPtr
+  );
+
+///
+/// This PPI provides function to disable temporary memory.
+///
+struct _FSP_TEMP_RAM_EXIT_PPI {
+  FSP_TEMP_RAM_EXIT   TempRamExit;
+};
+
+extern EFI_GUID gFspTempRamExitPpiGuid;
+
+#endif // _FSP_TEMP_RAM_EXIT_PPI_H_
-- 
2.13.3.windows.1

Re: [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.

[Zeng, Star]

Hi Chasel,

Two minor feedbacks.

1. The spec defines the return status below, should we follow it?

EFI_SUCCESS FSP execution environment was initialized successfully.
EFI_INVALID_PARAMETER Input parameters are invalid.
EFI_UNSUPPORTED The FSP calling conditions were not met.
EFI_DEVICE_ERROR Temporary memory exit.


2. The gFspTempRamExitPpiGuid should be added into IntelFsp2Pkg.dec, right?


Thanks,
Star

> -----Original Message-----
> From: Chiu, Chasel
> Sent: Friday, June 14, 2019 5:56 PM
> To: devel@edk2.groups.io
> Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Zeng, Star
> <star.zeng@intel.com>
> Subject: [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1883
> 
> Add header file for FSP_TEMP_RAM_EXIT_PPI which is
> defined by FSP 2.1 spec.
> 
> Test: Build successfully.
> 
> 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/Ppi/TempRamExitPpi.h | 50
> ++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 50 insertions(+)
> 
> diff --git a/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> new file mode 100644
> index 0000000000..9e728a5d4d
> --- /dev/null
> +++ b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> @@ -0,0 +1,50 @@
> +/** @file
> +  This file defines the Silicon Temp Ram Exit PPI which implements the
> +  required programming steps for disabling temporary memory.
> +
> +Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> +SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#ifndef _FSP_TEMP_RAM_EXIT_PPI_H_
> +#define _FSP_TEMP_RAM_EXIT_PPI_H_
> +
> +///
> +/// Global ID for the FSP_TEMP_RAM_EXIT_PPI.
> +///
> +#define FSP_TEMP_RAM_EXIT_GUID \
> +  { \
> +    0xbc1cfbdb, 0x7e50, 0x42be, { 0xb4, 0x87, 0x22, 0xe0, 0xa9, 0x0c, 0xb0,
> 0x52 } \
> +  }
> +
> +//
> +// Forward declaration for the FSP_TEMP_RAM_EXIT_PPI.
> +//
> +typedef struct _FSP_TEMP_RAM_EXIT_PPI FSP_TEMP_RAM_EXIT_PPI;
> +
> +/**
> +  Silicon function for disabling temporary memory.
> +  @param[in] TempRamExitParamPtr - Pointer to the TempRamExit
> parameters structure.
> +                                   This structure is normally defined in the Integration
> +                                   Guide. If it is not defined in the Integration Guide,
> +                                   pass NULL.
> +  @retval EFI_SUCCESS            - Execution was completed successfully.
> +  @retval Status                 - Error status reported by sub-functions if
> implemented.
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI *FSP_TEMP_RAM_EXIT) (
> +  IN  VOID    *TempRamExitParamPtr
> +  );
> +
> +///
> +/// This PPI provides function to disable temporary memory.
> +///
> +struct _FSP_TEMP_RAM_EXIT_PPI {
> +  FSP_TEMP_RAM_EXIT   TempRamExit;
> +};
> +
> +extern EFI_GUID gFspTempRamExitPpiGuid;
> +
> +#endif // _FSP_TEMP_RAM_EXIT_PPI_H_
> --
> 2.13.3.windows.1

Re: [edk2-devel] [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.

[Zeng, Star]

And the 'Ppi' postfix seems not needed in the file name.

Thanks,
Star

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Zeng, Star
> Sent: Sunday, June 16, 2019 9:11 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: [edk2-devel] [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.
> 
> Hi Chasel,
> 
> Two minor feedbacks.
> 
> 1. The spec defines the return status below, should we follow it?
> 
> EFI_SUCCESS FSP execution environment was initialized successfully.
> EFI_INVALID_PARAMETER Input parameters are invalid.
> EFI_UNSUPPORTED The FSP calling conditions were not met.
> EFI_DEVICE_ERROR Temporary memory exit.
> 
> 
> 2. The gFspTempRamExitPpiGuid should be added into IntelFsp2Pkg.dec,
> right?
> 
> 
> Thanks,
> Star
> 
> > -----Original Message-----
> > From: Chiu, Chasel
> > Sent: Friday, June 14, 2019 5:56 PM
> > To: devel@edk2.groups.io
> > Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Zeng, Star
> > <star.zeng@intel.com>
> > Subject: [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.
> >
> > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1883
> >
> > Add header file for FSP_TEMP_RAM_EXIT_PPI which is defined by FSP 2.1
> > spec.
> >
> > Test: Build successfully.
> >
> > 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/Ppi/TempRamExitPpi.h | 50
> > ++++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 50 insertions(+)
> >
> > diff --git a/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> > b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> > new file mode 100644
> > index 0000000000..9e728a5d4d
> > --- /dev/null
> > +++ b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> > @@ -0,0 +1,50 @@
> > +/** @file
> > +  This file defines the Silicon Temp Ram Exit PPI which implements
> > +the
> > +  required programming steps for disabling temporary memory.
> > +
> > +Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> > +SPDX-License-Identifier: BSD-2-Clause-Patent
> > +
> > +**/
> > +
> > +#ifndef _FSP_TEMP_RAM_EXIT_PPI_H_
> > +#define _FSP_TEMP_RAM_EXIT_PPI_H_
> > +
> > +///
> > +/// Global ID for the FSP_TEMP_RAM_EXIT_PPI.
> > +///
> > +#define FSP_TEMP_RAM_EXIT_GUID \
> > +  { \
> > +    0xbc1cfbdb, 0x7e50, 0x42be, { 0xb4, 0x87, 0x22, 0xe0, 0xa9, 0x0c,
> > +0xb0,
> > 0x52 } \
> > +  }
> > +
> > +//
> > +// Forward declaration for the FSP_TEMP_RAM_EXIT_PPI.
> > +//
> > +typedef struct _FSP_TEMP_RAM_EXIT_PPI FSP_TEMP_RAM_EXIT_PPI;
> > +
> > +/**
> > +  Silicon function for disabling temporary memory.
> > +  @param[in] TempRamExitParamPtr - Pointer to the TempRamExit
> > parameters structure.
> > +                                   This structure is normally defined in the Integration
> > +                                   Guide. If it is not defined in the Integration Guide,
> > +                                   pass NULL.
> > +  @retval EFI_SUCCESS            - Execution was completed successfully.
> > +  @retval Status                 - Error status reported by sub-functions if
> > implemented.
> > +**/
> > +typedef
> > +EFI_STATUS
> > +(EFIAPI *FSP_TEMP_RAM_EXIT) (
> > +  IN  VOID    *TempRamExitParamPtr
> > +  );
> > +
> > +///
> > +/// This PPI provides function to disable temporary memory.
> > +///
> > +struct _FSP_TEMP_RAM_EXIT_PPI {
> > +  FSP_TEMP_RAM_EXIT   TempRamExit;
> > +};
> > +
> > +extern EFI_GUID gFspTempRamExitPpiGuid;
> > +
> > +#endif // _FSP_TEMP_RAM_EXIT_PPI_H_
> > --
> > 2.13.3.windows.1
> 
> 
> 

Re: [edk2-devel] [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.

[Chiu, Chasel]

Hi Star,

Since FspmArchConfigPpi.h also having Ppi postfix, we would like to align this for TemPRamExitPpi.h in IntelFsp2Pkg.

Thanks!
Chasel


> -----Original Message-----
> From: Zeng, Star
> Sent: Monday, June 17, 2019 9:51 AM
> To: devel@edk2.groups.io; Chiu, Chasel <chasel.chiu@intel.com>
> Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Zeng, Star
> <star.zeng@intel.com>
> Subject: RE: [edk2-devel] [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.
> 
> And the 'Ppi' postfix seems not needed in the file name.
> 
> Thanks,
> Star
> 
> > -----Original Message-----
> > From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> > Zeng, Star
> > Sent: Sunday, June 16, 2019 9:11 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: [edk2-devel] [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.
> >
> > Hi Chasel,
> >
> > Two minor feedbacks.
> >
> > 1. The spec defines the return status below, should we follow it?
> >
> > EFI_SUCCESS FSP execution environment was initialized successfully.
> > EFI_INVALID_PARAMETER Input parameters are invalid.
> > EFI_UNSUPPORTED The FSP calling conditions were not met.
> > EFI_DEVICE_ERROR Temporary memory exit.
> >
> >
> > 2. The gFspTempRamExitPpiGuid should be added into IntelFsp2Pkg.dec,
> > right?
> >
> >
> > Thanks,
> > Star
> >
> > > -----Original Message-----
> > > From: Chiu, Chasel
> > > Sent: Friday, June 14, 2019 5:56 PM
> > > To: devel@edk2.groups.io
> > > Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Zeng,
> > > Star <star.zeng@intel.com>
> > > Subject: [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.
> > >
> > > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1883
> > >
> > > Add header file for FSP_TEMP_RAM_EXIT_PPI which is defined by FSP
> > > 2.1 spec.
> > >
> > > Test: Build successfully.
> > >
> > > 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/Ppi/TempRamExitPpi.h | 50
> > > ++++++++++++++++++++++++++++++++++++++++++++++++++
> > >  1 file changed, 50 insertions(+)
> > >
> > > diff --git a/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> > > b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> > > new file mode 100644
> > > index 0000000000..9e728a5d4d
> > > --- /dev/null
> > > +++ b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
> > > @@ -0,0 +1,50 @@
> > > +/** @file
> > > +  This file defines the Silicon Temp Ram Exit PPI which implements
> > > +the
> > > +  required programming steps for disabling temporary memory.
> > > +
> > > +Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> > > +SPDX-License-Identifier: BSD-2-Clause-Patent
> > > +
> > > +**/
> > > +
> > > +#ifndef _FSP_TEMP_RAM_EXIT_PPI_H_
> > > +#define _FSP_TEMP_RAM_EXIT_PPI_H_
> > > +
> > > +///
> > > +/// Global ID for the FSP_TEMP_RAM_EXIT_PPI.
> > > +///
> > > +#define FSP_TEMP_RAM_EXIT_GUID \
> > > +  { \
> > > +    0xbc1cfbdb, 0x7e50, 0x42be, { 0xb4, 0x87, 0x22, 0xe0, 0xa9,
> > > +0x0c, 0xb0,
> > > 0x52 } \
> > > +  }
> > > +
> > > +//
> > > +// Forward declaration for the FSP_TEMP_RAM_EXIT_PPI.
> > > +//
> > > +typedef struct _FSP_TEMP_RAM_EXIT_PPI FSP_TEMP_RAM_EXIT_PPI;
> > > +
> > > +/**
> > > +  Silicon function for disabling temporary memory.
> > > +  @param[in] TempRamExitParamPtr - Pointer to the TempRamExit
> > > parameters structure.
> > > +                                   This structure is normally defined in the
> Integration
> > > +                                   Guide. If it is not defined in the Integration
> Guide,
> > > +                                   pass NULL.
> > > +  @retval EFI_SUCCESS            - Execution was completed successfully.
> > > +  @retval Status                 - Error status reported by sub-functions if
> > > implemented.
> > > +**/
> > > +typedef
> > > +EFI_STATUS
> > > +(EFIAPI *FSP_TEMP_RAM_EXIT) (
> > > +  IN  VOID    *TempRamExitParamPtr
> > > +  );
> > > +
> > > +///
> > > +/// This PPI provides function to disable temporary memory.
> > > +///
> > > +struct _FSP_TEMP_RAM_EXIT_PPI {
> > > +  FSP_TEMP_RAM_EXIT   TempRamExit;
> > > +};
> > > +
> > > +extern EFI_GUID gFspTempRamExitPpiGuid;
> > > +
> > > +#endif // _FSP_TEMP_RAM_EXIT_PPI_H_
> > > --
> > > 2.13.3.windows.1
> >
> >
> > 

Re: [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.

[Nate DeSimone]

Hi Chasel,

Please update the comments for the TempRamExit() function declaration to include all of the FSP specification allowed return values:

EFI_SUCCESS - FSP execution environment was initialized successfully.
EFI_INVALID_PARAMETER - Input parameters are invalid.
EFI_UNSUPPORTED - The FSP calling conditions were not met.
EFI_DEVICE_ERROR - Temporary memory exit failed.

With this change...

Reviewed-by: Nate DeSimone <nathaniel.l.desimone@intel.com>

-----Original Message-----
From: Chiu, Chasel 
Sent: Friday, June 14, 2019 2:56 AM
To: devel@edk2.groups.io
Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Zeng, Star <star.zeng@intel.com>
Subject: [PATCH] IntelFsp2Pkg: add TempRamExitPpi.h.

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

Add header file for FSP_TEMP_RAM_EXIT_PPI which is defined by FSP 2.1 spec.

Test: Build successfully.

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/Ppi/TempRamExitPpi.h | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
new file mode 100644
index 0000000000..9e728a5d4d
--- /dev/null
+++ b/IntelFsp2Pkg/Include/Ppi/TempRamExitPpi.h
@@ -0,0 +1,50 @@
+/** @file
+  This file defines the Silicon Temp Ram Exit PPI which implements the
+  required programming steps for disabling temporary memory.
+
+Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef _FSP_TEMP_RAM_EXIT_PPI_H_
+#define _FSP_TEMP_RAM_EXIT_PPI_H_
+
+///
+/// Global ID for the FSP_TEMP_RAM_EXIT_PPI.
+///
+#define FSP_TEMP_RAM_EXIT_GUID \
+  { \
+    0xbc1cfbdb, 0x7e50, 0x42be, { 0xb4, 0x87, 0x22, 0xe0, 0xa9, 0x0c, 
+0xb0, 0x52 } \
+  }
+
+//
+// Forward declaration for the FSP_TEMP_RAM_EXIT_PPI.
+//
+typedef struct _FSP_TEMP_RAM_EXIT_PPI FSP_TEMP_RAM_EXIT_PPI;
+
+/**
+  Silicon function for disabling temporary memory.
+  @param[in] TempRamExitParamPtr - Pointer to the TempRamExit parameters structure.
+                                   This structure is normally defined in the Integration
+                                   Guide. If it is not defined in the Integration Guide,
+                                   pass NULL.
+  @retval EFI_SUCCESS            - Execution was completed successfully.
+  @retval Status                 - Error status reported by sub-functions if implemented.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *FSP_TEMP_RAM_EXIT) (
+  IN  VOID    *TempRamExitParamPtr
+  );
+
+///
+/// This PPI provides function to disable temporary memory.
+///
+struct _FSP_TEMP_RAM_EXIT_PPI {
+  FSP_TEMP_RAM_EXIT   TempRamExit;
+};
+
+extern EFI_GUID gFspTempRamExitPpiGuid;
+
+#endif // _FSP_TEMP_RAM_EXIT_PPI_H_
--
2.13.3.windows.1