pg085 Axi4stream Infrastructure
pg085 Axi4stream Infrastructure
Infrastructure IP Suite
v3.0
LogiCORE IP Product Guide
Chapter 1: Overview
Overview of Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Licensing and Ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Appendix A: Upgrading
Device Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Appendix B: Debugging
Finding Help on Xilinx.com . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Debug Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Hardware Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Interface Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
• AXI4-Stream Switch
° Allows multiple masters and slave to be connected by using the TDEST signal to route
transfers to different slaves.
° Optional control register routing mode that uses an AXI4-Lite interface to specify routing.
• AXI4-Stream Interconnect (Requires Vivado).
Overview
The Arm® AMBA® 4 Specification builds on the AMBA 3 specifications by adding new
interface protocols to provide greater interface flexibility in designs with open standards.
Among the new interface protocols is the AXI4-Stream interface which is designed to
support low resource, high bandwidth unidirectional data transfers. It is well-suited for
FPGA implementation because the transfer protocol allows for high frequency versus clock
latency trade-offs to help meet design goals.
The AXI4-Stream protocol is derived from the single AXI3 write channel. It has no
corresponding address or response channel and is capable of non-deterministic burst
transactions (undefined length). The protocol interface signal set adds optional signals to
support data routing, end-of-transaction indicators, and null-beat modifiers to facilitate
management and movement of data across a system. These characteristics are suitable for
transferring large amounts of data efficiently while keeping gate count low.
The protocol interface consists of a master interface and a slave interface. The two
interfaces are symmetric and point-to-point, such that master interface output signals can
connect directly to the slave interface input signals. Utilizing this concept, it is possible to
design AXI4-Stream modules that have a slave interface input channel and a master
interface output channel. Because the master and slave interfaces are symmetric, any
number of these modules can be daisy-chained together by connecting the master
interface output channel of one module to the slave interface input channel of another
module and so on. The function of the modules can be a multitude of different options such
as buffering, data transforming or routing.
Overview of Features
The AXI4-Stream Infrastructure IP Suite consists of eight modular IP cores supporting the
full AXI4-Stream specification. Common features include:
AXI4-Stream compliant
• Supports all AXI4-Stream defined signals: TVALID, TREADY, TDATA, TSTRB, TKEEP,
TLAST, TID, TDEST, and TUSER.
• TDATA, TSTRB, TKEEP, TLAST, TID, TDEST, and TUSER are optional.
• Programmable TDATA, TID, TDEST, and TUSER widths (TSTRB and TKEEP width is
TDATA width/8).
• ACLK/ARESETn ports.
• Per port ACLKEN inputs (optional).
AXI4-Stream Broadcaster
• Replicates a master stream into multiple output slave streams.
• Provides TDATA/TUSER remap functionality.
• Supports 2-16 slaves.
AXI4-Stream Combiner
• Combines multiple "narrow" streams into one wide output stream.
• Supports 2-16 masters.
• Supports error detection for unmatched TLAST, TID, or TDEST signals slave interfaces.
AXI4-Stream Switch
• Supports 1-16 slaves.
• Supports 1-16 masters.
• Has slave side arbitrated crossbar switch.
• Supports multiple arbitration tuning points:
• Supports routing based on TDEST base/high pairs OR optional control register routing
with AXI4-Lite interface.
AXI4-Stream Interconnect
Note: AXI4-Stream Interconnect requires Vivado® IP integrator.
• Supports 1-16 slaves
• Combines AXI4-Stream Switch with buffering modules, AXI4-Stream Data Width
Converter and AXI4-Stream Subset Converter to allow masters and slaves with varying
AXI4-Stream characteristics to exchange AXI4-Stream transfers.
System Requirements
For a list of System Requirements, see the Xilinx Design Tools: Release Notes Guide.
Product Specification
TDATA/TUSER
Remapper
TDATA/TUSER
Remapper
TDATA/TUSER
Remapper
X13158
X-Ref Target - Figure 2-2
Asynchronous clock converters are a generic solution able to handle both synchronous/
asynchronous clocks with arbitrary phase alignment. The trade-off is that there is a
significant increase in area and latency associated with asynchronous clock converters. If
global clock enables are configured, additional logic is generated to handle clock enables
independently for each clock domain. There is a Clock converter module available in every
datapath and it is instantiated if either the clocks are specified as asynchronous or have
different synchronous clock ratios. The Clock converter module performs the following
functions:
• A clock-rate reduction module performs integer (N:1) division of the clock rate from its
input (SI) side to its output (MI) side.
• A clock-rate acceleration module performs integer (1:N) multiplication of clock rate
from its input (SI) to output (MI) side.
• Asynchronous clock rate conversion between the input and output uses Xilinx
parameterized macros for automatic constraints generation.
• Clock enable crossing logic that handles different ACLKEN signals per clock domain.
Figure 2-2 shows the clock converter with support for independent ACLKEN signals on its
SI and MI.
X-Ref Target - Figure 2-2
Endpoint Endpoint
Clock Crossing
Master Slave
Logic
MI SI MI SI
Clk A Clk B
X12657
AXI4-Stream Combiner
The AXI4-Stream Combiner provides a solution for aggregating multiple narrow inbound
AXI4-Stream interfaces into a single wide outbound AXI4-Stream interface. Support for up
to 16 inbound AXI4-Stream interfaces is provided. A block diagram of the AXI4-Stream
Combiner is shown in Figure 2-3. A common use case of this solution is to merge three
separate red, green, blue video streams into a single RGB stream.
IMPORTANT: All slave interfaces must assert the TVALID signal before the TVALID signal on the output
is asserted.
axis_combiner
AXI4-Stream[0] Payload[0]
Payload[1]
AXI4-Stream[1] AXI4-
Stream
AXI4-Stream[15]
Payload[15]
X13159
Based on the Xilinx Parameterized Module xpm_fifo_axis, this IP allows you to easily use
the macro within Vivado® IP integrator with an easy to configure GUI. See the UltraScale
Architecture Libraries Guide (UG974) [Ref 11] for more details on the xpm_fifo_axis
macro. This supports native AXI4-Stream with the following features:
• Selectable memory type. Distributed RAMs are suitable for shallow depths and only
consume LUTs/Registers. Block RAMs are suitable for medium depth FIFOs and
consume only block RAM resources. UltraRAMs are best for very deep FIFOs, but are
limited to certain architectures and cannot use independent master/slave clocks.
• ECC support for single-bit error correction, and double-bit error detection. Optional
error injection for debug.
• FIFO Flags including almost full/empty, and programmable full/empty.
• Data counts for both writes (synchronous to s_axis clock) and reads (synchronous to
m_axis clock) interfaces.
The conversion follows the AMBA® AXI4-Stream Protocol Specification with regards to
ordering and expansion of TUSER bits. The width converter does not process any special
TUSER encoding formats; it only maps TUSER bits across the width conversion function
using the algorithm specified in the AXI4-Stream protocol specification. Depending on the
usage/meaning of TUSER to the endpoint IP, additional external logic might be required to
manipulate TUSER bits that have been transformed by the width converter.
IMPORTANT: The number of TUSER bits per TDATA bytes must remain constant between input and
output.
Up-conversion requires that each incoming beat that is composed of the new larger beat
consists of identical TID and TDEST bits and no intermediate TLAST assertions. Partial data
may be flushed when either the TLAST bit is received or TID/TDEST changes before
enough data is accumulated to send out a complete beat. Unassigned bytes are flushed out
as null bytes.
Any non-integer multiple byte ratio conversion (N:M) is accomplished by calculating the
lowest common multiple (LCM) of N and M and then up-converting from N:LCM then
down-converting from LCM:M.
Up-conversion features:
Down-conversion features:
X12656
Figure 2-4: Data Width Converter (Down Conversion) Module Block Diagram
All signals can be configured to be removed or added and additionally the TDATA, TUSER,
TSTRB, TKEEP, TID, TDEST, and TLAST signals can be remapped.
CAUTION! Due to the inherent data loss, care should be taken to fully understand the payload content
when converting to a signal set with fewer signals.
When signals are added, they are assigned default values as specified by the AMBA
specification. The TLAST signal can be added with a configurable assertion counter that
allows one to packetize their data. The REMAP functionality can be used to re-order TDATA
bytes when working with core that have slightly different notations for data storage and
propagation.
AXI4-Stream Switch
The AXI4-Stream Switch provides configurable routing between masters and slaves. It
supports up to 16 masters and 16 slaves, two routing options, and multiple arbitration
options.
The two routing options available are TDEST routing and control register routing. The
TDEST based routing uses RTL parameters configured before synthesis to control the
routing. Each master interface is assigned a base/high TDEST pair that is used to generate
a decode table. Each slave interface decodes the incoming transfer based on the valid
TDEST value and routes a request to an arbiter of one of the master interfaces. When the
arbiter responds with a grant, then the slave interface proceeds with the transfer.
Arbitration can be performed at the transfer level or at the transaction level. (A transaction
is a series of two or more transfers.) Transaction level arbitration can be set to either
arbitrate at either fixed lengths or at TLAST boundaries. An optional timeout option is
available that terminates the transaction before the fixed length or TLAST is received if the
connection is idle for too long. This can help avoid deadlock in certain system topologies.
TDEST based routing requires that the signal has at least log2(Number of Slave Interfaces)
number of bits.
Control register routing introduces an AXI4-Lite interface to configure the routing table.
There is one register for each of the master interfaces to control each of the selectors. Once
the registers have been programmed, a commit register transfers the programmed values
from the register interface into the switch. During this period, the AXI4-Stream interfaces
are held in reset. This routing mode requires that there is precisely only one path between
master and slave. When attempting to map the same slave interface to multiple master
interfaces, only the lowest master interface is able to access the slave interface. Unused
master interfaces may be disabled and any unmapped slave interfaces are disabled.
Sparse connectivity between slave and master interfaces can be configured. This allows
resources to be conserved when they are not needed or to prevent invalid routes. For each
slave interface and master interface, a grid is created to allow you to deselect connectivity
during IP configuration. Invalid routes stall if using control register based routing and drop
transfers in the TDEST based routing. When transfers are dropped, the appropriate
decode_err signal is asserted.
Standards
The IP cores have bus interfaces that comply with the Arm® AMBA AXI4-Stream Protocol
Specification Version 1.0.
Performance
The performance of an AXI4-Stream Infrastructure IP core is limited only by the FPGA logic
speed. Each core utilizes only block RAMs, LUTs, and registers and contains no I/O elements.
The values presented in this section should be used as an estimation guideline, actual
performance can vary.
Maximum Frequencies
Each core is designed to meet the maximum target frequency of 250 MHz on a Kintex ®-7
FPGA (xc7k325tffg900-1.) It can be expected that an -2 speed grade part can achieve 5%
higher maximum target frequency and that a -3 speed grade part can achieve 10% higher
maximum target frequency. For AXI4-Stream Switch configurations with more than
approximately four masters or slaves, the target maximum frequency can be reduced by
20-25%.
Latency
The latency in the IP cores can vary on an interface-to-interface basis, depending on how
the IP cores are configured. The latency is calculated in clocked cycles and is measured as
the time that it takes from the assertion of the slave interface TVALID signal to the first
assertion of the master interface TVALID signal. The latency for each of the individual
modules is listed in Table 2-1. To obtain the minimum latency for the system, add up the
values shown in the following tables for the modules in your system. The latency
specifications assume that the master interface TREADY signal input is always asserted. The
back-to-back delay is the number of clock cycles that back-to-back transfers can be
accepted by the module. This can be observed by counting how many cycles slave interface
TREADY is Low after a transfer is accepted on the interface.
Throughput
The throughput of a datapath through each AXI4-Stream Infrastructure IP is calculated as
TDATA width x clock frequency of each of the paths determined by the SI interface, and MI
interface. The minimum throughput of an individual path in a system for which the transfer
will traverse determines the overall throughput of the datapath.
Resource Utilization
The resource utilization of each AXI4-Stream Infrastructure IP is primarily a function of the
payload width of the stream. The payload width of the stream is calculated as the width of
the TDATA, TSTRB, TKEEP, TLAST, TID, TDEST, and TUSER signals. For example, consider
the design that has the following signal widths listed in Table 2-2.
Port Descriptions
Global Signals
These signals are always present when there is a common clock between all interfaces of the
IP core.
Notes:
1. This signal description is taken from the Arm AMBA Protocol Specification.
Notes:
1. This signal description is taken from the Arm AMBA Protocol Specification.
s_axi_ctrl_aclk Input Clock signal. All inputs/outputs of this bus interface are rising edge
aligned with this clock.
s_axi_ctrl_aresetn Input Active-Low synchronous reset signal
s_axi_ctrl_awalid Input Write address valid. This signal indicates that the channel is signaling
valid write address.
s_axi_ctrl_awready Output Write address ready. This signal indicates that the slave is ready to
accept an address.
s_axi_ctrl_awaddr Input Write address. The write address gives the address of the transaction.
s_axi_ctrl_wvalid Input Write valid. This signal indicates that valid write data are available.
s_axi_ctrl_wready Output Write ready. This signal indicates that the slave can accept the write
data.
s_axi_ctrl_wdata Input Write data.
s_axi_ctrl_bvalid Output Write response valid. This signal indicates that the channel is signaling
a valid write response.
s_axi_ctrl_bready Input Write response ready. This signal indicates that the master can accept
a write response.
s_axi_ctrl_bresp Output Write response. This signal indicate the status of the write transaction.
s_axi_ctrl_arvalid Input Read address valid. This signal indicates that the channel is signaling
valid read address.
s_axi_ctrl_arready Output Read address ready. This signal indicates that the slave is ready to
accept an address.
s_axi_ctrl_araddr Input Read address. The read address gives the address of the transaction.
s_axi_ctrl_rvalid Output Read valid. This signal indicates that the channel is signaling the
required read data.
s_axi_ctrl_rready Input Read ready. This signal indicates that the master can accept the read
data and response information.
s_axi_ctrl_rdata Output Read data.
s_axi_ctrl_rresp Output Read response. This signal indicate the status of the read transfer.
Notes:
1. This signal description is taken from the Arm AMBA Protocol Specification.
Register Space
AXI4-Stream Switch
The AXI4-Stream switch has a Control Register interface option that can be enabled when
the Use control register routing option is set to Yes. Table 2-8 describes the register map.
Control Register
This register is responsible for committing the MI selector values from the control register
block to the AXI4-Stream Switch block. This register has a single bit that commits the
change. The commit causes the AXI4-Stream switch to go into a soft reset for approximately
16 cycles. This register is self-clearing when the commit/reset is complete.
REG_UPDATE 1 Register Update. MUX registers are double buffered. Writing '1'
updates the registers and issues a soft reset to the core (for
approximately 16 cycles.)
Reserved 31:2 Reserved
MI_MUX[0-15] Register
There is one MI_MUX register for each number of master interfaces ports in the design. Each
MIx_MUX value controls slave interface selection. For example, MI4_MUX value of 0x1
would route slave interface 1 to master interface 4. The MIx_DISABLE value can be set to
disable the master interface. Each slave interface can only be selected once. If more than 1
MIx_MUX value is set to the same slave interface, then the lower master interface wins
control and the higher master interface(s) is disabled. MI0_MUX register is at address offset
0x40, MI1_MUX_register is at address offset 0x44, …, and MI15_MUX register is at address
offset 0x7C.
Notes:
1. x is 0-15
Usage
To configure a 4x4 switch where MI0 is sourced from SI1, MI1 is unused, MI2 is sourced from
SI3 and MI3 is sourced from SI0, use the following code example:
# Setup registers
Write address offset 0x40, Data 0x1
Write address offset 0x44, Data 0x8000_0000
Write address offset 0x48, Data 0x3
Write address offset 0x4C, Data 0x0
# Commit registers
Write address offset 0x0, data 0x2
The Xilinx Vivado AXI Reference Guide (UG1037) [Ref 3] provides information about
AXI4-Stream protocol usage guidelines and conventions; much of the AXI system
optimizations information described for AXI Interconnect is applicable to AXI4-Stream
Infrastructure IP Suite. The Xilinx AXI Reference Guide should be reviewed and consulted
before designing or structuring systems around the AXI4-Stream Infrastructure IP.
After the number and topology of AXI4-Stream Infrastructure IP systems have been
determined, the next step is to tailor each AXI4-Stream Infrastructure IP system to have the
correct set of optional interface signals and set signals’ widths as needed. This sets up the
interface signal set for the AXI4-Stream Infrastructure IP to ensure that data can be
exchanged and routed as needed across the system.
Finally, the AXI4-Stream Infrastructure IP system should be optimized and fine-tuned to fit
its application. This includes tuning FIFOs, width converters, clock converters, arbiters, and
register slices (pipeline stages) as needed to balance area, timing, performance, and
ease-of-use.
Clocking
Each AXI4-Stream Infrastructure IP module has a single clock input that must be driven with
the exception of AXI4-Stream Clock Converter and AXI4-Stream Data FIFO. These modules
allow for different clocks and must have both S_AXIS_ACLK and M_AXIS_ACLK
connected.
The AXI4-Stream Clock Converter and Data FIFO allows systems with different clock
domains to be designed. AXI4-Stream Clock Converter synchronous mode can be used
when the endpoint IP has a phase-aligned, integer multiple clock ratio to the core switch's
clock. This is often the case when the same MMCM or PLL is driving synchronous integer
ratio clocks because the MMCM/PLL can also ensure phase alignment across their clock
outputs. The AXI4-Stream Clock Converter and AXI4-Stream Data FIFO asynchronous
clocking mode allows the attached endpoint IP to run at a completely unrelated clock
frequency or phase to the core switch clock.
An optional feature for clock enables (ACLKEN ports) allows an extra level of control for
essentially gating clocks. The clock enable signals can be used to control which clock edges
are seen as real transfer cycles. Clock enables can be used for purposes like preserving
global clock buffers, debug by stepping the clock enable to step through operational states
in the system, and dynamic power savings. Clock enables can be controlled independently
on each interface port and for the core switch.
The optional AXI4-Lite control register interface operates asynchronously from the
AXI4-Stream clocks.
Resets
The AXI4-Stream Infrastructure IP Suite provides active-Low reset inputs for every clock
input on the IP. Each reset input must be synchronized to the associated ACLK input of the
interface. To ensure data is not lost during reset deassertion across multiple interfaces of
the AXI4-Stream Infrastructure IP systems (operating in potentially different clock domains),
the AXI4-Stream Infrastructure IP deasserts all TREADY and TVALID outputs until the clock
cycle after their source logic has internally exited reset. Any endpoint IP driving TREADY or
TVALID inputs to the AXI4-Stream Infrastructure IP should also deassert these signals until
the clock cycle after they have exited reset internally.
These guidelines ensure that endpoint IPs can internally come out of reset at different times
(due to internal reset pipelining) and no data will be exchanged until both are internally out
of reset.
RECOMMENDED: Any endpoint should deassert TREADY and TVALID within 8 clock cycles of reset
assertion. ARESETn should also be asserted for at least 16 cycles of the slowest system clock to ensure
that all AXI4-Stream interfaces in the system enter reset and have time to deassert their TREADY/
TVALID outputs before coming back out of reset.
• Vivado Design Suite User Guide: Designing IP Subsystems using IP Integrator (UG994)
[Ref 9]
• Vivado Design Suite User Guide: Designing with IP (UG896) [Ref 5]
• Vivado Design Suite User Guide: Getting Started (UG910) [Ref 7]
• Vivado Design Suite User Guide: Logic Simulation (UG900) [Ref 8]
If you are customizing and generating the core in the IP integrator, see the Vivado Design
Suite User Guide: Designing IP Subsystems using IP Integrator (UG994) [Ref 9] for detailed
information. IP integrator might auto-compute certain configuration values when
validating or generating the design. To check whether the values do change, see the
description of the parameter in this chapter. To view the parameter value, run the
validate_bd_design command in the Tcl console.
You can customize the IP for use in your design by specifying values for the various
parameters associated with the IP core using the following steps:
For details, see the sections, “Working with IP” and “Customizing IP for the Design” in the
Vivado Design Suite User Guide: Designing with IP (UG896) [Ref 5] and the “Working with the
Vivado IDE” section in the Vivado Design Suite User Guide: Getting Started (UG810) [Ref 7].
If you are customizing and generating the core in the IP integrator, see the Vivado Design
Suite User Guide: Designing IP Subsystems Using IP Integrator (UG994) [Ref 9] for detailed
information. IP integrator might auto-compute certain configuration values when
validating or generating the design. To check whether the values do change, see the
description of the parameter in this chapter. To view the parameter value you can run the
validate_bd_design command in the Tcl console.
Note: Figures in this chapter are illustrations of the Vivado IDE. This layout might vary from the
current version.
Creating a Project
First, create a new project using the Vivado Design Suite. For detailed information on
starting and using the Vivado Design Suite, see the Vivado documentation.
After creating the project, the IP cores are available for selection in the IP catalog, located
at AXI Infrastructure Taxonomy.
This launches the customization dialog box. Each dialog box is described in detail in their
respective sections.
AXI4-Stream Broadcaster
The AXI4-Stream Broadcaster GUI is shown in Figure 4-1.
X-Ref Target - Figure 4-1
Review each of the available options in Figure 4-1 and modify them as desired so that the
AXI4-Stream Broadcaster solution meets the requirements of the larger project into which it
is integrated. The following subsections discuss the options in detail to serve as a guide.
Global Parameters
Component Name: The base name of the output files generated for the core. Names must
begin with a letter and can be composed of any of the following characters: a to z, 0 to 9,
and "_".
Number of Master Interfaces: This parameter specifies the number of AXI4-Stream master
interfaces present on the IP. The value can be 2 and 16. AXI4-Stream slave interface
transfers are replicated to each of the AXI4-Stream master interfaces specified by this
parameter.
Signal Properties
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
Enable TREADY: If set to Yes, this parameters specifies if the optional TREADY signal is
present on all the AXI4-Stream interfaces. Set to No to omit the signal.
SI TDATA Width (bytes): This parameter specifies the width in bytes of the TDATA signal
on the inbound AXI4-Stream Interface (the Slave Interface). This parameter is an integer and
can vary from 0 to 512. Set to 0 to omit the TDATA signal. If the TDATA signal is omitted,
then the TKEEP and TSTRB signals are also omitted. The width of the port is multiplied by
8 to get the width in bits.
MI TDATA Width (bytes): This parameter specifies the width in bytes of the TDATA signal
on each of the outbound AXI4-Stream Interfaces (the Master Interfaces). This parameter is
an integer and can vary from 0 to 512, but it may only be set to 0 if the SI TDATA Width is
also 0. When both parameters are set to 0, the TDATA signal is omitted from the interfaces
of the IP. If the TDATA signal is omitted, then the TKEEP and TSTRB signals are also
omitted. The width of the TDATA signal on each port is multiplied by eight to get the width
in bits. If the MI TDATA width is not equal to the SI TDATA Width then TKEEP and TSTRB
signals should not be enabled.
Enable TSTRB: If set to Yes, this parameters specifies if the optional TSTRB signal is present
on all the AXI4-Stream interfaces. This option can only be enabled if the SI and MI TDATA
width (bytes) parameter are both greater than 0 and each have the same width value.
Enable TKEEP: If set to Yes, this parameters specifies if the optional TKEEP signal is present
on all the AXI4-Stream interfaces. This option can only be enabled if the SI and MI TDATA
width (bytes) parameter are both greater than 0 and each have the same width value.
Enable TLAST: If set to Yes, this parameters specifies if the optional TLAST signal is present
on all the AXI4-Stream interfaces.
TID Width (bits): If greater than 0, this parameter specifies if the optional TID signal is
present on all the AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets
the width of this signal accordingly.
TDEST Width (bits): If greater than 0, this parameter specifies if the optional TDEST signal
is present on all the AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32
sets the width of this signal accordingly.
TUSER Width (bits): If greater than 0, this parameter specifies if the optional TUSER signal
is present on all the AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32
sets the width of this signal accordingly.
Enable ACLKEN: If set to Yes, this parameter specifies if the optional ACLKEN signal is
present with all the AXI4-Stream interfaces clocks.
The second page of the AXI4-Stream Broadcaster GUI is shown in Figure 4-2.
The second page of configuration parameters control the remapping feature. Two remap
strings are shown for each enabled interface. The TDATA Remap String for each port
controls which bits from the S_AXIS interface's TDATA signal are present on the
corresponding master interface's TDATA signal. Similarly the TUSER Remap String for each
port controls which bits from the S_AXIS interface's TUSER signal are present on the
corresponding master interface's TUSER signal.
The remap string parameters are edited as regular text and are encoded in a syntax very
similar Verilog vector concatenation. Each remap string is a comma-separated list of
elements and each element is either a bit-constant (eg, 1'b0) or a bit slice of the source
signal (for example, tdata[7:0] for TDATA remap strings or tuser[1] for TUSER remap
strings). The same bit from the source signal may be mapped multiple times. For example,
the remap string "tdata[7:0],tdata[7:0],tdata[7:0]" replicates the first byte of the S_AXIS
tdata signal three times in the tdata signal of the corresponding master interface. It is also
acceptable to mix bit-constant and bit-slice elements in the remap string. For example, the
remap string "tdata[7:0],8'b0,tdata[7:0]" replicates the first byte from the S_AXIS interface
with a 1 byte constant in the second byte position of the corresponding master interface.
The total width of the expression specified must match the width of the master interface
signal specified in the M_TDATA_NUM_BYTES or M_TUSER_WIDTH parameter. If the
S_AXIS signal width is 0 and the width of the corresponding master interface signal is
greater than 0, the remap expression must be a bit-constant covering the full width of the
master interface signal.
The IP configuration GUI automatically updates the remap strings to safe defaults whenever
the Number of Master Interfaces, SI TDATA Width, MI TDATA Width, SI TUSER Width
or MI TUSER Width parameters are changed. If any custom remap strings are to be used in
the IP configuration, it is recommended the custom remap strings are entered specified
after the above parameters have been set to their desired value.
Global Parameters
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
Component Name
The base name of the output files generated for the core. Names must begin with a letter
and can be composed of any of the following characters: a to z, 0 to 9, and "_".
Asynchronous Clocks
If set to Yes, then the S_AXIS_ACLK and M_AXIS_ACLK clock signals are assumed to be
asynchronous to each other and the IP operates in asynchronous mode. The Slave
Interface Clock Frequency Ratio and Master Interface Clock Frequency Ratio options
are disabled when the clocks are specified as asynchronous. Asynchronous clock mode
should be used unless S_AXIS_ACLK and M_AXIS_ACLK are phase aligned and have
frequencies that have either 1:N or N:1 clock frequency ratio.
SI to MI Clock Ratio
This parameter set the ratio in frequency between the S_AXIS_ACLK and the
M_AXIS_ACLK inputs if they are not asynchronous.
When S_AXIS_ACLK and M_AXIS_ACLK are asynchronous to each other, then this
parameter specifies the number of synchronization stages to use for cross-clock domain
logic. Increasing this value increases the MTBF of design, but incurs increased latency and
logic utilization.
This pull-down option selects the conversion mode for the ACLKEN signal. Extra latency and
logic is incurred when ACLKEN conversion is performed. The options are:
Signal Properties
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
This parameter specifies the width in bytes of the TDATA signal on all the AXI4-Stream
interfaces. This parameter is an integer and can vary from 0 to 512. Set to 0 to omit the
TDATA signal. If the TDATA signal is omitted, then the TKEEP and TSTRB signals are also
omitted. The width of the port is multiplied by 8 to get the width in bits.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on all the
AXI4-Stream interfaces.
If greater than 0, this parameter specifies if the optional TID signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
AXI4-Stream Combiner
Review each of the available options in Figure 4-4 and modify them as desired so that the
AXI4-Stream Combiner solution meets the requirements of the larger project into which it is
integrated.
X-Ref Target - Figure 4-4
Global Parameters
Component Name
The base name of the output files generated for the core. Names must begin with a letter
and can be composed of any of the following characters: a to z, 0 to 9, and "_".
This parameter specifies the number of AXI4-Stream slave interfaces present on the IP. The
value can be 2 and 16. The AXI4-Stream master interface signals TDATA, TSTRB, TKEEP, and
TUSER width are multiplied by this value.
Signal Properties
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
This parameter specifies the width in bytes of the TDATA signal on each of the AXI4-Stream
slave interfaces. The AXI4-Stream master interface TDATA width is this value multiplied by
the Number of Slave Interfaces parameter. This parameter is an integer and can vary from 0
to (512/Number of Slave Interfaces). Set to 0 to omit the TDATA signal. If the TDATA signal
is omitted, then the TKEEP and TSTRB signals are also omitted. The width of the port is
multiplied by 8 to get the width in bits.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on all the
AXI4-Stream interfaces.
If greater than 0, this parameter specifies if the optional TID signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly on the AXI4-Stream slave interfaces. The AXI4-Stream master interface
TUSER width is to set to this value multiplied by Number of Slave Interfaces.
Enable ACLKEN
If set to Yes, this parameter specifies if the optional ACLKEN signal is present with all the
AXI4-Stream interfaces clocks.
This option specifies the Slave Interface that is used to pass the TLAST, TID, and TDEST
signals to the master interface.
If set to Yes, this option enables the s_cmd_err port if TID, TDEST, TLAST signals do not
match the slave interface specified by the Primary Slave Interface option.
General Options
Component Name
The base name of the output files generated for the core. Names must begin with a letter
and can be composed of any of the following characters: a to z, 0 to 9, and "_".
FIFO depth
This option specifies the depth of the FIFO to be instantiated. FIFO depth can vary between
16 and 32768 (powers of 2 up to 2 n for whichever value of n is the current maximum.) Large
FIFO depths may not be realizable on certain devices.
Memory type
Designate the FIFO memory primitive (resource type) to use. Allowable options: Auto -
Allow Vivado Synthesis to choose. Distributed RAM - Distributed RAM FIFO (does not
support ECC.) Block RAM - Block RAM FIFO. UltraRAM - UltraRAM FIFO (does not support
independent clocks.)
Independent clocks
If set to Yes, then the S_AXIS_ACLK and M_AXIS_ACLK clock signals are assumed to be
asynchronous to each other and the IP operates in asynchronous mode.
When S_AXIS_ACLK and M_AXIS_ACLK are asynchronous to each other, then this
parameter specifies the number of synchronization stages to use for cross clock domain
logic. Increasing this value increases the MTBF of design, but incurs increased latency and
logic utilization.
This option enables the Packet Mode option of the FIFO when set to Yes. This option
requires the TLAST signal to be enabled. The FIFO operation in Packet Mode is modified to
store transfers until the TLAST signal is asserted. When the TLAST signal is asserted or the
FIFO is full, the store transfers are presented on the AXI4-Stream master interface.
This pull-down option selects the conversion mode for the ACLKEN signal. Extra latency and
logic is incurred when ACLKEN conversion is performed. The options are:
Enable ECC
Enables both ECC Encoder and Decoder. ECC enablement only supported on Block RAM and
UltraRAM primitive types.
Signal properties
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
This parameter specifies the width in bytes of the TDATA signal on all the AXI4-Stream
interfaces. This parameter is an integer and can vary from 0 to 512. Set to 0 to omit the
TDATA signal. If the TDATA signal is omitted, then the TKEEP and TSTRB signals are also
omitted. The width of the port is multiplied by 8 to get the width in bits.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on all the
AXI4-Stream interfaces.
If greater than 0, this parameter specifies if the optional TID signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
Flags
X-Ref Target - Figure 4-6
Include almost full output port. Can only be enabled if Packet Mode is not used.
Configures the programmable full threshold value. Minimum value: 5+(Number of CDC
sync stages if using independent clocks), maximum value: (FIFO depth)-5.
Include almost empty output port. Can only be enabled if Packet Mode is not used.
Configures the programmable empty threshold value. Minimum value: 5, maximum value:
(FIFO depth)-5.
Component Name
The base name of the output files generated for the core. Names must begin with a letter
and can be composed of any of the following characters: a to z, 0 to 9, and "_".
This parameter specifies the width in bytes of the TDATA signal on the AXI4-Stream slave
interface. This parameter is an integer and can vary from 1 to 512. The width of the port is
multiplied by 8 to get the width in bits. This value cannot be the same as the value of Master
Interface TDATA Width (bytes). When using Vivado IP integrator, the Vivado IDE
automatically computes the value of this parameter.
This parameter specifies the width in bytes of the TDATA signal on the AXI4-Stream master
interface. This parameter is an integer and can vary from 1 to 512. The width of the port is
multiplied by 8 to get the width in bits. This value cannot be the same as the value of Slave
Interface TDATA Width (bytes).
Signal Properties
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters except for Enable Aclken.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on all the
AXI4-Stream interfaces.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on all the
AXI4-Stream interfaces. Certain configurations may introduce null-bytes into the system. In
these situations, the m_axis_tkeep signal is always present regardless of the value of this
parameter.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on all the
AXI4-Stream interfaces.
If greater than 0, this parameter specifies if the optional TID signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
Enable ACLKEN
If set to Yes, this parameter specifies if the optional ACLKEN signal is present with all the
AXI4-Stream interfaces clocks.
Signal Properties
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
Enable TREADY
If set to Yes, this parameters specifies if the optional TREADY signal is present on all the
AXI4-Stream interfaces. Set to No to omit the signal.
This parameter specifies the width in bytes of the TDATA signal on all the AXI4-Stream
interfaces. This parameter is an integer and can vary from 0 to 512. Set to 0 to omit the
TDATA signal. If the TDATA signal is omitted, then the TKEEP and TSTRB signals are also
omitted. The width of the port is multiplied by 8 to get the width in bits.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on all the
AXI4-Stream interfaces.
If greater than 0, this parameter specifies if the optional TID signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
Enable ACLKEN
If set to Yes, this parameter specifies if the optional ACLKEN signal is present with all the
AXI4-Stream interfaces clocks.
Advanced Properties
This property allows for the trade-off between performance and area efficiency.
SLR Crossing: Adds extra pipeline stages to optimally cross one super logic region (SLR)
boundary in stacked silicon interconnect (SSI) devices. All SLR crossings are flop-to-flop
with fanout=1. See Floor Planning Constraints for AXI4-Stream Register Slice SLR Crossing
Modes for floorplanning guidance.
SLR TDM Crossing: Similar to SLR Crossing, except it consumes half number of payload
wires across the SLR boundary and propagates the cross-SLR signals at twice the frequency
of the AXI interfaces.
Multi SLR Crossing: Supports spanning zero or more SLR boundaries using a single
Register Slice instance. Also inserts additional pipeline stages within each SLR to help meet
timing goals.
Number of SLR Crossings: When using Multi SLR Crossing mode, select the number of SLR
boundaries to be crossed within the core.
Pipeline Stages within Master-side SLR: When using Multi SLR Crossing mode, select the
number of additional pipeline stages to insert within the master-side SLR (between the SLR
boundary and the SI interface).
Pipeline Stages within Slave-side SLR: Select the number of additional pipeline stages to
insert within the slave-side SLR (between the SLR boundary and the MI interface).
Pipeline Stages within Middle SLR: Select the number of additional pipeline stages to
insert within each middle SLR (between the two SLR boundaries). Enabled only when
Number of SLR Crossings is >1.
Global Parameters
Component Name
The base name of the output files generated for the core. Names must begin with a letter
and can be composed of any of the following characters: a to z, 0 to 9, and "_".
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
Enable TREADY
If set to Yes, this parameters specifies if the optional TREADY signal is present on the
AXI4-Stream slave interface. Set to No to omit the signal.
This parameter specifies the width in bytes of the TDATA signal on the AXI4-Stream slave
interface. This parameter is an integer and can vary from 0 to 512. Set to 0 to omit the
TDATA signal. If the TDATA signal is omitted, then the TKEEP and TSTRB signals are also
omitted. The width of the port is multiplied by 8 to get the width in bits.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on the
AXI4-Stream slave interface. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on the
AXI4-Stream slave interface. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on the
AXI4-Stream slave interface.
If greater than 0, this parameter specifies if the optional TID signal is present on the
AXI4-Stream slave interface. A value of 0 omits this signal. Values 1 and 32 sets the width of
this signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on the
AXI4-Stream slave interface. A value of 0 omits this signal. Values 1 and 32 sets the width of
this signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on the
AXI4-Stream slave interface. A value of 0 omits this signal. Values 1 and 32 sets the width of
this signal accordingly.
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
Enable TREADY
If set to Yes, this parameters specifies if the optional TREADY signal is present on the
AXI4-Stream slave interface. Set to No to omit the signal.
This parameter specifies the width in bytes of the TDATA signal on the AXI4-Stream slave
interface. This parameter is an integer and can vary from 0 to 512. Set to 0 to omit the
TDATA signal. If the TDATA signal is omitted, then the TKEEP and TSTRB signals are also
omitted. The width of the port is multiplied by 8 to get the width in bits.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on the
AXI4-Stream slave interface. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on the
AXI4-Stream slave interface. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on the
AXI4-Stream slave interface.
If greater than 0, this parameter specifies if the optional TID signal is present on the
AXI4-Stream slave interface. A value of 0 omits this signal. Values 1 and 32 sets the width of
this signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on the
AXI4-Stream slave interface. A value of 0 omits this signal. Values 1 and 32 sets the width of
this signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on the
AXI4-Stream slave interface. A value of 0 omits this signal. Values 1 and 32 sets the width of
this signal accordingly.
Extra Settings
The remap string parameters are used to remap input to output bytes/bits of the
TDATA/TUSER/TID/TDES/TSTRB/TKEEP/TLAST signals, respectively.
The format of the remap user parameter follows syntax similar to Verilog vector
concatenation.
° For example, if SI and MI TDATA width have the same value 32, the remap string
tdata[31:0] passes the entire TDATA signal from SI to MI unmodified.
° If the MI TDATA signal were 24 bits and the SI TDATA signal were 16 bits, a remap
string of 8b00000000,tdata[15:0] assigns a constant 0 to the upper 8 bits of
the MI signal and pass the SI TDATA through on the lower 16 bits.
• A bit-slice element can reference a single bit of an SI signal (e.g., TDATA[0]) or a vector
slice of an SI signal (e.g., tdata[11:8]).
° The index values must not exceed the indices of the SI signal.
• The same SI bit can be mapped multiple times into the MI output.
° For example, the remap string for TDATA may reference bits from the TUSER SI
signal.
• Constant elements and bit-slice elements can be freely mixed in the comma separated
list of elements.
Generate TLAST
This parameter can be set if the TLAST signal is enabled on the master interface, but not on
the slave interface. The number specifies how many transfers to count before asserting the
TLAST signal. A value of 0 indicates that the TLAST signal should always be de-asserted.
Conversely, a value of 1 indicates that the TLAST signal should be asserted on every
transfer. A value of 2 indicates that the TLAST signal should be asserted on every other
transfer and so on. Values 0 and 256 are accepted.
Enable ACLKEN
If set to Yes, this parameter specifies if the optional ACLKEN signal is present with all the
AXI4-Stream interfaces clocks.
AXI4-Stream Switch
Review each of the available options in Figure 4-10 and modify them as desired so that the
AXI4-Stream Switch solution meets the requirements of the larger project into which it is
integrated.
Global Parameters
Component Name
The base name of the output files generated for the core. Names must begin with a letter
and can be composed of any of the following characters: a to z, 0 to 9, and "_".
Switch Properties
This parameter specifies the number of AXI4-Stream slave interfaces present on the IP. The
value can be 1 and 16. This value cannot be set to 1 when Number of Master Interfaces is 1.
This parameter specifies the number of AXI4-Stream master interfaces present on the IP.
The value can be 1 and 16. This value cannot be set to 1 when Number of Slave Interfaces
is 1.
This parameter specifies the routing mode. Control register routing enables the AXI4-Lite
control register interface to handle transfer routing. If this option is set to No, then the
inline TDEST value is used for routing. Enabling this option disables the Routing tab.
Signal Properties
When using Vivado IP integrator, the Vivado IDE automatically computes the values of these
parameters.
This parameter specifies the width in bytes of the TDATA signal on all the AXI4-Stream
interfaces. This parameter is an integer and can vary from 0 to 512. Set to 0 to omit the
TDATA signal. If the TDATA signal is omitted, then the TKEEP and TSTRB signals are also
omitted. The width of the port is multiplied by 8 to get the width in bits.
Enable TSTRB
If set to Yes, this parameters specifies if the optional TSTRB signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TKEEP
If set to Yes, this parameters specifies if the optional TKEEP signal is present on all the
AXI4-Stream interfaces. This option can only be enabled if the TDATA Width (bytes)
parameter is greater than 0.
Enable TLAST
If set to Yes, this parameters specifies if the optional TLAST signal is present on all the
AXI4-Stream interfaces.
If greater than 0, this parameter specifies if the optional TID signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TDEST signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
If greater than 0, this parameter specifies if the optional TUSER signal is present on all the
AXI4-Stream interfaces. A value of 0 omits this signal. Values 1 and 32 sets the width of this
signal accordingly.
Enable ACLKEN
If set to Yes, this parameter specifies if the optional ACLKEN signal is present with all the
AXI4-Stream interfaces clocks.
Data Flow Properties options are available to modify only if the Number of Slave Interfaces
is greater than 1 and Use control register routing is set to No.
This setting specifies how many transfers to count before relinquishing the granted
arbitration. If set to zero, then the number is infinite and Arbitrate on TLAST transfer must
be set. If set to one, then after each transfer, the interconnect switch relinquishes control
and requests another arbitration. If set to a value greater than one, then after the specified
number of transfers, the arbitration is relinquished. For example, setting this value to 16
allows 16 transfers to pass from slave interface to master interface per each arbitration
grant.
If checked, this setting indicates that a transaction is complete when a transfer with TLAST
asserted passes from the slave interface to the master interface of the interconnect switch.
The arbiter is then able to arbitrate to the next arbitration winner.
Arbiter Algorithm
There are three arbitration algorithms available to choose from. The True Round-Robin
algorithm arbitrates between all the slave interfaces in a round robin fashion. If all slave
interfaces are not active, then it adapts to provide an equal weighting for each active slave
interface. The ordering starts with S00, then S01, down to S15. The slave interface following
the one that was last granted has the highest priority next. The Round-Robin algorithm
operates similarly to the True Round-Robin option except that after a successful grant, it
proceeds to the next arbitration order regardless of which slave interface was granted.
Fixed-Priority algorithm issues the highest priority to S00, and the lowest priority to S15 for
every arbitration cycle. System-level traffic profiles for Fixed-Priority algorithm must be
carefully understood to avoid starvation of lower-priority ports.
Consider the scenario where there is a 4 SI to 1 MI switch with ports S00, S02, and S03
continuously requesting transfers with large transactions. After a large number of
arbitrations, the algorithms produces different utilizations. The True Round-Robin provides
33% of the available bandwidth to each of the ports S00, S02, and S03. The Round-Robin
algorithm provides 25% of the available bandwidth to ports S00 and S03, and 50% to port
S02. This is because port S02 gains ports S01 bandwidth. The Fixed-Priority algorithm
provides 100% bandwidth to port S00, and starve the other 2 requesting ports.
Regardless of arbiter algorithm, the arbiter does not support back-to-back transfers from
the same slave interface. This configuration has two implications. If only one interface is
requesting to a particular master, then only 50% of the bandwidth will be realized. If using
the fixed-priority arbitration in the scenario described previously, then the ports S00 and
S02 would get 50% bandwidth allocation.
Pipeline Registers
Pipeline register options are available to set when using the Use control register routing
is set to Yes.
When enabled, the slave interface side of the switch has register slices for each port at the
IP boundary.
When enabled, the master interface side of the switch has register slices for each port at the
IP boundary.
Connectivity
X-Ref Target - Figure 4-11
The table shown Figure 4-11 allows the configuration of the switch to optimize
connectivity. By default full connectivity is enabled meaning that every slave interface is
connected to every master interface. Deselecting a checkbox removes the connection from
the slave interface listed in the column to the master interface in the row. Removing
connections is desirable when it is known that a slave interface is never going to send
transfers to a particular master interface. This removes unnecessary logic resulting in
smaller area utilization, routing and logic complexity.
IMPORTANT: No interface should be left without connectivity. Every slave interface must have
connectivity to at least one master interface. Conversely, every master interface must have connectivity
to at least one slave interface.
Routing
X-Ref Target - Figure 4-12
Routing Parameters
The routing parameters shown in Figure 4-12 set up the decoding used by the switch to
route slave interface transfers to master interfaces based on the TDEST signal. Each master
interface must have a BASE/HIGH range that is within the valid width of the TDEST width
specified previously. The BASE/HIGH pair must not overlap master interfaces. When a
transfer is received at the slave interface, the TDEST is decoded based on this table. A
request is then sent to arbiter for the master interface corresponding to the TDEST. If the
slave interface is chosen by the arbiter, the transfer proceeds to the master interface. This
tab is only available when Use control register routing is set to No.
AXI4-Stream Interconnect
Note: AXI4-Stream Interconnect requires IP integrator.
Figure 4-13 shows the top-most AXI4-Stream Interconnect core block diagram. Inside the
AXI4-Stream Interconnect, an AXI4-Stream Switch core routes traffic between the Slave
Interfaces (SI) and Master Interfaces (MI). Along each pathway connecting a SI or MI to the
Switch, an optional series of AXI4-Stream Infrastructure cores (couplers) can perform
various conversion and buffering functions. The couplers include: AXI4-Stream Register
Slice, AXI4-Stream Data FIFO, AXI4-Stream Clock Converter, AXI4-Stream Data Width
Converter and AXI4-Stream Protocol Converter.
X-Ref Target - Figure 4-13
or between the Switch and an MI, there can be one or more AXI4-Stream infrastructure
cores to perform various conversion and storage functions.
The Switch effectively splits the AXI4-Stream Interconnect core down the middle between
the SI-related functional units (SI hemisphere) and the MI-related units (MI hemisphere).
Where possible, Vivado system design tools automatically insert couplers into the SI or MI
hemisphere to resolve differences in the configuration of the connected master and slave
devices.
AXI4-Stream Interconnect v2.1 requires IP integrator. To access the IP, first create a Vivado
project, then select Create Block Design from the Vivado Flow Navigator. In the block
design canvas, select the Add IP option from the toolbar and choose AXI4-Stream
Interconnect from the IP integrator IP catalog window. An AXI4-Stream Interconnect IP
instance is added to the block design canvas. Double-clicking on the IP instance in the
diagram opens its customization window. The user-configurable options of the
AXI4-Stream Interconnect are described in the following sections.
X-Ref Target - Figure 4-14
This parameter specifies the number of AXI4-Stream slave interfaces present on the IP. The
value can be between 1 and 16.
This parameter specifies the number of AXI4-Stream master interfaces present on the IP.
The value can be between 1 and 16.
Enable ACLKEN
If set to Yes, this parameter specifies if the optional ACLKEN signal is present with all the
AXI4-Stream interfaces clocks.
This parameter specifies the routing mode. Control register routing enables the AXI4-Lite
control register interface to handle transfer routing. If this option is set to No, then the
inline TDEST value is used for routing.
Data Flow Properties options are available to modify only if the Number of Slave Interfaces
is greater than 1.
This setting specifies how many transfers to count before relinquishing the granted
arbitration and is passed directly to the AXI4-Stream Switch within the AXI4-Stream
Interconnect instance. Consult the AXI4-Stream Switch parameter descriptions for more
details on the valid value range and use of this parameter.
This setting allows relinquishing of a granted arbitration without a transfer and is passed
directly to the AXI4-Stream Switch within the AXI4-Stream Interconnect instance. Consult
the AXI4-Stream Switch parameter descriptions for more details on the valid value range
and use of this parameter.
This setting allows relinquishing of a granted arbitration when a transfer with TLAST
asserted is received and is passed directly to the AXI4-Stream Switch within the
AXI4-Stream Interconnect instance. Consult the AXI4-Stream Switch parameter descriptions
for more details on the valid value range and use of this parameter.
Arbiter Algorithm
This setting allows the selection of an arbitration algorithm and is passed directly to the
AXI4_Stream Switch within the AXI4-Stream Interconnect instance. Consult the AXI4-Stream
Switch parameter descriptions for more details on the valid value range and use of this
parameter.
FIFO Depth
If checked and if a FIFO depth greater than 0 is selected for Snn_AXIS, the AXI4-Stream Data
FIFO's packet mode is enabled. Consult the AXI4-Data FIFO parameter descriptions for more
details on packet mode operation.
FIFO Depth
If checked and if a FIFO depth greater than 0 is selected for Snn_AXIS, the AXI4-Stream
Data FIFO's packet mode is enabled. Consult the AXI4-Stream Data FIFO parameter
descriptions for more details on packet mode operation.
The routing parameters shown in Figure 4-16 set up the decoding to route slave interface
transfers to master interfaces based on the TDEST signal and are passed directly to the
AXI4-Stream Switch instance within the AXI4-Stream Interconnect. Consult the AXI4-Stream
Switch parameter descriptions for more details on the valid range and use of routing
parameters. These parameters are not configurable when Use control register routing is
set to Yes.
X-Ref Target - Figure 4-17
When 'Yes' is selected, the data count pins of any SI and MI AXI4-Stream Data FIFO
instances are made available as pins on the boundary of AXI4-Stream Interconnect, as
shown in Figure 4-17. Two sets of data counts per FIFO are available: the read count and the
write count. If the interface has enabled clock conversion, then these data counts are
flopped on their respective clocks. For slave interfaces, the write data count is synchronous
to the clock input for that interface and the read data count is synchronous to the ACLK
global clock. For master interfaces, the read data count is synchronous to the clock input for
that interface and the write data count is synchronous to the ACLK global clock.
When 'Yes' is selected, the AXI4-Stream Data FIFO inserted inside the AXI4-Stream
Interconnect gets configured with UltraRAM memory. This option is only visible for devices
supporting URAM
Synchronization Stages
Specifies the number of synchronization stages used in any asynchronous clock domain
conversion couplers instantiated within the AXI4-Stream Interconnect.
Output Generation
For details, see the Vivado Design Suite User Guide: Designing with IP (UG896) [Ref 5].
Required Constraints
The AXI4-Stream Infrastructure IP does not generally require any additional timing
constraints other than clock period constraints on its clocks inputs. When an asynchronous
clock converter is utilized, the underlying Xilinx Parameterized Macro is instantiated and
generates an internal constraint file to prevent timing paths crossing clock domains from
causing false timing errors. Those constraints apply only to internal logic inside the
AXI4-Stream Infrastructure IP and are automatically generated with the IP.
create_pblock master_slr
add_cells_to_pblock [get_pblocks master_slr] [get_cells -hierarchical -filter
"NAME=~*my_reg*slr_source*"]
resize_pblock [get_pblocks master_slr] -add {CLOCKREGION_X0Y0:CLOCKREGION_X5Y4}
create_pblock slave_slr
Constraints that combine the instance name of the Register Slice and any of these
submodule name patterns can then be used to group all cells in the core into their
respective PBLOCKs for floorplanning.
One of the boundaries exists between row Y4 (the top of the lower SLR) and row Y5 (the
bottom of the middle SLR). The other boundary exists between row Y9 (the top of the
middle SLR) and row Y10 (the bottom of the upper SLR).
create_pblock lower_slr
add_cells_to_pblock [get_pblocks lower_slr] [get_cells -hierarchical -filter
"NAME=~*my_reg*slr_master*"]
resize_pblock [get_pblocks lower_slr] -add {CLOCKREGION_X0Y0:CLOCKREGION_X5Y4}
create_pblock center_slr
add_cells_to_pblock [get_pblocks center_slr] [get_cells -hierarchical -filter
"NAME=~*my_reg*slr_middle*"]
resize_pblock [get_pblocks center_slr] -add {CLOCKREGION_X0Y5:CLOCKREGION_X5Y9}
create_pblock upper_slr
add_cells_to_pblock [get_pblocks upper_slr] [get_cells -hierarchical -filter
"NAME=~*my_reg*slr_slave*"]
resize_pblock [get_pblocks upper_slr] -add {CLOCKREGION_X0Y10:CLOCKREGION_X5Y14}
Clock Frequencies
This section is not applicable for this IP core.
Clock Management
This section is not applicable for this IP core.
Clock Placement
This section is not applicable for this IP core.
Banking
This section is not applicable for this IP core.
Transceiver Placement
This section is not applicable for this IP core.
Simulation
For comprehensive information about Vivado simulation components, as well as
information about using supported third party tools, see the Vivado Design Suite User
Guide: Logic Simulation (UG900) [Ref 8].
Example Design
An example design that demonstrates basic core functionality for the customized IP is
available for AXI4-Stream Infrastructure IP cores. The example design is an independent
Vivado® project populated with the customized IP along with additional IPs including
example master(s), example slave(s), clocking and reset blocks. A synthesizable top-level
HDL file is provided that instantiates and wires together the IPs shown in Figure 5-1. If the
parent Vivado project is configured for a Xilinx supported board, then the physical board
constraints are also provided. A simulation-only demo test bench for the example design is
also provided and discussed in further in the Chapter 6, Test Bench.
IMPORTANT: The example design does not exhaustively demonstrate all the features of the IP. It is not
a verification test bench.
Functionality
The example design shows basic functionality by instantiating a synthesizable AXI4-Stream
example master which sends transfers to an AXI4-Stream example slave. After a fixed
number of transfers, the master completes and asserts the done output signal. The example
slave receives the transfers and performs a null operation on the payload to emulate data
processing. Once all transfers are received by the example slave the idle output signal is
asserted. The example master and example slave generates a subset of AXI4-Stream
protocol compliant transfers only. When the example master done output signal and the
example slave idle output signal are both asserted then the done output pin is asserted. If
this project is configured for a Xilinx® reference board then the done signal is tied to an LED
output.
A Clocking Wizard core is present to interface with an external differential clock input and
to provide a clock output suitable for the design to easily meet timing closure. If the project
is configured for a Xilinx reference board, then the Clocking Wizard is configured to specify
the differential clock input constraints for the board.
A LogiCore Processor System Reset block is present to interface with an external reset input
and to provide a de-bounced active Low system reset. If the project is configured for a
Xilinx reference board, then the Processor System Reset (Proc Sys Reset) core is configured
to specify the reset input constraint for the board.
Test Bench
A behavioral Verilog test bench that wraps around the example design top level is provided
when the example design output product is generated. The test bench provides clocking
and reset stimulus to the example design top level to run simulations on the example
design. It monitors the done output to signal simulation completion. The test bench is
useful for getting familiar with the signaling on the core by observing the simulation
waveforms. The test bench can be used with all simulation outputs from behavioral RTL
through post-implementation timing.
In the example design, the simulation sources file set includes the test bench. To run the
test bench, select the Run Simulation option in the Vivado® Flow Navigator. When the
simulation is open, enter the run all command to run the simulation to completion.
Output similar to code shown below should be generated if the simulation completes
successfully.
For more information with running the simulation test bench please see Vivado Design Suite
User Guide: Logic Simulation (UG900) [Ref 8].
Upgrading
This appendix contains information about migrating a design from ISE® to the Vivado®
Design Suite, and for upgrading to a more recent version of the IP core. For customers
upgrading in the Vivado Design Suite, important details (where applicable) about any port
changes and other impact to user logic are included.
Device Migration
If you are migrating from a 7 series GTX or GTH device to an UltraScale GTH device, the
prefixes of the optional transceiver debug ports for single-lane cores are changed from
“gt0”, “gt1” to “gt”, and the suffix “_in” and “_out” are dropped. For multi-lane cores,
the prefixes of the optional transceiver debug ports gt(n) are aggregated into a single port.
For example: gt0_gtrxreset and gt1_gtrxreset now become gt_gtrxreset [1:0].
This is true for all ports, with the exception of the DRP buses which follow the convention
of gt(n)_drpxyz.
It is important to update your design to use the new transceiver debug port names. For
more information about migration to UltraScale devices, see the UltraScale Architecture
Migration Methodology Guide (UG1026) [Ref 10].
Parameter Changes
There are no parameter changes.
Port Changes
There are no port changes.
Other Changes
There are no other changes.
Debugging
This appendix includes details about resources available on the Xilinx ® Support website and
debugging tools.
TIP: If the IP generation halts with an error, there may be a license issue. See Licensing and Ordering
in Chapter 1 for more details.
Documentation
This product guide is the main document associated with the AXI4-Stream Infrastructure IP
Suite. This guide, along with documentation related to all products that aid in the design
process, can be found on the Xilinx Support web page or by using the Xilinx Documentation
Navigator.
Download the Xilinx Documentation Navigator from the Design Tools tab on the Downloads
page. For more information about this tool and the features available, open the online help
after installation.
Solution Centers
See the Xilinx Solution Centers for support on devices, software tools, and intellectual
property at all stages of the design cycle. Topics include design assistance, advisories, and
troubleshooting tips.
Answer Records
Answer Records include information about commonly encountered problems, helpful
information on how to resolve these problems, and any known issues with a Xilinx product.
Answer Records are created and maintained daily ensuring that users have access to the
most accurate information available.
Answer Records for this core are listed below, and can also be located by using the Search
Support box on the main Xilinx support web page. To maximize your search results, use
proper keywords such as
• Product name
• Tool message(s)
• Summary of the issue encountered
A filter search is available after results are returned to further target the results.
Technical Support
Xilinx provides technical support at the Xilinx Support web page for this LogiCORE™ IP
product when used as described in the product documentation. Xilinx cannot guarantee
timing, functionality, or support if you do any of the following:
• Implement the solution in devices that are not defined in the documentation.
• Customize the solution beyond that allowed in the product documentation.
• Change any section of the design labeled DO NOT MODIFY.
To contact Xilinx Technical Support, navigate to the Xilinx Support web page.
Debug Tools
There are many tools available to address AXI4-Stream Infrastructure IP Suite design issues.
It is important to know which tools are useful for debugging various situations.
The Vivado logic analyzer is used with the logic debug IP cores, including:
See the Vivado Design Suite User Guide: Programming and Debugging (UG908) [Ref 6].
Reference Boards
Various Xilinx development boards support AXI4-Stream Infrastructure IP Suite. These
boards can be used to prototype designs and establish that the core can communicate with
the system.
° KC705
° KC724
Hardware Debug
Hardware issues can range from link bring-up to problems seen after hours of testing. This
section provides debug steps for common issues. The Vivado debug feature is a valuable
resource to use in hardware debug. The signal names mentioned in the following individual
sections can be probed using the ChipScope tool for debugging the specific problems.
General Checks
Ensure that all the timing constraints for the core were properly incorporated from the
example design and that all constraints were met during implementation.
• Does it work in post-place and route timing simulation? If problems are seen in
hardware but not in timing simulation, this could indicate a PCB issue. Ensure that all
clock sources are active and clean.
• If using MMCMs in the design, ensure that all MMCMs have obtained lock by
monitoring the LOCKED port.
• If your outputs go to 0, check your licensing.
Interface Debug
AXI4-Stream Interfaces
If data is not being transmitted or received, check the following conditions:
Xilinx Resources
For support resources such as Answers, Documentation, Downloads, and Forums, see Xilinx
Support.
• From the Vivado ® IDE, select Help > Documentation and Tutorials.
• On Windows, select Start > All Programs > Xilinx Design Tools > DocNav.
• At the Linux command prompt, enter docnav.
Xilinx Design Hubs provide links to documentation organized by design tasks and other
topics, which you can use to learn key concepts and address frequently asked questions. To
access the Design Hubs:
• In the Xilinx Documentation Navigator, click the Design Hubs View tab.
• On the Xilinx website, see the Design Hubs page.
Note: For more information on Documentation Navigator, see the Documentation Navigator page
on the Xilinx website.
References
These documents provide supplemental material useful with this product guide:
Revision History
The following table shows the revision history for this document.