Project Delivery

Release Description

Last supported Release

Name Description of Zip-delivery

Directory structure

Windows Command Files

Additional TCL functions for usage on Vivado TCL Console

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 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 you press this Button.
      
• Variant 3:
  • Reinitialise Script on Vivado TCL-Console:
    • Type: source ../scripts/reinitialise_all.tcl
      

Use predefined TE-Script functions

• Variant 1:
  • Typ function on Vivado TCL Console, ex.: TE::help
  • TE::help
    
    • Show all predefined TE-Script functions.
  • TE:<functionname> -help 
    
    • Show short description of this function.
    • Attention: If -help argument is set, all other args will be ignored. 
• Variant 2:
  • Create your own function Button on the Vivado GUI:
    • Tools → Customize Commands → Customize Commands...
    • Push +
    • Type Name ex.: Run SDK
      
    • Press Enter
      
    • Select Run command and insert function:
      • Variante 1 (no Vivado request window for args):
        • insert function and used args, ex.: TE::sw_program_zynq -swapp hello_world
      • Variant 2 (Vivado request window for args):
        • insert function, ex.:TE::sw_program_zynq
        • Press Define Args...
        • For every arg:
          
          • Push
          • Typ Name, Comment, Default Value and set optional
          • Press Enter
            
          • Example for args:
          • • Push
            • Index, Key Name, -swapp,
            • Push
            • Appname, Arg, hello_world,
              
             
    • Press Enter
    • A new Button is shown on the Vivado Gui.

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? Somtimes TCL-Scripts can't handle this correctly. Remove spaces from project path.

References

1. Xilinx User Guide UG949
2. Revision Control use guide from Vivado User Club 2015 Stuttgart
3. SDSoC platform builder file structure