SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Hash2DxeCrypto / Driver.c

/** @file\r
  This is service binding for Hash driver.\r
\r
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Driver.h"\r
\r
EFI_SERVICE_BINDING_PROTOCOL    mHash2ServiceBindingProtocol = {\r
  Hash2ServiceBindingCreateChild,\r
  Hash2ServiceBindingDestroyChild\r
};\r
\r
/**\r
  Creates a child handle with a set of I/O services.\r
\r
  @param[in]       This              Protocol instance pointer.\r
  @param[in, out]  ChildHandle       Pointer to the handle of the child to create. If\r
                                     it is NULL, then a new handle is created. If\r
                                     it is not NULL, then the I/O services are added\r
                                     to the existing child handle.\r
\r
  @retval EFI_SUCCES                 The protocol was added to ChildHandle.\r
  @retval EFI_INVALID_PARAMETER      ChildHandle is NULL.\r
  @retval EFI_OUT_OF_RESOURCES       There are not enough resources available to\r
                                     create the child.\r
  @retval Others                     The child handle was not created.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Hash2ServiceBindingCreateChild (\r
  IN     EFI_SERVICE_BINDING_PROTOCOL    *This,\r
  IN OUT EFI_HANDLE                      *ChildHandle\r
  )\r
{\r
  EFI_STATUS          Status;\r
  HASH2_SERVICE_DATA  *Hash2ServiceData;\r
  HASH2_INSTANCE_DATA *Instance;\r
  EFI_TPL             OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Hash2ServiceData = HASH2_SERVICE_DATA_FROM_THIS (This);\r
\r
  //\r
  // Allocate buffer for the new instance.\r
  //\r
  Instance = AllocateZeroPool (sizeof (HASH2_INSTANCE_DATA));\r
  if (Instance == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Init the instance data.\r
  //\r
  Instance->Signature = HASH2_INSTANCE_DATA_SIGNATURE;\r
  CopyMem (&Instance->Hash2Protocol, &mHash2Protocol, sizeof (Instance->Hash2Protocol));\r
  Instance->Hash2ServiceData = Hash2ServiceData;\r
\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiHash2ProtocolGuid,\r
                  &Instance->Hash2Protocol,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    FreePool (Instance);\r
    return Status;\r
  }\r
\r
  Instance->Handle = *ChildHandle;\r
\r
  //\r
  // Add the child instance into ChildrenList.\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  InsertTailList (&Hash2ServiceData->ChildrenList, &Instance->InstEntry);\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Destroys a child handle with a set of I/O services.\r
\r
  The DestroyChild() function does the opposite of CreateChild(). It removes a\r
  protocol that was installed by CreateChild() from ChildHandle. If the removed\r
  protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
  @param[in]  This               Pointer to the EFI_SERVICE_BINDING_PROTOCOL\r
                                 instance.\r
  @param[in]  ChildHandle        Handle of the child to destroy.\r
\r
  @retval EFI_SUCCES             The protocol was removed from ChildHandle.\r
  @retval EFI_UNSUPPORTED        ChildHandle does not support the protocol that\r
                                 is being removed.\r
  @retval EFI_INVALID_PARAMETER  ChildHandle is NULL.\r
  @retval EFI_ACCESS_DENIED      The protocol could not be removed from the\r
                                 ChildHandle because its services are being\r
                                 used.\r
  @retval Others                 The child handle was not destroyed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Hash2ServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                      ChildHandle\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  HASH2_SERVICE_DATA             *Hash2ServiceData;\r
  EFI_HASH2_PROTOCOL             *Hash2Protocol;\r
  HASH2_INSTANCE_DATA            *Instance;\r
  EFI_TPL                        OldTpl;\r
  LIST_ENTRY                     *Entry;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Hash2ServiceData = HASH2_SERVICE_DATA_FROM_THIS (This);\r
\r
  //\r
  // Check if this ChildHandle is valid\r
  //\r
  Instance = NULL;\r
  for(Entry = (&Hash2ServiceData->ChildrenList)->ForwardLink; Entry != (&Hash2ServiceData->ChildrenList); Entry = Entry->ForwardLink) {\r
    Instance = HASH2_INSTANCE_DATA_FROM_LINK (Entry);\r
    if (Instance->Handle == ChildHandle) {\r
      break;\r
    } else {\r
      Instance = NULL;\r
    }\r
  }\r
  if (Instance == NULL) {\r
    DEBUG ((EFI_D_ERROR, "Hash2ServiceBindingDestroyChild - Invalid handle\n"));\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Get HashProtocol\r
  //\r
  Status = gBS->HandleProtocol (\r
                  ChildHandle,\r
                  &gEfiHash2ProtocolGuid,\r
                  (VOID **)&Hash2Protocol\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ASSERT (Hash2Protocol == &Instance->Hash2Protocol);\r
\r
  //\r
  // Uninstall the Hash protocol.\r
  //\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiHash2ProtocolGuid,\r
                  &Instance->Hash2Protocol,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  //\r
  // Remove this instance from the ChildrenList.\r
  //\r
  RemoveEntryList (&Instance->InstEntry);\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  FreePool (Instance);\r
\r
  return Status;\r
}\r
\r
/**\r
  The entry point for Hash driver which installs the service binding protocol.\r
\r
  @param[in]  ImageHandle  The image handle of the driver.\r
  @param[in]  SystemTable  The system table.\r
\r
  @retval EFI_SUCCES       The service binding protocols is successfully installed.\r
  @retval Others           Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Hash2DriverEntryPoint (\r
  IN EFI_HANDLE          ImageHandle,\r
  IN EFI_SYSTEM_TABLE    *SystemTable\r
  )\r
{\r
  EFI_STATUS         Status;\r
  HASH2_SERVICE_DATA *Hash2ServiceData;\r
\r
  //\r
  // Initialize the Hash Service Data.\r
  //\r
  Hash2ServiceData = AllocateZeroPool (sizeof (HASH2_SERVICE_DATA));\r
  if (Hash2ServiceData == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Hash2ServiceData->Signature     = HASH2_SERVICE_DATA_SIGNATURE;\r
  CopyMem (&Hash2ServiceData->ServiceBinding, &mHash2ServiceBindingProtocol, sizeof (EFI_SERVICE_BINDING_PROTOCOL));\r
  InitializeListHead (&Hash2ServiceData->ChildrenList);\r
\r
  //\r
  // Install the HASH Service Binding Protocol\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Hash2ServiceData->ServiceHandle,\r
                  &gEfiHash2ServiceBindingProtocolGuid,\r
                  &Hash2ServiceData->ServiceBinding,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    FreePool (Hash2ServiceData);\r
  }\r
\r
  return Status;\r
}\r