XMailbox_Recv - 2021.1 English

Xilinx Standalone Library Documentation OS and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2021-06-16
Version
2021.1 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 Mask for the CPU which has sent the message
void * BufferPtr Pointer to buffer to which the read message needs to be stored
u32 MsgLen Length of the buffer/message
u8 BufferType Type of buffer (XILMBOX_MSG_TYPE_REQ or XILMBOX_MSG_TYPE_RESP)

Returns

  • XST_SUCCESS if successful
  • XST_FAILURE if unsuccessful