public inbox for dev@dpdk.org
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
	Dimon Zhao <dimon.zhao@nebula-matrix.com>,
	Kyo Liu <kyo.liu@nebula-matrix.com>,
	Leon Yu <leon.yu@nebula-matrix.com>,
	Sam Chen <sam.chen@nebula-matrix.com>
Subject: [PATCH] doc: fix documentation for NBL PMD
Date: Mon,  2 Mar 2026 12:21:44 -0800	[thread overview]
Message-ID: <20260302202144.253145-1-stephen@networkplumber.org> (raw)

The revised documentation had some issues with formatting and
setting up vfio-pci was not described. Use the existing ENA
documentation as a template to resolve these discrepancies.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/nics/nbl.rst | 42 +++++++++++++++++++----------------------
 1 file changed, 19 insertions(+), 23 deletions(-)

diff --git a/doc/guides/nics/nbl.rst b/doc/guides/nics/nbl.rst
index a9f439ae96..da4604781e 100644
--- a/doc/guides/nics/nbl.rst
+++ b/doc/guides/nics/nbl.rst
@@ -78,40 +78,36 @@ it is necessary to force I/O virtual address (IOVA)
 to be mapped to physical address (PA)
 with the EAL command line option ``--iova-mode=pa``.
 
-Only PF supports Coexistence Between DPDK And Kernel Driver, VF does not.
+Only PF supports coexistence between DPDK and kernel driver; VF does not.
 
 
 Prerequisites
 -------------
 
-- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>`
-  to setup the basic DPDK environment.
+#. Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>`
+   to setup the basic DPDK environment.
 
-- Learn about `Nebulamatrix Series NICs
-  <https://www.nebula-matrix.com/main>`_.
+#. NBL PMD requires the ``vfio-pci`` kernel driver.
+   The ``igb_uio`` and ``uio_pci_generic`` drivers are not supported.
 
+   Insert the ``vfio-pci`` kernel module using the command ``modprobe vfio-pci``.
+   Please make sure that IOMMU is enabled in your system,
+   or use ``vfio-pci`` in ``noiommu`` mode::
 
-Multiple Processes
-------------------
+     echo 1 > /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
 
-The NBL PMD does not support multiple processes.
+   Note that VF requires ``vfio-pci`` in ``noiommu`` mode
+   when no IOMMU is available on the system.
 
+#. Bind the intended NBL device to ``vfio-pci``.
 
-Limitations or Known Issues
----------------------------
-
-32-bit architectures are not supported.
-
-Windows and BSD are not supported yet.
-
-**igb_uio Driver Support**
+#. Learn about `Nebulamatrix Series NICs
+   <https://www.nebula-matrix.com/main>`_.
 
-The ``igb_uio`` driver is not supported.
 
-**uio_pci_generic Driver Support**
-
-The ``uio_pci_generic`` driver is not supported.
-
-**VFIO no-IOMMU mode**
-If there is no IOMMU available on the system, VF must use ``vfio`` driver in ``noiommu`` mode.
+Limitations or Known Issues
+---------------------------
 
+- 32-bit architectures are not supported.
+- Windows and BSD are not supported yet.
+- Multiple processes are not supported.
-- 
2.51.0


             reply	other threads:[~2026-03-02 20:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-02 20:21 Stephen Hemminger [this message]
2026-03-03  1:49 ` 回复:[PATCH] doc: fix documentation for NBL PMD Dimon
2026-03-03 14:37 ` [PATCH] " Stephen Hemminger

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260302202144.253145-1-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=dev@dpdk.org \
    --cc=dimon.zhao@nebula-matrix.com \
    --cc=kyo.liu@nebula-matrix.com \
    --cc=leon.yu@nebula-matrix.com \
    --cc=sam.chen@nebula-matrix.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox