[PATCH] app/dma-perf: documentation update of DMA perf for idxd

[PATCH] app/dma-perf: documentation update of DMA perf for idxd

[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] app/dma-perf: documentation update of DMA perf for idxd

[Bruce Richardson]

On Thu, Jun 27, 2024 at 05:34:04AM +0000, Shaiq Wani wrote:
> 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)
> +
> +

Nit: adding an extra line of whitespace here.

Also, the queue_id addition only applies if using idxd device with the
vfio-pci driver. If using the device with the idxd kernel driver - which is
the recommended way - the wq name is needed instead, IIRC.

/Bruce

[PATCH v2] 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>

v2 - addressed review comments.
---
 app/test-dma-perf/config.ini | 3 +++
 doc/guides/tools/dmaperf.rst | 2 ++
 2 files changed, 5 insertions(+)

diff --git a/app/test-dma-perf/config.ini b/app/test-dma-perf/config.ini
index a1222ae86c..799a800216 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: When using  idxd device (Device 0b25) with vfio-pci driver, add queue_id (lcore_dma=lcore10@0000:00:04.2-q0)
+;       When using  idxd device (Device 0b25) with kernel driver, add work_queue (lcore_dma=lcore4@wq0.0)
+
 [case1]
 type=DMA_MEM_COPY
 mem_size=10
diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst
index f68353b920..a689fa0baa 100644
--- a/doc/guides/tools/dmaperf.rst
+++ b/doc/guides/tools/dmaperf.rst
@@ -104,6 +104,8 @@ Configuration Parameters
 .. note::
 
    The mapping of lcore to DMA must be one-to-one and cannot be duplicated.
+   When using  idxd device (Device 0b25) with vfio-pci driver, add queue_id (lcore_dma=lcore10@0000:00:04.2-q0)
+   When using  idxd device (Device 0b25) with kernel driver, add work_queue (lcore_dma=lcore4@wq0.0)
 
 ``lcore``
   Specifies the lcore for CPU testing.
-- 
2.34.1

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

[Thomas Monjalon]

08/10/2024 08:52, Shaiq Wani:
> Added a note to avoid usage errors by end user.
> 
> Signed-off-by: Shaiq Wani <shaiq.wani@intel.com>
> 
> v2 - addressed review comments.
> ---
> --- 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: When using  idxd device (Device 0b25) with vfio-pci driver, add queue_id (lcore_dma=lcore10@0000:00:04.2-q0)
> +;       When using  idxd device (Device 0b25) with kernel driver, add work_queue (lcore_dma=lcore4@wq0.0)
> +
>  [case1]
>  type=DMA_MEM_COPY
>  mem_size=10
> diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst
> index f68353b920..a689fa0baa 100644
> --- a/doc/guides/tools/dmaperf.rst
> +++ b/doc/guides/tools/dmaperf.rst
> @@ -104,6 +104,8 @@ Configuration Parameters
>  .. note::
>  
>     The mapping of lcore to DMA must be one-to-one and cannot be duplicated.
> +   When using  idxd device (Device 0b25) with vfio-pci driver, add queue_id (lcore_dma=lcore10@0000:00:04.2-q0)
> +   When using  idxd device (Device 0b25) with kernel driver, add work_queue (lcore_dma=lcore4@wq0.0)

I suppose the double space is not needed.

Waiting for review from dma-perf maintainers.