drivers/crypto/aesni_gcm/aesni_gcm_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_AESNI_GCM_PMD_PRIVATE_H_
  34 #define _RTE_AESNI_GCM_PMD_PRIVATE_H_
  35
  36 #include "aesni_gcm_ops.h"
  37
  38 #define GCM_LOG_ERR(fmt, args...) \
  39         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
  40                         RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD), \
  41                         __func__, __LINE__, ## args)
  42
  43 #ifdef RTE_LIBRTE_AESNI_MB_DEBUG
  44 #define GCM_LOG_INFO(fmt, args...) \
  45         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  46                         RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD), \
  47                         __func__, __LINE__, ## args)
  48
  49 #define GCM_LOG_DBG(fmt, args...) \
  50         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  51                         RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD), \
  52                         __func__, __LINE__, ## args)
  53 #else
  54 #define GCM_LOG_INFO(fmt, args...)
  55 #define GCM_LOG_DBG(fmt, args...)
  56 #endif
  57
  58
  59 /** private data structure for each virtual AESNI GCM device */
  60 struct aesni_gcm_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 struct aesni_gcm_qp {
  68         uint16_t id;
  69         /**< Queue Pair Identifier */
  70         char name[RTE_CRYPTODEV_NAME_LEN];
  71         /**< Unique Queue Pair Name */
  72         struct rte_ring *processed_pkts;
  73         /**< Ring for placing process packets */
  74         struct rte_mempool *sess_mp;
  75         /**< Session Mempool */
  76         struct rte_cryptodev_stats qp_stats;
  77         /**< Queue pair statistics */
  78 } __rte_cache_aligned;
  79
  80
  81 enum aesni_gcm_operation {
  82         AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION,
  83         AESNI_GCM_OP_AUTHENTICATED_DECRYPTION,
  84         AESNI_GMAC_OP_GENERATE,
  85         AESNI_GMAC_OP_VERIFY
  86 };
  87
  88 enum aesni_gcm_key {
  89         AESNI_GCM_KEY_128,
  90         AESNI_GCM_KEY_256
  91 };
  92
  93 /** AESNI GCM private session structure */
  94 struct aesni_gcm_session {
  95         struct {
  96                 uint16_t length;
  97                 uint16_t offset;
  98         } iv;
  99         /**< IV parameters */
 100         uint16_t aad_length;
 101         /**< AAD length */
 102         uint16_t digest_length;
 103         /**< Digest length */
 104         enum aesni_gcm_operation op;
 105         /**< GCM operation type */
 106         enum aesni_gcm_key key;
 107         /**< GCM key type */
 108         struct gcm_data gdata __rte_cache_aligned;
 109         /**< GCM parameters */
 110 };
 111
 112
 113 /**
 114  * Setup GCM session parameters
 115  * @param       sess    aesni gcm session structure
 116  * @param       xform   crypto transform chain
 117  *
 118  * @return
 119  * - On success returns 0
 120  * - On failure returns error code < 0
 121  */
 122 extern int
 123 aesni_gcm_set_session_parameters(struct aesni_gcm_session *sess,
 124                 const struct rte_crypto_sym_xform *xform);
 125
 126
 127 /**
 128  * Device specific operations function pointer structure */
 129 extern struct rte_cryptodev_ops *rte_aesni_gcm_pmd_ops;
 130
 131
 132 #endif /* _RTE_AESNI_GCM_PMD_PRIVATE_H_ */