Tcl Scripting in Vivado - 2024.1 English

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

Document ID: UG894
Release Date: 2024-05-30
Version: 2024.1 English

Tcl Scripting in Vivado
Introduction
Navigating Content by Design Process
A Brief Overview of Tcl
Getting Help
Platform Specific Tcl Behaviors
Compilation and Reporting Example Scripts
Compilation with a Non-Project Flow
Details of the Sample Script
Compilation with a Project Flow
Details of the Sample Script
Loading and Running Tcl Scripts
Initializing Tcl Scripts
Sourcing Tcl Scripts
Executing a Tcl Script at Startup
Using Tcl Scripts in a Constraints Set
XDC Constraints: read_xdc versus source
Defining Tcl Hook Scripts
Sharing Hook Scripts Between Steps
Customizing the GUI
Writing a Tcl Script
Defining Tcl Procedures
Parsing Command Line Arguments
Local and Global Variables
Namespaces for Procedures
Template Script
Accessing Design Objects
Getting Objects By Name
Using the -hierarchical Option
Using the -filter and -regexp Options
Searching for Pins
Filtering Results
Getting Objects by Relationship
get_nets Command
Timing Path Object
Persistency of Objects
Handling Lists of Objects
Collection versus String Representation
Redirecting Output
Accessing Files
Working with Strings
Controlling Loops
Error Handling
Checking Validity of Variables
Handling Tcl Errors
Accessing Environment Variables
Calling External Programs
Vivado Integrated Design Environment (IDE)/Tcl Modes versus Batch Mode
Creating Custom Design Rules Checks (DRCs)
Creating a Tcl Checker Procedure
Creating a DRC Check
Creating a DRC Rule Deck
Reporting Custom DRCs
DRC Explanation Script
Manipulating DRCs
Custom GUI Buttons
Create a Custom GUI Button
Remove a Custom GUI Button
Add Arguments to a Custom Button
Vivado Tcl Store
Accessing the Vivado Tcl Store
Accessing the Tcl Store GUI
Installing an App
Getting Help from an Installed App
Accessing Tcl Procs from an Installed App
Accessing the Source Code
Searching the Tcl Store
Vivado Tcl Store Support
Refreshing the Catalog
Updating an App
Uninstalling an App
Disabling Catalog Refresh
Coding Guidelines
Vivado Package
App Namespace
User Procs and Helper Procs
Install and Uninstall Hook Procs
Sharing Variables
Meta-Comments
Meta-Comment for Command Line Arguments
User Procs without Command Line Argument
User Procs with Command Line Argument
Meta-Comment Argument Usage
Example Script
Contributing to the Vivado Tcl Store
Tcl Scripting Tips
Performance via Nesting
Caching Objects
Object Names and the NAME Property
Connecting and Disconnecting Nets
get_property and Sorted Lists
Formatting Lists of Objects
Finding Vivado Tcl Commands by Options
Writing Efficient Code
Getting User Input
Additional Resources and Legal Notices
Finding Additional Documentation
Support Resources
References
Revision History
Please Read: Important Legal Notices

Back to home page