From 202c32790fb65187a3f5dfc546d611b5f3b1f10b Mon Sep 17 00:00:00 2001 From: davidhuang Date: Wed, 23 Dec 2009 06:51:36 +0000 Subject: [PATCH] PI 1.1 SMM Feature Check-in 1. Update DxeMain to support COMBINED_DXE_SMM driver dispatch. 2. Add ReportStatusCodeRouter SMM part. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9591 6f19259b-4bc3-4df7-8a09-765794883524 --- MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c | 47 +++- MdeModulePkg/Core/Dxe/DxeMain.inf | 2 + MdeModulePkg/Core/Dxe/FwVol/FwVolRead.c | 6 +- MdeModulePkg/MdeModulePkg.dsc | 2 + .../Smm/ReportStatusCodeRouterSmm.c | 243 ++++++++++++++++++ .../Smm/ReportStatusCodeRouterSmm.h | 108 ++++++++ .../Smm/ReportStatusCodeRouterSmm.inf | 54 ++++ 7 files changed, 458 insertions(+), 4 deletions(-) create mode 100644 MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.c create mode 100644 MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.h create mode 100644 MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.inf diff --git a/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c b/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c index 6a18fe909e..5fbb2d442d 100644 --- a/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c +++ b/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c @@ -26,7 +26,7 @@ Depex - Dependency Expresion. SOR - Schedule On Request - Don't schedule if this bit is set. -Copyright (c) 2006 - 2008, Intel Corporation.
+Copyright (c) 2006 - 2009, Intel Corporation.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -78,6 +78,7 @@ VOID *mFwVolEventRegistration; // EFI_FV_FILETYPE mDxeFileTypes[] = { EFI_FV_FILETYPE_DRIVER, + EFI_FV_FILETYPE_COMBINED_SMM_DXE, EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER, EFI_FV_FILETYPE_DXE_CORE, EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE @@ -386,6 +387,23 @@ CoreTrust ( } +/** + An empty function to pass error checking of CreateEventEx (). + + @param Event Event whose notification function is being invoked. + @param Context Pointer to the notification function's context, + which is implementation-dependent. + +**/ +VOID +EFIAPI +EmptyFuntion ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + return; +} /** This is the main Dispatcher for DXE and it exits when there are no more @@ -412,6 +430,8 @@ CoreDispatcher ( LIST_ENTRY *Link; EFI_CORE_DRIVER_ENTRY *DriverEntry; BOOLEAN ReadyToRun; + EFI_EVENT DxeDispatchEvent; + if (gDispatcherRunning) { // @@ -422,6 +442,17 @@ CoreDispatcher ( gDispatcherRunning = TRUE; + Status = CoreCreateEventEx ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + EmptyFuntion, + NULL, + &gEfiEventDxeDispatchGuid, + &DxeDispatchEvent + ); + if (EFI_ERROR (Status)) { + return Status; + } ReturnStatus = EFI_NOT_FOUND; do { @@ -534,8 +565,22 @@ CoreDispatcher ( } } } + + // + // Now DXE Dispatcher finished one round of dispatch, signal an event group + // so that SMM Dispatcher get chance to dispatch SMM Drivers which depend + // on UEFI protocols + // + if (!EFI_ERROR (ReturnStatus)) { + CoreSignalEvent (DxeDispatchEvent); + } } while (ReadyToRun); + // + // Close DXE dispatch Event + // + CoreCloseEvent (DxeDispatchEvent); + gDispatcherRunning = FALSE; return ReturnStatus; diff --git a/MdeModulePkg/Core/Dxe/DxeMain.inf b/MdeModulePkg/Core/Dxe/DxeMain.inf index 3c711400e3..d94e864b40 100644 --- a/MdeModulePkg/Core/Dxe/DxeMain.inf +++ b/MdeModulePkg/Core/Dxe/DxeMain.inf @@ -102,6 +102,8 @@ gEfiHobListGuid ## CONSUMES ## GUID gEfiDxeServicesTableGuid ## CONSUMES ## GUID gEfiMemoryTypeInformationGuid ## CONSUMES ## GUID + gEfiEventDxeDispatchGuid ## CONSUMES ## GUID + [Protocols] gEfiStatusCodeRuntimeProtocolGuid ## SOMETIMES_CONSUMES diff --git a/MdeModulePkg/Core/Dxe/FwVol/FwVolRead.c b/MdeModulePkg/Core/Dxe/FwVol/FwVolRead.c index e7cac455ff..3936b466b2 100644 --- a/MdeModulePkg/Core/Dxe/FwVol/FwVolRead.c +++ b/MdeModulePkg/Core/Dxe/FwVol/FwVolRead.c @@ -1,7 +1,7 @@ /** @file Implements functions to read firmware file -Copyright (c) 2006 - 2008, Intel Corporation.
+Copyright (c) 2006 - 2009, Intel Corporation.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -135,9 +135,9 @@ FvGetNextFile ( return EFI_ACCESS_DENIED; } - if (*FileType > EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) { + if (*FileType > EFI_FV_FILETYPE_SMM_CORE) { // - // File type needs to be in 0 - 0x0B + // File type needs to be in 0 - 0x0D // return EFI_NOT_FOUND; } diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc index 5000934609..3bd0f48532 100644 --- a/MdeModulePkg/MdeModulePkg.dsc +++ b/MdeModulePkg/MdeModulePkg.dsc @@ -124,6 +124,7 @@ MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf SmbusLib|MdePkg/Library/DxeSmbusLib/DxeSmbusLib.inf DebugLib|MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf + SmmServicesTableLib|MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.inf [LibraryClasses.common.UEFI_DRIVER] HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf @@ -312,6 +313,7 @@ MdeModulePkg/Universal/ReportStatusCodeRouter/Pei/ReportStatusCodeRouterPei.inf MdeModulePkg/Universal/ReportStatusCodeRouter/RuntimeDxe/ReportStatusCodeRouterRuntimeDxe.inf + MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.inf MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf MdeModulePkg/Universal/SetupBrowserDxe/SetupBrowserDxe.inf diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.c b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.c new file mode 100644 index 0000000000..5e7cd1850c --- /dev/null +++ b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.c @@ -0,0 +1,243 @@ +/** @file + Report Status Code Router Driver which produces SMM Report Stataus Code Handler Protocol + and SMM Status Code Protocol. + + Copyright (c) 2009, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#include "ReportStatusCodeRouterSmm.h" + +LIST_ENTRY mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead); + +// +// Report operation nest status. +// If it is set, then the report operation has nested. +// +UINT32 mStatusCodeNestStatus = 0; + +EFI_SMM_STATUS_CODE_PROTOCOL mSmmStatusCodeProtocol = { + ReportDispatcher +}; + +EFI_SMM_RSC_HANDLER_PROTOCOL mSmmRscHandlerProtocol = { + Register, + Unregister + }; + +/** + Register the callback function for ReportStatusCode() notification. + + When this function is called the function pointer is added to an internal list and any future calls to + ReportStatusCode() will be forwarded to the Callback function. + + @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called + when a call to ReportStatusCode() occurs. + + @retval EFI_SUCCESS Function was successfully registered. + @retval EFI_INVALID_PARAMETER The callback function was NULL. + @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be + registered. + @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again. + +**/ +EFI_STATUS +EFIAPI +Register ( + IN EFI_SMM_RSC_HANDLER_CALLBACK Callback + ) +{ + EFI_STATUS Status; + LIST_ENTRY *Link; + SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry; + + if (Callback == NULL) { + return EFI_INVALID_PARAMETER; + } + + for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) { + CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE); + if (CallbackEntry->RscHandlerCallback == Callback) { + // + // If the function was already registered. It can't be registered again. + // + return EFI_ALREADY_STARTED; + } + } + + Status = gSmst->SmmAllocatePool ( + EfiRuntimeServicesData, + sizeof (SMM_RSC_HANDLER_CALLBACK_ENTRY), + (VOID**)&CallbackEntry + ); + + ASSERT_EFI_ERROR(Status); + ASSERT (CallbackEntry != NULL); + + CallbackEntry->Signature = SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE; + CallbackEntry->RscHandlerCallback = Callback; + + InsertTailList (&mCallbackListHead, &CallbackEntry->Node); + + return EFI_SUCCESS; +} + +/** + Remove a previously registered callback function from the notification list. + + ReportStatusCode() messages will no longer be forwarded to the Callback function. + + @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be + unregistered. + + @retval EFI_SUCCESS The function was successfully unregistered. + @retval EFI_INVALID_PARAMETER The callback function was NULL. + @retval EFI_NOT_FOUND The callback function was not found to be unregistered. + +**/ +EFI_STATUS +EFIAPI +Unregister ( + IN EFI_SMM_RSC_HANDLER_CALLBACK Callback + ) +{ + LIST_ENTRY *Link; + SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry; + + if (Callback == NULL) { + return EFI_INVALID_PARAMETER; + } + + for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) { + CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE); + if (CallbackEntry->RscHandlerCallback == Callback) { + // + // If the function is found in list, delete it and return. + // + RemoveEntryList (&CallbackEntry->Node); + gSmst->SmmFreePool (CallbackEntry); + return EFI_SUCCESS; + } + } + + return EFI_NOT_FOUND; +} + + +/** + Provides an interface that a software module can call to report a status code. + + @param This EFI_SMM_STATUS_CODE_PROTOCOL instance. + @param Type Indicates the type of status code being reported. + @param Value Describes the current status of a hardware or software entity. + This included information about the class and subclass that is used to + classify the entity as well as an operation. + @param Instance The enumeration of a hardware or software entity within + the system. Valid instance numbers start with 1. + @param CallerId This optional parameter may be used to identify the caller. + This parameter allows the status code driver to apply different rules to + different callers. + @param Data This optional parameter may be used to pass additional data. + + @retval EFI_SUCCESS The function completed successfully + @retval EFI_DEVICE_ERROR The function should not be completed due to a device error. + +**/ +EFI_STATUS +EFIAPI +ReportDispatcher ( + IN CONST EFI_SMM_STATUS_CODE_PROTOCOL *This, + IN EFI_STATUS_CODE_TYPE Type, + IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, + IN CONST EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL + ) +{ + LIST_ENTRY *Link; + SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry; + + // + // Use atom operation to avoid the reentant of report. + // If current status is not zero, then the function is reentrancy. + // + if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) { + return EFI_DEVICE_ERROR; + } + + for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) { + CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE); + + CallbackEntry->RscHandlerCallback ( + Type, + Value, + Instance, + (EFI_GUID*)CallerId, + Data + ); + + } + + // + // Restore the nest status of report + // + InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0); + + return EFI_SUCCESS; +} + +/** + Entry point of Generic Status Code Driver. + + This function is the entry point of SMM Status Code Router . + It produces SMM Report Stataus Code Handler and Status Code protocol. + + @param ImageHandle The firmware allocated handle for the EFI image. + @param SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The entry point is executed successfully. + +**/ +EFI_STATUS +EFIAPI +GenericStatusCodeSmmEntry ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_STATUS Status; + EFI_HANDLE Handle; + + Handle = NULL; + + // + // Install SmmRscHandler Protocol + // + Status = gSmst->SmmInstallProtocolInterface ( + &Handle, + &gEfiSmmRscHandlerProtocolGuid, + EFI_NATIVE_INTERFACE, + &mSmmRscHandlerProtocol + ); + ASSERT_EFI_ERROR (Status); + + // + // Install SmmStatusCode Protocol + // + Status = gSmst->SmmInstallProtocolInterface ( + &Handle, + &gEfiSmmStatusCodeProtocolGuid, + EFI_NATIVE_INTERFACE, + &mSmmStatusCodeProtocol + ); + ASSERT_EFI_ERROR (Status); + + return EFI_SUCCESS; +} diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.h b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.h new file mode 100644 index 0000000000..d3017b4b6e --- /dev/null +++ b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.h @@ -0,0 +1,108 @@ +/** @file + Internal include file for Report Status Code Router Driver. + + Copyright (c) 2009, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#ifndef __REPORT_STATUS_CODE_ROUTER_SMM_H__ +#define __REPORT_STATUS_CODE_ROUTER_SMM_H__ + + +#include +#include + +#include +#include +#include +#include +#include +#include + +#define SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE SIGNATURE_32 ('s', 'h', 'c', 'e') + +typedef struct { + UINTN Signature; + EFI_SMM_RSC_HANDLER_CALLBACK RscHandlerCallback; + LIST_ENTRY Node; +} SMM_RSC_HANDLER_CALLBACK_ENTRY; + +/** + Register the callback function for ReportStatusCode() notification. + + When this function is called the function pointer is added to an internal list and any future calls to + ReportStatusCode() will be forwarded to the Callback function. + + @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called + when a call to ReportStatusCode() occurs. + + @retval EFI_SUCCESS Function was successfully registered. + @retval EFI_INVALID_PARAMETER The callback function was NULL. + @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be + registered. + @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again. + +**/ +EFI_STATUS +EFIAPI +Register ( + IN EFI_SMM_RSC_HANDLER_CALLBACK Callback + ); + +/** + Remove a previously registered callback function from the notification list. + + ReportStatusCode() messages will no longer be forwarded to the Callback function. + + @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be + unregistered. + + @retval EFI_SUCCESS The function was successfully unregistered. + @retval EFI_INVALID_PARAMETER The callback function was NULL. + @retval EFI_NOT_FOUND The callback function was not found to be unregistered. + +**/ +EFI_STATUS +EFIAPI +Unregister ( + IN EFI_SMM_RSC_HANDLER_CALLBACK Callback + ); + +/** + Provides an interface that a software module can call to report a status code. + + @param This EFI_SMM_STATUS_CODE_PROTOCOL instance. + @param Type Indicates the type of status code being reported. + @param Value Describes the current status of a hardware or software entity. + This included information about the class and subclass that is used to + classify the entity as well as an operation. + @param Instance The enumeration of a hardware or software entity within + the system. Valid instance numbers start with 1. + @param CallerId This optional parameter may be used to identify the caller. + This parameter allows the status code driver to apply different rules to + different callers. + @param Data This optional parameter may be used to pass additional data. + + @retval EFI_SUCCESS The function completed successfully + @retval EFI_DEVICE_ERROR The function should not be completed due to a device error. + +**/ +EFI_STATUS +EFIAPI +ReportDispatcher ( + IN CONST EFI_SMM_STATUS_CODE_PROTOCOL *This, + IN EFI_STATUS_CODE_TYPE Type, + IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, + IN CONST EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL + ); + +#endif diff --git a/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.inf b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.inf new file mode 100644 index 0000000000..d4c4f7d212 --- /dev/null +++ b/MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCodeRouterSmm.inf @@ -0,0 +1,54 @@ +#/** @file +# Report Status Code Router Driver which produces Report Stataus Code Handler Protocol +# and Status Code Runtime Protocol. +# +# Copyright (c) 2009, Intel Corporation. +# +# All rights reserved. This program and the accompanying materials +# are licensed and made available under the terms and conditions of the BSD License +# which accompanies this distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +# +# +#**/ + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = ReportStatusCodeRouterSmm + FILE_GUID = A6885402-D022-4b0e-A509-4711B90F2A39 + MODULE_TYPE = DXE_SMM_DRIVER + PI_SPECIFICATION_VERSION = 0x0001000A + + ENTRY_POINT = GenericStatusCodeSmmEntry + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 +# + +[Sources.common] + ReportStatusCodeRouterSmm.c + ReportStatusCodeRouterSmm.h + + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + UefiRuntimeLib + SmmServicesTableLib + UefiDriverEntryPoint + DebugLib + BaseLib + SynchronizationLib + +[Protocols] + gEfiSmmRscHandlerProtocolGuid ## PRODUCES + gEfiSmmStatusCodeProtocolGuid ## PRODUCES + +[Depex] + TRUE -- 2.39.2