Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/96304/?format=api
{ "id": 96304, "url": "http://patchwork.dpdk.org/api/patches/96304/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/1627357200-15291-3-git-send-email-fengchengwen@huawei.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1627357200-15291-3-git-send-email-fengchengwen@huawei.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1627357200-15291-3-git-send-email-fengchengwen@huawei.com", "date": "2021-07-27T03:40:00", "name": "[v11,2/2] doc: add dmadev library guide", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "a3476165d579af7bf17713bdcea669fb05bb8b7b", "submitter": { "id": 2146, "url": "http://patchwork.dpdk.org/api/people/2146/?format=api", "name": "fengchengwen", "email": "fengchengwen@huawei.com" }, "delegate": { "id": 1, "url": "http://patchwork.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/1627357200-15291-3-git-send-email-fengchengwen@huawei.com/mbox/", "series": [ { "id": 18004, "url": "http://patchwork.dpdk.org/api/series/18004/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=18004", "date": "2021-07-27T03:39:58", "name": "support dmadev", "version": 11, "mbox": "http://patchwork.dpdk.org/series/18004/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/96304/comments/", "check": "fail", "checks": "http://patchwork.dpdk.org/api/patches/96304/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 02113A0C4B;\n\tTue, 27 Jul 2021 05:43:57 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id CAD9B410F9;\n\tTue, 27 Jul 2021 05:43:52 +0200 (CEST)", "from szxga08-in.huawei.com (szxga08-in.huawei.com [45.249.212.255])\n by mails.dpdk.org (Postfix) with ESMTP id B08B3410EE\n for <dev@dpdk.org>; Tue, 27 Jul 2021 05:43:49 +0200 (CEST)", "from dggemv703-chm.china.huawei.com (unknown [172.30.72.56])\n by szxga08-in.huawei.com (SkyGuard) with ESMTP id 4GYjDK4PlYz1CPDQ;\n Tue, 27 Jul 2021 11:37:53 +0800 (CST)", "from dggpeml500024.china.huawei.com (7.185.36.10) by\n dggemv703-chm.china.huawei.com (10.3.19.46) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id\n 15.1.2176.2; Tue, 27 Jul 2021 11:43:47 +0800", "from localhost.localdomain (10.67.165.24) by\n dggpeml500024.china.huawei.com (7.185.36.10) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id\n 15.1.2176.2; Tue, 27 Jul 2021 11:43:47 +0800" ], "From": "Chengwen Feng <fengchengwen@huawei.com>", "To": "<thomas@monjalon.net>, <ferruh.yigit@intel.com>,\n <bruce.richardson@intel.com>, <jerinj@marvell.com>, <jerinjacobk@gmail.com>,\n <andrew.rybchenko@oktetlabs.ru>", "CC": "<dev@dpdk.org>, <mb@smartsharesystems.com>, <nipun.gupta@nxp.com>,\n <hemant.agrawal@nxp.com>, <maxime.coquelin@redhat.com>,\n <honnappa.nagarahalli@arm.com>, <david.marchand@redhat.com>,\n <sburla@marvell.com>, <pkapoor@marvell.com>, <konstantin.ananyev@intel.com>", "Date": "Tue, 27 Jul 2021 11:40:00 +0800", "Message-ID": "<1627357200-15291-3-git-send-email-fengchengwen@huawei.com>", "X-Mailer": "git-send-email 2.8.1", "In-Reply-To": "<1627357200-15291-1-git-send-email-fengchengwen@huawei.com>", "References": "<1625231891-2963-1-git-send-email-fengchengwen@huawei.com>\n <1627357200-15291-1-git-send-email-fengchengwen@huawei.com>", "MIME-Version": "1.0", "Content-Type": "text/plain", "X-Originating-IP": "[10.67.165.24]", "X-ClientProxiedBy": "dggems704-chm.china.huawei.com (10.3.19.181) To\n dggpeml500024.china.huawei.com (7.185.36.10)", "X-CFilter-Loop": "Reflected", "Subject": "[dpdk-dev] [PATCH v11 2/2] doc: add dmadev library guide", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "This patch adds dmadev library guide.\n\nSigned-off-by: Chengwen Feng <fengchengwen@huawei.com>\n---\n doc/guides/prog_guide/dmadev.rst | 123 +++++++++++++++++++++++++++++++++++++++\n doc/guides/prog_guide/index.rst | 1 +\n 2 files changed, 124 insertions(+)\n create mode 100644 doc/guides/prog_guide/dmadev.rst", "diff": "diff --git a/doc/guides/prog_guide/dmadev.rst b/doc/guides/prog_guide/dmadev.rst\nnew file mode 100644\nindex 0000000..5bad598\n--- /dev/null\n+++ b/doc/guides/prog_guide/dmadev.rst\n@@ -0,0 +1,123 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright 2021 HiSilicon Limited\n+\n+DMA Device Library\n+====================\n+\n+The DMA library provides a DMA device framework for management and provisioning\n+of hardware and software DMA poll mode drivers, defining generic APIs which\n+support a number of different DMA operations.\n+\n+\n+Design Principles\n+-----------------\n+\n+The DMA library follows the same basic principles as those used in DPDK's\n+Ethernet Device framework and the RegEx framework. The DMA framework provides\n+a generic DMA device framework which supports both physical (hardware)\n+and virtual (software) DMA devices as well as a generic DMA API which allows\n+DMA devices to be managed and configured and supports DMA operations to be\n+provisioned on DMA poll mode driver.\n+\n+Figure below outlines the model of the DMA framework built on:\n+\n+.. code-block:: console\n+\n+ +-------------+ +-------------+ +-------------+\n+ | virtual DMA | | virtual DMA | | virtual DMA |\n+ | channel | | channel | | channel |\n+ +-------------+ +-------------+ +-------------+\n+ | | |\n+ ------------------- |\n+ | |\n+ +----------+ +----------+\n+ | dmadev | | dmadev |\n+ +----------+ +----------+\n+ | |\n+ +--------------+ +--------------+\n+ | hardware DMA | | hardware DMA |\n+ | channel | | channel |\n+ +--------------+ +--------------+\n+ | |\n+ --------------------------------\n+ |\n+ +--------------+\n+ | hardware DMA |\n+ | controller |\n+ +--------------+\n+\n+ * The DMA controller could have multiple hardware DMA channels (aka. hardware\n+ DMA queues), each hardware DMA channel should be represented by a dmadev.\n+ * The dmadev could create multiple virtual DMA channels, each virtual DMA\n+ channel represents a different transfer context. The DMA operation request\n+ must be submitted to the virtual DMA channel. e.g. Application could create\n+ virtual DMA channel 0 for memory-to-memory transfer scenario, and create\n+ virtual DMA channel 1 for memory-to-device transfer scenario.\n+\n+\n+Device Management\n+-----------------\n+\n+Device Creation\n+~~~~~~~~~~~~~~~\n+\n+Physical DMA controller is discovered during the PCI probe/enumeration of the\n+EAL function which is executed at DPDK initialization, based on their PCI\n+device identifier, each unique PCI BDF (bus/bridge, device, function). Specific\n+physical DMA controller, like other physical devices in DPDK can be listed using\n+the EAL command line options.\n+\n+And then dmadevs are dynamically allocated by rte_dmadev_pmd_allocate() based on\n+the number of hardware DMA channels.\n+\n+\n+Device Identification\n+~~~~~~~~~~~~~~~~~~~~~\n+\n+Each DMA device, whether physical or virtual is uniquely designated by two\n+identifiers:\n+\n+- A unique device index used to designate the DMA device in all functions\n+ exported by the DMA API.\n+\n+- A device name used to designate the DMA device in console messages, for\n+ administration or debugging purposes.\n+\n+\n+Device Configuration\n+~~~~~~~~~~~~~~~~~~~~\n+\n+The rte_dmadev_configure API is used to configure a DMA device.\n+\n+.. code-block:: c\n+\n+ int rte_dmadev_configure(uint16_t dev_id,\n+ const struct rte_dmadev_conf *dev_conf);\n+\n+The ``rte_dmadev_conf`` structure is used to pass the configuration parameters\n+for the DMA device for example maximum number of virtual DMA channels,\n+indication of whether to enable silent mode.\n+\n+\n+Configuration of Virtual DMA Channels\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+The rte_dmadev_vchan_setup API is used to configure a virtual DMA channel.\n+\n+.. code-block:: c\n+\n+ int rte_dmadev_vchan_setup(uint16_t dev_id,\n+\t\t const struct rte_dmadev_vchan_conf *conf);\n+\n+The ``rte_dmadev_vchan_conf`` structure is used to pass the configuration\n+parameters for the virtual DMA channel for example transfer direction, number of\n+descriptor for the virtual DMA channel, source device access port parameter,\n+destination device access port parameter.\n+\n+\n+Device Features and Capabilities\n+--------------------------------\n+\n+DMA devices may support different feature set. In order to get the supported PMD\n+features ``rte_dmadev_info_get`` API which returns the info of the device and\n+it's supported features.\ndiff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst\nindex 2dce507..0abea06 100644\n--- a/doc/guides/prog_guide/index.rst\n+++ b/doc/guides/prog_guide/index.rst\n@@ -29,6 +29,7 @@ Programmer's Guide\n regexdev\n rte_security\n rawdev\n+ dmadev\n link_bonding_poll_mode_drv_lib\n timer_lib\n hash_lib\n", "prefixes": [ "v11", "2/2" ] }