Skip to content

Commit

Permalink
Deploying to gh-pages from @ c910414 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubcabal committed Aug 11, 2023
1 parent 1880324 commit 1c6b8a1
Show file tree
Hide file tree
Showing 181 changed files with 637 additions and 372 deletions.
4 changes: 4 additions & 0 deletions devel/_images/card_with_ndk.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions devel/_images/fpga_arch.svg

This file was deleted.

69 changes: 69 additions & 0 deletions devel/_sources/ndk_core/doc/faq.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
.. _ndk_faq:

Frequently Asked Questions
==========================

What is a Network Development Kit (NDK)?
****************************************

The NDK is a generic FPGA framework for easy development of your own high-speed network FPGA application. `CESNET (an association of universities of the Czech Republic and the Czech Academy of Sciences) <https://www.cesnet.cz/cesnet/?lang=en>`_ develops and uses NDK primarily to implement own FPGA probes for monitoring CESNET high-speed backbone networks.

What SW do I need to build the NDK firmware?
********************************************

Intel Quartus Prime Pro tool is required to build FW with target FPGA from Intel. Xilinx Vivado tool is needed to build FW with target FPGA from Xilinx (AMD). You also need to have the corresponding licenses for these tools. The specific required versions of these tools are listed for each NDK application in the main README.md file.

What FPGA chips and cards does NDK support?
*******************************************

The NDK supports FPGA chips from both major manufacturers Intel and Xilinx (AMD). Specifically, these are Intel Agilex, Stratix 10 and Xilinx UltraScale+ FPGA chips. A list of specific supported FPGA cards is available for each NDK application in the main README.md file.

What communication interfaces can a NDK applications have available?
********************************************************************

A NDK application can use the interface for communication with external memories, for network communication (Ethernet), for software configuration (write and read 32b words) and for high-speed data transfers between the FPGA and the host memory (DMA).

What Ethernet standards does NDK support?
*****************************************

The specific support of Ethernet standards is always dependent on the target FPGA card or on the Ethernet IP used. NDK currently supports Intel E-Tile, F-Tile or Xilinx CMAC Ethernet IP. All listed IPs support the 100GBASE standard; E-Tile, F-Tile also handle 10GBASE and 25GBASE; and F-Tile then supports even more Ethernet standards.

Does NDK implement ISO/OSI protocol support?
********************************************

No, the user application in the NDK must work on the line layer (L2), i.e. with Ethernet frames without CRC (it is removed/added in the Ethernet IP). If necessary, support for ISO/OSI protocols must be implemented within the user application.

Does NDK support Jumbo packets?
*******************************

Yes, the NDK firmware supports packets up to 16383 B by default, which is the maximum possible value. However, the RX MAC by default discards received Ethernet frames larger than 1522 B (including CRC), but this limit can be changed dynamically through the SW tool (nfb-eth).

Is there also an open-source DMA controller available?
******************************************************

Not currently, but a low-latency DMA controller (DMA Calypte) is currently under development, which will be available as an open-source component of the NDK.

What clock frequencies are available for the user application?
**************************************************************

The user application in the NDK has available four clock signals from the same source with frequencies: 100, 200, 300 and 400 MHz. A 100MHz clock is typically used for the configuration interface and the default is 200MHz for the data path. Using a slower clock may degrade the overall throughput of the NDK.

Is there a SW stack also available for the NDK?
***********************************************

Yes, a Linux driver, a library with a simple API for developing your own SW application and a set of useful tools are available in a `separate repository <https://github.com/CESNET/ndk-sw>`_.

What is the difference between NDK and NetFPGA?
***********************************************

NetFPGA is a general framework for developing your own FPGA application same as the NDK. Unfortunately NetFPGA only supports Xilinx UltraScale+ FPGA chips and does not support Ethernet and data rates higher than 100 Gbps.

What is the difference between NDK and Corundum?
************************************************

Rather, Corundum is also trying to create a general FPGA network, but it also enables the expansion of its own RTL application. Corundum also supports various FPGA cards with chips from both Xilinx and Intel. Unfortunately it does not support Ethernet and data transfer rates higher than 100 Gbps.

What is the difference between NDK and OpenNIC?
***********************************************

OpenNIC is a general framework for developing your own FPGA application same as the NDK. Unfortunately OpenNIC only supports Xilinx UltraScale+ FPGA chips and does not support Ethernet and data transfer speeds higher than 100 Gbps.
4 changes: 2 additions & 2 deletions devel/_sources/ndk_core/doc/terminology.rst.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ndk_terminology:

Terminology
-----------
NDK Terminology
---------------

This chapter explains frequently used terms.

Expand Down
5 changes: 3 additions & 2 deletions devel/_sources/ndk_core/intel/readme.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ NDK architecture

The Network Development Kit (NDK) is available for the selected card based on FPGA. The NDK allows users to quickly and easily develop new network appliances based on FPGA acceleration cards. The NDK is optimized for high throughput and scalable to support 10, 100 and 400 Gigabit Ethernet.

.. image:: doc/img/fpga_arch.svg
.. image:: doc/img/card_with_ndk.drawio.svg
:align: center
:width: 100 %

As you can see in the image above, the top level architecture consists of several building blocks:
The diagram above shows a simplified NDK architecture on a generic FPGA board.
The NDK top level architecture consists of several building blocks:

- MI bus interconnection (MI Splitter,...) allows access to Control and Status Register (CSR)
- The Network module provides transmission and reception of Ethernet packets to/from the network.
Expand Down
1 change: 1 addition & 0 deletions devel/_static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #E40000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #008400 } /* Generic.Inserted */
Expand Down
4 changes: 2 additions & 2 deletions devel/app-minimal.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -57,7 +57,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -50,7 +50,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -52,7 +52,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_cards/agi-fh400g/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_cards/dk-dev-1sdx-p/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_cards/dk-dev-agi027res/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_cards/fb2cghh/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_cards/fb4cgg3/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_cards/ia-420f/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ndk_core/doc/testing.html">NDK testing</a></li>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_core/doc/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Configuration files and parameters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#parametrizing-ndk-core-design">Parametrizing NDK-CORE design</a><ul>
Expand Down
4 changes: 2 additions & 2 deletions devel/ndk_core/doc/devtree.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: c0ae043c
Git branch: devel, <br> Git hash: c9104140
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -53,7 +53,7 @@
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">NDK testing</a></li>
Expand Down
Loading

0 comments on commit 1c6b8a1

Please sign in to comment.