drivers/crypto/null/null_crypto_pmd_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 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 _NULL_CRYPTO_PMD_PRIVATE_H_
  34 #define _NULL_CRYPTO_PMD_PRIVATE_H_
  35
  36 #include "rte_config.h"
  37
  38 #define CRYPTODEV_NAME_NULL_PMD         crypto_null
  39 /**< Null crypto PMD device name */
  40
  41 #define NULL_CRYPTO_LOG_ERR(fmt, args...) \
  42         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
  43                         RTE_STR(CRYPTODEV_NAME_NULL_PMD), \
  44                         __func__, __LINE__, ## args)
  45
  46 #ifdef RTE_LIBRTE_NULL_CRYPTO_DEBUG
  47 #define NULL_CRYPTO_LOG_INFO(fmt, args...) \
  48         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  49                         RTE_STR(CRYPTODEV_NAME_NULL_PMD), \
  50                         __func__, __LINE__, ## args)
  51
  52 #define NULL_CRYPTO_LOG_DBG(fmt, args...) \
  53         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  54                         RTE_STR(CRYPTODEV_NAME_NULL_PMD), \
  55                         __func__, __LINE__, ## args)
  56 #else
  57 #define NULL_CRYPTO_LOG_INFO(fmt, args...)
  58 #define NULL_CRYPTO_LOG_DBG(fmt, args...)
  59 #endif
  60
  61
  62 /** private data structure for each NULL crypto device */
  63 struct null_crypto_private {
  64         unsigned max_nb_qpairs;         /**< Max number of queue pairs */
  65         unsigned max_nb_sessions;       /**< Max number of sessions */
  66 };
  67
  68 /** NULL crypto queue pair */
  69 struct null_crypto_qp {
  70         uint16_t id;
  71         /**< Queue Pair Identifier */
  72         char name[RTE_CRYPTODEV_NAME_LEN];
  73         /**< Unique Queue Pair Name */
  74         struct rte_ring *processed_pkts;
  75         /**< Ring for placing process packets */
  76         struct rte_mempool *sess_mp;
  77         /**< Session Mempool */
  78         struct rte_cryptodev_stats qp_stats;
  79         /**< Queue pair statistics */
  80 } __rte_cache_aligned;
  81
  82
  83 /** NULL crypto private session structure */
  84 struct null_crypto_session {
  85         uint32_t reserved;
  86 } __rte_cache_aligned;
  87
  88 /** Set and validate NULL crypto session parameters */
  89 extern int
  90 null_crypto_set_session_parameters(struct null_crypto_session *sess,
  91                 const struct rte_crypto_sym_xform *xform);
  92
  93 /** device specific operations function pointer structure */
  94 extern struct rte_cryptodev_ops *null_crypto_pmd_ops;
  95
  96 #endif /* _NULL_CRYPTO_PMD_PRIVATE_H_ */