[PATCH v2] doc: documentation update for idxd driver

[fengchengwen]

On 2024/11/20 1:42, Thomas Monjalon wrote:
> 08/10/2024 08:52, Shaiq Wani:
>> Added a note to avoid usage errors by end user.
>>
>> Signed-off-by: Shaiq Wani <shaiq.wani at 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 at 0000:00:04.2-q0)
>> +;       When using  idxd device (Device 0b25) with kernel driver, add work_queue (lcore_dma=lcore4 at 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 at 0000:00:04.2-q0)
>> +   When using  idxd device (Device 0b25) with kernel driver, add work_queue (lcore_dma=lcore4 at wq0.0)
> 
> I suppose the double space is not needed.
> 
> Waiting for review from dma-perf maintainers.

NAK

The dmadev name varies according to the manufacturer. This information should located
in specific dma driver's document.

And actually the 'doc/guides/dmadevs/idxd.rst' already included above information.

> 
>