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