[mirror_edk2.git] / IntelFsp2WrapperPkg / FspsWrapperPeim / FspsWrapperPeim.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
  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
\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/HobLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/FspWrapperPlatformLib.h>\r
#include <Library/FspWrapperHobProcessLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PerformanceLib.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/TemporaryRamDone.h>\r
#include <Ppi/SecPlatformInformation.h>\r
#include <Library/FspWrapperApiTestLib.h>\r
#include <FspEas.h>\r
#include <FspStatusCode.h>\r
\r
extern EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc;\r
extern EFI_GUID                  gFspHobGuid;\r
\r
/**\r
  This function handles S3 resume task at the end of PEI\r
\r
  @param[in] PeiServices    Pointer to PEI Services Table.\r
  @param[in] NotifyDesc     Pointer to the descriptor for the Notification event that\r
                            caused this function to execute.\r
  @param[in] Ppi            Pointer to the PPI data associated with this function.\r
\r
  @retval EFI_STATUS        Always return EFI_SUCCESS\r
**/\r
EFI_STATUS\r
EFIAPI\r
S3EndOfPeiNotify(\r
  IN EFI_PEI_SERVICES          **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
  IN VOID                      *Ppi\r
  );\r
\r
EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc = {\r
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiEndOfPeiSignalPpiGuid,\r
  S3EndOfPeiNotify\r
};\r
\r
/**\r
  This function handles S3 resume task at the end of PEI\r
\r
  @param[in] PeiServices    Pointer to PEI Services Table.\r
  @param[in] NotifyDesc     Pointer to the descriptor for the Notification event that\r
                            caused this function to execute.\r
  @param[in] Ppi            Pointer to the PPI data associated with this function.\r
\r
  @retval EFI_STATUS        Always return EFI_SUCCESS\r
**/\r
EFI_STATUS\r
EFIAPI\r
S3EndOfPeiNotify(\r
  IN EFI_PEI_SERVICES          **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
  IN VOID                      *Ppi\r
  )\r
{\r
  NOTIFY_PHASE_PARAMS NotifyPhaseParams;\r
  EFI_STATUS          Status;\r
\r
  DEBUG((DEBUG_INFO, "S3EndOfPeiNotify enter\n"));\r
\r
  NotifyPhaseParams.Phase = EnumInitPhaseAfterPciEnumeration;\r
  Status = CallFspNotifyPhase (&NotifyPhaseParams);\r
  DEBUG((DEBUG_INFO, "FSP S3NotifyPhase AfterPciEnumeration status: 0x%x\n", Status));\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, "FSP S3NotifyPhase AfterPciEnumeration requested reset 0x%x\n", Status));\r
    CallFspWrapperResetSystem ((UINT32)Status);\r
  }\r
\r
  NotifyPhaseParams.Phase = EnumInitPhaseReadyToBoot;\r
  Status = CallFspNotifyPhase (&NotifyPhaseParams);\r
  DEBUG((DEBUG_INFO, "FSP S3NotifyPhase ReadyToBoot status: 0x%x\n", Status));\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, "FSP S3NotifyPhase ReadyToBoot requested reset 0x%x\n", Status));\r
    CallFspWrapperResetSystem ((UINT32)Status);\r
  }\r
\r
  NotifyPhaseParams.Phase = EnumInitPhaseEndOfFirmware;\r
  Status = CallFspNotifyPhase (&NotifyPhaseParams);\r
  DEBUG((DEBUG_INFO, "FSP S3NotifyPhase EndOfFirmware status: 0x%x\n", Status));\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, "FSP S3NotifyPhase EndOfFirmware requested reset 0x%x\n", Status));\r
    CallFspWrapperResetSystem ((UINT32)Status);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Return Hob list produced by FSP.\r
\r
  @param[in]  PeiServices  The pointer to the PEI Services Table.\r
  @param[in]  This         The pointer to this instance of this PPI.\r
  @param[out] FspHobList   The pointer to Hob list produced by FSP.\r
\r
  @return EFI_SUCCESS FReturn Hob list produced by FSP successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FspSiliconInitDoneGetFspHobList (\r
  IN  CONST EFI_PEI_SERVICES         **PeiServices,\r
  IN  FSP_SILICON_INIT_DONE_PPI      *This,\r
  OUT VOID                           **FspHobList\r
  );\r
\r
FSP_SILICON_INIT_DONE_PPI mFspSiliconInitDonePpi = {\r
  FspSiliconInitDoneGetFspHobList\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR            mPeiFspSiliconInitDonePpi = {\r
  EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
  &gFspSiliconInitDonePpiGuid,\r
  &mFspSiliconInitDonePpi\r
};\r
\r
/**\r
  Return Hob list produced by FSP.\r
\r
  @param[in]  PeiServices  The pointer to the PEI Services Table.\r
  @param[in]  This         The pointer to this instance of this PPI.\r
  @param[out] FspHobList   The pointer to Hob list produced by FSP.\r
\r
  @return EFI_SUCCESS FReturn Hob list produced by FSP successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FspSiliconInitDoneGetFspHobList (\r
  IN  CONST EFI_PEI_SERVICES         **PeiServices,\r
  IN  FSP_SILICON_INIT_DONE_PPI      *This,\r
  OUT VOID                           **FspHobList\r
  )\r
{\r
  EFI_HOB_GUID_TYPE                  *GuidHob;\r
\r
  GuidHob = GetFirstGuidHob (&gFspHobGuid);\r
  if (GuidHob != NULL) {\r
    *FspHobList = *(VOID **)GET_GUID_HOB_DATA(GuidHob);\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_NOT_FOUND;\r
  }\r
}\r
\r
/**\r
  This function is called after PEI core discover memory and finish migration.\r
\r
  @param[in] PeiServices    Pointer to PEI Services Table.\r
  @param[in] NotifyDesc     Pointer to the descriptor for the Notification event that\r
                            caused this function to execute.\r
  @param[in] Ppi            Pointer to the PPI data associated with this function.\r
\r
  @retval EFI_STATUS        Always return EFI_SUCCESS\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiMemoryDiscoveredNotify (\r
  IN EFI_PEI_SERVICES          **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
  IN VOID                      *Ppi\r
  );\r
\r
EFI_PEI_NOTIFY_DESCRIPTOR mPeiMemoryDiscoveredNotifyDesc = {\r
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiMemoryDiscoveredPpiGuid,\r
  PeiMemoryDiscoveredNotify\r
};\r
\r
/**\r
  This function is called after PEI core discover memory and finish migration.\r
\r
  @param[in] PeiServices    Pointer to PEI Services Table.\r
  @param[in] NotifyDesc     Pointer to the descriptor for the Notification event that\r
                            caused this function to execute.\r
  @param[in] Ppi            Pointer to the PPI data associated with this function.\r
\r
  @retval EFI_STATUS        Always return EFI_SUCCESS\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiMemoryDiscoveredNotify (\r
  IN EFI_PEI_SERVICES          **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
  IN VOID                      *Ppi\r
  )\r
{\r
  FSP_INFO_HEADER           *FspsHeaderPtr;\r
  UINT64                    TimeStampCounterStart;\r
  EFI_STATUS                Status;\r
  VOID                      *FspHobListPtr;\r
  EFI_HOB_GUID_TYPE         *GuidHob;\r
  FSPS_UPD_COMMON           *FspsUpdDataPtr;\r
  UINTN                     *SourceData;\r
\r
  DEBUG ((DEBUG_INFO, "PeiMemoryDiscoveredNotify enter\n"));\r
  FspsUpdDataPtr = NULL;\r
\r
  FspsHeaderPtr = (FSP_INFO_HEADER *)FspFindFspHeader (PcdGet32 (PcdFspsBaseAddress));\r
  DEBUG ((DEBUG_INFO, "FspsHeaderPtr - 0x%x\n", FspsHeaderPtr));\r
  if (FspsHeaderPtr == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (PcdGet32 (PcdFspsUpdDataAddress) == 0 && (FspsHeaderPtr->CfgRegionSize != 0) && (FspsHeaderPtr->CfgRegionOffset != 0)) {\r
    //\r
    // Copy default FSP-S UPD data from Flash\r
    //\r
    FspsUpdDataPtr = (FSPS_UPD_COMMON *)AllocateZeroPool ((UINTN)FspsHeaderPtr->CfgRegionSize);\r
    ASSERT (FspsUpdDataPtr != NULL);\r
    SourceData = (UINTN *)((UINTN)FspsHeaderPtr->ImageBase + (UINTN)FspsHeaderPtr->CfgRegionOffset);\r
    CopyMem (FspsUpdDataPtr, SourceData, (UINTN)FspsHeaderPtr->CfgRegionSize);\r
  } else {\r
    FspsUpdDataPtr = (FSPS_UPD_COMMON *)PcdGet32 (PcdFspsUpdDataAddress);\r
    ASSERT (FspsUpdDataPtr != NULL);\r
  }\r
\r
  UpdateFspsUpdData ((VOID *)FspsUpdDataPtr);\r
\r
  TimeStampCounterStart = AsmReadTsc ();\r
  PERF_START_EX(&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_ENTRY);\r
  Status = CallFspSiliconInit ((VOID *)FspsUpdDataPtr);\r
  PERF_END_EX(&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);\r
  DEBUG ((DEBUG_INFO, "Total time spent executing FspSiliconInitApi: %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, "FspSiliconInitApi 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 FspSiliconInitApi(), Status = %r\n", Status));\r
  }\r
  DEBUG((DEBUG_INFO, "FspSiliconInit status: 0x%x\n", Status));\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = TestFspSiliconInitApiOutput ((VOID *)NULL);\r
  if (RETURN_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "ERROR - TestFspSiliconInitApiOutput () fail, Status = %r\n", Status));\r
  }\r
\r
  //\r
  // Now FspHobList complete, process it\r
  //\r
  GuidHob = GetFirstGuidHob (&gFspHobGuid);\r
  ASSERT (GuidHob != NULL);\r
  FspHobListPtr = *(VOID **)GET_GUID_HOB_DATA (GuidHob);\r
  DEBUG ((DEBUG_INFO, "FspHobListPtr - 0x%x\n", FspHobListPtr));\r
  PostFspsHobProcess (FspHobListPtr);\r
\r
  //\r
  // Install FspSiliconInitDonePpi so that any other driver can consume this info.\r
  //\r
  Status = PeiServicesInstallPpi (&mPeiFspSiliconInitDonePpi);\r
  ASSERT_EFI_ERROR(Status);\r
\r
  return Status;\r
}\r
\r
/**\r
  Do FSP initialization.\r
\r
  @return FSP initialization status.\r
**/\r
EFI_STATUS\r
FspsWrapperInit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS           Status;\r
  EFI_BOOT_MODE        BootMode;\r
\r
  //\r
  // Register MemoryDiscovered Nofity to run FspSiliconInit\r
  //\r
  Status = PeiServicesNotifyPpi (&mPeiMemoryDiscoveredNotifyDesc);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Register EndOfPei Notify for S3 to run FSP NotifyPhase\r
  //\r
  PeiServicesGetBootMode (&BootMode);\r
  if (BootMode == BOOT_ON_S3_RESUME) {\r
    Status = PeiServicesNotifyPpi (&mS3EndOfPeiNotifyDesc);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  return EFI_SUCCESS;\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
FspsWrapperPeimEntryPoint (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  DEBUG ((DEBUG_INFO, "FspsWrapperPeimEntryPoint\n"));\r
\r
  if (PcdGet8 (PcdFspModeSelection) == 1) {\r
    FspsWrapperInit ();\r
  } else {\r
    PeiServicesInstallFvInfoPpi (\r
      NULL,\r
      (VOID *)(UINTN) PcdGet32 (PcdFspsBaseAddress),\r
      (UINT32)((EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) PcdGet32 (PcdFspsBaseAddress))->FvLength,\r
      NULL,\r
      NULL\r
      );\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
cf1d4549 JY	1	/** @file\r
	2	This will be invoked only once. It will call FspMemoryInit API,\r
	3	register TemporaryRamDonePpi to call TempRamExit API, and register MemoryDiscoveredPpi\r
	4	notify to call FspSiliconInit API.\r
	5	\r
2098de62	6	Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r
cf1d4549 JY	7	This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php.\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/\r
	16	\r
	17	#include <PiPei.h>\r
	18	\r
	19	#include <Library/PeimEntryPoint.h>\r
	20	#include <Library/PeiServicesLib.h>\r
	21	#include <Library/PeiServicesTablePointerLib.h>\r
	22	#include <Library/BaseLib.h>\r
	23	#include <Library/DebugLib.h>\r
	24	#include <Library/BaseMemoryLib.h>\r
	25	#include <Library/HobLib.h>\r
	26	#include <Library/PcdLib.h>\r
	27	#include <Library/MemoryAllocationLib.h>\r
	28	#include <Library/FspWrapperPlatformLib.h>\r
	29	#include <Library/FspWrapperHobProcessLib.h>\r
	30	#include <Library/TimerLib.h>\r
	31	#include <Library/PerformanceLib.h>\r
	32	#include <Library/FspWrapperApiLib.h>\r
	33	\r
	34	#include <Ppi/FspSiliconInitDone.h>\r
	35	#include <Ppi/EndOfPeiPhase.h>\r
	36	#include <Ppi/MemoryDiscovered.h>\r
	37	#include <Ppi/TemporaryRamDone.h>\r
	38	#include <Ppi/SecPlatformInformation.h>\r
cf1d4549 JY	39	#include <Library/FspWrapperApiTestLib.h>\r
cf1d4549 JY	40	#include <FspEas.h>\r
19d29d35	41	#include <FspStatusCode.h>\r
cf1d4549 JY	42	\r
	43	extern EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc;\r
	44	extern EFI_GUID gFspHobGuid;\r
	45	\r
	46	/**\r
e69dcef5	47	This function handles S3 resume task at the end of PEI\r
cf1d4549	48	\r
e69dcef5 CC	49	@param[in] PeiServices Pointer to PEI Services Table.\r
	50	@param[in] NotifyDesc Pointer to the descriptor for the Notification event that\r
	51	caused this function to execute.\r
	52	@param[in] Ppi Pointer to the PPI data associated with this function.\r
cf1d4549	53	\r
e69dcef5	54	@retval EFI_STATUS Always return EFI_SUCCESS\r
cf1d4549 JY	55	**/\r
	56	EFI_STATUS\r
	57	EFIAPI\r
	58	S3EndOfPeiNotify(\r
	59	IN EFI_PEI_SERVICES **PeiServices,\r
	60	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
	61	IN VOID *Ppi\r
	62	);\r
	63	\r
	64	EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc = {\r
	65	(EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	66	&gEfiEndOfPeiSignalPpiGuid,\r
	67	S3EndOfPeiNotify\r
	68	};\r
	69	\r
	70	/**\r
e69dcef5	71	This function handles S3 resume task at the end of PEI\r
cf1d4549	72	\r
e69dcef5 CC	73	@param[in] PeiServices Pointer to PEI Services Table.\r
	74	@param[in] NotifyDesc Pointer to the descriptor for the Notification event that\r
	75	caused this function to execute.\r
	76	@param[in] Ppi Pointer to the PPI data associated with this function.\r
cf1d4549	77	\r
e69dcef5	78	@retval EFI_STATUS Always return EFI_SUCCESS\r
cf1d4549 JY	79	**/\r
	80	EFI_STATUS\r
	81	EFIAPI\r
	82	S3EndOfPeiNotify(\r
	83	IN EFI_PEI_SERVICES **PeiServices,\r
	84	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
	85	IN VOID *Ppi\r
	86	)\r
	87	{\r
	88	NOTIFY_PHASE_PARAMS NotifyPhaseParams;\r
	89	EFI_STATUS Status;\r
	90	\r
	91	DEBUG((DEBUG_INFO, "S3EndOfPeiNotify enter\n"));\r
	92	\r
	93	NotifyPhaseParams.Phase = EnumInitPhaseAfterPciEnumeration;\r
	94	Status = CallFspNotifyPhase (&NotifyPhaseParams);\r
	95	DEBUG((DEBUG_INFO, "FSP S3NotifyPhase AfterPciEnumeration status: 0x%x\n", Status));\r
	96	\r
f862a3b6 JY	97	//\r
	98	// Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status\r
	99	//\r
	100	if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {\r
	101	DEBUG((DEBUG_INFO, "FSP S3NotifyPhase AfterPciEnumeration requested reset 0x%x\n", Status));\r
	102	CallFspWrapperResetSystem ((UINT32)Status);\r
	103	}\r
	104	\r
cf1d4549 JY	105	NotifyPhaseParams.Phase = EnumInitPhaseReadyToBoot;\r
	106	Status = CallFspNotifyPhase (&NotifyPhaseParams);\r
	107	DEBUG((DEBUG_INFO, "FSP S3NotifyPhase ReadyToBoot status: 0x%x\n", Status));\r
	108	\r
f862a3b6 JY	109	//\r
	110	// Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status\r
	111	//\r
	112	if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {\r
	113	DEBUG((DEBUG_INFO, "FSP S3NotifyPhase ReadyToBoot requested reset 0x%x\n", Status));\r
	114	CallFspWrapperResetSystem ((UINT32)Status);\r
	115	}\r
	116	\r
cf1d4549 JY	117	NotifyPhaseParams.Phase = EnumInitPhaseEndOfFirmware;\r
	118	Status = CallFspNotifyPhase (&NotifyPhaseParams);\r
	119	DEBUG((DEBUG_INFO, "FSP S3NotifyPhase EndOfFirmware status: 0x%x\n", Status));\r
	120	\r
f862a3b6 JY	121	//\r
	122	// Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status\r
	123	//\r
	124	if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {\r
	125	DEBUG((DEBUG_INFO, "FSP S3NotifyPhase EndOfFirmware requested reset 0x%x\n", Status));\r
	126	CallFspWrapperResetSystem ((UINT32)Status);\r
	127	}\r
	128	\r
cf1d4549 JY	129	return EFI_SUCCESS;\r
	130	}\r
	131	\r
	132	/**\r
e69dcef5	133	Return Hob list produced by FSP.\r
cf1d4549	134	\r
e69dcef5 CC	135	@param[in] PeiServices The pointer to the PEI Services Table.\r
	136	@param[in] This The pointer to this instance of this PPI.\r
	137	@param[out] FspHobList The pointer to Hob list produced by FSP.\r
cf1d4549	138	\r
e69dcef5	139	@return EFI_SUCCESS FReturn Hob list produced by FSP successfully.\r
cf1d4549 JY	140	**/\r
	141	EFI_STATUS\r
	142	EFIAPI\r
	143	FspSiliconInitDoneGetFspHobList (\r
	144	IN CONST EFI_PEI_SERVICES **PeiServices,\r
	145	IN FSP_SILICON_INIT_DONE_PPI *This,\r
	146	OUT VOID **FspHobList\r
	147	);\r
	148	\r
	149	FSP_SILICON_INIT_DONE_PPI mFspSiliconInitDonePpi = {\r
	150	FspSiliconInitDoneGetFspHobList\r
	151	};\r
	152	\r
	153	EFI_PEI_PPI_DESCRIPTOR mPeiFspSiliconInitDonePpi = {\r
	154	EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
	155	&gFspSiliconInitDonePpiGuid,\r
	156	&mFspSiliconInitDonePpi\r
	157	};\r
	158	\r
	159	/**\r
e69dcef5	160	Return Hob list produced by FSP.\r
cf1d4549	161	\r
e69dcef5 CC	162	@param[in] PeiServices The pointer to the PEI Services Table.\r
	163	@param[in] This The pointer to this instance of this PPI.\r
	164	@param[out] FspHobList The pointer to Hob list produced by FSP.\r
cf1d4549	165	\r
e69dcef5	166	@return EFI_SUCCESS FReturn Hob list produced by FSP successfully.\r
cf1d4549 JY	167	**/\r
	168	EFI_STATUS\r
	169	EFIAPI\r
	170	FspSiliconInitDoneGetFspHobList (\r
	171	IN CONST EFI_PEI_SERVICES **PeiServices,\r
	172	IN FSP_SILICON_INIT_DONE_PPI *This,\r
	173	OUT VOID **FspHobList\r
	174	)\r
	175	{\r
	176	EFI_HOB_GUID_TYPE *GuidHob;\r
	177	\r
	178	GuidHob = GetFirstGuidHob (&gFspHobGuid);\r
	179	if (GuidHob != NULL) {\r
	180	FspHobList = (VOID **)GET_GUID_HOB_DATA(GuidHob);\r
	181	return EFI_SUCCESS;\r
	182	} else {\r
	183	return EFI_NOT_FOUND;\r
	184	}\r
	185	}\r
	186	\r
	187	/**\r
	188	This function is called after PEI core discover memory and finish migration.\r
	189	\r
	190	@param[in] PeiServices Pointer to PEI Services Table.\r
	191	@param[in] NotifyDesc Pointer to the descriptor for the Notification event that\r
	192	caused this function to execute.\r
	193	@param[in] Ppi Pointer to the PPI data associated with this function.\r
	194	\r
	195	@retval EFI_STATUS Always return EFI_SUCCESS\r
	196	**/\r
	197	EFI_STATUS\r
	198	EFIAPI\r
	199	PeiMemoryDiscoveredNotify (\r
	200	IN EFI_PEI_SERVICES **PeiServices,\r
	201	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
	202	IN VOID *Ppi\r
	203	);\r
	204	\r
	205	EFI_PEI_NOTIFY_DESCRIPTOR mPeiMemoryDiscoveredNotifyDesc = {\r
	206	(EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	207	&gEfiPeiMemoryDiscoveredPpiGuid,\r
	208	PeiMemoryDiscoveredNotify\r
	209	};\r
	210	\r
	211	/**\r
e69dcef5	212	This function is called after PEI core discover memory and finish migration.\r
cf1d4549	213	\r
e69dcef5 CC	214	@param[in] PeiServices Pointer to PEI Services Table.\r
	215	@param[in] NotifyDesc Pointer to the descriptor for the Notification event that\r
	216	caused this function to execute.\r
	217	@param[in] Ppi Pointer to the PPI data associated with this function.\r
cf1d4549	218	\r
e69dcef5	219	@retval EFI_STATUS Always return EFI_SUCCESS\r
cf1d4549 JY	220	**/\r
	221	EFI_STATUS\r
	222	EFIAPI\r
	223	PeiMemoryDiscoveredNotify (\r
	224	IN EFI_PEI_SERVICES **PeiServices,\r
	225	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
	226	IN VOID *Ppi\r
	227	)\r
	228	{\r
	229	FSP_INFO_HEADER *FspsHeaderPtr;\r
	230	UINT64 TimeStampCounterStart;\r
	231	EFI_STATUS Status;\r
	232	VOID *FspHobListPtr;\r
	233	EFI_HOB_GUID_TYPE *GuidHob;\r
	234	FSPS_UPD_COMMON *FspsUpdDataPtr;\r
	235	UINTN *SourceData;\r
	236	\r
cf1d4549	237	DEBUG ((DEBUG_INFO, "PeiMemoryDiscoveredNotify enter\n"));\r
e69dcef5 CC	238	FspsUpdDataPtr = NULL;\r
e69dcef5 CC	239	\r
cf1d4549	240	FspsHeaderPtr = (FSP_INFO_HEADER *)FspFindFspHeader (PcdGet32 (PcdFspsBaseAddress));\r
599c45ff HW	241	DEBUG ((DEBUG_INFO, "FspsHeaderPtr - 0x%x\n", FspsHeaderPtr));\r
	242	if (FspsHeaderPtr == NULL) {\r
	243	return EFI_DEVICE_ERROR;\r
	244	}\r
	245	\r
e69dcef5 CC	246	if (PcdGet32 (PcdFspsUpdDataAddress) == 0 && (FspsHeaderPtr->CfgRegionSize != 0) && (FspsHeaderPtr->CfgRegionOffset != 0)) {\r
	247	//\r
	248	// Copy default FSP-S UPD data from Flash\r
	249	//\r
	250	FspsUpdDataPtr = (FSPS_UPD_COMMON *)AllocateZeroPool ((UINTN)FspsHeaderPtr->CfgRegionSize);\r
	251	ASSERT (FspsUpdDataPtr != NULL);\r
	252	SourceData = (UINTN *)((UINTN)FspsHeaderPtr->ImageBase + (UINTN)FspsHeaderPtr->CfgRegionOffset);\r
	253	CopyMem (FspsUpdDataPtr, SourceData, (UINTN)FspsHeaderPtr->CfgRegionSize);\r
	254	} else {\r
	255	FspsUpdDataPtr = (FSPS_UPD_COMMON *)PcdGet32 (PcdFspsUpdDataAddress);\r
	256	ASSERT (FspsUpdDataPtr != NULL);\r
	257	}\r
cf1d4549 JY	258	\r
	259	UpdateFspsUpdData ((VOID *)FspsUpdDataPtr);\r
	260	\r
	261	TimeStampCounterStart = AsmReadTsc ();\r
19d29d35	262	PERF_START_EX(&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT \| FSP_STATUS_CODE_COMMON_CODE \| FSP_STATUS_CODE_API_ENTRY);\r
cf1d4549	263	Status = CallFspSiliconInit ((VOID *)FspsUpdDataPtr);\r
19d29d35	264	PERF_END_EX(&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT \| FSP_STATUS_CODE_COMMON_CODE \| FSP_STATUS_CODE_API_EXIT);\r
cf1d4549	265	DEBUG ((DEBUG_INFO, "Total time spent executing FspSiliconInitApi: %d millisecond\n", DivU64x32 (GetTimeInNanoSecond (AsmReadTsc () - TimeStampCounterStart), 1000000)));\r
f862a3b6 JY	266	\r
	267	//\r
	268	// Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status\r
	269	//\r
	270	if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {\r
	271	DEBUG((DEBUG_INFO, "FspSiliconInitApi requested reset 0x%x\n", Status));\r
	272	CallFspWrapperResetSystem ((UINT32)Status);\r
	273	}\r
	274	\r
cf1d4549 JY	275	if (EFI_ERROR(Status)) {\r
	276	DEBUG ((DEBUG_ERROR, "ERROR - Failed to execute FspSiliconInitApi(), Status = %r\n", Status));\r
	277	}\r
	278	DEBUG((DEBUG_INFO, "FspSiliconInit status: 0x%x\n", Status));\r
	279	ASSERT_EFI_ERROR (Status);\r
	280	\r
	281	Status = TestFspSiliconInitApiOutput ((VOID *)NULL);\r
	282	if (RETURN_ERROR (Status)) {\r
	283	DEBUG ((DEBUG_ERROR, "ERROR - TestFspSiliconInitApiOutput () fail, Status = %r\n", Status));\r
	284	}\r
	285	\r
	286	//\r
	287	// Now FspHobList complete, process it\r
	288	//\r
	289	GuidHob = GetFirstGuidHob (&gFspHobGuid);\r
	290	ASSERT (GuidHob != NULL);\r
	291	FspHobListPtr = (VOID *)GET_GUID_HOB_DATA (GuidHob);\r
	292	DEBUG ((DEBUG_INFO, "FspHobListPtr - 0x%x\n", FspHobListPtr));\r
	293	PostFspsHobProcess (FspHobListPtr);\r
	294	\r
	295	//\r
	296	// Install FspSiliconInitDonePpi so that any other driver can consume this info.\r
	297	//\r
	298	Status = PeiServicesInstallPpi (&mPeiFspSiliconInitDonePpi);\r
	299	ASSERT_EFI_ERROR(Status);\r
	300	\r
	301	return Status;\r
	302	}\r
	303	\r
	304	/**\r
	305	Do FSP initialization.\r
	306	\r
	307	@return FSP initialization status.\r
	308	**/\r
	309	EFI_STATUS\r
	310	FspsWrapperInit (\r
	311	VOID\r
	312	)\r
	313	{\r
	314	EFI_STATUS Status;\r
	315	EFI_BOOT_MODE BootMode;\r
	316	\r
	317	//\r
	318	// Register MemoryDiscovered Nofity to run FspSiliconInit\r
	319	//\r
	320	Status = PeiServicesNotifyPpi (&mPeiMemoryDiscoveredNotifyDesc);\r
	321	ASSERT_EFI_ERROR (Status);\r
e69dcef5	322	\r
cf1d4549 JY	323	//\r
	324	// Register EndOfPei Notify for S3 to run FSP NotifyPhase\r
	325	//\r
	326	PeiServicesGetBootMode (&BootMode);\r
	327	if (BootMode == BOOT_ON_S3_RESUME) {\r
	328	Status = PeiServicesNotifyPpi (&mS3EndOfPeiNotifyDesc);\r
	329	ASSERT_EFI_ERROR (Status);\r
	330	}\r
	331	\r
	332	return EFI_SUCCESS;\r
	333	}\r
	334	\r
	335	/**\r
	336	This is the entrypoint of PEIM\r
	337	\r
	338	@param[in] FileHandle Handle of the file being invoked.\r
	339	@param[in] PeiServices Describes the list of possible PEI Services.\r
	340	\r
	341	@retval EFI_SUCCESS if it completed successfully.\r
	342	**/\r
	343	EFI_STATUS\r
	344	EFIAPI\r
	345	FspsWrapperPeimEntryPoint (\r
	346	IN EFI_PEI_FILE_HANDLE FileHandle,\r
	347	IN CONST EFI_PEI_SERVICES **PeiServices\r
	348	)\r
	349	{\r
cf1d4549 JY	350	DEBUG ((DEBUG_INFO, "FspsWrapperPeimEntryPoint\n"));\r
cf1d4549 JY	351	\r
e8f40b77	352	if (PcdGet8 (PcdFspModeSelection) == 1) {\r
2098de62 CC	353	FspsWrapperInit ();\r
	354	} else {\r
	355	PeiServicesInstallFvInfoPpi (\r
	356	NULL,\r
	357	(VOID *)(UINTN) PcdGet32 (PcdFspsBaseAddress),\r
	358	(UINT32)((EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) PcdGet32 (PcdFspsBaseAddress))->FvLength,\r
	359	NULL,\r
	360	NULL\r
	361	);\r
	362	}\r
cf1d4549 JY	363	\r
	364	return EFI_SUCCESS;\r
	365	}\r