doc/dmadevs: clarify naming constraints for idxd devices
PATCH 1/1 doc/dmadevs: clarify naming constraints for idxd devices
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
--- doc/guides/dmadevs/idxd.rst | 4 ++++ 1 file changed, 4 insertions(+)
doc/guides/dmadevs/idxd.rst +4 -0
@@ -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::
Signature · 1 line
2.43.0
Quoted 5 lines · Bruce Richardson
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.
Quoted 7 lines
[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<[email protected]>--- doc/guides/dmadevs/idxd.rst | 4 ++++ 1 file changed, 4 insertions(+)
Thomas Monjalon
Applied18/02/2025 16:44, Kevin Laatz:
Quoted 6 lines · Bruce Richardson
Quoted 5 lines
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.
Quoted 6 lines
Quoted 4 lines
[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<[email protected]>Acked-by Kevin Laatz <[email protected]>
Applied, thanks.