IntelFsp2Pkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFsp2Pkg / Library / BaseFspCommonLib / FspCommonLib.c

/** @file\r
\r
  Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PcdLib.h>\r
#include <FspGlobalData.h>\r
#include <FspEas.h>\r
#include <Library/FspSwitchStackLib.h>\r
\r
#pragma pack(1)\r
\r
//\r
//   API Parameter                +0x34\r
//   API return address           +0x30\r
//\r
//   push    FspInfoHeader        +0x2C\r
//   pushfd                       +0x28\r
//   cli\r
//   pushad                       +0x24\r
//   sub     esp, 8               +0x00\r
//   sidt    fword ptr [esp]\r
//\r
typedef struct {\r
  UINT16    IdtrLimit;\r
  UINT32    IdtrBase;\r
  UINT16    Reserved;\r
  UINT32    Edi;\r
  UINT32    Esi;\r
  UINT32    Ebp;\r
  UINT32    Esp;\r
  UINT32    Ebx;\r
  UINT32    Edx;\r
  UINT32    Ecx;\r
  UINT32    Eax;\r
  UINT16    Flags[2];\r
  UINT32    FspInfoHeader;\r
  UINT32    ApiRet;\r
  UINT32    ApiParam[2];\r
} CONTEXT_STACK;\r
\r
#define CONTEXT_STACK_OFFSET(x)  (UINT32)&((CONTEXT_STACK *)(UINTN)0)->x\r
\r
#pragma pack()\r
\r
/**\r
  This function sets the FSP global data pointer.\r
\r
  @param[in] FspData       FSP global data pointer.\r
\r
**/\r
VOID\r
EFIAPI\r
SetFspGlobalDataPointer (\r
  IN FSP_GLOBAL_DATA   *FspData\r
  )\r
{\r
  ASSERT (FspData != NULL);\r
  *((volatile UINT32 *)(UINTN)PcdGet32(PcdGlobalDataPointerAddress)) = (UINT32)(UINTN)FspData;\r
}\r
\r
/**\r
  This function gets the FSP global data pointer.\r
\r
**/\r
FSP_GLOBAL_DATA *\r
EFIAPI\r
GetFspGlobalDataPointer (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA   *FspData;\r
\r
  FspData = *(FSP_GLOBAL_DATA  **)(UINTN)PcdGet32(PcdGlobalDataPointerAddress);\r
  return FspData;\r
}\r
\r
/**\r
  This function gets back the FSP API first parameter passed by the bootloader.\r
\r
  @retval ApiParameter FSP API first parameter passed by the bootloader.\r
**/\r
UINT32\r
EFIAPI\r
GetFspApiParameter (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return *(UINT32 *)(UINTN)(FspData->CoreStack + CONTEXT_STACK_OFFSET(ApiParam[0]));\r
}\r
\r
/**\r
  This function returns the FSP entry stack pointer from address of the first API parameter.\r
\r
  @retval FSP entry stack pointer.\r
**/\r
VOID*\r
EFIAPI\r
GetFspEntryStack (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return (VOID*)(FspData->CoreStack + CONTEXT_STACK_OFFSET(ApiParam[0]));\r
}\r
\r
/**\r
  This function gets back the FSP API second parameter passed by the bootloader.\r
\r
  @retval ApiParameter FSP API second parameter passed by the bootloader.\r
**/\r
UINT32\r
EFIAPI\r
GetFspApiParameter2 (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return *(UINT32 *)(UINTN)(FspData->CoreStack + CONTEXT_STACK_OFFSET(ApiParam[1]));\r
}\r
\r
/**\r
  This function sets the FSP API parameter in the stack.\r
\r
   @param[in] Value       New parameter value.\r
\r
**/\r
VOID\r
EFIAPI\r
SetFspApiParameter (\r
  IN UINT32      Value\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  *(UINT32 *)(UINTN)(FspData->CoreStack + CONTEXT_STACK_OFFSET(ApiParam)) = Value;\r
}\r
\r
/**\r
  This function set the API status code returned to the BootLoader.\r
\r
  @param[in] ReturnStatus       Status code to return.\r
\r
**/\r
VOID\r
EFIAPI\r
SetFspApiReturnStatus (\r
  IN UINT32  ReturnStatus\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  *(UINT32 *)(UINTN)(FspData->CoreStack + CONTEXT_STACK_OFFSET(Eax)) = ReturnStatus;\r
}\r
\r
/**\r
  This function sets the context switching stack to a new stack frame.\r
\r
  @param[in] NewStackTop       New core stack to be set.\r
\r
**/\r
VOID\r
EFIAPI\r
SetFspCoreStackPointer (\r
  IN VOID   *NewStackTop\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
  UINT32           *OldStack;\r
  UINT32           *NewStack;\r
  UINT32           StackContextLen;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  StackContextLen = sizeof(CONTEXT_STACK) / sizeof(UINT32);\r
\r
  //\r
  // Reserve space for the ContinuationFunc two parameters\r
  //\r
  OldStack = (UINT32 *)FspData->CoreStack;\r
  NewStack = (UINT32 *)NewStackTop - StackContextLen - 2;\r
  FspData->CoreStack = (UINT32)NewStack;\r
  while (StackContextLen-- != 0) {\r
    *NewStack++ = *OldStack++;\r
  }\r
}\r
\r
/**\r
  This function sets the platform specific data pointer.\r
\r
  @param[in] PlatformData       FSP platform specific data pointer.\r
\r
**/\r
VOID\r
EFIAPI\r
SetFspPlatformDataPointer (\r
  IN VOID   *PlatformData\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  FspData->PlatformData.DataPtr = PlatformData;\r
}\r
\r
\r
/**\r
  This function gets the platform specific data pointer.\r
\r
   @param[in] PlatformData       FSP platform specific data pointer.\r
\r
**/\r
VOID *\r
EFIAPI\r
GetFspPlatformDataPointer (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return FspData->PlatformData.DataPtr;\r
}\r
\r
\r
/**\r
  This function sets the UPD data pointer.\r
\r
  @param[in] UpdDataPtr   UPD data pointer.\r
**/\r
VOID\r
EFIAPI\r
SetFspUpdDataPointer (\r
  IN VOID    *UpdDataPtr\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  //\r
  // Get the FSP Global Data Pointer\r
  //\r
  FspData  = GetFspGlobalDataPointer ();\r
\r
  //\r
  // Set the UPD pointer.\r
  //\r
  FspData->UpdDataPtr = UpdDataPtr;\r
}\r
\r
/**\r
  This function gets the UPD data pointer.\r
\r
  @return UpdDataPtr   UPD data pointer.\r
**/\r
VOID *\r
EFIAPI\r
GetFspUpdDataPointer (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return FspData->UpdDataPtr;\r
}\r
\r
\r
/**\r
  This function sets the FspMemoryInit UPD data pointer.\r
\r
  @param[in] MemoryInitUpdPtr   FspMemoryInit UPD data pointer.\r
**/\r
VOID\r
EFIAPI\r
SetFspMemoryInitUpdDataPointer (\r
  IN VOID    *MemoryInitUpdPtr\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  //\r
  // Get the FSP Global Data Pointer\r
  //\r
  FspData  = GetFspGlobalDataPointer ();\r
\r
  //\r
  // Set the FspMemoryInit UPD pointer.\r
  //\r
  FspData->MemoryInitUpdPtr = MemoryInitUpdPtr;\r
}\r
\r
/**\r
  This function gets the FspMemoryInit UPD data pointer.\r
\r
  @return FspMemoryInit UPD data pointer.\r
**/\r
VOID *\r
EFIAPI\r
GetFspMemoryInitUpdDataPointer (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return FspData->MemoryInitUpdPtr;\r
}\r
\r
\r
/**\r
  This function sets the FspSiliconInit UPD data pointer.\r
\r
  @param[in] SiliconInitUpdPtr   FspSiliconInit UPD data pointer.\r
**/\r
VOID\r
EFIAPI\r
SetFspSiliconInitUpdDataPointer (\r
  IN VOID    *SiliconInitUpdPtr\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  //\r
  // Get the FSP Global Data Pointer\r
  //\r
  FspData  = GetFspGlobalDataPointer ();\r
\r
  //\r
  // Set the FspSiliconInit UPD data pointer.\r
  //\r
  FspData->SiliconInitUpdPtr = SiliconInitUpdPtr;\r
}\r
\r
/**\r
  This function gets the FspSiliconInit UPD data pointer.\r
\r
  @return FspSiliconInit UPD data pointer.\r
**/\r
VOID *\r
EFIAPI\r
GetFspSiliconInitUpdDataPointer (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return FspData->SiliconInitUpdPtr;\r
}\r
\r
\r
/**\r
  Set FSP measurement point timestamp.\r
\r
  @param[in] Id       Measurement point ID.\r
\r
  @return performance timestamp.\r
**/\r
UINT64\r
EFIAPI\r
SetFspMeasurePoint (\r
  IN UINT8  Id\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  //\r
  // Bit [55: 0]  will be the timestamp\r
  // Bit [63:56]  will be the ID\r
  //\r
  FspData  = GetFspGlobalDataPointer ();\r
  if (FspData->PerfIdx < sizeof(FspData->PerfData) / sizeof(FspData->PerfData[0])) {\r
    FspData->PerfData[FspData->PerfIdx] = AsmReadTsc ();\r
    ((UINT8 *)(&FspData->PerfData[FspData->PerfIdx]))[7] = Id;\r
  }\r
\r
  return FspData->PerfData[(FspData->PerfIdx)++];\r
}\r
\r
/**\r
  This function gets the FSP info header pointer.\r
\r
  @retval FspInfoHeader   FSP info header pointer\r
**/\r
FSP_INFO_HEADER *\r
EFIAPI\r
GetFspInfoHeader (\r
  VOID\r
  )\r
{\r
  return  GetFspGlobalDataPointer()->FspInfoHeader;\r
}\r
\r
/**\r
  This function sets the FSP info header pointer.\r
\r
  @param[in] FspInfoHeader   FSP info header pointer\r
**/\r
VOID\r
EFIAPI\r
SetFspInfoHeader (\r
  FSP_INFO_HEADER *FspInfoHeader\r
  )\r
{\r
  GetFspGlobalDataPointer()->FspInfoHeader = FspInfoHeader;\r
}\r
\r
/**\r
  This function gets the FSP info header pointer using the API stack context.\r
\r
  @retval FspInfoHeader   FSP info header pointer using the API stack context\r
**/\r
FSP_INFO_HEADER *\r
EFIAPI\r
GetFspInfoHeaderFromApiContext (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  return  (FSP_INFO_HEADER *)(*(UINT32 *)(UINTN)(FspData->CoreStack + CONTEXT_STACK_OFFSET(FspInfoHeader)));\r
}\r
\r
/**\r
  This function gets the CfgRegion data pointer.\r
\r
  @return CfgRegion data pointer.\r
**/\r
VOID *\r
EFIAPI\r
GetFspCfgRegionDataPointer (\r
  VOID\r
  )\r
{\r
  FSP_INFO_HEADER   *FspInfoHeader;\r
\r
  FspInfoHeader = GetFspInfoHeader ();\r
  return (VOID *)(FspInfoHeader->ImageBase + FspInfoHeader->CfgRegionOffset);\r
}\r
\r
/**\r
  This function gets FSP API calling index.\r
\r
  @retval API calling index\r
**/\r
UINT8\r
EFIAPI\r
GetFspApiCallingIndex (\r
  VOID\r
  )\r
{\r
  return  GetFspGlobalDataPointer()->ApiIdx;\r
}\r
\r
/**\r
  This function sets FSP API calling mode.\r
\r
  @param[in] Index     API calling index\r
**/\r
VOID\r
EFIAPI\r
SetFspApiCallingIndex (\r
  UINT8  Index\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  FspData->ApiIdx = Index;\r
}\r
\r
/**\r
  This function gets FSP Phase StatusCode.\r
\r
  @retval StatusCode\r
**/\r
UINT32\r
EFIAPI\r
GetPhaseStatusCode (\r
  VOID\r
  )\r
{\r
  return  GetFspGlobalDataPointer()->StatusCode;\r
}\r
\r
/**\r
  This function sets FSP Phase StatusCode.\r
\r
  @param[in] Mode     Phase StatusCode\r
**/\r
VOID\r
EFIAPI\r
SetPhaseStatusCode (\r
  UINT32  StatusCode\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  FspData->StatusCode = StatusCode;\r
}\r
\r
/**\r
  This function updates the return status of the FSP API with requested reset type and returns to Boot Loader.\r
\r
  @param[in] FspResetType     Reset type that needs to returned as API return status\r
\r
**/\r
VOID\r
EFIAPI\r
FspApiReturnStatusReset (\r
  IN UINT32   FspResetType\r
  )\r
{\r
  volatile BOOLEAN  LoopUntilReset;\r
\r
  LoopUntilReset = TRUE;\r
  DEBUG ((DEBUG_INFO, "FSP returning control to Bootloader with reset required return status %x\n",FspResetType));\r
  if (GetFspGlobalDataPointer ()->FspMode == FSP_IN_API_MODE) {\r
    ///\r
    /// Below code is not an infinite loop.The control will go back to API calling function in BootLoader each time BootLoader\r
    /// calls the FSP API without honoring the reset request by FSP\r
    ///\r
    do {\r
      SetFspApiReturnStatus ((EFI_STATUS)FspResetType);\r
      Pei2LoaderSwitchStack ();\r
      DEBUG ((DEBUG_ERROR, "!!!ERROR: FSP has requested BootLoader for reset. But BootLoader has not honored the reset\n"));\r
      DEBUG ((DEBUG_ERROR, "!!!ERROR: Please add support in BootLoader to honor the reset request from FSP\n"));\r
    } while (LoopUntilReset);\r
  }\r
}\r