doc: fix documentation for NBL PMD
PATCH 1/1 doc: fix documentation for NBL PMD
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.
--- doc/guides/nics/nbl.rst | 42 +++++++++++++++++++---------------------- 1 file changed, 19 insertions(+), 23 deletions(-)
doc/guides/nics/nbl.rst +19 -23
@@ -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.
Signature · 1 line
2.51.0
Hi Stephen,
Thank you for the patch and the detailed improvements to the NBL documentation.
The changes look good to me.
------------------------------------------------------------------
发件人:Stephen Hemminger <[email protected]>
发送时间:2026年3月3日(周二) 04:21
收件人:dev<[email protected]>
抄 送:Stephen Hemminger<[email protected]>; Dimon<[email protected]>; Kyo Liu<[email protected]>; Leon<[email protected]>; Sam<[email protected]> 主 题:[PATCH] doc: fix documentation for NBL PMD
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.
--- doc/guides/nics/nbl.rst | 42 +++++++++++++++++++---------------------- 1 file changed, 19 insertions(+), 23 deletions(-)
doc/guides/nics/nbl.rst +19 -23
@@ -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> <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> <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.
Signature · 1 line
2.51.0
Stephen Hemminger
AppliedQuoted 6 lines · On Mon, 2 Mar 2026 12:21:44 -0800 Stephen Hemminger…
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 <[email protected]>---
Queued to next-net