BD - 2023.1 English

Vivado Design Suite User Guide: Design Flows Overview (UG892)

Document ID
Release Date
2023.1 English

To revision control a block design, the only file necessary to check in is the BD file itself. Similar to IP, the IP repositories used by the BD must also be present. The BD file contains the configuration of each IP on the canvas and the connections between the IP. The XCI files that reside under the BD source directory contain the IP customizations after parameter propagation is run during BD validation. Although these files are not required to recreate the design, they will be automatically regenerated when the block diagram is re-validated. When the project is rebuilt from the revision control repository, the BD and the XCI files that reside beneath the BD must be writable. This is a limitation of the current version of Vivado.

A second method to preserve a BD is to use the write_bd_tcl command. This command will generate a Tcl script to recreate the BD. The Tcl script preserves the IP customizations, connections between the IP, and all BD properties that effect the design.

Note: To view the differences between two versions of a block diagram, see Vivado Design Suite User Guide: Designing IP Subsystems Using IP Integrator (UG994) to learn more about the diffbd utility.
Note: When a block design container is used in a project the source BD resides in the .srcs folder. The instances that are uniquified by parameter propagation reside in the .gen directory. When you restore the project, only the source BD will be visible in the project, and the instance BDs will appear as missing files in the hierarchical sources view. This is expected behavior. Regenerating the parent BD will recreate the block design container instance BDs and recreate the original project.