From 065ce3fa9cdc6fae957051cd460607beddae068e Mon Sep 17 00:00:00 2001 From: "NI\\bvanca" Date: Tue, 29 Jun 2021 13:29:19 +0300 Subject: [PATCH] Update Readme with description about the actual demo --- README.md | 46 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 061d896..f81d913 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,44 @@ -# Genesys-ZU Root Repository +# Genesys ZU Root Repository -This repository contains all demos for the Genesys-ZU. +## Genesys ZU-5EV HDMI Demo -For more information about the Genesys-ZU, visit its [Resource Center](https://reference.digilentinc.com/programmable-logic/genesys-zu/start) on the Digilent Wiki. +### Description -Each demo contained in this repository is documented on the Digilent Wiki, links in the table below. +This branch contains sources for the Genesys ZU-5EV HDMI Demo. -| Wiki Link | Demo Master Branch | Submodules Used | -|-----------|--------------------|-----------------| -| [Genesys ZU-5EV HDMI Demo](https://reference.digilentinc.com/learn/programmable-logic/tutorials/genesys-zu-5ev-demo-hdmi/start) | 5ev/demo/hdmi/master | HW, SW | +This project demonstrates usage of the Genesys ZU-5EV's HDMI in and HDMI out ports. Vivado is used to build the demo's hardware platform, and Vitis is used to program the bitstream onto the board and to build and deploy a C application. +To use this demo, the Genesys ZU-5EV must be connected to a computer over MicroUSB, which must be running a serial terminal. -## Repository Description +A menu is displayed over UART at 115200 baud rate. When only the HDMI TX port is connected, the project enters in standalone mode, generating a color bar on the display. +When both HDMI ports are connected, and there is a valid HDMI source, the project will automatically enter in pass-through mode and the Si5342A-D-GM will generate a jitter-attenuated reference clock to drive the HDMI Transmitter Subsystem with a phase-aligned version of the HDMI RX Subsystem HDMI RX TMDS Clock. Thus, the image from the HDMI source will be outputted on the display. -This repository is designed to offer a unified and comprehensive approach to all of the aspects of the demos that we provide for the Genesys-ZU, across multiple tools. By cloning this repo recursively you will receive the repositories for Vivado projects (HW), and Vitis workspaces (SW). Each submodule may have its own submodule dependencies which will also be pulled when cloning. An important aspect of this structure is the fact that the SW heavily depends on hardware hand-off files from the HW repository. +For more information on the Genesys ZU-5EV HDMI Demo, including setup instructions, visit its [Demo Page](https://reference.digilentinc.com/learn/programmable-logic/tutorials/genesys-zu-5ev-demo-hdmi/start) on the Digilent Wiki. -This repository also provides releases containing project and image files used by the various tools involved. Releases provide files that are directly usable, without requiring the use git or any scripting systems. Documentation of each demo, as well as instructions for using their releases, can be found by visiting the corresponding pages on the Digilent Wiki, links below. All releases in this repository can be found in this repository's [releases page](https://github.com/Digilent/Genesys-ZU/releases), however, use of the wiki pages to find specific well-tested releases is advised. +For more information on the Genesys ZU, including other demos that may be available, see its [Resource Center](https://reference.digilentinc.com/reference/programmable-logic/genesys-zu/start) on the Digilent Wiki. -For instructions on how to use this repository with git, and for additional documentation on the submodule and branch structures used, please visit [Digilent FPGA Demo Git Repositories](https://reference.digilentinc.com/reference/programmable-logic/documents/git) on the Digilent Wiki. Note that use of git is not required to use this demo. \ No newline at end of file +### Git Navigation Information + +For instructions on how to use this repository with git, and for additional documentation on the submodule and branch structures used, please visit [Digilent FPGA Demo Git Repositories](https://reference.digilentinc.com/reference/programmable-logic/documents/git) on the Digilent Wiki. Note that use of git is not required to use this demo. Digilent recommends the use of project releases, for which instructions can be found in each demo wiki page, linked above. + +To see other demos in this repository, see the master branch's [README](https://github.com/Digilent/Genesys-ZU). + +Some demos do not require some submodules, in these cases, they are still provided to ease switching between demos in git. When unused, the submodule folder is largely empty, except for a readme containing only the heading "Root commit". This demo contains the following submodules: + +| Submodule | Used by this demo | +|-----------|-------------------| +| HW | Yes | +| OS | No | +| SW | Yes | + +### Requirements + +The following are required for use of this demo. For more information on how to get any hardware or software you may be missing, see the Demo Page, linked above. + + +* Genesys ZU-5EV FPGA board +* 1 Micro-USB cables +* Genesys ZU-5EV Power Supply +* 1 or 2 HDMI-HDMI or HDMI-DVI Cables +* 1 HDMI Display +* 1 HDMI Source (Used only in pass-through mode)