Table of contents
Overview
Key Features
Revision History
| Date | Vivado | Project Built | Authors | Description |
|---|---|---|---|---|
| 2017-09-11 | 2017.1 | te0803-SK0803_zusys_SDSoC-vivado_2017.1-build_05_20170911131522 | John Hartfiel | initial release |
Release Notes and Know Issues
| Issues | Description | Workaround | To be fixed version |
|---|---|---|---|
| No known issues | --- | --- | --- |
Requirements
Software
| Software | Version | Note |
|---|---|---|
| Vivado | 2017.1 | needed |
| SDK | 2017.1 | needed |
| PetaLinux | 2017.1 | needed |
| SDx | 2017.1 | needed |
| SI5345 Clock Builder | --- | optional |
Hardware
| Module Model | Model Board Part ID | Notes |
|---|---|---|
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
| Carrier Model | Notes |
|---|---|
| --- |
| Additional Hardware | Notes |
|---|---|
Content
For general structure and of the reference design, see Project Delivery
Design Sources
| Type | Location | Notes |
|---|---|---|
| Vivado | <design name>/block_design <design name>/constraints <design name>/ip_lib | Vivado Project will be generated by TE Scripts |
| SDK/HSI | <design name>/sw_lib | Additional Software Template for SDK/HSI and apps_list.csv with settings for HSI |
| PetaLinux | <design name>/os/petalinux | PetaLinux template with current configuration |
| SDSoC | <design name>/../SDSoC_PFM | SDSoC Platform will be generated by TE Scripts or as separate download |
Additional Sources
| Type | Location | Notes |
|---|---|---|
| SI5345 | <design name>/misc/Si5338 | SI5345 Project with current PLL Configuration |
| init.sh | <design name>/misc/init_script | Additional Initialization Script for Linux |
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.
Reference Design is available on:
Design Flow
Trenz Electronic provides a tcl based built environment based on Xilinx Design Flow. See: Vivado/SDK/SDSoC#XilinxSoftware-BasicUserGuides and Project Delivery
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
Important Vivado and SDSoC Project need a very short path on Win OS. Project delivery provides a "_use_virtual_drive.cmd" to generate a virtual drive.
- _create_win_setup.cmd/_create_linux_setup.sh and follow instructions on shell:
- Reference Design (only tested on Win OS, but Linux should also works)
- Generate Virtual Drive or use short directory (for example x:\<design name>)
- Create Project
- Select correct device on "design_basic_settings.cmd" and create Vivado project with "vivado_create_project_guimode.cmd"
- Create HDF and export to prebuilt folder
- TE::hw_build_design -export_prebuilt
- Create Linux with HDF
- HDF is exported to "prebuilt\hardware\<short name>"
- Create Linux images on VM, see PetaLinux KICKstart
- Use TE Template from /o
- Add Linux files to prebuilt folder
- Generate Programming Files with HSI/SDK
SDSoC (only tested on Win OS)
- Generate Platform Project or use prebuilt from download
Programming
Check Module and Carrier TRMs for proper HW configuration before you try any design.
QSPI
Not used on this Example.
SD
Not used on this Example.
JTAG
Not used on this Example.
System Design - Vivado
Description currently not available.
Design
Constrains
Software Design - SDK/HSI
Description currently not available.
Application
FSBL
Software Design - PetaLinux
Description currently not available.
Config
U-Boot
Device Tree
Kernel
Rootfs
SDSoC Design
Description currently not available.
SDSoC Platform
SDSoC Demo Examples
SDSoC platform includes 21 demo projects demonstrating optimization techniques for Standalone and Linux targets with HW acceleration or in SW for fast compilation and debug. These projects have been downloaded and installed into the SDSoC platform from https://github.com/Xilinx/SDSoC_Examples
- array_partition
- burst_rw
- custom_data_type
- data_access_random
- dependence_inter
- direct_connect
- dma_sg
- dma_simple
- full_array_2d
- hello_vadd
- lmem_2rw
- loop_fusion
- loop_perfect
- loop_pipeline
- loop_reorder
- row_array_2d
- shift_register
- systolic_array
- sys_port
- wide_memory_rw
- window_array_2d
There are 3 larger Linux demo projects demonstrating video processing with data I/O from file to file. Source code of these projects have been installed into this platform from the Xilinx SDSoC 2016.4 release:
- file_io_manr_sobel
- file_io_optical
- file_io_sbm
These larger Linux demo projects demonstrate video processing with data I/O from file to file. Source code of these projects have been installed into this platform from demos present in the Xilinx SDSoC 2016.4 release.
Compilation steps in the SDSoC 2017.1 is identical to above described examples. File I/O demos support only the Linux target.
These three files use as an input larger video files. These files have to be present on the SD card as an input. Algorithms write output file to the SD card. These files can be visualized by YUV Player Deluxe and other players. To reduce size of the project, the video data files are not included.
Video input files can be found in the Xilinx SDSoC 2016.4 distribution:
- <xilinx install path>\SDx\2016.4\samples\file_io_manr_sobel\input.yuv
- <xilinx install path>\SDx\2016.4\samples\file_io_optical\route85_1920x1080.yuv
- <xilinx install path>\SDx\2016.4\samples\file_io_sbm\desk_1280x720.yuv
Array partition
This example shows how to use array partitioning to improve performance of a hardware function.
Key Concepts:
- Hardware Function Optimization
- Array Partitioning
Keywords:
- #pragma HLS ARRAY_PARTITION
- complete
Burst rw
This is a simple vector increment example which demonstrates usage of AXI4-master interface for burst read and write.
Key Concepts:
- Burst Access
Custom data type
This is a simple example of RGB to HSV conversion to demonstrate Custom Data Type usage in hardware accelerator. Xilinx HLS compiler supports custom data type to operate within the hardware function and also it acts as a memory interface between PL to DDR.
Key Concepts:
- Custom Data Type
Keywords:
- struct
- packed
- aligned
Data access random
This is a simple example of matrix multiplication (Row x Col) to demonstrate random data access pattern.
Key Concepts:
- Data Access Random
Keywords:
- #pragma HLS PIPELINE
- #pragma SDS access_pattern(a:RANDOM, b:RANDOM)
- #pragma SDS data copy
Dependence inter
This is a simple example to demonstrate inter dependence attribute using vertical convolution example. Using inter dependence attribute user can provide additional dependency details to compiler which allow compiler to perform unrolling/pipelining to get better performance.
Key Concepts:
- Inter Dependence
Keywords:
- DEPENDENCE
- inter
Direct connect
This is a simple example of matrix multiplication with matrix addition (Out = (A x B) + C) to demonstrate direct connection which helps to achieve increasing in system parallelism and concurrency.
Key Concepts:
- Direct Connection
- Multiple Accelerators
Keywords:
- #pragma SDS data access_pattern(in1:SEQUENTIAL, in2:SEQUENTIAL, out:SEQUENTIAL)
Dma sg
This example demonstrates how to use Scatter-Gather DMAs for data transfer to/from hardware accelerator.
Key Concepts:
- Scatter Gather DMA
Keywords:
- #pragma SDS access_parttern(a:SEQUENTIAL)
- #pragma SDS data_mover(a:AXIDMA_SG)
- #pragma SDS data copy
Dma simple
This example demonstrates how to insert Simple DMAs for data transfer between User program and hardware accelerator.
Key Concepts:
- Simple DMA
Keywords:
- #pragma SDS access_parttern(a:SEQUENTIAL)
- #pragma SDS data_mover(a:AXIDMA_SIMPLE)
- #pragma SDS data copy
Full array 2d
This is a simple example of accessing full data from 2D array.
Key Concepts:
- 2D data array access
Hello vadd
----------
This is a basic hello world kind of example which demonstrates how to achieve vector addition using hardware function.
Key Concepts:
- - Loop Pipelining
Keywords:
- - #pragma HLS PIPELINE
Lmem 2rw
This is a simple example of vector addition to demonstrate how to utilize both ports of Local Memory.
Key Concepts:
- Hardware Function Optimization
- 2port BRAM Utilization
- Two read/write Local Memory
Keywords:
- #pragma HLS UNROLL FACTOR=2
Loop fusion
This example will demonstrate how to fuse two loops into one to improve the performance of a C/C++ hardware function.
Key Concepts:
- Hardware Function Optimization
- Loop Fusion
- Loop Pipelining
Keywords:
- #pragma HLS PIPELINE
Loop perfect
This nearest neighbor example is to demonstrate how to achieve better performance using perfect loop.
Key Concepts:
- Loop perfect
Keywords:
- #pragma HLS PIPELINE
- #pragma HLS ARRAY_PARTITION
Loop pipeline
This example demonstrates how loop pipelining can be used to improve the performance of a hardware function.
Key Concepts:
- Loop Pipelining
Keywords:
- #pragma HLS PIPELINE
Loop reorder
This is a simple example of matrix multiplication (Row x Col) to demonstrate how to achieve better pipeline II factor by loop reordering.
Key Concepts:
- Hardware Function Optimization
- Loop Reorder to Improve II
Keywords:
- #pragma HLS PIPELINE
- #pragma HLS ARRAY_PARTITION
Row array 2d
This is a simple example of accessing each row of data from 2D array.
Key Concepts:
- Row of 2D data array access
Keywords:
- hls::stream
Shift register
This example demonstrates how to shift values in each clock cycle.
Key Concepts:
- Hardware Function Optimization
- Shift Register
- FIR
Keywords:
- #pragma HLS ARRAY_PARTITION
Systolic array
This is a simple example of matrix multiplication (Row x Col) to help developers learn systolic array based algorithm design. Note : Systolic array based algorithm design is well suited for FPGA.
Key Concepts:
- Systolic Array
Keywords:
- #pragma HLS PIPELINE
- #pragma HLS ARRAY_PARTITION
Sys port
This is a simple example which demonstrates sys_port usage.
Key Concepts:
- sys_port
- memory interface
- memory non-caching
Keywords:
- #pragma SDS data sys_port
- #pragms HLS PIPELINE
- sds_alloc_non_cacheable
Wide memory rw
This is a simple example of vector addition to demonstrate Wide Memory Access using structure data type of 128bit wide. Based on input argument type, sds++ compiler will figure out the memory interface datawidth of hardware accelerator.
Key Concepts:
- wide memory access
- burst read and write
- custom datatype
Keywords:
- struct
Window array 2d
This is a simple example of accessing window of data from 2D array.
Key Concepts:
- Window of 2D data array access
Keywords:
- #pragma HLS DATAFLOW
- #pragma HLS PIPELINE
- #pragma HLS stream
File IO Video Processing
Linux video processing application that reads input video from a file and writes out the output video to a file. Video processing includes Motion Adaptive Noise Reduction (MANR) followed by a Sobel filter for edge detection. You can run it by supplying a 1080p YUV422 file as input with limiting number of frames to a maximum of 20 frames.
Key Concepts:
- Video processing from file to file
- Direct connection of HW accelerated blocks
Select the "File IO Video Processing" template an compile for Linux target as project te22. Copy result to root of SD card. Copy also the input file input.yuv (82 944 000 bytes) to the root of the SD card. Login and cd to /media Run demo from terminal or from display+keyboard by comman ./te22.elf ./input.yuv 20 3 ./output.yuv
The output.yuv file contains 20 frames of 1080p vido in YUV422 format with computed edges. Copy output.yuv file to PC and visualise it in yuvplayer (size 1920x1080 colour YUV422).
File IO Dense Optical Flow
Linux video processing application that reads input video from a file and writes out the output video to a file. Video processing performs LK Dense Optical Flow over two Full HD frames video file. You can run it by supplying a 1080p YUV422 file route85_1920x1080.yuv as input.
Key Concept:s
- Video processing from file to file
- Direct connection of HW accelerated blocks
- Top down methodology with detailed description in Xilinx UG1235 (v2017.1) June 20. 2017.
Select the "File IO Dense Optical Flow" template an compile for Linux target as project te23. Copy result to root of SD card. Copy also the input file route85_1920x1080.yuv (8 294 400 bytes) to the root of the SD card. Login and cd to /media Run demo from terminal or from display+keyboard by command ./te23.elf
The OptFlow_1920x1080.yuv file is generated and stored on the SD card. It contains one 1080p frame in YUV422 format with computed dense optical flow vectors. Copy OptFlow_1920x1080.yuv file to PC and visualise it in yuvplayer (size 1920x1080 colour YUV422).
File IO Stereo Block Matching
Linux video processing application that reads input video from a file and writes out the output video to a file. Video processing performs Stereo Block Matching to calculate depth in a single sample stereo video file desk_1280x720.yuv in YUV422 format as input and single frame Disparity_640x720.yuv in YUV422 format as output, indicating the depth of objects.
Key Concepts:
- Video processing from file to file
- Bottom Up methodology with detailed description in Xilinx UG1235 (v2017.1) June 20. 2017.
Select the "File IO Stereo Block Matching" template an compile for Linux target as project te24. Copy result to root of SD card. Copy also the input file desk_1280x720.yuv (1 843 200 bytes) to the root of the SD card. Login and cd to /media Run demo from terminal or from display+keyboard by command ./te24.elf
The Disparity_640x720.yuv file is generated and stored on the SD card. It contains one 640x720 frame in YUV422 format indicating the depth of objects. Copy Disparity_640x720.yuv file to PC and visualise it in yuvplayer (size 640x720 colour YUV422) The input file desk_1280x720.yuv can be visualised by yuvplayer (size 1280x720 colour YUV422). It contains side by side two colour frames from a stereo camera.
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.
| Date | Document Revision | Authors | Description |
|---|---|---|---|
| Work in progress | ||
| 2017-09-11 | v.1 | Initial release | |
| All |
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.
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.
Overview
Content Tools