drivers/crypto/qat/qat_sym_session.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2015-2019 Intel Corporation
   3  */
   4 #ifndef _QAT_SYM_SESSION_H_
   5 #define _QAT_SYM_SESSION_H_
   6
   7 #include <rte_crypto.h>
   8 #include <cryptodev_pmd.h>
   9 #ifdef RTE_LIB_SECURITY
  10 #include <rte_security.h>
  11 #endif
  12
  13 #include "qat_common.h"
  14 #include "icp_qat_hw.h"
  15 #include "icp_qat_fw.h"
  16 #include "icp_qat_fw_la.h"
  17
  18 /*
  19  * Key Modifier (KM) value used in KASUMI algorithm in F9 mode to XOR
  20  * Integrity Key (IK)
  21  */
  22 #define KASUMI_F9_KEY_MODIFIER_4_BYTES   0xAAAAAAAA
  23
  24 #define KASUMI_F8_KEY_MODIFIER_4_BYTES   0x55555555
  25
  26 /*
  27  * AES-GCM J0 length
  28  */
  29 #define AES_GCM_J0_LEN 16
  30
  31 /* 3DES key sizes */
  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 */
  35
  36 /* 96-bit case of IV for CCP/GCM single pass algorithm */
  37 #define QAT_AES_GCM_SPC_IV_SIZE 12
  38
  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)
  43
  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)
  48
  49 #define QAT_AES_CMAC_CONST_RB 0x87
  50
  51 #define QAT_CRYPTO_SLICE_SPC    1
  52 #define QAT_CRYPTO_SLICE_UCS    2
  53 #define QAT_CRYPTO_SLICE_WCP    4
  54
  55 #define QAT_SESSION_IS_SLICE_SET(flags, flag)   \
  56         (!!((flags) & (flag)))
  57
  58 enum qat_sym_proto_flag {
  59         QAT_CRYPTO_PROTO_FLAG_NONE = 0,
  60         QAT_CRYPTO_PROTO_FLAG_CCM = 1,
  61         QAT_CRYPTO_PROTO_FLAG_GCM = 2,
  62         QAT_CRYPTO_PROTO_FLAG_SNOW3G = 3,
  63         QAT_CRYPTO_PROTO_FLAG_ZUC = 4
  64 };
  65
  66 /* Common content descriptor */
  67 struct qat_sym_cd {
  68         struct icp_qat_hw_cipher_algo_blk cipher;
  69         struct icp_qat_hw_auth_algo_blk hash;
  70 } __rte_packed __rte_cache_aligned;
  71
  72 struct qat_sym_session {
  73         enum icp_qat_fw_la_cmd_id qat_cmd;
  74         enum icp_qat_hw_cipher_algo qat_cipher_alg;
  75         enum icp_qat_hw_cipher_dir qat_dir;
  76         enum icp_qat_hw_cipher_mode qat_mode;
  77         enum icp_qat_hw_auth_algo qat_hash_alg;
  78         enum icp_qat_hw_auth_op auth_op;
  79         enum icp_qat_hw_auth_mode auth_mode;
  80         void *bpi_ctx;
  81         struct qat_sym_cd cd;
  82         uint8_t *cd_cur_ptr;
  83         phys_addr_t cd_paddr;
  84         struct icp_qat_fw_la_bulk_req fw_req;
  85         uint8_t aad_len;
  86         struct qat_crypto_instance *inst;
  87         struct {
  88                 uint16_t offset;
  89                 uint16_t length;
  90         } cipher_iv;
  91         struct {
  92                 uint16_t offset;
  93                 uint16_t length;
  94         } auth_iv;
  95         uint16_t auth_key_length;
  96         uint16_t digest_length;
  97         rte_spinlock_t lock;    /* protects this struct */
  98         enum qat_device_gen min_qat_dev_gen;
  99         uint8_t aes_cmac;
 100         uint8_t is_single_pass;
 101         uint8_t is_single_pass_gmac;
 102         uint8_t is_ucs;
 103         uint8_t is_iv12B;
 104         uint8_t is_gmac;
 105         uint8_t is_auth;
 106         uint8_t is_cnt_zero;
 107         /* Some generations need different setup of counter */
 108         uint32_t slice_types;
 109         enum qat_sym_proto_flag qat_proto_flag;
 110 };
 111
 112 int
 113 qat_sym_session_configure(struct rte_cryptodev *dev,
 114                 struct rte_crypto_sym_xform *xform,
 115                 struct rte_cryptodev_sym_session *sess,
 116                 struct rte_mempool *mempool);
 117
 118 int
 119 qat_sym_session_set_parameters(struct rte_cryptodev *dev,
 120                 struct rte_crypto_sym_xform *xform, void *session_private);
 121
 122 int
 123 qat_sym_session_configure_aead(struct rte_cryptodev *dev,
 124                                 struct rte_crypto_sym_xform *xform,
 125                                 struct qat_sym_session *session);
 126
 127 int
 128 qat_sym_session_configure_cipher(struct rte_cryptodev *dev,
 129                 struct rte_crypto_sym_xform *xform,
 130                 struct qat_sym_session *session);
 131
 132 int
 133 qat_sym_session_configure_auth(struct rte_cryptodev *dev,
 134                                 struct rte_crypto_sym_xform *xform,
 135                                 struct qat_sym_session *session);
 136
 137 void
 138 qat_sym_session_clear(struct rte_cryptodev *dev,
 139                 struct rte_cryptodev_sym_session *session);
 140
 141 unsigned int
 142 qat_sym_session_get_private_size(struct rte_cryptodev *dev);
 143
 144 void
 145 qat_sym_sesssion_init_common_hdr(struct qat_sym_session *session,
 146                                         struct icp_qat_fw_comn_req_hdr *header,
 147                                         enum qat_sym_proto_flag proto_flags);
 148 int
 149 qat_sym_validate_aes_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 150 int
 151 qat_sym_validate_aes_docsisbpi_key(int key_len,
 152                                         enum icp_qat_hw_cipher_algo *alg);
 153 int
 154 qat_sym_validate_snow3g_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 155 int
 156 qat_sym_validate_kasumi_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 157 int
 158 qat_sym_validate_3des_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 159 int
 160 qat_sym_validate_des_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 161 int
 162 qat_cipher_get_block_size(enum icp_qat_hw_cipher_algo qat_cipher_alg);
 163 int
 164 qat_sym_validate_zuc_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 165
 166 #ifdef RTE_LIB_SECURITY
 167 int
 168 qat_security_session_create(void *dev, struct rte_security_session_conf *conf,
 169                 struct rte_security_session *sess, struct rte_mempool *mempool);
 170 int
 171 qat_security_session_destroy(void *dev, struct rte_security_session *sess);
 172 #endif
 173
 174 #endif /* _QAT_SYM_SESSION_H_ */