[PATCH] doc: documentation update for idxd driver

[PATCH] doc: documentation update for idxd driver

[Shaiq Wani]

Added a note to avoid usage errors by end user.

Signed-off-by: Shaiq Wani <shaiq.wani@intel.com>
---
 app/test-dma-perf/config.ini | 3 +++
 doc/guides/tools/dmaperf.rst | 1 +
 2 files changed, 4 insertions(+)

diff --git a/app/test-dma-perf/config.ini b/app/test-dma-perf/config.ini
index a1222ae86c..5008103979 100644
--- a/app/test-dma-perf/config.ini
+++ b/app/test-dma-perf/config.ini
@@ -61,6 +61,9 @@
 ; If you do not specify a result file, one will be generated with the same name as the configuration
 ; file, with the addition of "_result.csv" at the end.
 
+; Note: For idxd device (Device 0b25), add queue_id (lcore_dma=lcore10@0000:00:04.2-q0)
+
+
 [case1]
 type=DMA_MEM_COPY
 mem_size=10
diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst
index 6f85fceb8a..c97810a66d 100644
--- a/doc/guides/tools/dmaperf.rst
+++ b/doc/guides/tools/dmaperf.rst
@@ -104,6 +104,7 @@ Configuration Parameters
 .. note::
 
    The mapping of lcore to DMA must be one-to-one and cannot be duplicated.
+   For idxd device (Device 0b25), add queue_id (lcore_dma=lcore10@0000:00:04.2-q0)
 
 ``lcore``
   Specifies the lcore for CPU testing.
-- 
2.34.1

Re: [PATCH] doc: documentation update for idxd driver

[Stephen Hemminger]

On Thu, 27 Jun 2024 04:42:14 +0000
Shaiq Wani <shaiq.wani@intel.com> wrote:

> Added a note to avoid usage errors by end user.
> 
> Signed-off-by: Shaiq Wani <shaiq.wani@intel.com>

If it is going in the documentation, it needs more explanation as to what
that parameters do.

Re: [PATCH] doc: documentation update for idxd driver

[Thomas Monjalon]

27/06/2024 17:04, Stephen Hemminger:
> On Thu, 27 Jun 2024 04:42:14 +0000
> Shaiq Wani <shaiq.wani@intel.com> wrote:
> 
> > Added a note to avoid usage errors by end user.
> > 
> > Signed-off-by: Shaiq Wani <shaiq.wani@intel.com>
> 
> If it is going in the documentation, it needs more explanation as to what
> that parameters do.

I would prefer not having such driver-specific requirement.