Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 9/26/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.24.3. enable_natural_bus_naming (::quartus::misc)

The following table displays information for the enable_natural_bus_naming Tcl command:

Tcl Package and Version

Belongs to ::quartus::misc

Syntax enable_natural_bus_naming [-h | -help] [-long_help]
Arguments -h | -help Short help
  -long_help Long help with examples and possible return values
Description
Enables natural bus naming so that square brackets for bus names do
not have to be escaped to prevent Tcl from interpreting them as
sub-commands.

Bus names have the following format:

<bus name>[<bus index>] or <bus name>[*]

The <bus name> portion is a string of alphanumeric characters.  The
<bus index> portion is an integer greater than or equal to zero or it
can be the character "*" used for string matching.  Notice that the
<bus index> is enclosed by the square brackets "[" and "]". For
example, "a[0]" and "a[*]" are supported bus names.

Many Quartus Prime Tcl commands allow bus names in their arguments, such
as:

set_location_assignment -to address[10] Pin_M20

If natural bus naming is enabled, you can just use address[10] instead
of having to excape the square brackets into address\[10\].

There are also Quartus Prime Tcl commands that take Tcl string match
patterns in their arguments, such as:

get_all_instance_assignments -name location -to address[10]

Since Tcl string matching take string patterns containing special
characters from the set "*?\[]" as values, address[10] would be
interpreted incorrectly. By enabling natural bus naming, these Tcl
commands will automatically detect address[10] as a bus name so that
you don't have to doubly escape the brackets into address\\\[10\\\].

To disable natural bus naming, type
"disable_natural_bus_naming".

For more information on the effects of disabling natural bus naming,
type "disable_natural_bus_naming -h".
Example Usage
# Enables natural bus naming
enable_natural_bus_naming
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful