v2025-07-10 or later
This tutorial explains how to integrate user IPs into the SoC
platform.
After identifying the interfaces of a completed IP, or defining the
interfaces of an IP to be developed, specify them in #(platform xml).
This will generate the corresponding NoC signals for connecting those
interfaces.
Then, instantiate your IP and connect it to the generated signals.
Any part starting with # should be replaced or modified according to your environment.
On Linux, use the bash shell for command-line operations.
The interfaces of user IPs are represented using the following naming convention:
user_XXX_YYY_ZZZXXX \(\in\) {slaveif, masterif}: interface role
YYY \(\in\) {apb, axi, axi4, axi4l, xmi}: communication protocol
ZZZ \(\in\) {clkout, clkin}: clock direction toward the NoC, from the interface’s perspective
Indicates that the clock enters the interface from the NoC side.
This applies when the interface operates in the same clock domain as the NoC, eliminating the need for a separate clock and CDC (Clock Domain Crossing) logic.
In the Verilog code, it is sufficient to map the provided clock to the corresponding port of the user IP.
This designation also applies when the user IP includes internal CDC logic for this interface.
Indicates that the clock used by the interface is forwarded to the NoC.
This is used when the interface is driven by a separate clock provided by the user.
A CDC is required between the interface and the NoC, and it is automatically handled by RVX.
In the Verilog code, the clock to be used by the interface must be explicitly specified by the user.
This designation is used when the user IP does not include internal CDC logic for the interface.