OSNT SUME Getting Started Guide - NetFPGA/OSNT-Public GitHub Wiki

Welcome to OSNT SUME getting started guide! This guide is for new users. It covers:

  1. System Requirements.
  2. Downloading the code repository.
  3. HW Installation.
  4. SW Installation.
  5. What to do next!

Let's get started...

Section 1 - OSNT SUME Requirements

To use the OSNT SUME code base, your system needs to meet the NetFPGA-SUME requirements. Please, refer to the following link for more information: NetFPGA-SUME Getting Started Guide

Section 2 - Registering for the Program

Prior to accessing code, we need people to register. We do this to understand who is using NetFPGA-SUME OSNT project so please give as complete answers as you can. The better usage we can show the more support we can motivate sponsors to provide.

Feel free to explore the wiki; it is publicly readable.

Continue on from here once your registered

Section 2a - Downloading the Code Base

The code release is available to the community as either a git repository or tarball.

If you wish to use a stable release, the most recent stable release is available as a tarball from the list. The latest release is the tag at the top. Edit access to this community wiki is co-located with the live repository. If you have access to the repository, you also have access to this wiki.

Section 2b - Downloading the Live Code Base (We recommend this method)

The current developers code base is available as a git repository hosted on GitHub. After you have gained access to the repository, change into the desired directory and execute the following command:

git clone https://github.com/NetFPGA/OSNT-SUME-live
cd ./OSNT-SUME-live
git checkout <latest version tag>

The latest version tag can be found in the OSNT-SUME Release Notes. For more information about git and github in general, please consult github help.

Section 3 - HW Installation

When you have the code in place, you will need to run a one-time installation script:

  1. Make sure you have Xilinx Vivado version 2016.2 installed for use of the latest OSNT SUME repo. (If the Vivado is 2014.4, you have to check out the OSNT SUME repo with an old version. See the release note.
  2. Make sure the 10G MAC is correctly licensed. You may need to run "xlicmgr" to check the status. Only "Full" or "Hardware Evaluation" will allow you to build the bitfile.
  3. OSNT Monitor use a TCAM so that an IP of the Xilinx TCAM needs to be downloaded from the Xilinx Website. Search xapp1151 at the Xilinx Website and put the xapp1151_Param_CAM.zip into the directory of ./OSNT-SUME-live/lib/hw/osnt/cores/osnt_sume_monitoring_output_port_lookup_v1_00. Run bash run_update_lib.sh to patch the Xilinx core.
  4. Go to the ./OSNT-SUME-live/ directory and run "make"

The above command will do the following:

  1. Copy necessary files from your Xilinx Vivado installation
  2. Generate necessary IP cores in the hardware library for OSNT SUME projects.
  3. Patch some of the copied files so that the copied IP can be synthesized on the NetFPGA-SUME board's Virtex-7 FPGA device.

Section 4 - SW Installation

Before using OSNT system, you need to compile both the OSNT DMA driver and user space software.

OSNT SUME DMA Driver

You will find the OSNT driver in OSNT-SUME-live/lib/sw/driver/osnt_sume_riffa_v1_00 directory. Run "make" to compile it.

OSNT SUME User Space Software

To compile the provided user space software you need to go to OSNT-SUME-live/projects/osnt/sw/host/app directory. Run "make" to compile the register read and write applications.

Section 5 - What to do Next!

For an explanation of the organization and use of the code base, please see the OSNT SUME Code Base Organization and Use section.

For information on OSNT SUME Generator project, please see the OSNT SUME Generator section.

For information on OSNT SUME Monitor project, please see the OSNT SUME Monitor section.

And for all information on the platform, please browse the NetFPGA-SUME Website.