Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
programmable-logic:zybo-z7:demos:dma-audio [2022/09/12 12:40] – changed forum.digilentinc.com to forum.digilent.com Jeffreyprogrammable-logic:zybo-z7:demos:dma-audio [2023/08/25 00:18] (current) – Move to direct file links for downloads Arthur Brown
Line 1: Line 1:
 +====== Zybo Z7 DMA Audio Demo ======
  
 +{{:learn:programmable-logic:tutorials:zybo-z7-dma-audio-demo:zybo-z7-dma-action.jpg?500|}}
 +
 +----
 +===== Description =====
 +
 +This demo contains Vivado IP Integrator and Vitis projects that control the Zybo Z7's audio codec in order to record and play audio 
 +
 +The audio demo records a 5-second sample from the microphone (J6) or line in (J7) port and plays it back on the headphone out (J5) port. Recording and playback are started by push buttons. Messages providing information on the status of the application are printed to a connected serial terminal.
 +
 +----
 +===== Inventory =====
 +
 +  * Zybo Z7 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.//
 +  * Headphones or Speakers
 +  * Audio Input Device - such as a microphone or a computer with 3.5mm audio jack and an audio 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  ^
 +| Zybo Z7-10     | @#C0EEBD: 10/DMA/2022.1-1  | {{https://github.com/Digilent/Zybo-Z7/releases/download/10/DMA/2022.1-1/Zybo-Z7-10-DMA-hw.xpr.zip}} \\ {{https://github.com/Digilent/Zybo-Z7/releases/download/10/DMA/2022.1-1/Zybo-Z7-10-DMA-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Zybo Z7-20     | @#C0EEBD: 20/DMA/2022.1-1  | {{https://github.com/Digilent/Zybo-Z7/releases/download/20/DMA/2022.1-1/Zybo-Z7-20-DMA-hw.xpr.zip}} \\ {{https://github.com/Digilent/Zybo-Z7/releases/download/20/DMA/2022.1-1/Zybo-Z7-20-DMA-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Zybo Z7-10     | 10/DMA/2021.1-1            | {{https://github.com/Digilent/Zybo-Z7/releases/download/10/DMA/2021.1-1/Zybo-Z7-10-DMA-hw.xpr.zip}} \\ {{https://github.com/Digilent/Zybo-Z7/releases/download/10/DMA/2021.1-1/Zybo-Z7-10-DMA-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Zybo Z7-20     | 20/DMA/2021.1-1            | {{https://github.com/Digilent/Zybo-Z7/releases/download/20/DMA/2021.1-1/Zybo-Z7-20-DMA-hw.xpr.zip}} \\ {{https://github.com/Digilent/Zybo-Z7/releases/download/20/DMA/2021.1-1/Zybo-Z7-20-DMA-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Zybo Z7-10     | 10/DMA/2020.1-1            | {{https://github.com/Digilent/Zybo-Z7/releases/download/10/DMA/2020.1-1/Zybo-Z7-10-DMA-hw.xpr.zip}} \\ {{https://github.com/Digilent/Zybo-Z7/releases/download/10/DMA/2020.1-1/Zybo-Z7-10-DMA-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Zybo Z7-20     | 20/DMA/2020.1-1            | {{https://github.com/Digilent/Zybo-Z7/releases/download/20/DMA/2020.1-1/Zybo-Z7-20-DMA-hw.xpr.zip}} \\ {{https://github.com/Digilent/Zybo-Z7/releases/download/20/DMA/2020.1-1/Zybo-Z7-20-DMA-sw.ide.zip}}  | See //Using the Latest Release//, below  |
 +| Zybo Z7-10     | v2018.2-1                  | [[https://github.com/Digilent/Zybo-Z7-10-DMA/releases/tag/v2018.2-1|Release ZIP downloads]]     | [[https://github.com/Digilent/Zybo-Z7-10-DMA/tree/v2018.2-1|v2018.2-1 README]]  |
 +| Zybo Z7-20     | v2018.2-1                  | [[https://github.com/Digilent/Zybo-Z7-20-DMA/releases/tag/v2018.2-1|Release ZIP downloads]]     | [[https://github.com/Digilent/Zybo-Z7-20-DMA/tree/v2018.2-1|v2018.2-1 README]]  |
 +
 +**Note for Advanced Users:** //GitHub sources for this demo can be found in the [[https://github.com/digilent/zybo-z7/tree/10/DMA/master|10/DMA/master]] and [[https://github.com/digilent/zybo-z7/tree/20/DMA/master|20/DMA/master]] branches of the Zybo-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 Zybo Z7 #
 +<WRAP group>
 +<WRAP group><WRAP column half>
 +Plug the Zybo Z7 into the computer via the microUSB programming cable.
 +
 +Plug your microphone or aux input into the appropriate jack on your Zybo (MIC IN or LINE IN, respectively). Plug your speakers/headphones into the headphone jack (HPH OUT).
 +</WRAP><WRAP column half>
 +{{:learn:programmable-logic:tutorials:zybo-z7-dma-audio-demo:zybo-z7-dma-action.jpg?400|}}
 +</WRAP></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.
 +----
 +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>
 +<--
 +
 +----
 +==== Controls ====
 +
 +Audio playback and recording are controlled by push buttons as below.
 +
 +^  Button  ^  Function             ^
 +^  BTN0    |  no effect            |
 +^  BTN1    |  record from mic in   |
 +^  BTN2    |  play on hph out      |
 +^  BTN3    |  record from line in  |
 +
 +=== Recording from an Input ===
 +
 +To record from MIC IN, press **BTN1**. To record from LINE IN, press **BTN3**. Once the recording is activated, the message "Start Recording..." will be sent over UART and the demo will record 5 seconds of audio. If any buttons are pressed during the recording, the message "Still Recording..." will be sent over UART.
 +----
 +=== Playing to an Output ===
 +
 +To play to HPH OUT, press **BTN2**. Once the playback is activated, the message "Start Playback..." will be sent over UART and the demo will play 5 seconds of audio. If any buttons are pressed during the playback, the message "Still Playing..." will be sent over UART.
 +
 +----
 +===== Additional Resources =====
 +
 +All materials related to the use of the Zybo 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.
 +
 +----