[dpdk-dev] [PATCH v7 5/5] doc: update doc for queue clear API in vhost lib
Cheng Jiang
cheng1.jiang at intel.com
Thu Jul 22 06:09:07 CEST 2021
Update the program guide and release notes for virtqueue inflight
packets clear API in vhost lib.
Signed-off-by: Cheng Jiang <cheng1.jiang at intel.com>
Reviewed-by: Maxime Coquelin <maxime.coquelin at redhat.com>
---
doc/guides/prog_guide/vhost_lib.rst | 5 +++++
doc/guides/rel_notes/release_21_08.rst | 5 +++++
2 files changed, 10 insertions(+)
diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst
index 70ce4974df..8874033165 100644
--- a/doc/guides/prog_guide/vhost_lib.rst
+++ b/doc/guides/prog_guide/vhost_lib.rst
@@ -305,6 +305,11 @@ The following is an overview of some key Vhost API functions:
This function returns the amount of in-flight packets for the vhost
queue using async acceleration.
+* ``rte_vhost_clear_queue_thread_unsafe(vid, queue_id, **pkts, count)``
+
+ Clear inflight packets which are submitted to DMA engine in vhost async data
+ path. Completed packets are returned to applications through ``pkts``.
+
Vhost-user Implementations
--------------------------
diff --git a/doc/guides/rel_notes/release_21_08.rst b/doc/guides/rel_notes/release_21_08.rst
index 543e93ff1d..d9c4cc5df0 100644
--- a/doc/guides/rel_notes/release_21_08.rst
+++ b/doc/guides/rel_notes/release_21_08.rst
@@ -155,6 +155,11 @@ New Features
The experimental PMD power management API now supports managing
multiple Ethernet Rx queues per lcore.
+* **Added inflight packets clear API in vhost library.**
+
+ Added an API which can clear the inflight packets submitted to DMA
+ engine in vhost async data path.
+
Removed Items
-------------
--
2.29.2
More information about the dev
mailing list