add_wave_virtual_bus - 2023.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2023-05-16
Version
2023.1 English

Add a new virtual bus

Syntax

add_wave_virtual_bus [‑into <args>] [‑at_wave <args>] [‑after_wave <args>]
    [‑before_wave <args>] [‑reverse] [‑radix <arg>] [‑color <arg>] [‑quiet]
    [‑verbose] [<name>]

Returns

The new virtual bus.

Usage

Name Description
[-into] the wave configuration, group, or virtual bus into which the new virtual bus will be inserted.
[-at_wave] inserts the new virtual bus into the specified wave object, or after the specified wave object if not a group or virtual bus
[-after_wave] inserts the new virtual bus after the specified wave object
[-before_wave] inserts the new virtual bus before the specified wave object
[-reverse] reverses the displayed bit order of the new virtual bus
[-radix] sets the displayed radix of the new virtual bus to the specified radix. Allowed values are: default, dec, bin, oct, hex, unsigned, ascii, smag
[-color] sets the displayed color of the new virtual bus to the specified color, which can be a standard color name or a string of the form #RRGGBB Default: default
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<name>] the displayed name of the new virtual bus to the specified string Default: new_virtual_bus

Categories

Waveform

Description

The add_wave_virtual_bus command creates a new virtual bus of the specified <name>. The command inserts the virtual bus into the wave configuration (WCFG) where specified, or by default at the bottom of the existing WCFG. It returns a vb### for the newly-created virtual bus.

Note: This command can only be used when running a simulation. At a minimum, you must specify a name, which is the name of the new virtual bus

Arguments

-into <wcfgGroupVbusObj> - (Optional) Specifies the wave configuration, group, or virtual bus into which the new virtual bus object(s) are inserted. If <wcfgGroupVbusObj> is a string instead of an object, it is treated as the name of a group in the current WCFG. If no such group is found, the tool searches the names of the virtual buses of the current WCFG. If still not found, the tool searches the names of all WCFG objects. If no -into object is specified, the current wave configuration is assumed.

-at_wave <waveObj> - (Optional) Adds a virtual bus object at a specified wave object. If <waveObj> is a string, it is treated as the display name of a wave object.

-after_wave <waveObj> - (Optional) Adds a virtual bus object after a specified wave object. If <waveObj> is a string, it is treated as the display name of a wave object.

-before_wave <waveObj> - (Optional) Adds a virtual bus object before a specified wave object. If <waveObj> is a string, it is treated as the display name of a wave object.

-reverse - (Optional) Sets the IS_REVERSED property of the new virtual bus object(s) to true.

-radix <arg> - (Optional) Sets the radix property of the new virtual bus object(s) to radix. Allowed values are: default, dec, bin, oct, hex, unsigned, ascii, or smag.

-color <arg> - (Optional) Sets the color property of the new wave object(s) to the specified color, which can be a pre-defined color name or a color specified by a six-digit RGB format (RRGGBB).

-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.

<name> - (Optional) Sets the DISPLAY_NAME property of the new virtual bus object to <name>.

Examples

Add a virtual bus of the name dout_tvalid to the end of the current waveform configuration:

add_wave_virtual_bus dout_tvalid