git.droids-corp.org
/
dpdk.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
vhost: enhance async enqueue for small packets
[dpdk.git]
/
doc
/
guides
/
prog_guide
/
vhost_lib.rst
diff --git
a/doc/guides/prog_guide/vhost_lib.rst
b/doc/guides/prog_guide/vhost_lib.rst
index
ba4c62a
..
dc29229
100644
(file)
--- a/
doc/guides/prog_guide/vhost_lib.rst
+++ b/
doc/guides/prog_guide/vhost_lib.rst
@@
-245,11
+245,13
@@
The following is an overview of some key Vhost API functions:
Unregister the async copy device channel from a vhost queue.
Unregister the async copy device channel from a vhost queue.
-* ``rte_vhost_submit_enqueue_burst(vid, queue_id, pkts, count)``
+* ``rte_vhost_submit_enqueue_burst(vid, queue_id, pkts, count
, comp_pkts, comp_count
)``
Submit an enqueue request to transmit ``count`` packets from host to guest
Submit an enqueue request to transmit ``count`` packets from host to guest
- by async data path. Enqueue is not guaranteed to finish upon the return of
- this API call.
+ by async data path. Successfully enqueued packets can be transfer completed
+ or being occupied by DMA engines; transfer completed packets are returned in
+ ``comp_pkts``, but others are not guaranteed to finish, when this API
+ call returns.
Applications must not free the packets submitted for enqueue until the
packets are completed.
Applications must not free the packets submitted for enqueue until the
packets are completed.