summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorFiona Trahe <fiona.trahe@intel.com>2018-10-27 01:13:54 +0100
committerAkhil Goyal <akhil.goyal@nxp.com>2018-11-02 12:25:39 +0100
commit1fca14d7dd4fed32e67cb2622546552c57b00c38 (patch)
tree75e67dee07db95882023930376c96076d0e417f6 /lib
parent6e5efb27b33f9c3b6478728ece5e89d80f7e8994 (diff)
downloaddpdk-1fca14d7dd4fed32e67cb2622546552c57b00c38.zip
dpdk-1fca14d7dd4fed32e67cb2622546552c57b00c38.tar.gz
dpdk-1fca14d7dd4fed32e67cb2622546552c57b00c38.tar.xz
compressdev: clarify usage of op structure
Add note on usage of op structure and when it can be accessed and freed. Fixes: 63f4bfd5328b ("compressdev: add enqueue/dequeue functions") Cc: stable@dpdk.org Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> Acked-by: Shally Verma <shally.verma@caviumnetworks.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/librte_compressdev/rte_compressdev.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/librte_compressdev/rte_compressdev.h b/lib/librte_compressdev/rte_compressdev.h
index 5b4fca4..7b68170 100644
--- a/lib/librte_compressdev/rte_compressdev.h
+++ b/lib/librte_compressdev/rte_compressdev.h
@@ -408,6 +408,13 @@ rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
* @note All compression operations are Out-of-place (OOP) operations,
* as the size of the output data is different to the size of the input data.
*
+ * @note The rte_comp_op contains both input and output parameters and is the
+ * vehicle for the application to pass data into and out of the PMD. While an
+ * op is inflight, i.e. once it has been enqueued, the private_xform or stream
+ * attached to it and any mbufs or memory referenced by it should not be altered
+ * or freed by the application. The PMD may use or change some of this data at
+ * any time until it has been returned in a dequeue operation.
+ *
* @note The flush flag only applies to operations which return SUCCESS.
* In OUT_OF_SPACE cases whether STATEFUL or STATELESS, data in dest buffer
* is as if flush flag was FLUSH_NONE.