corundum/fpga/mqnic/VCU108/fpga_25g/README.md

# Corundum mqnic for VCU108

## Introduction

This design targets the Xilinx VCU108 FPGA board.

* FPGA: xcvu095-ffva2104-2-e
* PHY: 10G BASE-R PHY IP core and internal GTY transceiver
* RAM: 4 GB DDR4 2400 (2x 256M x80)

## Quick start

### Build FPGA bitstream

Run `make` in the `fpga` subdirectory to build the bitstream.  Ensure that the Xilinx Vivado toolchain components are in PATH.

### Build driver and userspace tools

On the host system, run `make` in `modules/mqnic` to build the driver.  Ensure the headers for the running kernel are installed, otherwise the driver cannot be compiled.  Then, run `make` in `utils` to build the userspace tools.

### Testing

Run `make program` to program the board with Vivado.  Then, reboot the machine to re-enumerate the PCIe bus.  Finally, load the driver on the host system with `insmod mqnic.ko`.  Check `dmesg` for output from driver initialization, and run `mqnic-dump -d /dev/mqnic0` to dump the internal state.