From patchwork Thu Aug 29 08:00:00 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxime Coquelin X-Patchwork-Id: 58233 X-Patchwork-Delegate: maxime.coquelin@redhat.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A00ED1E4EA; Thu, 29 Aug 2019 10:01:09 +0200 (CEST) Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by dpdk.org (Postfix) with ESMTP id 6D6501D166; Thu, 29 Aug 2019 10:01:07 +0200 (CEST) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id D3C83308123B; Thu, 29 Aug 2019 08:01:06 +0000 (UTC) Received: from localhost.localdomain (ovpn-112-52.ams2.redhat.com [10.36.112.52]) by smtp.corp.redhat.com (Postfix) with ESMTP id 92DDF5D6B2; Thu, 29 Aug 2019 08:01:04 +0000 (UTC) From: Maxime Coquelin To: tiwei.bie@intel.com, zhihong.wang@intel.com, amorenoz@redhat.com, xiao.w.wang@intel.com, dev@dpdk.org, jfreimann@redhat.com Cc: stable@dpdk.org, Maxime Coquelin Date: Thu, 29 Aug 2019 10:00:00 +0200 Message-Id: <20190829080000.20806-16-maxime.coquelin@redhat.com> In-Reply-To: <20190829080000.20806-1-maxime.coquelin@redhat.com> References: <20190829080000.20806-1-maxime.coquelin@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.49]); Thu, 29 Aug 2019 08:01:06 +0000 (UTC) Subject: [dpdk-dev] [PATCH 15/15] doc: add documentation for Virtio vDPA driver X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 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" Signed-off-by: Maxime Coquelin --- doc/guides/nics/index.rst | 1 + doc/guides/nics/virtio_vdpa.rst | 45 +++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 doc/guides/nics/virtio_vdpa.rst diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 9fec02f3e..12aee63d7 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -55,6 +55,7 @@ Network Interface Controller Drivers thunderx vdev_netvsc virtio + virtio_vdpa vhost vmxnet3 pcap_ring diff --git a/doc/guides/nics/virtio_vdpa.rst b/doc/guides/nics/virtio_vdpa.rst new file mode 100644 index 000000000..b708ef77e --- /dev/null +++ b/doc/guides/nics/virtio_vdpa.rst @@ -0,0 +1,45 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Red Hat, Inc. + +Virtio vDPA driver +================== + +The Virtio vDPA driver provides support to either para-virtualized +or fully HW offloaded Virtio-net devices. + +Pre-Installation Configuration +------------------------------ + +Config File Options +~~~~~~~~~~~~~~~~~~~ + +The following option can be modified in the ``config`` file. + +- ``CONFIG_RTE_VIRTIO_VDPA`` (default ``y`` for linux) + +Virtio vDPA Implementation +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To let the Virtio-net device being probed by the Virtio vDPA driver, adding +"vdpa=1" parameter helps to specify that this device is to be used in vDPA +mode, rather than polling mode, virtio pmd will skip when it detects this +message. If no specified, device will not be used as a vDPA device, and it +will be driven by virtio pmd. + +This driver requires the use of VFIO with IOMMU enabled, as a second level +of addresses translation is required. + +Features +-------- + +Features of the Virtio vDPA driver are: + +- Compatibility with virtio 0.95, 1.0 and 1.1. +- Multiqueue support. + +Prerequisites +------------- + +- Platform with IOMMU feature. Virtio device needs address translation + service to Rx/Tx directly with virtio driver in VM or container. +