IntelFsp2WrapperPkg/Include/Library/FspWrapperApiLib.h

   1 /** @file
   2   Provide FSP wrapper API related function.
   3
   4   Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __FSP_WRAPPER_API_LIB_H__
  10 #define __FSP_WRAPPER_API_LIB_H__
  11
  12 #include <FspEas.h>
  13
  14 /**
  15   Find FSP header pointer.
  16
  17   @param[in] FlashFvFspBase Flash address of FSP FV.
  18
  19   @return FSP header pointer.
  20 **/
  21 FSP_INFO_HEADER *
  22 EFIAPI
  23 FspFindFspHeader (
  24   IN EFI_PHYSICAL_ADDRESS  FlashFvFspBase
  25   );
  26
  27 /**
  28   Call FSP API - FspNotifyPhase.
  29
  30   @param[in] NotifyPhaseParams Address pointer to the NOTIFY_PHASE_PARAMS structure.
  31
  32   @return EFI status returned by FspNotifyPhase API.
  33 **/
  34 EFI_STATUS
  35 EFIAPI
  36 CallFspNotifyPhase (
  37   IN NOTIFY_PHASE_PARAMS *NotifyPhaseParams
  38   );
  39
  40 /**
  41   Call FSP API - FspMemoryInit.
  42
  43   @param[in]  FspmUpdDataPtr          Pointer to the FSPM_UPD data sructure.
  44   @param[out] HobListPtr              Pointer to receive the address of the HOB list.
  45
  46   @return EFI status returned by FspMemoryInit API.
  47 **/
  48 EFI_STATUS
  49 EFIAPI
  50 CallFspMemoryInit (
  51   IN VOID                       *FspmUpdDataPtr,
  52   OUT VOID                      **HobListPtr
  53   );
  54
  55 /**
  56   Call FSP API - TempRamExit.
  57
  58   @param[in] TempRamExitParam    Address pointer to the TempRamExit parameters structure.
  59
  60   @return EFI status returned by TempRamExit API.
  61 **/
  62 EFI_STATUS
  63 EFIAPI
  64 CallTempRamExit (
  65   IN VOID                       *TempRamExitParam
  66   );
  67
  68 /**
  69   Call FSP API - FspSiliconInit.
  70
  71   @param[in] FspsUpdDataPtr     Pointer to the FSPS_UPD data structure.
  72
  73   @return EFI status returned by FspSiliconInit API.
  74 **/
  75 EFI_STATUS
  76 EFIAPI
  77 CallFspSiliconInit (
  78   IN VOID                       *FspsUpdDataPtr
  79   );
  80
  81 #endif