The following list consists of configurable parameters for FIR library elements with their default values.
| Name | Type | Default | Description |
|---|---|---|---|
| DATA_TYPE | typename | cint16 | Data Type. |
| COEFF_TYPE | typename | int16 | Coefficient Type. |
| FIR_LEN | unsigned | 81 | FIR length. |
| SHIFT | unsigned | 16 | See Common Configuration Parameters |
| INPUT_WINDOW_VSIZE | unsigned | 512 | Input window size. |
| CASC_LEN | unsigned | 1 | Cascade length. |
| INTERPOLATE_FACTOR | unsigned | 1 | Interpolation factor, see note below. |
| DECIMATE_FACTOR | unsigned | 1 | Decimation factor, see note below. |
| TDM_CHANNELS | unsigned | 1 | Number of TDM Channels. Only used by TDM FIR, see note below. |
| DUAL_IP | unsigned | 0 | Dual inputs used in FIRs, see note below. |
| NUM_OUTPUTS | unsigned | 1 | See Common Configuration Parameters |
| USE_COEFF_RELOAD | unsigned | 0 | Use two sets of reloadable coefficients, where the second set deliberately corrupts a single, randomly selected coefficient. |
| PORT_API | unsigned | 0 | Graph’s port API. 0: window 1: stream |
| UUT_SSR | unsigned | 1 | Super Sample Rate SSR parameter. Defaults to 1. see note below |
| NITER | unsigned | 16 | See Common Configuration Parameters |
| DIFF_TOLERANCE | unsigned | 0 | See Common Configuration Parameters |
| DATA_STIM_TYPE | unsigned | 0 | See STIM_TYPE in
Common Configuration Parameters |
| COEFF_STIM_TYPE | unsigned | 0 | See STIM_TYPE in
Common Configuration Parameters |
| USE_CUSTOM_CONSTRAINT | unsigned | 0 | Overwrite default or non-existent. 0: no action 1: use the Graph’s access functions to set a location and overwrite a fifo_depth constraint. see also Constraints |
| ROUND_MODE | unsigned | 0 | See Common Configuration Parameters |
| SAT_MODE | unsigned | 1 | See Common Configuration Parameters |
Note
The above configurable parameters range might exceed a library element’s maximum supported range, in which case, the compilation will end with a static_assert error informing about the exceeded range.
Note
Not all dsplib elements support all of the above configurable parameters. Unsupported parameters which are not used have no impact on execution, e.g., the INTERPOLATE_FACTOR parameter is only supported by interpolation filters and will be ignored by other library elements.