ArmPkg/Library/ArmMtlNullLib/ArmMtlNullLib.c

   1 /** @file
   2
   3   Copyright (c) 2017-2018, Arm Limited. All rights reserved.
   4
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7   System Control and Management Interface V1.0
   8     http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/
   9     DEN0056A_System_Control_and_Management_Interface.pdf
  10 **/
  11
  12 #include <Library/ArmMtlLib.h>
  13 #include <Library/DebugLib.h>
  14
  15 /** Wait until channel is free.
  16
  17   @param[in] Channel                Pointer to a channel.
  18   @param[in] TimeOutInMicroSeconds  Timeout in micro seconds.
  19
  20   @retval EFI_UNSUPPORTED           Interface not implemented.
  21 **/
  22 EFI_STATUS
  23 MtlWaitUntilChannelFree (
  24   IN MTL_CHANNEL  *Channel,
  25   IN UINTN        TimeOutInMicroSeconds
  26   )
  27 {
  28   return EFI_UNSUPPORTED;
  29 }
  30
  31 /** Return the address of the message payload.
  32
  33   @param[in] Channel   Pointer to a channel.
  34
  35   @retval UINT32*      Pointer to the payload.
  36 **/
  37 UINT32*
  38 MtlGetChannelPayload (
  39   IN  MTL_CHANNEL  *Channel
  40   )
  41 {
  42   ASSERT (FALSE);
  43   return NULL;
  44 }
  45
  46 /** Return pointer to a channel for the requested channel type.
  47
  48   @param[in] ChannelType        ChannelType, Low or High priority channel.
  49                                 MTL_CHANNEL_TYPE_LOW or
  50                                 MTL_CHANNEL_TYPE_HIGH
  51
  52   @param[out] Channel           Holds pointer to the channel.
  53
  54   @retval EFI_UNSUPPORTED       Requested channel type not supported or
  55                                 interface not implemented.
  56 **/
  57 EFI_STATUS
  58 MtlGetChannel (
  59   IN  MTL_CHANNEL_TYPE  ChannelType,
  60   OUT MTL_CHANNEL       **Channel
  61   )
  62 {
  63   return EFI_UNSUPPORTED;
  64 }
  65
  66 /** Mark the channel busy and ring the doorbell.
  67
  68   @param[in] Channel               Pointer to a channel.
  69   @param[in] MessageHeader         Message header.
  70
  71   @param[out] PayloadLength        Message length.
  72
  73   @retval EFI_UNSUPPORTED          Interface not implemented.
  74 **/
  75 EFI_STATUS
  76 MtlSendMessage (
  77   IN  MTL_CHANNEL  *Channel,
  78   IN  UINT32       MessageHeader,
  79   OUT UINT32       PayloadLength
  80   )
  81 {
  82   return EFI_UNSUPPORTED;
  83 }
  84
  85 /** Wait for a response on a channel.
  86
  87   If channel is free after sending message, it implies SCP responded
  88   with a response on the channel.
  89
  90   @param[in] Channel               Pointer to a channel.
  91
  92   @retval EFI_UNSUPPORTED          Interface not implemented.
  93 **/
  94 EFI_STATUS
  95 MtlReceiveMessage (
  96   IN  MTL_CHANNEL  *Channel,
  97   OUT UINT32       *MessageHeader,
  98   OUT UINT32       *PayloadLength
  99   )
 100 {
 101   return EFI_UNSUPPORTED;
 102 }