Access Functions - 2025.2 English

Vitis IP Libraries

Release Date: 2025-11-20
Version: 2025.2 English

Vitis IP Libraries
Release Information
Vitis DSP IP Library
Libraries
Introduction
Overview
Software Platform
Hardware Platform
Release Note
2025.2
L2 AIE DSP Library User Guide
Introduction
Navigating Content by Design Process
Organization
Using Library Elements within User Defined Graphs
Known Issues
Vitis Tutorials
DSP IP Library Functions
Filters
Entry Point
Device Support
Supported Types
Template Parameters
Access Functions
Ports
Design Notes
Additional Features of FIRs in DSP IP Library
Coefficient Array for Filters
Static Coefficients
Static Coefficients - Array Size
Reloadable Coefficients
Reloadable Coefficients - update_rtp() method
Reloadable Coefficients - Number of ports
Reloadable Coefficients - Array Size
Reloadable Coefficients - Array Contents
Window Interface for Filters
Multiple Buffer Ports
Maximum Window Size
Single Buffer Constraint
Streaming Interface for Filters
Stream Output
Stream Input for Asymmetric FIRs
Stream Input for Symmetric FIRs
Setting FIR Frame Size
Setting FIR Length
Maximum FIR Length
Maximum Window Based FIRs Length
Maximum Stream based FIRs Length
Minimum Cascade Length
Optimum Cascade Length
Super Sample Rate
Super Sample Rate - Operation Modes
Super Sample Rate - Resource Utilization
Super Sample Rate - Port Utilization and Throughput
Super Sample Rate - Coefficient and Data Distribution
Super Sample Rate - Coefficient and Data Distribution - Resampling Limitations
Super Sample Rate - Sample to Port Mapping
Super Sample Rate - Interpolation Polyphases
Super Sample Rate - Decimation Polyphases
Constraints
Configuration Notes
FIR TDM
Entry Point
Device Support
Supported Types
Template Parameters
Access Functions
Ports
Design Notes
Coefficient Array for Filters
Coefficients - Array Size
Coefficients - Array Organization
Reloadable Coefficients
Reloadable Coefficients - update_rtp() method
Reloadable Coefficients - Number of ports
Reloadable Coefficients - Array Size
Reloadable Coefficients - Array Contents
IO Buffer Interface for Filters
Margin
Internal Margin
Maximizing Throughput
Multiple Frames
Latency
Maximum Window Size
Single Buffer Constraint
Input Data Samples - Array Organization
Streaming Interface for Filters
Cascaded kernels
Cascade - Operation Mode
Cascade - Resource Utilization
Cascade - Port Utilization
Output type
Super Sample Rate
Super Sample Rate - Operation Mode
Super Sample Rate - Resource Utilization
Super Sample Rate - Port Utilization
Super Sample Rate - Sample to Port Mapping
Constraints
Configuration
Running Config Helper
Config Helper Example
Legality Checking
Compiling and Simulating
Library Element Unit Test
Compiling Using the Makefile
Running Compilation
Configuring the Test Case
Selecting TARGET
Troubleshooting Compilation
Compilation Arguments
Stack Size Allocation
Invalid Throughput and/or Latency
Power Analysis
Library Element Configuration Parameters
Common Configuration Parameters
FFT Configuration Parameters
FIR Configuration Parameters
Benchmark/QoR
Latency and Throughput
FIR Decimate Asymmetric
FIR Decimate Halfband
FIR Interpolate Asymmetric
FIR Interpolate Halfband
FIR Resampler
FIR Single Rate Symmetric
FIR Single Rate Asymmetric
FIR TDM
API Reference
API Reference Overview
FIRs
template class xf::dsp::aie::fir::decimate_asym::fir_decimate_asym_graph
struct xf::dsp::aie::fir::decimate_asym::fir_decimate_asym_graph::ssr_params
template struct xf::dsp::aie::fir::decimate_asym::fir_decimate_asym_graph::tmp_ssr_params
template class xf::dsp::aie::fir::decimate_hb::fir_decimate_hb_graph
template struct xf::dsp::aie::fir::decimate_hb::fir_decimate_hb_graph::aieml_ssr_params
template struct xf::dsp::aie::fir::decimate_hb::fir_decimate_hb_graph::ct_fir_params
template struct xf::dsp::aie::fir::decimate_hb::fir_decimate_hb_graph::hb_dec_graph_params
template struct xf::dsp::aie::fir::decimate_hb::fir_decimate_hb_graph::sr_asym_graph_params
template struct xf::dsp::aie::fir::decimate_hb::fir_decimate_hb_graph::tmp_ssr_params
template class xf::dsp::aie::fir::interpolate_asym::fir_interpolate_asym_graph
struct xf::dsp::aie::fir::interpolate_asym::fir_interpolate_asym_graph::ssr_params
template struct xf::dsp::aie::fir::interpolate_asym::fir_interpolate_asym_graph::tmp_ssr_params
template class xf::dsp::aie::fir::interpolate_hb::fir_interpolate_hb_graph
template struct xf::dsp::aie::fir::interpolate_hb::fir_interpolate_hb_graph::aieml_ssr_params
template struct xf::dsp::aie::fir::interpolate_hb::fir_interpolate_hb_graph::ct_fir_params
template struct xf::dsp::aie::fir::interpolate_hb::fir_interpolate_hb_graph::sr_asym_graph_params
template struct xf::dsp::aie::fir::interpolate_hb::fir_interpolate_hb_graph::ssr_params
template class xf::dsp::aie::fir::resampler::fir_resampler_graph
struct xf::dsp::aie::fir::resampler::fir_resampler_graph::ssr_params
template struct xf::dsp::aie::fir::resampler::fir_resampler_graph::tmp_ssr_params
template class xf::dsp::aie::fir::sr_asym::fir_sr_asym_graph
struct xf::dsp::aie::fir::sr_asym::fir_sr_asym_graph::first_casc_params
template struct xf::dsp::aie::fir::sr_asym::fir_sr_asym_graph::ssr_params
template struct xf::dsp::aie::fir::sr_asym::fir_sr_asym_graph::tmp_ssr_params
template class xf::dsp::aie::fir::sr_sym::fir_sr_sym_graph
struct xf::dsp::aie::fir::sr_sym::fir_sr_sym_graph::ssr_params
template class xf::dsp::aie::fir::tdm::fir_tdm_graph
struct xf::dsp::aie::fir::tdm::fir_tdm_graph::first_casc_params
template struct xf::dsp::aie::fir::tdm::fir_tdm_graph::ssr_params

For the access functions for each FIR variant, see API Reference Overview.

Back to home page