Versions Compared

Old Version 28

changes.mady.by.user John Hartfiel

Saved on

compared with

New Version 29

changes.mady.by.user John Hartfiel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

 

Last supported Release

Type or FileVersion
Vivado Design Suite2015.4
Trenz Project Scripts2015.4.09
Trenz <board_series>_board_files.csv1.2
Trenz apps_list.csv

1.5

...

File NameDescription
clear_project.cmd!Delete "<design_name>/v_log/", "<design_name>/vivado/", and "<design_name>/workspace/" directory with related documents!
create_project_firstgui.cmdCreate Project with setting from "start_settings.cmd" and source folders. Vivado GUI will be opened during the process.
Delete "<design_name>/v_log/", "<design_name>/vivado/", and "<design_name>/workspace/" directory with related documents before Projekt will created.
create_project_nogui.cmd

Create Project with setting from "start_settings.cmd" and source folders.

Delete "<design_name>/v_log/", "<design_name>/vivado/", and "<design_name>/workspace/" directory with related documents before Projekt will created.

open_project_gui.cmdOpens an existing Project "<design_name>/vivado/<design_name>.xpr". Delete old "<design_name>/v_log/" before Projekt will opend.
program_zynqflash.cmd

(optional) For Zynq Systems only. Programming Flash Memory with specified Boot.bin. (Same as SDK  "Programm Flash"). Used Boot.bin from prebuilt-Folder. It used the boot.bin from: <design_name>/prebuilt/boot_images/<board_file_shortname>/<app_name>. Set <board_file_shortname> and <app_name> in "start_settings.cmd".

create_prebuilt_sdk.cmd(optional) Create SDK project with hardware definition file from prebuild folder. It used the *.hdf from: <design_name>/prebuilt/hardware/<board_file_shortname>/. Set <board_file_shortname> and <app_name> in "start_settings.cmd".
run_project_nogui.cmd

Create Project with setting from "start_settings.cmd" and source folders. Build all Vivado hardware and software files if the sources are available.

Delete  "<design_name>/vivado/", and "<design_name>/workspace/hsi/" directory with related documents before Projekt will created.

start_settings.cmd

Settings for the other *.cmd files. Following Settings are avaliable:

  • General Settings:
    • (optional) Zip Path: Set Path to installed Zip-Programm. Currently 7-Zip are supported. IUsed for predefined TCL-function to Backup project.
    • XILDIR: Set Path to the Xilinx Directory (Default: c:\Xilinx).
    • VIVADO_Version: Used to get correct path of Vivado. Is the name of the Vivado Installation in %XILDIR%\vivado\  (Example:2015.4). Don't change Vivado Version.
  • Select Board Part:
    • PARTNUMBER: Select Board part number of the project which should be created. All available Boards are listed in <design_name>/board_files/TExxxx_board_file.csv. You can use  ID,PRODID,BOARDNAME or SHORTNAME from this list.
  • Programming Settings(program_zynqflash.cmd):
    • SWAPP: Select the Software App which should be configured. Use <app_name> from <design_name>/prebuilt/boot_images/<board_file_shortname>/

Additional TCL functions for usage on Vivado TCL Console

NameOptionsDescription
TE::help Display currently available functions. Important: Use only displayed functions and no functions from sub-namespaces 
TE::hw_blockdesign_export_tcl[-no_mig_contents] [-mod_tcl] [-svntxt <arg>] [-help] 
TE::hw_build_design[-help] 
TE::sw_run_hsi[-run_only] [-prebuilt_hdf <arg>] [-no_bif] [-no_bin] [-clear] [-help] 
TE::sw_run_sdk[-open_only] [-update_hdf_only] [-prebuilt_hdf <arg>] [-clear\] [-help] 
TE::sw_program_zynq[-used_board <arg>] [-swapp <arg>] [-available_apps] [-help] 
TE::util_zip_project[-save_all] [-remove_prebuilt] [-manual_filename <arg>] [-help] 

Usage

Create project

  1. Unzip project files
  2. Rename basefolder (basefolder name is used as project name)
  3. Edit start_settings.cmd
    1. Select the correct board part number for your PCB  (See: Windows Command Files -->start_settings.cmd)
    2. Other settings are optional  (See: Windows Command Files -->start_settings.cmd)
  4. Excecute create_project_firstgui.cmd or create_project_nogui.cmd to generate a vivado project with the predefined block_design from the block_design folder
  5. Open Vivado with open_project_gui.cmd (if you use create_project_firstgui.cmd on step 4, you didn't need this)
  6. Open the Block Design and create your own design inside this Block Design.
  7. Backup your Block Design as tcl-script: Type "TE::hw_blockdesign_export_tcl" on Vivado Tcl Console. The old one will be overwritten.
  8. Build your Design... 

Initial scripts on existing Vivado project

  • Variant 1:
    • start Start the project with the predefined command file (open_project_gui.cmd)
  • Variant 2:
    • Create your own Initialisation Button on the Vivado GUI:
      • Tools --> Customize Commands --> Customize Commands...
      • Push +
      • Type Name ex.: Init Scripts
      • Press Enter
      • Select Run command : and insert: cd [get_property DIRECTORY [current_project]]; source -notrace "../scripts/reinitialise_all.tcl"
      • Press Enter
      • A new Button is shown on the Vivado Gui: All Scripts are reinitialised, If if you press this Button Button.
  • Variant 3:
    • Reinitialise Script on Vivado TCL-Console:
      • Type: source ../scripts/reinitialise_all.tcl

 

Additional TCL functions for usage on Vivado TCL Console

...

      • tcl

...


 

Checklist

  1. Are you using exactly the same Vivado version? If not then the scripts will not work, no need to try.
  2. Do you run the script from Vivado console? They may work from Vivado GUI TCL prompt also, but they are tested only from pure Vivado TCL console prompt.
  3. Ary you using Vivado in Windows PC? Vivado works in Linux also, but the scripts are tested on Windows only.
  4. Is you PC OS Installation English? Vivado may work on national versions also, but there have been known problems.
  5. Are space character on the project path? TCL-Scripts can't handle this correct. Remove spaces from project path.

...