IntelFspWrapperPkg/Include/Library/FspApiLib.h

   1 /** @file
   2   Provide FSP API related function.
   3
   4   Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __FSP_API_LIB_H__
  10 #define __FSP_API_LIB_H__
  11
  12 #include <FspApi.h>
  13 #include <FspInfoHeader.h>
  14
  15 /**
  16   Find FSP header pointer.
  17
  18   @param[in] FlashFvFspBase Flash address of FSP FV.
  19
  20   @return FSP header pointer.
  21 **/
  22 FSP_INFO_HEADER *
  23 EFIAPI
  24 FspFindFspHeader (
  25   IN EFI_PHYSICAL_ADDRESS  FlashFvFspBase
  26   );
  27
  28 /**
  29   Call FSP API - FspInit.
  30
  31   @param[in] FspHeader     FSP header pointer.
  32   @param[in] FspInitParams Address pointer to the FSP_INIT_PARAMS structure.
  33
  34   @return EFI status returned by FspInit API.
  35 **/
  36 EFI_STATUS
  37 EFIAPI
  38 CallFspInit (
  39   IN FSP_INFO_HEADER     *FspHeader,
  40   IN FSP_INIT_PARAMS     *FspInitParams
  41   );
  42
  43 /**
  44   Call FSP API - FspNotifyPhase.
  45
  46   @param[in] FspHeader         FSP header pointer.
  47   @param[in] NotifyPhaseParams Address pointer to the NOTIFY_PHASE_PARAMS structure.
  48
  49   @return EFI status returned by FspNotifyPhase API.
  50 **/
  51 EFI_STATUS
  52 EFIAPI
  53 CallFspNotifyPhase (
  54   IN FSP_INFO_HEADER     *FspHeader,
  55   IN NOTIFY_PHASE_PARAMS *NotifyPhaseParams
  56   );
  57
  58 /**
  59   Call FSP API - FspMemoryInit.
  60
  61   @param[in]     FspHeader           FSP header pointer.
  62   @param[in,out] FspMemoryInitParams Address pointer to the FSP_MEMORY_INIT_PARAMS structure.
  63
  64   @return EFI status returned by FspMemoryInit API.
  65 **/
  66 EFI_STATUS
  67 EFIAPI
  68 CallFspMemoryInit (
  69   IN FSP_INFO_HEADER            *FspHeader,
  70   IN OUT FSP_MEMORY_INIT_PARAMS *FspMemoryInitParams
  71   );
  72
  73 /**
  74   Call FSP API - TempRamExit.
  75
  76   @param[in]     FspHeader           FSP header pointer.
  77   @param[in,out] TempRamExitParam    Address pointer to the TempRamExit parameters structure.
  78
  79   @return EFI status returned by TempRamExit API.
  80 **/
  81 EFI_STATUS
  82 EFIAPI
  83 CallTempRamExit (
  84   IN FSP_INFO_HEADER            *FspHeader,
  85   IN OUT VOID                   *TempRamExitParam
  86   );
  87
  88 /**
  89   Call FSP API - FspSiliconInit.
  90
  91   @param[in]     FspHeader           FSP header pointer.
  92   @param[in,out] FspSiliconInitParam Address pointer to the Silicon Init parameters structure.
  93
  94   @return EFI status returned by FspSiliconInit API.
  95 **/
  96 EFI_STATUS
  97 EFIAPI
  98 CallFspSiliconInit (
  99   IN FSP_INFO_HEADER            *FspHeader,
 100   IN OUT VOID                   *FspSiliconInitParam
 101   );
 102
 103 #endif