10888d04bSAndre Przywara // SPDX-License-Identifier: GPL-2.0 20888d04bSAndre Przywara /* 30888d04bSAndre Przywara * Randomness driver for the ARM SMCCC TRNG Firmware Interface 40888d04bSAndre Przywara * https://developer.arm.com/documentation/den0098/latest/ 50888d04bSAndre Przywara * 60888d04bSAndre Przywara * Copyright (C) 2020 Arm Ltd. 70888d04bSAndre Przywara * 80888d04bSAndre Przywara * The ARM TRNG firmware interface specifies a protocol to read entropy 90888d04bSAndre Przywara * from a higher exception level, to abstract from any machine specific 100888d04bSAndre Przywara * implemenations and allow easier use in hypervisors. 110888d04bSAndre Przywara * 120888d04bSAndre Przywara * The firmware interface is realised using the SMCCC specification. 130888d04bSAndre Przywara */ 140888d04bSAndre Przywara 150888d04bSAndre Przywara #include <linux/bits.h> 160888d04bSAndre Przywara #include <linux/device.h> 170888d04bSAndre Przywara #include <linux/hw_random.h> 180888d04bSAndre Przywara #include <linux/module.h> 190888d04bSAndre Przywara #include <linux/platform_device.h> 200888d04bSAndre Przywara #include <linux/arm-smccc.h> 210888d04bSAndre Przywara 220888d04bSAndre Przywara #ifdef CONFIG_ARM64 230888d04bSAndre Przywara #define ARM_SMCCC_TRNG_RND ARM_SMCCC_TRNG_RND64 240888d04bSAndre Przywara #define MAX_BITS_PER_CALL (3 * 64UL) 250888d04bSAndre Przywara #else 260888d04bSAndre Przywara #define ARM_SMCCC_TRNG_RND ARM_SMCCC_TRNG_RND32 270888d04bSAndre Przywara #define MAX_BITS_PER_CALL (3 * 32UL) 280888d04bSAndre Przywara #endif 290888d04bSAndre Przywara 300888d04bSAndre Przywara /* We don't want to allow the firmware to stall us forever. */ 310888d04bSAndre Przywara #define SMCCC_TRNG_MAX_TRIES 20 320888d04bSAndre Przywara 330888d04bSAndre Przywara #define SMCCC_RET_TRNG_INVALID_PARAMETER -2 340888d04bSAndre Przywara #define SMCCC_RET_TRNG_NO_ENTROPY -3 350888d04bSAndre Przywara 360888d04bSAndre Przywara static int copy_from_registers(char *buf, struct arm_smccc_res *res, 370888d04bSAndre Przywara size_t bytes) 380888d04bSAndre Przywara { 390888d04bSAndre Przywara unsigned int chunk, copied; 400888d04bSAndre Przywara 410888d04bSAndre Przywara if (bytes == 0) 420888d04bSAndre Przywara return 0; 430888d04bSAndre Przywara 440888d04bSAndre Przywara chunk = min(bytes, sizeof(long)); 450888d04bSAndre Przywara memcpy(buf, &res->a3, chunk); 460888d04bSAndre Przywara copied = chunk; 470888d04bSAndre Przywara if (copied >= bytes) 480888d04bSAndre Przywara return copied; 490888d04bSAndre Przywara 500888d04bSAndre Przywara chunk = min((bytes - copied), sizeof(long)); 510888d04bSAndre Przywara memcpy(&buf[copied], &res->a2, chunk); 520888d04bSAndre Przywara copied += chunk; 530888d04bSAndre Przywara if (copied >= bytes) 540888d04bSAndre Przywara return copied; 550888d04bSAndre Przywara 560888d04bSAndre Przywara chunk = min((bytes - copied), sizeof(long)); 570888d04bSAndre Przywara memcpy(&buf[copied], &res->a1, chunk); 580888d04bSAndre Przywara 590888d04bSAndre Przywara return copied + chunk; 600888d04bSAndre Przywara } 610888d04bSAndre Przywara 620888d04bSAndre Przywara static int smccc_trng_read(struct hwrng *rng, void *data, size_t max, bool wait) 630888d04bSAndre Przywara { 640888d04bSAndre Przywara struct arm_smccc_res res; 650888d04bSAndre Przywara u8 *buf = data; 660888d04bSAndre Przywara unsigned int copied = 0; 670888d04bSAndre Przywara int tries = 0; 680888d04bSAndre Przywara 690888d04bSAndre Przywara while (copied < max) { 700888d04bSAndre Przywara size_t bits = min_t(size_t, (max - copied) * BITS_PER_BYTE, 710888d04bSAndre Przywara MAX_BITS_PER_CALL); 720888d04bSAndre Przywara 730888d04bSAndre Przywara arm_smccc_1_1_invoke(ARM_SMCCC_TRNG_RND, bits, &res); 740888d04bSAndre Przywara 750888d04bSAndre Przywara switch ((int)res.a0) { 760888d04bSAndre Przywara case SMCCC_RET_SUCCESS: 770888d04bSAndre Przywara copied += copy_from_registers(buf + copied, &res, 780888d04bSAndre Przywara bits / BITS_PER_BYTE); 790888d04bSAndre Przywara tries = 0; 800888d04bSAndre Przywara break; 810888d04bSAndre Przywara case SMCCC_RET_TRNG_NO_ENTROPY: 820888d04bSAndre Przywara if (!wait) 830888d04bSAndre Przywara return copied; 840888d04bSAndre Przywara tries++; 850888d04bSAndre Przywara if (tries >= SMCCC_TRNG_MAX_TRIES) 860888d04bSAndre Przywara return copied; 870888d04bSAndre Przywara cond_resched(); 880888d04bSAndre Przywara break; 89042b4b16SJames Cowgill default: 90042b4b16SJames Cowgill return -EIO; 910888d04bSAndre Przywara } 920888d04bSAndre Przywara } 930888d04bSAndre Przywara 940888d04bSAndre Przywara return copied; 950888d04bSAndre Przywara } 960888d04bSAndre Przywara 970888d04bSAndre Przywara static int smccc_trng_probe(struct platform_device *pdev) 980888d04bSAndre Przywara { 990888d04bSAndre Przywara struct hwrng *trng; 1000888d04bSAndre Przywara 1010888d04bSAndre Przywara trng = devm_kzalloc(&pdev->dev, sizeof(*trng), GFP_KERNEL); 1020888d04bSAndre Przywara if (!trng) 1030888d04bSAndre Przywara return -ENOMEM; 1040888d04bSAndre Przywara 1050888d04bSAndre Przywara trng->name = "smccc_trng"; 1060888d04bSAndre Przywara trng->read = smccc_trng_read; 1070888d04bSAndre Przywara 1080888d04bSAndre Przywara return devm_hwrng_register(&pdev->dev, trng); 1090888d04bSAndre Przywara } 1100888d04bSAndre Przywara 1110888d04bSAndre Przywara static struct platform_driver smccc_trng_driver = { 1120888d04bSAndre Przywara .driver = { 1130888d04bSAndre Przywara .name = "smccc_trng", 1140888d04bSAndre Przywara }, 1150888d04bSAndre Przywara .probe = smccc_trng_probe, 1160888d04bSAndre Przywara }; 1170888d04bSAndre Przywara module_platform_driver(smccc_trng_driver); 1180888d04bSAndre Przywara 1190888d04bSAndre Przywara MODULE_ALIAS("platform:smccc_trng"); 1200888d04bSAndre Przywara MODULE_AUTHOR("Andre Przywara"); 121*691eaf1dSJeff Johnson MODULE_DESCRIPTION("Arm SMCCC TRNG firmware interface support"); 1220888d04bSAndre Przywara MODULE_LICENSE("GPL"); 123