/** @file\r
SMM Core Main Entry Point\r
\r
- Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2009 - 2018, 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
//\r
BOOLEAN mInLegacyBoot = FALSE;\r
\r
+//\r
+// Flag to determine if it is during S3 resume.\r
+// It will be set in S3 entry callback and cleared at EndOfS3Resume.\r
+//\r
+BOOLEAN mDuringS3Resume = 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
- { SmmExitBootServicesHandler, &gEfiEventExitBootServicesGuid, NULL, FALSE },\r
- { SmmReadyToBootHandler, &gEfiEventReadyToBootGuid, NULL, FALSE },\r
- { SmmEndOfDxeHandler, &gEfiEndOfDxeEventGroupGuid, NULL, TRUE },\r
- { NULL, NULL, NULL, FALSE }\r
+ { SmmDriverDispatchHandler, &gEfiEventDxeDispatchGuid, NULL, TRUE },\r
+ { SmmReadyToLockHandler, &gEfiDxeSmmReadyToLockProtocolGuid, NULL, TRUE }, \r
+ { SmmLegacyBootHandler, &gEfiEventLegacyBootGuid, NULL, FALSE },\r
+ { SmmExitBootServicesHandler, &gEfiEventExitBootServicesGuid, NULL, FALSE },\r
+ { SmmReadyToBootHandler, &gEfiEventReadyToBootGuid, NULL, FALSE },\r
+ { SmmEndOfDxeHandler, &gEfiEndOfDxeEventGroupGuid, NULL, TRUE },\r
+ { SmmS3SmmInitDoneHandler, &gEdkiiS3SmmInitDoneGuid, NULL, FALSE },\r
+ { SmmEndOfS3ResumeHandler, &gEdkiiEndOfS3ResumeGuid, NULL, FALSE },\r
+ { NULL, NULL, NULL, FALSE }\r
};\r
\r
UINTN mFullSmramRangeCount;\r
EFI_SMRAM_DESCRIPTOR *mFullSmramRanges;\r
\r
+EFI_SMM_DRIVER_ENTRY *mSmmCoreDriverEntry;\r
+\r
EFI_LOADED_IMAGE_PROTOCOL *mSmmCoreLoadedImage;\r
\r
/**\r
{\r
EFI_STATUS Status;\r
EFI_HANDLE SmmHandle;\r
+ UINTN Index;\r
\r
//\r
// Install SMM Legacy Boot protocol.\r
\r
SmiHandlerUnRegister (DispatchHandle);\r
\r
+ //\r
+ // It is legacy boot, unregister ExitBootService SMI handler.\r
+ //\r
+ for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
+ if (CompareGuid (mSmmCoreSmiHandlers[Index].HandlerType, &gEfiEventExitBootServicesGuid)) {\r
+ SmiHandlerUnRegister (mSmmCoreSmiHandlers[Index].DispatchHandle);\r
+ break;\r
+ }\r
+ }\r
+\r
return Status;\r
}\r
\r
{\r
EFI_STATUS Status;\r
EFI_HANDLE SmmHandle;\r
+ UINTN Index;\r
\r
//\r
// Install SMM Exit Boot Services protocol.\r
\r
SmiHandlerUnRegister (DispatchHandle);\r
\r
+ //\r
+ // It is UEFI boot, unregister LegacyBoot SMI handler.\r
+ //\r
+ for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
+ if (CompareGuid (mSmmCoreSmiHandlers[Index].HandlerType, &gEfiEventLegacyBootGuid)) {\r
+ SmiHandlerUnRegister (mSmmCoreSmiHandlers[Index].DispatchHandle);\r
+ break;\r
+ }\r
+ }\r
+\r
return Status;\r
}\r
\r
+/**\r
+ Main entry point for an SMM handler dispatch or communicate-based callback.\r
+\r
+ @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r
+ @param[in] Context Points to an optional handler context which was specified when the\r
+ handler was registered.\r
+ @param[in,out] 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[in,out] CommBufferSize The size of the CommBuffer.\r
+\r
+ @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers\r
+ should still be called.\r
+ @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED The interrupt has been quiesced but other handlers should\r
+ still be called.\r
+ @retval EFI_WARN_INTERRUPT_SOURCE_PENDING The interrupt is still pending and other handlers should still\r
+ be called.\r
+ @retval EFI_INTERRUPT_PENDING The interrupt could not be quiesced.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SmmS3EntryCallBack (\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
+ mDuringS3Resume = TRUE;\r
+ return EFI_SUCCESS;\r
+}\r
+\r
/**\r
Software SMI handler that is called when an Ready To Boot event is signalled.\r
Then the SMM Core also install SMM Ready To Boot protocol to notify SMM driver\r
IN OUT UINTN *CommBufferSize OPTIONAL\r
)\r
{\r
- EFI_STATUS Status;\r
- EFI_HANDLE SmmHandle;\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE SmmHandle;\r
\r
//\r
// Install SMM Ready To Boot protocol.\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
+ to be locked. It also verifies 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
IN OUT UINTN *CommBufferSize OPTIONAL\r
)\r
{\r
- EFI_STATUS Status;\r
- EFI_HANDLE SmmHandle;\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE SmmHandle;\r
+ EFI_SMM_SX_DISPATCH2_PROTOCOL *SxDispatch;\r
+ EFI_SMM_SX_REGISTER_CONTEXT EntryRegisterContext;\r
+ EFI_HANDLE S3EntryHandle;\r
\r
DEBUG ((EFI_D_INFO, "SmmEndOfDxeHandler\n"));\r
+\r
//\r
// Install SMM EndOfDxe protocol\r
//\r
EFI_NATIVE_INTERFACE,\r
NULL\r
);\r
+\r
+ //\r
+ // Locate SmmSxDispatch2 protocol.\r
+ //\r
+ Status = SmmLocateProtocol (\r
+ &gEfiSmmSxDispatch2ProtocolGuid,\r
+ NULL,\r
+ (VOID **)&SxDispatch\r
+ );\r
+ if (!EFI_ERROR (Status) && (SxDispatch != NULL)) {\r
+ //\r
+ // Register a S3 entry callback function to\r
+ // determine if it will be during S3 resume.\r
+ //\r
+ EntryRegisterContext.Type = SxS3;\r
+ EntryRegisterContext.Phase = SxEntry;\r
+ Status = SxDispatch->Register (\r
+ SxDispatch,\r
+ SmmS3EntryCallBack,\r
+ &EntryRegisterContext,\r
+ &S3EntryHandle\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Software SMI handler that is called when the S3SmmInitDone signal is triggered.\r
+ This function installs the SMM S3SmmInitDone Protocol so SMM Drivers are informed that\r
+ S3 SMM initialization has been done.\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
+SmmS3SmmInitDoneHandler (\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 ((DEBUG_INFO, "SmmS3SmmInitDoneHandler\n"));\r
+\r
+ if (!mDuringS3Resume) {\r
+ DEBUG ((DEBUG_ERROR, "It is not during S3 resume\n"));\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ // Install SMM S3SmmInitDone protocol\r
+ //\r
+ SmmHandle = NULL;\r
+ Status = SmmInstallProtocolInterface (\r
+ &SmmHandle,\r
+ &gEdkiiS3SmmInitDoneGuid,\r
+ EFI_NATIVE_INTERFACE,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Uninstall the protocol here because the comsumer just hook the\r
+ // installation event.\r
+ //\r
+ Status = SmmUninstallProtocolInterface (\r
+ SmmHandle,\r
+ &gEdkiiS3SmmInitDoneGuid,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ Software SMI handler that is called when the EndOfS3Resume signal is triggered.\r
+ This function installs the SMM EndOfS3Resume Protocol so SMM Drivers are informed that\r
+ S3 resume has finished.\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
+SmmEndOfS3ResumeHandler (\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 ((DEBUG_INFO, "SmmEndOfS3ResumeHandler\n"));\r
+\r
+ if (!mDuringS3Resume) {\r
+ DEBUG ((DEBUG_ERROR, "It is not during S3 resume\n"));\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ // Install SMM EndOfS3Resume protocol\r
+ //\r
+ SmmHandle = NULL;\r
+ Status = SmmInstallProtocolInterface (\r
+ &SmmHandle,\r
+ &gEdkiiEndOfS3ResumeGuid,\r
+ EFI_NATIVE_INTERFACE,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Uninstall the protocol here because the comsumer just hook the\r
+ // installation event.\r
+ //\r
+ Status = SmmUninstallProtocolInterface (\r
+ SmmHandle,\r
+ &gEdkiiEndOfS3ResumeGuid,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ mDuringS3Resume = FALSE;\r
return Status;\r
}\r
\r
EFI_SMM_COMMUNICATE_HEADER *CommunicateHeader;\r
BOOLEAN InLegacyBoot;\r
BOOLEAN IsOverlapped;\r
+ VOID *CommunicationBuffer;\r
+ UINTN BufferSize;\r
\r
- PERF_START (NULL, "SMM", NULL, 0) ;\r
+ PERF_INMODULE_BEGIN ("SMM");\r
\r
//\r
// Update SMST with contents of the SmmEntryContext structure\r
//\r
PlatformHookBeforeSmmDispatch ();\r
\r
+ //\r
+ // Call memory management hook function\r
+ //\r
+ SmmEntryPointMemoryManagementHook ();\r
+\r
//\r
// If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed\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
+ CommunicationBuffer = gSmmCorePrivate->CommunicationBuffer;\r
+ BufferSize = gSmmCorePrivate->BufferSize;\r
+ if (CommunicationBuffer != NULL) {\r
//\r
// Synchronous SMI for SMM Core or request from Communicate protocol\r
//\r
IsOverlapped = InternalIsBufferOverlapped (\r
- (UINT8 *) gSmmCorePrivate->CommunicationBuffer,\r
- gSmmCorePrivate->BufferSize,\r
+ (UINT8 *) CommunicationBuffer,\r
+ BufferSize,\r
(UINT8 *) gSmmCorePrivate,\r
sizeof (*gSmmCorePrivate)\r
);\r
- if (!SmmIsBufferOutsideSmmValid ((UINTN)gSmmCorePrivate->CommunicationBuffer, gSmmCorePrivate->BufferSize) || IsOverlapped) {\r
+ if (!SmmIsBufferOutsideSmmValid ((UINTN)CommunicationBuffer, BufferSize) || IsOverlapped) {\r
//\r
// If CommunicationBuffer is not in valid address scope,\r
// or there is overlap between gSmmCorePrivate and CommunicationBuffer,\r
// return EFI_INVALID_PARAMETER\r
//\r
gSmmCorePrivate->CommunicationBuffer = NULL;\r
- gSmmCorePrivate->ReturnStatus = EFI_INVALID_PARAMETER;\r
+ gSmmCorePrivate->ReturnStatus = EFI_ACCESS_DENIED;\r
} else {\r
- CommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)gSmmCorePrivate->CommunicationBuffer;\r
- gSmmCorePrivate->BufferSize -= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
+ CommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)CommunicationBuffer;\r
+ BufferSize -= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
Status = SmiManage (\r
&CommunicateHeader->HeaderGuid, \r
NULL, \r
CommunicateHeader->Data, \r
- &gSmmCorePrivate->BufferSize\r
+ &BufferSize\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->BufferSize = 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
gSmmCorePrivate->InSmm = FALSE;\r
}\r
\r
- PERF_END (NULL, "SMM", NULL, 0) ;\r
+ PERF_INMODULE_END ("SMM");\r
}\r
\r
/**\r
);\r
ASSERT_EFI_ERROR (Status);\r
\r
+ //\r
+ // Allocate a Loaded Image Protocol in SMM\r
+ //\r
+ Status = SmmAllocatePool (EfiRuntimeServicesData, sizeof(EFI_SMM_DRIVER_ENTRY), (VOID **)&mSmmCoreDriverEntry);\r
+ ASSERT_EFI_ERROR(Status);\r
+\r
+ ZeroMem (mSmmCoreDriverEntry, sizeof(EFI_SMM_DRIVER_ENTRY));\r
+ //\r
+ // Fill in the remaining fields of the Loaded Image Protocol instance.\r
+ //\r
+ mSmmCoreDriverEntry->Signature = EFI_SMM_DRIVER_ENTRY_SIGNATURE;\r
+ mSmmCoreDriverEntry->SmmLoadedImage.Revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;\r
+ mSmmCoreDriverEntry->SmmLoadedImage.ParentHandle = gSmmCorePrivate->SmmIplImageHandle;\r
+ mSmmCoreDriverEntry->SmmLoadedImage.SystemTable = gST;\r
+\r
+ mSmmCoreDriverEntry->SmmLoadedImage.ImageBase = (VOID *)(UINTN)gSmmCorePrivate->PiSmmCoreImageBase;\r
+ mSmmCoreDriverEntry->SmmLoadedImage.ImageSize = gSmmCorePrivate->PiSmmCoreImageSize;\r
+ mSmmCoreDriverEntry->SmmLoadedImage.ImageCodeType = EfiRuntimeServicesCode;\r
+ mSmmCoreDriverEntry->SmmLoadedImage.ImageDataType = EfiRuntimeServicesData;\r
+\r
+ mSmmCoreDriverEntry->ImageEntryPoint = gSmmCorePrivate->PiSmmCoreEntryPoint;\r
+ mSmmCoreDriverEntry->ImageBuffer = gSmmCorePrivate->PiSmmCoreImageBase;\r
+ mSmmCoreDriverEntry->NumberOfPage = EFI_SIZE_TO_PAGES((UINTN)gSmmCorePrivate->PiSmmCoreImageSize);\r
+\r
+ //\r
+ // Create a new image handle in the SMM handle database for the SMM Driver\r
+ //\r
+ mSmmCoreDriverEntry->SmmImageHandle = NULL;\r
+ Status = SmmInstallProtocolInterface (\r
+ &mSmmCoreDriverEntry->SmmImageHandle,\r
+ &gEfiLoadedImageProtocolGuid,\r
+ EFI_NATIVE_INTERFACE,\r
+ &mSmmCoreDriverEntry->SmmLoadedImage\r
+ );\r
+ ASSERT_EFI_ERROR(Status);\r
+\r
return ;\r
}\r
\r
//\r
gSmmCorePrivate->Smst = &gSmmCoreSmst;\r
gSmmCorePrivate->SmmEntryPoint = SmmEntryPoint;\r
- \r
+\r
//\r
// No need to initialize memory service.\r
// It is done in constructor of PiSmmCoreMemoryAllocationLib(),\r
\r
SmmCoreInstallLoadedImage ();\r
\r
+ SmmCoreInitializeMemoryAttributesTable ();\r
+\r
+ SmmCoreInitializeSmiHandlerProfile ();\r
+\r
return EFI_SUCCESS;\r
}\r
projects / mirror_edk2.git / blobdiff