ArmPkg: Introduce SCMI protocol

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

/** @file\r
\r
  Copyright (c) 2017-2018, Arm Limited. All rights reserved.\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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 <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Protocol/ArmScmiBaseProtocol.h>\r
\r
#include "ArmScmiBaseProtocolPrivate.h"\r
#include "ScmiPrivate.h"\r
\r
/** Return version of the Base protocol supported by SCP firmware.\r
\r
  @param[in]  This     A Pointer to SCMI_BASE_PROTOCOL Instance.\r
\r
  @param[out] Version  Version of the supported SCMI Base protocol.\r
\r
  @retval EFI_SUCCESS       The version of the protocol is returned.\r
  @retval EFI_DEVICE_ERROR  SCP returns an SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
STATIC\r
EFI_STATUS\r
BaseGetVersion (\r
  IN  SCMI_BASE_PROTOCOL  *This,\r
  OUT UINT32              *Version\r
  )\r
{\r
  return ScmiGetProtocolVersion (SCMI_PROTOCOL_ID_BASE, Version);\r
}\r
\r
/** Return total number of SCMI protocols supported by the SCP firmware.\r
\r
  @param[in]  This           A Pointer to SCMI_BASE_PROTOCOL Instance.\r
\r
  @param[out] TotalProtocols Total number of SCMI protocols supported.\r
\r
  @retval EFI_SUCCESS       Total number of protocols supported are returned.\r
  @retval EFI_DEVICE_ERROR  SCP returns a SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
STATIC\r
EFI_STATUS\r
BaseGetTotalProtocols (\r
  IN  SCMI_BASE_PROTOCOL  *This,\r
  OUT UINT32              *TotalProtocols\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT32      *ReturnValues;\r
\r
  Status = ScmiGetProtocolAttributes (SCMI_PROTOCOL_ID_BASE, &ReturnValues);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  *TotalProtocols = SCMI_TOTAL_PROTOCOLS (ReturnValues[0]);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Common function which returns vendor details.\r
\r
  @param[in] MessageId       SCMI_MESSAGE_ID_BASE_DISCOVER_VENDOR\r
                             OR\r
                             SCMI_MESSAGE_ID_BASE_DISCOVER_SUB_VENDOR\r
\r
  @param[out] VendorIdentifier ASCII name of the vendor/subvendor.\r
\r
  @retval EFI_SUCCESS       VendorIdentifier is returned.\r
  @retval EFI_DEVICE_ERROR  SCP returns an SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
STATIC\r
EFI_STATUS\r
BaseDiscoverVendorDetails (\r
  IN  SCMI_MESSAGE_ID_BASE  MessageId,\r
  OUT UINT8                 VendorIdentifier[SCMI_MAX_STR_LEN]\r
  )\r
{\r
  EFI_STATUS    Status;\r
  UINT32        *ReturnValues;\r
  SCMI_COMMAND  Cmd;\r
  UINT32        PayloadLength;\r
\r
  Cmd.ProtocolId = SCMI_PROTOCOL_ID_BASE;\r
  Cmd.MessageId  = MessageId;\r
\r
  PayloadLength = 0;\r
\r
  Status = ScmiCommandExecute (\r
             &Cmd,\r
             &PayloadLength,\r
             &ReturnValues\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  AsciiStrCpyS (\r
    (CHAR8*)VendorIdentifier,\r
    SCMI_MAX_STR_LEN,\r
    (CONST CHAR8*)ReturnValues\r
    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Return vendor name.\r
\r
  @param[in] This           A Pointer to SCMI_BASE_PROTOCOL Instance.\r
\r
  @param[out] VendorIdentifier Null terminated ASCII string of up to\r
                               16 bytes with a vendor name.\r
\r
  @retval EFI_SUCCESS       VendorIdentifier is returned.\r
  @retval EFI_DEVICE_ERROR  SCP returns a SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
STATIC\r
EFI_STATUS\r
BaseDiscoverVendor (\r
  IN  SCMI_BASE_PROTOCOL  *This,\r
  OUT UINT8               VendorIdentifier[SCMI_MAX_STR_LEN]\r
  )\r
{\r
  return BaseDiscoverVendorDetails (\r
           SCMI_MESSAGE_ID_BASE_DISCOVER_VENDOR,\r
           VendorIdentifier\r
           );\r
}\r
\r
/** Return sub vendor name.\r
\r
  @param[in]  This           A Pointer to SCMI_BASE_PROTOCOL Instance.\r
\r
  @param[out] VendorIdentifier Null terminated ASCII string of up to\r
                               16 bytes with a sub vendor name.\r
\r
  @retval EFI_SUCCESS       VendorIdentifier is returned.\r
  @retval EFI_DEVICE_ERROR  SCP returns a SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
EFI_STATUS\r
BaseDiscoverSubVendor (\r
  IN  SCMI_BASE_PROTOCOL  *This,\r
  OUT UINT8               VendorIdentifier[SCMI_MAX_STR_LEN]\r
  )\r
{\r
  return BaseDiscoverVendorDetails (\r
           SCMI_MESSAGE_ID_BASE_DISCOVER_SUB_VENDOR,\r
           VendorIdentifier\r
           );\r
}\r
\r
/** Return implementation version.\r
\r
  @param[in] This           A Pointer to SCMI_BASE_PROTOCOL Instance.\r
\r
  @param[out] ImplementationVersion Vendor specific implementation version.\r
\r
  @retval EFI_SUCCESS       Implementation version is returned.\r
  @retval EFI_DEVICE_ERROR  SCP returns a SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
STATIC\r
EFI_STATUS\r
BaseDiscoverImplVersion (\r
  IN  SCMI_BASE_PROTOCOL  *This,\r
  OUT UINT32              *ImplementationVersion\r
  )\r
{\r
  EFI_STATUS    Status;\r
  UINT32        *ReturnValues;\r
  SCMI_COMMAND  Cmd;\r
  UINT32        PayloadLength;\r
\r
  Cmd.ProtocolId = SCMI_PROTOCOL_ID_BASE;\r
  Cmd.MessageId  = SCMI_MESSAGE_ID_BASE_DISCOVER_IMPLEMENTATION_VERSION;\r
\r
  PayloadLength = 0;\r
\r
  Status = ScmiCommandExecute (\r
             &Cmd,\r
             &PayloadLength,\r
             &ReturnValues\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  *ImplementationVersion = ReturnValues[0];\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Return list of protocols.\r
\r
  @param[in]  This           A Pointer to SCMI_BASE_PROTOCOL Instance.\r
\r
  @param[out] ProtocolListSize  Size of the ProtocolList.\r
\r
  @param[out] ProtocolList   Protocol list.\r
\r
  @retval EFI_SUCCESS          List of protocols is returned.\r
  @retval EFI_BUFFER_TOO_SMALL ProtocolListSize is too small for the result.\r
                                It has been updated to the size needed.\r
  @retval EFI_DEVICE_ERROR     SCP returns a SCMI error.\r
  @retval !(EFI_SUCCESS)       Other errors.\r
**/\r
STATIC\r
EFI_STATUS\r
BaseDiscoverListProtocols (\r
  IN     SCMI_BASE_PROTOCOL  *This,\r
  IN OUT UINT32              *ProtocolListSize,\r
  OUT    UINT8               *ProtocolList\r
  )\r
{\r
  EFI_STATUS          Status;\r
  UINT32              TotalProtocols;\r
  UINT32              *MessageParams;\r
  BASE_DISCOVER_LIST  *DiscoverList;\r
  UINT32              Skip;\r
  UINT32              Index;\r
  SCMI_COMMAND        Cmd;\r
  UINT32              PayloadLength;\r
  UINT32              RequiredSize;\r
\r
  Status = BaseGetTotalProtocols (This, &TotalProtocols);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = ScmiCommandGetPayload (&MessageParams);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  RequiredSize = sizeof (UINT8) * TotalProtocols;\r
  if (*ProtocolListSize < RequiredSize) {\r
    *ProtocolListSize = RequiredSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  Cmd.ProtocolId = SCMI_PROTOCOL_ID_BASE;\r
  Cmd.MessageId  = SCMI_MESSAGE_ID_BASE_DISCOVER_LIST_PROTOCOLS;\r
\r
  Skip = 0;\r
\r
  while (Skip < TotalProtocols) {\r
\r
    *MessageParams = Skip;\r
\r
    // Note PayloadLength is a IN/OUT parameter.\r
    PayloadLength = sizeof (Skip);\r
\r
    Status = ScmiCommandExecute (\r
               &Cmd,\r
               &PayloadLength,\r
               (UINT32**)&DiscoverList\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    for (Index = 0; Index < DiscoverList->NumProtocols; Index++) {\r
      ProtocolList[Skip++] = DiscoverList->Protocols[Index];\r
    }\r
  }\r
\r
  *ProtocolListSize = RequiredSize;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
// Instance of the SCMI Base protocol.\r
STATIC CONST SCMI_BASE_PROTOCOL BaseProtocol = {\r
  BaseGetVersion,\r
  BaseGetTotalProtocols,\r
  BaseDiscoverVendor,\r
  BaseDiscoverSubVendor,\r
  BaseDiscoverImplVersion,\r
  BaseDiscoverListProtocols\r
};\r
\r
/** Initialize Base protocol and install protocol on a given handle.\r
\r
   @param[in] Handle              Handle to install Base protocol.\r
\r
   @retval EFI_SUCCESS            Base protocol interface installed\r
                                  successfully.\r
**/\r
EFI_STATUS\r
ScmiBaseProtocolInit (\r
  IN OUT EFI_HANDLE* Handle\r
  )\r
{\r
  return gBS->InstallMultipleProtocolInterfaces (\r
                Handle,\r
                &gArmScmiBaseProtocolGuid,\r
                &BaseProtocol,\r
                NULL\r
                );\r
}\r