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   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __FSP_WRAPPER_API_LIB_H__
  16 #define __FSP_WRAPPER_API_LIB_H__
  17
  18 #include <FspEas.h>
  19
  20 /**
  21   Find FSP header pointer.
  22
  23   @param[in] FlashFvFspBase Flash address of FSP FV.
  24
  25   @return FSP header pointer.
  26 **/
  27 FSP_INFO_HEADER *
  28 EFIAPI
  29 FspFindFspHeader (
  30   IN EFI_PHYSICAL_ADDRESS  FlashFvFspBase
  31   );
  32
  33 /**
  34   Call FSP API - FspNotifyPhase.
  35
  36   @param[in] NotifyPhaseParams Address pointer to the NOTIFY_PHASE_PARAMS structure.
  37
  38   @return EFI status returned by FspNotifyPhase API.
  39 **/
  40 EFI_STATUS
  41 EFIAPI
  42 CallFspNotifyPhase (
  43   IN NOTIFY_PHASE_PARAMS *NotifyPhaseParams
  44   );
  45
  46 /**
  47   Call FSP API - FspMemoryInit.
  48
  49   @param[in]  FspmUpdDataPtr          Pointer to the FSPM_UPD data sructure.
  50   @param[out] HobListPtr              Pointer to receive the address of the HOB list.
  51
  52   @return EFI status returned by FspMemoryInit API.
  53 **/
  54 EFI_STATUS
  55 EFIAPI
  56 CallFspMemoryInit (
  57   IN VOID                       *FspmUpdDataPtr,
  58   OUT VOID                      **HobListPtr
  59   );
  60
  61 /**
  62   Call FSP API - TempRamExit.
  63
  64   @param[in] TempRamExitParam    Address pointer to the TempRamExit parameters structure.
  65
  66   @return EFI status returned by TempRamExit API.
  67 **/
  68 EFI_STATUS
  69 EFIAPI
  70 CallTempRamExit (
  71   IN VOID                       *TempRamExitParam
  72   );
  73
  74 /**
  75   Call FSP API - FspSiliconInit.
  76
  77   @param[in] FspsUpdDataPtr     Pointer to the FSPS_UPD data structure.
  78
  79   @return EFI status returned by FspSiliconInit API.
  80 **/
  81 EFI_STATUS
  82 EFIAPI
  83 CallFspSiliconInit (
  84   IN VOID                       *FspsUpdDataPtr
  85   );
  86
  87 #endif