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:guides:install-board-files [2021/08/24 19:06] – Arthur Brownprogrammable-logic:guides:install-board-files [2022/10/04 11:38] (current) – external edit 127.0.0.1
Line 2: Line 2:
 ====== Install Digilent's Board Files ====== ====== Install Digilent's Board Files ======
  
-//Digilent provides //board files// for each FPGA development board. These files make it easy to select the correct part when creating a new project and allow for automated configuration of several complicated components (including the Zynq Processing System and Memory Interface Generator) used in many designs.//+Digilent provides //board files// for each FPGA development board. These files make it easy to select the correct part when creating a new project and allow for automated configuration of several complicated components (including the Zynq Processing System and Memory Interface Generator) used in many designs.
  
 +The board files will be copied into your version of Vivado's installation directory. At the end of this section, an alternate method of installation is presented, which users familiar with git may find more convenient.
 +
 +----
 <WRAP group> <WRAP column half> <WRAP group> <WRAP column half>
 Download the most recent [[https://github.com/Digilent/vivado-boards/archive/master.zip|Master Branch ZIP Archive]] of Digilent's [[https://github.com/Digilent/vivado-boards|vivado-boards]] Github repository and extract it. Download the most recent [[https://github.com/Digilent/vivado-boards/archive/master.zip|Master Branch ZIP Archive]] of Digilent's [[https://github.com/Digilent/vivado-boards|vivado-boards]] Github repository and extract it.
- 
-**Important!** At the time of writing, if using a Spartan or Artix-based board for Microblaze designs, it is recommended to use an alternate version of the board files which better support the DDR memory present on some boards. This version of the board files can be downloaded via this link: [[https://github.com/Digilent/vivado-boards/archive/refs/heads/Microblaze-MIG.zip|Microblaze-MIG.zip]]. To install these files, follow the process found in the installation guide, linked above. 
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
 {{ :vivado:installing-vivado:download-boards.png?800 |}} {{ :vivado:installing-vivado:download-boards.png?800 |}}
Line 13: Line 14:
 ---- ----
 <WRAP group> <WRAP column half> <WRAP group> <WRAP column half>
-Open the folder extracted from the archive and navigate to its 'new/board_files' directory. Select all folders within this directory and **copy** them.+Open the folder extracted from the archive and navigate to its ''new/board_files'' folder. You will be copying all of this folder's subfolders.
  
 **Note**: //When installing Vivado versions 2014.4 or older, use the files found in 'old/board_files' instead.// **Note**: //When installing Vivado versions 2014.4 or older, use the files found in 'old/board_files' instead.//
Line 21: Line 22:
 ---- ----
 <WRAP group> <WRAP column half> <WRAP group> <WRAP column half>
-Open the folder that Vivado was installed into - 'C:/Xilinx/Vivado' or '/opt/Xilinx/Vivado' by default. Under this folder, navigate to its '<version>/data/boards/board_files' directory, then **paste** the board files into this directory.+Open the folder that Vivado was installed into - ''C:/Xilinx/Vivado'' or ''/opt/Xilinx/Vivado'' by default. Under this folder, navigate to its ''<version>/data/boards/board_files'' directory. If this folder doesn't exist, create it. 
 + 
 +**Copy** all of the folders found in vivado-boards' ''new/board_files'' folder, then **paste** them into this folder.
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
 {{ :vivado:installing-vivado:board-files-paste.png?800 |}} {{ :vivado:installing-vivado:board-files-paste.png?800 |}}
 </WRAP> </WRAP> </WRAP> </WRAP>
 +----
 +
 +--> Appendix: Installing the Board Files via the "vivado-boards" Github Repository #
 +You might want to use this method instead if you are familiar with git and want to have a clean way of pulling in the latest changes to the board files, without needing to manually copy-paste the files into every newly-installed version.
 +----
 +<WRAP group> <WRAP column half>
 +Download the [[https://github.com/Digilent/vivado-boards/archive/master.zip|ZIP archive]] of the Digilent's "vivado-boards" Github repository and extract it into a memorable location where it can stay. Alternatively, you can use git and a command prompt to clone the repository into the current working directory with the command ''git clone https://github.com/Digilent/vivado-boards''.
 +</WRAP> <WRAP column half>
 +{{ :vivado:installing-vivado:2018.2:extract-boards.png?800 |}}
 +</WRAP> </WRAP>
 +----
 +<WRAP group> <WRAP column half>
 +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:** //You can also find the path to this directory by launching Vivado and, before changing directory, running the ''pwd'' command in the Tcl Console.//
 +
 +**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.//
 +</WRAP> <WRAP column half>
 +{{ :vivado:installing-vivado:2018.2:place-init-script.png?nolink&800 |}}
 +</WRAP> </WRAP>
 +----
 +<WRAP group>
 +<WRAP column half>
 +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.
 +
 +This script sets the board.repoPaths parameter to a fixed path. The script is run whenever any version of Vivado is launched, and the parameter for that version of Vivado will remain set after you are done with your session. This means that by installing the script, you are setting the board file repo for every version of Vivado you are using, and the changes will remain even after the script is potentially deleted in future. You can always clear the parameter later with the command ''set_param board.repoPaths ""'', again, this persists between sessions.
 +</WRAP>
 +<WRAP column half>
 +{{ :vivado:installing-vivado:2018.2:edit-init-script.png?800 |}}
 +</WRAP>
 +</WRAP>
 +<--
 ---- ----