get_dataflow_paths - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Get a list of dataflow paths

Syntax

get_dataflow_paths [‑filter <arg>] [‑start_ref_name <arg>]
    [‑end_ref_name <arg>] [‑max_paths <arg>] [‑max_depth <arg>]
    [‑min_depth <arg>] [‑from <args>] [‑to <args>] [‑through <args>]
    [‑quiet] [‑verbose]

Returns

List of dataflow paths.

Usage

Name Description
[-filter] Filter list with given expression.
[-start_ref_name] Searches for paths starting from this given start ref name.
[-end_ref_name] Searches for paths ending at this given end ref name.
[-max_paths] Maximum number of paths. Default: 100
[-max_depth] Maximum number of instances that can be skipped to find the next required end point. Default: 10
[-min_depth] Minimum number of instances that can be skipped to find the next required end point. Default: 1
[-from] From leaf cells.
[-to] To leaf cells.
[-through] Through leaf cells.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Netlist, Project

Description

This returns a list of dataflow path objects which is useful to generate a group of paths to analyze within the Dataflow Design view. A dataflow design is an optimized netlist that has low level objects trimmed out and focuses on sparse netlist objects and wide buses. A dataflow path object is a path extracted from a dataflow design.

This command works when a dataflow design is open and the Dataflow view is selected in the Vivado Design Suite. The command iterates through dataflow primitives until max_depth is reached and returns all paths that meet the criteria. The following are the typical dataflow primitives available in the dataflow netlist.

  • Memories
  • DSP
  • Other IP blocks such as Transceivers, PCIe, and DCMAC

Arguments

-filter <args> - (Optional) Filter the results list with the specified expression.

-start_ref_name <arg> - (Optional) Provides the REF_NAME of the intended startpoint. The REF_NAME must exist in the dataflow design.

-end_ref_name <arg> - (Optional) Provides the REF_NAME of intended endpoint. The REF_NAME must exist in the dataflow design.

-max_paths <arg> - (Optional) Specifies the maximum number of paths to return. Default value is 100.

-max_depth <arg> - (Optional) Specifies the maximum number of netlist objects to trace through before reaching the endpoint. Default value is 10.

-min_depth <arg> - (Optional) Specifies the minimum number of netlistobjects to trace through before reaching the endpoint. Default value is 1.

-from <arg> - (Optional) Specify a startpoint cell or list of cells. The returned path starts from one of the cells provided. The argument only accepts cell objects.

-to <arg> - (Optional) Specify a endpoint cell or list of cells. The returned path ends at one of the cells provided. The argument only accepts cell objects.

-through <arg> - (Optional) Specify a midpoint cell or list of cells to trace paths through. The argument only accepts cell objects.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

Examples

The following example generates up to 100 dataflow path objects:
show_objects -name dfv_1 [get_dataflow_paths]
The following example generates dataflow paths from NoC Slave NOC_NSU512 cells:
show_objects -name dfv_2 [get_dataflow_paths -start_ref_name NOC_NSU512]
The following example generates up to 50 paths from a given cell called start_cell with a max_depth of 20 cells:
show_objects -name dfv_3 [get_dataflow_paths -from [get_cells start_cell] \ -max_depth 20 -max_paths 50]