This repository contains an RFSoC4x2 reference design that enables high-speed data offload from the board to a PC/server, via the QSFP28 connection. The RF-ADC data is packetised into UDP packets using the open-source Network Layer IP, and sent to the QSFP28 port via Xilinx's CMAC IP core.
The following is a list of equipment and software used for development and testing of this design. Compatibility with any other software/equipment not listed here is not guaranteed.
Follow the instructions below to install the data offload example for PYNQ. You will need to give your board access to the internet.
pip3 install git+https://github.com/strath-sdr/rfsoc_qsfp_offload
Once installation has complete you will find the package folder in the Jupyter workspace directory. The folder will be named 'rfsoc-offload'.
## Using the Project Files
The following software is required to use the project files in this repository.
* Vitis Core Development Kit 2021.1 with [Y2K22](https://support.xilinx.com/s/article/76960?language=en_US) patch applied
* Vivado Design Suite 2021.1
* Git
### Cloning the Repository
As this repo contains a submodule, clone the repo using the `--recursive` flag
git clone https://github.com/strath-sdr/rfsoc_qsfp_offload.git --recursive
### Building the Project
The Vivado project uses an external Network Layer IP repository that is included as a submodule in the `./boards/ip_repo/` directory. The Network Layer IP uses a modified version of the repository that must be patched and built before the Vivado build process begins. This is all taken care of within the Makefile in the top level directory of this repo.
To build the project, first make sure Vitis and Vivado are on your `$PATH` environment variable.
source
Then run `make` in the top level directory.
make patch make all
This will patch and build the Network Layer IP, build the Vivado project, and generate the bitstream and HWH files required for the overlay.
```make patch``` needs to be run only once after the repository is cloned. ```make all``` can be re-run after ```make clean``` command is issued.
## PC/Server Setup
### PCIe slot
Make sure to attach the QSFP NIC to an appropriate PCIe interface. Most cards require a PCIe x16 slot to fully utilize the bandwidth.
### Static IP
To run this demo, the PC has to be setup to use a static IP for the QSFP interface.
Example using Gnome network manager interface:
<p align="center">
<img src="https://github.com/strath-sdr/rfsoc_qsfp_offload/raw/master/assets/static_ip_gnome.png" width="40%" height="40%" />
</p>
### MTU
For the best performance the Maximum Transmission Unit of the interface needs to be increased to support jumbo frames.
Example using Gnome network manager interface:
<p align="center">
<img src="https://github.com/strath-sdr/rfsoc_qsfp_offload/raw/master/assets/MTU_gnome.png" width="40%" height="40%" />
</p>
### GNU Radio
Instructions on installing GNU Radio and preparing to run the demo can be found in [gnuradio/README.md](gnuradio/README.md).