Add IntelFsp2Pkg and IntelFsp2WrapperPkg.

[mirror_edk2.git] / IntelFsp2Pkg / Include / Library / FspPlatformLib.h

diff --git a/IntelFsp2Pkg/Include/Library/FspPlatformLib.h b/IntelFsp2Pkg/Include/Library/FspPlatformLib.h
new file mode 100644 (file)
index 0000000..9247bd5
--- /dev/null
+++ b/IntelFsp2Pkg/Include/Library/FspPlatformLib.h
@@ -0,0 +1,105 @@
+/** @file\r
+\r
+  Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php.\r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef _FSP_PLATFORM_LIB_H_\r
+#define _FSP_PLATFORM_LIB_H_\r
+\r
+/**\r
+  Get system memory resource descriptor by owner.\r
+\r
+  @param[in] OwnerGuid   resource owner guid\r
+**/\r
+EFI_HOB_RESOURCE_DESCRIPTOR *\r
+EFIAPI\r
+FspGetResourceDescriptorByOwner (\r
+  IN EFI_GUID   *OwnerGuid\r
+  );\r
+\r
+/**\r
+  Get system memory from HOB.\r
+\r
+  @param[in,out] LowMemoryLength   less than 4G memory length\r
+  @param[in,out] HighMemoryLength  greater than 4G memory length\r
+**/\r
+VOID\r
+EFIAPI\r
+FspGetSystemMemorySize (\r
+  IN OUT UINT64              *LowMemoryLength,\r
+  IN OUT UINT64              *HighMemoryLength\r
+  );\r
+\r
+/**\r
+  Migrate BootLoader data before destroying CAR.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+FspMigrateTemporaryMemory (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Set a new stack frame for the continuation function.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+FspSetNewStackFrame (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  This function transfer control back to BootLoader after FspSiliconInit.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+FspSiliconInitDone (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  This function returns control to BootLoader after MemoryInitApi.\r
+\r
+  @param[in,out] HobListPtr The address of HobList pointer.\r
+**/\r
+VOID\r
+EFIAPI\r
+FspMemoryInitDone (\r
+  IN OUT VOID   **HobListPtr\r
+  );\r
+\r
+/**\r
+  This function returns control to BootLoader after TempRamExitApi.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+FspTempRamExitDone (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  This function handle NotifyPhase API call from the BootLoader.\r
+  It gives control back to the BootLoader after it is handled. If the\r
+  Notification code is a ReadyToBoot event, this function will return\r
+  and FSP continues the remaining execution until it reaches the DxeIpl.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+FspWaitForNotify (\r
+  VOID\r
+  );\r
+\r
+#endif\r