Most of the TE modules are available in different assembly options. Assembly option with different FPGA/SOC devices or other DDR sizes need an own board part file. In some cases also a PCB revision changes or a special carrier module combination needs a separate board part.
It's recommended to use the board part files only for this Vivado Version, for which it has been provided. Depending on the Schema Version of the XML-Files and Xilinx IP definitions, it is possible to use them with other Vivado versions, see Xilinx ug895.
Table of contents
Naming Conventions and Version
This Naming Convention will be used for the most Vivado 2016.2 Board Part Files and newer one.
Board Part Files consists on a base folder, a version sub folder with three xml files and one picture:
- Every assembly option of a module/carrier series where FPGA-Typ (Size, Speed/Temperature Grade) is changed, gets a new base folder.
- Every other assembly option or PCB-revision change, which has affects on the reference design settings, gets a new version sub folder.
Board Part Base Folder
Board Part Names of the base folder consists of max. three parts separated by underline character.
|Usage of the part of name||Example 1||Example 2||Example 3||Example 4|
|Name of the PCB Series||Always||TE0726||TE0745||TE0720||TE0711|
|FPGA Speed/Temperature Grade||Optional||1C||2C|
Board Part Version Folder
Version folder Name consists on a major and minor number separated by a dot (<major>.<minor>, example 1.0) Different Version folder means:
- Changes on assembly option, which has effects on the reference design, for example DDR Size
- Boart Part for special Carrier/Module combination
- Changes on PCB-Revision, which has effects on the reference design
Attention: Changes on the settings of the TE Board Part Files by itself are not under version control at the moment, like described in Xilinx ug895. XML file includes a comment header with the date of the last change of the selected file.
Board Part Files will be delivered with our Reference Designs on our https://shop.trenz-electronic.de/Download/?path=Trenz_Electronic/<group>/<form factor>/<module_name>/Reference_Design/<vivado_version>/<design_name>.
Board Part Files are locate in the sub folder <design_name>/board_files/ of the downloadable Reference Design. For detailed information of the zip-file folder structure see: Project Delivery - Directory Structure.
This folder includes also a *_board_files.csv file with a list of all available board parts. This list is only used by TE-Scripts.
Select Correct Board Part Files
Since 2018.3 special "Module Selection Guide" is included into "_create_win_setup.cmd" and "_create_linux_setup.sh"
- Execute "_create_win_setup.cmd" or "_create_linux_setup.sh"
- Select "Module Selection Guide" (press "0" and Enter)
- Follow instructions
- Check <design_name>/board_files/<board_series>_board_files.csv for available board part of the reference design:
- The table shows all available board parts, which are delivered with the reference design
- "ID" Unique ID for every board file in the project delivery
- "PRODID" is the whole article name, latest reference design are available with all variants
- "PARTNAME is the FPGA device setting of Vivado for the assembly variant
- "BOARDNAME" is the corresponding board part file, which is used, files location is in "./board_files/<basename>/<Xil file id>/"
- "SHORTNAME" is the name for the board part specific sub folders in the reference design
- "ZYNQFLASHTYP" is the setting to configure the Flash via SDK
- "FPGAFLASHTYP" is the setting to configure the Flash via Vivado (first part only), the second and third part are QSPI mode and memory size in MB
- "PCB_REV" is supporte PCB Revision
-"DDR_SIZE" is DDR size if available
-"FLASH_SIZE" is Flash size if available
-"EMMC_SIZE" is eMMC size if available
-"OTHERS" other HW notes
-"NOTES" additional notes
-"DESIGN" filter for the reference design usage
- Check your order number and/or TE shop page to get module information of your PCB:
- https://shop.trenz-electronic.de/en/Products/Trenz-Electronic/<device familie>/<TE module serie>
- "Model Overview" shows the basic difference between the assembly options, in the most cases different footprint compatible FPGAs or RAM size. Assembly options (like different connector) which has no affect on board parts settings, has no separate board part files.
- Select your board part file on design_basic_settings.cmd/sh:
Use unique name from CSV list (see 1.)
- Unique names are ID or PRODID (in the most cases) or BOARDNAME or SHORTNAME
- Revision number of the PRODID is the last one, which was available on last board part update. If there is no special board part for older revisions, this will be backward compatible. Please verify this on Vivado, see 4.
See Reference Design: Getting Started for more details.
- Create Vivado Project with vivado_create_project_guimode.cmd/sh
- Verify your board part selection on Vivado "Project Summary" tap:
See Vivado Board Part Installation and Project Delivery - QuickStart