diff mbox

[dpdk-dev] doc: add doc for vdpa

Message ID 20180525114020.6938-1-zhihong.wang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Zhihong Wang May 25, 2018, 11:40 a.m. UTC 
  Signed-off-by: Zhihong Wang <zhihong.wang@intel.com>
---
 doc/guides/prog_guide/vhost_lib.rst | 59 +++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)

Comments

Kovacevic, Marko May 25, 2018, 3:36 p.m. UTC | #1 
> 
> Signed-off-by: Zhihong Wang <zhihong.wang@intel.com>
> ---
>  doc/guides/prog_guide/vhost_lib.rst | 59
> +++++++++++++++++++++++++++++++++++++
>  1 file changed, 59 insertions(+)
> 

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
Ferruh Yigit May 25, 2018, 4:33 p.m. UTC | #2 
On 5/25/2018 4:36 PM, Kovacevic, Marko wrote:
>>
>> Signed-off-by: Zhihong Wang <zhihong.wang@intel.com>

> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Applied to dpdk-next-net/master, thanks.
diff mbox

Patch

diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst
index 92dcdb587..77af4d775 100644
--- a/doc/guides/prog_guide/vhost_lib.rst
+++ b/doc/guides/prog_guide/vhost_lib.rst
@@ -274,3 +274,62 @@  Vhost supported vSwitch reference
 
 For more vhost details and how to support vhost in vSwitch, please refer to
 the vhost example in the DPDK Sample Applications Guide.
+
+Vhost data path acceleration (vDPA)
+-----------------------------------
+
+vDPA supports selective datapath in vhost-user lib by enabling virtio ring
+compatible devices to serve virtio driver directly for datapath acceleration.
+
+``rte_vhost_driver_attach_vdpa_device`` is used to configure the vhost device
+with accelerated backend.
+
+Also vhost device capabilities are made configurable to adopt various devices.
+Such capabilities include supported features, protocol features, queue number.
+
+Finally, a set of device ops is defined for device specific operations:
+
+* ``get_queue_num``
+
+  Called to get supported queue number of the device.
+
+* ``get_features``
+
+  Called to get supported features of the device.
+
+* ``get_protocol_features``
+
+  Called to get supported protocol features of the device.
+
+* ``dev_conf``
+
+  Called to configure the actual device when the virtio device becomes ready.
+
+* ``dev_close``
+
+  Called to close the actual device when the virtio device is stopped.
+
+* ``set_vring_state``
+
+  Called to change the state of the vring in the actual device when vring state
+  changes.
+
+* ``set_features``
+
+  Called to set the negotiated features to device.
+
+* ``migration_done``
+
+  Called to allow the device to response to RARP sending.
+
+* ``get_vfio_group_fd``
+
+   Called to get the VFIO group fd of the device.
+
+* ``get_vfio_device_fd``
+
+  Called to get the VFIO device fd of the device.
+
+* ``get_notify_area``
+
+  Called to get the notify area info of the queue.