Deprecated and Unsupported Features - 2021.2 English

Vitis High-Level Synthesis User Guide (UG1399)

Document ID
UG1399
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English

Vitis™ HLS has deprecated a number of Vivado® HLS commands. These deprecated commands will be discontinued in a future release, and are not recommended for use; these are listed in the table below.

Table 1. Vivado HLS Commands Deprecated in Vitis HLS
Type Command Option Vitis HLS Details
config config_interface -m_axi_max_data_size Deprecated  
config config_interface -m_axi_min_data_size Deprecated  
config config_interface --m_axi_alignment_size Deprecated  
config config_interface -m_axi_offset=slave Unsupported This is now handled through a combination of -m_axi_offset=direct and -default_slave_interface=s_axilite
config config_interface -expose_global Unsupported  
config config_interface -trim_dangling_port Unsupported  
config config_array_partition -auto_promotion_threshold Deprecated  
config config_array_partition -auto_partition_threshold Deprecated Has been renamed to -complete_threshold
config config_array_partition -scalarize_all Unsupported  
config config_array_partition -throughput_driven Unsupported  
config config_array_partition -maximum_size Unsupported  
config config_array_partition -include_extern_globals Unsupported  
config config_array_partition -include_ports Unsupported  
config config_schedule All options but -enable_dsp_fill_reg Deprecated  
config config_bind * (all options) Deprecated  
config config_rtl -encoding Deprecated  
config config_sdx * (all options) Deprecated  
config config_flow * (all options) Deprecated  
config config_dataflow -disable_start_propagation Deprecated  
config config_rtl -auto_prefix Deprecated Replaced by config_rtl -module_prefix.
config config_rtl -prefix Deprecated Replaced by config_rtl -module_prefix.
config config_rtl -m_axi_conservative_mode Deprecated Use config_interface -m_axi_conservative_mode
directive/pragma set_directive_pipeline -enable_flush Deprecated  
directive/pragma CLOCK * Unsupported  
directive/pragma DATA_PACK * Unsupported Use AGGREGATE pragma or directive, and __attribute__(packed(X)) if needed.
directive/pragma INLINE -region Deprecated  
directive/pragma INTERFACE -mode ap_bus Unsupported Use m_axi instead.
directive/pragma ARRAY_MAP * Unsupported  
directive/pragma RESOURCE * Deprecated Replaced by BIND_OP and BIND_STORAGE pragmas and directives. Use INTERFACE pragma or directive with storage_type option for function arguments.
directive/pragma SHARED * Deprecated The SHARED pragma or directive has been moved to the type=shared option of the STREAM pragma or directive.
directive/pragma STREAM -dim Unsupported  
directive/pragma STREAM -off Deprecated STREAM off has become STREAM type=pipo
project csim_design -clang_sanitizer Add/Rename  
project export_design -use_netlist Deprecated Replaced by: export_design -format ip_catalog
project export_design -xo Deprecated Replaced by: export_design -format xo
project add_files   Unsupported System-C files are not supported by Vitis HLS.
config config_export -disable_deadlock_detection Deprecated Replaced by: config_export -deadlock_detection_sim
  1. Deprecated: A warning message for discontinuity of the pragma in a future release will be issued.
  2. Unsupported: Vitis HLS errors out with a valid message.
  3. *: All the options in the command.

The following libraries are deprecated.

Table 2. Deprecated Libraries
Library API Deprecated Suggested Replacement / Action

Linear Algebra Lib

hls_linear_algebra.h

hls/hls_axi_io.h

hls/hls_linear_algebra_io.h

hls/linear_algebra

|-- deprecated

| |-- x_complex_back_substitute.h

| |-- x_complex_cholesky.h

| |-- x_complex_cholesky_inverse.h

| |-- x_complex_matrix_multiply.h

| |-- x_complex_matrix_tb_utils.h

| |-- x_complex_matrix_utils.h

| |-- x_complex_qr_inverse.h

| |-- x_complex_qrf.h

| `-- x_complex_svd.h

|-- hls_back_substitute.h

|-- hls_cholesky.h

|-- hls_cholesky_inverse.h

|-- hls_matrix_multiply.h

|-- hls_qr_inverse.h

|-- hls_qrf.h

|-- hls_svd.h

`-- utils

|-- std_complex_utils.h

|-- x_hls_complex.h

|-- x_hls_matrix_tb_utils.h

`-- x_hls_matrix_utils.h

cholesky

float, ap_fixed, x_complex<float>, x_complex<ap_fixed>

deprecated

Vitis Solver

potrf

float, double

cholesky_inverse

float, ap_fixed, x_complex<float>, x_complex<ap_fixed>

Vitis Solver

pomatrixinverse

float, double

matrix_multiply

float, ap_fixed, x_complex<float>, x_complex<ap_fixed>

 

qrf

float, x_complex<float>

Vitis Solver

geqrf

float, double

qr_inverse

float, x_complex<float>

 

svd

float, x_complex<float>

Vitis Solver

gesvdj

float, double

DSP Lib

hls_dsp.h

hls/dsp

|-- hls_atan2_cordic.h

|-- hls_awgn.h

|-- hls_cmpy.h

|-- hls_convolution_encoder.h

|-- hls_nco.h

|-- hls_qam_demod.h

|-- hls_qam_mod.h

|-- hls_sqrt_cordic.h

|-- hls_viterbi_decoder.h

`-- utils

|-- hls_cordic.h

|-- hls_cordic_functions.h

`-- hls_dsp_common_utils.h

atan2

input: std::complex<ap_fixed>

output: ap_ufixed

deprecated

HLS Math

atan2

ap_fixed/ap_ufixed/float/double

sqrt

unsigned binary fraction with 1 bit integer, unsigned int

HLS Math

sqrt

ap_fixed/ap_ufixed/float/double

awgn(Additive white Gaussian noise)

input: ap_ufixed

output: ap_int

   

cmpy(complex number multiply)

input: std::complex< ap_fixed >

output: std::complex< ap_fixed >

   

convolution_encoder (for data transferring in channel with error correcting, used in pair with viterbi decoder)

input: ap_uint

output: ap_uint

   

viterbi_decoder(for data transferring in channel with error correcting, used in pair with convolution encoder)

input: ap_uint

output: ap_uint

   

nco (Numerically-Controlled Oscillator)

input: ap_uint

output: std::complex< ap_int >