1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * sun8i-ce.h - hardware cryptographic offloader for 4 * Allwinner H3/A64/H5/H2+/H6 SoC 5 * 6 * Copyright (C) 2016-2019 Corentin LABBE <clabbe.montjoie@gmail.com> 7 */ 8 #include <crypto/aes.h> 9 #include <crypto/des.h> 10 #include <crypto/engine.h> 11 #include <crypto/skcipher.h> 12 #include <linux/atomic.h> 13 #include <linux/debugfs.h> 14 #include <linux/crypto.h> 15 #include <linux/hw_random.h> 16 #include <crypto/internal/hash.h> 17 #include <crypto/md5.h> 18 #include <crypto/rng.h> 19 #include <crypto/sha1.h> 20 #include <crypto/sha2.h> 21 22 /* CE Registers */ 23 #define CE_TDQ 0x00 24 #define CE_CTR 0x04 25 #define CE_ICR 0x08 26 #define CE_ISR 0x0C 27 #define CE_TLR 0x10 28 #define CE_TSR 0x14 29 #define CE_ESR 0x18 30 #define CE_CSSGR 0x1C 31 #define CE_CDSGR 0x20 32 #define CE_CSAR 0x24 33 #define CE_CDAR 0x28 34 #define CE_TPR 0x2C 35 36 /* Used in struct ce_task */ 37 /* ce_task common */ 38 #define CE_ENCRYPTION 0 39 #define CE_DECRYPTION BIT(8) 40 41 #define CE_COMM_INT BIT(31) 42 43 /* ce_task symmetric */ 44 #define CE_AES_128BITS 0 45 #define CE_AES_192BITS 1 46 #define CE_AES_256BITS 2 47 48 #define CE_OP_ECB 0 49 #define CE_OP_CBC (1 << 8) 50 51 #define CE_ALG_AES 0 52 #define CE_ALG_DES 1 53 #define CE_ALG_3DES 2 54 #define CE_ALG_MD5 16 55 #define CE_ALG_SHA1 17 56 #define CE_ALG_SHA224 18 57 #define CE_ALG_SHA256 19 58 #define CE_ALG_SHA384 20 59 #define CE_ALG_SHA512 21 60 #define CE_ALG_TRNG 48 61 #define CE_ALG_PRNG 49 62 #define CE_ALG_TRNG_V2 0x1c 63 #define CE_ALG_PRNG_V2 0x1d 64 65 /* Used in ce_variant */ 66 #define CE_ID_NOTSUPP 0xFF 67 68 #define CE_ID_CIPHER_AES 0 69 #define CE_ID_CIPHER_DES 1 70 #define CE_ID_CIPHER_DES3 2 71 #define CE_ID_CIPHER_MAX 3 72 73 #define CE_ID_HASH_MD5 0 74 #define CE_ID_HASH_SHA1 1 75 #define CE_ID_HASH_SHA224 2 76 #define CE_ID_HASH_SHA256 3 77 #define CE_ID_HASH_SHA384 4 78 #define CE_ID_HASH_SHA512 5 79 #define CE_ID_HASH_MAX 6 80 81 #define CE_ID_OP_ECB 0 82 #define CE_ID_OP_CBC 1 83 #define CE_ID_OP_MAX 2 84 85 /* Used in CE registers */ 86 #define CE_ERR_ALGO_NOTSUP BIT(0) 87 #define CE_ERR_DATALEN BIT(1) 88 #define CE_ERR_KEYSRAM BIT(2) 89 #define CE_ERR_ADDR_INVALID BIT(5) 90 #define CE_ERR_KEYLADDER BIT(6) 91 92 #define ESR_H3 0 93 #define ESR_A64 1 94 #define ESR_R40 2 95 #define ESR_H5 3 96 #define ESR_H6 4 97 #define ESR_D1 5 98 99 #define PRNG_DATA_SIZE (160 / 8) 100 #define PRNG_SEED_SIZE DIV_ROUND_UP(175, 8) 101 #define PRNG_LD BIT(17) 102 103 #define CE_DIE_ID_SHIFT 16 104 #define CE_DIE_ID_MASK 0x07 105 106 #define MAX_SG 8 107 108 #define CE_MAX_CLOCKS 4 109 110 #define MAXFLOW 4 111 112 /* 113 * struct ce_clock - Describe clocks used by sun8i-ce 114 * @name: Name of clock needed by this variant 115 * @freq: Frequency to set for each clock 116 * @max_freq: Maximum frequency for each clock (generally given by datasheet) 117 */ 118 struct ce_clock { 119 const char *name; 120 unsigned long freq; 121 unsigned long max_freq; 122 }; 123 124 /* 125 * struct ce_variant - Describe CE capability for each variant hardware 126 * @alg_cipher: list of supported ciphers. for each CE_ID_ this will give the 127 * coresponding CE_ALG_XXX value 128 * @alg_hash: list of supported hashes. for each CE_ID_ this will give the 129 * corresponding CE_ALG_XXX value 130 * @op_mode: list of supported block modes 131 * @cipher_t_dlen_in_bytes: Does the request size for cipher is in 132 * bytes or words 133 * @hash_t_dlen_in_bytes: Does the request size for hash is in 134 * bits or words 135 * @prng_t_dlen_in_bytes: Does the request size for PRNG is in 136 * bytes or words 137 * @trng_t_dlen_in_bytes: Does the request size for TRNG is in 138 * bytes or words 139 * @ce_clks: list of clocks needed by this variant 140 * @esr: The type of error register 141 * @prng: The CE_ALG_XXX value for the PRNG 142 * @trng: The CE_ALG_XXX value for the TRNG 143 */ 144 struct ce_variant { 145 char alg_cipher[CE_ID_CIPHER_MAX]; 146 char alg_hash[CE_ID_HASH_MAX]; 147 u32 op_mode[CE_ID_OP_MAX]; 148 bool cipher_t_dlen_in_bytes; 149 bool hash_t_dlen_in_bits; 150 bool prng_t_dlen_in_bytes; 151 bool trng_t_dlen_in_bytes; 152 bool needs_word_addresses; 153 struct ce_clock ce_clks[CE_MAX_CLOCKS]; 154 int esr; 155 unsigned char prng; 156 unsigned char trng; 157 }; 158 159 struct sginfo { 160 __le32 addr; 161 __le32 len; 162 } __packed; 163 164 /* 165 * struct ce_task - CE Task descriptor 166 * The structure of this descriptor could be found in the datasheet 167 */ 168 struct ce_task { 169 __le32 t_id; 170 __le32 t_common_ctl; 171 __le32 t_sym_ctl; 172 __le32 t_asym_ctl; 173 __le32 t_key; 174 __le32 t_iv; 175 __le32 t_ctr; 176 __le32 t_dlen; 177 struct sginfo t_src[MAX_SG]; 178 struct sginfo t_dst[MAX_SG]; 179 __le32 next; 180 __le32 reserved[3]; 181 } __packed __aligned(8); 182 183 /* 184 * struct sun8i_ce_flow - Information used by each flow 185 * @engine: ptr to the crypto_engine for this flow 186 * @complete: completion for the current task on this flow 187 * @status: set to 1 by interrupt if task is done 188 * @t_phy: Physical address of task 189 * @tl: pointer to the current ce_task for this flow 190 * @backup_iv: buffer which contain the next IV to store 191 * @bounce_iv: buffer which contain the IV 192 * @stat_req: number of request done by this flow 193 */ 194 struct sun8i_ce_flow { 195 struct crypto_engine *engine; 196 struct completion complete; 197 int status; 198 dma_addr_t t_phy; 199 int timeout; 200 struct ce_task *tl; 201 void *backup_iv; 202 void *bounce_iv; 203 #ifdef CONFIG_CRYPTO_DEV_SUN8I_CE_DEBUG 204 unsigned long stat_req; 205 #endif 206 }; 207 208 /* 209 * struct sun8i_ce_dev - main container for all this driver information 210 * @base: base address of CE 211 * @ceclks: clocks used by CE 212 * @reset: pointer to reset controller 213 * @dev: the platform device 214 * @mlock: Control access to device registers 215 * @rnglock: Control access to the RNG (dedicated channel 3) 216 * @chanlist: array of all flow 217 * @flow: flow to use in next request 218 * @variant: pointer to variant specific data 219 * @dbgfs_dir: Debugfs dentry for statistic directory 220 * @dbgfs_stats: Debugfs dentry for statistic counters 221 */ 222 struct sun8i_ce_dev { 223 void __iomem *base; 224 struct clk *ceclks[CE_MAX_CLOCKS]; 225 struct reset_control *reset; 226 struct device *dev; 227 struct mutex mlock; 228 struct mutex rnglock; 229 struct sun8i_ce_flow *chanlist; 230 atomic_t flow; 231 const struct ce_variant *variant; 232 #ifdef CONFIG_CRYPTO_DEV_SUN8I_CE_DEBUG 233 struct dentry *dbgfs_dir; 234 struct dentry *dbgfs_stats; 235 #endif 236 #ifdef CONFIG_CRYPTO_DEV_SUN8I_CE_TRNG 237 struct hwrng trng; 238 #ifdef CONFIG_CRYPTO_DEV_SUN8I_CE_DEBUG 239 unsigned long hwrng_stat_req; 240 unsigned long hwrng_stat_bytes; 241 #endif 242 #endif 243 }; 244 desc_addr_val(struct sun8i_ce_dev * dev,dma_addr_t addr)245 static inline u32 desc_addr_val(struct sun8i_ce_dev *dev, dma_addr_t addr) 246 { 247 if (dev->variant->needs_word_addresses) 248 return addr / 4; 249 250 return addr; 251 } 252 desc_addr_val_le32(struct sun8i_ce_dev * dev,dma_addr_t addr)253 static inline __le32 desc_addr_val_le32(struct sun8i_ce_dev *dev, 254 dma_addr_t addr) 255 { 256 return cpu_to_le32(desc_addr_val(dev, addr)); 257 } 258 259 /* 260 * struct sun8i_cipher_req_ctx - context for a skcipher request 261 * @op_dir: direction (encrypt vs decrypt) for this request 262 * @flow: the flow to use for this request 263 * @ivlen: size of bounce_iv 264 * @nr_sgs: The number of source SG (as given by dma_map_sg()) 265 * @nr_sgd: The number of destination SG (as given by dma_map_sg()) 266 * @addr_iv: The IV addr returned by dma_map_single, need to unmap later 267 * @addr_key: The key addr returned by dma_map_single, need to unmap later 268 * @fallback_req: request struct for invoking the fallback skcipher TFM 269 */ 270 struct sun8i_cipher_req_ctx { 271 u32 op_dir; 272 int flow; 273 unsigned int ivlen; 274 int nr_sgs; 275 int nr_sgd; 276 dma_addr_t addr_iv; 277 dma_addr_t addr_key; 278 struct skcipher_request fallback_req; // keep at the end 279 }; 280 281 /* 282 * struct sun8i_cipher_tfm_ctx - context for a skcipher TFM 283 * @key: pointer to key data 284 * @keylen: len of the key 285 * @ce: pointer to the private data of driver handling this TFM 286 * @fallback_tfm: pointer to the fallback TFM 287 */ 288 struct sun8i_cipher_tfm_ctx { 289 u32 *key; 290 u32 keylen; 291 struct sun8i_ce_dev *ce; 292 struct crypto_skcipher *fallback_tfm; 293 }; 294 295 /* 296 * struct sun8i_ce_hash_tfm_ctx - context for an ahash TFM 297 * @ce: pointer to the private data of driver handling this TFM 298 * @fallback_tfm: pointer to the fallback TFM 299 */ 300 struct sun8i_ce_hash_tfm_ctx { 301 struct sun8i_ce_dev *ce; 302 struct crypto_ahash *fallback_tfm; 303 }; 304 305 /* 306 * struct sun8i_ce_hash_reqctx - context for an ahash request 307 * @fallback_req: pre-allocated fallback request 308 * @flow: the flow to use for this request 309 */ 310 struct sun8i_ce_hash_reqctx { 311 struct ahash_request fallback_req; 312 int flow; 313 }; 314 315 /* 316 * struct sun8i_ce_prng_ctx - context for PRNG TFM 317 * @seed: The seed to use 318 * @slen: The size of the seed 319 */ 320 struct sun8i_ce_rng_tfm_ctx { 321 void *seed; 322 unsigned int slen; 323 }; 324 325 /* 326 * struct sun8i_ce_alg_template - crypto_alg template 327 * @type: the CRYPTO_ALG_TYPE for this template 328 * @ce_algo_id: the CE_ID for this template 329 * @ce_blockmode: the type of block operation CE_ID 330 * @ce: pointer to the sun8i_ce_dev structure associated with 331 * this template 332 * @alg: one of sub struct must be used 333 * @stat_req: number of request done on this template 334 * @stat_fb: number of request which has fallbacked 335 * @stat_bytes: total data size done by this template 336 */ 337 struct sun8i_ce_alg_template { 338 u32 type; 339 u32 ce_algo_id; 340 u32 ce_blockmode; 341 struct sun8i_ce_dev *ce; 342 union { 343 struct skcipher_engine_alg skcipher; 344 struct ahash_engine_alg hash; 345 struct rng_alg rng; 346 } alg; 347 unsigned long stat_req; 348 unsigned long stat_fb; 349 unsigned long stat_bytes; 350 unsigned long stat_fb_maxsg; 351 unsigned long stat_fb_leniv; 352 unsigned long stat_fb_len0; 353 unsigned long stat_fb_mod16; 354 unsigned long stat_fb_srcali; 355 unsigned long stat_fb_srclen; 356 unsigned long stat_fb_dstali; 357 unsigned long stat_fb_dstlen; 358 char fbname[CRYPTO_MAX_ALG_NAME]; 359 }; 360 361 int sun8i_ce_aes_setkey(struct crypto_skcipher *tfm, const u8 *key, 362 unsigned int keylen); 363 int sun8i_ce_des3_setkey(struct crypto_skcipher *tfm, const u8 *key, 364 unsigned int keylen); 365 int sun8i_ce_cipher_init(struct crypto_tfm *tfm); 366 void sun8i_ce_cipher_exit(struct crypto_tfm *tfm); 367 int sun8i_ce_cipher_do_one(struct crypto_engine *engine, void *areq); 368 int sun8i_ce_skdecrypt(struct skcipher_request *areq); 369 int sun8i_ce_skencrypt(struct skcipher_request *areq); 370 371 int sun8i_ce_get_engine_number(struct sun8i_ce_dev *ce); 372 373 int sun8i_ce_run_task(struct sun8i_ce_dev *ce, int flow, const char *name); 374 375 int sun8i_ce_hash_init_tfm(struct crypto_ahash *tfm); 376 void sun8i_ce_hash_exit_tfm(struct crypto_ahash *tfm); 377 int sun8i_ce_hash_init(struct ahash_request *areq); 378 int sun8i_ce_hash_export(struct ahash_request *areq, void *out); 379 int sun8i_ce_hash_import(struct ahash_request *areq, const void *in); 380 int sun8i_ce_hash_final(struct ahash_request *areq); 381 int sun8i_ce_hash_update(struct ahash_request *areq); 382 int sun8i_ce_hash_finup(struct ahash_request *areq); 383 int sun8i_ce_hash_digest(struct ahash_request *areq); 384 int sun8i_ce_hash_run(struct crypto_engine *engine, void *breq); 385 386 int sun8i_ce_prng_generate(struct crypto_rng *tfm, const u8 *src, 387 unsigned int slen, u8 *dst, unsigned int dlen); 388 int sun8i_ce_prng_seed(struct crypto_rng *tfm, const u8 *seed, unsigned int slen); 389 void sun8i_ce_prng_exit(struct crypto_tfm *tfm); 390 int sun8i_ce_prng_init(struct crypto_tfm *tfm); 391 392 int sun8i_ce_hwrng_register(struct sun8i_ce_dev *ce); 393 void sun8i_ce_hwrng_unregister(struct sun8i_ce_dev *ce); 394