Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
vivado:getting_started:start [2022/10/13 21:45] – Arthur Brown | vivado:getting_started:start [2023/04/27 17:11] (current) – [10. Finished!] James Colvin | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Getting Started with Vivado ====== | ||
+ | <WRAP center round important 60%> | ||
+ | For the most up to date version of this guide, please visit [[programmable-logic/ | ||
+ | </ | ||
+ | ===== Introduction ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The goal of this guide is to familiarize the reader with the Vivado tools through the hello world of hardware, blinking an LED. | ||
+ | |||
+ | **Note:** //While this guide was created using Vivado 2016.4, the workflow described has not substantially changed, and the guide works as described through Vivado 2019.2, the latest version as of time of writing.// | ||
+ | |||
+ | ---- | ||
+ | ===== Prerequisites ===== | ||
+ | Prior to starting this guide make sure to install Vivado: | ||
+ | * For versions 2019.2 and later, see [[vivado: | ||
+ | * For versions prior to 2019.2, see [[vivado: | ||
+ | |||
+ | ---- | ||
+ | ===== Guide ===== | ||
+ | ==== 1. Launching Vivado ==== | ||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | **Windows**\\ | ||
+ | Open the start menu or desktop shortcut created during the installation process. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | **Linux**\\ | ||
+ | Open a terminal, cd into a working directory that can be cluttered with temporary Vivado files and logs, then run the following: | ||
+ | < | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ==== 2. The Start Page ==== | ||
+ | This is the screen that displays after Vivado starts up. The buttons are described below using the image as a guide. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | == 1. Create New Project == | ||
+ | |||
+ | This button will open the New Project wizard. This wizard steps the user through creating a new project. The wizard is stepped through in section 3. | ||
+ | |||
+ | == 2. Open Project == | ||
+ | |||
+ | This button will open a file browser. Navigate to the desired Xilinx Project (.xpr) file and click //Open// to open the project in Vivado. | ||
+ | |||
+ | == 3. Open Example Project == | ||
+ | |||
+ | This will guide the user through creating a new project based on an example project. These projects will not work on all devices. | ||
+ | |||
+ | == 4. Open Hardware Manager == | ||
+ | |||
+ | This will open the Hardware Manager without an associated project. If connecting to and programming a device is all that is required by the user, then this is the button to use. | ||
+ | |||
+ | ==== 3. Creating a New Project ==== | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 3.1 === | ||
+ | From the start page, select the //Create New Project// button to start the New Project Wizard. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 3.2 === | ||
+ | The text in this dialog describes the steps that will be taken to create a project. Click //Next// to continue to the first step. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 3.3 === | ||
+ | The first step is to set the name of the project. Vivado will use this name when generating its folder structure. | ||
+ | <WRAP center round important> | ||
+ | === Important === | ||
+ | Do NOT use spaces in your project name or location path. This will cause problems with Vivado. Instead use an underscore, a dash, or [[wp> | ||
+ | </ | ||
+ | Click //Next// to continue. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 3.4 === | ||
+ | Now that the project has a name and a place to save its files we need to select the type of project we will be creating. Select //RTL Project// and make sure to check //Do not specify sources at this time//. Source files will be added and created after the project has been created. Advanced users may use the other options on this screen, but they will not be covered in this guide. | ||
+ | |||
+ | Click //Next// to continue. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 3.5 === | ||
+ | <WRAP round center important> | ||
+ | === Important === | ||
+ | If your board does not appear in this list, then Digilent' | ||
+ | </ | ||
+ | Now it is time to choose the target device. Click the //Boards// tab at the top of the dialog, then select your board from the list. | ||
+ | |||
+ | Click //Next// to continue. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 3.6 == | ||
+ | The next section gives a summary of the options selected throughout the wizard. Verify that the information looks correct and click //Finish//. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== 4. The Flow Navigator ==== | ||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The //Flow Navigator// is the most important pane of the main Vivado window to know. It is how a user navigates between different Vivado tools. | ||
+ | |||
+ | The Navigator is broken into seven sections: | ||
+ | * //Project Manager// | ||
+ | * Allows for quick access to project settings, adding sources, language templates, and the IP catalog | ||
+ | * //IP Integrator// | ||
+ | * Tools for creating Block Designs | ||
+ | * // | ||
+ | * Allows a developer to verify the output of their design prior to programming their device | ||
+ | * //RTL Analysis// | ||
+ | * lets the developer see how the tools are interpreting their code | ||
+ | * // | ||
+ | * Gives access to Synthesis settings and post-synthesis reports | ||
+ | * // | ||
+ | * Gives access to Implementation settings and post-implementation reports | ||
+ | * //Program and Debug// | ||
+ | * Access to settings for bitstream generation and the Hardware Manager | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ vivado: | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ==== 5. The Project Manager ==== | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | This tool is where most development will occur and is the initial tool open after creating a new project. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The //Project Manager// consists of four panes, // | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The //Sources// pane contains the project hierarchy and is used for opening up files. The folder structure is organized such that the HDL files are kept under the //Design Sources// folder, constraints are kept under the // | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The // | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The unnamed pane at the bottom of the Project Manager window consists of several different useful tools for debugging a project. The most important one to know is the // | ||
+ | |||
+ | These tools can be accessed by selecting the different tabs at the bottom of this pane. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The //Tcl Console// is a tool that allows for running commands directly without the use of the main user interface. Some messages may link to the Tcl Console to provide more information regarding an error. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The //Reports// tool is useful for quickly jumping to any one of the many reports that Vivado generates on a design. These reports include power, timing, and utilization just to name a few. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The //Log// displays the output from the latest Synthesis, Implementation, | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The last tool is the //Design Runs//. Using this tool run settings can be edited and new runs can be created. This tool is useful when targeting multiple devices with the same design. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The most important pane in the Project Manager is the // | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ==== 6. Adding a Constraint File ==== | ||
+ | |||
+ | In order to connect HDL code with the physical pins of the FPGA, a constraint file needs to be added or created. Digilent has produced a Xilinx Design Constraint (XDC) file for each of our boards. Download [[https:// | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 6.1 === | ||
+ | In the //Project Manager// section of the //Flow Navigator//, | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 6.2 === | ||
+ | At this stage, Vivado provides a list of all of the constraint files that will be added or created when we click Finish. Currently this list is empty, this will change when files have been added or created. A constraint file will not be created from scratch in this guide, so click //Add Files//. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 6.3 === | ||
+ | Find the directory you extracted the // | ||
+ | |||
+ | Click //OK// to continue. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 6.4 === | ||
+ | Make sure that the selected XDC file has been added into the list of sources, and that the //Copy constraint files into project// is checked, then click //Finish//. | ||
+ | |||
+ | **Note:** //Leaving the Copy... box unchecked means that any editing done to the constraint file will be reflected in the original copy. Checking the box is highly recommended// | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | === 6.5 === | ||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | In the //Sources// pane of the //Project Manager//, expand the // | ||
+ | |||
+ | Find and uncomment the lines that call // | ||
+ | <WRAP round center tip> | ||
+ | === Tip === | ||
+ | A board using clk_p/clk_n pins means that the input clock that uses differential logic. If you want to know more read this article on [[wp> | ||
+ | </ | ||
+ | Change the name inside of the get_ports call to ' | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ==== 7. Creating a Verilog Source File ==== | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 7.1 === | ||
+ | In the //Project Manager// section of the //Flow Navigator//, | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 7.2 === | ||
+ | As before, at this stage, we will be provided a list of all of the source files that will be added or created when we click Finish. Instead of clicking Add Files, click //Create File//. | ||
+ | <WRAP round center tip> | ||
+ | === Tip === | ||
+ | It is also possible to add existing source files in the same way as we added the constraint file above. | ||
+ | </ | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 7.3 === | ||
+ | You will be prompted to select a //File type//, //File name//, and //File location//. Make sure to pick //Verilog// and //<Local to project>// | ||
+ | <WRAP center round important> | ||
+ | === Important === | ||
+ | Do NOT use spaces in your file name. This will cause problems with Vivado. Instead use an underscore, a dash, or [[wp> | ||
+ | </ | ||
+ | Click //OK// to continue. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | === 7.4 === | ||
+ | Make sure that the new Verilog source file has been added into the list of sources, then click //Finish//. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | === 7.5 === | ||
+ | Unlike when the constraint file was added, at this point a //Define Module// dialog will pop up. You can rename your Verilog module using the //Module name// field, but this is unnecessary. The Verilog module' | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | There are five fields to define for each of the module' | ||
+ | * **Port Name:** This field defines the name of the port and needs to match one of the names you used in your XDC file. | ||
+ | * **Direction: | ||
+ | * **Bus:** This can be checked or not, when checked, this port consists of multiple single bit signals, grouped into a single bus. | ||
+ | * **MSB:** The index of the most significant bit of the port, if it is a bus. This option is grayed out for single-bit ports. | ||
+ | * **LSB:** The index of the least significant bit of the port, if it is a bus. This option is grayed out for single-bit ports. | ||
+ | |||
+ | <WRAP round center tip> | ||
+ | === Tip === | ||
+ | If you are defining a module which will be instantiated in another module, which we will not go into in this guide, be aware that the port names should not be declared in the XDC, this is only done for your ' | ||
+ | </ | ||
+ | |||
+ | If your board uses differential clocking, add two single-bit input ports with the same names as the positive and negative clock ports that were uncommented in your XDC file. Otherwise, add a single single-bit input port with the same name as the clock port that was uncommented in your XDC file. | ||
+ | |||
+ | Add a single-bit output port with the same name as the LED port that was uncommented in your XDC file. | ||
+ | |||
+ | Once these two or three ports have been added, click //OK// to continue. | ||
+ | |||
+ | === 7.6 === | ||
+ | At this point, the new source file will be added to the //Design Sources// folder in the //Sources// pane of the //Project Manager//. Expand this folder and double click on the file to open it. | ||
+ | |||
+ | Next, some Verilog code needs to be written to define how the design will actually behave. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Between the ' | ||
+ | |||
+ | <code verilog> | ||
+ | reg [24:0] count = 0; | ||
+ | |||
+ | assign led = count[24]; | ||
+ | |||
+ | always @ (posedge(clk)) count <= count + 1; | ||
+ | </ | ||
+ | |||
+ | If your board is differentially clocked, add the following lines of code after ' | ||
+ | |||
+ | <code verilog> | ||
+ | wire clk; | ||
+ | |||
+ | IBUFGDS clk_inst ( | ||
+ | .O(clk), | ||
+ | .I(clk_p), | ||
+ | .IB(clk_n) | ||
+ | ); | ||
+ | </ | ||
+ | |||
+ | It should be noted that the rate at which the clock will blink will differ depending on the board used. System clocks on different Digilent boards run at a number of different rates, depending on the needs of the board. The system clock period in nanoseconds can be found on the // | ||
+ | |||
+ | After completing this guide, it is suggested to try changing the provided Verilog code so that the clock blinks at 1 Hertz - changing the XDC file beyond commenting or uncommenting entire lines is not recommended. | ||
+ | |||
+ | ==== 8. Synthesis, Implementation, | ||
+ | |||
+ | In order to create a file that can be used to program the target board, each stage of the " | ||
+ | |||
+ | This starts with // | ||
+ | |||
+ | // | ||
+ | |||
+ | The //Bitstream Generator// generates the final outputs needed for programming the FPGA. To run Bitstream Generation click either {{: | ||
+ | |||
+ | ==== 9. The Hardware Manager ==== | ||
+ | |||
+ | The //Hardware Manager// is used for programming the target device. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The first step to programming a device is to connect the Vivado Hardware Server to it. There are two ways to do this. | ||
+ | |||
+ | **1. Open New Hardware Target** | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The first method is to manually open the target. This is required if the hardware is connected to another computer. To get to the //Open Hardware Target// wizard either open the //Hardware Manager// and click the {{: | ||
+ | |||
+ | Once the wizard opens, click //Next//. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The next screen asks if the hardware server is local or remote. If the board is connected to the host computer choose local, if it is connected to another machine choose remote and fill in the //Host Name// and //Port// fields. | ||
+ | |||
+ | Click //Next// to continue. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | This screen gives a list of devices connected to the hardware server. If there is only one connected it should be the only device shown. If there are multiple connected devices, determine the serial number of the device to connect to and find it in the list. | ||
+ | |||
+ | Click //Next// to continue. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | The final screen shows a summary of the options selected in the wizard. Verify the information and click //Finish//. The board is now connected to the hardware manager. | ||
+ | </ | ||
+ | <WRAP column half> | ||
+ | {{ : | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | **2. Auto-Connect** | ||
+ | |||
+ | The second method is to automatically open the target. To get to the {{: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | **Programming** | ||
+ | |||
+ | To program the device with the bit file generated earlier, either click the {{: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The //Bitstream File// field should be automatically filled in with the bit file generated earlier. If not, click the {{: | ||
+ | |||
+ | ----- | ||
+ | |||
+ | ==== 10. Finished! ==== | ||
+ | |||
+ | You should now see one of the LEDs on your board blinking! | ||
+ | |||
+ | Be sure to visit your board' | ||
+ | |||
+ | {{tag> |