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 <rte_cryptodev_pmd.h>
   9
  10 #include "qat_common.h"
  11 #include "icp_qat_hw.h"
  12 #include "icp_qat_fw.h"
  13 #include "icp_qat_fw_la.h"
  14
  15 /*
  16  * Key Modifier (KM) value used in KASUMI algorithm in F9 mode to XOR
  17  * Integrity Key (IK)
  18  */
  19 #define KASUMI_F9_KEY_MODIFIER_4_BYTES   0xAAAAAAAA
  20
  21 #define KASUMI_F8_KEY_MODIFIER_4_BYTES   0x55555555
  22
  23 /*
  24  * AES-GCM J0 length
  25  */
  26 #define AES_GCM_J0_LEN 16
  27
  28 /* 3DES key sizes */
  29 #define QAT_3DES_KEY_SZ_OPT1 24 /* Keys are independent */
  30 #define QAT_3DES_KEY_SZ_OPT2 16 /* K3=K1 */
  31 #define QAT_3DES_KEY_SZ_OPT3 8 /* K1=K2=K3 */
  32
  33 /* 96-bit case of IV for CCP/GCM single pass algorithm */
  34 #define QAT_AES_GCM_SPC_IV_SIZE 12
  35
  36
  37 #define QAT_AES_HW_CONFIG_CBC_ENC(alg) \
  38         ICP_QAT_HW_CIPHER_CONFIG_BUILD(ICP_QAT_HW_CIPHER_CBC_MODE, alg, \
  39                                         ICP_QAT_HW_CIPHER_NO_CONVERT, \
  40                                         ICP_QAT_HW_CIPHER_ENCRYPT)
  41
  42 #define QAT_AES_HW_CONFIG_CBC_DEC(alg) \
  43         ICP_QAT_HW_CIPHER_CONFIG_BUILD(ICP_QAT_HW_CIPHER_CBC_MODE, alg, \
  44                                         ICP_QAT_HW_CIPHER_KEY_CONVERT, \
  45                                         ICP_QAT_HW_CIPHER_DECRYPT)
  46
  47 #define QAT_AES_CMAC_CONST_RB 0x87
  48
  49 enum qat_sym_proto_flag {
  50         QAT_CRYPTO_PROTO_FLAG_NONE = 0,
  51         QAT_CRYPTO_PROTO_FLAG_CCM = 1,
  52         QAT_CRYPTO_PROTO_FLAG_GCM = 2,
  53         QAT_CRYPTO_PROTO_FLAG_SNOW3G = 3,
  54         QAT_CRYPTO_PROTO_FLAG_ZUC = 4
  55 };
  56
  57 /* Common content descriptor */
  58 struct qat_sym_cd {
  59         struct icp_qat_hw_cipher_algo_blk cipher;
  60         struct icp_qat_hw_auth_algo_blk hash;
  61 } __rte_packed __rte_cache_aligned;
  62
  63 struct qat_sym_session {
  64         enum icp_qat_fw_la_cmd_id qat_cmd;
  65         enum icp_qat_hw_cipher_algo qat_cipher_alg;
  66         enum icp_qat_hw_cipher_dir qat_dir;
  67         enum icp_qat_hw_cipher_mode qat_mode;
  68         enum icp_qat_hw_auth_algo qat_hash_alg;
  69         enum icp_qat_hw_auth_op auth_op;
  70         void *bpi_ctx;
  71         struct qat_sym_cd cd;
  72         uint8_t *cd_cur_ptr;
  73         phys_addr_t cd_paddr;
  74         struct icp_qat_fw_la_bulk_req fw_req;
  75         uint8_t aad_len;
  76         struct qat_crypto_instance *inst;
  77         struct {
  78                 uint16_t offset;
  79                 uint16_t length;
  80         } cipher_iv;
  81         struct {
  82                 uint16_t offset;
  83                 uint16_t length;
  84         } auth_iv;
  85         uint16_t digest_length;
  86         rte_spinlock_t lock;    /* protects this struct */
  87         enum qat_device_gen min_qat_dev_gen;
  88         uint8_t aes_cmac;
  89         uint8_t is_single_pass;
  90 };
  91
  92 int
  93 qat_sym_session_configure(struct rte_cryptodev *dev,
  94                 struct rte_crypto_sym_xform *xform,
  95                 struct rte_cryptodev_sym_session *sess,
  96                 struct rte_mempool *mempool);
  97
  98 int
  99 qat_sym_session_set_parameters(struct rte_cryptodev *dev,
 100                 struct rte_crypto_sym_xform *xform, void *session_private);
 101
 102 int
 103 qat_sym_session_configure_aead(struct rte_cryptodev *dev,
 104                                 struct rte_crypto_sym_xform *xform,
 105                                 struct qat_sym_session *session);
 106
 107 int
 108 qat_sym_session_configure_cipher(struct rte_cryptodev *dev,
 109                 struct rte_crypto_sym_xform *xform,
 110                 struct qat_sym_session *session);
 111
 112 int
 113 qat_sym_session_configure_auth(struct rte_cryptodev *dev,
 114                                 struct rte_crypto_sym_xform *xform,
 115                                 struct qat_sym_session *session);
 116
 117 int
 118 qat_sym_session_aead_create_cd_cipher(struct qat_sym_session *cd,
 119                                                 const uint8_t *enckey,
 120                                                 uint32_t enckeylen);
 121
 122 int
 123 qat_sym_session_aead_create_cd_auth(struct qat_sym_session *cdesc,
 124                                                 const uint8_t *authkey,
 125                                                 uint32_t authkeylen,
 126                                                 uint32_t aad_length,
 127                                                 uint32_t digestsize,
 128                                                 unsigned int operation);
 129
 130 void
 131 qat_sym_session_clear(struct rte_cryptodev *dev,
 132                 struct rte_cryptodev_sym_session *session);
 133
 134 unsigned int
 135 qat_sym_session_get_private_size(struct rte_cryptodev *dev);
 136
 137 void
 138 qat_sym_sesssion_init_common_hdr(struct icp_qat_fw_comn_req_hdr *header,
 139                                         enum qat_sym_proto_flag proto_flags);
 140 int
 141 qat_sym_validate_aes_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 142 int
 143 qat_sym_validate_aes_docsisbpi_key(int key_len,
 144                                         enum icp_qat_hw_cipher_algo *alg);
 145 int
 146 qat_sym_validate_snow3g_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 147 int
 148 qat_sym_validate_kasumi_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 149 int
 150 qat_sym_validate_3des_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 151 int
 152 qat_sym_validate_des_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 153 int
 154 qat_cipher_get_block_size(enum icp_qat_hw_cipher_algo qat_cipher_alg);
 155 int
 156 qat_sym_validate_zuc_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 157
 158 #endif /* _QAT_SYM_SESSION_H_ */