/* SPDX-License-Identifier: GPL-2.0 */ /* * sl3516-ce.h - hardware cryptographic offloader for cortina/gemini SoC * * Copyright (C) 2021 Corentin LABBE <[email protected]> * * General notes on this driver: * Called either Crypto Acceleration Engine Module, Security Acceleration Engine * or IPSEC module in the datasheet, it will be called Crypto Engine for short * in this driver. * The CE was designed to handle IPSEC and wifi(TKIP WEP) protocol. * It can handle AES, DES, 3DES, MD5, WEP, TKIP, SHA1, HMAC(MD5), HMAC(SHA1), * Michael cipher/digest suites. * It acts the same as a network hw, with both RX and TX chained descriptors. */ #include <crypto/aes.h> #include <crypto/engine.h> #include <crypto/scatterwalk.h> #include <crypto/skcipher.h> #include <linux/debugfs.h> #include <linux/hw_random.h> #define TQ0_TYPE_DATA … #define TQ0_TYPE_CTRL … #define TQ1_CIPHER … #define TQ2_AUTH … #define TQ3_IV … #define TQ4_KEY0 … #define TQ5_KEY4 … #define TQ6_KEY6 … #define TQ7_AKEY0 … #define TQ8_AKEY2 … #define TQ9_AKEY2 … #define ECB_AES … #define DESC_LAST … #define DESC_FIRST … #define IPSEC_ID … #define IPSEC_STATUS_REG … #define IPSEC_RAND_NUM_REG … #define IPSEC_DMA_DEVICE_ID … #define IPSEC_DMA_STATUS … #define IPSEC_TXDMA_CTRL … #define IPSEC_TXDMA_FIRST_DESC … #define IPSEC_TXDMA_CURR_DESC … #define IPSEC_RXDMA_CTRL … #define IPSEC_RXDMA_FIRST_DESC … #define IPSEC_RXDMA_CURR_DESC … #define IPSEC_TXDMA_BUF_ADDR … #define IPSEC_RXDMA_BUF_ADDR … #define IPSEC_RXDMA_BUF_SIZE … #define CE_ENCRYPTION … #define CE_DECRYPTION … #define MAXDESC … #define DMA_STATUS_RS_EOFI … #define DMA_STATUS_RS_PERR … #define DMA_STATUS_RS_DERR … #define DMA_STATUS_TS_EOFI … #define DMA_STATUS_TS_PERR … #define DMA_STATUS_TS_DERR … #define TXDMA_CTRL_START … #define TXDMA_CTRL_CONTINUE … #define TXDMA_CTRL_CHAIN_MODE … /* the burst value is not documented in the datasheet */ #define TXDMA_CTRL_BURST_UNK … #define TXDMA_CTRL_INT_FAIL … #define TXDMA_CTRL_INT_PERR … #define RXDMA_CTRL_START … #define RXDMA_CTRL_CONTINUE … #define RXDMA_CTRL_CHAIN_MODE … /* the burst value is not documented in the datasheet */ #define RXDMA_CTRL_BURST_UNK … #define RXDMA_CTRL_INT_FINISH … #define RXDMA_CTRL_INT_FAIL … #define RXDMA_CTRL_INT_PERR … #define RXDMA_CTRL_INT_EOD … #define RXDMA_CTRL_INT_EOF … #define CE_CPU … #define CE_DMA … /* * struct sl3516_ce_descriptor - descriptor for CE operations * @frame_ctrl: Information for the current descriptor * @flag_status: For send packet, describe flag of operations. * @buf_adr: pointer to a send/recv buffer for data packet * @next_desc: control linking to other descriptors */ struct descriptor { … }; /* * struct control - The value of this register is used to set the * operation mode of the IPSec Module. * @process_id: Used to identify the process. The number will be copied * to the descriptor status of the received packet. * @auth_check_len: Number of 32-bit words to be checked or appended by the * authentication module * @auth_algorithm: * @auth_mode: 0:append 1:Check Authentication Result * @fcs_stream_copy: 0:enable 1:disable authentication stream copy * @mix_key_sel: 0:use rCipherKey0-3 1:use Key Mixer * @aesnk: AES Key Size * @cipher_algorithm: choice of CBC/ECE and AES/DES/3DES * @op_mode: Operation Mode for the IPSec Module */ struct pkt_control_header { … }; struct pkt_control_cipher { … }; /* * struct pkt_control_ecb - control packet for ECB */ struct pkt_control_ecb { … }; /* * struct sl3516_ce_dev - main container for all this driver information * @base: base address * @clks: clocks used * @reset: pointer to reset controller * @dev: the platform device * @engine: ptr to the crypto/crypto_engine * @complete: completion for the current task on this flow * @status: set to 1 by interrupt if task is done * @dtx: base DMA address for TX descriptors * @tx base address of TX descriptors * @drx: base DMA address for RX descriptors * @rx base address of RX descriptors * @ctx current used TX descriptor * @crx current used RX descriptor * @trng hw_random structure for RNG * @hwrng_stat_req number of HWRNG requests * @hwrng_stat_bytes total number of bytes generated by RNG * @stat_irq number of IRQ handled by CE * @stat_irq_tx number of TX IRQ handled by CE * @stat_irq_rx number of RX IRQ handled by CE * @stat_req number of requests handled by CE * @fallbak_sg_count_tx number of fallback due to destination SG count * @fallbak_sg_count_rx number of fallback due to source SG count * @fallbak_not_same_len number of fallback due to difference in SG length * @dbgfs_dir: Debugfs dentry for statistic directory * @dbgfs_stats: Debugfs dentry for statistic counters */ struct sl3516_ce_dev { … }; struct sginfo { … }; /* * struct sl3516_ce_cipher_req_ctx - context for a skcipher request * @t_src: list of mapped SGs with their size * @t_dst: list of mapped SGs with their size * @op_dir: direction (encrypt vs decrypt) for this request * @pctrllen: the length of the ctrl packet * @tqflag: the TQflag to set in data packet * @h pointer to the pkt_control_cipher header * @nr_sgs: number of source SG * @nr_sgd: number of destination SG * @fallback_req: request struct for invoking the fallback skcipher TFM */ struct sl3516_ce_cipher_req_ctx { … }; /* * struct sl3516_ce_cipher_tfm_ctx - context for a skcipher TFM * @key: pointer to key data * @keylen: len of the key * @ce: pointer to the private data of driver handling this TFM * @fallback_tfm: pointer to the fallback TFM */ struct sl3516_ce_cipher_tfm_ctx { … }; /* * struct sl3516_ce_alg_template - crypto_alg template * @type: the CRYPTO_ALG_TYPE for this template * @mode: value to be used in control packet for this algorithm * @ce: pointer to the sl3516_ce_dev structure associated with * this template * @alg: one of sub struct must be used * @stat_req: number of request done on this template * @stat_fb: number of request which has fallbacked * @stat_bytes: total data size done by this template */ struct sl3516_ce_alg_template { … }; int sl3516_ce_aes_setkey(struct crypto_skcipher *tfm, const u8 *key, unsigned int keylen); int sl3516_ce_cipher_init(struct crypto_tfm *tfm); void sl3516_ce_cipher_exit(struct crypto_tfm *tfm); int sl3516_ce_skdecrypt(struct skcipher_request *areq); int sl3516_ce_skencrypt(struct skcipher_request *areq); int sl3516_ce_run_task(struct sl3516_ce_dev *ce, struct sl3516_ce_cipher_req_ctx *rctx, const char *name); int sl3516_ce_rng_register(struct sl3516_ce_dev *ce); void sl3516_ce_rng_unregister(struct sl3516_ce_dev *ce); int sl3516_ce_handle_cipher_request(struct crypto_engine *engine, void *areq);