MdeModulePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  SMI management.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PiSmmCore.h"\r
\r
LIST_ENTRY  mSmiEntryList       = INITIALIZE_LIST_HEAD_VARIABLE (mSmiEntryList);\r
\r
SMI_ENTRY   mRootSmiEntry = {\r
  SMI_ENTRY_SIGNATURE,\r
  INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiEntry.AllEntries),\r
  {0},\r
  INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiEntry.SmiHandlers),\r
};\r
\r
/**\r
  Finds the SMI entry for the requested handler type.\r
\r
  @param  HandlerType            The type of the interrupt\r
  @param  Create                 Create a new entry if not found\r
\r
  @return SMI entry\r
\r
**/\r
SMI_ENTRY  *\r
EFIAPI\r
SmmCoreFindSmiEntry (\r
  IN EFI_GUID  *HandlerType,\r
  IN BOOLEAN   Create\r
  )\r
{\r
  LIST_ENTRY  *Link;\r
  SMI_ENTRY   *Item;\r
  SMI_ENTRY   *SmiEntry;\r
\r
  //\r
  // Search the SMI entry list for the matching GUID\r
  //\r
  SmiEntry = NULL;\r
  for (Link = mSmiEntryList.ForwardLink;\r
       Link != &mSmiEntryList;\r
       Link = Link->ForwardLink) {\r
\r
    Item = CR (Link, SMI_ENTRY, AllEntries, SMI_ENTRY_SIGNATURE);\r
    if (CompareGuid (&Item->HandlerType, HandlerType)) {\r
      //\r
      // This is the SMI entry\r
      //\r
      SmiEntry = Item;\r
      break;\r
    }\r
  }\r
\r
  //\r
  // If the protocol entry was not found and Create is TRUE, then\r
  // allocate a new entry\r
  //\r
  if ((SmiEntry == NULL) && Create) {\r
    SmiEntry = AllocatePool (sizeof(SMI_ENTRY));\r
    if (SmiEntry != NULL) {\r
      //\r
      // Initialize new SMI entry structure\r
      //\r
      SmiEntry->Signature = SMI_ENTRY_SIGNATURE;\r
      CopyGuid ((VOID *)&SmiEntry->HandlerType, HandlerType);\r
      InitializeListHead (&SmiEntry->SmiHandlers);\r
\r
      //\r
      // Add it to SMI entry list\r
      //\r
      InsertTailList (&mSmiEntryList, &SmiEntry->AllEntries);\r
    }\r
  }\r
  return SmiEntry;\r
}\r
\r
/**\r
  Manage SMI of a particular type.\r
\r
  @param  HandlerType    Points to the handler type or NULL for root SMI handlers.\r
  @param  Context        Points to an optional context buffer.\r
  @param  CommBuffer     Points to the optional communication buffer.\r
  @param  CommBufferSize Points to the size of the optional communication buffer.\r
\r
  @retval EFI_WARN_INTERRUPT_SOURCE_PENDING  Interrupt source was processed successfully but not quiesced.\r
  @retval EFI_INTERRUPT_PENDING              One or more SMI sources could not be quiesced.\r
  @retval EFI_NOT_FOUND                      Interrupt source was not handled or quiesced.\r
  @retval EFI_SUCCESS                        Interrupt source was handled and quiesced.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmiManage (\r
  IN     CONST EFI_GUID  *HandlerType,\r
  IN     CONST VOID      *Context         OPTIONAL,\r
  IN OUT VOID            *CommBuffer      OPTIONAL,\r
  IN OUT UINTN           *CommBufferSize  OPTIONAL\r
  )\r
{\r
  LIST_ENTRY   *Link;\r
  LIST_ENTRY   *Head;\r
  SMI_ENTRY    *SmiEntry;\r
  SMI_HANDLER  *SmiHandler;\r
  BOOLEAN      SuccessReturn;\r
  EFI_STATUS   Status;\r
\r
  Status = EFI_NOT_FOUND;\r
  SuccessReturn = FALSE;\r
  if (HandlerType == NULL) {\r
    //\r
    // Root SMI handler\r
    //\r
    SmiEntry = &mRootSmiEntry;\r
  } else {\r
    //\r
    // Non-root SMI handler\r
    //\r
    SmiEntry = SmmCoreFindSmiEntry ((EFI_GUID *) HandlerType, FALSE);\r
    if (SmiEntry == NULL) {\r
      //\r
      // There is no handler registered for this interrupt source\r
      //\r
      return Status;\r
    }\r
  }\r
  Head = &SmiEntry->SmiHandlers;\r
\r
  for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {\r
    SmiHandler = CR (Link, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
\r
    Status = SmiHandler->Handler (\r
               (EFI_HANDLE) SmiHandler,\r
               Context,\r
               CommBuffer,\r
               CommBufferSize\r
               );\r
\r
    switch (Status) {\r
    case EFI_INTERRUPT_PENDING:\r
      //\r
      // If a handler returns EFI_INTERRUPT_PENDING and HandlerType is not NULL then\r
      // no additional handlers will be processed and EFI_INTERRUPT_PENDING will be returned.\r
      //\r
      if (HandlerType != NULL) {\r
        return EFI_INTERRUPT_PENDING;\r
      }\r
      break;\r
\r
    case EFI_SUCCESS:\r
      //\r
      // If at least one of the handlers returns EFI_SUCCESS then the function will return\r
      // EFI_SUCCESS. If a handler returns EFI_SUCCESS and HandlerType is not NULL then no\r
      // additional handlers will be processed.\r
      //\r
      if (HandlerType != NULL) {\r
        return EFI_SUCCESS;\r
      }\r
      SuccessReturn = TRUE;\r
      break;\r
\r
    case EFI_WARN_INTERRUPT_SOURCE_QUIESCED:\r
      //\r
      // If at least one of the handlers returns EFI_WARN_INTERRUPT_SOURCE_QUIESCED\r
      // then the function will return EFI_SUCCESS.\r
      //\r
      SuccessReturn = TRUE;\r
      break;\r
\r
    case EFI_WARN_INTERRUPT_SOURCE_PENDING:\r
      //\r
      // If all the handlers returned EFI_WARN_INTERRUPT_SOURCE_PENDING\r
      // then EFI_WARN_INTERRUPT_SOURCE_PENDING will be returned.\r
      //\r
      break;\r
\r
    default:\r
      //\r
      // Unexpected status code returned.\r
      //\r
      ASSERT (FALSE);\r
      break;\r
    }\r
  }\r
\r
  if (SuccessReturn) {\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Registers a handler to execute within SMM.\r
\r
  @param  Handler        Handler service funtion pointer.\r
  @param  HandlerType    Points to the handler type or NULL for root SMI handlers.\r
  @param  DispatchHandle On return, contains a unique handle which can be used to later unregister the handler function.\r
\r
  @retval EFI_SUCCESS           Handler register success.\r
  @retval EFI_INVALID_PARAMETER Handler or DispatchHandle is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmiHandlerRegister (\r
  IN  EFI_SMM_HANDLER_ENTRY_POINT2  Handler,\r
  IN  CONST EFI_GUID                *HandlerType  OPTIONAL,\r
  OUT EFI_HANDLE                    *DispatchHandle\r
  )\r
{\r
  SMI_HANDLER  *SmiHandler;\r
  SMI_ENTRY    *SmiEntry;\r
  LIST_ENTRY   *List;\r
\r
  if (Handler == NULL || DispatchHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  SmiHandler = AllocateZeroPool (sizeof (SMI_HANDLER));\r
  if (SmiHandler == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  SmiHandler->Signature = SMI_HANDLER_SIGNATURE;\r
  SmiHandler->Handler = Handler;\r
  SmiHandler->CallerAddr = (UINTN)RETURN_ADDRESS (0);\r
\r
  if (HandlerType == NULL) {\r
    //\r
    // This is root SMI handler\r
    //\r
    SmiEntry = &mRootSmiEntry;\r
  } else {\r
    //\r
    // None root SMI handler\r
    //\r
    SmiEntry = SmmCoreFindSmiEntry ((EFI_GUID *) HandlerType, TRUE);\r
    if (SmiEntry == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
  }\r
  List = &SmiEntry->SmiHandlers;\r
\r
  SmiHandler->SmiEntry = SmiEntry;\r
  InsertTailList (List, &SmiHandler->Link);\r
\r
  *DispatchHandle = (EFI_HANDLE) SmiHandler;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Unregister a handler in SMM.\r
\r
  @param  DispatchHandle  The handle that was specified when the handler was registered.\r
\r
  @retval EFI_SUCCESS           Handler function was successfully unregistered.\r
  @retval EFI_INVALID_PARAMETER DispatchHandle does not refer to a valid handle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmiHandlerUnRegister (\r
  IN EFI_HANDLE  DispatchHandle\r
  )\r
{\r
  SMI_HANDLER  *SmiHandler;\r
  SMI_ENTRY    *SmiEntry;\r
  LIST_ENTRY   *EntryLink;\r
  LIST_ENTRY   *HandlerLink;\r
\r
  if (DispatchHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Look for it in root SMI handlers\r
  //\r
  SmiHandler = NULL;\r
  for ( HandlerLink = GetFirstNode (&mRootSmiEntry.SmiHandlers)\r
      ; !IsNull (&mRootSmiEntry.SmiHandlers, HandlerLink) && (SmiHandler != DispatchHandle)\r
      ; HandlerLink = GetNextNode (&mRootSmiEntry.SmiHandlers, HandlerLink)\r
      ) {\r
    SmiHandler = CR (HandlerLink, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
  }\r
\r
  //\r
  // Look for it in non-root SMI handlers\r
  //\r
  for ( EntryLink = GetFirstNode (&mSmiEntryList)\r
      ; !IsNull (&mSmiEntryList, EntryLink) && (SmiHandler != DispatchHandle)\r
      ; EntryLink = GetNextNode (&mSmiEntryList, EntryLink)\r
      ) {\r
    SmiEntry = CR (EntryLink, SMI_ENTRY, AllEntries, SMI_ENTRY_SIGNATURE);\r
    for ( HandlerLink = GetFirstNode (&SmiEntry->SmiHandlers)\r
        ; !IsNull (&SmiEntry->SmiHandlers, HandlerLink) && (SmiHandler != DispatchHandle)\r
        ; HandlerLink = GetNextNode (&SmiEntry->SmiHandlers, HandlerLink)\r
        ) {\r
      SmiHandler = CR (HandlerLink, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
    }\r
  }\r
\r
  if (SmiHandler != DispatchHandle) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  SmiEntry = SmiHandler->SmiEntry;\r
\r
  RemoveEntryList (&SmiHandler->Link);\r
  FreePool (SmiHandler);\r
\r
  if (SmiEntry == NULL) {\r
    //\r
    // This is root SMI handler\r
    //\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (IsListEmpty (&SmiEntry->SmiHandlers)) {\r
    //\r
    // No handler registered for this interrupt now, remove the SMI_ENTRY\r
    //\r
    RemoveEntryList (&SmiEntry->AllEntries);\r
\r
    FreePool (SmiEntry);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r