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:nexys-video:demos:dma-audio [2022/08/25 12:51] – [Table] andreisoptereanprogrammable-logic:nexys-video:demos:dma-audio [2022/10/04 11:38] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Nexys Video DMA Audio Demo ======
  
 +<WRAP round todo>
 +=== Under Construction ===
 +</WRAP>
 +
 +{{nexys/nexysvideo/16508527298_efc2312db1_o_1_.png?600}}
 +
 +----
 +===== Description =====
 +
 +This project demonstrates how to use the Nexys Video's Audio Codec and RAM to record samples of audio and play them back. Data is transferred to and from the DDR memory through DMA transfers. A custom I2S IP is used to control the timing of the transfers and to interface with the codec. 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.
 +
 +----
 +===== Inventory =====
 +
 +  * Nexys Video
 +  * MicroUSB cables for programming and serial communication
 +  * External power supply
 +  * Audio input and output, such as audio cables with a phone or computer, microphone, and/or speakers.
 +  * Vivado and Vitis installations compatible with the latest release of this demo (2020.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.//
 +
 +----
 +===== 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.//
 +
 +^ Release Tag  ^ Release Downloads  ^ Setup Instructions  |
 +| @#C0EEBD: DMA/2020.1-1  | [[https://github.com/Digilent/Nexys-Video/releases/tag/DMA/2020.1-1|Release ZIP Downloads]] | See //Using the Latest Release//, below  |
 +| v2018.2-2            | [[https://github.com/Digilent/Nexys-Video-DMA/releases/tag/v2018.2-1|Release ZIP Downloads]] | [[https://github.com/Digilent/Nexys-Video-HDMI/tree/v2018.2-1|v2018.2-1 README]]  |
 +| v2016.4-3            | [[https://github.com/Digilent/Nexys-Video-HDMI/releases/tag/v2016.4-3|Release ZIP Downloads]] | [[learn/programmable-logic/tutorials/github-demos/start|Using Digilent Github Demos (Legacy)]]  |
 +
 +**Note for Advanced Users:** //All demos for the Nexys Video are provided through the [[https://github.com/Digilent/Nexys-Video|Nexys-Video]] repository on Github. 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_before_programming&noheader}}
 +
 +--> Set up the (Board) #
 +<WRAP group> <WRAP column half>
 +Plug the Nexys Video into the computer via the MicroUSB programming cables (one for communication, one for programming). Plug the power supply into the board and power the board on by flipping the power switch.
 +
 +Connect your audio equipment to the corresponding ports - MIC for microphones, HPH OUT for headphones or speakers, LINE IN/OUT for audio cables running to other devices.
 +
 +Connect a serial terminal to the port associated with the Nexys Video. The demo uses a baud rate of **115200**.
 +</WRAP> <WRAP column half>
 +{{learn/programmable-logic/tutorials/2020.1/launch-vitis-application/set-baud.png?600}}
 +</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>
 +<--
 +
 +----
 +===== Functionality =====
 +
 +=== 1. Controls ===
 +
 +Audio playback and recording are controlled by push buttons as below.
 +
 +^  Button  ^  Function                   ^
 +^  BTNU    |  Record from microphone in  |
 +^  BTNR    |  Record from line in        |
 +^  BTNL    |  Play on line out           |
 +^  BTND    |  Play on headphone out      |
 +
 +----
 +=== 2. Recording from an Input ===
 +
 +Press the record button associated with the input you want to record from. 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.
 +
 +----
 +=== 3. Playing to an Output ===
 +
 +Press the play button associated with the output jack you want to use. 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.
 +
 +**Note:** //Recording audio prior to playback is recommended, as the memory buffer used is not necessarily zeroed out when the application is launched, and loud static may be played.//
 +
 +----
 +===== Additional Resources =====
 +
 +All materials related to the use of the Nexys Video can be found on its [[..:|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.digilentinc.com/forum/4-fpga/|FPGA]] section of the Digilent Forum.
 +
 +----
 +<code>{{tag>project zybo-z7}}</code>