From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id B196B1B3A2 for ; Thu, 28 Jun 2018 16:06:58 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Jun 2018 07:06:58 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,283,1526367600"; d="scan'208";a="60850415" Received: from dpdk-test32.sh.intel.com ([10.67.119.193]) by FMSMGA003.fm.intel.com with ESMTP; 28 Jun 2018 07:06:57 -0700 From: Marvin Liu To: maxime.coquelin@redhat.com, tiwei.bie@intel.com Cc: zhihong.wang@intel.com, dev@dpdk.org, Marvin Liu Date: Fri, 29 Jun 2018 05:52:35 +0800 Message-Id: <20180628215235.106069-12-yong.liu@intel.com> X-Mailer: git-send-email 2.17.0 In-Reply-To: <20180628215235.106069-1-yong.liu@intel.com> References: <20180628215235.106069-1-yong.liu@intel.com> Subject: [dpdk-dev] [PATCH v3 11/11] doc: add in-order funciton for virtio device 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: , X-List-Received-Date: Thu, 28 Jun 2018 14:06:59 -0000 Signed-off-by: Marvin Liu 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``. -- 2.17.0