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"
10 #define CRYPTODEV_NAME_AESNI_MB_PMD crypto_aesni_mb
11 /**< AES-NI Multi buffer PMD device name */
13 /** AESNI_MB PMD LOGTYPE DRIVER */
14 int aesni_mb_logtype_driver;
16 #define AESNI_MB_LOG(level, fmt, ...) \
17 rte_log(RTE_LOG_ ## level, aesni_mb_logtype_driver, \
18 "%s() line %u: " fmt "\n", __func__, __LINE__, \
22 #define HMAC_IPAD_VALUE (0x36)
23 #define HMAC_OPAD_VALUE (0x5C)
25 /* Maximum length for digest */
26 #define DIGEST_LENGTH_MAX 64
27 static const unsigned auth_blocksize[] = {
39 * Get the blocksize in bytes for a specified authentication algorithm
41 * @Note: this function will not return a valid value for a non-valid
42 * authentication algorithm
44 static inline unsigned
45 get_auth_algo_blocksize(JOB_HASH_ALG algo)
47 return auth_blocksize[algo];
50 static const unsigned auth_truncated_digest_byte_lengths[] = {
64 * Get the IPsec specified truncated length in bytes of the HMAC digest for a
65 * specified authentication algorithm
67 * @Note: this function will not return a valid value for a non-valid
68 * authentication algorithm
70 static inline unsigned
71 get_truncated_digest_byte_length(JOB_HASH_ALG algo)
73 return auth_truncated_digest_byte_lengths[algo];
76 static const unsigned auth_digest_byte_lengths[] = {
89 * Get the full digest size in bytes for a specified authentication algorithm
90 * (if available in the Multi-buffer library)
92 * @Note: this function will not return a valid value for a non-valid
93 * authentication algorithm
95 static inline unsigned
96 get_digest_byte_length(JOB_HASH_ALG algo)
98 return auth_digest_byte_lengths[algo];
101 enum aesni_mb_operation {
102 AESNI_MB_OP_HASH_CIPHER,
103 AESNI_MB_OP_CIPHER_HASH,
104 AESNI_MB_OP_HASH_ONLY,
105 AESNI_MB_OP_CIPHER_ONLY,
106 AESNI_MB_OP_AEAD_HASH_CIPHER,
107 AESNI_MB_OP_AEAD_CIPHER_HASH,
108 AESNI_MB_OP_NOT_SUPPORTED
111 /** private data structure for each virtual AESNI device */
112 struct aesni_mb_private {
113 enum aesni_mb_vector_mode vector_mode;
114 /**< CPU vector instruction set mode */
115 unsigned max_nb_queue_pairs;
116 /**< Max number of queue pairs supported by device */
119 /** AESNI Multi buffer queue pair */
122 /**< Queue Pair Identifier */
123 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
124 /**< Unique Queue Pair Name */
125 const struct aesni_mb_op_fns *op_fns;
126 /**< Vector mode dependent pointer table of the multi-buffer APIs */
128 /**< Multi-buffer instance */
129 struct rte_ring *ingress_queue;
130 /**< Ring for placing operations ready for processing */
131 struct rte_mempool *sess_mp;
132 /**< Session Mempool */
133 struct rte_cryptodev_stats stats;
134 /**< Queue pair statistics */
136 /**< Index of the next slot to be used in temp_digests,
137 * to store the digest for a given operation
139 uint8_t temp_digests[MAX_JOBS][DIGEST_LENGTH_MAX];
140 /**< Buffers used to store the digest generated
141 * by the driver when verifying a digest provided
142 * by the user (using authentication verify operation)
144 } __rte_cache_aligned;
146 /** AES-NI multi-buffer private session structure */
147 struct aesni_mb_session {
148 JOB_CHAIN_ORDER chain_order;
153 /**< IV parameters */
155 /** Cipher Parameters */
157 /** Cipher direction - encrypt / decrypt */
158 JOB_CIPHER_DIRECTION direction;
159 /** Cipher mode - CBC / Counter */
160 JOB_CIPHER_MODE mode;
162 uint64_t key_length_in_bytes;
166 uint32_t encode[60] __rte_aligned(16);
168 uint32_t decode[60] __rte_aligned(16);
172 const void *ks_ptr[3];
176 /**< Expanded AES keys - Allocating space to
177 * contain the maximum expanded key size which
178 * is 240 bytes for 256 bit AES, calculate by:
179 * ((key size (bytes)) *
180 * ((number of rounds) + 1))
184 /** Authentication Parameters */
186 JOB_HASH_ALG algo; /**< Authentication Algorithm */
187 enum rte_crypto_auth_operation operation;
188 /**< auth operation generate or verify */
191 uint8_t inner[128] __rte_aligned(16);
193 uint8_t outer[128] __rte_aligned(16);
196 /**< HMAC Authentication pads -
197 * allocating space for the maximum pad
198 * size supported which is 128 bytes for
203 uint32_t k1_expanded[44] __rte_aligned(16);
204 /**< k1 (expanded key). */
205 uint8_t k2[16] __rte_aligned(16);
207 uint8_t k3[16] __rte_aligned(16);
212 uint32_t expkey[60] __rte_aligned(16);
213 /**< k1 (expanded key). */
214 uint32_t skey1[4] __rte_aligned(16);
216 uint32_t skey2[4] __rte_aligned(16);
219 /**< Expanded XCBC authentication keys */
221 /** Generated digest size by the Multi-buffer library */
222 uint16_t gen_digest_len;
223 /** Requested digest size from Cryptodev */
224 uint16_t req_digest_len;
228 /** AAD data length */
231 } __rte_cache_aligned;
238 aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
239 struct aesni_mb_session *sess,
240 const struct rte_crypto_sym_xform *xform);
243 /** device specific operations function pointer structure */
244 extern struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops;
248 #endif /* _RTE_AESNI_MB_PMD_PRIVATE_H_ */