cryptodev: remove AAD size in auth capabilities
[dpdk.git] / lib / librte_cryptodev / rte_cryptodev.h
index bd422fd..756c00b 100644 (file)
@@ -51,44 +51,6 @@ extern "C" {
 #include <rte_common.h>
 #include <rte_vdev.h>
 
-#define CRYPTODEV_NAME_NULL_PMD                crypto_null
-/**< Null crypto PMD device name */
-#define CRYPTODEV_NAME_AESNI_MB_PMD    crypto_aesni_mb
-/**< AES-NI Multi buffer PMD device name */
-#define CRYPTODEV_NAME_AESNI_GCM_PMD   crypto_aesni_gcm
-/**< AES-NI GCM PMD device name */
-#define CRYPTODEV_NAME_OPENSSL_PMD     crypto_openssl
-/**< Open SSL Crypto PMD device name */
-#define CRYPTODEV_NAME_QAT_SYM_PMD     crypto_qat
-/**< Intel QAT Symmetric Crypto PMD device name */
-#define CRYPTODEV_NAME_SNOW3G_PMD      crypto_snow3g
-/**< SNOW 3G PMD device name */
-#define CRYPTODEV_NAME_KASUMI_PMD      crypto_kasumi
-/**< KASUMI PMD device name */
-#define CRYPTODEV_NAME_ZUC_PMD         crypto_zuc
-/**< KASUMI PMD device name */
-#define CRYPTODEV_NAME_ARMV8_PMD       crypto_armv8
-/**< ARMv8 Crypto PMD device name */
-#define CRYPTODEV_NAME_SCHEDULER_PMD   crypto_scheduler
-/**< Scheduler Crypto PMD device name */
-#define CRYPTODEV_NAME_DPAA2_SEC_PMD   crypto_dpaa2_sec
-/**< NXP DPAA2 - SEC PMD device name */
-
-/** Crypto device type */
-enum rte_cryptodev_type {
-       RTE_CRYPTODEV_NULL_PMD = 1,     /**< Null crypto PMD */
-       RTE_CRYPTODEV_AESNI_GCM_PMD,    /**< AES-NI GCM PMD */
-       RTE_CRYPTODEV_AESNI_MB_PMD,     /**< AES-NI multi buffer PMD */
-       RTE_CRYPTODEV_QAT_SYM_PMD,      /**< QAT PMD Symmetric Crypto */
-       RTE_CRYPTODEV_SNOW3G_PMD,       /**< SNOW 3G PMD */
-       RTE_CRYPTODEV_KASUMI_PMD,       /**< KASUMI PMD */
-       RTE_CRYPTODEV_ZUC_PMD,          /**< ZUC PMD */
-       RTE_CRYPTODEV_OPENSSL_PMD,    /**<  OpenSSL PMD */
-       RTE_CRYPTODEV_ARMV8_PMD,        /**< ARMv8 crypto PMD */
-       RTE_CRYPTODEV_SCHEDULER_PMD,    /**< Crypto Scheduler PMD */
-       RTE_CRYPTODEV_DPAA2_SEC_PMD,    /**< NXP DPAA2 - SEC PMD */
-};
-
 extern const char **rte_cyptodev_names;
 
 /* Logging Macros */
@@ -276,7 +238,6 @@ rte_cryptodev_sym_capability_check_cipher(
  * @param      capability      Description of the symmetric crypto capability.
  * @param      key_size        Auth key size.
  * @param      digest_size     Auth digest size.
- * @param      aad_size        Auth aad size.
  * @param      iv_size         Auth initial vector size.
  *
  * @return
@@ -286,8 +247,7 @@ rte_cryptodev_sym_capability_check_cipher(
 int
 rte_cryptodev_sym_capability_check_auth(
                const struct rte_cryptodev_symmetric_capability *capability,
-               uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
-               uint16_t iv_size);
+               uint16_t key_size, uint16_t digest_size, uint16_t iv_size);
 
 /**
  * Check if key, digest, AAD and initial vector sizes are supported
@@ -408,7 +368,7 @@ rte_cryptodev_get_feature_name(uint64_t flag);
 /**  Crypto device information */
 struct rte_cryptodev_info {
        const char *driver_name;                /**< Driver name. */
-       enum rte_cryptodev_type dev_type;       /**< Device type */
+       uint8_t driver_id;                      /**< Driver identifier */
        struct rte_pci_device *pci_dev;         /**< PCI information. */
 
        uint64_t feature_flags;                 /**< Feature flags */
@@ -512,13 +472,13 @@ rte_cryptodev_count(void);
 /**
  * Get number of crypto device defined type.
  *
- * @param      type    type of device.
+ * @param      driver_id       driver identifier.
  *
  * @return
  *   Returns number of crypto device.
  */
 extern uint8_t
-rte_cryptodev_count_devtype(enum rte_cryptodev_type type);
+rte_cryptodev_device_count_by_driver(uint8_t driver_id);
 
 /**
  * Get number and identifiers of attached crypto devices that
@@ -552,11 +512,6 @@ struct rte_cryptodev_config {
        int socket_id;                  /**< Socket to allocate resources on */
        uint16_t nb_queue_pairs;
        /**< Number of queue pairs to configure on device */
-
-       struct {
-               uint32_t nb_objs;       /**< Number of objects in mempool */
-               uint32_t cache_size;    /**< l-core object cache size */
-       } session_mp;           /**< Session mempool configuration */
 };
 
 /**
@@ -633,6 +588,8 @@ rte_cryptodev_close(uint8_t dev_id);
  *                             *SOCKET_ID_ANY* if there is no NUMA constraint
  *                             for the DMA memory allocated for the receive
  *                             queue pair.
+ * @param      session_pool    Pointer to device session mempool, used
+ *                             for session-less operations.
  *
  * @return
  *   - 0: Success, queue pair correctly set up.
@@ -640,7 +597,8 @@ rte_cryptodev_close(uint8_t dev_id);
  */
 extern int
 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
-               const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
+               const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
+               struct rte_mempool *session_pool);
 
 /**
  * Start a specified queue pair of a device. It is used
@@ -789,8 +747,8 @@ struct rte_cryptodev {
        struct rte_device *device;
        /**< Backing device */
 
-       enum rte_cryptodev_type dev_type;
-       /**< Crypto device type */
+       uint8_t driver_id;
+       /**< Crypto driver identifier*/
 
        struct rte_cryptodev_cb_list link_intr_cbs;
        /**< User application callback for interrupts if present */
@@ -923,66 +881,98 @@ rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 
 /** Cryptodev symmetric crypto session */
 struct rte_cryptodev_sym_session {
-       RTE_STD_C11
-       struct {
-               uint8_t dev_id;
-               /**< Device Id */
-               enum rte_cryptodev_type dev_type;
-               /** Crypto Device type session created on */
-               struct rte_mempool *mp;
-               /**< Mempool session allocated from */
-       } __rte_aligned(8);
-       /**< Public symmetric session details */
-
-       __extension__ char _private[0];
+       __extension__ void *sess_private_data[0];
        /**< Private session material */
 };
 
 
 /**
- * Initialise a session for symmetric cryptographic operations.
+ * Create symmetric crypto session header (generic with no private data)
  *
- * This function is used by the client to initialize immutable
- * parameters of symmetric cryptographic operation.
- * To perform the operation the rte_cryptodev_enqueue_burst function is
- * used.  Each mbuf should contain a reference to the session
- * pointer returned from this function contained within it's crypto_op if a
- * session-based operation is being provisioned. Memory to contain the session
- * information is allocated from within mempool managed by the cryptodev.
+ * @param   mempool    Symmetric session mempool to allocate session
+ *                     objects from
+ * @return
+ *  - On success return pointer to sym-session
+ *  - On failure returns NULL
+ */
+struct rte_cryptodev_sym_session *
+rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
+
+/**
+ * Frees symmetric crypto session header, after checking that all
+ * the device private data has been freed, returning it
+ * to its original mempool.
  *
- * The rte_cryptodev_session_free must be called to free allocated
- * memory when the session is no longer required.
+ * @param   sess     Session header to be freed.
  *
- * @param      dev_id          The device identifier.
- * @param      xform           Crypto transform chain.
+ * @return
+ *  - 0 if successful.
+ *  - -EINVAL if session is NULL.
+ *  - -EBUSY if not all device private data has been freed.
+ */
+int
+rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
+
+/**
+ * Fill out private data for the device id, based on its device type.
+ *
+ * @param   dev_id   ID of device that we want the session to be used on
+ * @param   sess     Session where the private data will be attached to
+ * @param   xforms   Symmetric crypto transform operations to apply on flow
+ *                   processed with this session
+ * @param   mempool  Mempool where the private data is allocated.
+ *
+ * @return
+ *  - On success, zero.
+ *  - On failure, a negative value.
+ */
+int
+rte_cryptodev_sym_session_init(uint8_t dev_id,
+                       struct rte_cryptodev_sym_session *sess,
+                       struct rte_crypto_sym_xform *xforms,
+                       struct rte_mempool *mempool);
+
+/**
+ * Frees private data for the device id, based on its device type,
+ * returning it to its mempool.
+ *
+ * @param   dev_id   ID of device that uses the session.
+ * @param   sess     Session containing the reference to the private data
+ *
+ * @return
+ *  - 0 if successful.
+ *  - -EINVAL if device is invalid or session is NULL.
+ */
+int
+rte_cryptodev_sym_session_clear(uint8_t dev_id,
+                       struct rte_cryptodev_sym_session *sess);
 
+/**
+ * Get the size of the header session, for all registered drivers.
  *
  * @return
- *  Pointer to the created session or NULL
+ *   Size of the header session.
  */
-extern struct rte_cryptodev_sym_session *
-rte_cryptodev_sym_session_create(uint8_t dev_id,
-               struct rte_crypto_sym_xform *xform);
+unsigned int
+rte_cryptodev_get_header_session_size(void);
 
 /**
- * Free the memory associated with a previously allocated session.
+ * Get the size of the private session data for a device.
  *
  * @param      dev_id          The device identifier.
- * @param      session         Session pointer previously allocated by
- *                             *rte_cryptodev_sym_session_create*.
  *
  * @return
- *   NULL on successful freeing of session.
- *   Session pointer on failure to free session.
+ *   - Size of the private data, if successful
+ *   - 0 if device is invalid or does not have private session
  */
-extern struct rte_cryptodev_sym_session *
-rte_cryptodev_sym_session_free(uint8_t dev_id,
-               struct rte_cryptodev_sym_session *session);
+unsigned int
+rte_cryptodev_get_private_session_size(uint8_t dev_id);
 
 /**
  * Attach queue pair with sym session.
  *
- * @param      qp_id           Queue pair to which session will be attached.
+ * @param      dev_id          Device to which the session will be attached.
+ * @param      qp_id           Queue pair to which the session will be attached.
  * @param      session         Session pointer previously allocated by
  *                             *rte_cryptodev_sym_session_create*.
  *
@@ -991,13 +981,14 @@ rte_cryptodev_sym_session_free(uint8_t dev_id,
  *  - On failure, a negative value.
  */
 int
-rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
+rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
                struct rte_cryptodev_sym_session *session);
 
 /**
  * Detach queue pair with sym session.
  *
- * @param      qp_id           Queue pair to which session is attached.
+ * @param      dev_id          Device to which the session is attached.
+ * @param      qp_id           Queue pair to which the session is attached.
  * @param      session         Session pointer previously allocated by
  *                             *rte_cryptodev_sym_session_create*.
  *
@@ -1006,9 +997,48 @@ rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
  *  - On failure, a negative value.
  */
 int
-rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
+rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
                struct rte_cryptodev_sym_session *session);
 
+/**
+ * Provide driver identifier.
+ *
+ * @param name
+ *   The pointer to a driver name.
+ * @return
+ *  The driver type identifier or -1 if no driver found
+ */
+int rte_cryptodev_driver_id_get(const char *name);
+
+/**
+ * Provide driver name.
+ *
+ * @param driver_id
+ *   The driver identifier.
+ * @return
+ *  The driver name or null if no driver found
+ */
+const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
+
+/**
+ * @internal
+ * Allocate Cryptodev driver.
+ *
+ * @param driver
+ *   Pointer to rte_driver.
+ * @return
+ *  The driver type identifier
+ */
+uint8_t rte_cryptodev_allocate_driver(const struct rte_driver *driver);
+
+
+#define RTE_PMD_REGISTER_CRYPTO_DRIVER(drv, driver_id)\
+RTE_INIT(init_ ##driver_id);\
+static void init_ ##driver_id(void)\
+{\
+       driver_id = rte_cryptodev_allocate_driver(&(drv).driver);\
+}
+
 
 #ifdef __cplusplus
 }