drivers/crypto/snow3g/rte_snow3g_pmd_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016-2017 Intel Corporation. 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 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.
  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_SNOW3G_PMD_PRIVATE_H_
  34 #define _RTE_SNOW3G_PMD_PRIVATE_H_
  35
  36 #include <sso_snow3g.h>
  37
  38 #define CRYPTODEV_NAME_SNOW3G_PMD       crypto_snow3g
  39 /**< SNOW 3G PMD device name */
  40
  41 #define SNOW3G_LOG_ERR(fmt, args...) \
  42         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
  43                         RTE_STR(CRYPTODEV_NAME_SNOW3G_PMD), \
  44                         __func__, __LINE__, ## args)
  45
  46 #ifdef RTE_LIBRTE_SNOW3G_DEBUG
  47 #define SNOW3G_LOG_INFO(fmt, args...) \
  48         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  49                         RTE_STR(CRYPTODEV_NAME_SNOW3G_PMD), \
  50                         __func__, __LINE__, ## args)
  51
  52 #define SNOW3G_LOG_DBG(fmt, args...) \
  53         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  54                         RTE_STR(CRYPTODEV_NAME_SNOW3G_PMD), \
  55                         __func__, __LINE__, ## args)
  56 #else
  57 #define SNOW3G_LOG_INFO(fmt, args...)
  58 #define SNOW3G_LOG_DBG(fmt, args...)
  59 #endif
  60
  61 /** private data structure for each virtual SNOW 3G device */
  62 struct snow3g_private {
  63         unsigned max_nb_queue_pairs;
  64         /**< Max number of queue pairs supported by device */
  65         unsigned max_nb_sessions;
  66         /**< Max number of sessions supported by device */
  67 };
  68
  69 /** SNOW 3G buffer queue pair */
  70 struct snow3g_qp {
  71         uint16_t id;
  72         /**< Queue Pair Identifier */
  73         char name[RTE_CRYPTODEV_NAME_LEN];
  74         /**< Unique Queue Pair Name */
  75         struct rte_ring *processed_ops;
  76         /**< Ring for placing processed ops */
  77         struct rte_mempool *sess_mp;
  78         /**< Session Mempool */
  79         struct rte_cryptodev_stats qp_stats;
  80         /**< Queue pair statistics */
  81 } __rte_cache_aligned;
  82
  83 enum snow3g_operation {
  84         SNOW3G_OP_ONLY_CIPHER,
  85         SNOW3G_OP_ONLY_AUTH,
  86         SNOW3G_OP_CIPHER_AUTH,
  87         SNOW3G_OP_AUTH_CIPHER,
  88         SNOW3G_OP_NOT_SUPPORTED
  89 };
  90
  91 /** SNOW 3G private session structure */
  92 struct snow3g_session {
  93         enum snow3g_operation op;
  94         enum rte_crypto_auth_operation auth_op;
  95         sso_snow3g_key_schedule_t pKeySched_cipher;
  96         sso_snow3g_key_schedule_t pKeySched_hash;
  97         uint16_t cipher_iv_offset;
  98         uint16_t auth_iv_offset;
  99 } __rte_cache_aligned;
 100
 101
 102 extern int
 103 snow3g_set_session_parameters(struct snow3g_session *sess,
 104                 const struct rte_crypto_sym_xform *xform);
 105
 106
 107 /** device specific operations function pointer structure */
 108 extern struct rte_cryptodev_ops *rte_snow3g_pmd_ops;
 109
 110
 111
 112 #endif /* _RTE_SNOW3G_PMD_PRIVATE_H_ */