root/drivers/crypto/chelsio/chcr_crypto.h
/*
 * This file is part of the Chelsio T6 Crypto driver for Linux.
 *
 * Copyright (c) 2003-2016 Chelsio Communications, Inc. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

#ifndef __CHCR_CRYPTO_H__
#define __CHCR_CRYPTO_H__

#define GHASH_BLOCK_SIZE    16
#define GHASH_DIGEST_SIZE   16

#define CCM_B0_SIZE             16
#define CCM_AAD_FIELD_SIZE      2
// 511 - 16(For IV)
#define T6_MAX_AAD_SIZE 495


/* Define following if h/w is not dropping the AAD and IV data before
 * giving the processed data
 */

#define CHCR_CRA_PRIORITY 500
#define CHCR_AEAD_PRIORITY 6000
#define CHCR_AES_MAX_KEY_LEN  (2 * (AES_MAX_KEY_SIZE)) /* consider xts */
#define CHCR_MAX_CRYPTO_IV_LEN 16 /* AES IV len */

#define CHCR_MAX_AUTHENC_AES_KEY_LEN 32 /* max aes key length*/
#define CHCR_MAX_AUTHENC_SHA_KEY_LEN 128 /* max sha key length*/

#define CHCR_GIVENCRYPT_OP 2
/* CPL/SCMD parameters */

#define CHCR_ENCRYPT_OP 0
#define CHCR_DECRYPT_OP 1

#define CHCR_SCMD_SEQ_NO_CTRL_32BIT     1
#define CHCR_SCMD_SEQ_NO_CTRL_48BIT     2
#define CHCR_SCMD_SEQ_NO_CTRL_64BIT     3

#define CHCR_SCMD_PROTO_VERSION_GENERIC 4

#define CHCR_SCMD_AUTH_CTRL_AUTH_CIPHER 0
#define CHCR_SCMD_AUTH_CTRL_CIPHER_AUTH 1

#define CHCR_SCMD_CIPHER_MODE_NOP               0
#define CHCR_SCMD_CIPHER_MODE_AES_CBC           1
#define CHCR_SCMD_CIPHER_MODE_AES_GCM           2
#define CHCR_SCMD_CIPHER_MODE_AES_CTR           3
#define CHCR_SCMD_CIPHER_MODE_GENERIC_AES       4
#define CHCR_SCMD_CIPHER_MODE_AES_XTS           6
#define CHCR_SCMD_CIPHER_MODE_AES_CCM           7

#define CHCR_SCMD_AUTH_MODE_NOP             0
#define CHCR_SCMD_AUTH_MODE_SHA1            1
#define CHCR_SCMD_AUTH_MODE_SHA224          2
#define CHCR_SCMD_AUTH_MODE_SHA256          3
#define CHCR_SCMD_AUTH_MODE_GHASH           4
#define CHCR_SCMD_AUTH_MODE_SHA512_224      5
#define CHCR_SCMD_AUTH_MODE_SHA512_256      6
#define CHCR_SCMD_AUTH_MODE_SHA512_384      7
#define CHCR_SCMD_AUTH_MODE_SHA512_512      8
#define CHCR_SCMD_AUTH_MODE_CBCMAC          9
#define CHCR_SCMD_AUTH_MODE_CMAC            10

#define CHCR_SCMD_HMAC_CTRL_NOP             0
#define CHCR_SCMD_HMAC_CTRL_NO_TRUNC        1
#define CHCR_SCMD_HMAC_CTRL_TRUNC_RFC4366   2
#define CHCR_SCMD_HMAC_CTRL_IPSEC_96BIT     3
#define CHCR_SCMD_HMAC_CTRL_PL1             4
#define CHCR_SCMD_HMAC_CTRL_PL2             5
#define CHCR_SCMD_HMAC_CTRL_PL3             6
#define CHCR_SCMD_HMAC_CTRL_DIV2            7
#define VERIFY_HW 0
#define VERIFY_SW 1

#define CHCR_SCMD_IVGEN_CTRL_HW             0
#define CHCR_SCMD_IVGEN_CTRL_SW             1
/* This are not really mac key size. They are intermediate values
 * of sha engine and its size
 */
#define CHCR_KEYCTX_MAC_KEY_SIZE_128        0
#define CHCR_KEYCTX_MAC_KEY_SIZE_160        1
#define CHCR_KEYCTX_MAC_KEY_SIZE_192        2
#define CHCR_KEYCTX_MAC_KEY_SIZE_256        3
#define CHCR_KEYCTX_MAC_KEY_SIZE_512        4
#define CHCR_KEYCTX_CIPHER_KEY_SIZE_128     0
#define CHCR_KEYCTX_CIPHER_KEY_SIZE_192     1
#define CHCR_KEYCTX_CIPHER_KEY_SIZE_256     2
#define CHCR_KEYCTX_NO_KEY                  15

#define CHCR_CPL_FW4_PLD_IV_OFFSET          (5 * 64) /* bytes. flt #5 and #6 */
#define CHCR_CPL_FW4_PLD_HASH_RESULT_OFFSET (7 * 64) /* bytes. flt #7 */
#define CHCR_CPL_FW4_PLD_DATA_SIZE          (4 * 64) /* bytes. flt #4 to #7 */

#define KEY_CONTEXT_HDR_SALT_AND_PAD        16
#define flits_to_bytes(x)  (x * 8)

#define IV_NOP                  0
#define IV_IMMEDIATE            1
#define IV_DSGL                 2

#define AEAD_H_SIZE             16

#define CRYPTO_ALG_SUB_TYPE_MASK            0x0f000000
#define CRYPTO_ALG_SUB_TYPE_HASH_HMAC       0x01000000
#define CRYPTO_ALG_SUB_TYPE_AEAD_RFC4106    0x02000000
#define CRYPTO_ALG_SUB_TYPE_AEAD_GCM        0x03000000
#define CRYPTO_ALG_SUB_TYPE_CBC_SHA         0x04000000
#define CRYPTO_ALG_SUB_TYPE_AEAD_CCM        0x05000000
#define CRYPTO_ALG_SUB_TYPE_AEAD_RFC4309    0x06000000
#define CRYPTO_ALG_SUB_TYPE_CBC_NULL        0x07000000
#define CRYPTO_ALG_SUB_TYPE_CTR             0x08000000
#define CRYPTO_ALG_SUB_TYPE_CTR_RFC3686     0x09000000
#define CRYPTO_ALG_SUB_TYPE_XTS             0x0a000000
#define CRYPTO_ALG_SUB_TYPE_CBC             0x0b000000
#define CRYPTO_ALG_SUB_TYPE_CTR_SHA         0x0c000000
#define CRYPTO_ALG_SUB_TYPE_CTR_NULL   0x0d000000
#define CRYPTO_ALG_TYPE_HMAC (CRYPTO_ALG_TYPE_AHASH |\
                              CRYPTO_ALG_SUB_TYPE_HASH_HMAC)

#define MAX_SCRATCH_PAD_SIZE    32

#define CHCR_HASH_MAX_BLOCK_SIZE_64  64
#define CHCR_HASH_MAX_BLOCK_SIZE_128 128
#define CHCR_SRC_SG_SIZE (0x10000 - sizeof(int))
#define CHCR_DST_SG_SIZE 2048

static inline struct chcr_context *a_ctx(struct crypto_aead *tfm)
{
        return crypto_aead_ctx(tfm);
}

static inline struct chcr_context *c_ctx(struct crypto_skcipher *tfm)
{
        return crypto_skcipher_ctx(tfm);
}

static inline struct chcr_context *h_ctx(struct crypto_ahash *tfm)
{
        return crypto_tfm_ctx(crypto_ahash_tfm(tfm));
}

struct ablk_ctx {
        struct crypto_skcipher *sw_cipher;
        __be32 key_ctx_hdr;
        unsigned int enckey_len;
        unsigned char ciph_mode;
        u8 key[CHCR_AES_MAX_KEY_LEN];
        u8 nonce[4];
        u8 rrkey[AES_MAX_KEY_SIZE];
};
struct chcr_aead_reqctx {
        struct  sk_buff *skb;
        dma_addr_t iv_dma;
        dma_addr_t b0_dma;
        unsigned int b0_len;
        unsigned int op;
        u16 imm;
        u16 verify;
        u16 txqidx;
        u16 rxqidx;
        u8 iv[CHCR_MAX_CRYPTO_IV_LEN + MAX_SCRATCH_PAD_SIZE];
        u8 *scratch_pad;
};

struct ulptx_walk {
        struct ulptx_sgl *sgl;
        unsigned int nents;
        unsigned int pair_idx;
        unsigned int last_sg_len;
        struct scatterlist *last_sg;
        struct ulptx_sge_pair *pair;

};

struct dsgl_walk {
        unsigned int nents;
        unsigned int last_sg_len;
        struct scatterlist *last_sg;
        struct cpl_rx_phys_dsgl *dsgl;
        struct phys_sge_pairs *to;
};

struct chcr_gcm_ctx {
        u8 ghash_h[AEAD_H_SIZE];
};

struct chcr_authenc_ctx {
        u8 dec_rrkey[AES_MAX_KEY_SIZE];
        u8 h_iopad[2 * CHCR_HASH_MAX_DIGEST_SIZE];
        unsigned char auth_mode;
};

struct __aead_ctx {
        union {
                DECLARE_FLEX_ARRAY(struct chcr_gcm_ctx, gcm);
                DECLARE_FLEX_ARRAY(struct chcr_authenc_ctx, authenc);
        };
};

struct chcr_aead_ctx {
        __be32 key_ctx_hdr;
        unsigned int enckey_len;
        struct crypto_aead *sw_cipher;
        u8 salt[MAX_SALT];
        u8 key[CHCR_AES_MAX_KEY_LEN];
        u8 nonce[4];
        u16 hmac_ctrl;
        u16 mayverify;
        struct  __aead_ctx ctx[];
};

struct hmac_ctx {
        u8 ipad[CHCR_HASH_MAX_BLOCK_SIZE_128];
        u8 opad[CHCR_HASH_MAX_BLOCK_SIZE_128];
};

struct __crypto_ctx {
        union {
                struct hmac_ctx hmacctx;
                struct ablk_ctx ablkctx;
                struct chcr_aead_ctx aeadctx;
        };
};

struct chcr_context {
        struct chcr_dev *dev;
        unsigned char rxq_perchan;
        unsigned char txq_perchan;
        unsigned int  ntxq;
        unsigned int  nrxq;
        struct completion cbc_aes_aio_done;
        struct __crypto_ctx crypto_ctx[];
};

struct chcr_hctx_per_wr {
        struct scatterlist *srcsg;
        struct sk_buff *skb;
        dma_addr_t dma_addr;
        u32 dma_len;
        unsigned int src_ofst;
        unsigned int processed;
        u32 result;
        u8 is_sg_map;
        u8 imm;
        /*Final callback called. Driver cannot rely on nbytes to decide
         * final call
         */
        u8 isfinal;
};

struct chcr_ahash_req_ctx {
        struct chcr_hctx_per_wr hctx_wr;
        u8 *reqbfr;
        u8 *skbfr;
        /* SKB which is being sent to the hardware for processing */
        u64 data_len;  /* Data len till time */
        u16 txqidx;
        u16 rxqidx;
        u8 reqlen;
        u8 partial_hash[CHCR_HASH_MAX_DIGEST_SIZE];
        u8 bfr1[CHCR_HASH_MAX_BLOCK_SIZE_128];
        u8 bfr2[CHCR_HASH_MAX_BLOCK_SIZE_128];
};

struct chcr_skcipher_req_ctx {
        struct sk_buff *skb;
        struct scatterlist *dstsg;
        unsigned int processed;
        unsigned int last_req_len;
        unsigned int partial_req;
        struct scatterlist *srcsg;
        unsigned int src_ofst;
        unsigned int dst_ofst;
        unsigned int op;
        u16 imm;
        u8 iv[CHCR_MAX_CRYPTO_IV_LEN];
        u8 init_iv[CHCR_MAX_CRYPTO_IV_LEN];
        u16 txqidx;
        u16 rxqidx;
        struct skcipher_request fallback_req;   // keep at the end
};

struct chcr_alg_template {
        u32 type;
        u32 is_registered;
        union {
                struct skcipher_alg skcipher;
                struct ahash_alg hash;
                struct aead_alg aead;
        } alg;
};

typedef struct sk_buff *(*create_wr_t)(struct aead_request *req,
                                       unsigned short qid,
                                       int size);

void chcr_verify_tag(struct aead_request *req, u8 *input, int *err);
int chcr_aead_dma_map(struct device *dev, struct aead_request *req,
                      unsigned short op_type);
void chcr_aead_dma_unmap(struct device *dev, struct aead_request *req,
                         unsigned short op_type);
void chcr_add_aead_dst_ent(struct aead_request *req,
                           struct cpl_rx_phys_dsgl *phys_cpl,
                           unsigned short qid);
void chcr_add_aead_src_ent(struct aead_request *req, struct ulptx_sgl *ulptx);
void chcr_add_cipher_src_ent(struct skcipher_request *req,
                             void *ulptx,
                             struct  cipher_wr_param *wrparam);
int chcr_cipher_dma_map(struct device *dev, struct skcipher_request *req);
void chcr_cipher_dma_unmap(struct device *dev, struct skcipher_request *req);
void chcr_add_cipher_dst_ent(struct skcipher_request *req,
                             struct cpl_rx_phys_dsgl *phys_cpl,
                             struct  cipher_wr_param *wrparam,
                             unsigned short qid);
void chcr_add_hash_src_ent(struct ahash_request *req, struct ulptx_sgl *ulptx,
                           struct hash_wr_param *param);
int chcr_hash_dma_map(struct device *dev, struct ahash_request *req);
void chcr_hash_dma_unmap(struct device *dev, struct ahash_request *req);
void chcr_aead_common_exit(struct aead_request *req);
#endif /* __CHCR_CRYPTO_H__ */