<!--
Template Revision 1.0
- export PDF to download, if vivado revision is changed!
Template for different design and SDSoC and examples, remove unused or wrong description!
 -->

Online version of this manual and other related documents can be found at https://wiki.trenz-electronic.de/display/PD/Trenz+Electronic+Documentation

Overview

<!--
General Design description
 -->

Key Features

• PetaLinux
• SD
• ETH
• USB
• U2C
• RTC

Revision History

Release Notes and Know Issues

Requirements

<!--
Removed unused SW or ADD SW ...
   -->

Software

Hardware

Basic description of TE Board Part Files is available on TE Board Part Files.

Complete List is available on <design name>/board_files/*_board_files.csv

Design supports following modules:

Design supports following modules:

Additional HW Requirements

Content

<!--
Remove unused content
  -->

For general structure and of the reference design, see Project Delivery

Design Sources

Additional Sources

Download

Reference Design is only usable with the specified Vivado/SDK/PetaLinux/SDx version. Do never use different Versions of Xilinx Software for the same Project.

<!--
Add correct path:https://shop.trenz-electronic.de/en/Download/?path=Trenz_Electronic/TE0803/Reference_Design/2017.1/Starterkit
  -->

Reference Design is available on:

• TE0000 Reference Design Download Area

Design Flow

<!--
Basic Design Steps
Add/ Remove project specific 
  -->

Trenz Electronic provides a tcl based built environment based on Xilinx Design Flow. See: Vivado/SDK/SDSoC#XilinxSoftware-BasicUserGuides and Project Delivery

The most Trenz Electronic FPGA Reference Designs are TCL-script based project. Command files for execution will be generated with "_create_win_setup.cmd" on Windows OS and "_create_linux_setup.sh" on Linux OS.

TE Scripts are only needed to generate the vivado project, all other additional steps are optional and can also executed by Xilinx Vivado/SDK GUI.  For currently limitations on Win and Linux OS see: Project Delivery Currently limitations of functionality

1. Run _create_win_setup.cmd/_create_linux_setup.sh and follow instructions on shell:
   
2. Press 0 and enter for minimum setup
3. (optional) Generate Virtual Drive or use short directory  for the reference design (for example x:\<design name>)
4. Create Project
   1. Select correct device on "design_basic_settings.cmd" and create Vivado project with "vivado_create_project_guimode.cmd"
      Note: Select correct one, see TE Board Part Files
5. Create HDF and export to prebuilt folder
   
   1. Run on Vivado TCL: TE::hw_build_design -export_prebuilt
      Note: Script generate design and export files into \prebuilt\hardware\<short dir>. Use GUI is the same, except file export to prebuilt folder
6. Create Linux (uboot.elf and image.ub) with exported HDF
   1. HDF is exported to "prebuilt\hardware\<short name>"
      Note: HW Export from Vivado GUI used default another path.
   2. Create Linux images on VM, see PetaLinux KICKstart
      1. Use TE Template from /os/petalinux
7. Add Linux files (uboot.elf and image.ub) to prebuilt folder
   1. "prebuilt\os\petalinux\default" or "prebuilt\os\petalinux\<short name>"
      Notes: Scrips select "prebuilt\os\petalinux\<short name>", if exist, otherwise "prebuilt\os\petalinux\default"
8. Generate Programming Files with HSI/SDK
   1. Run on Vivado TCL: TE::sw_run_hsi
      Note: Scripts generate applications and bootable files, which are defined in "sw_lib\apps_list.csv"
   2. (alternative) Use start SDK with Vivado GUI or start with TE Scripts on Vivado TCL: TE::sw_run_sdk
      Note: See SDK Projects
      
      

Launch

<!--
Description of Block Design, Constrains...
BD Pictures from Export...
  -->

Programming

Xilinx documentation for programming and debugging: Vivado/SDK/SDSoC-Xilinx Software Programming and Debugging

QSPI

Not used on this Example.

SD

1. Copy image.ub and Boot.bin on SD-Card.
   • For correct prebuilt file location, see <design_name>/prebuilt readme_file_location.txt
2. Set Boot Mode to SD-Boot.
   • Depends on Carrier, see carrier TRM.
3. Insert SD-Card in SD-Slot.

JTAG

Not used on this Example.

Usage

1. Prepare HW like described on section programming
2. Connect UART USB (most cases same as JTAG)
3. Power On PCB
4. Open Serial Console (e.g. putty)
   
   1. Speed: 115200

System Design - Vivado

<!--
Description of Block Design, Constrains...
BD Pictures from Export...
  -->

• Vivado Projects

Description currently not available.

Design

Constrains

Software Design - SDK/HSI

<!--
optional chapter
separate sections for different apps
  -->

• SDK Projects

Description currently not available.

Application

FSBL

Software Design -  PetaLinux

<!--
optional chapter
  -->

• PetaLinux KICKstart

Description currently not available.

Config

U-Boot

Device Tree

Kernel

Rootfs

Appx. A: Change History and Legal Notices

Document Change History

To get content of older revision  got to "Change History"  of this page and select older document revision number.

<!--
Generate new entry:
1:add new row below first
2:Copy Page Information Macro(date+user) Preview, Page Information Macro Preview
3.Update Metadate =Page Information Macro Preview+1
  -->

Date	Document Revision	Authors	Description
			Work in progress
2017-09-11	v.1		Initial release
	All

Legal Notices