XMailbox - XMailbox - 2026.1 English - UG643

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)
Document ID
UG643
Release Date
2026-06-23
Version
2026.1 English
Data structure used to refer XilMailbox.

Declaration

typedef struct
{
  u32(* XMbox_IPI_Send)(struct XMboxTag *InstancePtr, u8 Is_Blocking),
  u32(* XMbox_IPI_SendData)(struct XMboxTag *InstancePtr, void *BufferPtr, u32 MsgLen, u8 BufferType, u8 Is_Blocking),
  u32(* XMbox_IPI_Recv)(struct XMboxTag *InstancePtr, void *BufferPtr, u32 MsgLen, u8 BufferType),
  XMailbox_RecvHandler RecvHandler,
  XMailbox_ErrorHandler ErrorHandler,
  void * ErrorRefPtr,
  void * RecvRefPtr,
  XMailbox_Agent Agent,
  XMailbox_IpiSharedMem SharedMem
} XMailbox;
Table 1. Structure XMailbox member description
Member Description
XMbox_IPI_Send Triggers an IPI to a destination CPU.
XMbox_IPI_SendData Sends an IPI message to a destination CPU.
XMbox_IPI_Recv Reads an IPI message.
RecvHandler Receive handler.
ErrorHandler Callback for rx IPI event.
ErrorRefPtr To be passed to the error interrupt callback.
RecvRefPtr To be passed to the receive interrupt callback.
Agent Agent to store IPI channel information.
SharedMem shared memory segment