Build instructions

Source code

The source code for the reference designs is managed on this Github repository:

https://github.com/fpgadeveloper/sfp28-fmc-mrmac

To get the code, you can follow the link and use the Download ZIP option, or you can clone it using this command:

git clone https://github.com/fpgadeveloper/sfp28-fmc-mrmac.git

License requirements

The designs use the Versal Integrated MRMAC, which requires a (free, no-cost) license to generate a bitstream. The license can be obtained from the AMD Xilinx Licensing site. The VCK190 target also requires the Vivado Enterprise Edition (a 30-day evaluation license is available from the AMD Xilinx Licensing site).

Target designs

This repo contains designs that target the supported development board(s) and their FMC connectors. The table below lists the target design name, the link speed, the SFP28 ports supported by the design and the FMC connector on which to connect the mezzanine card.

10G designs

These designs drive each SFP28 port as an independent 10GbE channel of the MRMAC.

Target board	Target design	Ports	FMC Slot	Vivado Edition
VCK190	`vck190_fmcp1`	4x	FMCP1	Enterprise

25G designs

These designs drive each SFP28 port as an independent 25GbE channel of the MRMAC.

Target board	Target design	Ports	FMC Slot	Vivado Edition
VCK190	`vck190_fmcp1_25g`	4x	FMCP1	Enterprise

Notes:

The Vivado Edition column indicates which designs are supported by the Vivado Standard Edition, the FREE edition which can be used without a license. Vivado Enterprise Edition requires a license, however a 30-day evaluation license is available from the AMD Xilinx Licensing site.
Regardless of the Vivado Edition, the Versal Integrated MRMAC requires a (free) license to generate a bitstream.
All of the 25G designs have the _25g postfix in the target label. The 10G and 25G variants build the same architecture; they differ only in the MRMAC configuration preset, the active client data width and the SFP28 rate-select pin levels.

Windows users

Windows users will be able to build the Vivado project and the Vitis workspace (the bare-metal echo server), however Linux is required to build the PetaLinux project.

Tip

If you wish to build the PetaLinux project, we recommend that you build the entire project (including the Vivado project) on a machine (either physical or virtual) running one of the supported Linux distributions.

Build Vivado project in Windows

Download the repo as a zip file and extract the files to a directory on your hard drive –OR– clone the repo to your hard drive
Open Windows Explorer, browse to the repo files on your hard drive.
In the Vivado directory, double click on the build-vivado.bat batch file. You will be prompted to select a target design to build. You will find the project in the folder Vivado/<target>.
Run Vivado and open the project that was just created.
Click Generate bitstream.
When the bitstream is successfully generated, select File->Export->Export Hardware. In the window that opens, tick Include bitstream and use the default name and location for the XSA file.

Build Vitis workspace in Windows

Before running these steps, you must first build and export the Vivado project as described above.

Return to Windows Explorer and browse to the Vitis directory in the repo.
Double click the build-vitis.bat batch file. You will be prompted to select a target design. A Vitis workspace with hardware platform and software application will be created for the selected target design. You will find the Vitis workspace in the folder Vitis/<target>_workspace.

Linux users

This project can be built using a machine (either physical or virtual) with one of the supported Linux distributions.

Tip

The build steps can be completed in the order shown below, or you can go directly to the build PetaLinux instructions below to build the Vivado and PetaLinux projects with a single command.

Build Vivado project in Linux

Open a command terminal and launch the setup script for Vivado:
```
source <path-to-xilinx-tools>/2025.2/Vivado/settings64.sh
```

Clone the Git repository and cd into the Vivado folder of the repo:

git clone https://github.com/fpgadeveloper/sfp28-fmc-mrmac.git
cd sfp28-fmc-mrmac/Vivado

Run make to create the Vivado project for the target board. You must replace <target> with a valid target (alternatively, skip to step 5):
```
make project TARGET=<target>
```
Valid target labels are: vck190_fmcp1, vck190_fmcp1_25g. That will create the Vivado project and block design without generating a bitstream or exporting to XSA.
Open the generated project in the Vivado GUI and click Generate Bitstream. Once the build is complete, select File->Export->Export Hardware and be sure to tick Include bitstream and use the default name and location for the XSA file.
Alternatively, you can create the Vivado project, generate the bitstream and export to XSA (steps 3 and 4), all from a single command:
```
make xsa TARGET=<target>
```

Build Vitis workspace in Linux

The following steps are required if you wish to build and run the bare-metal echo server. You can skip to the following section if you instead want to use PetaLinux. You are not required to have built the Vivado design before following these steps, as the Makefile triggers the Vivado build for the corresponding design if it has not already been done.

Launch the setup script for Vivado (only if you skipped the Vivado build steps above):
```
source <path-to-xilinx-tools>/2025.2/Vivado/settings64.sh
```

Launch the setup script for Vitis:

source <path-to-xilinx-tools>/2025.2/Vitis/settings64.sh

To build the Vitis workspace, cd to the Vitis directory in the repo, then run make to create the Vitis workspace and compile the standalone application:
```
cd sfp28-fmc-mrmac/Vitis
make workspace TARGET=<target>
```
Valid target labels for the workspaces are: vck190_fmcp1, vck190_fmcp1_25g. You will find the Vitis workspace in the folder Vitis/<target>_workspace.

Build PetaLinux project in Linux

These steps will build the PetaLinux project for the target design. You are not required to have built the Vivado design before following these steps, as the Makefile triggers the Vivado build for the corresponding design if it has not already been done.

Launch the setup script for Vivado (only if you skipped the Vivado build steps above):
```
source <path-to-xilinx-tools>/2025.2/Vivado/settings64.sh
```
Launch PetaLinux by sourcing the settings.sh bash script, eg:
```
source <path-to-petalinux-install>/2025.2/settings.sh
```
Build the PetaLinux project for your specific target platform by running the following command, replacing <target> with a valid value from below:
```
cd PetaLinux
make petalinux TARGET=<target>
```
Valid target labels for PetaLinux projects are: vck190_fmcp1, vck190_fmcp1_25g. Note that if you skipped the Vivado build steps above, the Makefile will first generate and build the Vivado project, and then build the PetaLinux project.

PetaLinux offline build

If you need to build the PetaLinux project offline (without an internet connection), you can follow these instructions.

Download the sstate-cache artefacts from the Xilinx downloads site (the same page where you downloaded PetaLinux tools). For this Versal design you need:
- aarch64 sstate-cache
- Downloads (for all designs)
Extract the contents of those files to a single location on your hard drive, for this example we’ll say /home/user/petalinux-sstate. That should leave you with the following directory structure:
```
/home/user/petalinux-sstate
                          +---  aarch64
                          +---  downloads
```
Create a text file called offline.txt in the PetaLinux directory of the project repository. The file should contain a single line of text specifying the path where you extracted the sstate-cache files. In this example, the contents of the file would be:
```
/home/user/petalinux-sstate
```
It is important that the file contain only one line and that the path is written with NO TRAILING FORWARD SLASH.

Now when you use make to build the PetaLinux project, it will be configured for offline build.