Installing Vivado and Digilent Board Files

Introduction

This guide will show the process of installing and configuring the Vivado development environment, used for developing projects to run on Digilent FPGAs. In addition to the installation, Vivado will be pointed at Digilent's board support files, which are used to make the process of creating a new project significantly faster. In addition, the board files make it significantly easier to add a variety of peripherals (such as DDR memory) to a project.

Prerequisites

  • 20+ GB of free hard-drive space.

Guide

1. Install Vivado

1.1

Open Xilinx's Downloads page in a new tab. Find the section of the page entitled “Vivado Design Suite - HLx Editions - 2018.2 Full Product Installation”. Select the “Self Extracting Web Installer” download for the appropriate operating system. Follow the prompts to sign in or create an account for Xilinx's website. Once signed in, the internet browser will download the selected installer.

1.2

To launch the installer, choose the dropdown for the appropriate operating system, and follow the instructions:

Windows

Use Windows Explorer to find the installer executable in the Downloads directory. Double click on the executable to run it.

Linux

Navigate to the directory that the installer binary was downloaded to in a terminal application, then enter the command below with the correct filename to execute it as a super-user:

chmod +x <installer>.bin && sudo ./<installer>.bin

NOTE: All use of Vivado in Linux should be done as a super-user.

The rest of the steps in Section 1 are the same for both Windows and Linux.

1.3

At the Welcome screen, make sure that the operating system of the computer being used is listed in the compatibility list, then click Next.

1.4

Use the same credentials as on the Xilinx website for user authentication. Select the Download and Install Now option and click Next.

1.5

Read and accept all three license agreements, then click Next.

1.6

On the “Select Edition to Install” screen, several options are presented. Vivado WebPACK Edition is fully free, but will not work when developing for Digilent FPGAs that use a Kintex-7 or Virtex-7 part. Vivado Design Edition can be used without a license, and is the edition recommended by Digilent. A license is required to use Vivado System Edition. This guide does not cover the acquisition and management of licenses. Select the most appropriate edition for the situation, then click Next.

1.7

This screen provides more detailed options for the customization of the installation. The majority of these options do not need to be changed for a basic installation, but unnecessary features can be removed to reduce the installation's footprint on the file-system - for example, most users will not need their Vivado installation to support Ultrascale, Kintex, or Virtex devices. The important options for a beginner to note here are described in the list below. Review the selections, then click Next.

  • Design Tools:
    • Vivado Design Suite:
      • Installs the main Vivado development environment.
    • Software Development Kit:
      • Installs an Eclipse-based development environment for Microblaze and Zynq designs.
    • DocNav:
      • Installs a navigation tool to quickly find appropriate Xilinx documentation of IP and examples.
  • Devices:
    • Allows customization of the set of Xilinx FPGA parts that can be designed for after installation.
  • Installation Options:
    • Install Cable Drivers:
      • Installs the appropriate drivers so that a connected FPGA can be programmed. If Vivado has not been installed before, make sure to check this!
    • Acquire or Manage a License Key:
      • Launches the Xilinx License manager after installation is complete. Most users do not need to manage licenses.

NOTE: Changes can be made to the installation after it is complete by going to
Help → Add Design Tools or Devices in the Vivado toolbar.

1.8

The “Select Destination Directory” screen shows how and where the installation will be placed in the computer's file system. Leaving all of these settings as default is typically fine. Click Next and then Yes if prompted to confirm that the installer will be creating a new directory.

1.9

Review the “Installation Summary”, then click Install.

1.10

The installation process will take quite a while, potentially more than an hour. Find something else to work on until it completes.

1.11

Vivado is now successfully installed! If the “Acquire or Manage a License Key” box was checked in Step 1.7, the Vivado License Manager will launch. The majority of users will not need a license to use Vivado, so the License Manager can just be closed.

2. Installing Cable Drivers on Linux

Windows users may skip this section and continue on to Step 3.

2.1

The Vivado installer does not install the USB drivers required to recognize an FPGA on a Linux system, regardless of whether the option was checked or not. In order to install these drivers, navigate to the “<Vivado Install>/data/xicom/cable_drivers/lin64/install_script/install_drivers/” directory in a console window. The “<Vivado Install>” directory is typically the “/opt/Xilinx/Vivado/*/” directory - the “*” representing the Vivado version number (2018.2). From within this directory, run the “./install_drivers” command as a super-user. Once this command completes successfully, the required drivers will be installed.

NOTE: Some older versions of Vivado may require that the install_drivers command be extracted from a TAR file before use.

2.2

In order to use the USB drivers with a serial terminal, each user that will be using serial terminals must be added to the dialout group. Serial terminals can be very useful for debugging FPGA designs that implement a USB-UART controller. A user can be added to the dialout group with the “sudo adduser $USER dialout” command. Note that this only adds the user that is currently active. In order to add a non-super-user while authenticated as root, use the command “adduser <username> dialout” instead, with “<username>” replaced with the name of the user to be added.

3. Installing Digilent Board Files

3.1

Download the ZIP archive of the Digilent's “vivado-boards” Github repository and extract it into a memorable location where it can stay.

3.2

Find the file “Vivado_init.tcl” in the “utility” subdirectory of the vivado-boards repo. Copy and paste it into the “%APPDATA%/Xilinx/Vivado/” directory for Windows or “$HOME/.Xilinx/Vivado/” (after authenticating as superuser) in Linux. This file is a script that will be run whenever Vivado is launched. It will load Digilent's board files for use in Vivado from the directory they were extracted into.

NOTE: The script init.tcl should be used instead of Vivado_init.tcl for Vivado versions 2016.4 and older. If multiple versions of Vivado from before and after 2016.4 are installed, both scripts should used.

3.3

Open the copied init script in a text editor. Change the text “<extracted path>” in the script to the path to the extracted vivado-boards folder. Save and close the file.

In Conclusion

With Vivado and Digilent's board files installed, you are ready to start developing FPGA projects! To start learning how to use Vivado, check out one of the tutorials below: