4 * Copyright(c) 2016 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 "null_crypto_pmd_private.h"
41 static const struct rte_cryptodev_capabilities null_crypto_pmd_capabilities
[] = {
43 .op
= RTE_CRYPTO_OP_TYPE_SYMMETRIC
,
45 .xform_type
= RTE_CRYPTO_SYM_XFORM_AUTH
,
47 .algo
= RTE_CRYPTO_AUTH_NULL
,
64 .op
= RTE_CRYPTO_OP_TYPE_SYMMETRIC
,
66 .xform_type
= RTE_CRYPTO_SYM_XFORM_CIPHER
,
68 .algo
= RTE_CRYPTO_CIPHER_NULL
,
83 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
86 /** Configure device */
88 null_crypto_pmd_config(__rte_unused
struct rte_cryptodev
*dev
)
95 null_crypto_pmd_start(__rte_unused
struct rte_cryptodev
*dev
)
102 null_crypto_pmd_stop(__rte_unused
struct rte_cryptodev
*dev
)
108 null_crypto_pmd_close(__rte_unused
struct rte_cryptodev
*dev
)
113 /** Get device statistics */
115 null_crypto_pmd_stats_get(struct rte_cryptodev
*dev
,
116 struct rte_cryptodev_stats
*stats
)
120 for (qp_id
= 0; qp_id
< dev
->data
->nb_queue_pairs
; qp_id
++) {
121 struct null_crypto_qp
*qp
= dev
->data
->queue_pairs
[qp_id
];
123 stats
->enqueued_count
+= qp
->qp_stats
.enqueued_count
;
124 stats
->dequeued_count
+= qp
->qp_stats
.dequeued_count
;
126 stats
->enqueue_err_count
+= qp
->qp_stats
.enqueue_err_count
;
127 stats
->dequeue_err_count
+= qp
->qp_stats
.dequeue_err_count
;
131 /** Reset device statistics */
133 null_crypto_pmd_stats_reset(struct rte_cryptodev
*dev
)
137 for (qp_id
= 0; qp_id
< dev
->data
->nb_queue_pairs
; qp_id
++) {
138 struct null_crypto_qp
*qp
= dev
->data
->queue_pairs
[qp_id
];
140 memset(&qp
->qp_stats
, 0, sizeof(qp
->qp_stats
));
145 /** Get device info */
147 null_crypto_pmd_info_get(struct rte_cryptodev
*dev
,
148 struct rte_cryptodev_info
*dev_info
)
150 struct null_crypto_private
*internals
= dev
->data
->dev_private
;
152 if (dev_info
!= NULL
) {
153 dev_info
->dev_type
= dev
->dev_type
;
154 dev_info
->max_nb_queue_pairs
= internals
->max_nb_qpairs
;
155 dev_info
->sym
.max_nb_sessions
= internals
->max_nb_sessions
;
156 dev_info
->feature_flags
= dev
->feature_flags
;
157 dev_info
->capabilities
= null_crypto_pmd_capabilities
;
161 /** Release queue pair */
163 null_crypto_pmd_qp_release(struct rte_cryptodev
*dev
, uint16_t qp_id
)
165 if (dev
->data
->queue_pairs
[qp_id
] != NULL
) {
166 rte_free(dev
->data
->queue_pairs
[qp_id
]);
167 dev
->data
->queue_pairs
[qp_id
] = NULL
;
172 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
174 null_crypto_pmd_qp_set_unique_name(struct rte_cryptodev
*dev
,
175 struct null_crypto_qp
*qp
)
177 unsigned n
= snprintf(qp
->name
, sizeof(qp
->name
),
178 "null_crypto_pmd_%u_qp_%u",
179 dev
->data
->dev_id
, qp
->id
);
181 if (n
> sizeof(qp
->name
))
187 /** Create a ring to place process packets on */
188 static struct rte_ring
*
189 null_crypto_pmd_qp_create_processed_pkts_ring(struct null_crypto_qp
*qp
,
190 unsigned ring_size
, int socket_id
)
194 r
= rte_ring_lookup(qp
->name
);
196 if (r
->prod
.size
>= ring_size
) {
197 NULL_CRYPTO_LOG_INFO(
198 "Reusing existing ring %s for processed packets",
203 NULL_CRYPTO_LOG_INFO(
204 "Unable to reuse existing ring %s for processed packets",
209 return rte_ring_create(qp
->name
, ring_size
, socket_id
,
210 RING_F_SP_ENQ
| RING_F_SC_DEQ
);
213 /** Setup a queue pair */
215 null_crypto_pmd_qp_setup(struct rte_cryptodev
*dev
, uint16_t qp_id
,
216 const struct rte_cryptodev_qp_conf
*qp_conf
,
219 struct null_crypto_private
*internals
= dev
->data
->dev_private
;
220 struct null_crypto_qp
*qp
;
223 if (qp_id
>= internals
->max_nb_qpairs
) {
224 NULL_CRYPTO_LOG_ERR("Invalid qp_id %u, greater than maximum "
225 "number of queue pairs supported (%u).",
226 qp_id
, internals
->max_nb_qpairs
);
230 /* Free memory prior to re-allocation if needed. */
231 if (dev
->data
->queue_pairs
[qp_id
] != NULL
)
232 null_crypto_pmd_qp_release(dev
, qp_id
);
234 /* Allocate the queue pair data structure. */
235 qp
= rte_zmalloc_socket("Null Crypto PMD Queue Pair", sizeof(*qp
),
236 RTE_CACHE_LINE_SIZE
, socket_id
);
238 NULL_CRYPTO_LOG_ERR("Failed to allocate queue pair memory");
243 dev
->data
->queue_pairs
[qp_id
] = qp
;
245 retval
= null_crypto_pmd_qp_set_unique_name(dev
, qp
);
247 NULL_CRYPTO_LOG_ERR("Failed to create unique name for null "
249 goto qp_setup_cleanup
;
252 qp
->processed_pkts
= null_crypto_pmd_qp_create_processed_pkts_ring(qp
,
253 qp_conf
->nb_descriptors
, socket_id
);
254 if (qp
->processed_pkts
== NULL
) {
255 NULL_CRYPTO_LOG_ERR("Failed to create unique name for null "
257 goto qp_setup_cleanup
;
260 qp
->sess_mp
= dev
->data
->session_pool
;
262 memset(&qp
->qp_stats
, 0, sizeof(qp
->qp_stats
));
273 /** Start queue pair */
275 null_crypto_pmd_qp_start(__rte_unused
struct rte_cryptodev
*dev
,
276 __rte_unused
uint16_t queue_pair_id
)
281 /** Stop queue pair */
283 null_crypto_pmd_qp_stop(__rte_unused
struct rte_cryptodev
*dev
,
284 __rte_unused
uint16_t queue_pair_id
)
289 /** Return the number of allocated queue pairs */
291 null_crypto_pmd_qp_count(struct rte_cryptodev
*dev
)
293 return dev
->data
->nb_queue_pairs
;
296 /** Returns the size of the NULL crypto session structure */
298 null_crypto_pmd_session_get_size(struct rte_cryptodev
*dev __rte_unused
)
300 return sizeof(struct null_crypto_session
);
303 /** Configure a null crypto session from a crypto xform chain */
305 null_crypto_pmd_session_configure(struct rte_cryptodev
*dev __rte_unused
,
306 struct rte_crypto_sym_xform
*xform
, void *sess
)
310 if (unlikely(sess
== NULL
)) {
311 NULL_CRYPTO_LOG_ERR("invalid session struct");
314 retval
= null_crypto_set_session_parameters(
315 (struct null_crypto_session
*)sess
, xform
);
317 NULL_CRYPTO_LOG_ERR("failed configure session parameters");
324 /** Clear the memory of session so it doesn't leave key material behind */
326 null_crypto_pmd_session_clear(struct rte_cryptodev
*dev __rte_unused
,
330 memset(sess
, 0, sizeof(struct null_crypto_session
));
333 struct rte_cryptodev_ops pmd_ops
= {
334 .dev_configure
= null_crypto_pmd_config
,
335 .dev_start
= null_crypto_pmd_start
,
336 .dev_stop
= null_crypto_pmd_stop
,
337 .dev_close
= null_crypto_pmd_close
,
339 .stats_get
= null_crypto_pmd_stats_get
,
340 .stats_reset
= null_crypto_pmd_stats_reset
,
342 .dev_infos_get
= null_crypto_pmd_info_get
,
344 .queue_pair_setup
= null_crypto_pmd_qp_setup
,
345 .queue_pair_release
= null_crypto_pmd_qp_release
,
346 .queue_pair_start
= null_crypto_pmd_qp_start
,
347 .queue_pair_stop
= null_crypto_pmd_qp_stop
,
348 .queue_pair_count
= null_crypto_pmd_qp_count
,
350 .session_get_size
= null_crypto_pmd_session_get_size
,
351 .session_configure
= null_crypto_pmd_session_configure
,
352 .session_clear
= null_crypto_pmd_session_clear
355 struct rte_cryptodev_ops
*null_crypto_pmd_ops
= &pmd_ops
;