[v3,11/11] doc: add in-order funciton for virtio device
diff mbox series

Message ID 20180628215235.106069-12-yong.liu@intel.com
State Superseded, archived
Delegated to: Maxime Coquelin
Headers show
Series
  • support in-order feature
Related show

Checks

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

Commit Message

Liu, Yong June 28, 2018, 9:52 p.m. UTC
Signed-off-by: Marvin Liu <yong.liu@intel.com>

Comments

Maxime Coquelin June 28, 2018, 3:17 p.m. UTC | #1
On 06/28/2018 11:52 PM, Marvin Liu wrote:
> Signed-off-by: Marvin Liu <yong.liu@intel.com>
> 

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime

Patch
diff mbox series

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 46e292c4d..1b88cec96 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -201,7 +201,7 @@  The packet transmission flow is:
 Virtio PMD Rx/Tx Callbacks
 --------------------------
 
-Virtio driver has 3 Rx callbacks and 2 Tx callbacks.
+Virtio driver has 4 Rx callbacks and 3 Tx callbacks.
 
 Rx callbacks:
 
@@ -215,6 +215,9 @@  Rx callbacks:
    Vector version without mergeable Rx buffer support, also fixes the available
    ring indexes and uses vector instructions to optimize performance.
 
+#. ``virtio_recv_mergeable_pkts_inorder``:
+   In-order version with mergeable Rx buffer support.
+
 Tx callbacks:
 
 #. ``virtio_xmit_pkts``:
@@ -223,13 +226,17 @@  Tx callbacks:
 #. ``virtio_xmit_pkts_simple``:
    Vector version fixes the available ring indexes to optimize performance.
 
+#. ``virtio_xmit_pkts_inorder``:
+   In-order version.
 
-By default, the non-vector callbacks are used:
+By default, the in-order callbacks are used:
 
 *   For Rx: If mergeable Rx buffers is disabled then ``virtio_recv_pkts`` is
-    used; otherwise ``virtio_recv_mergeable_pkts``.
+    used; If in-order is enabled then ``virtio_recv_mergeable_pkts_inirder``;
+    otherwise ``virtio_recv_mergeable_pkts``.
 
-*   For Tx: ``virtio_xmit_pkts``.
+*   For Tx: If in-order is enabled then ``virtio_xmit_pkts_inorder``;
+    otherwise ``virtio_xmit_pkts``.
 
 
 Vector callbacks will be used when:
@@ -242,6 +249,8 @@  Vector callbacks will be used when:
 
 *   Mergeable Rx buffers is disabled.
 
+*   In-order is enabled
+
 The corresponding callbacks are:
 
 *   For Rx: ``virtio_recv_pkts_vec``.