4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <rte_common.h>
36 #include <rte_malloc.h>
37 #include <rte_cryptodev_pmd.h>
39 #include "rte_kasumi_pmd_private.h"
41 static const struct rte_cryptodev_capabilities kasumi_pmd_capabilities[] = {
43 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
45 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
47 .algo = RTE_CRYPTO_AUTH_KASUMI_F9,
64 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
66 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
68 .algo = RTE_CRYPTO_CIPHER_KASUMI_F8,
83 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
86 /** Configure device */
88 kasumi_pmd_config(__rte_unused struct rte_cryptodev *dev,
89 __rte_unused struct rte_cryptodev_config *config)
96 kasumi_pmd_start(__rte_unused struct rte_cryptodev *dev)
103 kasumi_pmd_stop(__rte_unused struct rte_cryptodev *dev)
109 kasumi_pmd_close(__rte_unused struct rte_cryptodev *dev)
115 /** Get device statistics */
117 kasumi_pmd_stats_get(struct rte_cryptodev *dev,
118 struct rte_cryptodev_stats *stats)
122 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
123 struct kasumi_qp *qp = dev->data->queue_pairs[qp_id];
125 stats->enqueued_count += qp->qp_stats.enqueued_count;
126 stats->dequeued_count += qp->qp_stats.dequeued_count;
128 stats->enqueue_err_count += qp->qp_stats.enqueue_err_count;
129 stats->dequeue_err_count += qp->qp_stats.dequeue_err_count;
133 /** Reset device statistics */
135 kasumi_pmd_stats_reset(struct rte_cryptodev *dev)
139 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
140 struct kasumi_qp *qp = dev->data->queue_pairs[qp_id];
142 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
147 /** Get device info */
149 kasumi_pmd_info_get(struct rte_cryptodev *dev,
150 struct rte_cryptodev_info *dev_info)
152 struct kasumi_private *internals = dev->data->dev_private;
154 if (dev_info != NULL) {
155 dev_info->driver_id = dev->driver_id;
156 dev_info->max_nb_queue_pairs = internals->max_nb_queue_pairs;
157 dev_info->sym.max_nb_sessions = internals->max_nb_sessions;
158 dev_info->feature_flags = dev->feature_flags;
159 dev_info->capabilities = kasumi_pmd_capabilities;
163 /** Release queue pair */
165 kasumi_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
167 struct kasumi_qp *qp = dev->data->queue_pairs[qp_id];
170 rte_ring_free(qp->processed_ops);
172 dev->data->queue_pairs[qp_id] = NULL;
177 /** set a unique name for the queue pair based on its name, dev_id and qp_id */
179 kasumi_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
180 struct kasumi_qp *qp)
182 unsigned n = snprintf(qp->name, sizeof(qp->name),
183 "kasumi_pmd_%u_qp_%u",
184 dev->data->dev_id, qp->id);
186 if (n >= sizeof(qp->name))
192 /** Create a ring to place processed ops on */
193 static struct rte_ring *
194 kasumi_pmd_qp_create_processed_ops_ring(struct kasumi_qp *qp,
195 unsigned ring_size, int socket_id)
199 r = rte_ring_lookup(qp->name);
201 if (rte_ring_get_size(r) == ring_size) {
202 KASUMI_LOG_INFO("Reusing existing ring %s"
203 " for processed packets",
208 KASUMI_LOG_ERR("Unable to reuse existing ring %s"
209 " for processed packets",
214 return rte_ring_create(qp->name, ring_size, socket_id,
215 RING_F_SP_ENQ | RING_F_SC_DEQ);
218 /** Setup a queue pair */
220 kasumi_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
221 const struct rte_cryptodev_qp_conf *qp_conf,
222 int socket_id, struct rte_mempool *session_pool)
224 struct kasumi_qp *qp = NULL;
226 /* Free memory prior to re-allocation if needed. */
227 if (dev->data->queue_pairs[qp_id] != NULL)
228 kasumi_pmd_qp_release(dev, qp_id);
230 /* Allocate the queue pair data structure. */
231 qp = rte_zmalloc_socket("KASUMI PMD Queue Pair", sizeof(*qp),
232 RTE_CACHE_LINE_SIZE, socket_id);
237 dev->data->queue_pairs[qp_id] = qp;
239 if (kasumi_pmd_qp_set_unique_name(dev, qp))
240 goto qp_setup_cleanup;
242 qp->processed_ops = kasumi_pmd_qp_create_processed_ops_ring(qp,
243 qp_conf->nb_descriptors, socket_id);
244 if (qp->processed_ops == NULL)
245 goto qp_setup_cleanup;
247 qp->sess_mp = session_pool;
249 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
259 /** Start queue pair */
261 kasumi_pmd_qp_start(__rte_unused struct rte_cryptodev *dev,
262 __rte_unused uint16_t queue_pair_id)
267 /** Stop queue pair */
269 kasumi_pmd_qp_stop(__rte_unused struct rte_cryptodev *dev,
270 __rte_unused uint16_t queue_pair_id)
275 /** Return the number of allocated queue pairs */
277 kasumi_pmd_qp_count(struct rte_cryptodev *dev)
279 return dev->data->nb_queue_pairs;
282 /** Returns the size of the KASUMI session structure */
284 kasumi_pmd_session_get_size(struct rte_cryptodev *dev __rte_unused)
286 return sizeof(struct kasumi_session);
289 /** Configure a KASUMI session from a crypto xform chain */
291 kasumi_pmd_session_configure(struct rte_cryptodev *dev __rte_unused,
292 struct rte_crypto_sym_xform *xform,
293 struct rte_cryptodev_sym_session *sess,
294 struct rte_mempool *mempool)
296 void *sess_private_data;
299 if (unlikely(sess == NULL)) {
300 KASUMI_LOG_ERR("invalid session struct");
304 if (rte_mempool_get(mempool, &sess_private_data)) {
306 "Couldn't get object from session mempool");
310 ret = kasumi_set_session_parameters(sess_private_data, xform);
312 KASUMI_LOG_ERR("failed configure session parameters");
314 /* Return session to mempool */
315 rte_mempool_put(mempool, sess_private_data);
319 set_session_private_data(sess, dev->driver_id,
325 /** Clear the memory of session so it doesn't leave key material behind */
327 kasumi_pmd_session_clear(struct rte_cryptodev *dev,
328 struct rte_cryptodev_sym_session *sess)
330 uint8_t index = dev->driver_id;
331 void *sess_priv = get_session_private_data(sess, index);
333 /* Zero out the whole structure */
335 memset(sess_priv, 0, sizeof(struct kasumi_session));
336 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
337 set_session_private_data(sess, index, NULL);
338 rte_mempool_put(sess_mp, sess_priv);
342 struct rte_cryptodev_ops kasumi_pmd_ops = {
343 .dev_configure = kasumi_pmd_config,
344 .dev_start = kasumi_pmd_start,
345 .dev_stop = kasumi_pmd_stop,
346 .dev_close = kasumi_pmd_close,
348 .stats_get = kasumi_pmd_stats_get,
349 .stats_reset = kasumi_pmd_stats_reset,
351 .dev_infos_get = kasumi_pmd_info_get,
353 .queue_pair_setup = kasumi_pmd_qp_setup,
354 .queue_pair_release = kasumi_pmd_qp_release,
355 .queue_pair_start = kasumi_pmd_qp_start,
356 .queue_pair_stop = kasumi_pmd_qp_stop,
357 .queue_pair_count = kasumi_pmd_qp_count,
359 .session_get_size = kasumi_pmd_session_get_size,
360 .session_configure = kasumi_pmd_session_configure,
361 .session_clear = kasumi_pmd_session_clear
364 struct rte_cryptodev_ops *rte_kasumi_pmd_ops = &kasumi_pmd_ops;