Page History

...

Page properties

hidden	true
id	Comments

Template Revision 12.0 8 - on construction

Design Name always "TE Series Name" + Design name, for example "TEI0003 TE0720 Test Board"

HTML

<!-- tables have all same width (web max 1200px and pdf full page(640px), flexible width or fix width on menu for single column can be used as before) -->
<style>
.wrapped{
  width: 100% !important;
  max-width: 1200px !important;
 }
</style>

...

Page properties

hidden	true
id	Comments

Important General Note:

Export PDF to download, if vivado revision is changed!

Designate all graphics and pictures with a number and a description, Use "Scroll Title" macro

Use "Scroll Title" macro for pictures and table labels. Figure number must be set manually at the moment (automatically enumeration is planned by scrollPDF)

Figure template (note: inner scroll ignore/only only with drawIO object):

Scroll Title

anchor	Figure_xyz
title	Text

Scroll Ignore
Create DrawIO object here: Attention if you copy from other page, use

Scroll Only
image link to the generate DrawIO PNG file of this page. This is a workaround until scroll pdf export bug is fixed

Table template:
- Layout macro can be use for landscape of large tables
- Set column width manually(can be used for small tables to fit over whole page) or leave empty (automatically)
Scroll Title
anchor Table_xyz
title Text
Scroll Table Layout
orientation portrait
sortDirection ASC
repeatTableHeaders default
style
widths
sortByColumn 1
sortEnabled false
cellHighlighting true
Example Comment
1 2

...

Scroll pdf ignore

Overview

Page properties

hidden	true
id	Comments

Notes :

short description of the design
Short Link of "Scroll only" macro:
- Use short link the Wiki Resource page, for example: http://trenz.org/te0720-info
- List of available short links: https://wiki.trenz-electronic.de/display/CON/Redirects

NIOS II Design with SDRAM Controllercontroller, 3-axis Accelerometer and 5 different LED sequences, that can be toggled using the user button.

Refer to http://trenz.org/cyc1000-info for the current online version of this manual and other available documentation.

...

Page properties

hidden	true
id	Comments

Notes :

Add basic key futuresfeatures, which can be tested with the design

Excerpt
Quartus 18Prime Lite 19.1 NIOS II SPI UART EPCQ16(A) Flash flash memory SDRAM memory 3-axis Accelerometer User LEDs User buttons

...

Scroll Title

anchor	Table_DRH
title	Design Revision History

Scroll Table Layout

orientation	portrait
sortDirection	ASC
repeatTableHeaders	default
style
widths
sortByColumn	1
sortEnabled	false
cellHighlighting	true

Date	Quartus	Project Built	Authors	Description
2020-05-13	19.1 Lite	TEI0003-test_board_noprebuilt-quartus_19.1.0-20200513080815.zip TEI0003-test_board-quartus_19.1.0-20200513081030.zip	Thomas Dück	19.1 update
2019-11-11	18.1	TEI0003-test_board_noprebuilt-quartus_18.1-20191111104152.zip TEI0003-test_board-quartus_18.1-20191111104339.zip	Thomas Dück	add bash files for Linux OS
2019-2010-29	18.1	TEI0003-test_board_noprebuilt-quartus_18.1-20191029121432.zip TEI0003-test_board-quartus_18.1-20191029121225.zip	Thomas Dück	create project with TE scripts new board variants
2019-04-02	18.1	TEI0003-02-test_board-quartus_18.1-20190402.zip	Thomas Dück	initial release

...

Scroll Title

anchor	Table_SW
title	Software

Scroll Table Layout

orientation	portrait
sortDirection	ASC
repeatTableHeaders	default
style
widths
sortByColumn	1
sortEnabled	false
cellHighlighting	true

Software	Version	Note
Quartus Prime Lite	1819.1	needed
NIOS II SBT for Eclipse	18.1	---	optionalneeded

Hardware

Page properties

hidden	true
id	Comments

Notes :

list of software which was used to generate the design

Complete List is available on <design_name>/board_files/*_devices.csv

Design supports following modules:

Scroll Title

anchor	Table_HWM
title	Hardware Modules

Scroll Table Layout

orientation	portrait
sortDirection	ASC
repeatTableHeaders	default
style
widths
sortByColumn	1
sortEnabled	false
cellHighlighting	true

Module Model	PCB Revision Support	Board Part Short Name	DDR	EPCQ Flash	Others	Notes
TEI0003-02	REV01, REV02	25_C8_8MB	8MByte	2 MByte2MByte	NA	NA
TEI0003-02A	REV2	25_C8_8MB	8MByte	2 MByte2MByte	NA	NA

Design supports following carriers:

...

Scroll Title

anchor	Table_AHW
title	Additional Hardware

Scroll Table Layout

orientation	portrait
sortDirection	ASC
repeatTableHeaders	default
style
widths
sortByColumn	1
sortEnabled	false
cellHighlighting	true

Additional Hardware	Notes
USB Cable cable for JTAG/UART	Check Carrier Board and Programmer for correct type

...

Scroll Title

anchor	Table_DS
title	Design sources

Scroll Table Layout

orientation	portrait
sortDirection	ASC
repeatTableHeaders	default
style
widths
sortByColumn	1
sortEnabled	false
cellHighlighting	true

Type	Location	Notes
Quartus	<design_name>/source_files/quartus	Quartus Project project will be generated by TE Scripts
Software	<design_name>/source_files/software	Additional Software software will be generated by TE Scripts

...

Scroll Title

anchor	Table_PF
title	Prebuilt files (only on ZIP with prebult content)

Scroll Table Layout

orientation	portrait
sortDirection	ASC
repeatTableHeaders	default
style
widths
sortByColumn	1
sortEnabled	false
cellHighlighting	true

File	File-Extension	Description
SOPC Information File	*.sopcinfo	File with description of the *.qsys file to create software for the target hardware
SRAM Object File	*.sof	Ram configuration file
JTAG indirect configuration file	*.jic	Flash configuration Filefile
Diverse Reports	---	Report files in different formats
Software - Application - File	*.elf	Software Application application for NIOS II processor system

...

Reference Design is only usable with the specified Quartus version. Do never use different Versions versions of Quartus Software software for the same Projectproject.

Page properties

hidden	true
id	Comments

Important set new Quartus version link on every Design update of new quartus version!
Set Link to download folder (Remove ../de/.. ../en/.. from url) for example: https://shop.trenz-electronic.de/Download/?path=Trenz_Electronic/Modules_and_Module_Carriers/4x5/TE0712/Reference_Design/2018.2/test_board

Reference Design is available on:

TEI0003 "Test Board" Reference Design

Design Flow

Page properties

hidden	true
id	Comments

Notes :

Basic Design Steps
Add/ Remove project specific description

...

The Trenz Electronic FPGA Reference Designs are TCL-script based projects. Command files for execution will be generated with "_create_win_setupTo create a project, open a project or program a device execute "create_project_win.cmd" on Windows OS and "create_createproject_linux_setup.sh" on Linux OS.

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

Open create_createproject_win_setup.cmd/create_createproject_linux_setup.sh and follow instructions on shell:
Press 0 and enter to start "Module Selection Guide"
:
Image Added
Select Board in "Board selection"
Click on "Create project" button to create projectCreate Project (follow instruction of the product selection guide), settings file will be configured automatically during this process
1. (optional for manual changes) Select correct device and Quartus install path on "design_basic_settings.cmd"/ "quartus installation path in "<design_name>/settings/design_basic_settings.sh" and create Quartus project with "quartus_create_project_batchmode.cmd"/"quartus_create_project_batchmode.shtcl"

Launch

Page properties

hidden	true
id	Comments

Note:

Programming and Startup procedure

Programming

JTAG

...

Note
Check Module and Carrier TRMs for proper HW configuration before you try any design.

EPCQ16(A) Flash

Connect the Module to USB-Port
Open Quartus project with "quartus_open_existingcreate_project_guimodewin.cmd"/ "quartus_open_existing_create_project_guimodelinux.sh
Select correct board in "Board selection"
Click on "
Open the Quartus Prime Programmer from Tools → Programmer
If the correct configuration file is not set:
1. Delete other files
2. Click "Add file..."
3. select the correct *.jic file (created project file: <design_name>/quartus/output_files/test_board.jic or prebuilt file: <design_name>/prebuilt/<board_part_short_name>/programming_files/*.jic)
4. enable Program/Configure
Click start

After Flash is programmed, press the reset button

Program device" button
1. if prebuilt files are available: select "Program prebuilt file"
2. using own generated programming file: select "Program other file" and click on "Browse ..." to open own generated programming file
3. (optional) click on "Open programmer GUI" to program device with Quartus programmer GUI
Click on "Start program device" button

JTAG

Not used on this example.

Usage

Prepare Hardware like described on section Programming
Connect UART USB (most cases same as JTAG)

UART

Open Serial Console "PuTTY"(e.g. PuTTY)Change settings in category "Session"
1. COM Port: Win OS see device manager (Win OS), Linux OS → OS see dmesg | grep ttytty (UART is *USB1)
2. Speed: 115200
Select "Implicit CR in every LF" in category "Terminal"
Click Open
Press reset button at on the module
You can toggle Toggle between following LED sequences modes by pressing user button
1. Spirit level
2. Case statement sequence
3. Shift register sequence
4. Knightrider sequence
5. Pulse-width modulation sequence

System Design - Quartus

Page properties

hidden	true
id	Comments

Note:

Description of Block Design, Constrains... BD Pictures from Export...

Block Design

Scroll Title

anchor	Figure_BD
title	Block Design - Project

Image Added

Scroll Title

anchor	Figure_BD
title	Block Design - Platform Designer

Image Added

Software Design - SDK

Page properties

hidden	true
id	Comments

Note:

optional chapter separate
sections for different apps

Application

Page properties

hidden	true
id	Comments

Template location: <design_name>/source_files/software/

test_board

Software example to test TEI0003 module.

Appx. A: Change History and Legal Notices

Document Change History

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

...

Scroll Title

anchor	Table_dch
title	Document change history.

Scroll Table Layout

orientation	portrait
sortDirection	ASC
repeatTableHeaders	default
style
widths	2,,3,4
sortByColumn	1
sortEnabled	false
cellHighlighting	true

Date

Document Revision

Authors

Description

Page info

	modified-date
	modified-date
dateFormat	yyyy-MM-dd

Page info

infoType	Current version
dateFormat	yyyy-MM-dd
prefix	v.
type	Flat

Page info

infoType	Modified by
type	Flat

19.1 release

2019-11-11

v.5

Thomas Dück

add bash files for Linux OS

2019-10-29

v.3

Thomas Dück

change design to TE scripts
new board variants

2019-04-03

v.2

Thomas Dück

Initial release 18.1

--

all

Page info

infoType	Modified users
dateFormat	yyyy-MM-dd
type	Flat

--

...

Trenz Electronic Documentation

Versions Compared

Old Version 5

New Version 6

Key

Table of contents

Overview

Hardware

Design Flow

Launch

Programming

JTAG

EPCQ16(A) Flash

JTAG

Usage

UART

System Design - Quartus

Block Design

Software Design - SDK

Application

test_board

Appx. A: Change History and Legal Notices

Document Change History