1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2016 Intel Corporation
5 #ifndef _RTE_AESNI_MB_PMD_PRIVATE_H_
6 #define _RTE_AESNI_MB_PMD_PRIVATE_H_
8 #include "aesni_mb_ops.h"
11 * IMB_VERSION_NUM macro was introduced in version Multi-buffer 0.50,
12 * so if macro is not defined, it means that the version is 0.49.
14 #if !defined(IMB_VERSION_NUM)
15 #define IMB_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
16 #define IMB_VERSION_NUM IMB_VERSION(0, 49, 0)
19 #define CRYPTODEV_NAME_AESNI_MB_PMD crypto_aesni_mb
20 /**< AES-NI Multi buffer PMD device name */
22 /** AESNI_MB PMD LOGTYPE DRIVER */
23 int aesni_mb_logtype_driver;
25 #define AESNI_MB_LOG(level, fmt, ...) \
26 rte_log(RTE_LOG_ ## level, aesni_mb_logtype_driver, \
27 "%s() line %u: " fmt "\n", __func__, __LINE__, \
31 #define HMAC_IPAD_VALUE (0x36)
32 #define HMAC_OPAD_VALUE (0x5C)
34 /* Maximum length for digest */
35 #define DIGEST_LENGTH_MAX 64
36 static const unsigned auth_blocksize[] = {
48 * Get the blocksize in bytes for a specified authentication algorithm
50 * @Note: this function will not return a valid value for a non-valid
51 * authentication algorithm
53 static inline unsigned
54 get_auth_algo_blocksize(JOB_HASH_ALG algo)
56 return auth_blocksize[algo];
59 static const unsigned auth_truncated_digest_byte_lengths[] = {
73 * Get the IPsec specified truncated length in bytes of the HMAC digest for a
74 * specified authentication algorithm
76 * @Note: this function will not return a valid value for a non-valid
77 * authentication algorithm
79 static inline unsigned
80 get_truncated_digest_byte_length(JOB_HASH_ALG algo)
82 return auth_truncated_digest_byte_lengths[algo];
85 static const unsigned auth_digest_byte_lengths[] = {
98 * Get the full digest size in bytes for a specified authentication algorithm
99 * (if available in the Multi-buffer library)
101 * @Note: this function will not return a valid value for a non-valid
102 * authentication algorithm
104 static inline unsigned
105 get_digest_byte_length(JOB_HASH_ALG algo)
107 return auth_digest_byte_lengths[algo];
110 enum aesni_mb_operation {
111 AESNI_MB_OP_HASH_CIPHER,
112 AESNI_MB_OP_CIPHER_HASH,
113 AESNI_MB_OP_HASH_ONLY,
114 AESNI_MB_OP_CIPHER_ONLY,
115 AESNI_MB_OP_AEAD_HASH_CIPHER,
116 AESNI_MB_OP_AEAD_CIPHER_HASH,
117 AESNI_MB_OP_NOT_SUPPORTED
120 /** private data structure for each virtual AESNI device */
121 struct aesni_mb_private {
122 enum aesni_mb_vector_mode vector_mode;
123 /**< CPU vector instruction set mode */
124 unsigned max_nb_queue_pairs;
125 /**< Max number of queue pairs supported by device */
128 /** AESNI Multi buffer queue pair */
131 /**< Queue Pair Identifier */
132 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
133 /**< Unique Queue Pair Name */
134 const struct aesni_mb_op_fns *op_fns;
135 /**< Vector mode dependent pointer table of the multi-buffer APIs */
137 /**< Multi-buffer instance */
138 struct rte_ring *ingress_queue;
139 /**< Ring for placing operations ready for processing */
140 struct rte_mempool *sess_mp;
141 /**< Session Mempool */
142 struct rte_cryptodev_stats stats;
143 /**< Queue pair statistics */
145 /**< Index of the next slot to be used in temp_digests,
146 * to store the digest for a given operation
148 uint8_t temp_digests[MAX_JOBS][DIGEST_LENGTH_MAX];
149 /**< Buffers used to store the digest generated
150 * by the driver when verifying a digest provided
151 * by the user (using authentication verify operation)
153 } __rte_cache_aligned;
155 /** AES-NI multi-buffer private session structure */
156 struct aesni_mb_session {
157 JOB_CHAIN_ORDER chain_order;
162 /**< IV parameters */
164 /** Cipher Parameters */
166 /** Cipher direction - encrypt / decrypt */
167 JOB_CIPHER_DIRECTION direction;
168 /** Cipher mode - CBC / Counter */
169 JOB_CIPHER_MODE mode;
171 uint64_t key_length_in_bytes;
175 uint32_t encode[60] __rte_aligned(16);
177 uint32_t decode[60] __rte_aligned(16);
181 const void *ks_ptr[3];
185 /**< Expanded AES keys - Allocating space to
186 * contain the maximum expanded key size which
187 * is 240 bytes for 256 bit AES, calculate by:
188 * ((key size (bytes)) *
189 * ((number of rounds) + 1))
193 /** Authentication Parameters */
195 JOB_HASH_ALG algo; /**< Authentication Algorithm */
196 enum rte_crypto_auth_operation operation;
197 /**< auth operation generate or verify */
200 uint8_t inner[128] __rte_aligned(16);
202 uint8_t outer[128] __rte_aligned(16);
205 /**< HMAC Authentication pads -
206 * allocating space for the maximum pad
207 * size supported which is 128 bytes for
212 uint32_t k1_expanded[44] __rte_aligned(16);
213 /**< k1 (expanded key). */
214 uint8_t k2[16] __rte_aligned(16);
216 uint8_t k3[16] __rte_aligned(16);
221 uint32_t expkey[60] __rte_aligned(16);
222 /**< k1 (expanded key). */
223 uint32_t skey1[4] __rte_aligned(16);
225 uint32_t skey2[4] __rte_aligned(16);
228 /**< Expanded XCBC authentication keys */
230 /** Generated digest size by the Multi-buffer library */
231 uint16_t gen_digest_len;
232 /** Requested digest size from Cryptodev */
233 uint16_t req_digest_len;
237 /** AAD data length */
240 } __rte_cache_aligned;
247 aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
248 struct aesni_mb_session *sess,
249 const struct rte_crypto_sym_xform *xform);
252 /** device specific operations function pointer structure */
253 extern struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops;
257 #endif /* _RTE_AESNI_MB_PMD_PRIVATE_H_ */