cryptodev: fix API AAD comments
authorArek Kusztal <arkadiuszx.kusztal@intel.com>
Tue, 25 Apr 2017 14:33:51 +0000 (15:33 +0100)
committerPablo de Lara <pablo.de.lara.guarch@intel.com>
Fri, 28 Apr 2017 15:46:19 +0000 (17:46 +0200)
Fix comments concerning aad sizes in Cryptodev API.
Cc: stable@dpdk.org
Fixes: d11b0f30df88 ("cryptodev: introduce API and framework for crypto devices")

Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
lib/librte_cryptodev/rte_crypto_sym.h

index 508f4ee..6f24ea9 100644 (file)
@@ -319,8 +319,8 @@ struct rte_crypto_auth_xform {
 
        uint32_t add_auth_data_length;
        /**< The length of the additional authenticated data (AAD) in bytes.
-        * The maximum permitted value is 240 bytes, unless otherwise specified
-        * below.
+        * The maximum permitted value is 65535 (2^16 - 1) bytes, unless
+        * otherwise specified below.
         *
         * This field must be specified when the hash algorithm is one of the
         * following:
@@ -612,7 +612,7 @@ struct rte_crypto_sym_op {
                         * set up for the session in the @ref
                         * rte_crypto_auth_xform structure as part of the @ref
                         * rte_cryptodev_sym_session_create function call.
-                        * This length must not exceed 240 bytes.
+                        * This length must not exceed 65535 (2^16-1) bytes.
                         *
                         * Specifically for CCM (@ref RTE_CRYPTO_AUTH_AES_CCM),
                         * the caller should setup this field as follows:
@@ -645,7 +645,10 @@ struct rte_crypto_sym_op {
                         * operation, this field is used to pass plaintext.
                         */
                        phys_addr_t phys_addr;  /**< physical address */
-                       uint16_t length;        /**< Length of digest */
+                       uint16_t length;
+                       /**< Length of additional authenticated data (AAD)
+                        * in bytes
+                        */
                } aad;
                /**< Additional authentication parameters */
        } auth;