This is an old revision of the document!


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 - 2017.4 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

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

1.3

At the Welcome screen, 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 Virtex-7 part. Licenses are required to use Vivado Design and System Editions. This guide does not cover the acquisition and management of licenses. Select the most appropriate edition for the situation (for beginners, WebPACK), 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. 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. Modifying these settings can help to reduce the installation's footprint on the file-system.
  • 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.

NOTE: Changes can be made to the installation after it is complete by re-running the Vivado Installer.

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, as seen in the screenshot to the right. Find something else to work on until it completes.

2. Installing Digilent Board Files

2.1

Download the archive of the vivado-boards Github repository and extract it wherever desired.

2.2

Open the file “Vivado_init.tcl” in the “utility” subdirectory of the vivado-boards repo. Change the text “<extracted path>” in the first line of init.tcl to the extracted location of vivado-boards. Save and close the file.

NOTE: The file init.tcl should be used instead of Vivado_init.tcl when installing Vivado versions 2016.4 and older.

2.3

Copy init.tcl and paste it into the “%APPDATA%/Xilinx/Vivado/” directory for Windows or “$HOME/.Xilinx/Vivado/” (after authenticating as superuser) in Linux.

In Conclusion

Vivado has now been installed and it has access to Digilent's board files! To begin using Vivado to develop a project, check out one of the tutorials below: