New upstream version 18.08
[deb_dpdk.git] / lib / librte_cryptodev / rte_cryptodev_pmd.h
index 089848e..6ff49d6 100644 (file)
@@ -1,32 +1,5 @@
-/*-
- *
- *   Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2015-2016 Intel Corporation.
  */
 
 #ifndef _RTE_CRYPTODEV_PMD_H_
@@ -59,18 +32,15 @@ extern "C" {
 
 
 #define RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS   8
-#define RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_SESSIONS      2048
 
 #define RTE_CRYPTODEV_PMD_NAME_ARG                     ("name")
 #define RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG                        ("max_nb_queue_pairs")
-#define RTE_CRYPTODEV_PMD_MAX_NB_SESS_ARG              ("max_nb_sessions")
 #define RTE_CRYPTODEV_PMD_SOCKET_ID_ARG                        ("socket_id")
 
 
 static const char * const cryptodev_pmd_valid_params[] = {
        RTE_CRYPTODEV_PMD_NAME_ARG,
        RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG,
-       RTE_CRYPTODEV_PMD_MAX_NB_SESS_ARG,
        RTE_CRYPTODEV_PMD_SOCKET_ID_ARG
 };
 
@@ -83,7 +53,6 @@ struct rte_cryptodev_pmd_init_params {
        size_t private_data_size;
        int socket_id;
        unsigned int max_nb_queue_pairs;
-       unsigned int max_nb_sessions;
 };
 
 /** Global structure used for maintaining state of allocated crypto devices */
@@ -215,28 +184,6 @@ typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);
 typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
                                struct rte_cryptodev_info *dev_info);
 
-/**
- * Start queue pair of a device.
- *
- * @param      dev     Crypto device pointer
- * @param      qp_id   Queue Pair Index
- *
- * @return     Returns 0 on success.
- */
-typedef int (*cryptodev_queue_pair_start_t)(struct rte_cryptodev *dev,
-                               uint16_t qp_id);
-
-/**
- * Stop queue pair of a device.
- *
- * @param      dev     Crypto device pointer
- * @param      qp_id   Queue Pair Index
- *
- * @return     Returns 0 on success.
- */
-typedef int (*cryptodev_queue_pair_stop_t)(struct rte_cryptodev *dev,
-                               uint16_t qp_id);
-
 /**
  * Setup a queue pair for a device.
  *
@@ -302,6 +249,17 @@ typedef int (*cryptodev_sym_create_session_pool_t)(
  */
 typedef unsigned (*cryptodev_sym_get_session_private_size_t)(
                struct rte_cryptodev *dev);
+/**
+ * Get the size of a asymmetric cryptodev session
+ *
+ * @param      dev             Crypto device pointer
+ *
+ * @return
+ *  - On success returns the size of the session structure for device
+ *  - On failure returns 0
+ */
+typedef unsigned int (*cryptodev_asym_get_session_private_size_t)(
+               struct rte_cryptodev *dev);
 
 /**
  * Configure a Crypto session on a device.
@@ -321,7 +279,24 @@ typedef int (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
                struct rte_crypto_sym_xform *xform,
                struct rte_cryptodev_sym_session *session,
                struct rte_mempool *mp);
-
+/**
+ * Configure a Crypto asymmetric session on a device.
+ *
+ * @param      dev             Crypto device pointer
+ * @param      xform           Single or chain of crypto xforms
+ * @param      priv_sess       Pointer to cryptodev's private session structure
+ * @param      mp              Mempool where the private session is allocated
+ *
+ * @return
+ *  - Returns 0 if private session structure have been created successfully.
+ *  - Returns -EINVAL if input parameters are invalid.
+ *  - Returns -ENOTSUP if crypto device does not support the crypto transform.
+ *  - Returns -ENOMEM if the private session could not be allocated.
+ */
+typedef int (*cryptodev_asym_configure_session_t)(struct rte_cryptodev *dev,
+               struct rte_crypto_asym_xform *xform,
+               struct rte_cryptodev_asym_session *session,
+               struct rte_mempool *mp);
 /**
  * Free driver private session data.
  *
@@ -330,32 +305,14 @@ typedef int (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
  */
 typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
                struct rte_cryptodev_sym_session *sess);
-
-/**
- * Optional API for drivers to attach sessions with queue pair.
- * @param      dev             Crypto device pointer
- * @param      qp_id           queue pair id for attaching session
- * @param      priv_sess       Pointer to cryptodev's private session structure
- * @return
- *  - Return 0 on success
- */
-typedef int (*cryptodev_sym_queue_pair_attach_session_t)(
-                 struct rte_cryptodev *dev,
-                 uint16_t qp_id,
-                 void *session_private);
-
 /**
- * Optional API for drivers to detach sessions from queue pair.
+ * Free asymmetric session private data.
+ *
  * @param      dev             Crypto device pointer
- * @param      qp_id           queue pair id for detaching session
- * @param      priv_sess       Pointer to cryptodev's private session structure
- * @return
- *  - Return 0 on success
+ * @param      sess            Cryptodev session structure
  */
-typedef int (*cryptodev_sym_queue_pair_detach_session_t)(
-                 struct rte_cryptodev *dev,
-                 uint16_t qp_id,
-                 void *session_private);
+typedef void (*cryptodev_asym_free_session_t)(struct rte_cryptodev *dev,
+               struct rte_cryptodev_asym_session *sess);
 
 /** Crypto device operations function pointer table */
 struct rte_cryptodev_ops {
@@ -375,23 +332,21 @@ struct rte_cryptodev_ops {
        /**< Set up a device queue pair. */
        cryptodev_queue_pair_release_t queue_pair_release;
        /**< Release a queue pair. */
-       cryptodev_queue_pair_start_t queue_pair_start;
-       /**< Start a queue pair. */
-       cryptodev_queue_pair_stop_t queue_pair_stop;
-       /**< Stop a queue pair. */
        cryptodev_queue_pair_count_t queue_pair_count;
        /**< Get count of the queue pairs. */
 
-       cryptodev_sym_get_session_private_size_t session_get_size;
+       cryptodev_sym_get_session_private_size_t sym_session_get_size;
        /**< Return private session. */
-       cryptodev_sym_configure_session_t session_configure;
+       cryptodev_asym_get_session_private_size_t asym_session_get_size;
+       /**< Return asym session private size. */
+       cryptodev_sym_configure_session_t sym_session_configure;
        /**< Configure a Crypto session. */
-       cryptodev_sym_free_session_t session_clear;
+       cryptodev_asym_configure_session_t asym_session_configure;
+       /**< Configure asymmetric Crypto session. */
+       cryptodev_sym_free_session_t sym_session_clear;
+       /**< Clear a Crypto sessions private data. */
+       cryptodev_asym_free_session_t asym_session_clear;
        /**< Clear a Crypto sessions private data. */
-       cryptodev_sym_queue_pair_attach_session_t qp_attach_session;
-       /**< Attach session to queue pair. */
-       cryptodev_sym_queue_pair_detach_session_t qp_detach_session;
-       /**< Detach session from queue pair. */
 };
 
 
@@ -516,20 +471,32 @@ uint8_t rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
 
 
 #define RTE_PMD_REGISTER_CRYPTO_DRIVER(crypto_drv, drv, driver_id)\
-RTE_INIT(init_ ##driver_id);\
-static void init_ ##driver_id(void)\
+RTE_INIT(init_ ##driver_id)\
 {\
-       driver_id = rte_cryptodev_allocate_driver(&crypto_drv, &(drv).driver);\
+       driver_id = rte_cryptodev_allocate_driver(&crypto_drv, &(drv));\
+}
+
+static inline void *
+get_sym_session_private_data(const struct rte_cryptodev_sym_session *sess,
+               uint8_t driver_id) {
+       return sess->sess_private_data[driver_id];
+}
+
+static inline void
+set_sym_session_private_data(struct rte_cryptodev_sym_session *sess,
+               uint8_t driver_id, void *private_data)
+{
+       sess->sess_private_data[driver_id] = private_data;
 }
 
 static inline void *
-get_session_private_data(const struct rte_cryptodev_sym_session *sess,
+get_asym_session_private_data(const struct rte_cryptodev_asym_session *sess,
                uint8_t driver_id) {
        return sess->sess_private_data[driver_id];
 }
 
 static inline void
-set_session_private_data(struct rte_cryptodev_sym_session *sess,
+set_asym_session_private_data(struct rte_cryptodev_asym_session *sess,
                uint8_t driver_id, void *private_data)
 {
        sess->sess_private_data[driver_id] = private_data;