Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/36794/?format=api
{ "id": 36794, "url": "https://patches.dpdk.org/api/patches/36794/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20180331022929.42172-5-xiao.w.wang@intel.com/", "project": { "id": 1, "url": "https://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": "<20180331022929.42172-5-xiao.w.wang@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20180331022929.42172-5-xiao.w.wang@intel.com", "date": "2018-03-31T02:29:29", "name": "[dpdk-dev,v3,4/4] net/ifcvf: add driver document and release note", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "cd1f98ce0424a56709a6a293f100d6968d391183", "submitter": { "id": 281, "url": "https://patches.dpdk.org/api/people/281/?format=api", "name": "Xiao Wang", "email": "xiao.w.wang@intel.com" }, "delegate": { "id": 319, "url": "https://patches.dpdk.org/api/users/319/?format=api", "username": "fyigit", "first_name": "Ferruh", "last_name": "Yigit", "email": "ferruh.yigit@amd.com" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20180331022929.42172-5-xiao.w.wang@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/36794/comments/", "check": "fail", "checks": "https://patches.dpdk.org/api/patches/36794/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 [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id BBF99AAA7;\n\tFri, 30 Mar 2018 19:56:27 +0200 (CEST)", "from mga03.intel.com (mga03.intel.com [134.134.136.65])\n\tby dpdk.org (Postfix) with ESMTP id D01E9AAA4\n\tfor <dev@dpdk.org>; Fri, 30 Mar 2018 19:56:25 +0200 (CEST)", "from orsmga005.jf.intel.com ([10.7.209.41])\n\tby orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t30 Mar 2018 10:56:24 -0700", "from dpdk-xiao-1.sh.intel.com ([10.67.110.153])\n\tby orsmga005.jf.intel.com with ESMTP; 30 Mar 2018 10:56:22 -0700" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.48,382,1517904000\"; d=\"scan'208\";a=\"212673981\"", "From": "Xiao Wang <xiao.w.wang@intel.com>", "To": "ferruh.yigit@intel.com,\n\tmaxime.coquelin@redhat.com", "Cc": "dev@dpdk.org, zhihong.wang@intel.com, yliu@fridaylinux.org,\n\tjianfeng.tan@intel.com, tiwei.bie@intel.com, cunming.liang@intel.com, \n\tdan.daly@intel.com, thomas@monjalon.net, gaetan.rivet@6wind.com,\n\tanatoly.burakov@intel.com, Xiao Wang <xiao.w.wang@intel.com>", "Date": "Sat, 31 Mar 2018 10:29:29 +0800", "Message-Id": "<20180331022929.42172-5-xiao.w.wang@intel.com>", "X-Mailer": "git-send-email 2.15.1", "In-Reply-To": "<20180331022929.42172-1-xiao.w.wang@intel.com>", "References": "<20180321132108.52464-4-xiao.w.wang@intel.com>\n\t<20180331022929.42172-1-xiao.w.wang@intel.com>", "Subject": "[dpdk-dev] [PATCH v3 4/4] net/ifcvf: add driver document and\n\trelease note", "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://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": "<https://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": "Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>\n---\n doc/guides/nics/features/ifcvf.ini | 8 ++++\n doc/guides/nics/ifcvf.rst | 85 ++++++++++++++++++++++++++++++++++\n doc/guides/nics/index.rst | 1 +\n doc/guides/rel_notes/release_18_05.rst | 9 ++++\n 4 files changed, 103 insertions(+)\n create mode 100644 doc/guides/nics/features/ifcvf.ini\n create mode 100644 doc/guides/nics/ifcvf.rst", "diff": "diff --git a/doc/guides/nics/features/ifcvf.ini b/doc/guides/nics/features/ifcvf.ini\nnew file mode 100644\nindex 000000000..ef1fc4711\n--- /dev/null\n+++ b/doc/guides/nics/features/ifcvf.ini\n@@ -0,0 +1,8 @@\n+;\n+; Supported features of the 'ifcvf' vDPA driver.\n+;\n+; Refer to default.ini for the full list of available PMD features.\n+;\n+[Features]\n+x86-32 = Y\n+x86-64 = Y\ndiff --git a/doc/guides/nics/ifcvf.rst b/doc/guides/nics/ifcvf.rst\nnew file mode 100644\nindex 000000000..5d82bd25e\n--- /dev/null\n+++ b/doc/guides/nics/ifcvf.rst\n@@ -0,0 +1,85 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2018 Intel Corporation.\n+\n+IFCVF vDPA driver\n+=================\n+\n+The IFCVF vDPA (vhost data path acceleration) driver provides support for the\n+Intel FPGA 100G VF (IFCVF). IFCVF's datapath is virtio ring compatible, it\n+works as a HW vhost backend which can send/receive packets to/from virtio\n+directly by DMA. Besides, it supports dirty page logging and device state\n+report/restore. This driver enables its vDPA functionality with live migration\n+feature.\n+\n+\n+IFCVF vDPA Implementation\n+-------------------------\n+\n+IFCVF's vendor ID and device ID are same as that of virtio net pci device,\n+with its specific subsystem vendor ID and device ID. To let the device be\n+probed by IFCVF driver, adding \"vdpa=1\" parameter helps to specify that this\n+device is to be used in vDPA mode, rather than polling mode, virtio pmd will\n+skip when it detects this message.\n+\n+Different VF devices serve different virtio frontends which are in different\n+VMs, so each VF needs to have its own DMA address translation service. During\n+the driver probe a new container is created for this device, with this\n+container vDPA driver can program DMA remapping table with the VM's memory\n+region information.\n+\n+Key IFCVF vDPA driver ops\n+~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+- ifcvf_dev_config:\n+ Enable VF data path with virtio information provided by vhost lib, including\n+ IOMMU programming to enable VF DMA to VM's memory, VFIO interrupt setup to\n+ route HW interrupt to virtio driver, create notify relay thread to translate\n+ virtio driver's kick to a MMIO write onto HW, HW queues configuration.\n+\n+ This function gets called to set up HW data path backend when virtio driver\n+ in VM gets ready.\n+\n+- ifcvf_dev_close:\n+ Revoke all the setup in ifcvf_dev_config.\n+\n+ This function gets called when virtio driver stops device in VM.\n+\n+To create a vhost port with IFC VF\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+- Create a vhost socket and assign a VF's device ID to this socket via\n+ vhost API. When QEMU vhost connection gets ready, the assigned VF will\n+ get configured automatically.\n+\n+\n+Features\n+--------\n+\n+Features of the IFCVF driver are:\n+\n+- Compatibility with virtio 0.95 and 1.0.\n+- Live migration.\n+\n+\n+Prerequisites\n+-------------\n+\n+- Platform with IOMMU feature. IFC VF needs address translation service to\n+ Rx/Tx directly with virtio driver in VM.\n+\n+\n+Limitations\n+-----------\n+\n+Dependency on vfio-pci\n+~~~~~~~~~~~~~~~~~~~~~~\n+\n+vDPA driver needs to setup VF MSIX interrupts, each queue's interrupt vector\n+is mapped to a callfd associated with a virtio ring. Currently only vfio-pci\n+allows multiple interrupts, so the IFCVF driver is dependent on vfio-pci.\n+\n+Live Migration with VIRTIO_NET_F_GUEST_ANNOUNCE\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+IFC VF doesn't support RARP packet generation, virtio frontend supporting\n+VIRTIO_NET_F_GUEST_ANNOUNCE feature can help to do that.\ndiff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst\nindex 59419f432..379798c20 100644\n--- a/doc/guides/nics/index.rst\n+++ b/doc/guides/nics/index.rst\n@@ -44,6 +44,7 @@ Network Interface Controller Drivers\n vmxnet3\n pcap_ring\n fail_safe\n+ ifcvf\n \n **Figures**\n \ndiff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst\nindex 3923dc253..dc6854035 100644\n--- a/doc/guides/rel_notes/release_18_05.rst\n+++ b/doc/guides/rel_notes/release_18_05.rst\n@@ -41,6 +41,15 @@ New Features\n Also, make sure to start the actual text at the margin.\n =========================================================\n \n+* **Added IFCVF vDPA driver.**\n+\n+ Added IFCVF vDPA driver to support Intel FPGA 100G VF device. IFCVF works\n+ as a HW vhost data path accelerator, it supports live migration and is\n+ compatible with virtio 0.95 and 1.0. This driver registers ifcvf vDPA driver\n+ to vhost lib, when virtio connected, with the help of the registered vDPA\n+ driver the assigned VF gets configured to Rx/Tx directly to VM's virtio\n+ vrings.\n+\n \n API Changes\n -----------\n", "prefixes": [ "dpdk-dev", "v3", "4/4" ] }