drivers/crypto/mrvl/rte_mrvl_pmd_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (C) Semihalf 2017. All rights reserved.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  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
  15  *       distribution.
  16  *     * Neither the name of Semihalf 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.
  19  *
  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.
  31  */
  32
  33 #ifndef _RTE_MRVL_PMD_PRIVATE_H_
  34 #define _RTE_MRVL_PMD_PRIVATE_H_
  35
  36 #include "rte_mrvl_compat.h"
  37
  38 #define CRYPTODEV_NAME_MRVL_PMD crypto_mrvl
  39 /**< Marvell PMD device name */
  40
  41 #define MRVL_CRYPTO_LOG_ERR(fmt, args...) \
  42         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
  43                         RTE_STR(CRYPTODEV_NAME_MRVL_CRYPTO_PMD), \
  44                         __func__, __LINE__, ## args)
  45
  46 #ifdef RTE_LIBRTE_MRVL_CRYPTO_DEBUG
  47 #define MRVL_CRYPTO_LOG_INFO(fmt, args...) \
  48         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  49                         RTE_STR(CRYPTODEV_NAME_MRVL_CRYPTO_PMD), \
  50                         __func__, __LINE__, ## args)
  51
  52 #define MRVL_CRYPTO_LOG_DBG(fmt, args...) \
  53         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  54                         RTE_STR(CRYPTODEV_NAME_MRVL_CRYPTO_PMD), \
  55                         __func__, __LINE__, ## args)
  56
  57 #else
  58 #define MRVL_CRYPTO_LOG_INFO(fmt, args...)
  59 #define MRVL_CRYPTO_LOG_DBG(fmt, args...)
  60 #endif
  61
  62 /**
  63  * Handy bits->bytes conversion macro.
  64  */
  65 #define BITS2BYTES(x) ((x) >> 3)
  66
  67 /** The operation order mode enumerator. */
  68 enum mrvl_crypto_chain_order {
  69         MRVL_CRYPTO_CHAIN_CIPHER_ONLY,
  70         MRVL_CRYPTO_CHAIN_AUTH_ONLY,
  71         MRVL_CRYPTO_CHAIN_CIPHER_AUTH,
  72         MRVL_CRYPTO_CHAIN_AUTH_CIPHER,
  73         MRVL_CRYPTO_CHAIN_COMBINED,
  74         MRVL_CRYPTO_CHAIN_NOT_SUPPORTED,
  75 };
  76
  77 /** Private data structure for each crypto device. */
  78 struct mrvl_crypto_private {
  79         unsigned int max_nb_qpairs;     /**< Max number of queue pairs */
  80         unsigned int max_nb_sessions;   /**< Max number of sessions */
  81 };
  82
  83 /** MRVL crypto queue pair structure. */
  84 struct mrvl_crypto_qp {
  85         /** SAM CIO (MUSDK Queue Pair equivalent).*/
  86         struct sam_cio *cio;
  87
  88         /** Session Mempool. */
  89         struct rte_mempool *sess_mp;
  90
  91         /** Queue pair statistics. */
  92         struct rte_cryptodev_stats stats;
  93
  94         /** CIO initialization parameters.*/
  95         struct sam_cio_params cio_params;
  96 } __rte_cache_aligned;
  97
  98 /** MRVL crypto private session structure. */
  99 struct mrvl_crypto_session {
 100         /** Crypto operations chain order. */
 101         enum mrvl_crypto_chain_order chain_order;
 102
 103         /** Session initialization parameters. */
 104         struct sam_session_params sam_sess_params;
 105
 106         /** SAM session pointer. */
 107         struct sam_sa *sam_sess;
 108
 109         /** Cipher IV offset. */
 110         uint16_t cipher_iv_offset;
 111 } __rte_cache_aligned;
 112
 113 /** Set and validate MRVL crypto session parameters */
 114 extern int
 115 mrvl_crypto_set_session_parameters(struct mrvl_crypto_session *sess,
 116                 const struct rte_crypto_sym_xform *xform);
 117
 118 /** device specific operations function pointer structure */
 119 extern struct rte_cryptodev_ops *rte_mrvl_crypto_pmd_ops;
 120
 121 #endif /* _RTE_MRVL_PMD_PRIVATE_H_ */