ArmPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ArmPkg / Drivers / ArmScmiDxe / Scmi.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 <Library/ArmMtlLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include "ScmiPrivate.h"\r
\r
// Arbitrary timeout value 20ms.\r
#define  RESPONSE_TIMEOUT  20000\r
\r
/** Return a pointer to the message payload.\r
\r
  @param[out] Payload         Holds pointer to the message payload.\r
\r
  @retval EFI_SUCCESS         Payload holds a valid message payload pointer.\r
  @retval EFI_TIMEOUT         Time out error if MTL channel is busy.\r
  @retval EFI_UNSUPPORTED     If MTL channel is unsupported.\r
**/\r
EFI_STATUS\r
ScmiCommandGetPayload (\r
  OUT UINT32** Payload\r
  )\r
{\r
  EFI_STATUS   Status;\r
  MTL_CHANNEL  *Channel;\r
\r
  // Get handle to the Channel.\r
  Status = MtlGetChannel (MTL_CHANNEL_TYPE_LOW, &Channel);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Payload will not be populated until channel is free.\r
  Status = MtlWaitUntilChannelFree (Channel, RESPONSE_TIMEOUT);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Get the address of the payload.\r
  *Payload = MtlGetChannelPayload (Channel);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Execute a SCMI command and receive a response.\r
\r
  This function uses a MTL channel to transfer message to SCP\r
  and waits for a response.\r
\r
  @param[in]   Command      Pointer to the SCMI command (Protocol ID\r
                            and Message ID)\r
\r
  @param[in,out] PayloadLength   SCMI command message length.\r
\r
  @param[out] OPTIONAL  ReturnValues   Pointer to SCMI response.\r
\r
  @retval OUT EFI_SUCCESS       Command sent and message received successfully.\r
  @retval OUT EFI_UNSUPPORTED   Channel not supported.\r
  @retval OUT EFI_TIMEOUT       Timeout on the channel.\r
  @retval OUT EFI_DEVICE_ERROR  Channel not ready.\r
  @retval OUT EFI_DEVICE_ERROR  Message Header corrupted.\r
  @retval OUT EFI_DEVICE_ERROR  SCMI error.\r
**/\r
EFI_STATUS\r
ScmiCommandExecute (\r
  IN     SCMI_COMMAND  *Command,\r
  IN OUT UINT32        *PayloadLength,\r
  OUT    UINT32       **ReturnValues OPTIONAL\r
  )\r
{\r
  EFI_STATUS             Status;\r
  SCMI_MESSAGE_RESPONSE  *Response;\r
  UINT32                 MessageHeader;\r
  UINT32                 ResponseHeader;\r
  MTL_CHANNEL            *Channel;\r
\r
  ASSERT (PayloadLength != NULL);\r
\r
  Status = MtlGetChannel (MTL_CHANNEL_TYPE_LOW, &Channel);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Fill in message header.\r
  MessageHeader = SCMI_MESSAGE_HEADER (\r
                    Command->MessageId,\r
                    SCMI_MESSAGE_TYPE_COMMAND,\r
                    Command->ProtocolId\r
                    );\r
\r
  // Send payload using MTL channel.\r
  Status = MtlSendMessage (\r
             Channel,\r
             MessageHeader,\r
             *PayloadLength\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // Wait for the response on the channel.\r
  Status = MtlReceiveMessage (Channel, &ResponseHeader, PayloadLength);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // SCMI must return MessageHeader unmodified.\r
  if (MessageHeader != ResponseHeader) {\r
    ASSERT (FALSE);\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Response = (SCMI_MESSAGE_RESPONSE*)MtlGetChannelPayload (Channel);\r
\r
  if (Response->Status != SCMI_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "SCMI error: ProtocolId = 0x%x, MessageId = 0x%x, error = %d\n",\r
      Command->ProtocolId,\r
      Command->MessageId,\r
      Response->Status\r
      ));\r
\r
    ASSERT (FALSE);\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (ReturnValues != NULL) {\r
    *ReturnValues = Response->ReturnValues;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Internal common function useful for common protocol discovery messages.\r
\r
  @param[in] ProtocolId    Protocol Id of the the protocol.\r
  @param[in] MesaageId     Message Id of the message.\r
\r
  @param[out] ReturnValues SCMI response return values.\r
\r
  @retval EFI_SUCCESS      Success with valid return values.\r
  @retval EFI_DEVICE_ERROR SCMI error.\r
  @retval !(EFI_SUCCESS)   Other errors.\r
**/\r
STATIC\r
EFI_STATUS\r
ScmiProtocolDiscoveryCommon (\r
  IN SCMI_PROTOCOL_ID  ProtocolId,\r
  IN SCMI_MESSAGE_ID   MessageId,\r
  OUT UINT32           **ReturnValues\r
  )\r
{\r
  SCMI_COMMAND  Command;\r
  UINT32        PayloadLength = 0;\r
\r
  Command.ProtocolId = ProtocolId;\r
  Command.MessageId  = MessageId;\r
\r
  return ScmiCommandExecute (\r
           &Command,\r
           &PayloadLength,\r
           ReturnValues\r
           );\r
}\r
\r
/** Return protocol version from SCP for a given protocol ID.\r
\r
  @param[in]  Protocol ID    Protocol ID.\r
  @param[out] Version        Pointer to version of the protocol.\r
\r
  @retval EFI_SUCCESS       Version holds a valid version received\r
                             from the SCP.\r
  @retval EFI_DEVICE_ERROR  SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
EFI_STATUS\r
ScmiGetProtocolVersion (\r
  IN  SCMI_PROTOCOL_ID  ProtocolId,\r
  OUT UINT32            *Version\r
  )\r
{\r
  EFI_STATUS             Status;\r
  UINT32                 *ProtocolVersion;\r
\r
  Status = ScmiProtocolDiscoveryCommon (\r
             ProtocolId,\r
             SCMI_MESSAGE_ID_PROTOCOL_VERSION,\r
             (UINT32**)&ProtocolVersion\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  *Version = *ProtocolVersion;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Return protocol attributes from SCP for a given protocol ID.\r
\r
  @param[in]  Protocol ID    Protocol ID.\r
  @param[out] ReturnValues   Pointer to attributes of the protocol.\r
\r
  @retval EFI_SUCCESS       ReturnValues points to protocol attributes.\r
  @retval EFI_DEVICE_ERROR  SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
EFI_STATUS\r
ScmiGetProtocolAttributes (\r
  IN  SCMI_PROTOCOL_ID  ProtocolId,\r
  OUT UINT32            **ReturnValues\r
  )\r
{\r
  return ScmiProtocolDiscoveryCommon (\r
           ProtocolId,\r
           SCMI_MESSAGE_ID_PROTOCOL_ATTRIBUTES,\r
           ReturnValues\r
           );\r
}\r
\r
/** Return protocol message attributes from SCP for a given protocol ID.\r
\r
  @param[in]  Protocol ID    Protocol ID.\r
  @param[out] Attributes     Pointer to attributes of the protocol.\r
\r
  @retval EFI_SUCCESS       ReturnValues points to protocol message attributes.\r
  @retval EFI_DEVICE_ERROR  SCMI error.\r
  @retval !(EFI_SUCCESS)    Other errors.\r
**/\r
EFI_STATUS\r
ScmiGetProtocolMessageAttributes (\r
  IN  SCMI_PROTOCOL_ID  ProtocolId,\r
  OUT UINT32            **ReturnValues\r
  )\r
{\r
  return ScmiProtocolDiscoveryCommon (\r
           ProtocolId,\r
           SCMI_MESSAGE_ID_PROTOCOL_MESSAGE_ATTRIBUTES,\r
           ReturnValues\r
           );\r
}\r