ArmPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ArmPkg / Drivers / ArmScmiDxe / ScmiDxe.c

/** @file\r
\r
  Copyright (c) 2017-2018, Arm Limited. All rights reserved.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  System Control and Management Interface V1.0\r
    http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/\r
    DEN0056A_System_Control_and_Management_Interface.pdf\r
**/\r
\r
#include <Base.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Protocol/ArmScmiBaseProtocol.h>\r
#include <Protocol/ArmScmiClockProtocol.h>\r
#include <Protocol/ArmScmiPerformanceProtocol.h>\r
\r
#include "ArmScmiBaseProtocolPrivate.h"\r
#include "ArmScmiClockProtocolPrivate.h"\r
#include "ArmScmiPerformanceProtocolPrivate.h"\r
#include "ScmiDxe.h"\r
#include "ScmiPrivate.h"\r
\r
STATIC CONST SCMI_PROTOCOL_ENTRY Protocols[] = {\r
  { SCMI_PROTOCOL_ID_BASE, ScmiBaseProtocolInit },\r
  { SCMI_PROTOCOL_ID_PERFORMANCE, ScmiPerformanceProtocolInit },\r
  { SCMI_PROTOCOL_ID_CLOCK, ScmiClockProtocolInit }\r
};\r
\r
/** ARM SCMI driver entry point function.\r
\r
  This function installs the SCMI Base protocol and a list of other\r
  protocols is queried using the Base protocol. If protocol is supported,\r
  driver will call each protocol init function to install the protocol on\r
  the ImageHandle.\r
\r
  @param[in] ImageHandle     Handle to this EFI Image which will be used to\r
                             install Base, Clock and Performance protocols.\r
  @param[in] SystemTable     A pointer to boot time system table.\r
\r
  @retval EFI_SUCCESS       Driver initalized successfully.\r
  @retval EFI_UNSUPPORTED   If SCMI base protocol version is not supported.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ArmScmiDxeEntryPoint (\r
  IN EFI_HANDLE             ImageHandle,\r
  IN EFI_SYSTEM_TABLE       *SystemTable\r
  )\r
{\r
  EFI_STATUS          Status;\r
  SCMI_BASE_PROTOCOL  *BaseProtocol;\r
  UINT32              Version;\r
  UINT32              Index;\r
  UINT32              NumProtocols;\r
  UINT32              ProtocolIndex;\r
  UINT8               *SupportedList;\r
  UINT32              SupportedListSize;\r
\r
  // Every SCMI implementation must implement the base protocol.\r
  ASSERT (Protocols[0].Id == SCMI_PROTOCOL_ID_BASE);\r
\r
  Status = ScmiBaseProtocolInit (&ImageHandle);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (FALSE);\r
    return Status;\r
  }\r
\r
  Status = gBS->LocateProtocol (\r
                  &gArmScmiBaseProtocolGuid,\r
                  NULL,\r
                  (VOID**)&BaseProtocol\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (FALSE);\r
    return Status;\r
  }\r
\r
  // Get SCMI Base protocol version.\r
  Status = BaseProtocol->GetVersion (BaseProtocol, &Version);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (FALSE);\r
    return Status;\r
  }\r
\r
  if (Version != BASE_PROTOCOL_VERSION) {\r
    ASSERT (FALSE);\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  // Apart from Base protocol, SCMI may implement various other protocols,\r
  // query total protocols implemented by the SCP firmware.\r
  NumProtocols = 0;\r
  Status = BaseProtocol->GetTotalProtocols (BaseProtocol, &NumProtocols);\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (FALSE);\r
    return Status;\r
  }\r
\r
  ASSERT (NumProtocols != 0);\r
\r
  SupportedListSize = (NumProtocols * sizeof (*SupportedList));\r
\r
  Status = gBS->AllocatePool (\r
                  EfiBootServicesData,\r
                  SupportedListSize,\r
                  (VOID**)&SupportedList\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT (FALSE);\r
    return Status;\r
  }\r
\r
  // Get the list of protocols supported by SCP firmware on the platform.\r
  Status = BaseProtocol->DiscoverListProtocols (\r
                           BaseProtocol,\r
                           &SupportedListSize,\r
                           SupportedList\r
                           );\r
  if (EFI_ERROR (Status)) {\r
    gBS->FreePool (SupportedList);\r
    ASSERT (FALSE);\r
    return Status;\r
  }\r
\r
  // Install supported protocol on ImageHandle.\r
  for (ProtocolIndex = 1; ProtocolIndex < ARRAY_SIZE (Protocols);\r
       ProtocolIndex++) {\r
    for (Index = 0; Index < NumProtocols; Index++) {\r
      if (Protocols[ProtocolIndex].Id == SupportedList[Index]) {\r
        Status = Protocols[ProtocolIndex].InitFn (&ImageHandle);\r
        if (EFI_ERROR (Status)) {\r
          ASSERT_EFI_ERROR (Status);\r
          return Status;\r
        }\r
        break;\r
      }\r
    }\r
  }\r
\r
  gBS->FreePool (SupportedList);\r
\r
  return EFI_SUCCESS;\r
}\r