DPDK patches and discussions
 help / color / mirror / Atom feed
From: Dean Marx <dmarx@iol.unh.edu>
To: probb@iol.unh.edu, luca.vizzarro@arm.com,
	yoan.picchi@foss.arm.com, Honnappa.Nagarahalli@arm.com,
	paul.szczepanek@arm.com
Cc: dev@dpdk.org, Dean Marx <dmarx@iol.unh.edu>
Subject: [PATCH v3 4/4] dts: add sr-iov section to docs
Date: Wed,  2 Jul 2025 12:23:31 -0400	[thread overview]
Message-ID: <20250702162331.352313-4-dmarx@iol.unh.edu> (raw)
In-Reply-To: <20250702162331.352313-1-dmarx@iol.unh.edu>

Add a section to the dts.rst file explaining how to
enable SR-IOV mode on an environment, as well
as any additional steps needed for virtual
function configuration.

Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
---
 doc/guides/tools/dts.rst | 46 ++++++++++++++++++++++++++++++++++++++++
 dts/README.md            |  2 +-
 2 files changed, 47 insertions(+), 1 deletion(-)

diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index 7e68159571..5dd858a7c8 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -217,6 +217,52 @@ There are two areas that need to be set up on a System Under Test:
 
       sudo usermod -aG sudo <sut_user>
 
+#. **SR-IOV**
+
+   Before configuring virtual functions, SR-IOV support must be enabled in the system BIOS/UEFI:
+
+   #. Reboot the system and enter BIOS/UEFI settings.
+   #. Locate the SR-IOV option (often under PCIe or Advanced settings).
+   #. Set SR-IOV to **Enabled** and save changes.
+
+   For Mellanox environments, the following additional setup steps are required:
+
+   #. **Install mstflint tools** (if not already installed):
+
+      .. code-block:: bash
+
+         sudo apt install mstflint        # On Debian/Ubuntu
+         sudo yum install mstflint        # On RHEL/CentOS
+
+   #. **Start the MST service**:
+
+      .. code-block:: bash
+
+         sudo mst start
+
+   #. **List Mellanox devices**:
+
+      .. code-block:: bash
+
+         sudo mst status
+
+      This will output paths such as ``/dev/mst/mt4121_pciconf0`` and possibly additional functions (e.g., ``pciconf0.1``).
+
+   #. **Enable SR-IOV and configure number of VFs**:
+
+      .. code-block:: bash
+
+         sudo mlxconfig -d /dev/mst/mt4121_pciconf0 set SRIOV_EN=1 NUM_OF_VFS=8
+         sudo mlxconfig -d /dev/mst/mt4121_pciconf0.1 set SRIOV_EN=1 NUM_OF_VFS=8
+
+      Replace the device names with those matching your setup (from ``mst status``). The number of VFs can be adjusted as needed.
+
+   #. **Reboot the system**:
+
+      .. code-block:: bash
+
+         sudo reboot now
+
 
 Setting up Traffic Generator Node
 ---------------------------------
diff --git a/dts/README.md b/dts/README.md
index 224a7aa20b..73c56ec504 100644
--- a/dts/README.md
+++ b/dts/README.md
@@ -33,7 +33,7 @@ its own ports.
 3. DTS uses ssh key auth to control the nodes. Copy your ssh keys to the TG and SUT:
     ssh-copy-id dts@{your host}.
 
-For additional detail, please refer to [dts.rst](doc/guides/tools/dts.rst)
+For additional detail on how to set up a valid DPDK environment, please refer to [dts.rst](doc/guides/tools/dts.rst)
 
 # DTS Configuration
 
-- 
2.49.0


  parent reply	other threads:[~2025-07-02 16:23 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-17 20:13 [PATCH v1] dts: add virtual functions to framework Dean Marx
2025-06-26 15:27 ` [PATCH v2 1/4] " Dean Marx
2025-06-26 15:27   ` [PATCH v2 2/4] dts: remove unnecessary testpmd verification Dean Marx
2025-06-26 15:27   ` [PATCH v2 3/4] dts: modify existing suites to work with VFs Dean Marx
2025-07-02 16:23     ` [PATCH v3 1/4] dts: add virtual functions to framework Dean Marx
2025-07-02 16:23       ` [PATCH v3 2/4] dts: remove unnecessary testpmd verification Dean Marx
2025-07-02 16:23       ` [PATCH v3 3/4] dts: add physical function capability check Dean Marx
2025-07-02 16:23       ` Dean Marx [this message]
2025-07-02 16:48       ` [PATCH v3 1/4] dts: add virtual functions to framework Dean Marx
2025-06-26 15:27   ` [PATCH v2 4/4] dts: add physical function capability check Dean Marx

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=20250702162331.352313-4-dmarx@iol.unh.edu \
    --to=dmarx@iol.unh.edu \
    --cc=Honnappa.Nagarahalli@arm.com \
    --cc=dev@dpdk.org \
    --cc=luca.vizzarro@arm.com \
    --cc=paul.szczepanek@arm.com \
    --cc=probb@iol.unh.edu \
    --cc=yoan.picchi@foss.arm.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;
as well as URLs for NNTP newsgroup(s).