drivers/crypto/aesni_mb/rte_aesni_mb_pmd_private.h

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