cryptodev: pass IV as offset
[dpdk.git] / lib / librte_cryptodev / rte_crypto_sym.h
index d694723..db594c8 100644 (file)
@@ -1,7 +1,7 @@
 /*-
  *   BSD LICENSE
  *
- *   Copyright(c) 2016 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
  *
  *   Redistribution and use in source and binary forms, with or without
  *   modification, are permitted provided that the following conditions
@@ -105,9 +105,31 @@ enum rte_crypto_cipher_algorithm {
        RTE_CRYPTO_CIPHER_ZUC_EEA3,
        /**< ZUC algorithm in EEA3 mode */
 
+       RTE_CRYPTO_CIPHER_DES_CBC,
+       /**< DES algorithm in CBC mode */
+
+       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
+
 };
 
+/** Cipher algorithm name strings */
+extern const char *
+rte_crypto_cipher_algorithm_strings[];
+
 /** Symmetric Cipher Direction */
 enum rte_crypto_cipher_operation {
        RTE_CRYPTO_CIPHER_OP_ENCRYPT,
@@ -116,6 +138,10 @@ enum rte_crypto_cipher_operation {
        /**< Decrypt cipher operation */
 };
 
+/** Cipher operation name strings */
+extern const char *
+rte_crypto_cipher_operation_strings[];
+
 /**
  * Symmetric Cipher Setup Data.
  *
@@ -241,12 +267,20 @@ enum rte_crypto_auth_algorithm {
        RTE_CRYPTO_AUTH_LIST_END
 };
 
+/** Authentication algorithm name strings */
+extern const char *
+rte_crypto_auth_algorithm_strings[];
+
 /** Symmetric Authentication / Hash Operations */
 enum rte_crypto_auth_operation {
        RTE_CRYPTO_AUTH_OP_VERIFY,      /**< Verify authentication digest */
        RTE_CRYPTO_AUTH_OP_GENERATE     /**< Generate authentication digest */
 };
 
+/** Authentication operation name strings */
+extern const char *
+rte_crypto_auth_operation_strings[];
+
 /**
  * Authentication / Hash transform data.
  *
@@ -276,17 +310,16 @@ struct rte_crypto_auth_xform {
         * this specifies the length of the digest to be compared for the
         * session.
         *
+        * It is the caller's responsibility to ensure that the
+        * digest length is compliant with the hash algorithm being used.
         * If the value is less than the maximum length allowed by the hash,
-        * the result shall be truncated.  If the value is greater than the
-        * maximum length allowed by the hash then an error will be generated
-        * by *rte_cryptodev_sym_session_create* or by the
-        * *rte_cryptodev_sym_enqueue_burst* if using session-less APIs.
+        * the result shall be truncated.
         */
 
        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:
@@ -343,17 +376,6 @@ struct rte_crypto_sym_xform {
        };
 };
 
-/**
- * Crypto operation session type. This is used to specify whether a crypto
- * operation has session structure attached for immutable parameters or if all
- * operation information is included in the operation data structure.
- */
-enum rte_crypto_sym_op_sess_type {
-       RTE_CRYPTO_SYM_OP_WITH_SESSION, /**< Session based crypto operation */
-       RTE_CRYPTO_SYM_OP_SESSIONLESS   /**< Session-less crypto operation */
-};
-
-
 struct rte_cryptodev_sym_session;
 
 /**
@@ -390,8 +412,6 @@ struct rte_crypto_sym_op {
        struct rte_mbuf *m_src; /**< source mbuf */
        struct rte_mbuf *m_dst; /**< destination mbuf */
 
-       enum rte_crypto_sym_op_sess_type sess_type;
-
        RTE_STD_C11
        union {
                struct rte_cryptodev_sym_session *session;
@@ -444,8 +464,10 @@ struct rte_crypto_sym_op {
                } data; /**< Data offsets and length for ciphering */
 
                struct {
-                       uint8_t *data;
-                       /**< Initialisation Vector or Counter.
+                       uint16_t offset;
+                       /**< Starting point for Initialisation Vector or Counter,
+                        * specified as number of bytes from start of crypto
+                        * operation.
                         *
                         * - For block ciphers in CBC or F8 mode, or for KASUMI
                         * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
@@ -471,7 +493,6 @@ struct rte_crypto_sym_op {
                         * For optimum performance, the data pointed to SHOULD
                         * be 8-byte aligned.
                         */
-                       phys_addr_t phys_addr;
                        uint16_t length;
                        /**< Length of valid IV data.
                         *
@@ -563,7 +584,9 @@ struct rte_crypto_sym_op {
                        phys_addr_t phys_addr;
                        /**< Physical address of digest */
                        uint16_t length;
-                       /**< Length of digest */
+                       /**< Length of digest. This must be the same value as
+                        * @ref rte_crypto_auth_xform.digest_length.
+                        */
                } digest; /**< Digest parameters */
 
                struct {
@@ -578,7 +601,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:
@@ -611,11 +634,14 @@ 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;
-} __rte_cache_aligned;
+};
 
 
 /**
@@ -627,8 +653,6 @@ static inline void
 __rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
 {
        memset(op, 0, sizeof(*op));
-
-       op->sess_type = RTE_CRYPTO_SYM_OP_SESSIONLESS;
 }
 
 
@@ -670,7 +694,6 @@ __rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op,
                struct rte_cryptodev_sym_session *sess)
 {
        sym_op->session = sess;
-       sym_op->sess_type = RTE_CRYPTO_SYM_OP_WITH_SESSION;
 
        return 0;
 }