MdeModulePkg/SmmCore: Add Context in SmiHandlerProfileUnregister.

The reason is that we observe that a platform may use same Handler
for different context.

In order to support Unregister such handler, we have to input
context information as well.

Cc: Jeff Fan <jeff.fan@intel.com>
Cc: Feng Tian <feng.tian@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Feng Tian <feng.tian@intel.com>
This commit is contained in:
Jiewen Yao 2017-03-10 11:45:32 +08:00
parent cb716d292b
commit 1c3ac4b91e
2 changed files with 89 additions and 22 deletions

View File

@ -1139,6 +1139,10 @@ SmiHandlerProfileRegisterHandler (
For the SmmChildDispatch protocol, the HandlerGuid For the SmmChildDispatch protocol, the HandlerGuid
must be the GUID of SmmChildDispatch protocol. must be the GUID of SmmChildDispatch protocol.
@param Handler The SMI handler. @param Handler The SMI handler.
@param Context The context of the SMI handler.
If it is NOT NULL, it will be used to check what is registered.
@param ContextSize The size of the context in bytes.
If Context is NOT NULL, it will be used to check what is registered.
@retval EFI_SUCCESS The original record is removed. @retval EFI_SUCCESS The original record is removed.
@retval EFI_NOT_FOUND There is no record for the HandlerGuid and handler. @retval EFI_NOT_FOUND There is no record for the HandlerGuid and handler.
@ -1148,7 +1152,9 @@ EFIAPI
SmiHandlerProfileUnregisterHandler ( SmiHandlerProfileUnregisterHandler (
IN SMI_HANDLER_PROFILE_PROTOCOL *This, IN SMI_HANDLER_PROFILE_PROTOCOL *This,
IN EFI_GUID *HandlerGuid, IN EFI_GUID *HandlerGuid,
IN EFI_SMM_HANDLER_ENTRY_POINT2 Handler IN EFI_SMM_HANDLER_ENTRY_POINT2 Handler,
IN VOID *Context, OPTIONAL
IN UINTN ContextSize OPTIONAL
); );
extern UINTN mFullSmramRangeCount; extern UINTN mFullSmramRangeCount;

View File

@ -1088,6 +1088,40 @@ SmmCoreFindHardwareSmiEntry (
return SmiEntry; return SmiEntry;
} }
/**
Convert EFI_SMM_USB_REGISTER_CONTEXT to SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT.
@param UsbContext A pointer to EFI_SMM_USB_REGISTER_CONTEXT
@param UsbContextSize The size of EFI_SMM_USB_REGISTER_CONTEXT in bytes
@param SmiHandlerUsbContextSize The size of SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT in bytes
@return SmiHandlerUsbContext A pointer to SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT
**/
SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT *
ConvertSmiHandlerUsbContext (
IN EFI_SMM_USB_REGISTER_CONTEXT *UsbContext,
IN UINTN UsbContextSize,
OUT UINTN *SmiHandlerUsbContextSize
)
{
UINTN DevicePathSize;
SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT *SmiHandlerUsbContext;
ASSERT (UsbContextSize == sizeof(EFI_SMM_USB_REGISTER_CONTEXT));
DevicePathSize = GetDevicePathSize (UsbContext->Device);
SmiHandlerUsbContext = AllocatePool (sizeof (SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT) + DevicePathSize);
if (SmiHandlerUsbContext == NULL) {
*SmiHandlerUsbContextSize = 0;
return NULL;
}
SmiHandlerUsbContext->Type = UsbContext->Type;
SmiHandlerUsbContext->DevicePathSize = (UINT32)DevicePathSize;
CopyMem (SmiHandlerUsbContext + 1, UsbContext->Device, DevicePathSize);
*SmiHandlerUsbContextSize = sizeof (SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT) + DevicePathSize;
return SmiHandlerUsbContext;
}
/** /**
This function is called by SmmChildDispatcher module to report This function is called by SmmChildDispatcher module to report
a new SMI handler is registered, to SmmCore. a new SMI handler is registered, to SmmCore.
@ -1123,6 +1157,11 @@ SmiHandlerProfileRegisterHandler (
SMI_ENTRY *SmiEntry; SMI_ENTRY *SmiEntry;
LIST_ENTRY *List; LIST_ENTRY *List;
if (((ContextSize == 0) && (Context != NULL)) ||
((ContextSize != 0) && (Context == NULL))) {
return EFI_INVALID_PARAMETER;
}
SmiHandler = AllocateZeroPool (sizeof (SMI_HANDLER)); SmiHandler = AllocateZeroPool (sizeof (SMI_HANDLER));
if (SmiHandler == NULL) { if (SmiHandler == NULL) {
return EFI_OUT_OF_RESOURCES; return EFI_OUT_OF_RESOURCES;
@ -1131,33 +1170,24 @@ SmiHandlerProfileRegisterHandler (
SmiHandler->Signature = SMI_HANDLER_SIGNATURE; SmiHandler->Signature = SMI_HANDLER_SIGNATURE;
SmiHandler->Handler = Handler; SmiHandler->Handler = Handler;
SmiHandler->CallerAddr = (UINTN)CallerAddress; SmiHandler->CallerAddr = (UINTN)CallerAddress;
if (ContextSize != 0 && Context != NULL) { SmiHandler->Context = Context;
SmiHandler->ContextSize = ContextSize;
if (Context != NULL) {
if (CompareGuid (HandlerGuid, &gEfiSmmUsbDispatch2ProtocolGuid)) { if (CompareGuid (HandlerGuid, &gEfiSmmUsbDispatch2ProtocolGuid)) {
EFI_SMM_USB_REGISTER_CONTEXT *UsbContext; SmiHandler->Context = ConvertSmiHandlerUsbContext (Context, ContextSize, &SmiHandler->ContextSize);
UINTN DevicePathSize;
SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT *SmiHandlerUsbContext;
ASSERT (ContextSize == sizeof(EFI_SMM_USB_REGISTER_CONTEXT));
UsbContext = (EFI_SMM_USB_REGISTER_CONTEXT *)Context;
DevicePathSize = GetDevicePathSize (UsbContext->Device);
SmiHandlerUsbContext = AllocatePool (sizeof (SMI_HANDLER_PROFILE_USB_REGISTER_CONTEXT) + DevicePathSize);
if (SmiHandlerUsbContext != NULL) {
SmiHandlerUsbContext->Type = UsbContext->Type;
SmiHandlerUsbContext->DevicePathSize = (UINT32)DevicePathSize;
CopyMem (SmiHandlerUsbContext + 1, UsbContext->Device, DevicePathSize);
SmiHandler->Context = SmiHandlerUsbContext;
}
} else { } else {
SmiHandler->Context = AllocateCopyPool (ContextSize, Context); SmiHandler->Context = AllocateCopyPool (ContextSize, Context);
} }
} }
if (SmiHandler->Context != NULL) { if (SmiHandler->Context == NULL) {
SmiHandler->ContextSize = ContextSize; SmiHandler->ContextSize = 0;
} }
SmiEntry = SmmCoreFindHardwareSmiEntry (HandlerGuid, TRUE); SmiEntry = SmmCoreFindHardwareSmiEntry (HandlerGuid, TRUE);
if (SmiEntry == NULL) { if (SmiEntry == NULL) {
FreePool (SmiHandler->Context);
FreePool (SmiHandler);
return EFI_OUT_OF_RESOURCES; return EFI_OUT_OF_RESOURCES;
} }
@ -1178,6 +1208,10 @@ SmiHandlerProfileRegisterHandler (
For the SmmChildDispatch protocol, the HandlerGuid For the SmmChildDispatch protocol, the HandlerGuid
must be the GUID of SmmChildDispatch protocol. must be the GUID of SmmChildDispatch protocol.
@param Handler The SMI handler. @param Handler The SMI handler.
@param Context The context of the SMI handler.
If it is NOT NULL, it will be used to check what is registered.
@param ContextSize The size of the context in bytes.
If Context is NOT NULL, it will be used to check what is registered.
@retval EFI_SUCCESS The original record is removed. @retval EFI_SUCCESS The original record is removed.
@retval EFI_NOT_FOUND There is no record for the HandlerGuid and handler. @retval EFI_NOT_FOUND There is no record for the HandlerGuid and handler.
@ -1187,7 +1221,9 @@ EFIAPI
SmiHandlerProfileUnregisterHandler ( SmiHandlerProfileUnregisterHandler (
IN SMI_HANDLER_PROFILE_PROTOCOL *This, IN SMI_HANDLER_PROFILE_PROTOCOL *This,
IN EFI_GUID *HandlerGuid, IN EFI_GUID *HandlerGuid,
IN EFI_SMM_HANDLER_ENTRY_POINT2 Handler IN EFI_SMM_HANDLER_ENTRY_POINT2 Handler,
IN VOID *Context, OPTIONAL
IN UINTN ContextSize OPTIONAL
) )
{ {
LIST_ENTRY *Link; LIST_ENTRY *Link;
@ -1195,21 +1231,46 @@ SmiHandlerProfileUnregisterHandler (
SMI_HANDLER *SmiHandler; SMI_HANDLER *SmiHandler;
SMI_ENTRY *SmiEntry; SMI_ENTRY *SmiEntry;
SMI_HANDLER *TargetSmiHandler; SMI_HANDLER *TargetSmiHandler;
VOID *SearchContext;
UINTN SearchContextSize;
if (((ContextSize == 0) && (Context != NULL)) ||
((ContextSize != 0) && (Context == NULL))) {
return EFI_INVALID_PARAMETER;
}
SmiEntry = SmmCoreFindHardwareSmiEntry (HandlerGuid, FALSE); SmiEntry = SmmCoreFindHardwareSmiEntry (HandlerGuid, FALSE);
if (SmiEntry == NULL) { if (SmiEntry == NULL) {
return EFI_NOT_FOUND; return EFI_NOT_FOUND;
} }
SearchContext = Context;
SearchContextSize = ContextSize;
if (Context != NULL) {
if (CompareGuid (HandlerGuid, &gEfiSmmUsbDispatch2ProtocolGuid)) {
SearchContext = ConvertSmiHandlerUsbContext (Context, ContextSize, &SearchContextSize);
}
}
TargetSmiHandler = NULL; TargetSmiHandler = NULL;
Head = &SmiEntry->SmiHandlers; Head = &SmiEntry->SmiHandlers;
for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) { for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {
SmiHandler = CR (Link, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE); SmiHandler = CR (Link, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);
if (SmiHandler->Handler == Handler) { if (SmiHandler->Handler == Handler) {
TargetSmiHandler = SmiHandler; if ((SearchContext == NULL) ||
break; ((SearchContextSize == SmiHandler->ContextSize) && (CompareMem (SearchContext, SmiHandler->Context, SearchContextSize) == 0))) {
TargetSmiHandler = SmiHandler;
break;
}
} }
} }
if (SearchContext != NULL) {
if (CompareGuid (HandlerGuid, &gEfiSmmUsbDispatch2ProtocolGuid)) {
FreePool (SearchContext);
}
}
if (TargetSmiHandler == NULL) { if (TargetSmiHandler == NULL) {
return EFI_NOT_FOUND; return EFI_NOT_FOUND;
} }