f-stack/dpdk/drivers/crypto/aesni_mb/aesni_mb_pmd_private.h

338 lines
8.7 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2015-2016 Intel Corporation
*/
#ifndef _AESNI_MB_PMD_PRIVATE_H_
#define _AESNI_MB_PMD_PRIVATE_H_
#include <intel-ipsec-mb.h>
#if defined(RTE_LIB_SECURITY) && (IMB_VERSION_NUM) >= IMB_VERSION(0, 54, 0)
#define AESNI_MB_DOCSIS_SEC_ENABLED 1
#include <rte_security.h>
#include <rte_security_driver.h>
#endif
enum aesni_mb_vector_mode {
RTE_AESNI_MB_NOT_SUPPORTED = 0,
RTE_AESNI_MB_SSE,
RTE_AESNI_MB_AVX,
RTE_AESNI_MB_AVX2,
RTE_AESNI_MB_AVX512
};
#define CRYPTODEV_NAME_AESNI_MB_PMD crypto_aesni_mb
/**< AES-NI Multi buffer PMD device name */
/** AESNI_MB PMD LOGTYPE DRIVER */
extern int aesni_mb_logtype_driver;
#define AESNI_MB_LOG(level, fmt, ...) \
rte_log(RTE_LOG_ ## level, aesni_mb_logtype_driver, \
"%s() line %u: " fmt "\n", __func__, __LINE__, \
## __VA_ARGS__)
#define HMAC_IPAD_VALUE (0x36)
#define HMAC_OPAD_VALUE (0x5C)
/* Maximum length for digest */
#define DIGEST_LENGTH_MAX 64
static const unsigned auth_blocksize[] = {
[NULL_HASH] = 0,
[MD5] = 64,
[SHA1] = 64,
[SHA_224] = 64,
[SHA_256] = 64,
[SHA_384] = 128,
[SHA_512] = 128,
[AES_XCBC] = 16,
[AES_CCM] = 16,
[AES_CMAC] = 16,
[AES_GMAC] = 16,
[PLAIN_SHA1] = 64,
[PLAIN_SHA_224] = 64,
[PLAIN_SHA_256] = 64,
[PLAIN_SHA_384] = 128,
[PLAIN_SHA_512] = 128,
#if IMB_VERSION(0, 53, 3) <= IMB_VERSION_NUM
[IMB_AUTH_ZUC_EIA3_BITLEN] = 16,
[IMB_AUTH_SNOW3G_UIA2_BITLEN] = 16,
[IMB_AUTH_KASUMI_UIA1] = 16
#endif
};
/**
* Get the blocksize in bytes for a specified authentication algorithm
*
* @Note: this function will not return a valid value for a non-valid
* authentication algorithm
*/
static inline unsigned
get_auth_algo_blocksize(JOB_HASH_ALG algo)
{
return auth_blocksize[algo];
}
static const unsigned auth_truncated_digest_byte_lengths[] = {
[MD5] = 12,
[SHA1] = 12,
[SHA_224] = 14,
[SHA_256] = 16,
[SHA_384] = 24,
[SHA_512] = 32,
[AES_XCBC] = 12,
[AES_CMAC] = 12,
[AES_CCM] = 8,
[NULL_HASH] = 0,
[AES_GMAC] = 12,
[PLAIN_SHA1] = 20,
[PLAIN_SHA_224] = 28,
[PLAIN_SHA_256] = 32,
[PLAIN_SHA_384] = 48,
[PLAIN_SHA_512] = 64,
#if IMB_VERSION(0, 53, 3) <= IMB_VERSION_NUM
[IMB_AUTH_ZUC_EIA3_BITLEN] = 4,
[IMB_AUTH_SNOW3G_UIA2_BITLEN] = 4,
[IMB_AUTH_KASUMI_UIA1] = 4
#endif
};
/**
* Get the IPsec specified truncated length in bytes of the HMAC digest for a
* specified authentication algorithm
*
* @Note: this function will not return a valid value for a non-valid
* authentication algorithm
*/
static inline unsigned
get_truncated_digest_byte_length(JOB_HASH_ALG algo)
{
return auth_truncated_digest_byte_lengths[algo];
}
static const unsigned auth_digest_byte_lengths[] = {
[MD5] = 16,
[SHA1] = 20,
[SHA_224] = 28,
[SHA_256] = 32,
[SHA_384] = 48,
[SHA_512] = 64,
[AES_XCBC] = 16,
[AES_CMAC] = 16,
[AES_CCM] = 16,
[AES_GMAC] = 16,
[NULL_HASH] = 0,
[PLAIN_SHA1] = 20,
[PLAIN_SHA_224] = 28,
[PLAIN_SHA_256] = 32,
[PLAIN_SHA_384] = 48,
[PLAIN_SHA_512] = 64,
#if IMB_VERSION(0, 53, 3) <= IMB_VERSION_NUM
[IMB_AUTH_ZUC_EIA3_BITLEN] = 4,
[IMB_AUTH_SNOW3G_UIA2_BITLEN] = 4,
[IMB_AUTH_KASUMI_UIA1] = 4
#endif
/**< Vector mode dependent pointer table of the multi-buffer APIs */
};
/**
* Get the full digest size in bytes for a specified authentication algorithm
* (if available in the Multi-buffer library)
*
* @Note: this function will not return a valid value for a non-valid
* authentication algorithm
*/
static inline unsigned
get_digest_byte_length(JOB_HASH_ALG algo)
{
return auth_digest_byte_lengths[algo];
}
enum aesni_mb_operation {
AESNI_MB_OP_HASH_CIPHER,
AESNI_MB_OP_CIPHER_HASH,
AESNI_MB_OP_HASH_ONLY,
AESNI_MB_OP_CIPHER_ONLY,
AESNI_MB_OP_AEAD_HASH_CIPHER,
AESNI_MB_OP_AEAD_CIPHER_HASH,
AESNI_MB_OP_NOT_SUPPORTED
};
/** private data structure for each virtual AESNI device */
struct aesni_mb_private {
enum aesni_mb_vector_mode vector_mode;
/**< CPU vector instruction set mode */
unsigned max_nb_queue_pairs;
/**< Max number of queue pairs supported by device */
MB_MGR *mb_mgr;
/**< Multi-buffer instance */
};
/** AESNI Multi buffer queue pair */
struct aesni_mb_qp {
uint16_t id;
/**< Queue Pair Identifier */
char name[RTE_CRYPTODEV_NAME_MAX_LEN];
/**< Unique Queue Pair Name */
MB_MGR *mb_mgr;
/**< Multi-buffer instance */
struct rte_ring *ingress_queue;
/**< Ring for placing operations ready for processing */
struct rte_mempool *sess_mp;
/**< Session Mempool */
struct rte_mempool *sess_mp_priv;
/**< Session Private Data Mempool */
struct rte_cryptodev_stats stats;
/**< Queue pair statistics */
uint8_t digest_idx;
/**< Index of the next slot to be used in temp_digests,
* to store the digest for a given operation
*/
uint8_t temp_digests[MAX_JOBS][DIGEST_LENGTH_MAX];
/**< Buffers used to store the digest generated
* by the driver when verifying a digest provided
* by the user (using authentication verify operation)
*/
} __rte_cache_aligned;
/** AES-NI multi-buffer private session structure */
struct aesni_mb_session {
JOB_CHAIN_ORDER chain_order;
struct {
uint16_t length;
uint16_t offset;
} iv;
struct {
uint16_t length;
uint16_t offset;
} auth_iv;
/**< IV parameters */
/** Cipher Parameters */const struct aesni_mb_op_fns *op_fns;
/**< Vector mode dependent pointer table of the multi-buffer APIs */
struct {
/** Cipher direction - encrypt / decrypt */
JOB_CIPHER_DIRECTION direction;
/** Cipher mode - CBC / Counter */
JOB_CIPHER_MODE mode;
uint64_t key_length_in_bytes;
union {
struct {
uint32_t encode[60] __rte_aligned(16);
/**< encode key */
uint32_t decode[60] __rte_aligned(16);
/**< decode key */
} expanded_aes_keys;
/**< Expanded AES keys - Allocating space to
* contain the maximum expanded key size which
* is 240 bytes for 256 bit AES, calculate by:
* ((key size (bytes)) *
* ((number of rounds) + 1))
*/
struct {
const void *ks_ptr[3];
uint64_t key[3][16];
} exp_3des_keys;
/**< Expanded 3DES keys */
struct gcm_key_data gcm_key;
/**< Expanded GCM key */
uint8_t zuc_cipher_key[16];
/**< ZUC cipher key */
#if IMB_VERSION(0, 53, 3) <= IMB_VERSION_NUM
snow3g_key_schedule_t pKeySched_snow3g_cipher;
/**< SNOW3G scheduled cipher key */
kasumi_key_sched_t pKeySched_kasumi_cipher;
/**< KASUMI scheduled cipher key */
#endif
};
} cipher;
/** Authentication Parameters */
struct {
JOB_HASH_ALG algo; /**< Authentication Algorithm */
enum rte_crypto_auth_operation operation;
/**< auth operation generate or verify */
union {
struct {
uint8_t inner[128] __rte_aligned(16);
/**< inner pad */
uint8_t outer[128] __rte_aligned(16);
/**< outer pad */
} pads;
/**< HMAC Authentication pads -
* allocating space for the maximum pad
* size supported which is 128 bytes for
* SHA512
*/
struct {
uint32_t k1_expanded[44] __rte_aligned(16);
/**< k1 (expanded key). */
uint8_t k2[16] __rte_aligned(16);
/**< k2. */
uint8_t k3[16] __rte_aligned(16);
/**< k3. */
} xcbc;
struct {
uint32_t expkey[60] __rte_aligned(16);
/**< k1 (expanded key). */
uint32_t skey1[4] __rte_aligned(16);
/**< k2. */
uint32_t skey2[4] __rte_aligned(16);
/**< k3. */
} cmac;
/**< Expanded XCBC authentication keys */
uint8_t zuc_auth_key[16];
/**< ZUC authentication key */
#if IMB_VERSION(0, 53, 3) <= IMB_VERSION_NUM
snow3g_key_schedule_t pKeySched_snow3g_auth;
/**< SNOW3G scheduled authentication key */
kasumi_key_sched_t pKeySched_kasumi_auth;
/**< KASUMI scheduled authentication key */
#endif
};
/** Generated digest size by the Multi-buffer library */
uint16_t gen_digest_len;
/** Requested digest size from Cryptodev */
uint16_t req_digest_len;
} auth;
struct {
/** AAD data length */
uint16_t aad_len;
} aead;
} __rte_cache_aligned;
extern int
aesni_mb_set_session_parameters(const MB_MGR *mb_mgr,
struct aesni_mb_session *sess,
const struct rte_crypto_sym_xform *xform);
#ifdef AESNI_MB_DOCSIS_SEC_ENABLED
extern int
aesni_mb_set_docsis_sec_session_parameters(
__rte_unused struct rte_cryptodev *dev,
struct rte_security_session_conf *conf,
void *sess);
#endif
/** device specific operations function pointer structures */
extern struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops;
#ifdef AESNI_MB_DOCSIS_SEC_ENABLED
extern struct rte_security_ops *rte_aesni_mb_pmd_sec_ops;
#endif
extern uint32_t
aesni_mb_cpu_crypto_process_bulk(struct rte_cryptodev *dev,
struct rte_cryptodev_sym_session *sess, union rte_crypto_sym_ofs sofs,
struct rte_crypto_sym_vec *vec);
#endif /* _AESNI_MB_PMD_PRIVATE_H_ */