cryptodev: add API note

Add note to cryptodev API that chained mbufs
are not supported in DOCSISBPI mode.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
Acked-by: Declan Doherty <declan.doherty@intel.com>

diff --git a/lib/librte_cryptodev/rte_crypto_sym.h b/lib/librte_cryptodev/rte_crypto_sym.h
index 4d5459f..508f4ee 100644 (file)
--- a/lib/librte_cryptodev/rte_crypto_sym.h
+++ b/lib/librte_cryptodev/rte_crypto_sym.h
@@ -111,11 +111,15 @@ enum rte_crypto_cipher_algorithm {
        RTE_CRYPTO_CIPHER_AES_DOCSISBPI,
        /**< AES algorithm using modes required by
         * DOCSIS Baseline Privacy Plus Spec.
+        * Chained mbufs are not supported in this mode, i.e. rte_mbuf.next
+        * for m_src and m_dst in the rte_crypto_sym_op must be NULL.
         */
 
        RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
        /**< DES algorithm using modes required by
         * DOCSIS Baseline Privacy Plus Spec.
+        * Chained mbufs are not supported in this mode, i.e. rte_mbuf.next
+        * for m_src and m_dst in the rte_crypto_sym_op must be NULL.
         */
 
        RTE_CRYPTO_CIPHER_LIST_END