doc: describe naming of idxd devices

Since the test-dma-perf application identifies devices by name, include in the idxd driver documentation a note on device naming when vfio-pci. See also discussion in Bugzilla. Bugzilla ID: 1268 Signed-off-by: Bruce Richardson <[email protected]> Acked-by: Vipin Varghese <[email protected]>
DPDK · Jul 27, 2023 · 4334b7b · 4334b7b
1 parent 2627f96
commit 4334b7b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/guides/dmadevs/idxd.rst b/doc/guides/dmadevs/idxd.rst
@@ -123,6 +123,13 @@ For example::
 
 	$ dpdk-devbind.py -b vfio-pci 6a:01.0
 
+.. note::
+
+   Since each individual queue on the HW device is its own separate dmadev instance,
+   the internal DMA device name includes the HW queue ID as a suffix on the PCI address.
+   The above device when used by a DPDK application will be accessible via dmadevs with names:
+   ``0000:6a:01.0-q0``, ``00006a:01.0-q1``, etc.
+
 Device Probing and Initialization
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~