1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * sun4i-ss-core.c - hardware cryptographic accelerator for Allwinner A20 SoC
5 * Copyright (C) 2013-2015 Corentin LABBE <clabbe.montjoie@gmail.com>
7 * Core file which registers crypto algorithms supported by the SS.
9 * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
11 #include <linux/clk.h>
12 #include <linux/crypto.h>
13 #include <linux/debugfs.h>
15 #include <linux/module.h>
17 #include <linux/platform_device.h>
18 #include <crypto/scatterwalk.h>
19 #include <linux/scatterlist.h>
20 #include <linux/interrupt.h>
21 #include <linux/delay.h>
22 #include <linux/reset.h>
26 static const struct ss_variant ss_a10_variant = {
30 static const struct ss_variant ss_a33_variant = {
34 static struct sun4i_ss_alg_template ss_algs[] = {
35 { .type = CRYPTO_ALG_TYPE_AHASH,
38 .init = sun4i_hash_init,
39 .update = sun4i_hash_update,
40 .final = sun4i_hash_final,
41 .finup = sun4i_hash_finup,
42 .digest = sun4i_hash_digest,
43 .export = sun4i_hash_export_md5,
44 .import = sun4i_hash_import_md5,
46 .digestsize = MD5_DIGEST_SIZE,
47 .statesize = sizeof(struct md5_state),
50 .cra_driver_name = "md5-sun4i-ss",
52 .cra_blocksize = MD5_HMAC_BLOCK_SIZE,
53 .cra_ctxsize = sizeof(struct sun4i_req_ctx),
54 .cra_module = THIS_MODULE,
55 .cra_init = sun4i_hash_crainit,
56 .cra_exit = sun4i_hash_craexit,
61 { .type = CRYPTO_ALG_TYPE_AHASH,
64 .init = sun4i_hash_init,
65 .update = sun4i_hash_update,
66 .final = sun4i_hash_final,
67 .finup = sun4i_hash_finup,
68 .digest = sun4i_hash_digest,
69 .export = sun4i_hash_export_sha1,
70 .import = sun4i_hash_import_sha1,
72 .digestsize = SHA1_DIGEST_SIZE,
73 .statesize = sizeof(struct sha1_state),
76 .cra_driver_name = "sha1-sun4i-ss",
78 .cra_blocksize = SHA1_BLOCK_SIZE,
79 .cra_ctxsize = sizeof(struct sun4i_req_ctx),
80 .cra_module = THIS_MODULE,
81 .cra_init = sun4i_hash_crainit,
82 .cra_exit = sun4i_hash_craexit,
87 { .type = CRYPTO_ALG_TYPE_SKCIPHER,
89 .setkey = sun4i_ss_aes_setkey,
90 .encrypt = sun4i_ss_cbc_aes_encrypt,
91 .decrypt = sun4i_ss_cbc_aes_decrypt,
92 .min_keysize = AES_MIN_KEY_SIZE,
93 .max_keysize = AES_MAX_KEY_SIZE,
94 .ivsize = AES_BLOCK_SIZE,
96 .cra_name = "cbc(aes)",
97 .cra_driver_name = "cbc-aes-sun4i-ss",
99 .cra_blocksize = AES_BLOCK_SIZE,
100 .cra_flags = CRYPTO_ALG_KERN_DRIVER_ONLY | CRYPTO_ALG_NEED_FALLBACK,
101 .cra_ctxsize = sizeof(struct sun4i_tfm_ctx),
102 .cra_module = THIS_MODULE,
104 .cra_init = sun4i_ss_cipher_init,
105 .cra_exit = sun4i_ss_cipher_exit,
109 { .type = CRYPTO_ALG_TYPE_SKCIPHER,
111 .setkey = sun4i_ss_aes_setkey,
112 .encrypt = sun4i_ss_ecb_aes_encrypt,
113 .decrypt = sun4i_ss_ecb_aes_decrypt,
114 .min_keysize = AES_MIN_KEY_SIZE,
115 .max_keysize = AES_MAX_KEY_SIZE,
117 .cra_name = "ecb(aes)",
118 .cra_driver_name = "ecb-aes-sun4i-ss",
120 .cra_blocksize = AES_BLOCK_SIZE,
121 .cra_flags = CRYPTO_ALG_KERN_DRIVER_ONLY | CRYPTO_ALG_NEED_FALLBACK,
122 .cra_ctxsize = sizeof(struct sun4i_tfm_ctx),
123 .cra_module = THIS_MODULE,
125 .cra_init = sun4i_ss_cipher_init,
126 .cra_exit = sun4i_ss_cipher_exit,
130 { .type = CRYPTO_ALG_TYPE_SKCIPHER,
132 .setkey = sun4i_ss_des_setkey,
133 .encrypt = sun4i_ss_cbc_des_encrypt,
134 .decrypt = sun4i_ss_cbc_des_decrypt,
135 .min_keysize = DES_KEY_SIZE,
136 .max_keysize = DES_KEY_SIZE,
137 .ivsize = DES_BLOCK_SIZE,
139 .cra_name = "cbc(des)",
140 .cra_driver_name = "cbc-des-sun4i-ss",
142 .cra_blocksize = DES_BLOCK_SIZE,
143 .cra_flags = CRYPTO_ALG_KERN_DRIVER_ONLY | CRYPTO_ALG_NEED_FALLBACK,
144 .cra_ctxsize = sizeof(struct sun4i_req_ctx),
145 .cra_module = THIS_MODULE,
147 .cra_init = sun4i_ss_cipher_init,
148 .cra_exit = sun4i_ss_cipher_exit,
152 { .type = CRYPTO_ALG_TYPE_SKCIPHER,
154 .setkey = sun4i_ss_des_setkey,
155 .encrypt = sun4i_ss_ecb_des_encrypt,
156 .decrypt = sun4i_ss_ecb_des_decrypt,
157 .min_keysize = DES_KEY_SIZE,
158 .max_keysize = DES_KEY_SIZE,
160 .cra_name = "ecb(des)",
161 .cra_driver_name = "ecb-des-sun4i-ss",
163 .cra_blocksize = DES_BLOCK_SIZE,
164 .cra_flags = CRYPTO_ALG_KERN_DRIVER_ONLY | CRYPTO_ALG_NEED_FALLBACK,
165 .cra_ctxsize = sizeof(struct sun4i_req_ctx),
166 .cra_module = THIS_MODULE,
168 .cra_init = sun4i_ss_cipher_init,
169 .cra_exit = sun4i_ss_cipher_exit,
173 { .type = CRYPTO_ALG_TYPE_SKCIPHER,
175 .setkey = sun4i_ss_des3_setkey,
176 .encrypt = sun4i_ss_cbc_des3_encrypt,
177 .decrypt = sun4i_ss_cbc_des3_decrypt,
178 .min_keysize = DES3_EDE_KEY_SIZE,
179 .max_keysize = DES3_EDE_KEY_SIZE,
180 .ivsize = DES3_EDE_BLOCK_SIZE,
182 .cra_name = "cbc(des3_ede)",
183 .cra_driver_name = "cbc-des3-sun4i-ss",
185 .cra_blocksize = DES3_EDE_BLOCK_SIZE,
186 .cra_flags = CRYPTO_ALG_KERN_DRIVER_ONLY | CRYPTO_ALG_NEED_FALLBACK,
187 .cra_ctxsize = sizeof(struct sun4i_req_ctx),
188 .cra_module = THIS_MODULE,
190 .cra_init = sun4i_ss_cipher_init,
191 .cra_exit = sun4i_ss_cipher_exit,
195 { .type = CRYPTO_ALG_TYPE_SKCIPHER,
197 .setkey = sun4i_ss_des3_setkey,
198 .encrypt = sun4i_ss_ecb_des3_encrypt,
199 .decrypt = sun4i_ss_ecb_des3_decrypt,
200 .min_keysize = DES3_EDE_KEY_SIZE,
201 .max_keysize = DES3_EDE_KEY_SIZE,
203 .cra_name = "ecb(des3_ede)",
204 .cra_driver_name = "ecb-des3-sun4i-ss",
206 .cra_blocksize = DES3_EDE_BLOCK_SIZE,
207 .cra_flags = CRYPTO_ALG_KERN_DRIVER_ONLY | CRYPTO_ALG_NEED_FALLBACK,
208 .cra_ctxsize = sizeof(struct sun4i_req_ctx),
209 .cra_module = THIS_MODULE,
211 .cra_init = sun4i_ss_cipher_init,
212 .cra_exit = sun4i_ss_cipher_exit,
216 #ifdef CONFIG_CRYPTO_DEV_SUN4I_SS_PRNG
218 .type = CRYPTO_ALG_TYPE_RNG,
221 .cra_name = "stdrng",
222 .cra_driver_name = "sun4i_ss_rng",
225 .cra_module = THIS_MODULE,
227 .generate = sun4i_ss_prng_generate,
228 .seed = sun4i_ss_prng_seed,
229 .seedsize = SS_SEED_LEN / BITS_PER_BYTE,
235 static int sun4i_ss_debugfs_show(struct seq_file *seq, void *v)
239 for (i = 0; i < ARRAY_SIZE(ss_algs); i++) {
242 switch (ss_algs[i].type) {
243 case CRYPTO_ALG_TYPE_SKCIPHER:
244 seq_printf(seq, "%s %s reqs=%lu opti=%lu fallback=%lu tsize=%lu\n",
245 ss_algs[i].alg.crypto.base.cra_driver_name,
246 ss_algs[i].alg.crypto.base.cra_name,
247 ss_algs[i].stat_req, ss_algs[i].stat_opti, ss_algs[i].stat_fb,
248 ss_algs[i].stat_bytes);
250 case CRYPTO_ALG_TYPE_RNG:
251 seq_printf(seq, "%s %s reqs=%lu tsize=%lu\n",
252 ss_algs[i].alg.rng.base.cra_driver_name,
253 ss_algs[i].alg.rng.base.cra_name,
254 ss_algs[i].stat_req, ss_algs[i].stat_bytes);
256 case CRYPTO_ALG_TYPE_AHASH:
257 seq_printf(seq, "%s %s reqs=%lu\n",
258 ss_algs[i].alg.hash.halg.base.cra_driver_name,
259 ss_algs[i].alg.hash.halg.base.cra_name,
260 ss_algs[i].stat_req);
266 DEFINE_SHOW_ATTRIBUTE(sun4i_ss_debugfs);
269 * Power management strategy: The device is suspended unless a TFM exists for
270 * one of the algorithms proposed by this driver.
272 static int sun4i_ss_pm_suspend(struct device *dev)
274 struct sun4i_ss_ctx *ss = dev_get_drvdata(dev);
276 reset_control_assert(ss->reset);
278 clk_disable_unprepare(ss->ssclk);
279 clk_disable_unprepare(ss->busclk);
283 static int sun4i_ss_pm_resume(struct device *dev)
285 struct sun4i_ss_ctx *ss = dev_get_drvdata(dev);
289 err = clk_prepare_enable(ss->busclk);
291 dev_err(ss->dev, "Cannot prepare_enable busclk\n");
295 err = clk_prepare_enable(ss->ssclk);
297 dev_err(ss->dev, "Cannot prepare_enable ssclk\n");
301 err = reset_control_deassert(ss->reset);
303 dev_err(ss->dev, "Cannot deassert reset control\n");
309 sun4i_ss_pm_suspend(dev);
313 static const struct dev_pm_ops sun4i_ss_pm_ops = {
314 SET_RUNTIME_PM_OPS(sun4i_ss_pm_suspend, sun4i_ss_pm_resume, NULL)
318 * When power management is enabled, this function enables the PM and set the
319 * device as suspended
320 * When power management is disabled, this function just enables the device
322 static int sun4i_ss_pm_init(struct sun4i_ss_ctx *ss)
326 pm_runtime_use_autosuspend(ss->dev);
327 pm_runtime_set_autosuspend_delay(ss->dev, 2000);
329 err = pm_runtime_set_suspended(ss->dev);
332 pm_runtime_enable(ss->dev);
336 static void sun4i_ss_pm_exit(struct sun4i_ss_ctx *ss)
338 pm_runtime_disable(ss->dev);
341 static int sun4i_ss_probe(struct platform_device *pdev)
346 const unsigned long cr_ahb = 24 * 1000 * 1000;
347 const unsigned long cr_mod = 150 * 1000 * 1000;
348 struct sun4i_ss_ctx *ss;
350 if (!pdev->dev.of_node)
353 ss = devm_kzalloc(&pdev->dev, sizeof(*ss), GFP_KERNEL);
357 ss->base = devm_platform_ioremap_resource(pdev, 0);
358 if (IS_ERR(ss->base)) {
359 dev_err(&pdev->dev, "Cannot request MMIO\n");
360 return PTR_ERR(ss->base);
363 ss->variant = of_device_get_match_data(&pdev->dev);
365 dev_err(&pdev->dev, "Missing Security System variant\n");
369 ss->ssclk = devm_clk_get(&pdev->dev, "mod");
370 if (IS_ERR(ss->ssclk)) {
371 err = PTR_ERR(ss->ssclk);
372 dev_err(&pdev->dev, "Cannot get SS clock err=%d\n", err);
375 dev_dbg(&pdev->dev, "clock ss acquired\n");
377 ss->busclk = devm_clk_get(&pdev->dev, "ahb");
378 if (IS_ERR(ss->busclk)) {
379 err = PTR_ERR(ss->busclk);
380 dev_err(&pdev->dev, "Cannot get AHB SS clock err=%d\n", err);
383 dev_dbg(&pdev->dev, "clock ahb_ss acquired\n");
385 ss->reset = devm_reset_control_get_optional(&pdev->dev, "ahb");
386 if (IS_ERR(ss->reset))
387 return PTR_ERR(ss->reset);
389 dev_info(&pdev->dev, "no reset control found\n");
392 * Check that clock have the correct rates given in the datasheet
393 * Try to set the clock to the maximum allowed
395 err = clk_set_rate(ss->ssclk, cr_mod);
397 dev_err(&pdev->dev, "Cannot set clock rate to ssclk\n");
402 * The only impact on clocks below requirement are bad performance,
403 * so do not print "errors"
404 * warn on Overclocked clocks
406 cr = clk_get_rate(ss->busclk);
408 dev_dbg(&pdev->dev, "Clock bus %lu (%lu MHz) (must be >= %lu)\n",
409 cr, cr / 1000000, cr_ahb);
411 dev_warn(&pdev->dev, "Clock bus %lu (%lu MHz) (must be >= %lu)\n",
412 cr, cr / 1000000, cr_ahb);
414 cr = clk_get_rate(ss->ssclk);
417 dev_warn(&pdev->dev, "Clock ss %lu (%lu MHz) (must be <= %lu)\n",
418 cr, cr / 1000000, cr_mod);
420 dev_dbg(&pdev->dev, "Clock ss %lu (%lu MHz) (must be <= %lu)\n",
421 cr, cr / 1000000, cr_mod);
423 dev_warn(&pdev->dev, "Clock ss is at %lu (%lu MHz) (must be <= %lu)\n",
424 cr, cr / 1000000, cr_mod);
426 ss->dev = &pdev->dev;
427 platform_set_drvdata(pdev, ss);
429 spin_lock_init(&ss->slock);
431 err = sun4i_ss_pm_init(ss);
436 * Datasheet named it "Die Bonding ID"
437 * I expect to be a sort of Security System Revision number.
438 * Since the A80 seems to have an other version of SS
439 * this info could be useful
442 err = pm_runtime_resume_and_get(ss->dev);
446 writel(SS_ENABLED, ss->base + SS_CTL);
447 v = readl(ss->base + SS_CTL);
450 dev_info(&pdev->dev, "Die ID %d\n", v);
451 writel(0, ss->base + SS_CTL);
453 pm_runtime_put_sync(ss->dev);
455 for (i = 0; i < ARRAY_SIZE(ss_algs); i++) {
457 switch (ss_algs[i].type) {
458 case CRYPTO_ALG_TYPE_SKCIPHER:
459 err = crypto_register_skcipher(&ss_algs[i].alg.crypto);
461 dev_err(ss->dev, "Fail to register %s\n",
462 ss_algs[i].alg.crypto.base.cra_name);
466 case CRYPTO_ALG_TYPE_AHASH:
467 err = crypto_register_ahash(&ss_algs[i].alg.hash);
469 dev_err(ss->dev, "Fail to register %s\n",
470 ss_algs[i].alg.hash.halg.base.cra_name);
474 case CRYPTO_ALG_TYPE_RNG:
475 err = crypto_register_rng(&ss_algs[i].alg.rng);
477 dev_err(ss->dev, "Fail to register %s\n",
478 ss_algs[i].alg.rng.base.cra_name);
484 /* Ignore error of debugfs */
485 ss->dbgfs_dir = debugfs_create_dir("sun4i-ss", NULL);
486 ss->dbgfs_stats = debugfs_create_file("stats", 0444, ss->dbgfs_dir, ss,
487 &sun4i_ss_debugfs_fops);
492 for (; i >= 0; i--) {
493 switch (ss_algs[i].type) {
494 case CRYPTO_ALG_TYPE_SKCIPHER:
495 crypto_unregister_skcipher(&ss_algs[i].alg.crypto);
497 case CRYPTO_ALG_TYPE_AHASH:
498 crypto_unregister_ahash(&ss_algs[i].alg.hash);
500 case CRYPTO_ALG_TYPE_RNG:
501 crypto_unregister_rng(&ss_algs[i].alg.rng);
506 sun4i_ss_pm_exit(ss);
510 static void sun4i_ss_remove(struct platform_device *pdev)
513 struct sun4i_ss_ctx *ss = platform_get_drvdata(pdev);
515 for (i = 0; i < ARRAY_SIZE(ss_algs); i++) {
516 switch (ss_algs[i].type) {
517 case CRYPTO_ALG_TYPE_SKCIPHER:
518 crypto_unregister_skcipher(&ss_algs[i].alg.crypto);
520 case CRYPTO_ALG_TYPE_AHASH:
521 crypto_unregister_ahash(&ss_algs[i].alg.hash);
523 case CRYPTO_ALG_TYPE_RNG:
524 crypto_unregister_rng(&ss_algs[i].alg.rng);
529 sun4i_ss_pm_exit(ss);
532 static const struct of_device_id a20ss_crypto_of_match_table[] = {
533 { .compatible = "allwinner,sun4i-a10-crypto",
534 .data = &ss_a10_variant
536 { .compatible = "allwinner,sun8i-a33-crypto",
537 .data = &ss_a33_variant
541 MODULE_DEVICE_TABLE(of, a20ss_crypto_of_match_table);
543 static struct platform_driver sun4i_ss_driver = {
544 .probe = sun4i_ss_probe,
545 .remove_new = sun4i_ss_remove,
548 .pm = &sun4i_ss_pm_ops,
549 .of_match_table = a20ss_crypto_of_match_table,
553 module_platform_driver(sun4i_ss_driver);
555 MODULE_ALIAS("platform:sun4i-ss");
556 MODULE_DESCRIPTION("Allwinner Security System cryptographic accelerator");
557 MODULE_LICENSE("GPL");
558 MODULE_AUTHOR("Corentin LABBE <clabbe.montjoie@gmail.com>");