Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/64131/?format=api
{ "id": 64131, "url": "http://patches.dpdk.org/api/patches/64131/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1577287161-10321-3-git-send-email-matan@mellanox.com/", "project": { "id": 1, "url": "http://patches.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": "<1577287161-10321-3-git-send-email-matan@mellanox.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1577287161-10321-3-git-send-email-matan@mellanox.com", "date": "2019-12-25T15:19:20", "name": "[v1,2/3] doc: add vDPA feature table", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "b5e06584f1c6e7d842ad99a8cf015ea2303a1541", "submitter": { "id": 796, "url": "http://patches.dpdk.org/api/people/796/?format=api", "name": "Matan Azrad", "email": "matan@mellanox.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1577287161-10321-3-git-send-email-matan@mellanox.com/mbox/", "series": [ { "id": 7948, "url": "http://patches.dpdk.org/api/series/7948/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=7948", "date": "2019-12-25T15:19:18", "name": "Introduce new class for vDPA device drivers", "version": 1, "mbox": "http://patches.dpdk.org/series/7948/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/64131/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/64131/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 dpdk.org (dpdk.org [92.243.14.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id A3D70A04F0;\n\tWed, 25 Dec 2019 16:19:56 +0100 (CET)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 78CDD1BF02;\n\tWed, 25 Dec 2019 16:19:56 +0100 (CET)", "from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129])\n by dpdk.org (Postfix) with ESMTP id 319E81BE94\n for <dev@dpdk.org>; Wed, 25 Dec 2019 16:19:55 +0100 (CET)", "from Internal Mail-Server by MTLPINE1 (envelope-from\n asafp@mellanox.com)\n with ESMTPS (AES256-SHA encrypted); 25 Dec 2019 17:19:54 +0200", "from pegasus07.mtr.labs.mlnx (pegasus07.mtr.labs.mlnx\n [10.210.16.112])\n by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id xBPFJdJU020861;\n Wed, 25 Dec 2019 17:19:54 +0200" ], "From": "Matan Azrad <matan@mellanox.com>", "To": "Maxime Coquelin <maxime.coquelin@redhat.com>,\n Tiwei Bie <tiwei.bie@intel.com>, Zhihong Wang <zhihong.wang@intel.com>,\n Xiao Wang <xiao.w.wang@intel.com>", "Cc": "Ferruh Yigit <ferruh.yigit@intel.com>, dev@dpdk.org,\n Thomas Monjalon <thomas@monjalon.net>", "Date": "Wed, 25 Dec 2019 15:19:20 +0000", "Message-Id": "<1577287161-10321-3-git-send-email-matan@mellanox.com>", "X-Mailer": "git-send-email 1.8.3.1", "In-Reply-To": "<1577287161-10321-1-git-send-email-matan@mellanox.com>", "References": "<1577287161-10321-1-git-send-email-matan@mellanox.com>", "Subject": "[dpdk-dev] [PATCH v1 2/3] doc: add vDPA feature table", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "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": "Add vDPA devices features table and explanation.\n\nAny vDPA driver can add its own supported features by ading a new ini\nfile to the features directory in doc/guides/vdpadevs/features.\n\nSigned-off-by: Matan Azrad <matan@mellanox.com>\n---\n doc/guides/conf.py | 5 +++\n doc/guides/vdpadevs/features/default.ini | 55 ++++++++++++++++++++++++++\n doc/guides/vdpadevs/features_overview.rst | 65 +++++++++++++++++++++++++++++++\n doc/guides/vdpadevs/index.rst | 1 +\n 4 files changed, 126 insertions(+)\n create mode 100644 doc/guides/vdpadevs/features/default.ini\n create mode 100644 doc/guides/vdpadevs/features_overview.rst", "diff": "diff --git a/doc/guides/conf.py b/doc/guides/conf.py\nindex 0892c06..c368fa5 100644\n--- a/doc/guides/conf.py\n+++ b/doc/guides/conf.py\n@@ -401,6 +401,11 @@ def setup(app):\n 'Features',\n 'Features availability in compression drivers',\n 'Feature')\n+ table_file = dirname(__file__) + '/vdpadevs/overview_feature_table.txt'\n+ generate_overview_table(table_file, 1,\n+ 'Features',\n+ 'Features availability in vDPA drivers',\n+ 'Feature')\n \n if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):\n print('Upgrade sphinx to version >= 1.3.1 for '\ndiff --git a/doc/guides/vdpadevs/features/default.ini b/doc/guides/vdpadevs/features/default.ini\nnew file mode 100644\nindex 0000000..a3e0bc7\n--- /dev/null\n+++ b/doc/guides/vdpadevs/features/default.ini\n@@ -0,0 +1,55 @@\n+;\n+; Features of a default vDPA driver.\n+;\n+; This file defines the features that are valid for inclusion in\n+; the other driver files and also the order that they appear in\n+; the features table in the documentation. The feature description\n+; string should not exceed feature_str_len defined in conf.py.\n+;\n+[Features]\n+csum =\n+guest csum =\n+mac =\n+gso =\n+guest tso4 =\n+guest tso6 =\n+ecn =\n+ufo =\n+host tso4 =\n+host tso6 =\n+mrg rxbuf =\n+ctrl vq =\n+ctrl rx =\n+any layout =\n+guest announce =\n+mq =\n+version 1 =\n+log all =\n+protocol features =\n+indirect desc =\n+event idx =\n+mtu =\n+in_order =\n+IOMMU platform =\n+packed =\n+proto mq =\n+proto log shmfd =\n+proto rarp =\n+proto reply ack =\n+proto slave req =\n+proto crypto session =\n+proto host notifier =\n+proto pagefault =\n+Multiprocess aware =\n+BSD nic_uio =\n+Linux UIO =\n+Linux VFIO =\n+Other kdrv =\n+ARMv7 =\n+ARMv8 =\n+Power8 =\n+x86-32 =\n+x86-64 =\n+Usage doc =\n+Design doc =\n+Perf doc =\n\\ No newline at end of file\ndiff --git a/doc/guides/vdpadevs/features_overview.rst b/doc/guides/vdpadevs/features_overview.rst\nnew file mode 100644\nindex 0000000..c7745b7\n--- /dev/null\n+++ b/doc/guides/vdpadevs/features_overview.rst\n@@ -0,0 +1,65 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright 2019 Mellanox Technologies, Ltd\n+\n+Overview of vDPA drivers features\n+=================================\n+\n+This section explains the supported features that are listed in the table below.\n+\n+ * csum - Device can handle packets with partial checksum.\n+ * guest csum - Guest can handle packets with partial checksum.\n+ * mac - Device has given MAC address.\n+ * gso - Device can handle packets with any GSO type.\n+ * guest tso4 - Guest can receive TSOv4.\n+ * guest tso6 - Guest can receive TSOv6.\n+ * ecn - Device can receive TSO with ECN.\n+ * ufo - Device can receive UFO.\n+ * host tso4 - Device can receive TSOv4.\n+ * host tso6 - Device can receive TSOv6.\n+ * mrg rxbuf - Guest can merge receive buffers.\n+ * ctrl vq - Control channel is available.\n+ * ctrl rx - Control channel RX mode support.\n+ * any layout - Device can handle any descriptor layout.\n+ * guest announce - Guest can send gratuitous packets.\n+ * mq - Device supports Receive Flow Steering.\n+ * version 1 - v1.0 compliant.\n+ * log all - Device can log all write descriptors (live migration).\n+ * protocol features - Protocol features negotiation support.\n+ * indirect desc - Indirect buffer descriptors support.\n+ * event idx - Support for avail_idx and used_idx fields.\n+ * mtu - Host can advise the guest with its maximum supported MTU.\n+ * in_order - Device can use descriptors in ring order.\n+ * IOMMU platform - Device support IOMMU addresses.\n+ * packed - Device support packed virtio queues.\n+ * proto mq - Support the number of queues query.\n+ * proto log shmfd - Guest support setting log base.\n+ * proto rarp - Host can broadcast a fake RARP after live migration.\n+ * proto reply ack - Host support requested operation status ack. \n+ * proto slave req - Allow the slave to make requests to the master.\n+ * proto crypto session - Support crypto session creation.\n+ * proto host notifier - Host can register memory region based host notifiers.\n+ * proto pagefault - Slave expose page-fault FD for migration process.\n+ * Multiprocess aware - Driver can be used for primary-secondary process model.\n+ * BSD nic_uio - BSD ``nic_uio`` module supported.\n+ * Linux UIO - Works with ``igb_uio`` kernel module.\n+ * Linux VFIO - Works with ``vfio-pci`` kernel module.\n+ * Other kdrv - Kernel module other than above ones supported.\n+ * ARMv7 - Support armv7 architecture.\n+ * ARMv8 - Support armv8a (64bit) architecture.\n+ * Power8 - Support PowerPC architecture.\n+ * x86-32 - Support 32bits x86 architecture.\n+ * x86-64 - Support 64bits x86 architecture.\n+ * Usage doc - Documentation describes usage, In ``doc/guides/vdpadevs/``.\n+ * Design doc - Documentation describes design. In ``doc/guides/vdpadevs/``.\n+ * Perf doc - Documentation describes performance values, In ``doc/perf/``.\n+\n+\n+\n+.. _table_vdpa_pmd_features:\n+\n+.. include:: overview_feature_table.txt\n+\n+.. Note::\n+\n+ Features marked with \"P\" are partially supported. Refer to the appropriate\n+ driver guide in the following sections for details.\ndiff --git a/doc/guides/vdpadevs/index.rst b/doc/guides/vdpadevs/index.rst\nindex d69dc91..89e2b03 100644\n--- a/doc/guides/vdpadevs/index.rst\n+++ b/doc/guides/vdpadevs/index.rst\n@@ -11,3 +11,4 @@ which can be used from an application through vhost API.\n :maxdepth: 2\n :numbered:\n \n+ features_overview\n", "prefixes": [ "v1", "2/3" ] }