drivers/crypto/mvsam/rte_mrvl_pmd.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Marvell International Ltd.
   3  * Copyright(c) 2017 Semihalf.
   4  * All rights reserved.
   5  */
   6
   7 #include <rte_common.h>
   8 #include <rte_hexdump.h>
   9 #include <rte_cryptodev.h>
  10 #include <rte_cryptodev_pmd.h>
  11 #include <rte_bus_vdev.h>
  12 #include <rte_malloc.h>
  13 #include <rte_cpuflags.h>
  14 #include <rte_kvargs.h>
  15
  16 #include "rte_mrvl_pmd_private.h"
  17
  18 #define MRVL_MUSDK_DMA_MEMSIZE 41943040
  19
  20 #define MRVL_PMD_MAX_NB_SESS_ARG                ("max_nb_sessions")
  21 #define MRVL_PMD_DEFAULT_MAX_NB_SESSIONS        2048
  22
  23 static uint8_t cryptodev_driver_id;
  24
  25 struct mrvl_pmd_init_params {
  26         struct rte_cryptodev_pmd_init_params common;
  27         uint32_t max_nb_sessions;
  28 };
  29
  30 const char *mrvl_pmd_valid_params[] = {
  31         RTE_CRYPTODEV_PMD_NAME_ARG,
  32         RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG,
  33         RTE_CRYPTODEV_PMD_SOCKET_ID_ARG,
  34         MRVL_PMD_MAX_NB_SESS_ARG
  35 };
  36
  37 /**
  38  * Flag if particular crypto algorithm is supported by PMD/MUSDK.
  39  *
  40  * The idea is to have Not Supported value as default (0).
  41  * This way we need only to define proper map sizes,
  42  * non-initialized entries will be by default not supported.
  43  */
  44 enum algo_supported {
  45         ALGO_NOT_SUPPORTED = 0,
  46         ALGO_SUPPORTED = 1,
  47 };
  48
  49 /** Map elements for cipher mapping.*/
  50 struct cipher_params_mapping {
  51         enum algo_supported  supported;   /**< On/Off switch */
  52         enum sam_cipher_alg  cipher_alg;  /**< Cipher algorithm */
  53         enum sam_cipher_mode cipher_mode; /**< Cipher mode */
  54         unsigned int max_key_len;         /**< Maximum key length (in bytes)*/
  55 }
  56 /* We want to squeeze in multiple maps into the cache line. */
  57 __rte_aligned(32);
  58
  59 /** Map elements for auth mapping.*/
  60 struct auth_params_mapping {
  61         enum algo_supported supported;  /**< On/off switch */
  62         enum sam_auth_alg   auth_alg;   /**< Auth algorithm */
  63 }
  64 /* We want to squeeze in multiple maps into the cache line. */
  65 __rte_aligned(32);
  66
  67 /**
  68  * Map of supported cipher algorithms.
  69  */
  70 static const
  71 struct cipher_params_mapping cipher_map[RTE_CRYPTO_CIPHER_LIST_END] = {
  72         [RTE_CRYPTO_CIPHER_3DES_CBC] = {
  73                 .supported = ALGO_SUPPORTED,
  74                 .cipher_alg = SAM_CIPHER_3DES,
  75                 .cipher_mode = SAM_CIPHER_CBC,
  76                 .max_key_len = BITS2BYTES(192) },
  77         [RTE_CRYPTO_CIPHER_3DES_CTR] = {
  78                 .supported = ALGO_SUPPORTED,
  79                 .cipher_alg = SAM_CIPHER_3DES,
  80                 .cipher_mode = SAM_CIPHER_CTR,
  81                 .max_key_len = BITS2BYTES(192) },
  82         [RTE_CRYPTO_CIPHER_3DES_ECB] = {
  83                 .supported = ALGO_SUPPORTED,
  84                 .cipher_alg = SAM_CIPHER_3DES,
  85                 .cipher_mode = SAM_CIPHER_ECB,
  86                 .max_key_len = BITS2BYTES(192) },
  87         [RTE_CRYPTO_CIPHER_AES_CBC] = {
  88                 .supported = ALGO_SUPPORTED,
  89                 .cipher_alg = SAM_CIPHER_AES,
  90                 .cipher_mode = SAM_CIPHER_CBC,
  91                 .max_key_len = BITS2BYTES(256) },
  92         [RTE_CRYPTO_CIPHER_AES_CTR] = {
  93                 .supported = ALGO_SUPPORTED,
  94                 .cipher_alg = SAM_CIPHER_AES,
  95                 .cipher_mode = SAM_CIPHER_CTR,
  96                 .max_key_len = BITS2BYTES(256) },
  97 };
  98
  99 /**
 100  * Map of supported auth algorithms.
 101  */
 102 static const
 103 struct auth_params_mapping auth_map[RTE_CRYPTO_AUTH_LIST_END] = {
 104         [RTE_CRYPTO_AUTH_MD5_HMAC] = {
 105                 .supported = ALGO_SUPPORTED,
 106                 .auth_alg = SAM_AUTH_HMAC_MD5 },
 107         [RTE_CRYPTO_AUTH_MD5] = {
 108                 .supported = ALGO_SUPPORTED,
 109                 .auth_alg = SAM_AUTH_HASH_MD5 },
 110         [RTE_CRYPTO_AUTH_SHA1_HMAC] = {
 111                 .supported = ALGO_SUPPORTED,
 112                 .auth_alg = SAM_AUTH_HMAC_SHA1 },
 113         [RTE_CRYPTO_AUTH_SHA1] = {
 114                 .supported = ALGO_SUPPORTED,
 115                 .auth_alg = SAM_AUTH_HASH_SHA1 },
 116         [RTE_CRYPTO_AUTH_SHA224_HMAC] = {
 117                 .supported = ALGO_SUPPORTED,
 118                 .auth_alg = SAM_AUTH_HMAC_SHA2_224 },
 119         [RTE_CRYPTO_AUTH_SHA224] = {
 120                 .supported = ALGO_SUPPORTED,
 121                 .auth_alg = SAM_AUTH_HASH_SHA2_224 },
 122         [RTE_CRYPTO_AUTH_SHA256_HMAC] = {
 123                 .supported = ALGO_SUPPORTED,
 124                 .auth_alg = SAM_AUTH_HMAC_SHA2_256 },
 125         [RTE_CRYPTO_AUTH_SHA256] = {
 126                 .supported = ALGO_SUPPORTED,
 127                 .auth_alg = SAM_AUTH_HASH_SHA2_256 },
 128         [RTE_CRYPTO_AUTH_SHA384_HMAC] = {
 129                 .supported = ALGO_SUPPORTED,
 130                 .auth_alg = SAM_AUTH_HMAC_SHA2_384 },
 131         [RTE_CRYPTO_AUTH_SHA384] = {
 132                 .supported = ALGO_SUPPORTED,
 133                 .auth_alg = SAM_AUTH_HASH_SHA2_384 },
 134         [RTE_CRYPTO_AUTH_SHA512_HMAC] = {
 135                 .supported = ALGO_SUPPORTED,
 136                 .auth_alg = SAM_AUTH_HMAC_SHA2_512 },
 137         [RTE_CRYPTO_AUTH_SHA512] = {
 138                 .supported = ALGO_SUPPORTED,
 139                 .auth_alg = SAM_AUTH_HASH_SHA2_512 },
 140         [RTE_CRYPTO_AUTH_AES_GMAC] = {
 141                 .supported = ALGO_SUPPORTED,
 142                 .auth_alg = SAM_AUTH_AES_GMAC },
 143 };
 144
 145 /**
 146  * Map of supported aead algorithms.
 147  */
 148 static const
 149 struct cipher_params_mapping aead_map[RTE_CRYPTO_AEAD_LIST_END] = {
 150         [RTE_CRYPTO_AEAD_AES_GCM] = {
 151                 .supported = ALGO_SUPPORTED,
 152                 .cipher_alg = SAM_CIPHER_AES,
 153                 .cipher_mode = SAM_CIPHER_GCM,
 154                 .max_key_len = BITS2BYTES(256) },
 155 };
 156
 157 /*
 158  *-----------------------------------------------------------------------------
 159  * Forward declarations.
 160  *-----------------------------------------------------------------------------
 161  */
 162 static int cryptodev_mrvl_crypto_uninit(struct rte_vdev_device *vdev);
 163
 164 /*
 165  *-----------------------------------------------------------------------------
 166  * Session Preparation.
 167  *-----------------------------------------------------------------------------
 168  */
 169
 170 /**
 171  * Get xform chain order.
 172  *
 173  * @param xform Pointer to configuration structure chain for crypto operations.
 174  * @returns Order of crypto operations.
 175  */
 176 static enum mrvl_crypto_chain_order
 177 mrvl_crypto_get_chain_order(const struct rte_crypto_sym_xform *xform)
 178 {
 179         /* Currently, Marvell supports max 2 operations in chain */
 180         if (xform->next != NULL && xform->next->next != NULL)
 181                 return MRVL_CRYPTO_CHAIN_NOT_SUPPORTED;
 182
 183         if (xform->next != NULL) {
 184                 if ((xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) &&
 185                         (xform->next->type == RTE_CRYPTO_SYM_XFORM_CIPHER))
 186                         return MRVL_CRYPTO_CHAIN_AUTH_CIPHER;
 187
 188                 if ((xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) &&
 189                         (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH))
 190                         return MRVL_CRYPTO_CHAIN_CIPHER_AUTH;
 191         } else {
 192                 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH)
 193                         return MRVL_CRYPTO_CHAIN_AUTH_ONLY;
 194
 195                 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER)
 196                         return MRVL_CRYPTO_CHAIN_CIPHER_ONLY;
 197
 198                 if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD)
 199                         return MRVL_CRYPTO_CHAIN_COMBINED;
 200         }
 201         return MRVL_CRYPTO_CHAIN_NOT_SUPPORTED;
 202 }
 203
 204 /**
 205  * Set session parameters for cipher part.
 206  *
 207  * @param sess Crypto session pointer.
 208  * @param cipher_xform Pointer to configuration structure for cipher operations.
 209  * @returns 0 in case of success, negative value otherwise.
 210  */
 211 static int
 212 mrvl_crypto_set_cipher_session_parameters(struct mrvl_crypto_session *sess,
 213                 const struct rte_crypto_sym_xform *cipher_xform)
 214 {
 215         /* Make sure we've got proper struct */
 216         if (cipher_xform->type != RTE_CRYPTO_SYM_XFORM_CIPHER) {
 217                 MRVL_CRYPTO_LOG_ERR("Wrong xform struct provided!");
 218                 return -EINVAL;
 219         }
 220
 221         /* See if map data is present and valid */
 222         if ((cipher_xform->cipher.algo > RTE_DIM(cipher_map)) ||
 223                 (cipher_map[cipher_xform->cipher.algo].supported
 224                         != ALGO_SUPPORTED)) {
 225                 MRVL_CRYPTO_LOG_ERR("Cipher algorithm not supported!");
 226                 return -EINVAL;
 227         }
 228
 229         sess->cipher_iv_offset = cipher_xform->cipher.iv.offset;
 230
 231         sess->sam_sess_params.dir =
 232                 (cipher_xform->cipher.op == RTE_CRYPTO_CIPHER_OP_ENCRYPT) ?
 233                 SAM_DIR_ENCRYPT : SAM_DIR_DECRYPT;
 234         sess->sam_sess_params.cipher_alg =
 235                 cipher_map[cipher_xform->cipher.algo].cipher_alg;
 236         sess->sam_sess_params.cipher_mode =
 237                 cipher_map[cipher_xform->cipher.algo].cipher_mode;
 238
 239         /* Assume IV will be passed together with data. */
 240         sess->sam_sess_params.cipher_iv = NULL;
 241
 242         /* Get max key length. */
 243         if (cipher_xform->cipher.key.length >
 244                 cipher_map[cipher_xform->cipher.algo].max_key_len) {
 245                 MRVL_CRYPTO_LOG_ERR("Wrong key length!");
 246                 return -EINVAL;
 247         }
 248
 249         sess->sam_sess_params.cipher_key_len = cipher_xform->cipher.key.length;
 250         sess->sam_sess_params.cipher_key = cipher_xform->cipher.key.data;
 251
 252         return 0;
 253 }
 254
 255 /**
 256  * Set session parameters for authentication part.
 257  *
 258  * @param sess Crypto session pointer.
 259  * @param auth_xform Pointer to configuration structure for auth operations.
 260  * @returns 0 in case of success, negative value otherwise.
 261  */
 262 static int
 263 mrvl_crypto_set_auth_session_parameters(struct mrvl_crypto_session *sess,
 264                 const struct rte_crypto_sym_xform *auth_xform)
 265 {
 266         /* Make sure we've got proper struct */
 267         if (auth_xform->type != RTE_CRYPTO_SYM_XFORM_AUTH) {
 268                 MRVL_CRYPTO_LOG_ERR("Wrong xform struct provided!");
 269                 return -EINVAL;
 270         }
 271
 272         /* See if map data is present and valid */
 273         if ((auth_xform->auth.algo > RTE_DIM(auth_map)) ||
 274                 (auth_map[auth_xform->auth.algo].supported != ALGO_SUPPORTED)) {
 275                 MRVL_CRYPTO_LOG_ERR("Auth algorithm not supported!");
 276                 return -EINVAL;
 277         }
 278
 279         sess->sam_sess_params.dir =
 280                 (auth_xform->auth.op == RTE_CRYPTO_AUTH_OP_GENERATE) ?
 281                 SAM_DIR_ENCRYPT : SAM_DIR_DECRYPT;
 282         sess->sam_sess_params.auth_alg =
 283                 auth_map[auth_xform->auth.algo].auth_alg;
 284         sess->sam_sess_params.u.basic.auth_icv_len =
 285                 auth_xform->auth.digest_length;
 286         /* auth_key must be NULL if auth algorithm does not use HMAC */
 287         sess->sam_sess_params.auth_key = auth_xform->auth.key.length ?
 288                                          auth_xform->auth.key.data : NULL;
 289         sess->sam_sess_params.auth_key_len = auth_xform->auth.key.length;
 290
 291         return 0;
 292 }
 293
 294 /**
 295  * Set session parameters for aead part.
 296  *
 297  * @param sess Crypto session pointer.
 298  * @param aead_xform Pointer to configuration structure for aead operations.
 299  * @returns 0 in case of success, negative value otherwise.
 300  */
 301 static int
 302 mrvl_crypto_set_aead_session_parameters(struct mrvl_crypto_session *sess,
 303                 const struct rte_crypto_sym_xform *aead_xform)
 304 {
 305         /* Make sure we've got proper struct */
 306         if (aead_xform->type != RTE_CRYPTO_SYM_XFORM_AEAD) {
 307                 MRVL_CRYPTO_LOG_ERR("Wrong xform struct provided!");
 308                 return -EINVAL;
 309         }
 310
 311         /* See if map data is present and valid */
 312         if ((aead_xform->aead.algo > RTE_DIM(aead_map)) ||
 313                 (aead_map[aead_xform->aead.algo].supported
 314                         != ALGO_SUPPORTED)) {
 315                 MRVL_CRYPTO_LOG_ERR("AEAD algorithm not supported!");
 316                 return -EINVAL;
 317         }
 318
 319         sess->sam_sess_params.dir =
 320                 (aead_xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT) ?
 321                 SAM_DIR_ENCRYPT : SAM_DIR_DECRYPT;
 322         sess->sam_sess_params.cipher_alg =
 323                 aead_map[aead_xform->aead.algo].cipher_alg;
 324         sess->sam_sess_params.cipher_mode =
 325                 aead_map[aead_xform->aead.algo].cipher_mode;
 326
 327         /* Assume IV will be passed together with data. */
 328         sess->sam_sess_params.cipher_iv = NULL;
 329
 330         /* Get max key length. */
 331         if (aead_xform->aead.key.length >
 332                 aead_map[aead_xform->aead.algo].max_key_len) {
 333                 MRVL_CRYPTO_LOG_ERR("Wrong key length!");
 334                 return -EINVAL;
 335         }
 336
 337         sess->sam_sess_params.cipher_key = aead_xform->aead.key.data;
 338         sess->sam_sess_params.cipher_key_len = aead_xform->aead.key.length;
 339
 340         if (sess->sam_sess_params.cipher_mode == SAM_CIPHER_GCM)
 341                 sess->sam_sess_params.auth_alg = SAM_AUTH_AES_GCM;
 342
 343         sess->sam_sess_params.u.basic.auth_icv_len =
 344                 aead_xform->aead.digest_length;
 345
 346         sess->sam_sess_params.u.basic.auth_aad_len =
 347                 aead_xform->aead.aad_length;
 348
 349         return 0;
 350 }
 351
 352 /**
 353  * Parse crypto transform chain and setup session parameters.
 354  *
 355  * @param dev Pointer to crypto device
 356  * @param sess Poiner to crypto session
 357  * @param xform Pointer to configuration structure chain for crypto operations.
 358  * @returns 0 in case of success, negative value otherwise.
 359  */
 360 int
 361 mrvl_crypto_set_session_parameters(struct mrvl_crypto_session *sess,
 362                 const struct rte_crypto_sym_xform *xform)
 363 {
 364         const struct rte_crypto_sym_xform *cipher_xform = NULL;
 365         const struct rte_crypto_sym_xform *auth_xform = NULL;
 366         const struct rte_crypto_sym_xform *aead_xform = NULL;
 367
 368         /* Filter out spurious/broken requests */
 369         if (xform == NULL)
 370                 return -EINVAL;
 371
 372         sess->chain_order = mrvl_crypto_get_chain_order(xform);
 373         switch (sess->chain_order) {
 374         case MRVL_CRYPTO_CHAIN_CIPHER_AUTH:
 375                 cipher_xform = xform;
 376                 auth_xform = xform->next;
 377                 break;
 378         case MRVL_CRYPTO_CHAIN_AUTH_CIPHER:
 379                 auth_xform = xform;
 380                 cipher_xform = xform->next;
 381                 break;
 382         case MRVL_CRYPTO_CHAIN_CIPHER_ONLY:
 383                 cipher_xform = xform;
 384                 break;
 385         case MRVL_CRYPTO_CHAIN_AUTH_ONLY:
 386                 auth_xform = xform;
 387                 break;
 388         case MRVL_CRYPTO_CHAIN_COMBINED:
 389                 aead_xform = xform;
 390                 break;
 391         default:
 392                 return -EINVAL;
 393         }
 394
 395         if ((cipher_xform != NULL) &&
 396                 (mrvl_crypto_set_cipher_session_parameters(
 397                         sess, cipher_xform) < 0)) {
 398                 MRVL_CRYPTO_LOG_ERR("Invalid/unsupported cipher parameters");
 399                 return -EINVAL;
 400         }
 401
 402         if ((auth_xform != NULL) &&
 403                 (mrvl_crypto_set_auth_session_parameters(
 404                         sess, auth_xform) < 0)) {
 405                 MRVL_CRYPTO_LOG_ERR("Invalid/unsupported auth parameters");
 406                 return -EINVAL;
 407         }
 408
 409         if ((aead_xform != NULL) &&
 410                 (mrvl_crypto_set_aead_session_parameters(
 411                         sess, aead_xform) < 0)) {
 412                 MRVL_CRYPTO_LOG_ERR("Invalid/unsupported aead parameters");
 413                 return -EINVAL;
 414         }
 415
 416         return 0;
 417 }
 418
 419 /*
 420  *-----------------------------------------------------------------------------
 421  * Process Operations
 422  *-----------------------------------------------------------------------------
 423  */
 424
 425 /**
 426  * Prepare a single request.
 427  *
 428  * This function basically translates DPDK crypto request into one
 429  * understandable by MUDSK's SAM. If this is a first request in a session,
 430  * it starts the session.
 431  *
 432  * @param request Pointer to pre-allocated && reset request buffer [Out].
 433  * @param src_bd Pointer to pre-allocated source descriptor [Out].
 434  * @param dst_bd Pointer to pre-allocated destination descriptor [Out].
 435  * @param op Pointer to DPDK crypto operation struct [In].
 436  */
 437 static inline int
 438 mrvl_request_prepare(struct sam_cio_op_params *request,
 439                 struct sam_buf_info *src_bd,
 440                 struct sam_buf_info *dst_bd,
 441                 struct rte_crypto_op *op)
 442 {
 443         struct mrvl_crypto_session *sess;
 444         struct rte_mbuf *dst_mbuf;
 445         uint8_t *digest;
 446
 447         if (unlikely(op->sess_type == RTE_CRYPTO_OP_SESSIONLESS)) {
 448                 MRVL_CRYPTO_LOG_ERR("MRVL CRYPTO PMD only supports session "
 449                                 "oriented requests, op (%p) is sessionless.",
 450                                 op);
 451                 return -EINVAL;
 452         }
 453
 454         sess = (struct mrvl_crypto_session *)get_sym_session_private_data(
 455                         op->sym->session, cryptodev_driver_id);
 456         if (unlikely(sess == NULL)) {
 457                 MRVL_CRYPTO_LOG_ERR("Session was not created for this device");
 458                 return -EINVAL;
 459         }
 460
 461         /*
 462          * If application delivered us null dst buffer, it means it expects
 463          * us to deliver the result in src buffer.
 464          */
 465         dst_mbuf = op->sym->m_dst ? op->sym->m_dst : op->sym->m_src;
 466
 467         request->sa = sess->sam_sess;
 468         request->cookie = op;
 469
 470         /* Single buffers only, sorry. */
 471         request->num_bufs = 1;
 472         request->src = src_bd;
 473         src_bd->vaddr = rte_pktmbuf_mtod(op->sym->m_src, void *);
 474         src_bd->paddr = rte_pktmbuf_iova(op->sym->m_src);
 475         src_bd->len = rte_pktmbuf_data_len(op->sym->m_src);
 476
 477         /* Empty source. */
 478         if (rte_pktmbuf_data_len(op->sym->m_src) == 0) {
 479                 /* EIP does not support 0 length buffers. */
 480                 MRVL_CRYPTO_LOG_ERR("Buffer length == 0 not supported!");
 481                 return -1;
 482         }
 483
 484         /* Empty destination. */
 485         if (rte_pktmbuf_data_len(dst_mbuf) == 0) {
 486                 /* Make dst buffer fit at least source data. */
 487                 if (rte_pktmbuf_append(dst_mbuf,
 488                         rte_pktmbuf_data_len(op->sym->m_src)) == NULL) {
 489                         MRVL_CRYPTO_LOG_ERR("Unable to set big enough dst buffer!");
 490                         return -1;
 491                 }
 492         }
 493
 494         request->dst = dst_bd;
 495         dst_bd->vaddr = rte_pktmbuf_mtod(dst_mbuf, void *);
 496         dst_bd->paddr = rte_pktmbuf_iova(dst_mbuf);
 497
 498         /*
 499          * We can use all available space in dst_mbuf,
 500          * not only what's used currently.
 501          */
 502         dst_bd->len = dst_mbuf->buf_len - rte_pktmbuf_headroom(dst_mbuf);
 503
 504         if (sess->chain_order == MRVL_CRYPTO_CHAIN_COMBINED) {
 505                 request->cipher_len = op->sym->aead.data.length;
 506                 request->cipher_offset = op->sym->aead.data.offset;
 507                 request->cipher_iv = rte_crypto_op_ctod_offset(op, uint8_t *,
 508                         sess->cipher_iv_offset);
 509
 510                 request->auth_aad = op->sym->aead.aad.data;
 511                 request->auth_offset = request->cipher_offset;
 512                 request->auth_len = request->cipher_len;
 513         } else {
 514                 request->cipher_len = op->sym->cipher.data.length;
 515                 request->cipher_offset = op->sym->cipher.data.offset;
 516                 request->cipher_iv = rte_crypto_op_ctod_offset(op, uint8_t *,
 517                                 sess->cipher_iv_offset);
 518
 519                 request->auth_offset = op->sym->auth.data.offset;
 520                 request->auth_len = op->sym->auth.data.length;
 521         }
 522
 523         digest = sess->chain_order == MRVL_CRYPTO_CHAIN_COMBINED ?
 524                 op->sym->aead.digest.data : op->sym->auth.digest.data;
 525         if (digest == NULL) {
 526                 /* No auth - no worry. */
 527                 return 0;
 528         }
 529
 530         request->auth_icv_offset = request->auth_offset + request->auth_len;
 531
 532         /*
 533          * EIP supports only scenarios where ICV(digest buffer) is placed at
 534          * auth_icv_offset. Any other placement means risking errors.
 535          */
 536         if (sess->sam_sess_params.dir == SAM_DIR_ENCRYPT) {
 537                 /*
 538                  * This should be the most common case anyway,
 539                  * EIP will overwrite DST buffer at auth_icv_offset.
 540                  */
 541                 if (rte_pktmbuf_mtod_offset(
 542                                 dst_mbuf, uint8_t *,
 543                                 request->auth_icv_offset) == digest) {
 544                         return 0;
 545                 }
 546         } else {/* sess->sam_sess_params.dir == SAM_DIR_DECRYPT */
 547                 /*
 548                  * EIP will look for digest at auth_icv_offset
 549                  * offset in SRC buffer.
 550                  */
 551                 if (rte_pktmbuf_mtod_offset(
 552                                 op->sym->m_src, uint8_t *,
 553                                 request->auth_icv_offset) == digest) {
 554                         return 0;
 555                 }
 556         }
 557
 558         /*
 559          * If we landed here it means that digest pointer is
 560          * at different than expected place.
 561          */
 562         return -1;
 563 }
 564
 565 /*
 566  *-----------------------------------------------------------------------------
 567  * PMD Framework handlers
 568  *-----------------------------------------------------------------------------
 569  */
 570
 571 /**
 572  * Enqueue burst.
 573  *
 574  * @param queue_pair Pointer to queue pair.
 575  * @param ops Pointer to ops requests array.
 576  * @param nb_ops Number of elements in ops requests array.
 577  * @returns Number of elements consumed from ops.
 578  */
 579 static uint16_t
 580 mrvl_crypto_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
 581                 uint16_t nb_ops)
 582 {
 583         uint16_t iter_ops = 0;
 584         uint16_t to_enq = 0;
 585         uint16_t consumed = 0;
 586         int ret;
 587         struct sam_cio_op_params requests[nb_ops];
 588         /*
 589          * DPDK uses single fragment buffers, so we can KISS descriptors.
 590          * SAM does not store bd pointers, so on-stack scope will be enough.
 591          */
 592         struct sam_buf_info src_bd[nb_ops];
 593         struct sam_buf_info dst_bd[nb_ops];
 594         struct mrvl_crypto_qp *qp = (struct mrvl_crypto_qp *)queue_pair;
 595
 596         if (nb_ops == 0)
 597                 return 0;
 598
 599         /* Prepare the burst. */
 600         memset(&requests, 0, sizeof(requests));
 601
 602         /* Iterate through */
 603         for (; iter_ops < nb_ops; ++iter_ops) {
 604                 if (mrvl_request_prepare(&requests[iter_ops],
 605                                         &src_bd[iter_ops],
 606                                         &dst_bd[iter_ops],
 607                                         ops[iter_ops]) < 0) {
 608                         MRVL_CRYPTO_LOG_ERR(
 609                                 "Error while parameters preparation!");
 610                         qp->stats.enqueue_err_count++;
 611                         ops[iter_ops]->status = RTE_CRYPTO_OP_STATUS_ERROR;
 612
 613                         /*
 614                          * Number of handled ops is increased
 615                          * (even if the result of handling is error).
 616                          */
 617                         ++consumed;
 618                         break;
 619                 }
 620
 621                 ops[iter_ops]->status =
 622                         RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
 623
 624                 /* Increase the number of ops to enqueue. */
 625                 ++to_enq;
 626         } /* for (; iter_ops < nb_ops;... */
 627
 628         if (to_enq > 0) {
 629                 /* Send the burst */
 630                 ret = sam_cio_enq(qp->cio, requests, &to_enq);
 631                 consumed += to_enq;
 632                 if (ret < 0) {
 633                         /*
 634                          * Trust SAM that in this case returned value will be at
 635                          * some point correct (now it is returned unmodified).
 636                          */
 637                         qp->stats.enqueue_err_count += to_enq;
 638                         for (iter_ops = 0; iter_ops < to_enq; ++iter_ops)
 639                                 ops[iter_ops]->status =
 640                                         RTE_CRYPTO_OP_STATUS_ERROR;
 641                 }
 642         }
 643
 644         qp->stats.enqueued_count += to_enq;
 645         return consumed;
 646 }
 647
 648 /**
 649  * Dequeue burst.
 650  *
 651  * @param queue_pair Pointer to queue pair.
 652  * @param ops Pointer to ops requests array.
 653  * @param nb_ops Number of elements in ops requests array.
 654  * @returns Number of elements dequeued.
 655  */
 656 static uint16_t
 657 mrvl_crypto_pmd_dequeue_burst(void *queue_pair,
 658                 struct rte_crypto_op **ops,
 659                 uint16_t nb_ops)
 660 {
 661         int ret;
 662         struct mrvl_crypto_qp *qp = queue_pair;
 663         struct sam_cio *cio = qp->cio;
 664         struct sam_cio_op_result results[nb_ops];
 665         uint16_t i;
 666
 667         ret = sam_cio_deq(cio, results, &nb_ops);
 668         if (ret < 0) {
 669                 /* Count all dequeued as error. */
 670                 qp->stats.dequeue_err_count += nb_ops;
 671
 672                 /* But act as they were dequeued anyway*/
 673                 qp->stats.dequeued_count += nb_ops;
 674
 675                 return 0;
 676         }
 677
 678         /* Unpack and check results. */
 679         for (i = 0; i < nb_ops; ++i) {
 680                 ops[i] = results[i].cookie;
 681
 682                 switch (results[i].status) {
 683                 case SAM_CIO_OK:
 684                         ops[i]->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
 685                         break;
 686                 case SAM_CIO_ERR_ICV:
 687                         MRVL_CRYPTO_LOG_DBG("CIO returned SAM_CIO_ERR_ICV.");
 688                         ops[i]->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
 689                         break;
 690                 default:
 691                         MRVL_CRYPTO_LOG_DBG(
 692                                 "CIO returned Error: %d", results[i].status);
 693                         ops[i]->status = RTE_CRYPTO_OP_STATUS_ERROR;
 694                         break;
 695                 }
 696         }
 697
 698         qp->stats.dequeued_count += nb_ops;
 699         return nb_ops;
 700 }
 701
 702 /**
 703  * Create a new crypto device.
 704  *
 705  * @param name Driver name.
 706  * @param vdev Pointer to device structure.
 707  * @param init_params Pointer to initialization parameters.
 708  * @returns 0 in case of success, negative value otherwise.
 709  */
 710 static int
 711 cryptodev_mrvl_crypto_create(const char *name,
 712                 struct rte_vdev_device *vdev,
 713                 struct mrvl_pmd_init_params *init_params)
 714 {
 715         struct rte_cryptodev *dev;
 716         struct mrvl_crypto_private *internals;
 717         struct sam_init_params  sam_params;
 718         int ret;
 719
 720         dev = rte_cryptodev_pmd_create(name, &vdev->device,
 721                         &init_params->common);
 722         if (dev == NULL) {
 723                 MRVL_CRYPTO_LOG_ERR("failed to create cryptodev vdev");
 724                 goto init_error;
 725         }
 726
 727         dev->driver_id = cryptodev_driver_id;
 728         dev->dev_ops = rte_mrvl_crypto_pmd_ops;
 729
 730         /* Register rx/tx burst functions for data path. */
 731         dev->enqueue_burst = mrvl_crypto_pmd_enqueue_burst;
 732         dev->dequeue_burst = mrvl_crypto_pmd_dequeue_burst;
 733
 734         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
 735                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
 736                         RTE_CRYPTODEV_FF_HW_ACCELERATED |
 737                         RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
 738                         RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT;
 739
 740         /* Set vector instructions mode supported */
 741         internals = dev->data->dev_private;
 742
 743         internals->max_nb_qpairs = init_params->common.max_nb_queue_pairs;
 744         internals->max_nb_sessions = init_params->max_nb_sessions;
 745
 746         /*
 747          * ret == -EEXIST is correct, it means DMA
 748          * has been already initialized.
 749          */
 750         ret = mv_sys_dma_mem_init(MRVL_MUSDK_DMA_MEMSIZE);
 751         if (ret < 0) {
 752                 if (ret != -EEXIST)
 753                         return ret;
 754
 755                 MRVL_CRYPTO_LOG_INFO(
 756                         "DMA memory has been already initialized by a different driver.");
 757         }
 758
 759         sam_params.max_num_sessions = internals->max_nb_sessions;
 760
 761         return sam_init(&sam_params);
 762
 763 init_error:
 764         MRVL_CRYPTO_LOG_ERR(
 765                 "driver %s: %s failed", init_params->common.name, __func__);
 766
 767         cryptodev_mrvl_crypto_uninit(vdev);
 768         return -EFAULT;
 769 }
 770
 771 /** Parse integer from integer argument */
 772 static int
 773 parse_integer_arg(const char *key __rte_unused,
 774                 const char *value, void *extra_args)
 775 {
 776         int *i = (int *) extra_args;
 777
 778         *i = atoi(value);
 779         if (*i < 0) {
 780                 MRVL_CRYPTO_LOG_ERR("Argument has to be positive.\n");
 781                 return -EINVAL;
 782         }
 783
 784         return 0;
 785 }
 786
 787 /** Parse name */
 788 static int
 789 parse_name_arg(const char *key __rte_unused,
 790                 const char *value, void *extra_args)
 791 {
 792         struct rte_cryptodev_pmd_init_params *params = extra_args;
 793
 794         if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
 795                 MRVL_CRYPTO_LOG_ERR("Invalid name %s, should be less than "
 796                                 "%u bytes.\n", value,
 797                                 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
 798                 return -EINVAL;
 799         }
 800
 801         strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
 802
 803         return 0;
 804 }
 805
 806 static int
 807 mrvl_pmd_parse_input_args(struct mrvl_pmd_init_params *params,
 808                          const char *input_args)
 809 {
 810         struct rte_kvargs *kvlist = NULL;
 811         int ret = 0;
 812
 813         if (params == NULL)
 814                 return -EINVAL;
 815
 816         if (input_args) {
 817                 kvlist = rte_kvargs_parse(input_args,
 818                                           mrvl_pmd_valid_params);
 819                 if (kvlist == NULL)
 820                         return -1;
 821
 822                 /* Common VDEV parameters */
 823                 ret = rte_kvargs_process(kvlist,
 824                                          RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG,
 825                                          &parse_integer_arg,
 826                                          &params->common.max_nb_queue_pairs);
 827                 if (ret < 0)
 828                         goto free_kvlist;
 829
 830                 ret = rte_kvargs_process(kvlist,
 831                                          RTE_CRYPTODEV_PMD_SOCKET_ID_ARG,
 832                                          &parse_integer_arg,
 833                                          &params->common.socket_id);
 834                 if (ret < 0)
 835                         goto free_kvlist;
 836
 837                 ret = rte_kvargs_process(kvlist,
 838                                          RTE_CRYPTODEV_PMD_NAME_ARG,
 839                                          &parse_name_arg,
 840                                          &params->common);
 841                 if (ret < 0)
 842                         goto free_kvlist;
 843
 844                 ret = rte_kvargs_process(kvlist,
 845                                          MRVL_PMD_MAX_NB_SESS_ARG,
 846                                          &parse_integer_arg,
 847                                          params);
 848                 if (ret < 0)
 849                         goto free_kvlist;
 850
 851         }
 852
 853 free_kvlist:
 854         rte_kvargs_free(kvlist);
 855         return ret;
 856 }
 857
 858 /**
 859  * Initialize the crypto device.
 860  *
 861  * @param vdev Pointer to device structure.
 862  * @returns 0 in case of success, negative value otherwise.
 863  */
 864 static int
 865 cryptodev_mrvl_crypto_init(struct rte_vdev_device *vdev)
 866 {
 867         struct mrvl_pmd_init_params init_params = {
 868                 .common = {
 869                         .name = "",
 870                         .private_data_size =
 871                                 sizeof(struct mrvl_crypto_private),
 872                         .max_nb_queue_pairs =
 873                                 sam_get_num_inst() * sam_get_num_cios(0),
 874                         .socket_id = rte_socket_id()
 875                 },
 876                 .max_nb_sessions = MRVL_PMD_DEFAULT_MAX_NB_SESSIONS
 877         };
 878
 879         const char *name, *args;
 880         int ret;
 881
 882         name = rte_vdev_device_name(vdev);
 883         if (name == NULL)
 884                 return -EINVAL;
 885         args = rte_vdev_device_args(vdev);
 886
 887         ret = mrvl_pmd_parse_input_args(&init_params, args);
 888         if (ret) {
 889                 RTE_LOG(ERR, PMD,
 890                         "Failed to parse initialisation arguments[%s]\n",
 891                         args);
 892                 return -EINVAL;
 893         }
 894
 895         return cryptodev_mrvl_crypto_create(name, vdev, &init_params);
 896 }
 897
 898 /**
 899  * Uninitialize the crypto device
 900  *
 901  * @param vdev Pointer to device structure.
 902  * @returns 0 in case of success, negative value otherwise.
 903  */
 904 static int
 905 cryptodev_mrvl_crypto_uninit(struct rte_vdev_device *vdev)
 906 {
 907         struct rte_cryptodev *cryptodev;
 908         const char *name = rte_vdev_device_name(vdev);
 909
 910         if (name == NULL)
 911                 return -EINVAL;
 912
 913         RTE_LOG(INFO, PMD,
 914                 "Closing Marvell crypto device %s on numa socket %u\n",
 915                 name, rte_socket_id());
 916
 917         sam_deinit();
 918
 919         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
 920         if (cryptodev == NULL)
 921                 return -ENODEV;
 922
 923         return rte_cryptodev_pmd_destroy(cryptodev);
 924 }
 925
 926 /**
 927  * Basic driver handlers for use in the constructor.
 928  */
 929 static struct rte_vdev_driver cryptodev_mrvl_pmd_drv = {
 930         .probe = cryptodev_mrvl_crypto_init,
 931         .remove = cryptodev_mrvl_crypto_uninit
 932 };
 933
 934 static struct cryptodev_driver mrvl_crypto_drv;
 935
 936 /* Register the driver in constructor. */
 937 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_MRVL_PMD, cryptodev_mrvl_pmd_drv);
 938 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_MRVL_PMD,
 939         "max_nb_queue_pairs=<int> "
 940         "max_nb_sessions=<int> "
 941         "socket_id=<int>");
 942 RTE_PMD_REGISTER_CRYPTO_DRIVER(mrvl_crypto_drv, cryptodev_mrvl_pmd_drv.driver,
 943                 cryptodev_driver_id);