template class xf::dsp::aie::fir::sr_asym::fir_sr_asym_graph

#include "fir_sr_asym_graph.hpp"

Overview

fir_sr_asym is a Asymmetric Single Rate FIR filter

These are the templates to configure the Asymmetric Single Rate FIR class.

Parameters:

TT_DATA	describes the type of individual data samples input to and output from the filter function. This is a typename and must be one of the following: int16, cint16, int32, cint32, float, cfloat.
TT_COEFF	describes the type of individual coefficients of the filter taps. It must be one of the same set of types listed for TT_DATA and must also satisfy the following rules: Complex types are only supported when TT_DATA is also complex. 32 bit types are only supported when TT_DATA is also a 32 bit type, TT_COEFF must be an integer type if TT_DATA is an integer type TT_COEFF must be a float type if TT_DATA is a float type.
TP_FIR_LEN	is an unsigned integer which describes the number of taps in the filter.
TP_SHIFT	describes power of 2 shift down applied to the accumulation of FIR terms before output. TP_SHIFT must be in the range 0 to 61.
TP_RND	describes the selection of rounding to be applied during the shift down stage of processing. TP_RND must be in the range 0 to 7 where 0 = floor (truncate) eg. 3.8 Would become 3. 1 = ceiling e.g. 3.2 would become 4. 2 = round to positive infinity. 3 = round to negative infinity. 4 = round symmetrical to infinity. 5 = round symmetrical to zero. 6 = round convergent to even. 7 = round convergent to odd. Modes 2 to 7 round to the nearest integer. They differ only in how they round for values of 0.5.
TP_INPUT_WINDOW_VSIZE	describes the number of samples in the window API used for input to the filter function. The number of values in the output window will be TP_INPUT_WINDOW_VSIZE also by virtue the single rate nature of this function. Note: Margin size should not be included in TP_INPUT_WINDOW_VSIZE.
TP_CASC_LEN	describes the number of AIE processors to split the operation over. This allows resource to be traded for higher performance. TP_CASC_LEN must be in the range 1 (default) to 9.
TP_USE_COEFF_RELOAD	allows the user to select if runtime coefficient reloading should be used. When defining the parameter: 0 = static coefficients, defined in filter constructor, 1 = reloadable coefficients, passed as argument to runtime function. Note: when used, optional port: port<input> coeff; will be added to the FIR.
TP_NUM_OUTPUTS	sets the number of ports to broadcast the output to. Note: when used, optional port: port<output> out2; will be added to the FIR. Note: For Windows API, additional output an exact copy of the data. Stream API interleaves the output data with a 128-bit pattern, e.g.: samples 0-3 to be sent over stream0 for cint16 data type, samples 4-7 to be sent over stream1 for cint16 data type.
TP_API	specifies if the input/output interface should be window-based or stream-based. The values supported are 0 (window API) or 1 (stream API).
TP_DUAL_IP	allows 2 stream inputs to be connected to FIR, increasing available throughput. When set to 0, single stream will be connected as FIRs input. When set to 1, two stream inputs will be connected. In such case data should be organized in 128-bit interleaved pattern, e.g.: samples 0-3 to be sent over stream0 for cint16 data type, samples 4-7 to be sent over stream1 for cint16 data type. Note: Dual input streams offer no throughput gain if only single output stream would be used. Therefore, dual input streams are only supported with 2 output streams. Note: Dual input ports offer no throughput gain if port api is windows. Therefore, dual input ports are only supported with streams and not windows.

template <
    typename TT_DATA,
    typename TT_COEFF,
    unsigned int TP_FIR_LEN,
    unsigned int TP_SHIFT,
    unsigned int TP_RND,
    unsigned int TP_INPUT_WINDOW_VSIZE,
    unsigned int TP_CASC_LEN = 1,
    unsigned int TP_USE_COEFF_RELOAD = 0,
    unsigned int TP_NUM_OUTPUTS = 1,
    unsigned int TP_DUAL_IP = 0,
    unsigned int TP_API = 0
    >
class fir_sr_asym_graph:
    public xf::dsp::aie::fir::sr_asym::fir_sr_asym_base_graph
    public xf::dsp::aie::fir::sr_asym::conditional_in_graph
    public xf::dsp::aie::fir::sr_asym::conditional_out_graph
    public xf::dsp::aie::fir::sr_asym::conditioanl_rtp_graph

Inherited Members

// fields

port <input> in
port <output> out
kernel m_firKernels[TP_CASC_LEN]
port <input> in2
port <output> out2
port <input> coeff

Methods

fir_sr_asym_graph

fir_sr_asym_graph overload (1)

fir_sr_asym_graph ()

This is the constructor function for the Symmetric Single Rate FIR graph.

Constructor has no args. To be used with TP_USE_COEFF_RELOAD=1, taps needs to be passed through RTP.

fir_sr_asym_graph overload (2)

fir_sr_asym_graph (const std::vector <TT_COEFF>& taps)

This is the constructor function for the Symmetric Single Rate FIR graph.

Constructor has the following arguments:

• taps a reference to the std::vector array of taps values of type TT_COEFF.

getKernels

kernel* getKernels ()

Access function to get pointer to kernel (or first kernel in a chained configuration). No arguments required.