drivers/crypto/qat/qat_crypto.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _QAT_CRYPTO_H_
  35 #define _QAT_CRYPTO_H_
  36
  37 #include <rte_cryptodev_pmd.h>
  38 #include <rte_memzone.h>
  39
  40 #include "qat_crypto_capabilities.h"
  41
  42 /*
  43  * This macro rounds up a number to a be a multiple of
  44  * the alignment when the alignment is a power of 2
  45  */
  46 #define ALIGN_POW2_ROUNDUP(num, align) \
  47         (((num) + (align) - 1) & ~((align) - 1))
  48 #define QAT_64_BTYE_ALIGN_MASK (~0x3f)
  49
  50 /**
  51  * Structure associated with each queue.
  52  */
  53 struct qat_queue {
  54         char            memz_name[RTE_MEMZONE_NAMESIZE];
  55         void            *base_addr;             /* Base address */
  56         phys_addr_t     base_phys_addr;         /* Queue physical address */
  57         uint32_t        head;                   /* Shadow copy of the head */
  58         uint32_t        tail;                   /* Shadow copy of the tail */
  59         uint32_t        modulo;
  60         uint32_t        msg_size;
  61         uint16_t        max_inflights;
  62         uint32_t        queue_size;
  63         uint8_t         hw_bundle_number;
  64         uint8_t         hw_queue_number;
  65         /* HW queue aka ring offset on bundle */
  66 };
  67
  68 struct qat_qp {
  69         void                    *mmap_bar_addr;
  70         rte_atomic16_t          inflights16;
  71         struct  qat_queue       tx_q;
  72         struct  qat_queue       rx_q;
  73         struct  rte_cryptodev_stats stats;
  74         struct rte_mempool *op_cookie_pool;
  75         void **op_cookies;
  76         uint32_t nb_descriptors;
  77 } __rte_cache_aligned;
  78
  79 /** private data structure for each QAT device */
  80 struct qat_pmd_private {
  81         unsigned max_nb_queue_pairs;
  82         /**< Max number of queue pairs supported by device */
  83         unsigned max_nb_sessions;
  84         /**< Max number of sessions supported by device */
  85         const struct rte_cryptodev_capabilities *qat_dev_capabilities;
  86 };
  87
  88 int qat_dev_config(struct rte_cryptodev *dev,
  89                 struct rte_cryptodev_config *config);
  90 int qat_dev_start(struct rte_cryptodev *dev);
  91 void qat_dev_stop(struct rte_cryptodev *dev);
  92 int qat_dev_close(struct rte_cryptodev *dev);
  93 void qat_dev_info_get(struct rte_cryptodev *dev,
  94         struct rte_cryptodev_info *info);
  95
  96 void qat_crypto_sym_stats_get(struct rte_cryptodev *dev,
  97         struct rte_cryptodev_stats *stats);
  98 void qat_crypto_sym_stats_reset(struct rte_cryptodev *dev);
  99
 100 int qat_crypto_sym_qp_setup(struct rte_cryptodev *dev, uint16_t queue_pair_id,
 101         const struct rte_cryptodev_qp_conf *rx_conf, int socket_id);
 102 int qat_crypto_sym_qp_release(struct rte_cryptodev *dev,
 103         uint16_t queue_pair_id);
 104
 105 int
 106 qat_pmd_session_mempool_create(struct rte_cryptodev *dev,
 107         unsigned nb_objs, unsigned obj_cache_size, int socket_id);
 108
 109 extern unsigned
 110 qat_crypto_sym_get_session_private_size(struct rte_cryptodev *dev);
 111
 112 extern void
 113 qat_crypto_sym_session_init(struct rte_mempool *mempool, void *priv_sess);
 114
 115 extern void *
 116 qat_crypto_sym_configure_session(struct rte_cryptodev *dev,
 117                 struct rte_crypto_sym_xform *xform, void *session_private);
 118
 119 struct qat_session *
 120 qat_crypto_sym_configure_session_auth(struct rte_cryptodev *dev,
 121                                 struct rte_crypto_sym_xform *xform,
 122                                 struct qat_session *session_private);
 123
 124 void *
 125 qat_crypto_sym_configure_session_cipher(struct rte_cryptodev *dev,
 126                 struct rte_crypto_sym_xform *xform, void *session_private);
 127
 128
 129 extern void
 130 qat_crypto_sym_clear_session(struct rte_cryptodev *dev, void *session);
 131
 132
 133 extern uint16_t
 134 qat_pmd_enqueue_op_burst(void *qp, struct rte_crypto_op **ops,
 135                 uint16_t nb_ops);
 136
 137 extern uint16_t
 138 qat_pmd_dequeue_op_burst(void *qp, struct rte_crypto_op **ops,
 139                 uint16_t nb_ops);
 140
 141 #endif /* _QAT_CRYPTO_H_ */