| dual_splitter Vitis Drivers API Documentation

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

dual_splitter Documentation

This header file contains identifiers and register-level core functions (or macros), range macros, structure typedefs that can be used to access the Xilinx Dual Splitter core.Core Features

For full description of Dual Splitter features, please see the hardware specification.

Initialization & Configuration

The application needs to do the following steps in order to use Dual Splitter core.

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

Interrupts

The driver provides an interrupt handler XDualSplitter_IntrHandler for handling the interrupt from the Dual Splitter core. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XDualSplitter_SetCallBack API.

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 Dual Splitter 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 07/21/14 Initial release.
          ms  03/17/17 Added readme.txt file in examples folder for doxygen
                       generation.