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 <intel-ipsec-mb.h>
12 * IMB_VERSION_NUM macro was introduced in version Multi-buffer 0.50,
13 * so if macro is not defined, it means that the version is 0.49.
15 #if !defined(IMB_VERSION_NUM)
16 #define IMB_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
17 #define IMB_VERSION_NUM IMB_VERSION(0, 49, 0)
20 #if IMB_VERSION_NUM < IMB_VERSION(0, 52, 0)
21 #include "aesni_mb_ops.h"
24 #if IMB_VERSION_NUM >= IMB_VERSION(0, 52, 0)
25 enum aesni_mb_vector_mode {
26 RTE_AESNI_MB_NOT_SUPPORTED = 0,
35 #define CRYPTODEV_NAME_AESNI_MB_PMD crypto_aesni_mb
36 /**< AES-NI Multi buffer PMD device name */
38 /** AESNI_MB PMD LOGTYPE DRIVER */
39 int aesni_mb_logtype_driver;
41 #define AESNI_MB_LOG(level, fmt, ...) \
42 rte_log(RTE_LOG_ ## level, aesni_mb_logtype_driver, \
43 "%s() line %u: " fmt "\n", __func__, __LINE__, \
47 #define HMAC_IPAD_VALUE (0x36)
48 #define HMAC_OPAD_VALUE (0x5C)
50 /* Maximum length for digest */
51 #define DIGEST_LENGTH_MAX 64
52 static const unsigned auth_blocksize[] = {
64 * Get the blocksize in bytes for a specified authentication algorithm
66 * @Note: this function will not return a valid value for a non-valid
67 * authentication algorithm
69 static inline unsigned
70 get_auth_algo_blocksize(JOB_HASH_ALG algo)
72 return auth_blocksize[algo];
75 static const unsigned auth_truncated_digest_byte_lengths[] = {
89 * Get the IPsec specified truncated length in bytes of the HMAC digest for a
90 * specified authentication algorithm
92 * @Note: this function will not return a valid value for a non-valid
93 * authentication algorithm
95 static inline unsigned
96 get_truncated_digest_byte_length(JOB_HASH_ALG algo)
98 return auth_truncated_digest_byte_lengths[algo];
101 static const unsigned auth_digest_byte_lengths[] = {
112 #if IMB_VERSION_NUM >= IMB_VERSION(0, 52, 0)
114 [PLAIN_SHA_224] = 28,
115 [PLAIN_SHA_256] = 32,
116 [PLAIN_SHA_384] = 48,
119 /**< Vector mode dependent pointer table of the multi-buffer APIs */
124 * Get the full digest size in bytes for a specified authentication algorithm
125 * (if available in the Multi-buffer library)
127 * @Note: this function will not return a valid value for a non-valid
128 * authentication algorithm
130 static inline unsigned
131 get_digest_byte_length(JOB_HASH_ALG algo)
133 return auth_digest_byte_lengths[algo];
136 enum aesni_mb_operation {
137 AESNI_MB_OP_HASH_CIPHER,
138 AESNI_MB_OP_CIPHER_HASH,
139 AESNI_MB_OP_HASH_ONLY,
140 AESNI_MB_OP_CIPHER_ONLY,
141 AESNI_MB_OP_AEAD_HASH_CIPHER,
142 AESNI_MB_OP_AEAD_CIPHER_HASH,
143 AESNI_MB_OP_NOT_SUPPORTED
146 /** private data structure for each virtual AESNI device */
147 struct aesni_mb_private {
148 enum aesni_mb_vector_mode vector_mode;
149 /**< CPU vector instruction set mode */
150 unsigned max_nb_queue_pairs;
151 /**< Max number of queue pairs supported by device */
152 #if IMB_VERSION_NUM >= IMB_VERSION(0, 52, 0)
154 /**< Multi-buffer instance */
158 /** AESNI Multi buffer queue pair */
161 /**< Queue Pair Identifier */
162 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
163 #if IMB_VERSION_NUM < IMB_VERSION(0, 52, 0)
164 /**< Unique Queue Pair Name */
165 const struct aesni_mb_op_fns *op_fns;
167 /**< Unique Queue Pair Name */
169 /**< Multi-buffer instance */
170 struct rte_ring *ingress_queue;
171 /**< Ring for placing operations ready for processing */
172 struct rte_mempool *sess_mp;
173 /**< Session Mempool */
174 struct rte_cryptodev_stats stats;
175 /**< Queue pair statistics */
177 /**< Index of the next slot to be used in temp_digests,
178 * to store the digest for a given operation
180 uint8_t temp_digests[MAX_JOBS][DIGEST_LENGTH_MAX];
181 /**< Buffers used to store the digest generated
182 * by the driver when verifying a digest provided
183 * by the user (using authentication verify operation)
185 } __rte_cache_aligned;
187 /** AES-NI multi-buffer private session structure */
188 struct aesni_mb_session {
189 JOB_CHAIN_ORDER chain_order;
194 /**< IV parameters */
196 /** Cipher Parameters */const struct aesni_mb_op_fns *op_fns;
197 /**< Vector mode dependent pointer table of the multi-buffer APIs */
200 /** Cipher direction - encrypt / decrypt */
201 JOB_CIPHER_DIRECTION direction;
202 /** Cipher mode - CBC / Counter */
203 JOB_CIPHER_MODE mode;
205 uint64_t key_length_in_bytes;
209 uint32_t encode[60] __rte_aligned(16);
211 uint32_t decode[60] __rte_aligned(16);
215 const void *ks_ptr[3];
219 struct gcm_key_data gcm_key;
221 /**< Expanded AES keys - Allocating space to
222 * contain the maximum expanded key size which
223 * is 240 bytes for 256 bit AES, calculate by:
224 * ((key size (bytes)) *
225 * ((number of rounds) + 1))
229 /** Authentication Parameters */
231 JOB_HASH_ALG algo; /**< Authentication Algorithm */
232 enum rte_crypto_auth_operation operation;
233 /**< auth operation generate or verify */
236 uint8_t inner[128] __rte_aligned(16);
238 uint8_t outer[128] __rte_aligned(16);
241 /**< HMAC Authentication pads -
242 * allocating space for the maximum pad
243 * size supported which is 128 bytes for
248 uint32_t k1_expanded[44] __rte_aligned(16);
249 /**< k1 (expanded key). */
250 uint8_t k2[16] __rte_aligned(16);
252 uint8_t k3[16] __rte_aligned(16);
257 uint32_t expkey[60] __rte_aligned(16);
258 /**< k1 (expanded key). */
259 uint32_t skey1[4] __rte_aligned(16);
261 uint32_t skey2[4] __rte_aligned(16);
264 /**< Expanded XCBC authentication keys */
266 /** Generated digest size by the Multi-buffer library */
267 uint16_t gen_digest_len;
268 /** Requested digest size from Cryptodev */
269 uint16_t req_digest_len;
273 /** AAD data length */
276 } __rte_cache_aligned;
280 #if IMB_VERSION_NUM >= IMB_VERSION(0, 52, 0)
285 aesni_mb_set_session_parameters(const MB_MGR *mb_mgr,
286 struct aesni_mb_session *sess,
287 const struct rte_crypto_sym_xform *xform);
290 aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
291 struct aesni_mb_session *sess,
292 const struct rte_crypto_sym_xform *xform);
295 /** device specific operations function pointer structure */
296 extern struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops;
300 #endif /* _RTE_AESNI_MB_PMD_PRIVATE_H_ */