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 CRYPTODEV_NAME_AESNI_GCM_PMD    crypto_aesni_gcm
  39 /**< AES-NI GCM PMD device name */
  40
  41 #define GCM_LOG_ERR(fmt, args...) \
  42         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
  43                         RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD), \
  44                         __func__, __LINE__, ## args)
  45
  46 #ifdef RTE_LIBRTE_AESNI_MB_DEBUG
  47 #define GCM_LOG_INFO(fmt, args...) \
  48         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  49                         RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD), \
  50                         __func__, __LINE__, ## args)
  51
  52 #define GCM_LOG_DBG(fmt, args...) \
  53         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  54                         RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD), \
  55                         __func__, __LINE__, ## args)
  56 #else
  57 #define GCM_LOG_INFO(fmt, args...)
  58 #define GCM_LOG_DBG(fmt, args...)
  59 #endif
  60
  61 /* Maximum length for digest */
  62 #define DIGEST_LENGTH_MAX 16
  63
  64 /** private data structure for each virtual AESNI GCM device */
  65 struct aesni_gcm_private {
  66         enum aesni_gcm_vector_mode vector_mode;
  67         /**< Vector mode */
  68         unsigned max_nb_queue_pairs;
  69         /**< Max number of queue pairs supported by device */
  70         unsigned max_nb_sessions;
  71         /**< Max number of sessions supported by device */
  72 };
  73
  74 struct aesni_gcm_qp {
  75         const struct aesni_gcm_ops *ops;
  76         /**< Architecture dependent function pointer table of the gcm APIs */
  77         struct rte_ring *processed_pkts;
  78         /**< Ring for placing process packets */
  79         struct gcm_context_data gdata_ctx; /* (16 * 5) + 8 = 88 B */
  80         /**< GCM parameters */
  81         struct rte_cryptodev_stats qp_stats; /* 8 * 4 = 32 B */
  82         /**< Queue pair statistics */
  83         struct rte_mempool *sess_mp;
  84         /**< Session Mempool */
  85         uint16_t id;
  86         /**< Queue Pair Identifier */
  87         char name[RTE_CRYPTODEV_NAME_LEN];
  88         /**< Unique Queue Pair Name */
  89         uint8_t temp_digest[DIGEST_LENGTH_MAX];
  90         /**< Buffer used to store the digest generated
  91          * by the driver when verifying a digest provided
  92          * by the user (using authentication verify operation)
  93          */
  94 } __rte_cache_aligned;
  95
  96
  97 enum aesni_gcm_operation {
  98         AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION,
  99         AESNI_GCM_OP_AUTHENTICATED_DECRYPTION,
 100         AESNI_GMAC_OP_GENERATE,
 101         AESNI_GMAC_OP_VERIFY
 102 };
 103
 104 /** AESNI GCM private session structure */
 105 struct aesni_gcm_session {
 106         struct {
 107                 uint16_t length;
 108                 uint16_t offset;
 109         } iv;
 110         /**< IV parameters */
 111         uint16_t aad_length;
 112         /**< AAD length */
 113         uint16_t digest_length;
 114         /**< Digest length */
 115         enum aesni_gcm_operation op;
 116         /**< GCM operation type */
 117         enum aesni_gcm_key key;
 118         /**< GCM key type */
 119         struct gcm_key_data gdata_key;
 120         /**< GCM parameters */
 121 };
 122
 123
 124 /**
 125  * Setup GCM session parameters
 126  * @param       sess    aesni gcm session structure
 127  * @param       xform   crypto transform chain
 128  *
 129  * @return
 130  * - On success returns 0
 131  * - On failure returns error code < 0
 132  */
 133 extern int
 134 aesni_gcm_set_session_parameters(const struct aesni_gcm_ops *ops,
 135                 struct aesni_gcm_session *sess,
 136                 const struct rte_crypto_sym_xform *xform);
 137
 138
 139 /**
 140  * Device specific operations function pointer structure */
 141 extern struct rte_cryptodev_ops *rte_aesni_gcm_pmd_ops;
 142
 143
 144 #endif /* _RTE_AESNI_GCM_PMD_PRIVATE_H_ */