| srio Vitis Drivers API Documentation

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

srio Documentation

This file contains the implementation of the SRIO Gen2 driver.User documentation for the driver functions is contained in this file in the form of comment blocks at the front of each function.

The SRIO Gen2 Core supports RapidIO Interconnect Specification rev. 2.2 The SRIO Gen2 Endpoint comprises of the phy ,logical and transport and buffer layers. Using the SRIO Gen2 Endpoint Core we can generate I/O transactions Read(NREAD), Write(NWRITE), Read with response (NREAD_R), Stream write(SWRITE) atomic operations(atomic set,clear,test and swap etc...). It also supports Messaging Transactions Message (MESSAGE), Doorbell(DOORBELL)and 8-bit/16-bit device ID's.

Initialization & Configuration

The XSrio_Config structure is used by the driver to configure itself. This configuration structure is typically created by the tool-chain based on HW build properties.

To support multiple runtime loading and initialization strategies employed by various operating systems, the driver instance can be initialized in the following way:

- XSrio_LookupConfig(DeviceId) - Use the device identifier to find the static configuration structure defined in xsrio_g.c. This is setup by the tools. For some operating systems the config structure will be initialized by the software and this call is not needed.
- XSrio_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) - Uses a configuration structure provided by the caller. If running in a system with address translation, the provided virtual memory base address replaces the physical address present in the configuration structure.

Interrupts There are no interrupts available for the SRIO Gen2 Core.

Examples

There is an example provided to show the usage of the APIs

- SRIO Dma loopback example (xsrio_dma_loopback_example.c)

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.

RTOS Independence

This driver is intended to be RTOS and processor independent. It works with physical addresses only. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver.

    MODIFICATION HISTORY:

    Ver   Who  Date     Changes

    1.0   adk  16/04/14 Initial release.
    1.1   sk   11/10/15 Used UINTPTR instead of u32 for Baseaddress CR# 867425.
                        Changed the prototype of XSrio_CfgInitialize API.
          ms   01/23/17 Modified xil_printf statement in main function for all
                        examples to ensure that "Successfully ran" and "Failed"
                        strings are available in all examples. This is a fix
                        for CR-965028.
          ms   03/17/17 Added readme.txt file in examples folder for doxygen
                        generation.
          ms   04/05/17 Added tabspace for return statements in functions of
                        srio examples for proper documentation while
                        generating doxygen.
    1.2   adk  30/07/19 Fix portwidth handling in the XSrio_CfgInitialize() API.
    1.4   mus  09/02/20 Updated makefile to support parallel make and
                        incremental builds. It would help to reduce compilation
                        time
    1.6   adk  06/02/24 Added support for system device-tree flow.