drivers/staging/ccree/ssi_driver.h

   1 /*
   2  * Copyright (C) 2012-2017 ARM Limited or its affiliates.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 /* \file ssi_driver.h
  18  * ARM CryptoCell Linux Crypto Driver
  19  */
  20
  21 #ifndef __SSI_DRIVER_H__
  22 #define __SSI_DRIVER_H__
  23
  24 #include "ssi_config.h"
  25 #ifdef COMP_IN_WQ
  26 #include <linux/workqueue.h>
  27 #else
  28 #include <linux/interrupt.h>
  29 #endif
  30 #include <linux/dma-mapping.h>
  31 #include <crypto/algapi.h>
  32 #include <crypto/internal/skcipher.h>
  33 #include <crypto/aes.h>
  34 #include <crypto/sha.h>
  35 #include <crypto/aead.h>
  36 #include <crypto/authenc.h>
  37 #include <crypto/hash.h>
  38 #include <linux/version.h>
  39 #include <linux/clk.h>
  40
  41 /* Registers definitions from shared/hw/ree_include */
  42 #include "dx_reg_base_host.h"
  43 #include "dx_host.h"
  44 #include "cc_regs.h"
  45 #include "dx_reg_common.h"
  46 #include "cc_hal.h"
  47 #define CC_SUPPORT_SHA DX_DEV_SHA_MAX
  48 #include "cc_crypto_ctx.h"
  49 #include "ssi_sysfs.h"
  50 #include "hash_defs.h"
  51 #include "ssi_fips_local.h"
  52 #include "cc_hw_queue_defs.h"
  53 #include "ssi_sram_mgr.h"
  54
  55 #define DRV_MODULE_VERSION "3.0"
  56
  57 #define SSI_DEV_NAME_STR "cc715ree"
  58 #define SSI_CC_HAS_AES_CCM 1
  59 #define SSI_CC_HAS_AES_GCM 1
  60 #define SSI_CC_HAS_AES_XTS 1
  61 #define SSI_CC_HAS_AES_ESSIV 1
  62 #define SSI_CC_HAS_AES_BITLOCKER 1
  63 #define SSI_CC_HAS_AES_CTS 1
  64 #define SSI_CC_HAS_MULTI2 0
  65 #define SSI_CC_HAS_CMAC 1
  66
  67 #define SSI_AXI_IRQ_MASK ((1 << DX_AXIM_CFG_BRESPMASK_BIT_SHIFT) | (1 << DX_AXIM_CFG_RRESPMASK_BIT_SHIFT) |     \
  68                         (1 << DX_AXIM_CFG_INFLTMASK_BIT_SHIFT) | (1 << DX_AXIM_CFG_COMPMASK_BIT_SHIFT))
  69
  70 #define SSI_AXI_ERR_IRQ_MASK (1 << DX_HOST_IRR_AXI_ERR_INT_BIT_SHIFT)
  71
  72 #define SSI_COMP_IRQ_MASK (1 << DX_HOST_IRR_AXIM_COMP_INT_BIT_SHIFT)
  73
  74 /* TEE FIPS status interrupt */
  75 #define SSI_GPR0_IRQ_MASK (1 << DX_HOST_IRR_GPR0_BIT_SHIFT)
  76
  77 #define SSI_CRA_PRIO 3000
  78
  79 #define MIN_HW_QUEUE_SIZE 50 /* Minimum size required for proper function */
  80
  81 #define MAX_REQUEST_QUEUE_SIZE 4096
  82 #define MAX_MLLI_BUFF_SIZE 2080
  83 #define MAX_ICV_NENTS_SUPPORTED 2
  84
  85 /* Definitions for HW descriptors DIN/DOUT fields */
  86 #define NS_BIT 1
  87 #define AXI_ID 0
  88 /* AXI_ID is not actually the AXI ID of the transaction but the value of AXI_ID
  89  * field in the HW descriptor. The DMA engine +8 that value.
  90  */
  91
  92 /* Logging macros */
  93 #define SSI_LOG(level, format, ...) \
  94         printk(level "cc715ree::%s: " format , __func__, ##__VA_ARGS__)
  95 #define SSI_LOG_ERR(format, ...) SSI_LOG(KERN_ERR, format, ##__VA_ARGS__)
  96 #define SSI_LOG_WARNING(format, ...) SSI_LOG(KERN_WARNING, format, ##__VA_ARGS__)
  97 #define SSI_LOG_NOTICE(format, ...) SSI_LOG(KERN_NOTICE, format, ##__VA_ARGS__)
  98 #define SSI_LOG_INFO(format, ...) SSI_LOG(KERN_INFO, format, ##__VA_ARGS__)
  99 #ifdef CC_DEBUG
 100 #define SSI_LOG_DEBUG(format, ...) SSI_LOG(KERN_DEBUG, format, ##__VA_ARGS__)
 101 #else /* Debug log messages are removed at compile time for non-DEBUG config. */
 102 #define SSI_LOG_DEBUG(format, ...) do {} while (0)
 103 #endif
 104
 105 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
 106 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
 107
 108 #define SSI_MAX_IVGEN_DMA_ADDRESSES     3
 109 struct ssi_crypto_req {
 110         void (*user_cb)(struct device *dev, void *req, void __iomem *cc_base);
 111         void *user_arg;
 112         dma_addr_t ivgen_dma_addr[SSI_MAX_IVGEN_DMA_ADDRESSES];
 113         /* For the first 'ivgen_dma_addr_len' addresses of this array,
 114          * generated IV would be placed in it by send_request().
 115          * Same generated IV for all addresses!
 116          */
 117         unsigned int ivgen_dma_addr_len; /* Amount of 'ivgen_dma_addr' elements to be filled. */
 118         unsigned int ivgen_size; /* The generated IV size required, 8/16 B allowed. */
 119         struct completion seq_compl; /* request completion */
 120 };
 121
 122 /**
 123  * struct ssi_drvdata - driver private data context
 124  * @cc_base:    virt address of the CC registers
 125  * @irq:        device IRQ number
 126  * @irq_mask:   Interrupt mask shadow (1 for masked interrupts)
 127  * @fw_ver:     SeP loaded firmware version
 128  */
 129 struct ssi_drvdata {
 130         struct resource *res_mem;
 131         struct resource *res_irq;
 132         void __iomem *cc_base;
 133         unsigned int irq;
 134         u32 irq_mask;
 135         u32 fw_ver;
 136         /* Calibration time of start/stop
 137          * monitor descriptors
 138          */
 139         u32 monitor_null_cycles;
 140         struct platform_device *plat_dev;
 141         ssi_sram_addr_t mlli_sram_addr;
 142         struct completion icache_setup_completion;
 143         void *buff_mgr_handle;
 144         void *hash_handle;
 145         void *aead_handle;
 146         void *blkcipher_handle;
 147         void *request_mgr_handle;
 148         void *fips_handle;
 149         void *ivgen_handle;
 150         void *sram_mgr_handle;
 151         u32 inflight_counter;
 152         struct clk *clk;
 153 };
 154
 155 struct ssi_crypto_alg {
 156         struct list_head entry;
 157         int cipher_mode;
 158         int flow_mode; /* Note: currently, refers to the cipher mode only. */
 159         int auth_mode;
 160         struct ssi_drvdata *drvdata;
 161         struct crypto_alg crypto_alg;
 162         struct aead_alg aead_alg;
 163 };
 164
 165 struct ssi_alg_template {
 166         char name[CRYPTO_MAX_ALG_NAME];
 167         char driver_name[CRYPTO_MAX_ALG_NAME];
 168         unsigned int blocksize;
 169         u32 type;
 170         union {
 171                 struct ablkcipher_alg ablkcipher;
 172                 struct aead_alg aead;
 173                 struct blkcipher_alg blkcipher;
 174                 struct cipher_alg cipher;
 175                 struct compress_alg compress;
 176         } template_u;
 177         int cipher_mode;
 178         int flow_mode; /* Note: currently, refers to the cipher mode only. */
 179         int auth_mode;
 180         struct ssi_drvdata *drvdata;
 181 };
 182
 183 struct async_gen_req_ctx {
 184         dma_addr_t iv_dma_addr;
 185         enum drv_crypto_direction op_type;
 186 };
 187
 188 #ifdef DX_DUMP_BYTES
 189 void dump_byte_array(const char *name, const u8 *the_array, unsigned long size);
 190 #else
 191 #define dump_byte_array(name, array, size) do { \
 192 } while (0);
 193 #endif
 194
 195 int init_cc_regs(struct ssi_drvdata *drvdata, bool is_probe);
 196 void fini_cc_regs(struct ssi_drvdata *drvdata);
 197 int cc_clk_on(struct ssi_drvdata *drvdata);
 198 void cc_clk_off(struct ssi_drvdata *drvdata);
 199
 200 #endif /*__SSI_DRIVER_H__*/
 201