[dpdk-dev] [PATCH] compressdev: clarify buffer size limitation

[Fiona Trahe <fiona.trahe@intel.com>]

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 lib/librte_compressdev/rte_comp.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index 4c802195f..9826086b1 100644
--- 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 {
-- 
2.13.6