[dpdk-dev] [PATCH v13 5/6] doc: add DMA device library guide

fengchengwen fengchengwen at huawei.com
Thu Aug 5 15:15:42 CEST 2021


On 2021/8/3 22:55, Jerin Jacob wrote:
> On Tue, Aug 3, 2021 at 5:03 PM Chengwen Feng <fengchengwen at huawei.com> wrote:
>>
>> This patch adds dmadev library guide.
>>
>> Signed-off-by: Chengwen Feng <fengchengwen at huawei.com>
>> ---
>>  doc/guides/prog_guide/dmadev.rst        | 126 +++++++++++++++
> 
> 
> doc build has following warning in my machine
> 
> ninja: Entering directory `build'
> [2789/2813] Generating html_guides with a custom command
> /export/dpdk.org/doc/guides/prog_guide/dmadev.rst:24: WARNING: Figure
> caption must be a paragraph or empty comment.
will fix in v14

> 
> .. figure:: img/dmadev_i1.*
> 
>    The model of the DMA framework built on
> 
>  * The DMA controller could have multiple hardware DMA channels (aka. hardware
>    DMA queues), each hardware DMA channel should be represented by a dmadev.
>  * The dmadev could create multiple virtual DMA channels, each virtual DMA
>    channel represents a different transfer context. The DMA operation request
>    must be submitted to the virtual DMA channel. e.g. Application could create
>    virtual DMA channel 0 for memory-to-memory transfer scenario, and create
>    virtual DMA channel 1 for memory-to-device transfer scenario.
> [2813/2813] Linking target app/dpdk-test-pipeline
> 
>> new file mode 100644
>> index 0000000..b305beb
>> --- /dev/null
>> +++ b/doc/guides/prog_guide/img/dmadev_i1.svg
> 
> why _i1 in the name?

OK, maybe dmadev.svg is enough.

> 
> 
>> @@ -0,0 +1,278 @@
>> +<?xml version="1.0" encoding="UTF-8" standalone="no"?>
>> +<!-- Created with Inkscape (http://www.inkscape.org/) -->
> 
> You could add an SPDX license and your company copyright as well.
> See other .svg files.

OK

> 
> 
> Rest looks good to me.
> 
> 
>> +

[snip]

>>
> .
> 


More information about the dev mailing list