cryptodev: rename ADD field

[dpdk.git] / lib / librte_cryptodev / rte_crypto_sym.h

diff --git a/lib/librte_cryptodev/rte_crypto_sym.h b/lib/librte_cryptodev/rte_crypto_sym.h
index 931ff2c..ea58cef 100644 (file)
--- a/lib/librte_cryptodev/rte_crypto_sym.h
+++ b/lib/librte_cryptodev/rte_crypto_sym.h
@@ -143,7 +143,7 @@ struct rte_crypto_cipher_xform {
 
        struct {
                uint8_t *data;  /**< pointer to key data */
-               size_t length;  /**< key length in bytes */
+               uint16_t length;/**< key length in bytes */
        } key;
        /**< Cipher key
         *
@@ -306,7 +306,7 @@ struct rte_crypto_auth_xform {
 
        struct {
                uint8_t *data;  /**< pointer to key data */
-               size_t length;  /**< key length in bytes */
+               uint16_t length;/**< key length in bytes */
        } key;
        /**< Authentication key data.
         * The authentication key length MUST be less than or equal to the
@@ -326,23 +326,18 @@ struct rte_crypto_auth_xform {
         * the result shall be truncated.
         */
 
-       uint16_t add_auth_data_length;
-       /**< The length of the additional authenticated data (AAD) in bytes.
-        * The maximum permitted value is 65535 (2^16 - 1) bytes, unless
-        * otherwise specified below.
-        *
-        */
-
        struct {
                uint16_t offset;
                /**< Starting point for Initialisation Vector or Counter,
                 * specified as number of bytes from start of crypto
                 * operation (rte_crypto_op).
                 *
-                * - For KASUMI in F9 mode, SNOW 3G in UIA2 mode,
-                *   for ZUC in EIA3 mode and for AES-GMAC, this is the
-                *   authentication Initialisation Vector (IV) value.
+                * - For SNOW 3G in UIA2 mode, for ZUC in EIA3 mode and
+                *   for AES-GMAC, this is the authentication
+                *   Initialisation Vector (IV) value.
                 *
+                * - For KASUMI in F9 mode and other authentication
+                *   algorithms, this field is not used.
                 *
                 * For optimum performance, the data pointed to SHOULD
                 * be 8-byte aligned.
@@ -350,9 +345,11 @@ struct rte_crypto_auth_xform {
                uint16_t length;
                /**< Length of valid IV data.
                 *
-                * - For KASUMI in F9 mode, SNOW3G in UIA2 mode, for
-                *   ZUC in EIA3 mode and for AES-GMAC, this is the length
-                *   of the IV.
+                * - For SNOW3G in UIA2 mode, for ZUC in EIA3 mode and
+                *   for AES-GMAC, this is the length of the IV.
+                *
+                * - For KASUMI in F9 mode and other authentication
+                *   algorithms, this field is not used.
                 *
                 */
        } iv;   /**< Initialisation vector parameters */
@@ -392,7 +389,7 @@ struct rte_crypto_aead_xform {
 
        struct {
                uint8_t *data;  /**< pointer to key data */
-               size_t length;   /**< key length in bytes */
+               uint16_t length;/**< key length in bytes */
        } key;
 
        struct {
@@ -427,9 +424,9 @@ struct rte_crypto_aead_xform {
                 */
        } iv;   /**< Initialisation vector parameters */
 
-       uint32_t digest_length;
+       uint16_t digest_length;
 
-       uint16_t add_auth_data_length;
+       uint16_t aad_length;
        /**< The length of the additional authenticated data (AAD) in bytes. */
 };
 
@@ -632,6 +629,11 @@ struct rte_crypto_sym_op {
                                          * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
                                          * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
                                          * this field should be in bits.
+                                         *
+                                         * @note
+                                         * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
+                                         * this offset should be such that
+                                         * data to authenticate starts at COUNT.
                                          */
                                        uint32_t length;
                                         /**< The message length, in bytes, of the source
@@ -642,6 +644,12 @@ struct rte_crypto_sym_op {
                                          * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
                                          * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
                                          * this field should be in bits.
+                                         *
+                                         * @note
+                                         * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
+                                         * the length should include the COUNT,
+                                         * FRESH, message, direction bit and padding
+                                         * (to be multiple of 8 bits).
                                          */
                                } data;
                                /**< Data offsets and length for authentication */
@@ -670,25 +678,6 @@ struct rte_crypto_sym_op {
                                        phys_addr_t phys_addr;
                                        /**< Physical address of digest */
                                } digest; /**< Digest parameters */
-
-                               struct {
-                                       uint8_t *data;
-                                       /**< Pointer to Additional Authenticated
-                                        * Data (AAD) needed for authenticated cipher
-                                        * mechanisms (CCM and GCM).
-                                        *
-                                        * The length of the data pointed to by this
-                                        * field is 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 65535 (2^16-1)
-                                        * bytes.
-                                        *
-                                        */
-                                       phys_addr_t phys_addr;  /**< physical address */
-                               } aad;
-                               /**< Additional authentication parameters */
                        } auth;
                };
        };