Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/21024/?format=api
{ "id": 21024, "url": "http://patches.dpdk.org/api/patches/21024/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1488390112-134046-1-git-send-email-allain.legacy@windriver.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": "<1488390112-134046-1-git-send-email-allain.legacy@windriver.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1488390112-134046-1-git-send-email-allain.legacy@windriver.com", "date": "2017-03-01T17:41:52", "name": "[dpdk-dev] doc: adds information related to the AVP PMD", "commit_ref": null, "pull_url": null, "state": "not-applicable", "archived": true, "hash": "c08fdb797d0513c7d31a5ed900c06a85064b224c", "submitter": { "id": 679, "url": "http://patches.dpdk.org/api/people/679/?format=api", "name": "Allain Legacy", "email": "allain.legacy@windriver.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1488390112-134046-1-git-send-email-allain.legacy@windriver.com/mbox/", "series": [], "comments": "http://patches.dpdk.org/api/patches/21024/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/21024/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id 003EF2C2B;\n\tWed, 1 Mar 2017 18:42:09 +0100 (CET)", "from mail5.wrs.com (mail5.windriver.com [192.103.53.11])\n\tby dpdk.org (Postfix) with ESMTP id 75FD02BB1\n\tfor <dev@dpdk.org>; Wed, 1 Mar 2017 18:42:06 +0100 (CET)", "from ALA-HCA.corp.ad.wrs.com (ala-hca.corp.ad.wrs.com\n\t[147.11.189.40])\n\tby mail5.wrs.com (8.15.2/8.15.2) with ESMTPS id v21Hg0RN001312\n\t(version=TLSv1 cipher=AES128-SHA bits=128 verify=OK);\n\tWed, 1 Mar 2017 09:42:02 -0800", "from yow-cgts4-lx.wrs.com (128.224.145.137) by\n\tALA-HCA.corp.ad.wrs.com (147.11.189.50) with Microsoft SMTP Server\n\t(TLS) id 14.3.294.0; Wed, 1 Mar 2017 09:41:57 -0800" ], "From": "Allain Legacy <allain.legacy@windriver.com>", "To": "<thomas.monjalon@6wind.com>", "CC": "<dev@dpdk.org>", "Date": "Wed, 1 Mar 2017 12:41:52 -0500", "Message-ID": "<1488390112-134046-1-git-send-email-allain.legacy@windriver.com>", "X-Mailer": "git-send-email 1.8.3.1", "MIME-Version": "1.0", "Content-Type": "text/plain", "X-Originating-IP": "[128.224.145.137]", "Subject": "[dpdk-dev] [PATCH] doc: adds information related to the AVP PMD", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Updates the documentation and feature lists for the AVP PMD device.\n\nSigned-off-by: Allain Legacy <allain.legacy@windriver.com>\nSigned-off-by: Matt Peters <matt.peters@windriver.com>\nAcked-by: John McNamara <john.mcnamara@intel.com>\n---\n MAINTAINERS | 1 +\n doc/guides/nics/avp.rst | 112 +++++++++++++++++++++++++++++++++\n doc/guides/nics/features/avp.ini | 17 +++++\n doc/guides/nics/index.rst | 1 +\n doc/guides/rel_notes/release_17_05.rst | 5 ++\n 5 files changed, 136 insertions(+)\n create mode 100644 doc/guides/nics/avp.rst\n create mode 100644 doc/guides/nics/features/avp.ini", "diff": "diff --git a/MAINTAINERS b/MAINTAINERS\nindex fef23a0..4a14945 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -427,6 +427,7 @@ Wind River AVP PMD\n M: Allain Legacy <allain.legacy@windriver.com>\n M: Matt Peters <matt.peters@windriver.com>\n F: drivers/net/avp\n+F: doc/guides/nics/avp.rst\n \n \n Crypto Drivers\ndiff --git a/doc/guides/nics/avp.rst b/doc/guides/nics/avp.rst\nnew file mode 100644\nindex 0000000..af6d04d\n--- /dev/null\n+++ b/doc/guides/nics/avp.rst\n@@ -0,0 +1,112 @@\n+.. BSD LICENSE\n+ Copyright(c) 2017 Wind River Systems, Inc. rights reserved.\n+ All rights reserved.\n+\n+ Redistribution and use in source and binary forms, with or without\n+ modification, are permitted provided that the following conditions\n+ are met:\n+\n+ * Redistributions of source code must retain the above copyright\n+ notice, this list of conditions and the following disclaimer.\n+ * Redistributions in binary form must reproduce the above copyright\n+ notice, this list of conditions and the following disclaimer in\n+ the documentation and/or other materials provided with the\n+ distribution.\n+ * Neither the name of Intel Corporation nor the names of its\n+ contributors may be used to endorse or promote products derived\n+ from this software without specific prior written permission.\n+\n+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+ \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+AVP Poll Mode Driver\n+=================================================================\n+\n+The Accelerated Virtual Port (AVP) device is a shared memory based device\n+available on the `virtualization platforms <http://www.windriver.com/products/titanium-cloud/>`_\n+from Wind River Systems. It is based on an earlier implementation of the DPDK\n+KNI device and made available to VM instances via a mechanism based on an early\n+implementation of qemu-kvm ivshmem.\n+\n+It enables optimized packet throughput without requiring any packet processing\n+in qemu. This provides our customers with a significant performance increase\n+for DPDK applications in the VM. Since our AVP implementation supports VM\n+live-migration it is viewed as a better alternative to PCI passthrough or PCI\n+SRIOV since neither of those support VM live-migration without manual\n+intervention or significant performance penalties.\n+\n+Since the initial implementation of AVP devices, vhost-user has become\n+part of the qemu offering with a significant performance increase over\n+the original virtio implementation. However, vhost-user still does\n+not achieve the level of performance that the AVP device can provide\n+to our customers for DPDK based VM instances.\n+\n+The driver binds to PCI devices that are exported by the hypervisor DPDK\n+application via the ivshmem-like mechanism. The definition of the device\n+structure and configuration options are defined in rte_avp_common.h and\n+rte_avp_fifo.h. These two header files are made available as part of the PMD\n+implementation in order to share the device definitions between the guest\n+implementation (i.e., the PMD) and the host implementation (i.e., the\n+hypervisor DPDK vswitch application).\n+\n+\n+Features and Limitations of the AVP PMD\n+---------------------------------------\n+\n+The AVP PMD driver provides the following functionality.\n+\n+* Receive and transmit of both simple and chained mbuf packets,\n+\n+* Chained mbufs may include up to 5 chained segments,\n+\n+* Up to 8 receive and transmit queues per device,\n+\n+* Only a single MAC address is supported,\n+\n+* The MAC address cannot be modified,\n+\n+* The maximum receive packet length is 9238 bytes,\n+\n+* VLAN header stripping and inserting,\n+\n+* Promiscuous mode\n+\n+* VM live-migration\n+\n+* PCI hotplug insertion and removal\n+\n+\n+Prerequisites\n+-------------\n+\n+The following prerequisites apply:\n+\n+* A virtual machine running in a Wind River Systems virtualization\n+ environment and configured with at least one neutron port defined with a\n+ vif-model set to \"avp\".\n+\n+\n+Launching a VM with an AVP type network attachment\n+--------------------------------------------------\n+\n+The following example will launch a VM with three network attachments. The\n+first attachment will have a default vif-model of \"virtio\". The next two\n+network attachments will have a vif-model of \"avp\" and may be used with a DPDK\n+application which is built to include the AVP PMD driver.\n+\n+.. code-block:: console\n+\n+ nova boot --flavor small --image my-image \\\n+ --nic net-id=${NETWORK1_UUID} \\\n+ --nic net-id=${NETWORK2_UUID},vif-model=avp \\\n+ --nic net-id=${NETWORK3_UUID},vif-model=avp \\\n+ --security-group default my-instance1\ndiff --git a/doc/guides/nics/features/avp.ini b/doc/guides/nics/features/avp.ini\nnew file mode 100644\nindex 0000000..64bf42e\n--- /dev/null\n+++ b/doc/guides/nics/features/avp.ini\n@@ -0,0 +1,17 @@\n+;\n+; Supported features of the 'AVP' network poll mode driver.\n+;\n+; Refer to default.ini for the full list of available PMD features.\n+;\n+[Features]\n+Link status = Y\n+Queue start/stop = Y\n+Jumbo frame = Y\n+Scattered Rx = Y\n+Promiscuous mode = Y\n+Unicast MAC filter = Y\n+VLAN offload = Y\n+Basic stats = Y\n+Stats per queue = Y\n+Linux UIO = Y\n+x86-64 = Y\ndiff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst\nindex 87f9334..0ddcea5 100644\n--- a/doc/guides/nics/index.rst\n+++ b/doc/guides/nics/index.rst\n@@ -36,6 +36,7 @@ Network Interface Controller Drivers\n :numbered:\n \n overview\n+ avp\n bnx2x\n bnxt\n cxgbe\ndiff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst\nindex e25ea9f..3accbac 100644\n--- a/doc/guides/rel_notes/release_17_05.rst\n+++ b/doc/guides/rel_notes/release_17_05.rst\n@@ -41,6 +41,11 @@ New Features\n Also, make sure to start the actual text at the margin.\n =========================================================\n \n+* **Added support for the Wind River Systems AVP PMD.**\n+\n+ Added a new networking driver for the AVP device type. Theses devices are\n+ specific to the Wind River Systems virtualization platforms.\n+\n \n Resolved Issues\n ---------------\n", "prefixes": [ "dpdk-dev" ] }