diff mbox series

doc/dmadevs: clarify naming constraints for idxd devices

Message ID 20250131144915.2129736-1-bruce.richardson@intel.com (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series doc/dmadevs: clarify naming constraints for idxd devices |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS

Commit Message

Bruce Richardson Jan. 31, 2025, 2:49 p.m. UTC 
The requirement to have DPDK in the DSA wq name is given in the idxd
chapter section 5.3.3 [1]. However, that information should also be
given in section 5.3.1 [2] where we list out the fields to be set and
what values they should have.

[1] https://doc.dpdk.org/guides-24.11/dmadevs/idxd.html#device-probing-and-initialization
[2] https://doc.dpdk.org/guides-24.11/dmadevs/idxd.html#intelreg-dsa-devices-using-idxd-kernel-driver

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/dmadevs/idxd.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Kevin Laatz Feb. 18, 2025, 3:44 p.m. UTC | #1 
On 31/01/2025 14:49, Bruce Richardson wrote:
> The requirement to have DPDK in the DSA wq name is given in the idxd
> chapter section 5.3.3 [1]. However, that information should also be
> given in section 5.3.1 [2] where we list out the fields to be set and
> what values they should have.
>
> [1]https://doc.dpdk.org/guides-24.11/dmadevs/idxd.html#device-probing-and-initialization
> [2]https://doc.dpdk.org/guides-24.11/dmadevs/idxd.html#intelreg-dsa-devices-using-idxd-kernel-driver
>
> Signed-off-by: Bruce Richardson<bruce.richardson@intel.com>
> ---
>   doc/guides/dmadevs/idxd.rst | 4 ++++
>   1 file changed, 4 insertions(+)

Acked-by: Kevin Laatz <kevin.laatz@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/dmadevs/idxd.rst b/doc/guides/dmadevs/idxd.rst
index cb8f1fe729..d1ac6b770a 100644
--- a/doc/guides/dmadevs/idxd.rst
+++ b/doc/guides/dmadevs/idxd.rst
@@ -57,6 +57,8 @@  The internal engines, which do the copies or other operations,
 and the work-queues, which are used by applications to assign work to the device,
 need to be assigned to groups, and the various other configuration options,
 such as priority or queue depth, need to be set for each queue.
+Furthermore, to mark a work-queue for use by DPDK, so it will be picked up in device scans,
+the queue must be assigned a name starting with either ``dpdk_`` or the DPDK application's ``file-prefix`` parameter (default ``rte_``).
 
 To assign an engine to a group::
 
@@ -71,6 +73,8 @@  Some configuration options include:
 * wq-size: the size of the WQ. Sum of all WQ sizes must be less that the total-size defined by the device.
 * type: WQ type (kernel/mdev/user). Determines how the device is presented.
 * name: identifier given to the WQ.
+  For DPDK to automatically find and use the queue as a DMA device,
+  the queue must be assigned a name starting with either ``dpdk_`` or the DPDK application's ``file-prefix`` parameter (default ``rte_``).
 
 Example configuration for a work queue::