[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
  { SmmEndOfDxeHandler,       &gEfiEndOfDxeEventGroupGuid,        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
  Software SMI handler that is called when the EndOfDxe event is signalled.\r
  This function installs the SMM EndOfDxe Protocol so SMM Drivers are informed that\r
  platform code will invoke 3rd part code.\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
SmmEndOfDxeHandler (\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
  EFI_HANDLE  SmmHandle;\r
\r
  DEBUG ((EFI_D_INFO, "SmmEndOfDxeHandler\n"));\r
  //\r
  // Install SMM EndOfDxe protocol\r
  //\r
  SmmHandle = NULL;\r
  Status = SmmInstallProtocolInterface (\r
             &SmmHandle,\r
             &gEfiSmmEndOfDxeProtocolGuid,\r
             EFI_NATIVE_INTERFACE,\r
             NULL\r
             );\r
  return EFI_SUCCESS;\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
  BOOLEAN                     InLegacyBoot;\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
  InLegacyBoot = mInLegacyBoot;\r
  if (!InLegacyBoot) {\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
    }\r
  }\r
\r
  //\r
  // Process Asynchronous SMI sources\r
  //\r
  SmiManage (NULL, NULL, NULL, NULL);\r
  \r
  //\r
  // Call platform hook after Smm Dispatch\r
  //\r
  PlatformHookAfterSmmDispatch ();\r
\r
  //\r
  // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed\r
  //\r
  if (!InLegacyBoot) {\r
    //\r
    // Clear the InSmm flag as we are going to leave SMM\r
    //\r
    gSmmCorePrivate->InSmm = FALSE;\r
  }\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
46ece1ff	81	{ SmmEndOfDxeHandler, &gEfiEndOfDxeEventGroupGuid, NULL, FALSE },\r
e42e9404	82	{ NULL, NULL, NULL, FALSE }\r
	83	};\r
	84	\r
	85	/**\r
	86	Place holder function until all the SMM System Table Service are available.\r
	87	\r
	88	Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.\r
	89	\r
	90	@param Arg1 Undefined\r
	91	@param Arg2 Undefined\r
	92	@param Arg3 Undefined\r
	93	@param Arg4 Undefined\r
	94	@param Arg5 Undefined\r
	95	\r
	96	@return EFI_NOT_AVAILABLE_YET\r
	97	\r
	98	**/\r
	99	EFI_STATUS\r
	100	EFIAPI\r
	101	SmmEfiNotAvailableYetArg5 (\r
	102	UINTN Arg1,\r
	103	UINTN Arg2,\r
	104	UINTN Arg3,\r
	105	UINTN Arg4,\r
	106	UINTN Arg5\r
	107	)\r
	108	{\r
	109	//\r
	110	// This function should never be executed. If it does, then the architectural protocols\r
	111	// have not been designed correctly.\r
	112	//\r
	113	return EFI_NOT_AVAILABLE_YET;\r
	114	}\r
	115	\r
	116	/**\r
	117	Software SMI handler that is called when a Legacy Boot event is signalled. The SMM\r
	118	Core uses this signal to know that a Legacy Boot has been performed and that \r
	119	gSmmCorePrivate that is shared between the UEFI and SMM execution environments can\r
	120	not be accessed from SMM anymore since that structure is considered free memory by\r
	121	a legacy OS.\r
	122	\r
	123	@param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r
	124	@param Context Points to an optional handler context which was specified when the handler was registered.\r
	125	@param CommBuffer A pointer to a collection of data in memory that will\r
	126	be conveyed from a non-SMM environment into an SMM environment.\r
	127	@param CommBufferSize The size of the CommBuffer.\r
	128	\r
	129	@return Status Code\r
	130	\r
	131	**/\r
	132	EFI_STATUS\r
	133	EFIAPI\r
	134	SmmLegacyBootHandler (\r
	135	IN EFI_HANDLE DispatchHandle,\r
	136	IN CONST VOID *Context, OPTIONAL\r
	137	IN OUT VOID *CommBuffer, OPTIONAL\r
	138	IN OUT UINTN *CommBufferSize OPTIONAL\r
	139	)\r
	140	{\r
	141	mInLegacyBoot = TRUE;\r
	142	return EFI_SUCCESS;\r
	143	}\r
	144	\r
	145	/**\r
146	Software SMI handler that is called when the DxeSmmReadyToLock protocol is added\r
147	or if gEfiEventReadyToBootGuid is signalled. This function unregisters the \r
148	Software SMIs that are nor required after SMRAM is locked and installs the \r
149	SMM Ready To Lock Protocol so SMM Drivers are informed that SMRAM is about \r
150	to be locked. It also verifies the the SMM CPU I/O 2 Protocol has been installed\r
151	and NULLs gBS and gST because they can not longer be used after SMRAM is locked.\r
152	\r
153	@param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r
154	@param Context Points to an optional handler context which was specified when the handler was registered.\r
155	@param CommBuffer A pointer to a collection of data in memory that will\r
156	be conveyed from a non-SMM environment into an SMM environment.\r
157	@param CommBufferSize The size of the CommBuffer.\r
158	\r
159	@return Status Code\r
160	\r
161	**/\r
162	EFI_STATUS\r
163	EFIAPI\r
164	SmmReadyToLockHandler (\r
165	IN EFI_HANDLE DispatchHandle,\r
166	IN CONST VOID *Context, OPTIONAL\r
167	IN OUT VOID *CommBuffer, OPTIONAL\r
168	IN OUT UINTN *CommBufferSize OPTIONAL\r
169	)\r
170	{\r
171	EFI_STATUS Status;\r
172	UINTN Index;\r
173	EFI_HANDLE SmmHandle;\r
174	VOID *Interface;\r
175	\r
176	//\r
177	// Unregister SMI Handlers that are no required after the SMM driver dispatch is stopped\r
178	//\r
179	for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
180	if (mSmmCoreSmiHandlers[Index].UnRegister) {\r
181	SmiHandlerUnRegister (mSmmCoreSmiHandlers[Index].DispatchHandle);\r
182	}\r
183	}\r
184	\r
185	//\r
186	// Install SMM Ready to lock protocol\r
187	//\r
188	SmmHandle = NULL;\r
189	Status = SmmInstallProtocolInterface (\r
190	&SmmHandle,\r
191	&gEfiSmmReadyToLockProtocolGuid,\r
192	EFI_NATIVE_INTERFACE,\r
193	NULL\r
194	);\r
195	\r
196	//\r
197	// Make sure SMM CPU I/O 2 Procol has been installed into the handle database\r
198	//\r
199	Status = SmmLocateProtocol (&gEfiSmmCpuIo2ProtocolGuid, NULL, &Interface);\r
200	\r
201	//\r
202	// Print a message on a debug build if the SMM CPU I/O 2 Protocol is not installed\r
203	//\r
204	DEBUG_CODE_BEGIN ();\r
205	if (EFI_ERROR (Status)) {\r
206	DEBUG ((DEBUG_ERROR, "\nSMM: SmmCpuIo Arch Protocol not present!!\n"));\r
207	}\r
208	DEBUG_CODE_END ();\r
209	\r
210	//\r
211	// Assert if the CPU I/O 2 Protocol is not installed\r
212	//\r
213	ASSERT_EFI_ERROR (Status);\r
214	\r
215	//\r
216	// Display any drivers that were not dispatched because dependency expression\r
217	// evaluated to false if this is a debug build\r
218	//\r
219	DEBUG_CODE_BEGIN ();\r
220	SmmDisplayDiscoveredNotDispatched ();\r
221	DEBUG_CODE_END ();\r
222	\r
223	//\r
224	// Not allowed to use gST or gBS after lock\r
225	//\r
226	gST = NULL;\r
227	gBS = NULL;\r
228	\r
229	return Status;\r
230	}\r
231	\r
46ece1ff JY	232	/**\r
	233	Software SMI handler that is called when the EndOfDxe event is signalled.\r
	234	This function installs the SMM EndOfDxe Protocol so SMM Drivers are informed that\r
	235	platform code will invoke 3rd part code.\r
	236	\r
	237	@param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r
	238	@param Context Points to an optional handler context which was specified when the handler was registered.\r
	239	@param CommBuffer A pointer to a collection of data in memory that will\r
	240	be conveyed from a non-SMM environment into an SMM environment.\r
	241	@param CommBufferSize The size of the CommBuffer.\r
	242	\r
	243	@return Status Code\r
	244	\r
	245	**/\r
	246	EFI_STATUS\r
	247	EFIAPI\r
	248	SmmEndOfDxeHandler (\r
	249	IN EFI_HANDLE DispatchHandle,\r
	250	IN CONST VOID *Context, OPTIONAL\r
	251	IN OUT VOID *CommBuffer, OPTIONAL\r
	252	IN OUT UINTN *CommBufferSize OPTIONAL\r
	253	)\r
	254	{\r
	255	EFI_STATUS Status;\r
	256	EFI_HANDLE SmmHandle;\r
	257	\r
	258	DEBUG ((EFI_D_INFO, "SmmEndOfDxeHandler\n"));\r
	259	//\r
	260	// Install SMM EndOfDxe protocol\r
	261	//\r
	262	SmmHandle = NULL;\r
	263	Status = SmmInstallProtocolInterface (\r
	264	&SmmHandle,\r
	265	&gEfiSmmEndOfDxeProtocolGuid,\r
	266	EFI_NATIVE_INTERFACE,\r
	267	NULL\r
	268	);\r
	269	return EFI_SUCCESS;\r
	270	}\r
	271	\r
e42e9404	272	/**\r
	273	The main entry point to SMM Foundation.\r
	274	\r
	275	Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.\r
	276	\r
	277	@param SmmEntryContext Processor information and functionality\r
	278	needed by SMM Foundation.\r
	279	\r
	280	**/\r
	281	VOID\r
	282	EFIAPI\r
	283	SmmEntryPoint (\r
	284	IN CONST EFI_SMM_ENTRY_CONTEXT *SmmEntryContext\r
	285	)\r
	286	{\r
	287	EFI_STATUS Status;\r
	288	EFI_SMM_COMMUNICATE_HEADER *CommunicateHeader;\r
a25cb9f6	289	BOOLEAN InLegacyBoot;\r
e42e9404	290	\r
495797c5	291	PERF_START (NULL, "SMM", NULL, 0) ;\r
495797c5	292	\r
e42e9404	293	//\r
	294	// Update SMST using the context\r
	295	//\r
	296	CopyMem (&gSmmCoreSmst.SmmStartupThisAp, SmmEntryContext, sizeof (EFI_SMM_ENTRY_CONTEXT));\r
	297	\r
495797c5	298	//\r
	299	// Call platform hook before Smm Dispatch\r
	300	//\r
	301	PlatformHookBeforeSmmDispatch ();\r
	302	\r
e42e9404	303	//\r
	304	// If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed\r
	305	//\r
a25cb9f6	306	InLegacyBoot = mInLegacyBoot;\r
a25cb9f6	307	if (!InLegacyBoot) {\r
e42e9404	308	//\r
9fa90bb4	309	// Mark the InSmm flag as TRUE, it will be used by SmmBase2 protocol\r
e42e9404	310	//\r
9fa90bb4	311	gSmmCorePrivate->InSmm = TRUE;\r
e42e9404	312	\r
e42e9404	313	//\r
9fa90bb4	314	// Check to see if this is a Synchronous SMI sent through the SMM Communication \r
9fa90bb4	315	// Protocol or an Asynchronous SMI\r
e42e9404	316	//\r
9fa90bb4	317	if (gSmmCorePrivate->CommunicationBuffer != NULL) {\r
	318	//\r
	319	// Synchronous SMI for SMM Core or request from Communicate protocol\r
	320	//\r
	321	CommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)gSmmCorePrivate->CommunicationBuffer;\r
	322	gSmmCorePrivate->BufferSize -= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
	323	Status = SmiManage (\r
	324	&CommunicateHeader->HeaderGuid, \r
	325	NULL, \r
	326	CommunicateHeader->Data, \r
	327	&gSmmCorePrivate->BufferSize\r
	328	);\r
	329	\r
	330	//\r
	331	// Update CommunicationBuffer, BufferSize and ReturnStatus\r
	332	// Communicate service finished, reset the pointer to CommBuffer to NULL\r
	333	//\r
	334	gSmmCorePrivate->BufferSize += OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
	335	gSmmCorePrivate->CommunicationBuffer = NULL;\r
	336	gSmmCorePrivate->ReturnStatus = (Status == EFI_SUCCESS) ? EFI_SUCCESS : EFI_NOT_FOUND;\r
	337	}\r
e42e9404	338	}\r
9fa90bb4	339	\r
	340	//\r
	341	// Process Asynchronous SMI sources\r
	342	//\r
	343	SmiManage (NULL, NULL, NULL, NULL);\r
495797c5	344	\r
	345	//\r
	346	// Call platform hook after Smm Dispatch\r
	347	//\r
	348	PlatformHookAfterSmmDispatch ();\r
e42e9404	349	\r
e42e9404	350	//\r
9fa90bb4	351	// If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed\r
e42e9404	352	//\r
a25cb9f6	353	if (!InLegacyBoot) {\r
9fa90bb4	354	//\r
	355	// Clear the InSmm flag as we are going to leave SMM\r
	356	//\r
	357	gSmmCorePrivate->InSmm = FALSE;\r
	358	}\r
495797c5	359	\r
495797c5	360	PERF_END (NULL, "SMM", NULL, 0) ;\r
e42e9404	361	}\r
	362	\r
	363	/**\r
	364	The Entry Point for SMM Core\r
	365	\r
	366	Install DXE Protocols and reload SMM Core into SMRAM and register SMM Core \r
	367	EntryPoint on the SMI vector.\r
	368	\r
	369	Note: This function is called for both DXE invocation and SMRAM invocation.\r
	370	\r
	371	@param ImageHandle The firmware allocated handle for the EFI image.\r
	372	@param SystemTable A pointer to the EFI System Table.\r
	373	\r
	374	@retval EFI_SUCCESS The entry point is executed successfully.\r
	375	@retval Other Some error occurred when executing this entry point.\r
	376	\r
	377	**/\r
	378	EFI_STATUS\r
	379	EFIAPI\r
	380	SmmMain (\r
	381	IN EFI_HANDLE ImageHandle,\r
	382	IN EFI_SYSTEM_TABLE *SystemTable\r
	383	)\r
	384	{\r
	385	EFI_STATUS Status;\r
	386	UINTN Index;\r
	387	\r
	388	//\r
	389	// Get SMM Core Private context passed in from SMM IPL in ImageHandle.\r
	390	//\r
	391	gSmmCorePrivate = (SMM_CORE_PRIVATE_DATA *)ImageHandle;\r
	392	\r
	393	//\r
	394	// Fill in SMRAM physical address for the SMM Services Table and the SMM Entry Point.\r
	395	//\r
	396	gSmmCorePrivate->Smst = &gSmmCoreSmst;\r
	397	gSmmCorePrivate->SmmEntryPoint = SmmEntryPoint;\r
	398	\r
	399	//\r
	400	// Initialize memory service using free SMRAM\r
	401	//\r
	402	SmmInitializeMemoryServices (gSmmCorePrivate->SmramRangeCount, gSmmCorePrivate->SmramRanges);\r
	403	\r
	404	//\r
	405	// Register all SMI Handlers required by the SMM Core\r
	406	//\r
	407	for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
	408	Status = SmiHandlerRegister (\r
	409	mSmmCoreSmiHandlers[Index].Handler,\r
	410	mSmmCoreSmiHandlers[Index].HandlerType,\r
	411	&mSmmCoreSmiHandlers[Index].DispatchHandle\r
	412	);\r
	413	ASSERT_EFI_ERROR (Status);\r
	414	}\r
	415	\r
	416	return EFI_SUCCESS;\r
	417	}\r