[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / PiSmmCore.c

/** @file\r
  SMM Core Main Entry Point\r
\r
  Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials are licensed and made available \r
  under the terms and conditions of the BSD License which accompanies this \r
  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 "PiSmmCore.h"\r
\r
//\r
// Physical pointer to private structure shared between SMM IPL and the SMM Core\r
//\r
SMM_CORE_PRIVATE_DATA  *gSmmCorePrivate;\r
\r
//\r
// SMM Core global variable for SMM System Table.  Only accessed as a physical structure in SMRAM.\r
//\r
EFI_SMM_SYSTEM_TABLE2  gSmmCoreSmst = {\r
  {\r
    SMM_SMST_SIGNATURE,\r
    EFI_SMM_SYSTEM_TABLE2_REVISION,\r
    sizeof (gSmmCoreSmst.Hdr)\r
  },\r
  NULL,                          // SmmFirmwareVendor\r
  0,                             // SmmFirmwareRevision\r
  SmmInstallConfigurationTable,\r
  {\r
    {\r
      (EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5,       // SmmMemRead\r
      (EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5        // SmmMemWrite\r
    },\r
    {\r
      (EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5,       // SmmIoRead\r
      (EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5        // SmmIoWrite\r
    }\r
  },\r
  SmmAllocatePool,\r
  SmmFreePool,\r
  SmmAllocatePages,\r
  SmmFreePages,\r
  NULL,                          // SmmStartupThisAp\r
  0,                             // CurrentlyExecutingCpu\r
  0,                             // NumberOfCpus\r
  NULL,                          // CpuSaveStateSize\r
  NULL,                          // CpuSaveState\r
  0,                             // NumberOfTableEntries\r
  NULL,                          // SmmConfigurationTable\r
  SmmInstallProtocolInterface,\r
  SmmUninstallProtocolInterface,\r
  SmmHandleProtocol,\r
  SmmRegisterProtocolNotify,\r
  SmmLocateHandle,\r
  SmmLocateProtocol,\r
  SmiManage,\r
  SmiHandlerRegister,\r
  SmiHandlerUnRegister\r
};\r
\r
//\r
// Flag to determine if the platform has performed a legacy boot.\r
// If this flag is TRUE, then the runtime code and runtime data associated with the \r
// SMM IPL are converted to free memory, so the SMM COre must guarantee that is\r
// does not touch of the code/data associated with the SMM IPL if this flag is TRUE.\r
//\r
BOOLEAN  mInLegacyBoot = FALSE;\r
\r
//\r
// Table of SMI Handlers that are registered by the SMM Core when it is initialized\r
//\r
SMM_CORE_SMI_HANDLERS  mSmmCoreSmiHandlers[] = {\r
  { SmmDriverDispatchHandler, &gEfiEventDxeDispatchGuid,          NULL, TRUE  },\r
  { SmmReadyToLockHandler,    &gEfiDxeSmmReadyToLockProtocolGuid, NULL, TRUE }, \r
  { SmmLegacyBootHandler,     &gEfiEventLegacyBootGuid,           NULL, FALSE },\r
  { NULL,                     NULL,                               NULL, FALSE }\r
};\r
\r
/**\r
  Place holder function until all the SMM System Table Service are available.\r
\r
  Note: This function is only used by SMRAM invocation.  It is never used by DXE invocation.\r
\r
  @param  Arg1                   Undefined\r
  @param  Arg2                   Undefined\r
  @param  Arg3                   Undefined\r
  @param  Arg4                   Undefined\r
  @param  Arg5                   Undefined\r
\r
  @return EFI_NOT_AVAILABLE_YET\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmEfiNotAvailableYetArg5 (\r
  UINTN Arg1,\r
  UINTN Arg2,\r
  UINTN Arg3,\r
  UINTN Arg4,\r
  UINTN Arg5\r
  )\r
{\r
  //\r
  // This function should never be executed.  If it does, then the architectural protocols\r
  // have not been designed correctly.\r
  //\r
  return EFI_NOT_AVAILABLE_YET;\r
}\r
\r
/**\r
  Software SMI handler that is called when a Legacy Boot event is signalled.  The SMM\r
  Core uses this signal to know that a Legacy Boot has been performed and that \r
  gSmmCorePrivate that is shared between the UEFI and SMM execution environments can\r
  not be accessed from SMM anymore since that structure is considered free memory by\r
  a legacy OS.\r
\r
  @param  DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().\r
  @param  Context         Points to an optional handler context which was specified when the handler was registered.\r
  @param  CommBuffer      A pointer to a collection of data in memory that will\r
                          be conveyed from a non-SMM environment into an SMM environment.\r
  @param  CommBufferSize  The size of the CommBuffer.\r
\r
  @return Status Code\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmLegacyBootHandler (\r
  IN     EFI_HANDLE  DispatchHandle,\r
  IN     CONST VOID  *Context,        OPTIONAL\r
  IN OUT VOID        *CommBuffer,     OPTIONAL\r
  IN OUT UINTN       *CommBufferSize  OPTIONAL\r
  )\r
{\r
  mInLegacyBoot = TRUE;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Software SMI handler that is called when the DxeSmmReadyToLock protocol is added\r
  or if gEfiEventReadyToBootGuid is signalled.  This function unregisters the \r
  Software SMIs that are nor required after SMRAM is locked and installs the \r
  SMM Ready To Lock Protocol so SMM Drivers are informed that SMRAM is about \r
  to be locked.  It also verifies the the SMM CPU I/O 2 Protocol has been installed\r
  and NULLs gBS and gST because they can not longer be used after SMRAM is locked.\r
\r
  @param  DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().\r
  @param  Context         Points to an optional handler context which was specified when the handler was registered.\r
  @param  CommBuffer      A pointer to a collection of data in memory that will\r
                          be conveyed from a non-SMM environment into an SMM environment.\r
  @param  CommBufferSize  The size of the CommBuffer.\r
\r
  @return Status Code\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmReadyToLockHandler (\r
  IN     EFI_HANDLE  DispatchHandle,\r
  IN     CONST VOID  *Context,        OPTIONAL\r
  IN OUT VOID        *CommBuffer,     OPTIONAL\r
  IN OUT UINTN       *CommBufferSize  OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       Index;\r
  EFI_HANDLE  SmmHandle;\r
  VOID        *Interface;\r
\r
  //\r
  // Unregister SMI Handlers that are no required after the SMM driver dispatch is stopped\r
  //\r
  for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
    if (mSmmCoreSmiHandlers[Index].UnRegister) {\r
      SmiHandlerUnRegister (mSmmCoreSmiHandlers[Index].DispatchHandle);\r
    }\r
  }\r
\r
  //\r
  // Install SMM Ready to lock protocol\r
  //\r
  SmmHandle = NULL;\r
  Status = SmmInstallProtocolInterface (\r
             &SmmHandle,\r
             &gEfiSmmReadyToLockProtocolGuid,\r
             EFI_NATIVE_INTERFACE,\r
             NULL\r
             );\r
\r
  //\r
  // Make sure SMM CPU I/O 2 Procol has been installed into the handle database\r
  //\r
  Status = SmmLocateProtocol (&gEfiSmmCpuIo2ProtocolGuid, NULL, &Interface);\r
\r
  //\r
  // Print a message on a debug build if the SMM CPU I/O 2 Protocol is not installed\r
  //\r
  DEBUG_CODE_BEGIN ();\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "\nSMM: SmmCpuIo Arch Protocol not present!!\n"));\r
    }\r
  DEBUG_CODE_END ();\r
\r
  //\r
  // Assert if the CPU I/O 2 Protocol is not installed\r
  //\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Display any drivers that were not dispatched because dependency expression\r
  // evaluated to false if this is a debug build\r
  //\r
  DEBUG_CODE_BEGIN ();\r
    SmmDisplayDiscoveredNotDispatched ();\r
  DEBUG_CODE_END ();\r
\r
  //\r
  // Not allowed to use gST or gBS after lock\r
  //\r
  gST = NULL;\r
  gBS = NULL;\r
\r
  return Status;\r
}\r
\r
/**\r
  The main entry point to SMM Foundation.\r
\r
  Note: This function is only used by SMRAM invocation.  It is never used by DXE invocation.\r
\r
  @param  SmmEntryContext           Processor information and functionality\r
                                    needed by SMM Foundation.\r
\r
**/\r
VOID\r
EFIAPI\r
SmmEntryPoint (\r
  IN CONST EFI_SMM_ENTRY_CONTEXT  *SmmEntryContext\r
)\r
{\r
  EFI_STATUS                  Status;\r
  EFI_SMM_COMMUNICATE_HEADER  *CommunicateHeader;\r
\r
  PERF_START (NULL, "SMM", NULL, 0) ;\r
\r
  //\r
  // Update SMST using the context\r
  //\r
  CopyMem (&gSmmCoreSmst.SmmStartupThisAp, SmmEntryContext, sizeof (EFI_SMM_ENTRY_CONTEXT));\r
\r
  //\r
  // Call platform hook before Smm Dispatch\r
  //\r
  PlatformHookBeforeSmmDispatch ();\r
\r
  //\r
  // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed\r
  //\r
  if (mInLegacyBoot) {\r
    //\r
    // Asynchronous SMI\r
    //\r
    SmiManage (NULL, NULL, NULL, NULL);\r
    return;\r
  }\r
\r
  //\r
  // Mark the InSmm flag as TRUE, it will be used by SmmBase2 protocol\r
  //\r
  gSmmCorePrivate->InSmm = TRUE;\r
\r
  //\r
  // Check to see if this is a Synchronous SMI sent through the SMM Communication \r
  // Protocol or an Asynchronous SMI\r
  //\r
  if (gSmmCorePrivate->CommunicationBuffer != NULL) {\r
    //\r
    // Synchronous SMI for SMM Core or request from Communicate protocol\r
    //\r
    CommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)gSmmCorePrivate->CommunicationBuffer;\r
    gSmmCorePrivate->BufferSize -= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
    Status = SmiManage (\r
               &CommunicateHeader->HeaderGuid, \r
               NULL, \r
               CommunicateHeader->Data, \r
               &gSmmCorePrivate->BufferSize\r
               );\r
\r
    //\r
    // Update CommunicationBuffer, BufferSize and ReturnStatus\r
    // Communicate service finished, reset the pointer to CommBuffer to NULL\r
    //\r
    gSmmCorePrivate->BufferSize += OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
    gSmmCorePrivate->CommunicationBuffer = NULL;\r
    gSmmCorePrivate->ReturnStatus = (Status == EFI_SUCCESS) ? EFI_SUCCESS : EFI_NOT_FOUND;\r
  } else {\r
    //\r
    // Asynchronous SMI\r
    //\r
    SmiManage (NULL, NULL, NULL, NULL);\r
  }\r
  \r
  //\r
  // Call platform hook after Smm Dispatch\r
  //\r
  PlatformHookAfterSmmDispatch ();\r
\r
  //\r
  // Clear the InSmm flag as we are going to leave SMM\r
  //\r
  gSmmCorePrivate->InSmm = FALSE;\r
\r
  PERF_END (NULL, "SMM", NULL, 0) ;\r
}\r
\r
/**\r
  The Entry Point for SMM Core\r
\r
  Install DXE Protocols and reload SMM Core into SMRAM and register SMM Core \r
  EntryPoint on the SMI vector.\r
\r
  Note: This function is called for both DXE invocation and SMRAM invocation.\r
\r
  @param  ImageHandle    The firmware allocated handle for the EFI image.\r
  @param  SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS    The entry point is executed successfully.\r
  @retval Other          Some error occurred when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmMain (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       Index;\r
\r
  //\r
  // Get SMM Core Private context passed in from SMM IPL in ImageHandle.\r
  //\r
  gSmmCorePrivate = (SMM_CORE_PRIVATE_DATA *)ImageHandle;\r
\r
  //\r
  // Fill in SMRAM physical address for the SMM Services Table and the SMM Entry Point.\r
  //\r
  gSmmCorePrivate->Smst          = &gSmmCoreSmst;\r
  gSmmCorePrivate->SmmEntryPoint = SmmEntryPoint;\r
  \r
  //\r
  // Initialize memory service using free SMRAM\r
  //\r
  SmmInitializeMemoryServices (gSmmCorePrivate->SmramRangeCount, gSmmCorePrivate->SmramRanges);\r
\r
  //\r
  // Register all SMI Handlers required by the SMM Core\r
  //\r
  for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
    Status = SmiHandlerRegister (\r
               mSmmCoreSmiHandlers[Index].Handler,\r
               mSmmCoreSmiHandlers[Index].HandlerType,\r
               &mSmmCoreSmiHandlers[Index].DispatchHandle\r
               );\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
e42e9404	1	/** @file\r
	2	SMM Core Main Entry Point\r
	3	\r
d5b339a9	4	Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
e42e9404	5	This program and the accompanying materials are licensed and made available \r
	6	under the terms and conditions of the BSD License which accompanies this \r
	7	distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	**/\r
	14	\r
	15	#include "PiSmmCore.h"\r
	16	\r
	17	//\r
	18	// Physical pointer to private structure shared between SMM IPL and the SMM Core\r
	19	//\r
	20	SMM_CORE_PRIVATE_DATA *gSmmCorePrivate;\r
	21	\r
	22	//\r
	23	// SMM Core global variable for SMM System Table. Only accessed as a physical structure in SMRAM.\r
	24	//\r
	25	EFI_SMM_SYSTEM_TABLE2 gSmmCoreSmst = {\r
	26	{\r
	27	SMM_SMST_SIGNATURE,\r
	28	EFI_SMM_SYSTEM_TABLE2_REVISION,\r
	29	sizeof (gSmmCoreSmst.Hdr)\r
	30	},\r
	31	NULL, // SmmFirmwareVendor\r
	32	0, // SmmFirmwareRevision\r
	33	SmmInstallConfigurationTable,\r
	34	{\r
	35	{\r
	36	(EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5, // SmmMemRead\r
	37	(EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5 // SmmMemWrite\r
	38	},\r
	39	{\r
	40	(EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5, // SmmIoRead\r
	41	(EFI_SMM_CPU_IO2) SmmEfiNotAvailableYetArg5 // SmmIoWrite\r
	42	}\r
	43	},\r
	44	SmmAllocatePool,\r
	45	SmmFreePool,\r
	46	SmmAllocatePages,\r
	47	SmmFreePages,\r
	48	NULL, // SmmStartupThisAp\r
	49	0, // CurrentlyExecutingCpu\r
	50	0, // NumberOfCpus\r
	51	NULL, // CpuSaveStateSize\r
	52	NULL, // CpuSaveState\r
	53	0, // NumberOfTableEntries\r
	54	NULL, // SmmConfigurationTable\r
	55	SmmInstallProtocolInterface,\r
	56	SmmUninstallProtocolInterface,\r
	57	SmmHandleProtocol,\r
	58	SmmRegisterProtocolNotify,\r
	59	SmmLocateHandle,\r
	60	SmmLocateProtocol,\r
	61	SmiManage,\r
	62	SmiHandlerRegister,\r
	63	SmiHandlerUnRegister\r
	64	};\r
	65	\r
	66	//\r
	67	// Flag to determine if the platform has performed a legacy boot.\r
	68	// If this flag is TRUE, then the runtime code and runtime data associated with the \r
69	// SMM IPL are converted to free memory, so the SMM COre must guarantee that is\r
70	// does not touch of the code/data associated with the SMM IPL if this flag is TRUE.\r
71	//\r
72	BOOLEAN mInLegacyBoot = FALSE;\r
73	\r
74	//\r
75	// Table of SMI Handlers that are registered by the SMM Core when it is initialized\r
76	//\r
77	SMM_CORE_SMI_HANDLERS mSmmCoreSmiHandlers[] = {\r
78	{ SmmDriverDispatchHandler, &gEfiEventDxeDispatchGuid, NULL, TRUE },\r
d5c3d1be	79	{ SmmReadyToLockHandler, &gEfiDxeSmmReadyToLockProtocolGuid, NULL, TRUE }, \r
e42e9404	80	{ SmmLegacyBootHandler, &gEfiEventLegacyBootGuid, NULL, FALSE },\r
	81	{ NULL, NULL, NULL, FALSE }\r
	82	};\r
	83	\r
	84	/**\r
	85	Place holder function until all the SMM System Table Service are available.\r
	86	\r
	87	Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.\r
	88	\r
	89	@param Arg1 Undefined\r
	90	@param Arg2 Undefined\r
	91	@param Arg3 Undefined\r
	92	@param Arg4 Undefined\r
	93	@param Arg5 Undefined\r
	94	\r
	95	@return EFI_NOT_AVAILABLE_YET\r
	96	\r
	97	**/\r
	98	EFI_STATUS\r
	99	EFIAPI\r
	100	SmmEfiNotAvailableYetArg5 (\r
	101	UINTN Arg1,\r
	102	UINTN Arg2,\r
	103	UINTN Arg3,\r
	104	UINTN Arg4,\r
	105	UINTN Arg5\r
	106	)\r
	107	{\r
	108	//\r
	109	// This function should never be executed. If it does, then the architectural protocols\r
	110	// have not been designed correctly.\r
	111	//\r
	112	return EFI_NOT_AVAILABLE_YET;\r
	113	}\r
	114	\r
	115	/**\r
	116	Software SMI handler that is called when a Legacy Boot event is signalled. The SMM\r
	117	Core uses this signal to know that a Legacy Boot has been performed and that \r
	118	gSmmCorePrivate that is shared between the UEFI and SMM execution environments can\r
	119	not be accessed from SMM anymore since that structure is considered free memory by\r
	120	a legacy OS.\r
	121	\r
	122	@param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r
	123	@param Context Points to an optional handler context which was specified when the handler was registered.\r
	124	@param CommBuffer A pointer to a collection of data in memory that will\r
	125	be conveyed from a non-SMM environment into an SMM environment.\r
	126	@param CommBufferSize The size of the CommBuffer.\r
	127	\r
	128	@return Status Code\r
	129	\r
	130	**/\r
	131	EFI_STATUS\r
	132	EFIAPI\r
	133	SmmLegacyBootHandler (\r
	134	IN EFI_HANDLE DispatchHandle,\r
	135	IN CONST VOID *Context, OPTIONAL\r
	136	IN OUT VOID *CommBuffer, OPTIONAL\r
	137	IN OUT UINTN *CommBufferSize OPTIONAL\r
	138	)\r
	139	{\r
	140	mInLegacyBoot = TRUE;\r
	141	return EFI_SUCCESS;\r
	142	}\r
	143	\r
144	/**\r
145	Software SMI handler that is called when the DxeSmmReadyToLock protocol is added\r
146	or if gEfiEventReadyToBootGuid is signalled. This function unregisters the \r
147	Software SMIs that are nor required after SMRAM is locked and installs the \r
148	SMM Ready To Lock Protocol so SMM Drivers are informed that SMRAM is about \r
149	to be locked. It also verifies the the SMM CPU I/O 2 Protocol has been installed\r
150	and NULLs gBS and gST because they can not longer be used after SMRAM is locked.\r
151	\r
152	@param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r
153	@param Context Points to an optional handler context which was specified when the handler was registered.\r
154	@param CommBuffer A pointer to a collection of data in memory that will\r
155	be conveyed from a non-SMM environment into an SMM environment.\r
156	@param CommBufferSize The size of the CommBuffer.\r
157	\r
158	@return Status Code\r
159	\r
160	**/\r
161	EFI_STATUS\r
162	EFIAPI\r
163	SmmReadyToLockHandler (\r
164	IN EFI_HANDLE DispatchHandle,\r
165	IN CONST VOID *Context, OPTIONAL\r
166	IN OUT VOID *CommBuffer, OPTIONAL\r
167	IN OUT UINTN *CommBufferSize OPTIONAL\r
168	)\r
169	{\r
170	EFI_STATUS Status;\r
171	UINTN Index;\r
172	EFI_HANDLE SmmHandle;\r
173	VOID *Interface;\r
174	\r
175	//\r
176	// Unregister SMI Handlers that are no required after the SMM driver dispatch is stopped\r
177	//\r
178	for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
179	if (mSmmCoreSmiHandlers[Index].UnRegister) {\r
180	SmiHandlerUnRegister (mSmmCoreSmiHandlers[Index].DispatchHandle);\r
181	}\r
182	}\r
183	\r
184	//\r
185	// Install SMM Ready to lock protocol\r
186	//\r
187	SmmHandle = NULL;\r
188	Status = SmmInstallProtocolInterface (\r
189	&SmmHandle,\r
190	&gEfiSmmReadyToLockProtocolGuid,\r
191	EFI_NATIVE_INTERFACE,\r
192	NULL\r
193	);\r
194	\r
195	//\r
196	// Make sure SMM CPU I/O 2 Procol has been installed into the handle database\r
197	//\r
198	Status = SmmLocateProtocol (&gEfiSmmCpuIo2ProtocolGuid, NULL, &Interface);\r
199	\r
200	//\r
201	// Print a message on a debug build if the SMM CPU I/O 2 Protocol is not installed\r
202	//\r
203	DEBUG_CODE_BEGIN ();\r
204	if (EFI_ERROR (Status)) {\r
205	DEBUG ((DEBUG_ERROR, "\nSMM: SmmCpuIo Arch Protocol not present!!\n"));\r
206	}\r
207	DEBUG_CODE_END ();\r
208	\r
209	//\r
210	// Assert if the CPU I/O 2 Protocol is not installed\r
211	//\r
212	ASSERT_EFI_ERROR (Status);\r
213	\r
214	//\r
215	// Display any drivers that were not dispatched because dependency expression\r
216	// evaluated to false if this is a debug build\r
217	//\r
218	DEBUG_CODE_BEGIN ();\r
219	SmmDisplayDiscoveredNotDispatched ();\r
220	DEBUG_CODE_END ();\r
221	\r
222	//\r
223	// Not allowed to use gST or gBS after lock\r
224	//\r
225	gST = NULL;\r
226	gBS = NULL;\r
227	\r
228	return Status;\r
229	}\r
230	\r
231	/**\r
232	The main entry point to SMM Foundation.\r
233	\r
234	Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.\r
235	\r
236	@param SmmEntryContext Processor information and functionality\r
237	needed by SMM Foundation.\r
238	\r
239	**/\r
240	VOID\r
241	EFIAPI\r
242	SmmEntryPoint (\r
243	IN CONST EFI_SMM_ENTRY_CONTEXT *SmmEntryContext\r
244	)\r
245	{\r
246	EFI_STATUS Status;\r
247	EFI_SMM_COMMUNICATE_HEADER *CommunicateHeader;\r
e42e9404	248	\r
495797c5	249	PERF_START (NULL, "SMM", NULL, 0) ;\r
495797c5	250	\r
e42e9404	251	//\r
	252	// Update SMST using the context\r
	253	//\r
	254	CopyMem (&gSmmCoreSmst.SmmStartupThisAp, SmmEntryContext, sizeof (EFI_SMM_ENTRY_CONTEXT));\r
	255	\r
495797c5	256	//\r
	257	// Call platform hook before Smm Dispatch\r
	258	//\r
	259	PlatformHookBeforeSmmDispatch ();\r
	260	\r
e42e9404	261	//\r
	262	// If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed\r
	263	//\r
	264	if (mInLegacyBoot) {\r
	265	//\r
	266	// Asynchronous SMI\r
	267	//\r
	268	SmiManage (NULL, NULL, NULL, NULL);\r
	269	return;\r
	270	}\r
	271	\r
	272	//\r
3c5963cf	273	// Mark the InSmm flag as TRUE, it will be used by SmmBase2 protocol\r
e42e9404	274	//\r
e42e9404	275	gSmmCorePrivate->InSmm = TRUE;\r
	276	\r
	277	//\r
	278	// Check to see if this is a Synchronous SMI sent through the SMM Communication \r
	279	// Protocol or an Asynchronous SMI\r
	280	//\r
	281	if (gSmmCorePrivate->CommunicationBuffer != NULL) {\r
	282	//\r
	283	// Synchronous SMI for SMM Core or request from Communicate protocol\r
	284	//\r
	285	CommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)gSmmCorePrivate->CommunicationBuffer;\r
ab780ebf	286	gSmmCorePrivate->BufferSize -= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
e42e9404	287	Status = SmiManage (\r
	288	&CommunicateHeader->HeaderGuid, \r
	289	NULL, \r
	290	CommunicateHeader->Data, \r
ab780ebf	291	&gSmmCorePrivate->BufferSize\r
e42e9404	292	);\r
	293	\r
	294	//\r
	295	// Update CommunicationBuffer, BufferSize and ReturnStatus\r
	296	// Communicate service finished, reset the pointer to CommBuffer to NULL\r
	297	//\r
ab780ebf	298	gSmmCorePrivate->BufferSize += OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
e42e9404	299	gSmmCorePrivate->CommunicationBuffer = NULL;\r
d5b339a9	300	gSmmCorePrivate->ReturnStatus = (Status == EFI_SUCCESS) ? EFI_SUCCESS : EFI_NOT_FOUND;\r
e42e9404	301	} else {\r
	302	//\r
	303	// Asynchronous SMI\r
	304	//\r
	305	SmiManage (NULL, NULL, NULL, NULL);\r
	306	}\r
495797c5	307	\r
	308	//\r
	309	// Call platform hook after Smm Dispatch\r
	310	//\r
	311	PlatformHookAfterSmmDispatch ();\r
e42e9404	312	\r
e42e9404	313	//\r
3c5963cf	314	// Clear the InSmm flag as we are going to leave SMM\r
e42e9404	315	//\r
3c5963cf	316	gSmmCorePrivate->InSmm = FALSE;\r
495797c5	317	\r
495797c5	318	PERF_END (NULL, "SMM", NULL, 0) ;\r
e42e9404	319	}\r
	320	\r
	321	/**\r
	322	The Entry Point for SMM Core\r
	323	\r
	324	Install DXE Protocols and reload SMM Core into SMRAM and register SMM Core \r
	325	EntryPoint on the SMI vector.\r
	326	\r
	327	Note: This function is called for both DXE invocation and SMRAM invocation.\r
	328	\r
	329	@param ImageHandle The firmware allocated handle for the EFI image.\r
	330	@param SystemTable A pointer to the EFI System Table.\r
	331	\r
	332	@retval EFI_SUCCESS The entry point is executed successfully.\r
	333	@retval Other Some error occurred when executing this entry point.\r
	334	\r
	335	**/\r
	336	EFI_STATUS\r
	337	EFIAPI\r
	338	SmmMain (\r
	339	IN EFI_HANDLE ImageHandle,\r
	340	IN EFI_SYSTEM_TABLE *SystemTable\r
	341	)\r
	342	{\r
	343	EFI_STATUS Status;\r
	344	UINTN Index;\r
	345	\r
	346	//\r
	347	// Get SMM Core Private context passed in from SMM IPL in ImageHandle.\r
	348	//\r
	349	gSmmCorePrivate = (SMM_CORE_PRIVATE_DATA *)ImageHandle;\r
	350	\r
	351	//\r
	352	// Fill in SMRAM physical address for the SMM Services Table and the SMM Entry Point.\r
	353	//\r
	354	gSmmCorePrivate->Smst = &gSmmCoreSmst;\r
	355	gSmmCorePrivate->SmmEntryPoint = SmmEntryPoint;\r
	356	\r
	357	//\r
	358	// Initialize memory service using free SMRAM\r
	359	//\r
	360	SmmInitializeMemoryServices (gSmmCorePrivate->SmramRangeCount, gSmmCorePrivate->SmramRanges);\r
	361	\r
	362	//\r
	363	// Register all SMI Handlers required by the SMM Core\r
	364	//\r
	365	for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
	366	Status = SmiHandlerRegister (\r
	367	mSmmCoreSmiHandlers[Index].Handler,\r
	368	mSmmCoreSmiHandlers[Index].HandlerType,\r
	369	&mSmmCoreSmiHandlers[Index].DispatchHandle\r
	370	);\r
	371	ASSERT_EFI_ERROR (Status);\r
	372	}\r
	373	\r
	374	return EFI_SUCCESS;\r
	375	}\r