Vivado Package - 2022.1 English

Vivado Design Suite User Guide: Using Tcl Scripting (UG894)

Document ID
Release Date
2022.1 English

Each app requires a minimum Vivado version to work. The app can check this by requiring a minimum Vivado package version number inside the Tcl code. The Vivado package name follows the format 1.<release>. For example: 1.2018.1, 1.2018.2, 1.2018.3, and so forth.

If the app requires, for instance, Vivado 2018.1 to work, the following code should be added at the very top of the script:

package require Vivado 1.2018.1

If the app depends on some functionalities added, for instance, to Vivado 2018.3, then the following code should be used instead:

package require Vivado 1.2018.3

The required Vivado package should be the minimum Vivado release that works with the app. This means that the Tcl scripts should not update the Vivado package that is required unless this is necessary, for instance, if the app would be enhanced to support functionalities that are delivered with the new release of Vivado.