UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / StandaloneMmPkg / Core / Handle.c

/** @file\r
  SMM handle & protocol handling.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "StandaloneMmCore.h"\r
\r
//\r
// mProtocolDatabase     - A list of all protocols in the system.  (simple list for now)\r
// gHandleList           - A list of all the handles in the system\r
//\r
LIST_ENTRY  mProtocolDatabase = INITIALIZE_LIST_HEAD_VARIABLE (mProtocolDatabase);\r
LIST_ENTRY  gHandleList       = INITIALIZE_LIST_HEAD_VARIABLE (gHandleList);\r
\r
/**\r
  Check whether a handle is a valid EFI_HANDLE\r
\r
  @param  UserHandle             The handle to check\r
\r
  @retval EFI_INVALID_PARAMETER  The handle is NULL or not a valid EFI_HANDLE.\r
  @retval EFI_SUCCESS            The handle is valid EFI_HANDLE.\r
\r
**/\r
EFI_STATUS\r
MmValidateHandle (\r
  IN EFI_HANDLE  UserHandle\r
  )\r
{\r
  IHANDLE  *Handle;\r
\r
  Handle = (IHANDLE *)UserHandle;\r
  if (Handle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Handle->Signature != EFI_HANDLE_SIGNATURE) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Finds the protocol entry for the requested protocol.\r
\r
  @param  Protocol               The ID of the protocol\r
  @param  Create                 Create a new entry if not found\r
\r
  @return Protocol entry\r
\r
**/\r
PROTOCOL_ENTRY  *\r
MmFindProtocolEntry (\r
  IN EFI_GUID  *Protocol,\r
  IN BOOLEAN   Create\r
  )\r
{\r
  LIST_ENTRY      *Link;\r
  PROTOCOL_ENTRY  *Item;\r
  PROTOCOL_ENTRY  *ProtEntry;\r
\r
  //\r
  // Search the database for the matching GUID\r
  //\r
\r
  ProtEntry = NULL;\r
  for (Link = mProtocolDatabase.ForwardLink;\r
       Link != &mProtocolDatabase;\r
       Link = Link->ForwardLink)\r
  {\r
    Item = CR (Link, PROTOCOL_ENTRY, AllEntries, PROTOCOL_ENTRY_SIGNATURE);\r
    if (CompareGuid (&Item->ProtocolID, Protocol)) {\r
      //\r
      // This is the protocol entry\r
      //\r
      ProtEntry = 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 ((ProtEntry == NULL) && Create) {\r
    ProtEntry = AllocatePool (sizeof (PROTOCOL_ENTRY));\r
    if (ProtEntry != NULL) {\r
      //\r
      // Initialize new protocol entry structure\r
      //\r
      ProtEntry->Signature = PROTOCOL_ENTRY_SIGNATURE;\r
      CopyGuid ((VOID *)&ProtEntry->ProtocolID, Protocol);\r
      InitializeListHead (&ProtEntry->Protocols);\r
      InitializeListHead (&ProtEntry->Notify);\r
\r
      //\r
      // Add it to protocol database\r
      //\r
      InsertTailList (&mProtocolDatabase, &ProtEntry->AllEntries);\r
    }\r
  }\r
\r
  return ProtEntry;\r
}\r
\r
/**\r
  Finds the protocol instance for the requested handle and protocol.\r
  Note: This function doesn't do parameters checking, it's caller's responsibility\r
  to pass in valid parameters.\r
\r
  @param  Handle                 The handle to search the protocol on\r
  @param  Protocol               GUID of the protocol\r
  @param  Interface              The interface for the protocol being searched\r
\r
  @return Protocol instance (NULL: Not found)\r
\r
**/\r
PROTOCOL_INTERFACE *\r
MmFindProtocolInterface (\r
  IN IHANDLE   *Handle,\r
  IN EFI_GUID  *Protocol,\r
  IN VOID      *Interface\r
  )\r
{\r
  PROTOCOL_INTERFACE  *Prot;\r
  PROTOCOL_ENTRY      *ProtEntry;\r
  LIST_ENTRY          *Link;\r
\r
  Prot = NULL;\r
\r
  //\r
  // Lookup the protocol entry for this protocol ID\r
  //\r
  ProtEntry = MmFindProtocolEntry (Protocol, FALSE);\r
  if (ProtEntry != NULL) {\r
    //\r
    // Look at each protocol interface for any matches\r
    //\r
    for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
      //\r
      // If this protocol interface matches, remove it\r
      //\r
      Prot = CR (Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
      if ((Prot->Interface == Interface) && (Prot->Protocol == ProtEntry)) {\r
        break;\r
      }\r
\r
      Prot = NULL;\r
    }\r
  }\r
\r
  return Prot;\r
}\r
\r
/**\r
  Wrapper function to MmInstallProtocolInterfaceNotify.  This is the public API which\r
  Calls the private one which contains a BOOLEAN parameter for notifications\r
\r
  @param  UserHandle             The handle to install the protocol handler on,\r
                                 or NULL if a new handle is to be allocated\r
  @param  Protocol               The protocol to add to the handle\r
  @param  InterfaceType          Indicates whether Interface is supplied in\r
                                 native form.\r
  @param  Interface              The interface for the protocol being added\r
\r
  @return Status code\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MmInstallProtocolInterface (\r
  IN OUT EFI_HANDLE      *UserHandle,\r
  IN EFI_GUID            *Protocol,\r
  IN EFI_INTERFACE_TYPE  InterfaceType,\r
  IN VOID                *Interface\r
  )\r
{\r
  return MmInstallProtocolInterfaceNotify (\r
           UserHandle,\r
           Protocol,\r
           InterfaceType,\r
           Interface,\r
           TRUE\r
           );\r
}\r
\r
/**\r
  Installs a protocol interface into the boot services environment.\r
\r
  @param  UserHandle             The handle to install the protocol handler on,\r
                                 or NULL if a new handle is to be allocated\r
  @param  Protocol               The protocol to add to the handle\r
  @param  InterfaceType          Indicates whether Interface is supplied in\r
                                 native form.\r
  @param  Interface              The interface for the protocol being added\r
  @param  Notify                 indicates whether notify the notification list\r
                                 for this protocol\r
\r
  @retval EFI_INVALID_PARAMETER  Invalid parameter\r
  @retval EFI_OUT_OF_RESOURCES   No enough buffer to allocate\r
  @retval EFI_SUCCESS            Protocol interface successfully installed\r
\r
**/\r
EFI_STATUS\r
MmInstallProtocolInterfaceNotify (\r
  IN OUT EFI_HANDLE          *UserHandle,\r
  IN     EFI_GUID            *Protocol,\r
  IN     EFI_INTERFACE_TYPE  InterfaceType,\r
  IN     VOID                *Interface,\r
  IN     BOOLEAN             Notify\r
  )\r
{\r
  PROTOCOL_INTERFACE  *Prot;\r
  PROTOCOL_ENTRY      *ProtEntry;\r
  IHANDLE             *Handle;\r
  EFI_STATUS          Status;\r
  VOID                *ExistingInterface;\r
\r
  //\r
  // returns EFI_INVALID_PARAMETER if InterfaceType is invalid.\r
  // Also added check for invalid UserHandle and Protocol pointers.\r
  //\r
  if ((UserHandle == NULL) || (Protocol == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (InterfaceType != EFI_NATIVE_INTERFACE) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Print debug message\r
  //\r
  DEBUG ((DEBUG_LOAD | DEBUG_INFO, "MmInstallProtocolInterface: %g %p\n", Protocol, Interface));\r
\r
  Status = EFI_OUT_OF_RESOURCES;\r
  Prot   = NULL;\r
  Handle = NULL;\r
\r
  if (*UserHandle != NULL) {\r
    Status = MmHandleProtocol (*UserHandle, Protocol, (VOID **)&ExistingInterface);\r
    if (!EFI_ERROR (Status)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  //\r
  // Lookup the Protocol Entry for the requested protocol\r
  //\r
  ProtEntry = MmFindProtocolEntry (Protocol, TRUE);\r
  if (ProtEntry == NULL) {\r
    goto Done;\r
  }\r
\r
  //\r
  // Allocate a new protocol interface structure\r
  //\r
  Prot = AllocateZeroPool (sizeof (PROTOCOL_INTERFACE));\r
  if (Prot == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  //\r
  // If caller didn't supply a handle, allocate a new one\r
  //\r
  Handle = (IHANDLE *)*UserHandle;\r
  if (Handle == NULL) {\r
    Handle = AllocateZeroPool (sizeof (IHANDLE));\r
    if (Handle == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto Done;\r
    }\r
\r
    //\r
    // Initialize new handler structure\r
    //\r
    Handle->Signature = EFI_HANDLE_SIGNATURE;\r
    InitializeListHead (&Handle->Protocols);\r
\r
    //\r
    // Add this handle to the list global list of all handles\r
    // in the system\r
    //\r
    InsertTailList (&gHandleList, &Handle->AllHandles);\r
  }\r
\r
  Status = MmValidateHandle (Handle);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  //\r
  // Each interface that is added must be unique\r
  //\r
  ASSERT (MmFindProtocolInterface (Handle, Protocol, Interface) == NULL);\r
\r
  //\r
  // Initialize the protocol interface structure\r
  //\r
  Prot->Signature = PROTOCOL_INTERFACE_SIGNATURE;\r
  Prot->Handle    = Handle;\r
  Prot->Protocol  = ProtEntry;\r
  Prot->Interface = Interface;\r
\r
  //\r
  // Add this protocol interface to the head of the supported\r
  // protocol list for this handle\r
  //\r
  InsertHeadList (&Handle->Protocols, &Prot->Link);\r
\r
  //\r
  // Add this protocol interface to the tail of the\r
  // protocol entry\r
  //\r
  InsertTailList (&ProtEntry->Protocols, &Prot->ByProtocol);\r
\r
  //\r
  // Notify the notification list for this protocol\r
  //\r
  if (Notify) {\r
    MmNotifyProtocol (Prot);\r
  }\r
\r
  Status = EFI_SUCCESS;\r
\r
Done:\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Return the new handle back to the caller\r
    //\r
    *UserHandle = Handle;\r
  } else {\r
    //\r
    // There was an error, clean up\r
    //\r
    if (Prot != NULL) {\r
      FreePool (Prot);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Uninstalls all instances of a protocol:interfacer from a handle.\r
  If the last protocol interface is remove from the handle, the\r
  handle is freed.\r
\r
  @param  UserHandle             The handle to remove the protocol handler from\r
  @param  Protocol               The protocol, of protocol:interface, to remove\r
  @param  Interface              The interface, of protocol:interface, to remove\r
\r
  @retval EFI_INVALID_PARAMETER  Protocol is NULL.\r
  @retval EFI_SUCCESS            Protocol interface successfully uninstalled.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MmUninstallProtocolInterface (\r
  IN EFI_HANDLE  UserHandle,\r
  IN EFI_GUID    *Protocol,\r
  IN VOID        *Interface\r
  )\r
{\r
  EFI_STATUS          Status;\r
  IHANDLE             *Handle;\r
  PROTOCOL_INTERFACE  *Prot;\r
\r
  //\r
  // Check that Protocol is valid\r
  //\r
  if (Protocol == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check that UserHandle is a valid handle\r
  //\r
  Status = MmValidateHandle (UserHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Check that Protocol exists on UserHandle, and Interface matches the interface in the database\r
  //\r
  Prot = MmFindProtocolInterface (UserHandle, Protocol, Interface);\r
  if (Prot == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Remove the protocol interface from the protocol\r
  //\r
  Status = EFI_NOT_FOUND;\r
  Handle = (IHANDLE *)UserHandle;\r
  Prot   = MmRemoveInterfaceFromProtocol (Handle, Protocol, Interface);\r
\r
  if (Prot != NULL) {\r
    //\r
    // Remove the protocol interface from the handle\r
    //\r
    RemoveEntryList (&Prot->Link);\r
\r
    //\r
    // Free the memory\r
    //\r
    Prot->Signature = 0;\r
    FreePool (Prot);\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  //\r
  // If there are no more handlers for the handle, free the handle\r
  //\r
  if (IsListEmpty (&Handle->Protocols)) {\r
    Handle->Signature = 0;\r
    RemoveEntryList (&Handle->AllHandles);\r
    FreePool (Handle);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Locate a certain GUID protocol interface in a Handle's protocols.\r
\r
  @param  UserHandle             The handle to obtain the protocol interface on\r
  @param  Protocol               The GUID of the protocol\r
\r
  @return The requested protocol interface for the handle\r
\r
**/\r
PROTOCOL_INTERFACE  *\r
MmGetProtocolInterface (\r
  IN EFI_HANDLE  UserHandle,\r
  IN EFI_GUID    *Protocol\r
  )\r
{\r
  EFI_STATUS          Status;\r
  PROTOCOL_ENTRY      *ProtEntry;\r
  PROTOCOL_INTERFACE  *Prot;\r
  IHANDLE             *Handle;\r
  LIST_ENTRY          *Link;\r
\r
  Status = MmValidateHandle (UserHandle);\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  Handle = (IHANDLE *)UserHandle;\r
\r
  //\r
  // Look at each protocol interface for a match\r
  //\r
  for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
    Prot      = CR (Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
    ProtEntry = Prot->Protocol;\r
    if (CompareGuid (&ProtEntry->ProtocolID, Protocol)) {\r
      return Prot;\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
  Queries a handle to determine if it supports a specified protocol.\r
\r
  @param  UserHandle             The handle being queried.\r
  @param  Protocol               The published unique identifier of the protocol.\r
  @param  Interface              Supplies the address where a pointer to the\r
                                 corresponding Protocol Interface is returned.\r
\r
  @retval EFI_SUCCESS            The interface information for the specified protocol was returned.\r
  @retval EFI_UNSUPPORTED        The device does not support the specified protocol.\r
  @retval EFI_INVALID_PARAMETER  Handle is not a valid EFI_HANDLE..\r
  @retval EFI_INVALID_PARAMETER  Protocol is NULL.\r
  @retval EFI_INVALID_PARAMETER  Interface is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MmHandleProtocol (\r
  IN  EFI_HANDLE  UserHandle,\r
  IN  EFI_GUID    *Protocol,\r
  OUT VOID        **Interface\r
  )\r
{\r
  EFI_STATUS          Status;\r
  PROTOCOL_INTERFACE  *Prot;\r
\r
  //\r
  // Check for invalid Protocol\r
  //\r
  if (Protocol == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check for invalid Interface\r
  //\r
  if (Interface == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  } else {\r
    *Interface = NULL;\r
  }\r
\r
  //\r
  // Check for invalid UserHandle\r
  //\r
  Status = MmValidateHandle (UserHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Look at each protocol interface for a match\r
  //\r
  Prot = MmGetProtocolInterface (UserHandle, Protocol);\r
  if (Prot == NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // This is the protocol interface entry for this protocol\r
  //\r
  *Interface = Prot->Interface;\r
\r
  return EFI_SUCCESS;\r
}\r