1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
# Vivado Environment Utilities
## Environment Setup
- Navigate to `<repo>/fpga/usrp3/top/{project}` where {project} is:
+ `x300:` For USRP X300/X310
+ `e31x:` For USRP E310
+ `e320:` For USRP E320
+ `n3xx:` For USRP N300/N310/N320
+ `x400:` For USRP X410
- To setup up the Ettus Research Xilinx build environment run
+ `source setupenv.sh` (If Vivado is installed in the default path /opt/Xilinx/Vivado) _OR_
+ `source setupenv.sh --vivado-path=<VIVADO_PATH>` (where VIVADO_PATH is a non-default installation path)
- This should not only enable building USRP FPGAs but also make available the
utilities described in the following sections.
## ModelSim Specific
The `setupenv.sh` script will search the system for ModelSim installations and setup everything to run it natively and
within Vivado. The currently supported versions of ModelSim are PE, DE, SE, DE-64, SE-64.
The following functions are also available in the environment:
build_simlibs: Build ModelSim simulation libraries for Vivado
## IP Management
### Create Vivado IP
viv_create_ip: Create a new Vivado IP instance and a Makefile for it
Usage: viv_create_ip <IP Name> <IP Location> <IP VLNV> <Product>
- <IP Name>: Name of the IP instance
- <IP Location>: Base location for IP
- <IP VLNV>: The vendor, library, name, and version (VLNV) string for the IP as defined by Xilinx
- <Product>: Product to generate IP for
### Modify existing Vivado IP
viv_modify_ip: Modify an existing Vivado IP instance
Usage: viv_modify_ip <IP XCI Path>
- <IP XCI Path>: Path to the IP XCI file
### Modify existing Vivado Block Design (BD)
viv_modify_bd: Modify an existing Vivado BD instance
Usage: viv_modify_bd <BD File Path> <Product>
- <BD File Path>: Path to the BD file.
- <Product>: Product to generate IP for
### Modify existing Vivado Tcl-based Block Design
viv_modify_tcl_bd: Modify an existing Vivado BD instance
Usage: viv_modify_tcl_bd <Tcl File Path> <Product>
- <Tcl File Path>: Path to the Tcl file for the block design.
- <Product>: Product to generate IP for
### List supported Vivado IP
viv_ls_ip: List the items in the Vivado IP catalog
Usage: viv_ls_ip <Product>
- <Product>: Product to generate IP for.
### Upgrade IP to the environment version of Vivado
viv_upgrade_ip: Upgrade one or more Xilinx IP targets
Usage: viv_upgrade_ip <IP Directory> [--recursive]
- <IP Directory>: Path to the IP XCI file.
## Hardware Management
### Launch Vivado Hardware Console
viv_hw_console: Launch the Tcl hardware console
Usage: viv_hw_console
### List connected JTAG devices
viv_jtag_list: List all devices (and their addresses) that are connected to the system using the Xilinx platform cable
Usage: viv_jtag_list
### Program device over JTAG
viv_jtag_program: Downloads a bitfile to an FPGA device using Vivado
Usage: viv_jtag_program <Bitfile Path> [<Device Address> = 0:0]
- <Bitfile Path>: Path to a .bit FPGA configuration file
- <Device Address>: Address to the device in the form <Target>:<Device>
Run viv_jtag_list to get a list of connected devices
### Probe Xilinx bitfile
probe_bitfile: Probe a Xilinx bitfile and report header information
Usage: probe_bitfile <Bitfile Path>
- <Bitfile Path>: Path to a .bit FPGA configuration file
|
