XMailbox_SendData - 2022.2 English

Xilinx Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2022-10-19
Version
2022.2 English

This function sends an IPI message to a destination CPU.

Prototype

u32 XMailbox_SendData(XMailbox *InstancePtr, u32 RemoteId, void *BufferPtr, u32 MsgLen, u8 BufferType, u8 Is_Blocking);

Parameters

The following table lists the XMailbox_SendData function arguments.

Table 1. XMailbox_SendData Arguments
Type Name Description
XMailbox * InstancePtr Pointer to the XMailbox instance
u32 RemoteId is the Mask of the CPU to which IPI is to be triggered
void * BufferPtr is the pointer to Buffer which contains the message to be sent
u32 MsgLen is the length of the buffer/message
u8 BufferType is the type of buffer (XILMBOX_MSG_TYPE_REQ (OR) XILMBOX_MSG_TYPE_RESP)
u8 Is_Blocking if set trigger the notification in blocking mode

Returns

  • XST_SUCCESS if successful
  • XST_FAILURE if unsuccessful