Versions Compared

Key

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


Page properties
hiddentrue
idComments

Template Revision 1.0 - on construction

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

...

DateVersionChangesAuthor




2021-06-151.2
  • table of content view
  • template history
  • placed a horizontal separation line under each chapter heading
  • replaced <design name> by <project folder>
  • changed title-alignment for tables from left to center
  • update 19.x to 20.x
JH,TD
2020-11-241.1
  • add fix table of content
  • add table size as macro
JH
--1.0----


Custom_table_size_100

Page properties
hiddentrue
idComments

Important General Note:

  • Export PDF to download, if

...

  • quartus 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
        anchorFigure_xyz
        titleText


        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
        anchorTable_xyz
        titleText

        Scroll Table Layout
        orientationportrait
        sortDirectionASC
        repeatTableHeadersdefault
        style
        widths
        sortByColumn1
        sortEnabledfalse
        cellHighlightingtrue

        ExampleComment
        12



  • ...

Overview

scroll

...

-ignore

Table of contents

...

scroll-pdftrue
scroll-officetrue

...

scroll-chm

...

true

...

scroll-docbooktrue

...

scroll-eclipsehelp

...

true
scroll-epubtrue
scroll-htmltrue


Page properties
hiddentrue
idComments

Notes :

NIOS II Design with SDRAM controller, flash memory test and different LED sequences.

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

Key Features

Page properties
hiddentrue
idComments

Notes :

  • Add basic key futures, which can be tested with the design


Excerpt
  • Quartus Prime Lite

...

  • 20.1
  • NIOS II
  • SPI
  • UART
  • User Flash memory
  • SDRAM memory
  • 3-axis Accelerometer
  • User LEDs
  • User buttons

Revision History

Page properties
hiddentrue
idComments

Notes :

  • add every update file on the download
  • add design changes on description


Scroll Title
anchorTable_DRH
title-alignmentcenter
titleDesign Revision History

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

DateQuartusProject BuiltAuthorsDescription

...

2021-

...

07-

...

09

...

20.1 Lite

TEI0001-test_board_noprebuilt-quartus_

...

20.1.

...

1-

...

20210709113727.zip

TEI0001-test_board-quartus_

...

20.1.

...

1-

...

20210709113644.zip

Thomas Dück

...

  • bugfixes
  • update to Quartus Prime Lite 20.1
  • TE scripts update
2020-10-1919.1 Lite

TEI0001-test_board_noprebuilt-quartus_19.1.0-20201019101714.zip

TEI0001-test_board-quartus_19.1.0-20201019101651.zip

Thomas Dück
  • bugfixes
2020-07-0719.1 Lite

TEI0001-test_board_noprebuilt-quartus_19.1.0-20200707153033.zip

TEI0001-test_board-quartus_19.1.0-20200707153205.zip

Thomas Dück
  • bugfixes
  • script update
2020-05-1219.1 Lite

TEI0001-test_board_noprebuilt-quartus_19.1.0-20200512095852.zip

TEI0001-test_board-quartus_19.1.0-20200512100037.zip

Thomas Dück
  • 19.1 update
2019-11-1118.1

TEI0001-test_board_noprebuilt-quartus_18.1-20191111104201.zip

TEI0001-test_board-quartus_18.1-20191111104348.zip

Thomas Dück
  • add bash files for Linux OS
2019-10-2818.1

TEI0001-test_board_noprebuilt-quartus_18.1-20191028120819.zip

TEI0001-test_board-quartus_18.1-20191028120521.zip

Thomas Dück
  • create project with TE scripts
  • new assembly variants
2019-04-0218.1TEI0001-03-08-C8-test_board-quartus_18.1-20190402.zipThomas Dück
  • initial release


Release Notes and Know Issues

Page properties
hiddentrue
idComments
Notes :
  • add known Design issues and general notes for the current revision
  • do not delete known issue, add fixed version time stamp if  issue fixed


Scroll Title
anchorTable_KI
title-alignmentcenter
titleKnown Issues

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

IssuesDescriptionWorkaroundTo be fixed version
No known issues---------


Requirements

Software

Page properties
hiddentrue
idComments

Notes :

  • list of software which was used to generate the design


Scroll Title
anchorTable_SW
title-alignmentcenter
titleSoftware

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

SoftwareVersionNote
Quartus Prime Lite

...

20.1needed
NIOS II SBT for eclipse---optional


Hardware

Page properties
hiddentrue
idComments

Notes :

  • list of

...

  • hardware which was used to generate the design
  • mark the module and carrier board, which was used tested with an *
Complete List is available on

...

<project folder>/board_files/*_devices.csv

Design supports following modules:

Scroll Title
anchorTable_HWM
title-alignmentcenter
titleHardware Modules

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

Module ModelBoard Part Short NamePCB Revision SupportDDRQSPI FlashOthersNotes
TEI0001-03-08-C8*08_C8_8MBREV02, REV038MByte64MBitNANA
TEI0001-03-16-C816_C8_8MBREV02, REV038MByte64MBitNA

NA

TEI0001-03-16-C8A16_C8A_32MBREV0332MByte64MBitNANA
TEI0001-03-16-C8P16_C8P_8MBREV038MByte64MBitNANA

*used as reference

Design supports following carriers:

Scroll Title
anchorTable_HWC
title-alignmentcenter
titleHardware Carrier

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

Carrier ModelNotes
---

*used as reference

Additional HW Requirements:

Scroll Title
anchorTable_AHW
title-alignmentcenter
titleAdditional Hardware

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

Additional HardwareNotes
USB cable for JTAG/UARTCheck Carrier Board and Programmer for correct type


Content

Page properties
hiddentrue
idComments

Notes :

  • content of the zip file

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

Design Sources

Scroll Title
anchorTable_DS
title-alignmentcenter
titleDesign sources

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

TypeLocationNotes
Quartus

...

<project folder>/source_files/quartus

<project folder>/source_files/<Board Part Short Name>/quartus

Quartus project will be generated by TE Scripts

optional, source files for specific assembly variants

Software

...

<project folder>/source_files/software

<project folder>/source_files/<Board Part Short Name>/software

Additional software will be generated by TE Scripts

Prebuilt

...

optional, source files for specific assembly variants


Prebuilt

Page properties
hiddentrue
idComments

Notes :

  • prebuilt files
  • Template Table:

    • Scroll Title
      anchorTable_PF
      titlePrebuilt files

      Scroll Table Layout
      orientationportrait
      sortDirectionASC
      repeatTableHeadersdefault
      style
      widths
      sortByColumn1
      sortEnabledfalse
      cellHighlightingtrue

      File

      File-Extension

      Description

      SOPC Information File*.sopcinfoFile with description of the .qsys file to create software for the target hardware
      SRAM Object File*.sofRam configuration file
      Programmer Object File*.pofFPGA configuration file
      JTAG indirect configuration file*.jicFlash configuration file
      Diverse Reports---Report files in different formats
      Software-Application-File*.elfSoftware application for NIOS II processor system




Scroll Title
anchorTable_PF
title-alignmentcenter
titlePrebuilt files (only on ZIP with prebuilt content)

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

File

File-Extension

Description

SOPC Information File*.sopcinfoFile with description of the *.qsys file to create software for the target hardware
Programmer Object File*.pofFPGA configuration file
Diverse Reports---Report files in different formats
Software Application File*.elfSoftware application for NIOS II processor system


Download

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

Page properties
hiddentrue
idComments

Reference Design is available on:

Design Flow

...

Scroll Ignore
scroll-pdftrue
scroll-officetrue

...

scroll-chm

...

  • Basic Design Steps

  • Add/ Remove project specific description

...

true
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


Page properties
hiddentrue
idComments
Notes :
  • Basic Design Steps

  • Add/ Remove project specific description


Note

Reference Design is available with and without prebuilt files. It's recommended to use TE prebuilt files for first launch.

Trenz Electronic provides a tcl based built environment based on Quartus Design Flow.

See also:


The Trenz Electronic FPGA Reference Designs are TCL-script based projects. To create a project, open a project or program a device execute "create_project_win.cmd" on Windows OS and "create_project_linux.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 Quartus/SDK GUI. For currently Scripts limitations on Win and Linux OS see: Project Delivery - Intel devices → Currently limitations of functionality

  1. Open create_project_win.cmd/create_project_linux.sh:
    'Create Project' GUI exampleImage Modified
  2. Select Board in "Board selection"
  3. Click on "Create project" button to create project
    1. (optional for manual changes) Select correct quartus installation path in "

...

    1. <project folder>/settings/design_basic_settings.tcl"

Launch

...

Scroll Ignore
scroll-pdftrue

...

scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


Page properties
hiddentrue
idComments

Note:

  • Programming and Startup procedure

Programming

Note

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

MAX10 Flash

  1. Connect the Module to USB-Port
  2. Open create_project_win.cmd/create_project_linux.sh
  3. Select correct board in "Board selection"
  4. Click on "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
  5. Click on "Start program device" button

JTAG

Not used on this example.

Usage

  1. Prepare Hardware like described on section

...

  1. Programming
  2. Connect UART USB (most cases same as JTAG)

UART

  1. Open Serial Console (e.g. PuTTY)
    1. COM Port: Win OS see device manager, Linux OS see  dmesg | grep tty  (UART is *USB1)
    2. Speed: 115200
  2. Press reset button

...

  1. Spirit level
  2. Winbond SPI flash memory test
  3. Shift register sequence
  4. Knightrider sequence
  5. Case statement sequence

System Design - Quartus

...

hiddentrue
idComments

Note:

...

  1. Console output depends on used Software project, see Software Design - SDK#Application

System Design - Quartus

Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


Page properties
hiddentrue
idComments

Note:

  • Description of Block Design - Project, Block Design - Platform Desginer, ... Block Design Pictures from Export...

Block Design

The block designs may differ depending on the assembly variant.

Scroll Title
anchorFigure_BD
title-alignmentcenter
titleBlock Design - Project
Image Modified



Scroll Title
anchorFigure_BD
title-alignmentcenter
titleBlock Design - Platform Designer
Block Design - NIOS_test_board.qsysImage Modified

Software Design - SDK

...

Scroll Ignore
scroll-pdftrue

...

scroll-office

...

true
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


Page properties
hiddentrue
idComments
Note:
  • optional chapter separate

  • sections for different apps

Application

Page properties
hiddentrue
idComments

----------------------------------------------------------

General Example:

hello_tei0006

Hello TEI0006 is a Quartus Hello World example as endless loop instead of one console output.


Used software project depends on board assembly variant. Template location: <project folder>/source_files/software/

test_board

Software example to test TEI0001 module.

  • You can toggle between following modes by pressing user button
    1. Spirit level
    2. Winbond SPI flash memory test
    3. Shift register sequence
    4. Knightrider sequence
    5. Case statement sequence


Appx. A: Change History and Legal Notices

Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbook

General Example:

hello_tei0006

Hello TEI0006 is a Quartus Hello World example as endless loop instead of one console output.

Template location: <design_name>/source_files/software/

test_board

Software example to test TEI0001 module.

...

true
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue

Document Change History

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

Page properties
hiddentrue
idComments
  • Note this list must be only updated, if the document is online on public doc!
  • It's semi automatically, so do following
    • Add new row below first

    • Copy "Page Information Macro(date)" Macro-Preview, Metadata Version number, Author Name and description to the empty row. Important Revision number must be the same as the Wiki document revision number Update Metadata = "Page Information Macro (current-version)" Preview+1 and add Author and change description. --> this point is will be deleted on newer pdf export template

    • Metadata is only used of compatibility of older exports


Scroll Title
anchorTable_dch
title-alignmentcenter
titleDocument change history.

Scroll Table Layout
orientationportrait
sortDirectionASC
repeatTableHeadersdefault
style
widths2*,*,3*,4*
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

DateDocument Revision

Authors

Description

Page info
infoTypeModified date
dateFormatyyyy-MM-dd
typeFlat

Page info
infoTypeCurrent version
dateFormatyyyy-MM-dd
prefixv.
count1
typeFlat

Page info
infoTypeModified by
type

...

Flat

  • update to Quartus Prime Lite 20.1
  • document style update
  • script update
2020-10-09v.12Thomas Dück
  • bugfixes
  • script update
2020-05-13v.10Thomas Dück
  • 19.1 release
2019-11-11v.8Thomas Dück
  • add bash files for Linux OS
2019-10-29v.6Thomas Dück
  • change design to TE scripts
  • new variants
2019-04-03v.4Thomas Dück
  • Initial release 18.1
--


all

Page info
infoTypeModified users
dateFormatyyyy-MM-dd
typeFlat

--


Legal Notices

Include Page
IN:Legal Notices
IN:Legal Notices


Scroll Only


HTML
<style>
.wiki-content .columnLayout .cell.aside {
width: 0%;
}</style>



Scroll pdf ignore


Custom_fix_page_content

Table of contents

Table of Contents
outlinetrue