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 itsaie::vectorandaie::accumdata types.

Functions

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

Function Documentation

readincr_v()[1/2]

template
aie::vector readincr_v ( input_stream< T > * w )

Reads a vector from the input AXI stream.

Template Parameters
N Size of the vector to be read
Parameters
w Input stream

readincr_v()[2/2]

template
aie::vector 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
N Size of the vector to be read
Parameters
w Input stream
tlast Output argument that tells whether TLAST has been asserted.

window_read_v()[1/2]

templateaie_dm_resourceResource = aie_dm_resource::none, typename T = void>
aie::vector window_read_v ( input_window< T > * w )

Read a vector from an input window.

Template Parameters
N Size of the vector to be read
Parameters
w Input window

window_read_v()[2/2]

templateaie_dm_resourceResource = 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
w Input window
value Output parameter that contains the read vector

window_readdecr_v()[1/2]

templateaie_dm_resourceResource = aie_dm_resource::none, typename T = void>
aie::vector window_readdecr_v ( input_window< T > * w )

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

Template Parameters
N Size of the vector to be read
Parameters
w Input window

window_readdecr_v()[2/2]

templateaie_dm_resourceResource = 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
w Input window
value Output parameter that contains the read vector

window_readincr_v()[1/2]

templateaie_dm_resourceResource = aie_dm_resource::none, typename T = void>
aie::vector window_readincr_v ( input_window< T > * w )

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

Template Parameters
N Size of the vector to be read
Parameters
w Input window

window_readincr_v()[2/2]

templateaie_dm_resourceResource = 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
w Input window
value Output parameter that contains the read vector

window_write()

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

Write a vector into an output window.

Parameters
w Output window
value Vector to be written

window_writeincr()

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

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

Parameters
w Output window
value Vector to be written

writeincr()[1/3]

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

Writes an accumulator into the output cascade stream.

Parameters
w Output stream
value Accumulator to be written

writeincr()[2/3]

template
void writeincr ( output_stream< T > * w,
constaie::vector< T, N > & value
)

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

Parameters
w Output stream
value Vector to be written

writeincr()[3/3]

template
void writeincr ( output_stream< T > * w,
constaie::vector< T, N > & value,
bool tlast
)

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

Parameters
w Output stream
value Vector to be written
tlast TLAST is asserted if true