[PATCH] doc/dmadevs: add note clarifying naming of idxd devices

[PATCH] doc/dmadevs: add note clarifying naming of idxd devices

[Bruce Richardson]

Since the test-dma-perf application identifies devices by name, include
in the idxd driver documentation a note on device naming when vfio-pci.
See also discussion in bugzilla[1].

[1] https://bugs.dpdk.org/show_bug.cgi?id=1268

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/dmadevs/idxd.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/dmadevs/idxd.rst b/doc/guides/dmadevs/idxd.rst
index ea101031bf..a9a788ac56 100644
--- a/doc/guides/dmadevs/idxd.rst
+++ b/doc/guides/dmadevs/idxd.rst
@@ -123,6 +123,13 @@ For example::
 
 	$ dpdk-devbind.py -b vfio-pci 6a:01.0
 
+.. note::
+
+  Since each individual queue on the HW device is its own separate dmadev instance,
+  the internal DMA device name includes the HW queue id as a suffix on the PCI id.
+  The above device when used by a DPDK application will be accessible via dmadevs with names:
+  ``0000:6a:01.0-q0``, ``00006a:01.0-q1``, etc.
+
 Device Probing and Initialization
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.39.2

Re: [PATCH] doc/dmadevs: add note clarifying naming of idxd devices

[Bruce Richardson]

On Tue, Jul 25, 2023 at 05:16:29PM +0100, Bruce Richardson wrote:
> Since the test-dma-perf application identifies devices by name, include
> in the idxd driver documentation a note on device naming when vfio-pci.
> See also discussion in bugzilla[1].
> 
> [1] https://bugs.dpdk.org/show_bug.cgi?id=1268
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
Note, although I reference bugzilla here, I don't consider this a bugfix,
so I've not included a fixes tag and official bugzilla id etc. It's instead
a note clarifying the expected behaviour.

/Bruce

RE: [PATCH] doc/dmadevs: add note clarifying naming of idxd devices

[Varghese, Vipin]

[AMD Official Use Only - General]

> -----Original Message-----
> From: Bruce Richardson <bruce.richardson@intel.com>
> Sent: Tuesday, July 25, 2023 9:49 PM
> To: dev@dpdk.org
> Cc: Varghese, Vipin <Vipin.Varghese@amd.com>
> Subject: Re: [PATCH] doc/dmadevs: add note clarifying naming of idxd devices
>
> Caution: This message originated from an External Source. Use proper
> caution when opening attachments, clicking links, or responding.
>
>
> On Tue, Jul 25, 2023 at 05:16:29PM +0100, Bruce Richardson wrote:
> > Since the test-dma-perf application identifies devices by name,
> > include in the idxd driver documentation a note on device naming when
> vfio-pci.
> > See also discussion in bugzilla[1].
> >
> > [1] https://bugs.dpdk.org/show_bug.cgi?id=1268
> >
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > ---
> Note, although I reference bugzilla here, I don't consider this a bugfix, so I've
> not included a fixes tag and official bugzilla id etc. It's instead a note clarifying
> the expected behaviour.

App/dma-perf got integrated into DPDK via `https://patches.dpdk.org/project/dpdk/patch/20230629131455.52732-1-cheng1.jiang@intel.com/`. The expectation is that, it is tried and tested for hardware dma, sw skeleton dma and cpu memcpy.
Happy to acknowledge the change as it helps the DPDK community.

Acked-by: Vipin Varghese <vipin.varghese@amd.com>

>
> /Bruce

Re: [PATCH] doc/dmadevs: add note clarifying naming of idxd devices

[Thomas Monjalon]

> > > Since the test-dma-perf application identifies devices by name,
> > > include in the idxd driver documentation a note on device naming when
> > vfio-pci.
> > > See also discussion in bugzilla[1].
> > >
> > > [1] https://bugs.dpdk.org/show_bug.cgi?id=1268

Bugzilla ID: 1268

> > >
> > > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > > ---
> > Note, although I reference bugzilla here, I don't consider this a bugfix, so I've
> > not included a fixes tag and official bugzilla id etc. It's instead a note clarifying
> > the expected behaviour.
> 
> App/dma-perf got integrated into DPDK via `https://patches.dpdk.org/project/dpdk/patch/20230629131455.52732-1-cheng1.jiang@intel.com/`. The expectation is that, it is tried and tested for hardware dma, sw skeleton dma and cpu memcpy.
> Happy to acknowledge the change as it helps the DPDK community.
> 
> Acked-by: Vipin Varghese <vipin.varghese@amd.com>

Replaced PCI id with PCI address,
and applied, thanks.