crypto/qat: move sym-specific qp code to sym file

[dpdk.git] / lib / librte_compressdev / rte_comp.h

diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index 4c80219..5b513c7 100644 (file)
--- a/lib/librte_compressdev/rte_comp.h
+++ b/lib/librte_compressdev/rte_comp.h
@@ -295,12 +295,19 @@ struct rte_comp_op {
        struct rte_mbuf *m_src;
        /**< source mbuf
         * The total size of the input buffer(s) can be retrieved using
-        * rte_pktmbuf_data_len(m_src)
+        * rte_pktmbuf_data_len(m_src). The max data size which can fit in a
+        * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
+        * If the input data is bigger than this it can be passed to the PMD in
+        * a chain of mbufs if the PMD's capabilities indicate it supports this.
         */
        struct rte_mbuf *m_dst;
        /**< destination mbuf
         * The total size of the output buffer(s) can be retrieved using
-        * rte_pktmbuf_data_len(m_dst)
+        * rte_pktmbuf_data_len(m_dst). The max data size which can fit in a
+        * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
+        * If the output data is expected to be bigger than this a chain of
+        * mbufs can be passed to the PMD if the PMD's capabilities indicate
+        * it supports this.
         */
 
        struct {
@@ -308,6 +315,8 @@ struct rte_comp_op {
                /**< Starting point for compression or decompression,
                 * specified as number of bytes from start of packet in
                 * source buffer.
+                * This offset starts from the first segment
+                * of the buffer, in case the m_src is a chain of mbufs.
                 * Starting point for checksum generation in compress direction.
                 */
                uint32_t length;
@@ -321,7 +330,10 @@ struct rte_comp_op {
                uint32_t offset;
                /**< Starting point for writing output data, specified as
                 * number of bytes from start of packet in dest
-                * buffer. Starting point for checksum generation in
+                * buffer.
+                * This offset starts from the first segment
+                * of the buffer, in case the m_dst is a chain of mbufs.
+                * Starting point for checksum generation in
                 * decompress direction.
                 */
        } dst;