Refer to http://trenz.org/te0741-info for the current online version of this manual and other available documentation.
This example shows how to reconfigure SI5338 with the MicroBlaze_MCS and monitor the CLKs. An additional MicroBlaze is added for the Hello_TE0741 standalone application.
- Vitis/Vivado 2021.2
- SI5338 initialisation with MCS
Release Notes and Know Issues
|Issues||Description||Workaround||To be fixed version|
|No known issues||---||---||---|
|Vitis||2021.2||needed, Vivado is included into Vitis installation|
|SI ClockBuilder Pro||---||optional|
Basic description of TE Board Part Files is available on TE Board Part Files.
Complete List is available on "<project folder>\board_files\*_board_files.csv"
Design supports following modules:
|Module Model||Board Part Short Name||PCB Revision Support||DDR||QSPI Flash||Others||Notes|
|TE0741-03-070-2IF||070_2if||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-160-2IF||160_2if||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-325-2IF||325_2if||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-410-2IF||410_2if||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-070-2CF||070_2cf||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-160-2CF||160_2cf||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-325-2CF*||325_2cf||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-410-2CF||410_2cf||REV02, REV03||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-160-2C1||160_2c1||REV02, REV03||---||32MB||MGT LR: 10,3125 Gb/s|
|TE0741-02-B3E-1-AF||160_3e1||REV02, REV03||---||32MB||MGT LR: 10,3125 Gb/s|
|TE0741-04-A2I-1-A||070_2if||REV04||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-04-G2C-1-A||410_2cf||REV04||---||32MB||MGT LR: 6,6 Gb/s|
|TE0741-03-S002||410_2cf||REV03||---||32MB||MGT LR: 6,6 Gb/s|
*used as reference
Design supports following carriers:
*used as reference
Additional HW Requirements:
|USB Cable for JTAG/UART||Check Carrier Board and Programmer for correct type|
|XMOD Programmer||Carrier Board dependent, only if carrier has no own FTDI|
*used as reference
For general structure and usage of the reference design, see Project Delivery - Xilinx devices
|Vivado Project will be generated by TE Scripts|
|Vitis||<project folder>\sw_lib||Additional Software Template for Vitis and apps_list.csv with settings automatically for Vitis app generation|
|SI5338||<project folder>\misc\Si5338||SI5338 Project with current PLL Configuration|
|BIT-File||*.bit||FPGA (PL Part) Configuration File|
|DebugProbes-File||*.ltx||Definition File for Vivado/Vivado Labtools Debugging Interface|
|Diverse Reports||---||Report files in different formats|
|Xilinx Support Archive||*.xsa||Exported Vivado Hardware Specification for Vitis and PetaLinux|
|LabTools Project-File||*.lpr||Vivado Labtools Project File|
Flash Configuration File with Boot-Image (MicroBlaze or FPGA part only)
File with BRAM-Location to generate MCS or BIT-File with *.elf content (MicroBlaze only)
|Software-Application-File||*.elf||Software Application for Zynq or MicroBlaze Processor Systems|
Reference Design is only usable with the specified Vivado/Vitis/PetaLinux version. Do never use different Versions of Xilinx Software for the same Project.
Reference Design is available on:
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 Xilinx Design Flow.
- Xilinx Development Tools#XilinxSoftware-BasicUserGuides
- Vivado Projects - TE Reference Design
- Project Delivery.
The 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/Vitis GUI. For currently Scripts limitations on Win and Linux OS see: Project Delivery Currently limitations of functionality
Caution! Win OS has a 260 character limit for path lengths which can affect the Vivado tools. To avoid this issue, use Virtual Drive or the shortest possible names and directory locations for the reference design (for example "x:\<project folder>")
Run _create_win_setup.cmd/_create_linux_setup.sh and follow instructions on shell:
- Press 0 and enter to start "Module Selection Guide"
- Create project and follow instructions of the product selection guide, settings file will be configured automatically during this process.
optional for manual changes: Select correct device and Xilinx install path on "design_basic_settings.cmd" and create Vivado project with "vivado_create_project_guimode.cmd"
Note: Select correct one, see also Vivado Board Part Flow
Create hardware description file (.xsa file) and export to prebuilt folder
Using Vivado GUI is the same, except file export to prebuilt folder.
- Generate Programming Files with Vitis
Run on Vivado TCL:
- Copy "\prebuilt\software\<short name>\hello_te0741.elf" into "\firmware\microblaze_0\"
- (optional) Copy "\prebuilt\software\<short name>\scu.elf" into "\firmware\microblaze_mcs_0\"
Regenerate Vivado Project or Update Bitfile only, with new "hello_te0741.elf" and "scu.elf"
TCL scripts generate also platform project, this must be done manually in case GUI is used. See Vitis
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.
Xilinx documentation for programming and debugging: Vivado/Vitis/SDSoC-Xilinx Software Programming and Debugging
Get prebuilt boot binaries
- Run _create_win_setup.cmd/_create_linux_setup.sh and follow instructions on shell
- Press 0 and enter to start "Module Selection Guide"
- Select assembly version
- Validate selection
Select create and open delivery binary folder
Note: Folder "<project folder>\_binaries_<Article Name>" with subfolder "boot_<app name>" for different applications will be generated
- Connect JTAG and power on carrier with module
Open Vivado Project with "vivado_open_existing_project_guimode.cmd" or if not created, create with "vivado_create_project_guimode.cmd"
To program with Vitis/Vivado GUI, use special FSBL (fsbl_flash) on setup
Not used on this Example.
- Connect JTAG and power on PCB
- Open Vivado HW Manager
- Program FPGA with Bitfile from "prebuilt\hardware\<short dir>\"
- Prepare HW like described on section Programming
- Connect UART USB (most cases same as JTAG)
Select QSPI as Boot Mode
Note: See TRM of the Carrier, which is used.
Power On PCBboot process
1. FPGA Loads Bitfile from Flash
2. MCS Firmware configure SI5338 and starts Microblaze
3. Hello TE0741 from Bitfile Example will be run on UART console.
info: Do not reboot, if Bitfile programming over JTAG is used as programming method.
Open Serial Console (e.g. putty)
- Speed: 9600
- COM Port: Win OS, see device manager, Linux OS see dmesg |grep tty (UART is *USB1)
Vivado HW Manager
Open Vivado HW-Manager and add VIO signal to dashboard (*.ltx located on prebuilt folder)
- LED_D1/D2 control
- SI5338 25MHz REF CLK Enable
- MGT Enable
- LED_D1/D2 control
- Set radix from VIO signals (MGT...) to unsigned integer.
- Note: Frequency Counter is inaccurate and displayed unit is Hz
- MGT REFCLK1~125MHz, GT_REFCLK3~156,25MHz (default off, configured with MCS Firmware)
- MGT Power Monitoring
System Design - Vivado
Basic module constraints
Design specific constraints
Software Design - Vitis
For Vitis project creation, follow instructions from:
Template location: "<project folder>\sw_lib\sw_apps\"
MCS Firmware to configure SI5338 and Reset System.
Template location: \sw_lib\sw_apps\scu
Xilinx Hello World example as endless loop
Template location: \sw_lib\sw_apps\hello_te0741
File location "<project folder>\misc\Si5338\Si5338-*.slabtimeproj"
General documentation how you work with this project will be available on Si5338
App. A: Change History and Legal Notices
Document Change History
To get content of older revision go to "Change History" of this page and select older document revision number.
Please also note our data protection declaration at https://www.trenz-electronic.de/en/Data-protection-Privacy
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.
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.
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.
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
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).
Trenz Electronic GmbH herewith declares that all its products are developed, manufactured and distributed RoHS compliant.
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
- No labels