Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
programmable-logic:arty-z7:demos:hdmi-output [2022/08/18 08:46] – [Table] Andrei Soptereanprogrammable-logic:arty-z7:demos:hdmi-output [2023/08/24 22:48] (current) – Arthur Brown
Line 1: Line 1:
 +~~META: robots = noindex, nofollow ~~
 +====== Arty Z7 HDMI Output Demo ======
  
 +{{learn/programmable-logic/tutorials/arty-z7-hdmi-demo/hdmiout.png?800}}
 +
 +----
 +===== Description =====
 +
 +The Arty Z7 HDMI Out project demonstrates the usage of the HDMI out port on the Arty Z7 board. There are two projects, one for each variant of the board: Arty Z7-10 and Arty Z7-20. The behavior is as follows:
 +
 +  * Frames stream out through the HDMI OUT port.
 +  * A UART interface is available to configure what is output through HDMI.
 +  * There are 3 display frame buffers that the user can choose to display.
 +
 +----
 +===== Inventory =====
 +
 +  * Arty Z7 (-10 or -20) with a MicroUSB Programming Cable
 +  * Vivado and Vitis installations compatible with the latest release of this demo (2022.1)
 +    * //See [[programmable-logic:guides:installing-vivado-and-vitis|Installing Vivado, Vitis, and Digilent Board Files]] for installation instructions.//
 +  * Serial Terminal application to receive messages printed by the demo
 +    * //See [[programmable-logic:guides:serial-terminals:start]] for more information.//
 +  * HDMI-capable Monitor
 +  * 1 HDMI Cable
 +
 +----
 +===== Download and Usage Instructions =====
 +
 +First and foremost, releases - consisting of a set of files for download - are only compatible with a specific version of the Xilinx tools, as specified in the name of the release (referred to as a //release tag//). In addition, releases are only compatible with the specified variant of the board. For example, a release tagged "20/DMA/2020.1" for the Zybo Z7 is only to be used with the -20 variant of the board and Xilinx tools (Vivado and Vitis) version 2020.1.
 +
 +The latest release version for this demo is highlighted in green.
 +
 +**Note:** //Releases for FPGA demos from before 2020.1 used a different git structure, and used a different release tag naming scheme.//
 +
 +^ Board Variant  ^ Release Tag                     ^ Release Downloads                                                                                    ^ Setup Instructions                   ^
 +| Arty Z7-10     | @#C0EEBD: 10/HDMI-out/2022.1-1  | {{https://github.com/Digilent/Arty-Z7/releases/download/10/HDMI-out/2022.1-1/Arty-Z7-10-HDMI-out-hw.xpr.zip}} \\ {{https://github.com/Digilent/Arty-Z7/releases/download/10/HDMI-out/2022.1-1/Arty-Z7-10-HDMI-out-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Arty Z7-20     | @#C0EEBD: 20/HDMI-out/2022.1-1  | {{https://github.com/Digilent/Arty-Z7/releases/download/20/HDMI-out/2022.1-1/Arty-Z7-20-HDMI-out-hw.xpr.zip}} \\ {{https://github.com/Digilent/Arty-Z7/releases/download/20/HDMI-out/2022.1-1/Arty-Z7-20-HDMI-out-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Arty Z7-10     | 10/HDMI-out/2021.1-1            | {{https://github.com/Digilent/Arty-Z7/releases/download/10/HDMI-out/2021.1-1/Arty-Z7-10-HDMI-out-hw.xpr.zip}} \\ {{https://github.com/Digilent/Arty-Z7/releases/download/10/HDMI-out/2021.1-1/Arty-Z7-10-HDMI-out-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Arty Z7-20     | 20/HDMI-out/2021.1-1            | {{https://github.com/Digilent/Arty-Z7/releases/download/20/HDMI-out/2021.1-1/Arty-Z7-20-HDMI-out-hw.xpr.zip}} \\ {{https://github.com/Digilent/Arty-Z7/releases/download/20/HDMI-out/2021.1-1/Arty-Z7-20-HDMI-out-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Arty Z7-10     | 10/HDMI-out/2020.1-1            | {{https://github.com/Digilent/Arty-Z7/releases/download/10/HDMI-out/2020.1-1/Arty-Z7-10-HDMI-out-hw.xpr.zip}} \\ {{https://github.com/Digilent/Arty-Z7/releases/download/10/HDMI-out/2020.1-1/Arty-Z7-10-HDMI-out-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Arty Z7-20     | 20/HDMI-out/2020.1-1            | {{https://github.com/Digilent/Arty-Z7/releases/download/20/HDMI-out/2020.1-1/Arty-Z7-20-HDMI-out-hw.xpr.zip}} \\ {{https://github.com/Digilent/Arty-Z7/releases/download/20/HDMI-out/2020.1-1/Arty-Z7-20-HDMI-out-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Arty Z7-10     | 2018.2-1                        | [[https://github.com/Digilent/Arty-Z7-10-HDMI-Out/releases/tag/2018.2-1|Release ZIP Downloads]]  | [[https://github.com/Digilent/Arty-Z7-10-hdmi-out/tree/v2018.2-1|2018.2-1 Github README]]               |
 +| Arty Z7-20     | 2018.2-2                        | [[https://github.com/Digilent/Arty-Z7-20-HDMI-Out/releases/tag/2018.2-2|Release ZIP Downloads]]  | [[https://github.com/Digilent/Arty-Z7-20-hdmi-out/tree/v2018.2-2|2018.2-2 Github README]]               |
 +| Arty Z7-10     | 2016.4-3                        | [[https://github.com/Digilent/Arty-Z7-10-HDMI-Out/releases/tag/2016.4-3|Release ZIP Downloads]]  | [[learn/programmable-logic/tutorials/github-demos/start|Using Digilent Github Demo Projects (Legacy)]]  |
 +| Arty Z7-20     | 2016.4-4                        | [[https://github.com/Digilent/Arty-Z7-20-HDMI-Out/releases/tag/2016.4-4|Release ZIP Downloads]]  | [[learn/programmable-logic/tutorials/github-demos/start|Using Digilent Github Demo Projects (Legacy)]]  |
 +
 +**Note for Advanced Users:** //GitHub sources for this demo can be found in the [[https://github.com/digilent/arty-z7/tree/10/HDMI-out/master|10/HDMI-out/master]] and [[https://github.com/digilent/arty-z7/tree/20/HDMI-out/master|20/HDMI-out/master]] branches of the Arty-Z7 repository. Further documentation on the structure of this repository can be found on this wiki's [[programmable-logic:documents:git]] page.//
 +
 +----
 +Instructions on the use of the latest release can be found in this dropdown:
 +
 +--> Using the Latest Release ^#
 +<WRAP group>
 +
 +{{page>programmable-logic:guides:using-github-releases#baremetal_release_no_build&noheader}}
 +
 +{{page>programmable-logic:guides:using-github-releases#baremetal_release_workaround_before_programming&noheader}}
 +
 +--> Build a Vitis Application #
 +<WRAP group>
 +{{page>programmable-logic:guides:vitis-build-software&noheader}}
 +</WRAP>
 +<--
 +
 +--> Set up the Arty Z7 #
 +<WRAP group> <WRAP column half>
 +Plug the Arty Z7 into the computer via the microUSB programming cable.
 +
 +Plug one end of the HDMI cable into a video monitor and the other into the Arty Z7 HDMI out port.
 +</WRAP> <WRAP column half>
 +{{learn/programmable-logic/tutorials/arty-z7-hdmi-demo/hdmi_out_setup.jpg}}
 +</WRAP> </WRAP>
 +----
 +<--
 +
 +{{page>programmable-logic:guides:using-github-releases#baremetal_release_programming&noheader}}
 +
 +At this point, the demo is now running on your board. Refer to the [[#description|Description]] section of this document for more information on what it does. The [[#hdmi_display_options|HDMI Display Options]] section, below, presents each of the commands that can be sent over serial to the application in order to configure it or have it perform some operation.
 +----
 +Additional steps beyond here present how you can use the other archive provided in the release, containing the hardware project, to rebuild the Vivado project, and use a newly exported XSA file to update the platform in Vitis.
 +----
 +{{page>programmable-logic:guides:using-github-releases#baremetal_update_specification&noheader}}
 +
 +</WRAP>
 +<--
 +
 +----
 +==== HDMI Display Options ====
 +=== 1. Change Display Resolution ===
 +Changes the resolution used for HDMI Output.
 +----
 +=== 2. Change Display Framebuffer Index ===
 +Changes the VDMA framebuffer used for the video output. Each framebuffer represents a different block of DDR memory which can be modified by the processor and read by the VDMA to repeatedly stream the frame out through the HDMI OUT port.
 +----
 +=== 3/4. Print Test Pattern to Display Framebuffer ===
 +Stores one of two test test patterns (blended colors or vertical color bars) into the output buffer, to be displayed immediately. Note that if video input is streaming into the same buffer, the test pattern may be immediately overwritten.
 +
 +Also to note, if the resolution of the video output is later changed, the video data is cropped or padded to fit the screen. This cropping and padding does not affect the actual stored memory, as it is a result of how the VDMA indexes the framebuffer's region of DDR memory. Storing a new test pattern does not affect the memory in the framebuffer outside of the current display area - including areas that would not be displayed with the current output resolution.
 +
 +<WRAP group> <WRAP column half>
 +{{learn/programmable-logic/tutorials/arty-z7-hdmi-demo/arty-z7-hdmi-blend.jpg}}
 +</WRAP> <WRAP column half>
 +{{learn/programmable-logic/tutorials/arty-z7-hdmi-demo/arty-z7-hdmi-bar.jpg}}
 +</WRAP> </WRAP>
 +----
 +=== 5/6. Invert Current Frame Colors ===
 +Iterates through each pixel in the current framebuffer, and inverts the colors. When choosing option 6 instead of 5, the current framebuffer is copied to another framebuffer while doing the inversion, switching to the second buffer after the operation is complete. In this case, the original framebuffer is not modified, and the entire display updates only once the entire operation has been completed.
 +----
 +===== Additional Resources =====
 +
 +All materials related to the use of the Arty Z7 can be found on its [[..:start|Resource Center]].
 +
 +For a walkthrough of the process of creating a simple baremetal software project in Vivado and Vitis, see [[programmable-logic:guides:getting-started-with-ipi]]. Information on important parts of the GUIs, and indirect discussion of the steps required to modify, rebuild, and run this demo in hardware can also be found here.
 +
 +For technical support, please visit the [[https://forum.digilent.com/forum/4-fpga/|FPGA]] section of the Digilent Forum.
 +
 +----