XMailbox_Send - 2023.2 English

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

Document ID
UG643
Release Date
2023-12-13
Version
2023.2 English

This function triggers an IPI to a destination CPU.

Prototype

u32 XMailbox_Send(XMailbox *InstancePtr, u32 RemoteId, u8 Is_Blocking);

Parameters

The following table lists the XMailbox_Send function arguments.

Table 1. XMailbox_Send Arguments
Type Name Description
XMailbox * InstancePtr Pointer to the XMailbox instance
u32 RemoteId is the Mask of the CPU to which IPI is to be triggered
u8 Is_Blocking if set trigger the notification in blocking mode

Returns

  • XST_SUCCESS if successful
  • XST_FAILURE if unsuccessful