Introduction
The XilMailbox library provides an interface for the users to send messages to various entities. The library is designed to run on top of Xilinx® standalone BSPs. It acts as a bridge
between the user application and the messaging hardware device like IPI. It provides the required functionality to the user application for sending the messages.
Library Sources
The source code for the driver is included with the Vitis Unified Software Platform installation, as well as being available in the Xilinx Github repository.
| Library Name | Path in Vitis | Path in Github |
|---|---|---|
| Xilmailbox | <Vitis Install Directory>/data/embedded/lib/sw_services/xilmailbox_v1_8 | https://github.com/Xilinx/embeddedsw/tree/master/lib/sw_services/xilmailbox |
The driver source code is organized into different folders. The table below shows the xilmailbox library source organization.
| Directory | Description |
|---|---|
| Doc | Provides the API and data structure details |
| data | Driver .tcl, .yaml and .mld file |
| examples | Example applications that show how to use the driver features |
| src | Library source files, make and cmakelists file |
Note: AMD Xilinx embeddedsw build flow has been changed from 2023.2 release to adapt to the new system device tree based flow. For further information, refer to the wiki link
The .yaml(in data folder) and CMakeLists.txt(in src folder) files are needed for the System Device Tree based flow. The Driver .tcl and .mdd files are for the older build flow which will be deprecated in future.
Library Implementation
Features
The following features are supported in Zynq UltraScale+ MPSoC platform:
- Message sending
- Receiving messages
The following features are supported in Versal platform:
- Message sending
- Receiving messages
Known Issues and Limitations
None
Example Applications
Refer to the driver examples directory for various example applications that exercise the different features of the driver.
Each application is linked in the table below. The following sections describe the usage and expected output of the various applications.
These example applications can be imported into the Vitis IDE from the Board Support Package settings tab.
Links to Examples
Examples Path: https://github.com/Xilinx/embeddedsw/tree/master/lib/sw_services/xilmailbox/examples
| Test Name | Example Source | Description |
|---|---|---|
| Mailbox example | xilmailbox_example.c | Transfer messages and receive the message. |
Example Application Usage
Mailbox example
Transfer the messages.
Expected Output
Inside XMailbox Example Successfully ran XMailbox Example
ChangeLog
2019.1
https://github.com/Xilinx/embeddedsw/blob/xilinx-v2019.2/doc/ChangeLog#L527
2021.1
None
2021.2
https://github.com/Xilinx/embeddedsw/blob/xilinx_v2021.2/doc/ChangeLog#L240
2022.1
None
2022.2
None
2023.1
https://github.com/Xilinx/embeddedsw/blob/xilinx_v2023.1/doc/ChangeLog#L172
2023.2
https://github.com/Xilinx/embeddedsw/blob/xilinx_v2023.2/doc/ChangeLog#L627