Overview


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

Key Features

  • Quartus Prime Pro 23.4
  • Nios V (SG Variant only)
    • UART
    • DDR4
  • Yocto (SX Variant only)
    • UART
    • ETH
    • USB
    • SD
    • I2C
    • DDR4

Revision History

DateQuartusProject BuiltAuthorsDescription
2025-04-2523.4 Pro

TEI1000-rd-test_board-quartus_23.4.0-20250425161615.zip

TEI1000-rd-test_board_noprebuilt-quartus_23.4.0-20250425161615.zip

Thomas Dück
  • initial release
Design Revision History

Release Notes and Know Issues

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

Requirements

Software

SoftwareVersionNote
Quartus Prime Pro23.4Nios V license is needed. For more information see: Intel Nios V Processors
Ashling RiscFree IDE for Intel FPGAs23.4needed
Yoctoscarthgapoptional
Software

Hardware

Complete List is available on <project folder>/board_files/*_board_files.csv

Design supports following modules:

Module ModelBoard Part Short NamePCB Revision SupportDDRQSPI FlashOthersNotes
TEI1000-02-A3I11-A*A3I11REV021GB64MB----
TEI1000-02-ADI11-AADI11REV021GB64MB----

*used as reference

Hardware Modules

Design supports following carriers:

Carrier ModelNotes
TEB1000-02*Used as reference carrier

*used as reference

Hardware Carrier

Additional HW Requirements:

Additional HardwareNotes
USB cable for JTAG/UARTCheck Carrier Board and Programmer for correct type
TEI0004 JTAG Programmer
USB StickOptional HW
USB was tested with USB memory stick
ETH cableOptional HW
Ethernet works with DHCP, but can be setup also manually
SD cardwith fat32 partition

*used as reference

Additional Hardware

Content

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

Design Sources

TypeLocationNotes
Quartus

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

Quartus project will be generated by TE Scripts

Software

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

Additional software will be generated by TE Scripts

Yocto<project folder>/source_files/<Board Part Short Name>/os/yocto/Yocto BSP layer template for linux
Design sources

Prebuilt

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
JTAG indirect configuration file*.jicFlash configuration file
Diverse Reports---Report files in different formats
Device Tree*.dtsDevice tree (2 possible, one for u-boot and one for linux)
SFP-File*.sfpBoot image with SPL (Secondary Program Loader)
Software-Application-File*.elfSoftware application for Nios II/Nios V processor system
Prebuilt files (only in ZIP file with prebuilt content)

Download

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

Reference Design is available on:

Design Flow


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 OS and Linux OS see: Project Delivery - Intel devices → Currently limitations of functionality

  1. Open create_project_win.cmd/create_project_linux.sh:
  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 "<project folder>/settings/design_basic_settings.tcl"
  4. (SX Variant only) Create and configure your Yocto Linux project in LinuxOS
    1. Copy the meta-trenz_altera folder from <project name>/os/yocto/meta-trenz_altera to the path/to/your/yocto/directory
    2. Run following command in the command shell and follow the instructions:
      . ./meta-trenz_altera/tei1000_yocto_setup
  5. (SX Variant only) Open Nios V command shell and run following command to generate the jic file with this files included:

    • test_board.sof file (generated in quartus project)

    • u-boot-dtb.hex file (generated with Yocto):

      quartus_pfg -c path/to/reference_design/quartus/output_files/test_board.sof path/to/reference_design/quartus/output_files/u-boot-spl-dtb.jic \
         -o device=MT25QU512 \
         -o flash_loader=1SX040HH3 \
         -o hps_path=path/to/yocto/u-boot-spl-dtb.hex \
         -o mode=ASX4

Launch


Programming

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

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

Get prebuilt boot binaries

  1. Run create_project_win.cmd/create_project_linux.sh
  2. Select Module in 'Board selection'
  3. Click on 'Export prebuilt files' button
    1. Folder <project folder>/_binaries_<Article Name> with subfolder boot_linux will be generated and opened

SD-Boot mode (SX variant only)

  1. Copy  u-boot.itb, Image, tei1000_*.dtb and the extlinux folder on SD
  2. Insert SD-Card in the SD-Slot
  3. Program configuration flash with the jic file
    1. Set DIP-Switch S5.1-4 to OFF on TEB1000
    2. Connect JTAG and power on carrier with module
    3. Open create_project_win.cmd/create_project_linux.sh
    4. Select correct board in "Board selection"
    5. 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
    6. Click on "Start program device" button

QSPI (SG variant only)

  1. Set DIP-Switch S5.1-4 to OFF on TEB1000
  2. Connect JTAG and power on carrier with module
  3. Open create_project_win.cmd/create_project_linux.sh
  4. Select correct board in "Board selection"
  5. 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
  6. Click on "Start program device" button

JTAG

Not used on this example.

Usage

  1. Prepare HW like described on section Programming
  2. Set DIP-Switch S5.1=ON on TEB1000
  3. Connect UART USB (most cases same as JTAG)
  4. Connect your board to the network
  5. Power on PCB
  6. Open Serial Console (e.g. PuTTY)
    • Speed: 115200
    • select COM Port

      Win OS: see device manager | Linux OS: see ls -l dev/serial/by-id  (UART is *USB1)

Linux (SX variant only)

  1. Linux Console:

    Note: Wait until Linux boot finished

  2. You can use Linux shell now.

    i2cdetect -y -r 1   (check I2C 1 Bus)
    udhcpc              (ETH check)
    lsusb               (USB check)
  3. Optional Features

    • init.sh scripts
      • add init.sh script on SD, content will be load automatically on startup (template included in "<project folder>\misc\sd")

Baremetal (SG variant only)


  1. Console output:
    1. 'Hello TEI1000' in endless loop

System Design - Quartus


Block Design

The block designs may differ depending on the assembly variant.

Block Design SX Variant - Platform Desginer


Block Design SG Variant - Platform Desginer

HPS Interfaces (SX variant only)

Activated interfaces:

TypeNote
DDR--
EMAC1--
GPIO0--
I2C1--
SDMMC--
UART0--
USB1--


Software Design - SDK


Application

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

hello_tei1000

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

Software Design - Yocto


U-Boot

File location: meta-trenz_altera/recipes-bsp/u-boot/

Changes:

  • enable boot from sd

    • CONFIG_SD_BOOT=y

    • CONFIG_BOOTDELAY=3

    • CONFIG_BOOTCOMMAND="setenv fdt_addr_r 0x10000000; run distro_bootcmd"

  • set env to nowhere

    • CONFIG_ENV_IS_NOWHERE=y

    • # CONFIG_ENV_IS_IN_FAT is not set

  • MAC from eeprom

    • CONFIG_I2C_EEPROM=y

    • CONFIG_SYS_I2C_EEPROM_ADDR=0x50

    • CONFIG_SYS_I2C_EEPROM_BUS=1

    • CONFIG_SYS_EEPROM_SIZE=256

    • CONFIG_SYS_EEPROM_PAGE_WRITE_BITS=0

    • CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS=0

    • CONFIG_SYS_I2C_EEPROM_ADDR_LEN=1

    • CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW=0

  • enable spl output

    • CONFIG_SPL_DISPLAY_PRINT=y

  • enable misc_init_r function

    • CONFIG_MISC_INIT_R=y

  • configure eth

    • CONFIG_PHY_MARVELL=y

    • # CONFIG_DM_ETH_PHY is not set

  • Disable NAND/UBI/QSPI related settings from defconfig

    • CONFIG_NAND_BOOT=n

    • CONFIG_SPL_NAND_SUPPORT=n

    • CONFIG_CMD_NAND_TRIMFFS=n

    • CONFIG_CMD_NAND_LOCK_UNLOCK=n

    • CONFIG_NAND_DENALI_DT=n

    • CONFIG_SYS_NAND_U_BOOT_LOCATIONS=n

    • CONFIG_UBIFS_SILENCE_MSG=n

    • CONFIG_QSPI_BOOT=n

    • CONFIG_SPL_NAND_FRAMEWORK=n

    • CONFIG_MTD_RAW_NAND=n

    • CONFIG_CMD_UBI=n

    • CONFIG_CMD_UBIFS=n

    • CONFIG_MTD_UBI=n

    • CONFIG_ENV_IS_IN_UBI=n

Device Tree

U-boot Device Tree

Excerpts from meta-trenz_altera/recipes-bsp/u-boot/files/dts/tei1000_<Board_Part_Short_Name>.dts
#u-boot device_tree.dts
/ {
  aliases {
    serial0 = &uart0;
    ethernet1 = &gmac1;
    i2c1 = &i2c1;
  };
};

&gmac1 {
  status = "okay";
  phy-mode = "rgmii";
  phy-handle = <&emac1_phy0>;

  mdio {
    #address-cells = <1>;
    #size-cells = <0>;
    compatible = "snps,dwmac-mdio";

    emac1_phy0: ethernet-phy@1 {
      reg = <1>;
    };
  };

};

&gpio0 {
  status = "okay";
};

&i2c1 {
  status = "okay";

  eeprom_mac: eeprom@50 {
    #address-cells = <1>;
    #size-cells = <1>;
    reg = <0x50>;
    compatible = "microchip,24aa025","atmel,24c02";
  };
};

&mmc {
  status = "okay";
  bus-width = <4>;
  cap-sd-highspeed;
  cap-mmc-highspeed;
};

&uart0 {
  status = "okay";
  clock-frequency = <75000000>;
};

&usb1 {
  status = "okay";
};

&watchdog0 {
  status = "okay";
};

Excerpts from meta-trenz_altera/recipes-bsp/u-boot/files/dts/tei1000_<Board_Part_Short_Name>-u-boot.dts
#device_tree-u-boot.dts
/ {
  chosen {
    stdout-path = "serial0:115200n8";
    u-boot,spl-boot-order = &mmc;
  };
};

&clkmgr {
  bootph-all;
};

&sysmgr {
  bootph-all;
};

&fdt_0_blob {
  filename = "arch/arm/dts/tei1000_a3i11.dtb";
};

&binman {
  /delete-node/ kernel;
};

Kernel Device Tree

Excerpts from test_board/os/yocto/meta-trenz_altera/recipes-kernel/linux/files/dts/tei1000_<Board_Part_Short_Name>.dts
#kernel device_tree.dts
/ {
  aliases {
    serial0 = &uart0;
    ethernet1 = &gmac1;
    i2c1 = &i2c1;
  };

  chosen {
    stdout-path = "serial0:115200n8";
  };

  memory@40000000 {
    device_type = "memory";
    reg = <0 0x00000000 0 0x40000000>;
  };

  soc {
    eccmgr {
      sdmmca-ecc@ff8c8c00 {
        compatible = "altr,socfpga-s10-sdmmc-ecc", "altr,socfpga-sdmmc-ecc";
        reg = <0xff8c8c00 0x100>;
        altr,ecc-parent = <&mmc>;
        interrupts = <14 4>, <15 4>;
      };
    };

    mmcclk_ciu: mmcclk-ciu {
      #clock-cells = <0>;
      compatible = "fixed-clock";
      clock-frequency = <200000000>;
    };
  };
};

&gmac1 {
  status = "okay";
  phy-mode = "rgmii-id";
  phy-handle = <&emac1_phy0>;

  mdio {
    #address-cells = <1>;
    #size-cells = <0>;
    compatible = "snps,dwmac-mdio";

    emac1_phy0: ethernet-phy@1 {
      reg = <1>;
    };
  };
};

&gpio0 {
  status = "okay";
};

&i2c1 {
  status = "okay";

  eeprom: eeprom@50 {
    compatible = "microchip,24aa025","atmel,24c02";
    reg = <0x50>;
    eth1_addr: eth-mac-addr@fa {
      reg = <0xfa 0x06>;
    };
  };
};

&mmc {
  status = "okay";
  cd-gpios = <&porta 6 GPIO_ACTIVE_LOW>;
  bus-width = <4>;
  cap-sd-highspeed;
  cap-mmc-highspeed;
  
  clocks = <&clkmgr STRATIX10_L4_MP_CLK>, <&mmcclk_ciu>;
};

&osc1 {
  clock-frequency = <25000000>;
};

&uart0 {
  status = "okay";
};

&usb1 {
  status = "okay";
};

Kernel

File location: meta-trenz_altera/recipes-kernel/linux/

Changes:

  • eth phy
    • CONFIG_MARVELL_PHY=y
    • CONFIG_OF_MDIO=y
  • eeprom
    • CONFIG_EEPROM_AT24=y

Images

Image recipe for minimal console image

File location: meta-trenz_altera/recipes-core/images/

Image recipes:

  • te-image-minimal.bb: create minimal linux image
  • te-image-initramfs.bb: required for building an image with initial RAM Filesystem

Added packages/recipes:

  • startup
  • ethtool
  • i2c-tools
  • usbutils
  • mtd-utils
  • util-linux
  • bash
  • libgpiod-tools

Rootfs

Used filesystem: Initial RAM Filesystem (initramfs)

Appx. A: Change History and Legal Notices


Document Change History

DateDocument Revision

Authors

Description

  • initial release
--all--
Document change history

Legal Notices

Data Privacy

Please also note our data protection declaration at https://www.trenz-electronic.de/en/Data-protection-Privacy

Document Warranty

The material contained in this document is provided “as is” and is subject to being changed at any time without notice. Trenz Electronic does not warrant the accuracy and completeness of the materials in this document. Further, to the maximum extent permitted by applicable law, Trenz Electronic disclaims all warranties, either express or implied, with regard to this document and any information contained herein, including but not limited to the implied warranties of merchantability, fitness for a particular purpose or non infringement of intellectual property. Trenz Electronic shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein.

Limitation of Liability

In no event will Trenz Electronic, its suppliers, or other third parties mentioned in this document be liable for any damages whatsoever (including, without limitation, those resulting from lost profits, lost data or business interruption) arising out of the use, inability to use, or the results of use of this document, any documents linked to this document, or the materials or information contained at any or all such documents. If your use of the materials or information from this document results in the need for servicing, repair or correction of equipment or data, you assume all costs thereof.

Product Disclaimer

Products (incl. Software and Firmware) are exclusively designed, manufactured, and distributed for industrial applications. They are not intended, authorized, or certified for use in critical safety applications, medical devices, aerospace, nuclear, life-support, traffic-control, military, or other environments where malfunction or failure could result in personal injury, death, or significant property or environmental damage.

Trenz Electronic GmbH (“Manufacturer”) excludes any liability for inappropriate use in such contexts. The Customer bears all responsibility for verifying suitability and compliance with applicable regulations when deploying in any critical-use scenario. The Customer also agrees to indemnify and hold harmless the Manufacturer from any third-party claims or liabilities arising from such use.

Copyright Notice

No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Trenz Electronic.

Technology Licenses

The hardware / firmware / software described in this document are furnished under a license and may be used /modified / copied only in accordance with the terms of such license.

Environmental Protection

To confront directly with the responsibility toward the environment, the global community and eventually also oneself. Such a resolution should be integral part not only of everybody's life. Also enterprises shall be conscious of their social responsibility and contribute to the preservation of our common living space. That is why Trenz Electronic invests in the protection of our Environment.

REACH, RoHS and WEEE

REACH

Trenz Electronic is a manufacturer and a distributor of electronic products. It is therefore a so called downstream user in the sense of REACH. The products we supply to you are solely non-chemical products (goods). Moreover and under normal and reasonably foreseeable circumstances of application, the goods supplied to you shall not release any substance. For that, Trenz Electronic is obliged to neither register nor to provide safety data sheet. According to present knowledge and to best of our knowledge, no SVHC (Substances of Very High Concern) on the Candidate List are contained in our products. Furthermore, we will immediately and unsolicited inform our customers in compliance with REACH - Article 33 if any substance present in our goods (above a concentration of 0,1 % weight by weight) will be classified as SVHC by the European Chemicals Agency (ECHA).

RoHS

Trenz Electronic GmbH herewith declares that all its products are developed, manufactured and distributed RoHS compliant.

WEEE

Information for users within the European Union in accordance with Directive 2002/96/EC of the European Parliament and of the Council of 27 January 2003 on waste electrical and electronic equipment (WEEE).

Users of electrical and electronic equipment in private households are required not to dispose of waste electrical and electronic equipment as unsorted municipal waste and to collect such waste electrical and electronic equipment separately. By the 13 August 2005, Member States shall have ensured that systems are set up allowing final holders and distributors to return waste electrical and electronic equipment at least free of charge. Member States shall ensure the availability and accessibility of the necessary collection facilities. Separate collection is the precondition to ensure specific treatment and recycling of waste electrical and electronic equipment and is necessary to achieve the chosen level of protection of human health and the environment in the European Union. Consumers have to actively contribute to the success of such collection and the return of waste electrical and electronic equipment. Presence of hazardous substances in electrical and electronic equipment results in potential effects on the environment and human health. The symbol consisting of the crossed-out wheeled bin indicates separate collection for waste electrical and electronic equipment.

Trenz Electronic is registered under WEEE-Reg.-Nr. DE97922676.




Table of contents