Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/recolic/vivado-wrapper
This is a read-only mirror for https://git.recolic.net/root/vivado-wrapper
https://github.com/recolic/vivado-wrapper
bash build-tool command-line project-management vivado
Last synced: about 2 months ago
JSON representation
This is a read-only mirror for https://git.recolic.net/root/vivado-wrapper
- Host: GitHub
- URL: https://github.com/recolic/vivado-wrapper
- Owner: recolic
- License: gpl-3.0
- Created: 2018-06-19T11:53:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-25T06:16:24.000Z (almost 4 years ago)
- Last Synced: 2024-08-03T01:39:22.820Z (5 months ago)
- Topics: bash, build-tool, command-line, project-management, vivado
- Language: Shell
- Homepage:
- Size: 85 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hust - vivado-wrapper
README
# Vivado Wrapper
> Simple is beautiful.
A light & simple vivado project manager, natively working in Linux/Unix command line.
## Features
- Init, build, burn any vivado project in one command.
- Extremely simple, flexible, and customizable project layout.
- Burn auto saved built binary at anytime and any machine.
- Built-in support to an extremely simple constraint file format: `.vwc`.
- Full vivado GUI support.
- Support every hardware supported by vivado.
- Theoretically support any vivado version (But latest is the best).
## Installation
- Arch Linux
You may install AUR package [vivado-wrapper](https://aur.archlinux.org/packages/vivado-wrapper) directly with your favorite package manager.
- Other Linux
```sh
git clone https://github.com/recolic/vivado-wrapper
export vivado_exec="/path/to/your/vivado" # Bash
set -Ux vivado_exec "/path/to/your/vivado" # Fish
```
Or if you want to make yourself happier:
```sh
set -Ux PATH $PATH (pwd)/vivado-wrapper # Fish
export PATH="$PATH:$(pwd)/vivado-wrapper" # Bash
alias vivadow=vivado-wrapper # I'll use this wrapper in the doc below.
```
## Usage
- Create Project
```sh
mkdir my_project && cd my_project
vivadow init
code . # Or any editor you prefer.
vim Vivadofile # To tell vivado-wrapper about your module~constraint relationship, threads, board, etc.
```
- Build Project
```sh
cd vivado-wrapper/example
vivadow build
# Plug in your board now
vivadow burn
```
Or you can easily burn a pre-built bitstream:
```sh
vivadow burn-file ./build/other_mod.bit
```
- Run Simulation (Or other GUI-only Tasks)
Warning: All modification to sources/constraints will be saved to origin project. All modification to other project-level configurations, adding or removing sources, will be discarded.
```sh
vivadow gui
```
## Notice
This is a bash script, so it can be easily injected. `Vivadofile` and `.vwc` constraint will be directly `source`d. **Never** trust Vivadofile uploaded by others!
If you give a wrong top\_module name, *silly vivado* will accept it, and generate bitstream for a **randomly-taken** module(with long time spent), then report error.
## TODO
Support bridging C/C++ into systemverilog via SV DPI. However my vivado 2018 failed to simulate it, saying `xsim.dir/tb_dpi_behav/xsimk: error while loading shared libraries: unexpected PLT reloc type 0x00`.