XIpiPs_RecvData - 2023.1 English

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

Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

This function reads an IPI message.

Prototype

u32 XIpiPs_RecvData(XMailbox *InstancePtr, void *MsgBufferPtr, u32 MsgLen, u8 BufferType);

Parameters

The following table lists the XIpiPs_RecvData function arguments.

Table 1. XIpiPs_RecvData Arguments
Type Name Description
XMailbox * InstancePtr Pointer to the XMailbox instance
void * MsgBufferPtr 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

Returns

  • XST_SUCCESS if successful
  • XST_FAILURE if unsuccessful