AI Engine API User Guide (AIE) 2021.2
Interoperability with Adaptive Data Flow (ADF) Graph Abstractions

Overview

ADF graphs use data flow abstractions to read input data and write output data. AIE API extends such abstractions to work with its aie::vector and aie::accum data types.

Functions

template<unsigned N, typename T >
aie::vector< T, N > readincr_v (input_stream< T > *w)
  More...
 
template<unsigned N, typename T >
aie::vector< T, N > readincr_v (input_stream< T > *w, bool &tlast)
  More...
 
template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
aie::vector< T, N > window_read_v (input_window< T > *w)
  More...
 
template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
void window_read_v (input_window< T > *w, aie::vector< T, N > &value)
  More...
 
template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
aie::vector< T, N > window_readdecr_v (input_window< T > *w)
  More...
 
template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
void window_readdecr_v (input_window< T > *w, aie::vector< T, N > &value)
  More...
 
template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
aie::vector< T, N > window_readincr_v (input_window< T > *w)
  More...
 
template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
void window_readincr_v (input_window< T > *w, aie::vector< T, N > &value)
  More...
 
template<aie_dm_resource Resource = aie_dm_resource::none, unsigned N = 0, typename T = void>
void window_write (output_window< T > *w, const aie::vector< T, N > &value)
  More...
 
template<aie_dm_resource Resource = aie_dm_resource::none, unsigned N = 0, typename T = void>
void window_writeincr (output_window< T > *w, const aie::vector< T, N > &value)
  More...
 
template<aie::AccumElemBaseType T, unsigned N>
void writeincr (output_stream< T > *w, const aie::accum< T, N > &value)
  More...
 
template<typename T , unsigned N>
void writeincr (output_stream< T > *w, const aie::vector< T, N > &value)
  More...
 
template<typename T , unsigned N>
void writeincr (output_stream< T > *w, const aie::vector< T, N > &value, bool tlast)
  More...
 

Function Documentation

◆ readincr_v() [1/2]

template<unsigned N, typename T >
aie::vector<T, N> readincr_v ( input_stream< T > *  w)

Reads a vector from the input AXI stream.

Template Parameters
NSize of the vector to be read
Parameters
wInput stream

◆ readincr_v() [2/2]

template<unsigned N, typename T >
aie::vector<T, N> readincr_v ( input_stream< T > *  w,
bool &  tlast 
)

Reads a vector from the input AXI stream and returns whether TLAST has been asserted.

Template Parameters
NSize of the vector to be read
Parameters
wInput stream
tlastOutput argument that tells whether TLAST has been asserted.

◆ window_read_v() [1/2]

template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
aie::vector<T, N> window_read_v ( input_window< T > *  w)

Read a vector from an input window.

Template Parameters
NSize of the vector to be read
Parameters
wInput window

◆ window_read_v() [2/2]

template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
void window_read_v ( input_window< T > *  w,
aie::vector< T, N > &  value 
)

Read a vector from an input window.

Parameters
wInput window
valueOutput parameter that contains the read vector

◆ window_readdecr_v() [1/2]

template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
aie::vector<T, N> window_readdecr_v ( input_window< T > *  w)

Read a vector from an input window and decrement the window pointer.

Template Parameters
NSize of the vector to be read
Parameters
wInput window

◆ window_readdecr_v() [2/2]

template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
void window_readdecr_v ( input_window< T > *  w,
aie::vector< T, N > &  value 
)

Read a vector from an input window and decrement the window pointer.

Parameters
wInput window
valueOutput parameter that contains the read vector

◆ window_readincr_v() [1/2]

template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
aie::vector<T, N> window_readincr_v ( input_window< T > *  w)

Read a vector from an input window and increment the window pointer.

Template Parameters
NSize of the vector to be read
Parameters
wInput window

◆ window_readincr_v() [2/2]

template<unsigned N, aie_dm_resource Resource = aie_dm_resource::none, typename T = void>
void window_readincr_v ( input_window< T > *  w,
aie::vector< T, N > &  value 
)

Read a vector from an input window and increment the window pointer.

Parameters
wInput window
valueOutput parameter that contains the read vector

◆ window_write()

template<aie_dm_resource Resource = aie_dm_resource::none, unsigned N = 0, typename T = void>
void window_write ( output_window< T > *  w,
const aie::vector< T, N > &  value 
)

Write a vector into an output window.

Parameters
wOutput window
valueVector to be written

◆ window_writeincr()

template<aie_dm_resource Resource = aie_dm_resource::none, unsigned N = 0, typename T = void>
void window_writeincr ( output_window< T > *  w,
const aie::vector< T, N > &  value 
)

Write a vector into an output window and increment the window pointer.

Parameters
wOutput window
valueVector to be written

◆ writeincr() [1/3]

template<aie::AccumElemBaseType T, unsigned N>
void writeincr ( output_stream< T > *  w,
const aie::accum< T, N > &  value 
)

Writes an accumulator into the output cascade stream.

Parameters
wOutput stream
valueAccumulator to be written

◆ writeincr() [2/3]

template<typename T , unsigned N>
void writeincr ( output_stream< T > *  w,
const aie::vector< T, N > &  value 
)

Writes a vector into the output AXI stream. TLAST is not asserted.

Parameters
wOutput stream
valueVector to be written

◆ writeincr() [3/3]

template<typename T , unsigned N>
void writeincr ( output_stream< T > *  w,
const aie::vector< T, N > &  value,
bool  tlast 
)

Writes a vector into the output stream. An additional argument says whether TLAST is asserted.

Parameters
wOutput stream
valueVector to be written
tlastTLAST is asserted if true