1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2019 Intel Corporation
4 #ifndef _QAT_SYM_SESSION_H_
5 #define _QAT_SYM_SESSION_H_
7 #include <rte_crypto.h>
8 #include <rte_cryptodev_pmd.h>
9 #ifdef RTE_LIB_SECURITY
10 #include <rte_security.h>
13 #include "qat_common.h"
14 #include "icp_qat_hw.h"
15 #include "icp_qat_fw.h"
16 #include "icp_qat_fw_la.h"
19 * Key Modifier (KM) value used in KASUMI algorithm in F9 mode to XOR
22 #define KASUMI_F9_KEY_MODIFIER_4_BYTES 0xAAAAAAAA
24 #define KASUMI_F8_KEY_MODIFIER_4_BYTES 0x55555555
29 #define AES_GCM_J0_LEN 16
32 #define QAT_3DES_KEY_SZ_OPT1 24 /* Keys are independent */
33 #define QAT_3DES_KEY_SZ_OPT2 16 /* K3=K1 */
34 #define QAT_3DES_KEY_SZ_OPT3 8 /* K1=K2=K3 */
36 /* 96-bit case of IV for CCP/GCM single pass algorithm */
37 #define QAT_AES_GCM_SPC_IV_SIZE 12
39 #define QAT_AES_HW_CONFIG_CBC_ENC(alg) \
40 ICP_QAT_HW_CIPHER_CONFIG_BUILD(ICP_QAT_HW_CIPHER_CBC_MODE, alg, \
41 ICP_QAT_HW_CIPHER_NO_CONVERT, \
42 ICP_QAT_HW_CIPHER_ENCRYPT)
44 #define QAT_AES_HW_CONFIG_CBC_DEC(alg) \
45 ICP_QAT_HW_CIPHER_CONFIG_BUILD(ICP_QAT_HW_CIPHER_CBC_MODE, alg, \
46 ICP_QAT_HW_CIPHER_KEY_CONVERT, \
47 ICP_QAT_HW_CIPHER_DECRYPT)
49 #define QAT_AES_CMAC_CONST_RB 0x87
51 enum qat_sym_proto_flag {
52 QAT_CRYPTO_PROTO_FLAG_NONE = 0,
53 QAT_CRYPTO_PROTO_FLAG_CCM = 1,
54 QAT_CRYPTO_PROTO_FLAG_GCM = 2,
55 QAT_CRYPTO_PROTO_FLAG_SNOW3G = 3,
56 QAT_CRYPTO_PROTO_FLAG_ZUC = 4
59 /* Common content descriptor */
61 struct icp_qat_hw_cipher_algo_blk cipher;
62 struct icp_qat_hw_auth_algo_blk hash;
63 } __rte_packed __rte_cache_aligned;
65 struct qat_sym_session {
66 enum icp_qat_fw_la_cmd_id qat_cmd;
67 enum icp_qat_hw_cipher_algo qat_cipher_alg;
68 enum icp_qat_hw_cipher_dir qat_dir;
69 enum icp_qat_hw_cipher_mode qat_mode;
70 enum icp_qat_hw_auth_algo qat_hash_alg;
71 enum icp_qat_hw_auth_op auth_op;
72 enum icp_qat_hw_auth_mode auth_mode;
77 struct icp_qat_fw_la_bulk_req fw_req;
79 struct qat_crypto_instance *inst;
88 uint16_t auth_key_length;
89 uint16_t digest_length;
90 rte_spinlock_t lock; /* protects this struct */
91 enum qat_device_gen min_qat_dev_gen;
93 uint8_t is_single_pass;
94 uint8_t is_single_pass_gmac;
99 qat_sym_session_configure(struct rte_cryptodev *dev,
100 struct rte_crypto_sym_xform *xform,
101 struct rte_cryptodev_sym_session *sess,
102 struct rte_mempool *mempool);
105 qat_sym_session_set_parameters(struct rte_cryptodev *dev,
106 struct rte_crypto_sym_xform *xform, void *session_private);
109 qat_sym_session_configure_aead(struct rte_cryptodev *dev,
110 struct rte_crypto_sym_xform *xform,
111 struct qat_sym_session *session);
114 qat_sym_session_configure_cipher(struct rte_cryptodev *dev,
115 struct rte_crypto_sym_xform *xform,
116 struct qat_sym_session *session);
119 qat_sym_session_configure_auth(struct rte_cryptodev *dev,
120 struct rte_crypto_sym_xform *xform,
121 struct qat_sym_session *session);
124 qat_sym_session_clear(struct rte_cryptodev *dev,
125 struct rte_cryptodev_sym_session *session);
128 qat_sym_session_get_private_size(struct rte_cryptodev *dev);
131 qat_sym_sesssion_init_common_hdr(struct qat_sym_session *session,
132 struct icp_qat_fw_comn_req_hdr *header,
133 enum qat_sym_proto_flag proto_flags);
135 qat_sym_validate_aes_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
137 qat_sym_validate_aes_docsisbpi_key(int key_len,
138 enum icp_qat_hw_cipher_algo *alg);
140 qat_sym_validate_snow3g_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
142 qat_sym_validate_kasumi_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
144 qat_sym_validate_3des_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
146 qat_sym_validate_des_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
148 qat_cipher_get_block_size(enum icp_qat_hw_cipher_algo qat_cipher_alg);
150 qat_sym_validate_zuc_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
152 #ifdef RTE_LIB_SECURITY
154 qat_security_session_create(void *dev, struct rte_security_session_conf *conf,
155 struct rte_security_session *sess, struct rte_mempool *mempool);
157 qat_security_session_destroy(void *dev, struct rte_security_session *sess);
160 #endif /* _QAT_SYM_SESSION_H_ */