drivers/crypto/aesni_mb/rte_aesni_mb_pmd_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2015-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_AESNI_MB_PMD_PRIVATE_H_
  34 #define _RTE_AESNI_MB_PMD_PRIVATE_H_
  35
  36 #include "aesni_mb_ops.h"
  37
  38 #define MB_LOG_ERR(fmt, args...) \
  39         RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n",  \
  40                         RTE_STR(CRYPTODEV_NAME_AESNI_MB_PMD), \
  41                         __func__, __LINE__, ## args)
  42
  43 #ifdef RTE_LIBRTE_AESNI_MB_DEBUG
  44 #define MB_LOG_INFO(fmt, args...) \
  45         RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  46                         CRYPTODEV_NAME_AESNI_MB_PMD, \
  47                         __func__, __LINE__, ## args)
  48
  49 #define MB_LOG_DBG(fmt, args...) \
  50         RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
  51                         CRYPTODEV_NAME_AESNI_MB_PMD, \
  52                         __func__, __LINE__, ## args)
  53 #else
  54 #define MB_LOG_INFO(fmt, args...)
  55 #define MB_LOG_DBG(fmt, args...)
  56 #endif
  57
  58 #define HMAC_IPAD_VALUE                 (0x36)
  59 #define HMAC_OPAD_VALUE                 (0x5C)
  60
  61 static const unsigned auth_blocksize[] = {
  62                 [MD5]           = 64,
  63                 [SHA1]          = 64,
  64                 [SHA_224]       = 64,
  65                 [SHA_256]       = 64,
  66                 [SHA_384]       = 128,
  67                 [SHA_512]       = 128,
  68                 [AES_XCBC]      = 16,
  69 };
  70
  71 /**
  72  * Get the blocksize in bytes for a specified authentication algorithm
  73  *
  74  * @Note: this function will not return a valid value for a non-valid
  75  * authentication algorithm
  76  */
  77 static inline unsigned
  78 get_auth_algo_blocksize(JOB_HASH_ALG algo)
  79 {
  80         return auth_blocksize[algo];
  81 }
  82
  83 static const unsigned auth_truncated_digest_byte_lengths[] = {
  84                 [MD5]           = 12,
  85                 [SHA1]          = 12,
  86                 [SHA_224]       = 14,
  87                 [SHA_256]       = 16,
  88                 [SHA_384]       = 24,
  89                 [SHA_512]       = 32,
  90                 [AES_XCBC]      = 12,
  91 };
  92
  93 /**
  94  * Get the IPsec specified truncated length in bytes of the HMAC digest for a
  95  * specified authentication algorithm
  96  *
  97  * @Note: this function will not return a valid value for a non-valid
  98  * authentication algorithm
  99  */
 100 static inline unsigned
 101 get_truncated_digest_byte_length(JOB_HASH_ALG algo)
 102 {
 103         return auth_truncated_digest_byte_lengths[algo];
 104 }
 105
 106 static const unsigned auth_digest_byte_lengths[] = {
 107                 [MD5]           = 16,
 108                 [SHA1]          = 20,
 109                 [SHA_224]       = 28,
 110                 [SHA_256]       = 32,
 111                 [SHA_384]       = 48,
 112                 [SHA_512]       = 64,
 113                 [AES_XCBC]      = 16,
 114 };
 115
 116 /**
 117  * Get the output digest size in bytes for a specified authentication algorithm
 118  *
 119  * @Note: this function will not return a valid value for a non-valid
 120  * authentication algorithm
 121  */
 122 static inline unsigned
 123 get_digest_byte_length(JOB_HASH_ALG algo)
 124 {
 125         return auth_digest_byte_lengths[algo];
 126 }
 127
 128 enum aesni_mb_operation {
 129         AESNI_MB_OP_HASH_CIPHER,
 130         AESNI_MB_OP_CIPHER_HASH,
 131         AESNI_MB_OP_HASH_ONLY,
 132         AESNI_MB_OP_CIPHER_ONLY,
 133         AESNI_MB_OP_NOT_SUPPORTED
 134 };
 135
 136 /** private data structure for each virtual AESNI device */
 137 struct aesni_mb_private {
 138         enum aesni_mb_vector_mode vector_mode;
 139         /**< CPU vector instruction set mode */
 140         unsigned max_nb_queue_pairs;
 141         /**< Max number of queue pairs supported by device */
 142         unsigned max_nb_sessions;
 143         /**< Max number of sessions supported by device */
 144 };
 145
 146 /** AESNI Multi buffer queue pair */
 147 struct aesni_mb_qp {
 148         uint16_t id;
 149         /**< Queue Pair Identifier */
 150         char name[RTE_CRYPTODEV_NAME_LEN];
 151         /**< Unique Queue Pair Name */
 152         const struct aesni_mb_ops *ops;
 153         /**< Vector mode dependent pointer table of the multi-buffer APIs */
 154         MB_MGR mb_mgr;
 155         /**< Multi-buffer instance */
 156         struct rte_ring *processed_ops;
 157         /**< Ring for placing process operations */
 158         struct rte_mempool *sess_mp;
 159         /**< Session Mempool */
 160         struct rte_cryptodev_stats stats;
 161         /**< Queue pair statistics */
 162 } __rte_cache_aligned;
 163
 164
 165 /** AES-NI multi-buffer private session structure */
 166 struct aesni_mb_session {
 167         JOB_CHAIN_ORDER chain_order;
 168
 169         /** Cipher Parameters */
 170         struct {
 171                 /** Cipher direction - encrypt / decrypt */
 172                 JOB_CIPHER_DIRECTION direction;
 173                 /** Cipher mode - CBC / Counter */
 174                 JOB_CIPHER_MODE mode;
 175
 176                 uint64_t key_length_in_bytes;
 177
 178                 struct {
 179                         uint32_t encode[60] __rte_aligned(16);
 180                         /**< encode key */
 181                         uint32_t decode[60] __rte_aligned(16);
 182                         /**< decode key */
 183                 } expanded_aes_keys;
 184                 /**< Expanded AES keys - Allocating space to
 185                  * contain the maximum expanded key size which
 186                  * is 240 bytes for 256 bit AES, calculate by:
 187                  * ((key size (bytes)) *
 188                  * ((number of rounds) + 1))
 189                  */
 190         } cipher;
 191
 192         /** Authentication Parameters */
 193         struct {
 194                 JOB_HASH_ALG algo; /**< Authentication Algorithm */
 195                 enum rte_crypto_auth_operation operation;
 196                 /**< auth operation generate or verify */
 197                 union {
 198                         struct {
 199                                 uint8_t inner[128] __rte_aligned(16);
 200                                 /**< inner pad */
 201                                 uint8_t outer[128] __rte_aligned(16);
 202                                 /**< outer pad */
 203                         } pads;
 204                         /**< HMAC Authentication pads -
 205                          * allocating space for the maximum pad
 206                          * size supported which is 128 bytes for
 207                          * SHA512
 208                          */
 209
 210                         struct {
 211                             uint32_t k1_expanded[44] __rte_aligned(16);
 212                             /**< k1 (expanded key). */
 213                             uint8_t k2[16] __rte_aligned(16);
 214                             /**< k2. */
 215                             uint8_t k3[16] __rte_aligned(16);
 216                             /**< k3. */
 217                         } xcbc;
 218                         /**< Expanded XCBC authentication keys */
 219                 };
 220         } auth;
 221 } __rte_cache_aligned;
 222
 223
 224 /**
 225  *
 226  */
 227 extern int
 228 aesni_mb_set_session_parameters(const struct aesni_mb_ops *mb_ops,
 229                 struct aesni_mb_session *sess,
 230                 const struct rte_crypto_sym_xform *xform);
 231
 232
 233 /** device specific operations function pointer structure */
 234 extern struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops;
 235
 236
 237
 238 #endif /* _RTE_AESNI_MB_PMD_PRIVATE_H_ */