ArmMtlLib.h

Go to the documentation of this file.

 
#ifndef ARM_MTL_LIB_H_
#define ARM_MTL_LIB_H_
 
#include <Uefi/UefiBaseType.h>
 
// Ideally we don't need packed struct. However we can't rely on compilers.
#pragma pack(1)
 
typedef struct {
  UINT32    Reserved1;
  UINT32    ChannelStatus;
  UINT64    Reserved2;
  UINT32    Flags;
  UINT32    Length;
  UINT32    MessageHeader;
 
  // NOTE: Since EDK2 does not allow flexible array member [] we declare
  // here array of 1 element length. However below is used as a variable
  // length array.
  UINT32    Payload[1]; // size less object gives offset to payload.
} MTL_MAILBOX;
 
#pragma pack()
 
// Channel Type, Low-priority, and High-priority
typedef enum {
  MTL_CHANNEL_TYPE_LOW  = 0,
  MTL_CHANNEL_TYPE_HIGH = 1
} MTL_CHANNEL_TYPE;
 
typedef struct {
  UINT64    PhysicalAddress;
  UINT32    ModifyMask;
  UINT32    PreserveMask;
} MTL_DOORBELL;
 
typedef struct {
  MTL_CHANNEL_TYPE           ChannelType;
  MTL_MAILBOX      *CONST    MailBox;
  MTL_DOORBELL               DoorBell;
} MTL_CHANNEL;
 
EFI_STATUS
MtlWaitUntilChannelFree (
  IN MTL_CHANNEL  *Channel,
  IN UINTN        TimeOutInMicroSeconds
  );
 
UINT32 *
MtlGetChannelPayload (
  IN MTL_CHANNEL  *Channel
  );
 
EFI_STATUS
MtlGetChannel (
  IN  MTL_CHANNEL_TYPE  ChannelType,
  OUT MTL_CHANNEL       **Channel
  );
 
EFI_STATUS
MtlSendMessage (
  IN  MTL_CHANNEL  *Channel,
  IN  UINT32       MessageHeader,
  OUT UINT32       PayloadLength
  );
 
EFI_STATUS
MtlReceiveMessage (
  IN  MTL_CHANNEL  *Channel,
  OUT UINT32       *MessageHeader,
  OUT UINT32       *PayloadLength
  );
 
#endif /* ARM_MTL_LIB_H_ */