[mirror_edk2.git] / MdeModulePkg / Core / Pei / PeiMain / PeiMain.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. 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
Module Name:\r
\r
  PeiMain.c\r
\r
Abstract:\r
\r
  Pei Core Main Entry Point\r
\r
Revision History\r
\r
--*/\r
\r
#include <PeiMain.h>\r
\r
//\r
//CAR is filled with this initial value during SEC phase\r
//\r
#define INIT_CAR_VALUE 0x5AA55AA5\r
\r
static EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiMemoryDiscoveredPpiGuid,\r
  NULL\r
};\r
\r
//\r
// Pei Core Module Variables\r
//\r
//\r
static EFI_PEI_SERVICES  mPS = {\r
  {\r
    PEI_SERVICES_SIGNATURE,\r
    PEI_SERVICES_REVISION,\r
    sizeof (EFI_PEI_SERVICES),\r
    0,\r
    0\r
  },\r
  PeiInstallPpi,\r
  PeiReInstallPpi,\r
  PeiLocatePpi,\r
  PeiNotifyPpi,\r
\r
  PeiGetBootMode,\r
  PeiSetBootMode,\r
\r
  PeiGetHobList,\r
  PeiCreateHob,\r
\r
  PeiFvFindNextVolume,\r
  PeiFfsFindNextFile,\r
  PeiFfsFindSectionData,\r
\r
  PeiInstallPeiMemory,      \r
  PeiAllocatePages,\r
  PeiAllocatePool,\r
  (EFI_PEI_COPY_MEM)CopyMem,\r
  (EFI_PEI_SET_MEM)SetMem,\r
\r
  PeiReportStatusCode,\r
  PeiResetSystem,\r
\r
  NULL,\r
  NULL,\r
\r
  PeiFfsFindFileByName,\r
  PeiFfsGetFileInfo,\r
  PeiFfsGetVolumeInfo,\r
  PeiRegisterForShadow\r
};\r
\r
EFI_STATUS\r
EFIAPI\r
PeiCore (\r
  IN CONST EFI_SEC_PEI_HAND_OFF        *SecCoreData,\r
  IN CONST EFI_PEI_PPI_DESCRIPTOR      *PpList,\r
  IN VOID                              *Data\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The entry routine to Pei Core, invoked by PeiMain during transition\r
  from SEC to PEI. After switching stack in the PEI core, it will restart\r
  with the old core data.\r
\r
Arguments:\r
\r
  SecCoreData          - Points to a data structure containing information about the PEI core's operating\r
                         environment, such as the size and location of temporary RAM, the stack location and\r
                         the BFV location.\r
  PpiList              - Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
                         An empty PPI list consists of a single descriptor with the end-tag\r
                         EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r
                         phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such\r
                         that both the PEI Foundation and any modules can leverage the associated service\r
                         calls and/or code in these early PPIs\r
  Data                 - Pointer to old core data that is used to initialize the\r
                         core's data areas.\r
\r
Returns:\r
\r
  This function never returns\r
  EFI_NOT_FOUND        - Never reach\r
\r
--*/\r
{\r
  PEI_CORE_INSTANCE                                     PrivateData;\r
  EFI_STATUS                                            Status;\r
  PEI_CORE_TEMP_POINTERS                                TempPtr;\r
  UINT64                                                mTick;\r
  PEI_CORE_INSTANCE                                     *OldCoreData;\r
  EFI_PEI_CPU_IO_PPI                                    *CpuIo;\r
  EFI_PEI_PCI_CFG2_PPI                                  *PciCfg;\r
\r
  mTick = 0;\r
  OldCoreData = (PEI_CORE_INSTANCE *) Data;\r
\r
  if (PerformanceMeasurementEnabled()) {\r
    if (OldCoreData == NULL) {\r
      mTick = GetPerformanceCounter ();\r
    }\r
  }\r
\r
  //\r
  // For IPF in CAR mode the real memory access is uncached,in InstallPeiMemory()\r
  //  the 63-bit of address is set to 1.\r
  //\r
  SWITCH_TO_CACHE_MODE (OldCoreData);\r
\r
  if (OldCoreData != NULL) {\r
    CopyMem (&PrivateData, OldCoreData, sizeof (PEI_CORE_INSTANCE));\r
    \r
    CpuIo = (VOID*)PrivateData.ServiceTableShadow.CpuIo;\r
    PciCfg = (VOID*)PrivateData.ServiceTableShadow.PciCfg;\r
    \r
    CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));\r
    \r
    PrivateData.ServiceTableShadow.CpuIo  = CpuIo;\r
    PrivateData.ServiceTableShadow.PciCfg = PciCfg;\r
  } else {\r
    ZeroMem (&PrivateData, sizeof (PEI_CORE_INSTANCE));\r
    PrivateData.Signature = PEI_CORE_HANDLE_SIGNATURE;\r
    CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));\r
  }\r
\r
  PrivateData.PS = &PrivateData.ServiceTableShadow;\r
\r
  //\r
  // Initialize libraries that the PeiCore is linked against\r
  // BUGBUG: The FileHandle is passed in as NULL.  Do we look it up or remove it from the lib init?\r
  //\r
  ProcessLibraryConstructorList (NULL, &PrivateData.PS);\r
\r
  InitializeMemoryServices (&PrivateData, SecCoreData, OldCoreData);\r
\r
  InitializePpiServices (&PrivateData, OldCoreData);\r
\r
  if (OldCoreData != NULL) {\r
\r
    PERF_END (NULL,"PreMem", NULL, 0);\r
    PERF_START (NULL,"PostMem", NULL, 0);\r
\r
    //\r
    // The following code dumps out interesting cache as RAM usage information\r
    // so we can keep tabs on how the cache as RAM is being utilized.  The\r
    // DEBUG_CODE_BEGIN macro is used to prevent this code from being compiled\r
    // on a debug build.\r
    //\r
    DEBUG_CODE_BEGIN ();\r
      UINTN  *StackPointer;\r
      UINTN  StackValue;\r
\r
      StackValue = INIT_CAR_VALUE;\r
      for (StackPointer = (UINTN *) OldCoreData->MaxTopOfCarHeap;\r
           ((UINTN) StackPointer < ((UINTN) OldCoreData->BottomOfCarHeap + OldCoreData->SizeOfCacheAsRam))\r
           && StackValue == INIT_CAR_VALUE;\r
           StackPointer++) {\r
        StackValue = *StackPointer;\r
      }\r
\r
      DEBUG ((EFI_D_INFO, "Total Cache as RAM:    %d bytes.\n", OldCoreData->SizeOfCacheAsRam));\r
      DEBUG ((EFI_D_INFO, "  CAR stack ever used: %d bytes.\n",\r
        ((UINTN) OldCoreData->TopOfCarHeap - (UINTN) StackPointer)\r
        ));\r
      DEBUG ((EFI_D_INFO, "  CAR heap used:       %d bytes.\n",\r
        ((UINTN) OldCoreData->HobList.HandoffInformationTable->EfiFreeMemoryBottom -\r
        (UINTN) OldCoreData->HobList.Raw)\r
        ));\r
    DEBUG_CODE_END ();\r
\r
    //\r
    // Alert any listeners that there is permanent memory available\r
    //\r
    \r
    PERF_START (NULL,"DisMem", NULL, 0);\r
    Status = PeiServicesInstallPpi (&mMemoryDiscoveredPpi);\r
    PERF_END (NULL,"DisMem", NULL, 0);\r
\r
  } else {\r
\r
    //\r
    // Report Status Code EFI_SW_PC_INIT\r
    //\r
    REPORT_STATUS_CODE (\r
      EFI_PROGRESS_CODE,\r
      EFI_SOFTWARE_PEI_CORE | EFI_SW_PC_INIT\r
      );\r
\r
    PERF_START (NULL,"PEI", NULL, mTick);\r
    //\r
    // If first pass, start performance measurement.\r
    //\r
    PERF_START (NULL,"PreMem", NULL, mTick);\r
\r
    //\r
    // If SEC provided any PPI services to PEI, install them.\r
    //\r
    if (PpList != NULL) {\r
      Status = PeiServicesInstallPpi (PpList);\r
      ASSERT_EFI_ERROR (Status);\r
    }\r
  }\r
\r
  InitializeSecurityServices (&PrivateData.PS, OldCoreData);\r
\r
  InitializeDispatcherData (&PrivateData, OldCoreData, SecCoreData);\r
\r
  //\r
  // Install Pei Load File PPI. \r
  //\r
  InitializeImageServices (&PrivateData, OldCoreData);\r
\r
  //\r
  // Call PEIM dispatcher\r
  //\r
  PeiDispatcher (SecCoreData, &PrivateData);\r
\r
  //\r
  // Check if InstallPeiMemory service was called.\r
  //\r
  ASSERT(PrivateData.PeiMemoryInstalled == TRUE);\r
\r
  PERF_END (NULL, "PostMem", NULL, 0);\r
\r
  Status = PeiServicesLocatePpi (\r
             &gEfiDxeIplPpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&TempPtr.DxeIpl\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  DEBUG ((EFI_D_INFO, "DXE IPL Entry\n"));\r
  Status = TempPtr.DxeIpl->Entry (\r
                             TempPtr.DxeIpl,\r
                             &PrivateData.PS,\r
                             PrivateData.HobList\r
                             );\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
Commit	Line	Data
192f6d4c	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation\r
	4	All rights reserved. This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	Module Name:\r
	13	\r
	14	PeiMain.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	Pei Core Main Entry Point\r
	19	\r
	20	Revision History\r
	21	\r
	22	--*/\r
	23	\r
192f6d4c	24	#include <PeiMain.h>\r
	25	\r
	26	//\r
	27	//CAR is filled with this initial value during SEC phase\r
	28	//\r
	29	#define INIT_CAR_VALUE 0x5AA55AA5\r
	30	\r
	31	static EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {\r
	32	(EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	33	&gEfiPeiMemoryDiscoveredPpiGuid,\r
	34	NULL\r
	35	};\r
	36	\r
	37	//\r
	38	// Pei Core Module Variables\r
	39	//\r
	40	//\r
	41	static EFI_PEI_SERVICES mPS = {\r
	42	{\r
	43	PEI_SERVICES_SIGNATURE,\r
	44	PEI_SERVICES_REVISION,\r
	45	sizeof (EFI_PEI_SERVICES),\r
	46	0,\r
	47	0\r
	48	},\r
	49	PeiInstallPpi,\r
	50	PeiReInstallPpi,\r
	51	PeiLocatePpi,\r
	52	PeiNotifyPpi,\r
	53	\r
	54	PeiGetBootMode,\r
	55	PeiSetBootMode,\r
	56	\r
	57	PeiGetHobList,\r
	58	PeiCreateHob,\r
	59	\r
	60	PeiFvFindNextVolume,\r
	61	PeiFfsFindNextFile,\r
	62	PeiFfsFindSectionData,\r
	63	\r
b0d803fe	64	PeiInstallPeiMemory, \r
192f6d4c	65	PeiAllocatePages,\r
	66	PeiAllocatePool,\r
	67	(EFI_PEI_COPY_MEM)CopyMem,\r
	68	(EFI_PEI_SET_MEM)SetMem,\r
	69	\r
	70	PeiReportStatusCode,\r
14e8823a	71	PeiResetSystem,\r
b0d803fe	72	\r
14e8823a	73	NULL,\r
14e8823a	74	NULL,\r
b0d803fe	75	\r
	76	PeiFfsFindFileByName,\r
	77	PeiFfsGetFileInfo,\r
	78	PeiFfsGetVolumeInfo,\r
14e8823a	79	PeiRegisterForShadow\r
192f6d4c	80	};\r
	81	\r
	82	EFI_STATUS\r
	83	EFIAPI\r
	84	PeiCore (\r
5aae0aa7	85	IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
b0d803fe	86	IN CONST EFI_PEI_PPI_DESCRIPTOR *PpList,\r
5aae0aa7	87	IN VOID *Data\r
192f6d4c	88	)\r
	89	/*++\r
	90	\r
	91	Routine Description:\r
	92	\r
	93	The entry routine to Pei Core, invoked by PeiMain during transition\r
	94	from SEC to PEI. After switching stack in the PEI core, it will restart\r
	95	with the old core data.\r
	96	\r
	97	Arguments:\r
	98	\r
5aae0aa7	99	SecCoreData - Points to a data structure containing information about the PEI core's operating\r
	100	environment, such as the size and location of temporary RAM, the stack location and\r
	101	the BFV location.\r
	102	PpiList - Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
	103	An empty PPI list consists of a single descriptor with the end-tag\r
	104	EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r
	105	phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such\r
	106	that both the PEI Foundation and any modules can leverage the associated service\r
	107	calls and/or code in these early PPIs\r
	108	Data - Pointer to old core data that is used to initialize the\r
192f6d4c	109	core's data areas.\r
	110	\r
	111	Returns:\r
	112	\r
	113	This function never returns\r
	114	EFI_NOT_FOUND - Never reach\r
	115	\r
	116	--*/\r
	117	{\r
	118	PEI_CORE_INSTANCE PrivateData;\r
	119	EFI_STATUS Status;\r
	120	PEI_CORE_TEMP_POINTERS TempPtr;\r
192f6d4c	121	UINT64 mTick;\r
192f6d4c	122	PEI_CORE_INSTANCE *OldCoreData;\r
b0d803fe	123	EFI_PEI_CPU_IO_PPI *CpuIo;\r
b0d803fe	124	EFI_PEI_PCI_CFG2_PPI *PciCfg;\r
192f6d4c	125	\r
	126	mTick = 0;\r
	127	OldCoreData = (PEI_CORE_INSTANCE *) Data;\r
	128	\r
	129	if (PerformanceMeasurementEnabled()) {\r
	130	if (OldCoreData == NULL) {\r
	131	mTick = GetPerformanceCounter ();\r
	132	}\r
	133	}\r
	134	\r
	135	//\r
	136	// For IPF in CAR mode the real memory access is uncached,in InstallPeiMemory()\r
	137	// the 63-bit of address is set to 1.\r
	138	//\r
	139	SWITCH_TO_CACHE_MODE (OldCoreData);\r
	140	\r
	141	if (OldCoreData != NULL) {\r
	142	CopyMem (&PrivateData, OldCoreData, sizeof (PEI_CORE_INSTANCE));\r
b0d803fe	143	\r
	144	CpuIo = (VOID*)PrivateData.ServiceTableShadow.CpuIo;\r
	145	PciCfg = (VOID*)PrivateData.ServiceTableShadow.PciCfg;\r
	146	\r
	147	CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));\r
	148	\r
	149	PrivateData.ServiceTableShadow.CpuIo = CpuIo;\r
	150	PrivateData.ServiceTableShadow.PciCfg = PciCfg;\r
192f6d4c	151	} else {\r
192f6d4c	152	ZeroMem (&PrivateData, sizeof (PEI_CORE_INSTANCE));\r
b0d803fe	153	PrivateData.Signature = PEI_CORE_HANDLE_SIGNATURE;\r
b0d803fe	154	CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));\r
192f6d4c	155	}\r
192f6d4c	156	\r
b0d803fe	157	PrivateData.PS = &PrivateData.ServiceTableShadow;\r
192f6d4c	158	\r
	159	//\r
	160	// Initialize libraries that the PeiCore is linked against\r
b0d803fe	161	// BUGBUG: The FileHandle is passed in as NULL. Do we look it up or remove it from the lib init?\r
192f6d4c	162	//\r
	163	ProcessLibraryConstructorList (NULL, &PrivateData.PS);\r
	164	\r
b0d803fe	165	InitializeMemoryServices (&PrivateData, SecCoreData, OldCoreData);\r
192f6d4c	166	\r
b0d803fe	167	InitializePpiServices (&PrivateData, OldCoreData);\r
192f6d4c	168	\r
	169	if (OldCoreData != NULL) {\r
	170	\r
	171	PERF_END (NULL,"PreMem", NULL, 0);\r
	172	PERF_START (NULL,"PostMem", NULL, 0);\r
	173	\r
	174	//\r
	175	// The following code dumps out interesting cache as RAM usage information\r
	176	// so we can keep tabs on how the cache as RAM is being utilized. The\r
	177	// DEBUG_CODE_BEGIN macro is used to prevent this code from being compiled\r
	178	// on a debug build.\r
	179	//\r
	180	DEBUG_CODE_BEGIN ();\r
	181	UINTN *StackPointer;\r
	182	UINTN StackValue;\r
	183	\r
	184	StackValue = INIT_CAR_VALUE;\r
	185	for (StackPointer = (UINTN *) OldCoreData->MaxTopOfCarHeap;\r
	186	((UINTN) StackPointer < ((UINTN) OldCoreData->BottomOfCarHeap + OldCoreData->SizeOfCacheAsRam))\r
	187	&& StackValue == INIT_CAR_VALUE;\r
	188	StackPointer++) {\r
	189	StackValue = *StackPointer;\r
	190	}\r
	191	\r
	192	DEBUG ((EFI_D_INFO, "Total Cache as RAM: %d bytes.\n", OldCoreData->SizeOfCacheAsRam));\r
	193	DEBUG ((EFI_D_INFO, " CAR stack ever used: %d bytes.\n",\r
	194	((UINTN) OldCoreData->TopOfCarHeap - (UINTN) StackPointer)\r
	195	));\r
	196	DEBUG ((EFI_D_INFO, " CAR heap used: %d bytes.\n",\r
	197	((UINTN) OldCoreData->HobList.HandoffInformationTable->EfiFreeMemoryBottom -\r
	198	(UINTN) OldCoreData->HobList.Raw)\r
	199	));\r
	200	DEBUG_CODE_END ();\r
	201	\r
	202	//\r
	203	// Alert any listeners that there is permanent memory available\r
	204	//\r
	205	\r
	206	PERF_START (NULL,"DisMem", NULL, 0);\r
	207	Status = PeiServicesInstallPpi (&mMemoryDiscoveredPpi);\r
	208	PERF_END (NULL,"DisMem", NULL, 0);\r
	209	\r
	210	} else {\r
	211	\r
	212	//\r
	213	// Report Status Code EFI_SW_PC_INIT\r
	214	//\r
	215	REPORT_STATUS_CODE (\r
	216	EFI_PROGRESS_CODE,\r
	217	EFI_SOFTWARE_PEI_CORE \| EFI_SW_PC_INIT\r
	218	);\r
	219	\r
	220	PERF_START (NULL,"PEI", NULL, mTick);\r
	221	//\r
	222	// If first pass, start performance measurement.\r
	223	//\r
	224	PERF_START (NULL,"PreMem", NULL, mTick);\r
	225	\r
	226	//\r
	227	// If SEC provided any PPI services to PEI, install them.\r
	228	//\r
b0d803fe	229	if (PpList != NULL) {\r
b0d803fe	230	Status = PeiServicesInstallPpi (PpList);\r
192f6d4c	231	ASSERT_EFI_ERROR (Status);\r
	232	}\r
	233	}\r
	234	\r
b0d803fe	235	InitializeSecurityServices (&PrivateData.PS, OldCoreData);\r
	236	\r
	237	InitializeDispatcherData (&PrivateData, OldCoreData, SecCoreData);\r
	238	\r
	239	//\r
	240	// Install Pei Load File PPI. \r
	241	//\r
	242	InitializeImageServices (&PrivateData, OldCoreData);\r
192f6d4c	243	\r
	244	//\r
	245	// Call PEIM dispatcher\r
	246	//\r
b0d803fe	247	PeiDispatcher (SecCoreData, &PrivateData);\r
192f6d4c	248	\r
	249	//\r
	250	// Check if InstallPeiMemory service was called.\r
	251	//\r
	252	ASSERT(PrivateData.PeiMemoryInstalled == TRUE);\r
	253	\r
	254	PERF_END (NULL, "PostMem", NULL, 0);\r
	255	\r
	256	Status = PeiServicesLocatePpi (\r
	257	&gEfiDxeIplPpiGuid,\r
	258	0,\r
	259	NULL,\r
	260	(VOID **)&TempPtr.DxeIpl\r
	261	);\r
	262	ASSERT_EFI_ERROR (Status);\r
	263	\r
	264	DEBUG ((EFI_D_INFO, "DXE IPL Entry\n"));\r
	265	Status = TempPtr.DxeIpl->Entry (\r
	266	TempPtr.DxeIpl,\r
	267	&PrivateData.PS,\r
	268	PrivateData.HobList\r
	269	);\r
	270	\r
	271	ASSERT_EFI_ERROR (Status);\r
	272	\r
	273	return EFI_NOT_FOUND;\r
	274	}\r
	275	\r