compressdev: clarify mbuf offsets

Add extra clarification about offset in source and
destination mbuf used in compressdev, when they
are a chain of mbufs.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Reviewed-by: Shally Verma <shally.verma@caviumnetworks.com>

diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index 9826086..5b513c7 100644 (file)
--- a/lib/librte_compressdev/rte_comp.h
+++ b/lib/librte_compressdev/rte_comp.h
@@ -315,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;
@@ -328,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;