drivers/crypto/zuc/rte_zuc_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 _RTE_ZUC_PMD_PRIVATE_H_
  34 #define _RTE_ZUC_PMD_PRIVATE_H_
  35
  36 #include <sso_zuc.h>
  37
  38 #define ZUC_LOG_ERR(fmt, args...) \
  39         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
  40                         RTE_STR(CRYPTODEV_NAME_ZUC_PMD), \
  41                         __func__, __LINE__, ## args)
  42
  43 #ifdef RTE_LIBRTE_ZUC_DEBUG
  44 #define ZUC_LOG_INFO(fmt, args...) \
  45         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  46                         RTE_STR(CRYPTODEV_NAME_ZUC_PMD), \
  47                         __func__, __LINE__, ## args)
  48
  49 #define ZUC_LOG_DBG(fmt, args...) \
  50         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  51                         RTE_STR(CRYPTODEV_NAME_ZUC_PMD), \
  52                         __func__, __LINE__, ## args)
  53 #else
  54 #define ZUC_LOG_INFO(fmt, args...)
  55 #define ZUC_LOG_DBG(fmt, args...)
  56 #endif
  57
  58 #define ZUC_IV_KEY_LENGTH 16
  59 /** private data structure for each virtual ZUC device */
  60 struct zuc_private {
  61         unsigned max_nb_queue_pairs;
  62         /**< Max number of queue pairs supported by device */
  63         unsigned max_nb_sessions;
  64         /**< Max number of sessions supported by device */
  65 };
  66
  67 /** ZUC buffer queue pair */
  68 struct zuc_qp {
  69         uint16_t id;
  70         /**< Queue Pair Identifier */
  71         char name[RTE_CRYPTODEV_NAME_LEN];
  72         /**< Unique Queue Pair Name */
  73         struct rte_ring *processed_ops;
  74         /**< Ring for placing processed ops */
  75         struct rte_mempool *sess_mp;
  76         /**< Session Mempool */
  77         struct rte_cryptodev_stats qp_stats;
  78         /**< Queue pair statistics */
  79 } __rte_cache_aligned;
  80
  81 enum zuc_operation {
  82         ZUC_OP_ONLY_CIPHER,
  83         ZUC_OP_ONLY_AUTH,
  84         ZUC_OP_CIPHER_AUTH,
  85         ZUC_OP_AUTH_CIPHER,
  86         ZUC_OP_NOT_SUPPORTED
  87 };
  88
  89 /** ZUC private session structure */
  90 struct zuc_session {
  91         enum zuc_operation op;
  92         enum rte_crypto_auth_operation auth_op;
  93         uint8_t pKey_cipher[ZUC_IV_KEY_LENGTH];
  94         uint8_t pKey_hash[ZUC_IV_KEY_LENGTH];
  95 } __rte_cache_aligned;
  96
  97
  98 extern int
  99 zuc_set_session_parameters(struct zuc_session *sess,
 100                 const struct rte_crypto_sym_xform *xform);
 101
 102
 103 /** device specific operations function pointer structure */
 104 extern struct rte_cryptodev_ops *rte_zuc_pmd_ops;
 105
 106
 107
 108 #endif /* _RTE_ZUC_PMD_PRIVATE_H_ */