From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8E0F2A0547; Tue, 3 Aug 2021 16:56:12 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1BD89411A7; Tue, 3 Aug 2021 16:56:12 +0200 (CEST) Received: from mail-io1-f53.google.com (mail-io1-f53.google.com [209.85.166.53]) by mails.dpdk.org (Postfix) with ESMTP id 4E75740E3C for ; Tue, 3 Aug 2021 16:56:10 +0200 (CEST) Received: by mail-io1-f53.google.com with SMTP id m13so24541623iol.7 for ; Tue, 03 Aug 2021 07:56:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=SheHQ9z01JFyrN6dW1mtjK4XUTmxyBbhAUiovvkf/io=; b=Zltz6T/xlgAhlrQ7MUYRG+4GVJpURprSZLfiUO8xdh2FasW/ugENp0/D2I01qEziUF k9y2rPxGYSGv807l8yOffyj8tGFQt0Juh2nOyWXwv9EdMwYmTwGCiBLpIODnUnglASsD NTZBAgY0jokAsM0oJ3bgNSgBFDkDVMqGMjFCSThGBoTBWqI0vhrio2dE4jADPg/CdsTx 7klTBS4m193UPVO00MDl/bcGAvSR04TIISxKVRRjzh/wVzvdbG/+8qU9pvVbrLIr8biE 6148AdkC6ljxFyXc796DcGBZtjPdvtGYdLQolD3hWvVMMSlAN1NUR18TFF9N2n9DOyhM 10Ww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=SheHQ9z01JFyrN6dW1mtjK4XUTmxyBbhAUiovvkf/io=; b=QEC4a9MwyFkQQTa11E5+Ra36eKDkRE/9yHf4ceIYHSzU4X82y2NQ9e45lwyUuh77te ka4JwEnxFW3WXDY1pF3XokwAdt4/kTHzOmJnLOJsQIn/rHYjK12RvqM+Aw9+TgBTR+pP 3Fw17OQkzQprCxFXye5VhdpOtlZ36x6taKE27JXHHNXeN4Mbw3YPoO5DmvNPU7zgFKk+ rpg0jssMKhyNJ/UN+rYhB6OzSK+O4Qb//4pFMS28pmM9dFPO2QlGT6FNGRkd1c/I1G/5 XWFjhZ9u6M/ZdMc/Jl0mnJBpo2f11QiZlCD2zluHK8Qi9srwefBNo/LKgrxkXD01xB1z M57A== X-Gm-Message-State: AOAM531+9KOuhwEfbcO+KmTlUEVTbxCAfydxlRMsAlA3PqhKawvyxrpu fotZfQ3yBZFvldVKnSCIqDfVjPcG0aA2Fx4Wxd8= X-Google-Smtp-Source: ABdhPJxoDqidGM8NxY4jlKJVfLQ7SGBcwRfA9CqGZqhwqIHWkFeln91sS0jN9ZQawoFNy1RV/ZldAXMS7JI/l18NfqM= X-Received: by 2002:a6b:db18:: with SMTP id t24mr290265ioc.163.1628002569612; Tue, 03 Aug 2021 07:56:09 -0700 (PDT) MIME-Version: 1.0 References: <1625231891-2963-1-git-send-email-fengchengwen@huawei.com> <1627990189-36531-1-git-send-email-fengchengwen@huawei.com> <1627990189-36531-6-git-send-email-fengchengwen@huawei.com> In-Reply-To: <1627990189-36531-6-git-send-email-fengchengwen@huawei.com> From: Jerin Jacob Date: Tue, 3 Aug 2021 20:25:43 +0530 Message-ID: To: Chengwen Feng Cc: Thomas Monjalon , Ferruh Yigit , "Richardson, Bruce" , Jerin Jacob , Andrew Rybchenko , dpdk-dev , =?UTF-8?Q?Morten_Br=C3=B8rup?= , Nipun Gupta , Hemant Agrawal , Maxime Coquelin , Honnappa Nagarahalli , David Marchand , Satananda Burla , Prasun Kapoor , "Ananyev, Konstantin" Content-Type: text/plain; charset="UTF-8" Subject: Re: [dpdk-dev] [PATCH v13 5/6] doc: add DMA device library guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On Tue, Aug 3, 2021 at 5:03 PM Chengwen Feng wrote: > > This patch adds dmadev library guide. > > Signed-off-by: Chengwen Feng > --- > 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. .. 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? > @@ -0,0 +1,278 @@ > + > + You could add an SPDX license and your company copyright as well. See other .svg files. Rest looks good to me. > + > + + width="206.19344mm" > + height="168.97479mm" > + viewBox="0 0 206.19344 168.97479" > + version="1.1" > + id="svg934" > + inkscape:version="1.1 (c68e22c387, 2021-05-23)" > + sodipodi:docname="dmadev_i1.svg" > + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" > + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" > + xmlns="http://www.w3.org/2000/svg" > + xmlns:svg="http://www.w3.org/2000/svg"> > + + id="namedview936" > + pagecolor="#ffffff" > + bordercolor="#666666" > + borderopacity="1.0" > + inkscape:pageshadow="2" > + inkscape:pageopacity="0.0" > + inkscape:pagecheckerboard="0" > + inkscape:document-units="mm" > + showgrid="false" > + fit-margin-top="0" > + fit-margin-left="0" > + fit-margin-right="0" > + fit-margin-bottom="0" > + inkscape:showpageshadow="false" > + inkscape:zoom="0.66635802" > + inkscape:cx="396.93377" > + inkscape:cy="480.22233" > + inkscape:window-width="1920" > + inkscape:window-height="1017" > + inkscape:window-x="1914" > + inkscape:window-y="-8" > + inkscape:window-maximized="1" > + inkscape:current-layer="layer1" /> > + + id="defs931"> > + + x="342.43954" > + y="106.56832" > + width="58.257381" > + height="137.82834" > + id="rect17873" /> > + > + + inkscape:label="Layer 1" > + inkscape:groupmode="layer" > + id="layer1" > + transform="translate(-0.13857517,-21.527306)"> > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.296755" > + id="rect31-9" > + width="50" > + height="28" > + x="0.13857517" > + y="21.527306" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1" > + transform="translate(-49.110795,15.205683)"> + x="54.136707" > + y="18.045568" > + id="tspan1277">virtual DMA + x="54.136707" > + y="26.865018" > + id="tspan1279">channel > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.296755" > + id="rect31-9-5" > + width="50" > + height="28" > + x="60.820271" > + y="21.69492" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1-4" > + transform="translate(11.570899,15.373298)"> + x="54.136707" > + y="18.045568" > + id="tspan1281">virtual DMA + x="54.136707" > + y="26.865018" > + id="tspan1283">channel > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.296755" > + id="rect31-9-5-3" > + width="50" > + height="28" > + x="150.74168" > + y="21.694923" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1-4-8" > + transform="translate(101.49231,15.373299)"> + x="54.136707" > + y="18.045568" > + id="tspan1285">virtual DMA + x="54.136707" > + y="26.865018" > + id="tspan1287">channel > + + xml:space="preserve" > + transform="matrix(0.26458333,0,0,0.26458333,-0.04940429,21.408845)" > + id="text17871" > + style="font-style:normal;font-weight:normal;font-size:40px;line-height:1.25;font-family:sans-serif;white-space:pre;shape-inside:url(#rect17873);fill:#000000;fill-opacity:1;stroke:none" /> > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.218145" > + id="rect31-9-5-8" > + width="38.34557" > + height="19.729115" > + x="35.854393" > + y="79.215172" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1-4-3" > + transform="translate(-13.394978,72.893551)"> + x="54.136707" > + y="18.045568" > + id="tspan1289">dmadev > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.307089" > + id="rect31-9-5-8-0" > + width="60.902534" > + height="24.616455" > + x="24.763887" > + y="117.93796" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1-4-3-76" > + transform="translate(-24.485484,111.61634)"> + x="54.136707" > + y="18.045568" > + id="tspan1291">hardware DMA + x="54.136707" > + y="26.865018" > + id="tspan1293">channel > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.307089" > + id="rect31-9-5-8-0-6" > + width="60.902534" > + height="24.616455" > + x="145.42947" > + y="117.74998" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1-4-3-76-7" > + transform="translate(96.180071,111.42836)"> + x="54.136707" > + y="18.045568" > + id="tspan1295">hardware DMA + x="54.136707" > + y="26.865018" > + id="tspan1297">channel > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.307089" > + id="rect31-9-5-8-0-4" > + width="60.902534" > + height="24.616455" > + x="87.923386" > + y="165.88565" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1-4-3-76-4" > + transform="translate(38.674008,159.56408)"> + x="54.136707" > + y="18.045568" > + id="tspan1299">hardware DMA + x="54.136707" > + y="26.865018" > + id="tspan1301">controller > + + style="fill:#c9c9ff;fill-opacity:1;stroke-width:0.218145" > + id="rect31-9-5-8-5" > + width="38.34557" > + height="19.729115" > + x="156.87534" > + y="79.215179" > + ry="0" /> > + + xml:space="preserve" > + style="font-style:normal;font-weight:normal;font-size:7.05556px;line-height:1.25;font-family:sans-serif;white-space:pre;inline-size:70.1114;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583" > + x="54.136707" > + y="18.045568" > + id="text803-1-4-3-7" > + transform="translate(107.62597,72.893552)"> + x="54.136707" > + y="18.045568" > + id="tspan1303">dmadev > + + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" > + d="M 77.744878,49.69492 60.71719,79.215172" > + id="path45308" > + inkscape:connector-type="polyline" > + inkscape:connector-curvature="0" > + inkscape:connection-start="#rect31-9-5" > + inkscape:connection-end="#rect31-9-5-8" /> > + + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" > + d="m 32.952235,49.527306 16.56935,29.687866" > + id="path45310" > + inkscape:connector-type="polyline" > + inkscape:connector-curvature="0" > + inkscape:connection-start="#rect31-9" > + inkscape:connection-end="#rect31-9-5-8" /> > + + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" > + d="m 55.072222,98.944286 0.08673,18.993674" > + id="path45312" > + inkscape:connector-type="polyline" > + inkscape:connector-curvature="0" > + inkscape:connection-start="#rect31-9-5-8" > + inkscape:connection-end="#rect31-9-5-8-0" /> > + + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" > + d="m 176.00783,98.944294 -0.0768,18.805686" > + id="path45320" > + inkscape:connector-type="polyline" > + inkscape:connector-curvature="0" > + inkscape:connection-start="#rect31-9-5-8-5" > + inkscape:connection-end="#rect31-9-5-8-0-6" /> > + + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" > + d="m 161.17651,142.36643 -28.09763,23.51922" > + id="path45586" > + inkscape:connector-type="polyline" > + inkscape:connector-curvature="0" > + inkscape:connection-start="#rect31-9-5-8-0-6" > + inkscape:connection-end="#rect31-9-5-8-0-4" /> > + + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" > + d="m 71.42827,142.55441 30.73327,23.33124" > + id="path45588" > + inkscape:connector-type="polyline" > + inkscape:connector-curvature="0" > + inkscape:connection-start="#rect31-9-5-8-0" > + inkscape:connection-end="#rect31-9-5-8-0-4" /> > + + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" > + d="m 175.82205,49.694923 0.16945,29.520256" > + id="path45956" > + inkscape:connector-type="polyline" > + inkscape:connector-curvature="0" > + inkscape:connection-start="#rect31-9-5-3" > + inkscape:connection-end="#rect31-9-5-8-5" /> > + > + > diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst > index 2dce507..0abea06 100644 > --- a/doc/guides/prog_guide/index.rst > +++ b/doc/guides/prog_guide/index.rst > @@ -29,6 +29,7 @@ Programmer's Guide > regexdev > rte_security > rawdev > + dmadev > link_bonding_poll_mode_drv_lib > timer_lib > hash_lib > -- > 2.8.1 >