drivers/crypto/qat/qat_adf/qat_algs.h

   1 /*
   2  *  This file is provided under a dual BSD/GPLv2 license.  When using or
   3  *  redistributing this file, you may do so under either license.
   4  *
   5  *  GPL LICENSE SUMMARY
   6  *  Copyright(c) 2015-2016 Intel Corporation.
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of version 2 of the GNU General Public License as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful, but
  12  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *  General Public License for more details.
  15  *
  16  *  Contact Information:
  17  *  qat-linux@intel.com
  18  *
  19  *  BSD LICENSE
  20  *  Copyright(c) 2015-2016 Intel Corporation.
  21  *  Redistribution and use in source and binary forms, with or without
  22  *  modification, are permitted provided that the following conditions
  23  *  are met:
  24  *
  25  *    * Redistributions of source code must retain the above copyright
  26  *      notice, this list of conditions and the following disclaimer.
  27  *    * Redistributions in binary form must reproduce the above copyright
  28  *      notice, this list of conditions and the following disclaimer in
  29  *      the documentation and/or other materials provided with the
  30  *      distribution.
  31  *    * Neither the name of Intel Corporation nor the names of its
  32  *      contributors may be used to endorse or promote products derived
  33  *      from this software without specific prior written permission.
  34  *
  35  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  36  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  38  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  39  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  42  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  43  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  44  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  45  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  46  */
  47 #ifndef _ICP_QAT_ALGS_H_
  48 #define _ICP_QAT_ALGS_H_
  49 #include <rte_memory.h>
  50 #include "icp_qat_hw.h"
  51 #include "icp_qat_fw.h"
  52 #include "icp_qat_fw_la.h"
  53
  54 /*
  55  * Key Modifier (KM) value used in KASUMI algorithm in F9 mode to XOR
  56  * Integrity Key (IK)
  57  */
  58 #define KASUMI_F9_KEY_MODIFIER_4_BYTES   0xAAAAAAAA
  59
  60 #define KASUMI_F8_KEY_MODIFIER_4_BYTES   0x55555555
  61
  62 /* 3DES key sizes */
  63 #define QAT_3DES_KEY_SZ_OPT1 24 /* Keys are independent */
  64 #define QAT_3DES_KEY_SZ_OPT2 16 /* K3=K1 */
  65
  66 #define QAT_AES_HW_CONFIG_CBC_ENC(alg) \
  67         ICP_QAT_HW_CIPHER_CONFIG_BUILD(ICP_QAT_HW_CIPHER_CBC_MODE, alg, \
  68                                         ICP_QAT_HW_CIPHER_NO_CONVERT, \
  69                                         ICP_QAT_HW_CIPHER_ENCRYPT)
  70
  71 #define QAT_AES_HW_CONFIG_CBC_DEC(alg) \
  72         ICP_QAT_HW_CIPHER_CONFIG_BUILD(ICP_QAT_HW_CIPHER_CBC_MODE, alg, \
  73                                         ICP_QAT_HW_CIPHER_KEY_CONVERT, \
  74                                         ICP_QAT_HW_CIPHER_DECRYPT)
  75
  76 struct qat_alg_buf {
  77         uint32_t len;
  78         uint32_t resrvd;
  79         uint64_t addr;
  80 } __rte_packed;
  81
  82 struct qat_alg_buf_list {
  83         uint64_t resrvd;
  84         uint32_t num_bufs;
  85         uint32_t num_mapped_bufs;
  86         struct qat_alg_buf bufers[];
  87 } __rte_packed __rte_cache_aligned;
  88
  89 /* Common content descriptor */
  90 struct qat_alg_cd {
  91         struct icp_qat_hw_cipher_algo_blk cipher;
  92         struct icp_qat_hw_auth_algo_blk hash;
  93 } __rte_packed __rte_cache_aligned;
  94
  95 struct qat_session {
  96         enum icp_qat_fw_la_cmd_id qat_cmd;
  97         enum icp_qat_hw_cipher_algo qat_cipher_alg;
  98         enum icp_qat_hw_cipher_dir qat_dir;
  99         enum icp_qat_hw_cipher_mode qat_mode;
 100         enum icp_qat_hw_auth_algo qat_hash_alg;
 101         enum icp_qat_hw_auth_op auth_op;
 102         struct qat_alg_cd cd;
 103         uint8_t *cd_cur_ptr;
 104         phys_addr_t cd_paddr;
 105         struct icp_qat_fw_la_bulk_req fw_req;
 106         uint8_t aad_len;
 107         struct qat_crypto_instance *inst;
 108         rte_spinlock_t lock;    /* protects this struct */
 109 };
 110
 111 struct qat_alg_ablkcipher_cd {
 112         struct icp_qat_hw_cipher_algo_blk *cd;
 113         phys_addr_t cd_paddr;
 114         struct icp_qat_fw_la_bulk_req fw_req;
 115         struct qat_crypto_instance *inst;
 116         rte_spinlock_t lock;    /* protects this struct */
 117 };
 118
 119 int qat_get_inter_state_size(enum icp_qat_hw_auth_algo qat_hash_alg);
 120
 121 int qat_alg_aead_session_create_content_desc_cipher(struct qat_session *cd,
 122                                                 uint8_t *enckey,
 123                                                 uint32_t enckeylen);
 124
 125 int qat_alg_aead_session_create_content_desc_auth(struct qat_session *cdesc,
 126                                                 uint8_t *authkey,
 127                                                 uint32_t authkeylen,
 128                                                 uint32_t add_auth_data_length,
 129                                                 uint32_t digestsize,
 130                                                 unsigned int operation);
 131
 132 void qat_alg_init_common_hdr(struct icp_qat_fw_comn_req_hdr *header,
 133                                                 uint16_t proto);
 134
 135 void qat_alg_ablkcipher_init_enc(struct qat_alg_ablkcipher_cd *cd,
 136                                         int alg, const uint8_t *key,
 137                                         unsigned int keylen);
 138
 139 void qat_alg_ablkcipher_init_dec(struct qat_alg_ablkcipher_cd *cd,
 140                                         int alg, const uint8_t *key,
 141                                         unsigned int keylen);
 142
 143 int qat_alg_validate_aes_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 144 int qat_alg_validate_snow3g_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 145 int qat_alg_validate_kasumi_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 146 int qat_alg_validate_3des_key(int key_len, enum icp_qat_hw_cipher_algo *alg);
 147 #endif