XMailbox_Recv - 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 reads an IPI message.

Prototype

u32 XMailbox_Recv(XMailbox *InstancePtr, u32 SourceId, void *BufferPtr, u32 MsgLen, u8 BufferType);

Parameters

The following table lists the XMailbox_Recv function arguments.

Table 1. XMailbox_Recv Arguments
Type Name Description
XMailbox * InstancePtr Pointer to the XMailbox instance
u32 SourceId is the Mask for the CPU which has sent the message
void * BufferPtr is the pointer to Buffer to which the read message needs to be stored
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)

Returns

  • XST_SUCCESS if successful
  • XST_FAILURE if unsuccessful