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 <dm...@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
