From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH] doc/dmadevs: clarify naming constraints for idxd devices
Date: Fri, 31 Jan 2025 14:49:15 +0000 [thread overview]
Message-ID: <20250131144915.2129736-1-bruce.richardson@intel.com> (raw)
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(+)
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::
--
2.43.0
reply other threads:[~2025-01-31 14:49 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20250131144915.2129736-1-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
/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).