XMailbox_SetSharedMem - XMailbox_SetSharedMem - 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

This function sets the shared memory location for IPI usage.

Prototype

u32 XMailbox_SetSharedMem(XMailbox *InstancePtr, u64 Address, u32 Size);

Parameters

The following table lists the XMailbox_SetSharedMem function arguments.

Table 1. XMailbox_SetSharedMem Arguments
Type Name Description
XMailbox * InstancePtr Pointer to the XMailbox instance.
u64 Address Address of shared memory location
u32 Size Size of the memory location

Returns

  • XST_SUCCESS - if memory is set for IPI usage
  • XST_FAILURE - On failure