| axis_switch Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

axis_switch Documentation

This is the main header file for Xilinx AXI4-Stream Switch Control Router core. It is used for routing streams where masters in the system do not know final destination address.

Core Features

For a full description of AXI4-Stream Switch Control Router, please see the hardware specification.

Software Initialization & Configuration

The application needs to do following steps in order for preparing the AXI4-Stream Switch Control Router core to be ready.

- Call XAxisScr_LookupConfig using a device ID to find the core configuration.
- Call XAxisScr_CfgInitialize to initialize the device and the driver instance associated with it.

Interrupts

This driver does not have interrupt mechanism.

Virtual Memory

This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.

Threads

This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.

Asserts

Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.

Building the driver

The XAXI4-Stream Switch driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.

    MODIFICATION HISTORY:

    Ver   Who Date     Changes

    1.00  sha 01/28/15 Initial release.
    1.1   sk  08/16/16 Used UINTPTR instead of u32 for Baseaddress as part of
                       adding 64 bit support. CR# 867425.
                       Changed the prototype of XAxisScr_CfgInitialize API.
    1.2   ms  02/20/17 Fixed compilation warning in _sinit.c file. This is a
                       fix for CR-969126.
          ms  03/17/17 Added readme.txt file in examples folder for doxygen
                       generation.
    1.4   sd   02/09/20 Updated makefile for parallel execution.