diff mbox series

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

Message ID 20240627053404.3049609-1-shaiq.wani@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series app/dma-perf: documentation update of DMA perf for idxd |

Checks

Context Check Description
ci/checkpatch success coding style OK
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
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Shaiq Wani June 27, 2024, 5:34 a.m. UTC 
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(+)

Comments

Bruce Richardson Oct. 4, 2024, 4:56 p.m. UTC | #1
Addressed 
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
diff mbox series

Patch

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.