Advanced File Groups - 2024.1 English

Vivado Design Suite User Guide: Creating and Packaging Custom IP (UG1118)

Document ID
UG1118
Release Date
2024-05-30
Version
2024.1 English

The following table contains a listing and a description of each Advanced file group type.

Table 1. Advanced File Group Types and Descriptions
Advanced File Groups
Catalog Disabled Icon GUI icon to show in the IP catalog when the IP is disabled (for example, when the IP does not support the selected device family). Supported file types are GIF, JPEG, and PNG.
Catalog Icon GUI icon to show in the IP catalog. Supported file types are GIF, JPEG, and PNG.
C Simulation Use to deliver files for c-model simulation. These files are copied out without any further processing (excepting Tcl and XIT which is always evaluated). If you are delivering pre-compiled libraries, it is suggested to deliver these in machine specific directories following the Vivado convention (for example; lnx32, lnx64, win32, and win64).
Custom UI Layout Tcl file to control custom GUI layout and customization. Only a single file is allowed, additional files should be added to the Utility XIT file group.
Data sheet IP Data sheet.
Encrypted Data sheet Encrypted IP Data sheet.
Example Implementation Files to apply for implantation, post synthesis in an example design. Typically only XDC files should be added.
Examples Script Script to create example project. Typically only Tcl files should be added.
Examples Script Extension Script to extend our default example project script. Typically only Tcl files should be added.
Examples Simulation Files that make up a simulation example design. Typically exclusive of the €œExamples€ and €œExample Synthesis€ file groups.
Getting Started Guide Getting Started Guide.
Implementation Files that make up an implementation design. Typically this file group contains only implementation (XDC) constraints.
MATLAB® Simulation MATLAB® software simulation file.
MIF Files MIF file.
Miscellaneous Vivado copies any files in the group to disk during generation. It is recommended that you use another, appropriate file group.
Reference Design Files that make up a reference design.
Software Drivers Any created software drivers.
SystemC Simulation Use to deliver files for System-C Simulation. If you are delivering pre-compiled libraries, it is suggested to deliver these in machine-specific directories following the Vivado convention (such as lnx32, lnx64, win32, and win64).
System Generator Simulation Any System Generator simulation.
System Verilog Simulation Use to deliver files for SystemVerilog simulation.
Test Bench One or more test bench files written in both VHDL and Verilog. Add all mixed language test bench files for delivery to the end-user, even if there are multiple top modules.
UI DRCs User Interface Design Rule Checks.
UI Icon GUI icon to use in IP Customization GUI. Supported file types are GIF, JPEG, and PNG.
UI Layout Tcl file to control GUI layout and customization. Only a single file is allowed, additional files should be added to the Utility XIT file group.
Upgrade Tcl Functions AMD scripts supporting upgrades from previous versions of IP. These allow the later version of an equivalent instance to the earlier version of IP.
Utility XIT/TTCL Add any utility files used during TTCL, XIT, or XSpice generation. These can either be data files, include files or extra evaluation Tcl files. For XSpice, only a single Tcl file is allowed in its file group, therefore any add any additional supporting Tcl files here.
Verilog Instantiation Template Verilog instantiation template.
Verilog Test Bench Test bench files written in Verilog.
Version Information Version information.
VHDL Instantiation Template VHDL instantiation template.
VHDL Test Bench Test Bench files written in VHDL.