Skip to content

Commit

Permalink
docs: update index page and notes about DMA Medusa IP
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubcabal committed Feb 10, 2025
1 parent 3c8ed3d commit e739dfb
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 11 deletions.
3 changes: 2 additions & 1 deletion core/doc/dma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ The DMA module is a wrapper containing the DMA controller (DMA IP), auxiliary, a

.. note::

The DMA Medusa IP is not part of the open-source NDK. `You can get the NDK, including the DMA Medusa IP and professional support, through our partner BrnoLogic. <https://support.brnologic.com/>`_
The DMA Medusa IP is not part of the open-source NDK-FPGA.
For more information about IP availability, `see the section Partners in README.md file <https://github.com/CESNET/ndk-fpga/blob/devel/README.md#partners>`_.

Each DMA stream consists of two buses: the :ref:`MFB bus <mfb_bus>` is used to transfer data packets, the :ref:`MVB bus <mvb_bus>` is used to transfer DMA instructions to each packet. How a user application should properly use these buses is described in :ref:`The Application chapter <ndk_app>`.

Expand Down
5 changes: 5 additions & 0 deletions core/doc/performance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ The throughput test is performed in three phases:
:align: center
:width: 100 %

.. note::

The DMA Medusa IP is not part of the open-source NDK-FPGA.
For more information about IP availability, `see the section Partners in README.md file <https://github.com/CESNET/ndk-fpga/blob/devel/README.md#partners>`_.

DMA Calypte IP
**************

Expand Down
23 changes: 13 additions & 10 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,13 @@ The **Network Development Kit (NDK) for FPGAs** is a comprehensive framework des
for the rapid and efficient development of FPGA-accelerated network applications. Optimized
for scalability and high throughput, the NDK supports speeds up to **400 Gigabit Ethernet**.

.. note::

New features and changes in the latest version of NDK-FPGA are described in the `CHANGELOG.md file <https://github.com/CESNET/ndk-fpga/blob/devel/CHANGELOG.md>`_.

--------

The NDK provides a minimal example application. The **NDK Minimal Application**
The NDK-FPGA provides a minimal example application. The **NDK Minimal Application**
demonstrates how to build an FPGA application using the NDK and serves as a starting point
for your own development. The minimal application doesn't process network packets; it simply
sends and receives them. If a DMA IP is enabled (see the :ref:`DMA Module <ndk_dma>`),
Expand All @@ -44,7 +48,7 @@ Other example applications will be added in the future, stay tuned!

--------

In addition, the NDK provides a collection of reusable components, some of which are vendor and
In addition, the NDK-FPGA provides a collection of reusable components, some of which are vendor and
vendor- and tool-independent, while others are optimized for specific FPGA vendors and architectures.
For transferring packets (frames) and auxiliary data at such high rates, the NDK uses its own set of what are called
"multibuses" that can transfer multiple frames and values, respectively, within a single clock cycle.
Expand Down Expand Up @@ -87,7 +91,7 @@ it also provides converters:
--------

The NDK supports a wide range of FPGA cards, providing access to features such as DDR and HBM
The NDK-FPGA supports a wide range of FPGA cards, providing access to features such as DDR and HBM
memories, PCIe, and Ethernet in your applications. However, different applications may only
support a subset of these cards. A complete list of supported FPGA cards can be found below
(minimal app supports all of them).
Expand All @@ -114,20 +118,19 @@ support a subset of these cards. A complete list of supported FPGA cards can be

--------

NDK provides two implementations of DMA IPs:
NDK-FPGA supports two implementations of DMA IPs:

* DMA Medusa
* DMA Calypte

DMA Medusa is a state-of-the-art DMA module that supports up to 400Gbps of throughput to
DMA Medusa is a state-of-the-art DMA module that supports up to 400 Gbps of throughput to
host memory. DMA Calypte is an open-source low-latency DMA supporting throughput up
to tens of Gigabits per second. However, the DMA Calypte is still under development
and is not yet officially released (stay tuned).

.. warning::
to 100 Gbps.

The DMA Medusa IP is not included in the open-source version of the NDK. `You can obtain the full NDK package, including DMA Medusa IP and professional support, from our partner BrnoLogic. <https://support.brnologic.com/>`_
.. note::

The DMA Medusa IP is not part of the open-source NDK-FPGA.
For more information about IP availability, `see the section Partners in README.md file <https://github.com/CESNET/ndk-fpga/blob/devel/README.md#partners>`_.

.. image:: img/liberouter_logo.svg
:align: center
Expand Down

0 comments on commit e739dfb

Please sign in to comment.