Signed-off-by: Maxime Coquelin <maxime.coque...@redhat.com> --- 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. + -- 2.21.0