IntelFsp2WrapperPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFsp2WrapperPkg / FspmWrapperPeim / FspmWrapperPeim.c

/** @file\r
  This will be invoked only once. It will call FspMemoryInit API,\r
  register TemporaryRamDonePpi to call TempRamExit API, and register MemoryDiscoveredPpi\r
  notify to call FspSiliconInit API.\r
\r
  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <PiPei.h>\r
\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/FspWrapperPlatformLib.h>\r
#include <Library/FspWrapperHobProcessLib.h>\r
#include <Library/FspWrapperApiLib.h>\r
\r
#include <Ppi/FspSiliconInitDone.h>\r
#include <Ppi/EndOfPeiPhase.h>\r
#include <Ppi/MemoryDiscovered.h>\r
#include <Ppi/SecPlatformInformation.h>\r
#include <Library/FspWrapperApiTestLib.h>\r
#include <FspEas.h>\r
#include <FspStatusCode.h>\r
\r
extern EFI_GUID gFspHobGuid;\r
\r
/**\r
  Call FspMemoryInit API.\r
\r
  @return Status returned by FspMemoryInit API.\r
**/\r
EFI_STATUS\r
PeiFspMemoryInit (\r
  VOID\r
  )\r
{\r
  FSP_INFO_HEADER           *FspmHeaderPtr;\r
  EFI_STATUS                Status;\r
  UINT64                    TimeStampCounterStart;\r
  VOID                      *FspHobListPtr;\r
  VOID                      *HobData;\r
  FSPM_UPD_COMMON           *FspmUpdDataPtr;\r
  UINTN                     *SourceData;\r
\r
  DEBUG ((DEBUG_INFO, "PeiFspMemoryInit enter\n"));\r
\r
  FspHobListPtr = NULL;\r
  FspmUpdDataPtr = NULL;\r
\r
  FspmHeaderPtr = (FSP_INFO_HEADER *) FspFindFspHeader (PcdGet32 (PcdFspmBaseAddress));\r
  DEBUG ((DEBUG_INFO, "FspmHeaderPtr - 0x%x\n", FspmHeaderPtr));\r
  if (FspmHeaderPtr == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (PcdGet32 (PcdFspmUpdDataAddress) == 0 && (FspmHeaderPtr->CfgRegionSize != 0) && (FspmHeaderPtr->CfgRegionOffset != 0)) {\r
    //\r
    // Copy default FSP-M UPD data from Flash\r
    //\r
    FspmUpdDataPtr = (FSPM_UPD_COMMON *)AllocateZeroPool ((UINTN)FspmHeaderPtr->CfgRegionSize);\r
    ASSERT (FspmUpdDataPtr != NULL);\r
    SourceData = (UINTN *)((UINTN)FspmHeaderPtr->ImageBase + (UINTN)FspmHeaderPtr->CfgRegionOffset);\r
    CopyMem (FspmUpdDataPtr, SourceData, (UINTN)FspmHeaderPtr->CfgRegionSize);\r
  } else {\r
    //\r
    // External UPD is ready, get the buffer from PCD pointer.\r
    //\r
    FspmUpdDataPtr = (FSPM_UPD_COMMON *)PcdGet32 (PcdFspmUpdDataAddress);\r
    ASSERT (FspmUpdDataPtr != NULL);\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "UpdateFspmUpdData enter\n"));\r
  UpdateFspmUpdData ((VOID *)FspmUpdDataPtr);\r
  DEBUG ((DEBUG_INFO, "  NvsBufferPtr        - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.NvsBufferPtr));\r
  DEBUG ((DEBUG_INFO, "  StackBase           - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.StackBase));\r
  DEBUG ((DEBUG_INFO, "  StackSize           - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.StackSize));\r
  DEBUG ((DEBUG_INFO, "  BootLoaderTolumSize - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.BootLoaderTolumSize));\r
  DEBUG ((DEBUG_INFO, "  BootMode            - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.BootMode));\r
  DEBUG ((DEBUG_INFO, "  HobListPtr          - 0x%x\n", &FspHobListPtr));\r
\r
  TimeStampCounterStart = AsmReadTsc ();\r
  Status = CallFspMemoryInit (FspmUpdDataPtr, &FspHobListPtr);\r
  // Create hobs after memory initialization and not in temp RAM. Hence passing the recorded timestamp here\r
  PERF_START_EX(&gFspApiPerformanceGuid, "EventRec", NULL, TimeStampCounterStart, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_ENTRY);\r
  PERF_END_EX(&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);\r
  DEBUG ((DEBUG_INFO, "Total time spent executing FspMemoryInitApi: %d millisecond\n", DivU64x32 (GetTimeInNanoSecond (AsmReadTsc () - TimeStampCounterStart), 1000000)));\r
\r
  //\r
  // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status\r
  //\r
  if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {\r
    DEBUG((DEBUG_INFO, "FspMemoryInitApi requested reset 0x%x\n", Status));\r
    CallFspWrapperResetSystem ((UINT32)Status);\r
  }\r
\r
  if (EFI_ERROR(Status)) {\r
    DEBUG ((DEBUG_ERROR, "ERROR - Failed to execute FspMemoryInitApi(), Status = %r\n", Status));\r
  }\r
  DEBUG((DEBUG_INFO, "FspMemoryInit status: 0x%x\n", Status));\r
  ASSERT_EFI_ERROR (Status);\r
\r
\r
  Status = TestFspMemoryInitApiOutput (FspmUpdDataPtr, &FspHobListPtr);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "ERROR - TestFspMemoryInitApiOutput () fail, Status = %r\n", Status));\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "  FspHobListPtr (returned) - 0x%x\n", FspHobListPtr));\r
  ASSERT (FspHobListPtr != NULL);\r
\r
  PostFspmHobProcess (FspHobListPtr);\r
\r
  //\r
  // FspHobList is not complete at this moment.\r
  // Save FspHobList pointer to hob, so that it can be got later\r
  //\r
  HobData = BuildGuidHob (\r
             &gFspHobGuid,\r
             sizeof (VOID *)\r
             );\r
  ASSERT (HobData != NULL);\r
  CopyMem (HobData, &FspHobListPtr, sizeof (FspHobListPtr));\r
\r
  return Status;\r
}\r
\r
/**\r
  Do FSP initialization.\r
\r
  @return FSP initialization status.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FspmWrapperInit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS           Status;\r
\r
  Status = EFI_SUCCESS;\r
\r
  if (PcdGet8 (PcdFspModeSelection) == 1) {\r
    Status = PeiFspMemoryInit ();\r
    ASSERT_EFI_ERROR (Status);\r
  } else {\r
    PeiServicesInstallFvInfoPpi (\r
      NULL,\r
      (VOID *)(UINTN) PcdGet32 (PcdFspmBaseAddress),\r
      (UINT32)((EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) PcdGet32 (PcdFspmBaseAddress))->FvLength,\r
      NULL,\r
      NULL\r
      );\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  This is the entrypoint of PEIM\r
\r
  @param[in] FileHandle  Handle of the file being invoked.\r
  @param[in] PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCCESS if it completed successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FspmWrapperPeimEntryPoint (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  DEBUG((DEBUG_INFO, "FspmWrapperPeimEntryPoint\n"));\r
\r
  FspmWrapperInit ();\r
\r
  return EFI_SUCCESS;\r
}\r