FspApi.h

Go to the documentation of this file.

 
#ifndef _FSP_API_H_
#define _FSP_API_H_
 
#include <Pi/PiStatusCode.h>
#include <Base.h>
 
 
#define ENCODE_RESET_REQUEST(ResetType)  \
        ((EFI_STATUS)((MAX_BIT >> 1) | (ResetType)))
#define FSP_STATUS_RESET_REQUIRED_COLD  ENCODE_RESET_REQUEST(1)
#define FSP_STATUS_RESET_REQUIRED_WARM  ENCODE_RESET_REQUEST(2)
#define FSP_STATUS_RESET_REQUIRED_3     ENCODE_RESET_REQUEST(3)
#define FSP_STATUS_RESET_REQUIRED_4     ENCODE_RESET_REQUEST(4)
#define FSP_STATUS_RESET_REQUIRED_5     ENCODE_RESET_REQUEST(5)
#define FSP_STATUS_RESET_REQUIRED_6     ENCODE_RESET_REQUEST(6)
#define FSP_STATUS_RESET_REQUIRED_7     ENCODE_RESET_REQUEST(7)
#define FSP_STATUS_RESET_REQUIRED_8     ENCODE_RESET_REQUEST(8)
#define FSP_STATUS_VARIABLE_REQUEST     ENCODE_RESET_REQUEST(10)
 
#define FSP_EVENT_CODE  0xF5000000
#define FSP_POST_CODE   (FSP_EVENT_CODE | 0x00F80000)
 
/*
  FSP may optionally include the capability of generating events messages to aid in the debugging of firmware issues.
  These events fall under three catagories: Error, Progress, and Debug. The event reporting mechanism follows the
  status code services described in section 6 and 7 of the PI Specification v1.7 Volume 3.
 
  @param[in] Type                   Indicates the type of event being reported.
                                    See MdePkg/Include/Pi/PiStatusCode.h for the definition of EFI_STATUS_CODE_TYPE.
  @param[in] Value                  Describes the current status of a hardware or software entity.
                                    This includes information about the class and subclass that is used to classify the entity as well as an operation.
                                    For progress events, the operation is the current activity. For error events, it is the exception.
                                    For debug events, it is not defined at this time.
                                    See MdePkg/Include/Pi/PiStatusCode.h for the definition of EFI_STATUS_CODE_VALUE.
  @param[in] Instance               The enumeration of a hardware or software entity within the system.
                                    A system may contain multiple entities that match a class/subclass pairing. The instance differentiates between them.
                                    An instance of 0 indicates that instance information is unavailable, not meaningful, or not relevant.
                                    Valid instance numbers start with 1.
  @param[in] *CallerId              This parameter can be used to identify the sub-module within the FSP generating the event.
                                    This parameter may be NULL.
  @param[in] *Data                  This optional parameter may be used to pass additional data. The contents can have event-specific data.
                                    For example, the FSP provides a EFI_STATUS_CODE_STRING_DATA instance to this parameter when sending debug messages.
                                    This parameter is NULL when no additional data is provided.
 
  @retval EFI_SUCCESS               The event was handled successfully.
  @retval EFI_INVALID_PARAMETER     Input parameters are invalid.
  @retval EFI_DEVICE_ERROR          The event handler failed.
*/
typedef
EFI_STATUS
(EFIAPI *FSP_EVENT_HANDLER)(
  IN          EFI_STATUS_CODE_TYPE   Type,
  IN          EFI_STATUS_CODE_VALUE  Value,
  IN          UINT32                 Instance,
  IN OPTIONAL EFI_GUID               *CallerId,
  IN OPTIONAL EFI_STATUS_CODE_DATA   *Data
  );
 
/*
  Handler for FSP-T debug log messages, provided by the bootloader.
 
  @param[in] DebugMessage           A pointer to the debug message to be written to the log.
  @param[in] MessageLength          Number of bytes to written to the debug log.
 
  @retval UINT32                    The return value indicates the number of bytes actually written to
                                    the debug log. If the return value is less than MessageLength,
                                    an error occurred.
*/
typedef
UINT32
(EFIAPI *FSP_DEBUG_HANDLER)(
  IN CHAR8 *DebugMessage,
  IN UINT32                 MessageLength
  );
 
#pragma pack(1)
typedef struct {
  UINT64    Signature;
  UINT8     Revision;
  UINT8     Reserved[23];
} FSP_UPD_HEADER;
 
typedef struct {
  UINT8                Revision;
  UINT8                Reserved[3];
  UINT32               Length;
  FSP_DEBUG_HANDLER    FspDebugHandler;
  UINT8                Reserved1[20];
} FSPT_ARCH_UPD;
 
typedef struct {
  UINT8                   Revision;
  UINT8                   Reserved[3];
  UINT32                  Length;
  EFI_PHYSICAL_ADDRESS    FspDebugHandler;
  UINT32                  FspTemporaryRamSize;
  UINT8                   Reserved1[12];
} FSPT_ARCH2_UPD;
 
typedef struct {
  UINT8                Revision;
  UINT8                Reserved[3];
  VOID                 *NvsBufferPtr;
  VOID                 *StackBase;
  UINT32               StackSize;
  UINT32               BootLoaderTolumSize;
  UINT32               BootMode;
  FSP_EVENT_HANDLER    *FspEventHandler;
  UINT8                Reserved1[4];
} FSPM_ARCH_UPD;
 
typedef struct {
  UINT8                   Revision;
  UINT8                   Reserved[3];
  UINT32                  Length;
  EFI_PHYSICAL_ADDRESS    NvsBufferPtr;
  EFI_PHYSICAL_ADDRESS    StackBase;
  UINT64                  StackSize;
  UINT32                  BootLoaderTolumSize;
  UINT32                  BootMode;
  EFI_PHYSICAL_ADDRESS    FspEventHandler;
  UINT8                   Reserved1[16];
} FSPM_ARCH2_UPD;
 
typedef struct {
  UINT8                Revision;
  UINT8                Reserved[3];
  UINT32               Length;
  FSP_EVENT_HANDLER    FspEventHandler;
  UINT8                EnableMultiPhaseSiliconInit;
  UINT8                Reserved1[19];
} FSPS_ARCH_UPD;
 
typedef struct {
  UINT8                   Revision;
  UINT8                   Reserved[3];
  UINT32                  Length;
  EFI_PHYSICAL_ADDRESS    FspEventHandler;
  UINT8                   Reserved1[16];
} FSPS_ARCH2_UPD;
 
typedef struct {
  UINT8                   Revision;
  UINT8                   Reserved[3];
  UINT32                  Length;
  EFI_PHYSICAL_ADDRESS    BootloaderSmmFvBaseAddress;
  UINT64                  BootloaderSmmFvLength;
  EFI_PHYSICAL_ADDRESS    BootloaderSmmFvContextData;
  UINT16                  BootloaderSmmFvContextDataLength;
  UINT8                   Reserved1[30];
} FSPI_ARCH_UPD;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
} FSPT_UPD_COMMON;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
 
  FSPT_ARCH_UPD     FsptArchUpd;
} FSPT_UPD_COMMON_FSP22;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
 
  FSPT_ARCH2_UPD    FsptArchUpd;
} FSPT_UPD_COMMON_FSP24;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
  FSPM_ARCH_UPD     FspmArchUpd;
} FSPM_UPD_COMMON;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
  FSPM_ARCH2_UPD    FspmArchUpd;
} FSPM_UPD_COMMON_FSP24;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
} FSPS_UPD_COMMON;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
 
  FSPS_ARCH_UPD     FspsArchUpd;
} FSPS_UPD_COMMON_FSP22;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
 
  FSPS_ARCH2_UPD    FspsArchUpd;
} FSPS_UPD_COMMON_FSP24;
 
typedef struct {
  FSP_UPD_HEADER    FspUpdHeader;
 
  FSPI_ARCH_UPD     FspiArchUpd;
} FSPI_UPD_COMMON;
 
typedef enum {
  EnumInitPhaseAfterPciEnumeration = 0x20,
  EnumInitPhaseReadyToBoot = 0x40,
  EnumInitPhaseEndOfFirmware = 0xF0
} FSP_INIT_PHASE;
 
typedef struct {
  FSP_INIT_PHASE    Phase;
} NOTIFY_PHASE_PARAMS;
 
typedef enum {
  EnumMultiPhaseGetNumberOfPhases       = 0x0,
  EnumMultiPhaseExecutePhase            = 0x1,
  EnumMultiPhaseGetVariableRequestInfo  = 0x2,
  EnumMultiPhaseCompleteVariableRequest = 0x3
} FSP_MULTI_PHASE_ACTION;
 
typedef enum {
  EnumFspVariableRequestGetVariable         = 0x0,
  EnumFspVariableRequestGetNextVariableName = 0x1,
  EnumFspVariableRequestSetVariable         = 0x2,
  EnumFspVariableRequestQueryVariableInfo   = 0x3
} FSP_VARIABLE_REQUEST_TYPE;
 
#pragma pack(16)
typedef struct {
  IN     FSP_VARIABLE_REQUEST_TYPE    VariableRequest;
  IN OUT CHAR16                       *VariableName;
  IN OUT UINT64                       *VariableNameSize;
  IN OUT EFI_GUID                     *VariableGuid;
  IN OUT UINT32                       *Attributes;
  IN OUT UINT64                       *DataSize;
  IN OUT VOID                         *Data;
  OUT    UINT64                       *MaximumVariableStorageSize;
  OUT    UINT64                       *RemainingVariableStorageSize;
  OUT    UINT64                       *MaximumVariableSize;
} FSP_MULTI_PHASE_VARIABLE_REQUEST_INFO_PARAMS;
 
typedef struct {
  EFI_STATUS    VariableRequestStatus;
} FSP_MULTI_PHASE_COMPLETE_VARIABLE_REQUEST_PARAMS;
#pragma pack()
 
typedef struct {
  UINT32    NumberOfPhases;
  UINT32    PhasesExecuted;
} FSP_MULTI_PHASE_GET_NUMBER_OF_PHASES_PARAMS;
 
typedef struct {
  IN     FSP_MULTI_PHASE_ACTION    MultiPhaseAction;
  IN     UINT32                    PhaseIndex;
  IN OUT VOID                      *MultiPhaseParamPtr;
} FSP_MULTI_PHASE_PARAMS;
 
#pragma pack()
 
typedef
EFI_STATUS
(EFIAPI *FSP_TEMP_RAM_INIT)(
  IN  VOID    *FsptUpdDataPtr
  );
 
typedef
EFI_STATUS
(EFIAPI *FSP_NOTIFY_PHASE)(
  IN NOTIFY_PHASE_PARAMS *NotifyPhaseParamPtr
  );
 
typedef
EFI_STATUS
(EFIAPI *FSP_MEMORY_INIT)(
  IN  VOID    *FspmUpdDataPtr,
  OUT VOID    **HobListPtr
  );
 
typedef
EFI_STATUS
(EFIAPI *FSP_TEMP_RAM_EXIT)(
  IN  VOID    *TempRamExitParamPtr
  );
 
typedef
EFI_STATUS
(EFIAPI *FSP_SILICON_INIT)(
  IN  VOID    *FspsUpdDataPtr
  );
 
typedef
EFI_STATUS
(EFIAPI *FSP_MULTI_PHASE_SI_INIT)(
  IN FSP_MULTI_PHASE_PARAMS     *MultiPhaseSiInitParamPtr
  );
 
typedef
EFI_STATUS
(EFIAPI *FSP_SMM_INIT)(
  IN VOID          *FspiUpdDataPtr
  );
 
typedef
EFI_STATUS
(EFIAPI *FSP_MULTI_PHASE_INIT)(
  IN FSP_MULTI_PHASE_PARAMS     *MultiPhaseInitParamPtr
  );
 
#endif