IntelFsp2Pkg/Include/Library/FspPlatformLib.h

   1 /** @file
   2
   3   Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
   4   SPDX-License-Identifier: BSD-2-Clause-Patent
   5
   6 **/
   7
   8 #ifndef _FSP_PLATFORM_LIB_H_
   9 #define _FSP_PLATFORM_LIB_H_
  10
  11 /**
  12   Get system memory resource descriptor by owner.
  13
  14   @param[in] OwnerGuid   resource owner guid
  15 **/
  16 EFI_HOB_RESOURCE_DESCRIPTOR *
  17 EFIAPI
  18 FspGetResourceDescriptorByOwner (
  19   IN EFI_GUID  *OwnerGuid
  20   );
  21
  22 /**
  23   Get system memory from HOB.
  24
  25   @param[in,out] LowMemoryLength   less than 4G memory length
  26   @param[in,out] HighMemoryLength  greater than 4G memory length
  27 **/
  28 VOID
  29 EFIAPI
  30 FspGetSystemMemorySize (
  31   IN OUT UINT64  *LowMemoryLength,
  32   IN OUT UINT64  *HighMemoryLength
  33   );
  34
  35 /**
  36   Set a new stack frame for the continuation function.
  37
  38 **/
  39 VOID
  40 EFIAPI
  41 FspSetNewStackFrame (
  42   VOID
  43   );
  44
  45 /**
  46   This function transfer control back to BootLoader after FspSiliconInit.
  47
  48 **/
  49 VOID
  50 EFIAPI
  51 FspSiliconInitDone (
  52   VOID
  53   );
  54
  55 /**
  56   This function returns control to BootLoader after MemoryInitApi.
  57
  58   @param[in,out] HobListPtr The address of HobList pointer.
  59 **/
  60 VOID
  61 EFIAPI
  62 FspMemoryInitDone (
  63   IN OUT VOID  **HobListPtr
  64   );
  65
  66 /**
  67   This function returns control to BootLoader after TempRamExitApi.
  68
  69 **/
  70 VOID
  71 EFIAPI
  72 FspTempRamExitDone (
  73   VOID
  74   );
  75
  76 /**
  77   This function handle NotifyPhase API call from the BootLoader.
  78   It gives control back to the BootLoader after it is handled. If the
  79   Notification code is a ReadyToBoot event, this function will return
  80   and FSP continues the remaining execution until it reaches the DxeIpl.
  81
  82 **/
  83 VOID
  84 EFIAPI
  85 FspWaitForNotify (
  86   VOID
  87   );
  88
  89 /**
  90   This function transfer control back to BootLoader after FspSiliconInit.
  91
  92   @param[in] Status return status for the FspSiliconInit.
  93 **/
  94 VOID
  95 EFIAPI
  96 FspSiliconInitDone2 (
  97   IN EFI_STATUS  Status
  98   );
  99
 100 /**
 101   This function returns control to BootLoader after MemoryInitApi.
 102
 103   @param[in] Status return status for the MemoryInitApi.
 104   @param[in,out] HobListPtr The address of HobList pointer.
 105 **/
 106 VOID
 107 EFIAPI
 108 FspMemoryInitDone2 (
 109   IN EFI_STATUS  Status,
 110   IN OUT VOID    **HobListPtr
 111   );
 112
 113 /**
 114   This function returns control to BootLoader after TempRamExitApi.
 115
 116   @param[in] Status return status for the TempRamExitApi.
 117 **/
 118 VOID
 119 EFIAPI
 120 FspTempRamExitDone2 (
 121   IN EFI_STATUS  Status
 122   );
 123
 124 #endif