MdeModulePkg/SetupBrowser: Fix the typo in the comment

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

/** @file\r
\r
  Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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 <FspDataTable.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 bootlaoder.\r
\r
  @retval ApiParameter FSP API first parameter passed by the bootlaoder.\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 gets back the FSP API second parameter passed by the bootlaoder.\r
\r
  @retval ApiParameter FSP API second parameter passed by the bootlaoder.\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 memory init UPD data pointer.\r
\r
  @param[in] MemoryInitUpdPtr   memory init 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 memory init UPD pointer.\r
  //\r
  FspData->MemoryInitUpdPtr = MemoryInitUpdPtr;\r
}\r
\r
/**\r
  This function gets the memory init UPD data pointer.\r
\r
  @return memory init 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 silicon init UPD data pointer.\r
\r
  @param[in] SiliconInitUpdPtr   silicon init 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 silicon init UPD data pointer.\r
  //\r
  FspData->SiliconInitUpdPtr = SiliconInitUpdPtr;\r
}\r
\r
/**\r
  This function gets the silicon init UPD data pointer.\r
\r
  @return silicon init 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 gets FSP CAR base.\r
\r
**/\r
UINT32\r
EFIAPI\r
GetFspCarBase (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
  UINT32           CarBase;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  CarBase = FspData->PlatformData.CarBase;\r
  if (CarBase == 0) {\r
    CarBase = PcdGet32(PcdTemporaryRamBase);\r
  }\r
  return CarBase;\r
}\r
\r
/**\r
  This function gets FSP CAR size.\r
\r
**/\r
UINT32\r
EFIAPI\r
GetFspCarSize (\r
  VOID\r
  )\r
{\r
  FSP_GLOBAL_DATA  *FspData;\r
  UINT32           CarSize;\r
\r
  FspData  = GetFspGlobalDataPointer ();\r
  CarSize = FspData->PlatformData.CarSize;\r
  if (FspData->PlatformData.CarBase == 0) {\r
    CarSize = PcdGet32(PcdTemporaryRamSize);\r
  }\r
  return CarSize;\r
}\r