Versions Compared

Key

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

...

File or DirectoryTypeDescription
<design_name>base directoryBase directory with predefined batch files (*.cmd) to generate or open VIVADO-Project
<design_name>/block_design/sourceScript to generate Block Design in Vivado (*_bd.tcl) 
<design_name>/board_files/sourceLocal board part files repository and a list of available board part files  (<board_series>_board_files.csv)
<design_name>/constraints/sourceProject constrains (*.xdc)
<design_name>/doc/sourceDocumentation
<design_name>/ip_lib/sourceLocal Vivado IP repository
<design_name>/misc/source(Optional) Directory with additional sources
<design_name>/prebuilt/boot_images/prebuiltDirectory with prebuild prebuilt boot images (*.bin) and configuration files (*.bif)  for zynq and configured hardware files (*.bit and *.mcs) for micoblaze included in subfolders: default or <board_file_shortname>/<app_name>
<design_name>/prebuilt/hardware/prebuiltDirectory with prebuild prebuilt hardware sources (*.bit, *hdf, *.mcs) and reports included in subfolders: default or <board_file_shortname>
<design_name>/prebuilt/software/prebuilt(Optional) Directory with prebuild prebuilt software sources (*.elf) included in subfolders: default or <board_file_shortname>/<app_name>
<design_name>/prebuilt/os/prebuilt(Optional) Directory with predefined OS images included in subfolders  <os_name>/<board_file_shortname> or <os_name>/default
<design_name>/scripts/sourceTCL scripts to build a project
<design_name>/software/source(Optional) Directory with additional software
<design_name>/sw_lib/source(Optional) Directory with local SDK/HSI software IP repository and a list of available software (apps_list.csv)
<design_name>/v_log/generatedTemporary directory with vivado log files (used only when vivado is started with predefined command files (*.cmd) from base folder otherwise this logs will be writen into the vivado working directory)
<design_name>/vivado/work, generatedWorking directory where Vivado project is created. Vivado project file is <design_name>.xpr
<design_name>/vivado_lab/work, generated(Optional) Working directory where Vivado LabTools is created. LabTools project file is <design_name>.lpr
<design_name>/workspace/hsiwork, generated(Optional) Directory where hsi project is created
<design_name>/workspace/sdkwork, generated(Optional) Directory where sdk project is created
<design_name>/backup/generated(Optional) Directory for project backups

...

File NameDescription
Settings
start_settings.cmd

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

  • General Settings:
    • (optional) DO_NOT_CLOSE_SHELL: Shell do not closed after processing
    • (optional) Zip Path ZIP_PATH: Set Path to installed Zip-Program. Currently 7-Zip are supported. IUsed for predefined TCL-function to Backup project.
  • Xilinx Setting:
    • XILDIR: Set Path to the Xilinx Directory  Set Xilinx installation path (Default: c:\Xilinx).
    • VIVADO_Version: Used to get correct path of Vivado. Is the name of the Vivado Installation in %XILDIR%\vivado\  VERSION: Current Vivado/LabTool/SDK Version (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.
          • Xilinx Software will be searched in:
          • VIVADO (optional for project creation and programming): %XILDIR%\Vivado\%VIVADO_VERSION%\

          • SDK (optional for software projects and programming): %XILDIR%\SDK\%VIVADO_VERSION%\

          • LabTools (optional for programming only): %XILDIR%\Vivado_Lab\%VIVADO_VERSION%\

      • Board Setting:
        • PARTNUMBER: Set Board part number of the project which should be created
          • Available Numbers: (you can use ID,PRODID,BOARDNAME or SHORTNAME from TExxxx_board_file.csv list)
          • Used for project creation and programming
          • To create empty project without board part, used PARTNUMBER=-1 (use GUI to create your project. No block design tcl-file should be in /block_design)
          • Example TE0726 Module :
          • USE ID                 |USE PRODID                      |Use Boardname                                                |Use Shortname
            PARTNUMBER=1|PARTNUMBER=te0726-01 |PARTNUMBER=trenz.biz:te0726-01:part0:1.0 |PARTNUMBER=TE0726-01
      • Programming Settings(program*file.cmd):
        • SWAPP: Select Software App, which should be configured.
          • Use the folder name of the <design_name>/prebuilt/boot_image/<partname>/* subfolder. The *bin,*.mcs or *.bit from this folder will be used.
          • If you will configure the raw *.bit or *.mcs  *.bin  from the <design_name>/prebuilt/hardware/<partname>/ folder, use @set SWAPP=NA or @set SWAPP="".
          • Example: SWAPP=hello_world   → used the file from prebuilt/boot_image/<partname>/hello_world
                            SWAPP=NA                → used the file
        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>/
          • _image/<partname>/
        • PROGRAM_ROOT_FOLDER_FILE: If you want to program design file from the rootfolder <design_name>, set to 1
          • Attention: it should be only one *.bit, *.msc or *.bin file in the root folder.

    Hardware Design

    create_project_firstgui.cmd

    Create 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

    (optional)  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.
    run_project_nogui.cmd

    (optional)  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.

    Software Design
    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".
    Programming
    program_flash_binfile.cmd(optional) For Zynq Systems only. Programming Flash Memory via JTAG with specified Boot.bin. Used SDK Programmer (Same as SDK  "Program Flash") or LabTools Programmer (Vivado or LabTools only), depends on installion settings. It Default, it used the boot.bin from: <design_name>/prebuilt/boot_images/<board_file_shortname>/<app_name>. Set <board_file_shortname> and <app_name> Settings are done in "start_settings.cmd".
    program_flash_mcsfile.cmd(optional) For Non-Zynq Systems only. Programming Flash Memory via JTAG with specified <design_name>.mcs. Used LabTools Programmer (Vivado or LabTools only), depends on installion settings. It Default, it used the <design_name>.mcs from: <design_name>/prebuilt/hardware/<board_file_shortname>. Set <board_file_shortname> Settings are done in "start_settings.cmd".
    program_fpga_bitfile.cmd(optional)  Programming FPGA via JTAG with specified <design_name>.bit. Used LabTools Programmer (Vivado or LabTools only), depends on installion settings. It Default, it used the <design_name>.bit from: <design_name>/prebuilt/hardware/<board_file_shortname>. Set <board_file_shortname>  Settings are done in "start_settings.cmd".
    vivado_labtools.cmd

    (optional)  Create or open an existing Vivado Lab Tools Project. (Additional TCL functions from Programming and Utilities Group are usable).

    Utilities
    clear_project.cmd(optional)  Attention: Delete "<design_name>/v_log/", "<design_name>/vivado/","<design_name>/vivado_lab/", and "<design_name>/workspace/" directory with related documents!

    ...

    NameOptionsDescription (Default Configuration)
    TE::help Display currently available functions. Important: Use only displayed functions and no functions from sub-namespaces 
    Hardware Design
    TE::hw_blockdesign_export_tcl[-no_mig_contents] [-no_validate] [-mod_tcl] [-svntxt <arg>] [-help]Export Blockdesign to project folder <design_name>/block_design/ . Old *bd.tcl will be overwritten!
    TE::hw_build_design[-export_prebuilt] [-export_prebuilt_only] [-help]Run Synthese, Implement, and generate Bitfile, optional MCSfile and some report files
    Software Design
    TE::sw_run_hsi[-run_only] [-prebuilt_hdf <arg>]   [-no_hsi] [-no_bif] [-no_bin] [-no_bitmcs] [-clear] [-help]

    Copies current Hardware files and reports from the vivado project to the prebuilt folder, if -prebuild_hdf <arg> isn't set.
    Copy the Hardware Defintition file to the working directory:<design_name>/workspace/hsi
    Run HSI in <design_name>/workspace/hsi for all Programes listed in <design_name>/sw_lib/apps_list.csv
    If HSI is finished, BIF-GEN and BIN-Gen are running for these Apps in the prepuilt folders <design_name>/prebuilt/...
    You can deactivate different steps with following args :

    • -no_hsi  : *.elf filesgeneration is disabled
    • -no_bif   : *.bif files generation is disabled
    • -no_bin  : *.bin files generation is disabled
    • -no_bitmcs: *.bin files generation bit and *.mcs file (with software design) is disabled
    TE::sw_run_sdk[-open_only] [-update_hdf_only] [-prebuilt_hdf <arg>] [-clear\] [-help]

    Copies current Hardware files and reports from the vivado project to the prebuilt folder, if -prebuild_hdf <arg> isn't set.
    Copy the Hardware Defintition file to the working directory:<design_name>/workspace/sdk
    Start SDK GUI in this workspace

    Programming
    TE::pr_init_hardware_manager[-help]Open Hardwaremanager, autoconnect target device and initialise flash memory with configuration from *_board_files.csv.
    TE::pr_program_jtag_bitfile[-used_board <arg>] [-swapp <arg>] [-available_apps] [-used_basefolder_bitfile] [-help]

    Copies current Hardware files and reports from the vivado project to the prebuilt folder, if -used_board <arg> isn't set (Vivado only).
    Programming Bitfile from <design_name>/prebuilt/hardware/<board_file_shortname> to the fpga device.
    If "-used_basefolder_bitfile" is set, the Bitfile (*.bit)  from the base folder (<design_name>) is used instead of the prebuilts. Attention: Take only one Bitfile in the basefolder!the basefolder!

    (MicroBlaze only) If "-swapp" is set, the Bitfile with *.elf configuration is used from <design_name>/prebuilt/boot_images/<board_file_shortname>/<app_name>

    TE::pr_program_flash_binfile[-no_reboot] [-used_board <arg>] [-swapp <arg>] [-available_apps] [-force_hw_manager]   [-used_basefolder_binfile] [-help]

    Attention: For Zynq Systems only!
    Program the Bootbin from <design_name>/prebuilt/boot_images/<board_file_shortname>/<app_name> to the fpga device.
    Appname is selected with: -swapp <app_name>
    After programming device reboot from memory will be done.
    Default SDK Programmer is used, if not available LabTools Programmer is used.
    If "-used_basefolder_binfile" is set, the Binfile (*.bin)  from the base folder (<design_name>) is used instead of the prebuilts. Attention: Take only one Binfile in the basefolder!

    TE::pr_program_flash_mcsfile[-no_reboot] [-used_board <arg>] [-swapp <arg>] [-available_apps] [-used_basefolder_mcsfile] [-help]

    Copies current Hardware files and reports from the vivado project to the prebuilt folder, if -used_board <arg> isn't set (Vivado only).
    Initialise flash memory with configuration from *_board_files.csv
    Programming  MCSfile from <design_name>/prebuilt/hardware/<board_file_shortname> to the Flash Device.
    After programming device reboot from memory will be done.
    If "-used_basefolder_binfile" is set, the MCSfile (*.mcs)  from the base folder (<design_name>) is used instead of  the prebuilts. Attention: Take only one MCSfile in the basefolder!

    (MicroBlaze only) If "-swapp" is set, the MCSfile with *.elf configuration is used from <design_name>/prebuilt/boot_images/<board_file_shortname>/<app_name>

    Utilities
    TE::util_zip_project[-save_all] [-remove_prebuilt] [-manual_filename <arg>] [-help]

    Make a Backup from your Project in <design_name>/backup/

    Zip-Program Variable must be set in start_settings.cmd. Currently only 7-Zip is supported.

    ...