XilMailbox API Reference - 2022.1 English

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

Document ID
UG643
Release Date
2022-04-21
Version
2022.1 English

This file contains the definitions for Zynq® UltraScale+™ MPSoC and Versal® inter-processor interrupt (IPI) implementation. This file contains the definitions for Xilinx® mailbox library top level functions. The XilMailbox library provides the top-level hooks for sending or receiving an IPI message using the Zynq UltraScale+ MPSoC IPI hardware.

For a full description of IPI features, please see the hardware specifications. This library supports the following features:

Table 1. Quick Function Reference
Type Name Arguments
u32 XIpiPs_Init
u32 XIpiPs_Send
u32 XIpiPs_SendData
  • XMailbox * InstancePtr
  • void * MsgBufferPtr
  • u32 MsgLen
  • u8 BufferType
  • u8 Is_Blocking
u32 XIpiPs_PollforDone
u32 XIpiPs_RecvData
  • XMailbox * InstancePtr
  • void * MsgBufferPtr
  • u32 MsgLen
  • u8 BufferType
XStatus XIpiPs_RegisterIrq
  • XScuGic * IntcInstancePtr
  • XMailbox * InstancePtr
  • u32 IpiIntrId
void XIpiPs_ErrorIntrHandler
  • void * XMailboxPtr
void XIpiPs_IntrHandler
  • void * XMailboxPtr
u32 XMailbox_Initialize
u32 XMailbox_Send
  • XMailbox * InstancePtr
  • u32 RemoteId
  • u8 Is_Blocking
u32 XMailbox_SendData
  • XMailbox * InstancePtr
  • u32 RemoteId
  • void * BufferPtr
  • u32 MsgLen
  • u8 BufferType
  • u8 Is_Blocking
u32 XMailbox_Recv
  • XMailbox * InstancePtr
  • u32 SourceId
  • void * BufferPtr
  • u32 MsgLen
  • u8 BufferType
s32 XMailbox_SetCallBack