Repository files navigation

The OpenNIC project provides an FPGA-based NIC platform for the open sourcecommunity. It consists of multiple components: a NIC shell, a Linux kerneldriver, and a DPDK driver. The NIC shell contains the RTL sources and designfiles for targetting several of the AMD-Xilinx Alveo boards featuring UltraScale+FPGAs. It delivers a NIC implementation supporting up to four PCI-e physicalfunctions (PFs) and two 100Gbps Ethernet ports. The shell is equipped withwell-defined data and control interfaces and is designed to enable easyintegration of user logic into the shell. A block diagram of the OpenNICshell follows:

The Linux kernel driver implements the device driver for the NIC shell. Itsupports multiple PFs and multiple TX/RX queues in each PF. The RX queues areselected through a receive-side scaling (RSS) implementation in the shell.

The goal of OpenNIC is to enable fast prototyping of hardware-acceleratednetwork-attached applications. It is not a fully-fledged SmartNIC solution.

The latest version of OpenNIC is 1.0, which uses OpenNIC shell version 1.0 andOpenNIC driver version 1.0 or OpenNIC DPDK driver version 1.0.

This repository serves as the release point for the OpenNIC project, whichconsists of three components:

• OpenNIC shell,
• OpenNIC driver, and
• OpenNIC DPDK.

A released version of OpenNIC pins to a commit in themaster branch of each component repository.

A Bash scriptscript/checkout.sh is provided to checkout a specific version ofOpenNIC. It takes two arguments, the root directory for the cloned repositoriesand optionally, a version number. By default, it will checkout the latestversion. The correspondence between OpenNIC versions and component repositorytags are tracked inscript/version.yaml.

A technical reference guide (PDF versionorMS Word version) provides details ofthe design of the OpenNIC. The document primarily covers the hardware architecture and its relatedimplementation. It also briefly describes the organization of the Linux kernel driver for OpenNIC.

A set offrequently asked questionshas been prepared to help in answering questions regarding this project. The FAQ has sections for:(a) general questions, (b) feature set questions, (c) hardware questions, (d) software questions, and(e) operation questions. Please contact us to submit any additional questions that you feel would help others.

This file contains confidential and proprietary information of Advanced MicroDevices-Xilinx and is protected under U.S. and international copyright and otherintellectual property laws.

DISCLAIMER

This disclaimer is not a license and does not grant any rights to the materialsdistributed herewith. Except as otherwise provided in a valid license issued toyou by Xilinx, and to the maximum extent permitted by applicable law: (1) THESEMATERIALS ARE MADE AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBYDISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY,INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, ORFITNESS FOR ANY PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whetherin contract or tort, including negligence, or under any other theory ofliability) for any loss or damage of any kind or nature related to, arisingunder or in connection with these materials, including for any direct, or anyindirect, special, incidental, or consequential loss or damage (including lossof data, profits, goodwill, or any type of loss or damage suffered as a resultof any action brought by a third party) even if such damage or loss wasreasonably foreseeable or Xilinx had been advised of the possibility of thesame.

CRITICAL APPLICATIONS

Xilinx products are not designed or intended to be fail-safe, or for use in anyapplication requiring failsafe performance, such as life-support or safetydevices or systems, Class III medical devices, nuclear facilities, applicationsrelated to the deployment of airbags, or any other applications that could leadto death, personal injury, or severe property or environmental damage(individually and collectively, "Critical Applications"). Customer assumes thesole risk and liability of any use of Xilinx products in Critical Applications,subject only to applicable laws and regulations governing limitations on productliability.

THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE ATALL TIMES.