Received-SPF: pass (google.com: domain of linux-crypto-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   meenakshi.aggarwal@nxp.com
To:     horia.geanta@nxp.com, V.sethi@nxp.com, pankaj.gupta@nxp.com,
        gaurav.jain@nxp.com, herbert@gondor.apana.org.au,
        davem@davemloft.net, linux-crypto@vger.kernel.org,
        linux-kernel@vger.kernel.org
Cc:     "Victoria Milhoan (b42089)" <vicki.milhoan@freescale.com>,
        Dan Douglass <dan.douglass@nxp.com>,
        Vipul Kumar <vipul_kumar@mentor.com>,
        Meenakshi Aggarwal <meenakshi.aggarwal@nxp.com>
Subject: [PATCH] crypto: caam - add a test for the RNG
Date:   Mon, 12 Jun 2023 10:28:42 +0200
Message-Id: <20230612082842.1256507-1-meenakshi.aggarwal@nxp.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?dmNVYWtkQVhaWXBzTnAySEE1UmVXWEtPejNJR1I4dVlyc0ZHQ2F3NGJ4Zlhy?=
 =?utf-8?B?ekdRcnpaeXM3eGd1S0x4ZHM2TmttVU45ajJZTFZ2RjFVdExSTmgzRitZNWZm?=
 =?utf-8?B?czQxOWFhQmNIdEI0RmF6cXVmcTBMUTArbkJnTjgzVHhMdTlrSVlublZ2VHRY?=
 =?utf-8?B?ejZkRWVzdGgvT0NuRHJIYytyRG9Yd2QvYnpVK1ZVS1AyODk2d1NYK1hnVU5n?=
 =?utf-8?B?TDByNjlOWmtUL25wTGluQ1BtMTc0QWdML3Iwak1QNGh3OGxCNkJNcC82a1pz?=
 =?utf-8?B?VlVzcnBmNG82L25CTW8xQU05UXZMOTZPRTloSUZkQytFdXY2d3ZGbzViYXdM?=
 =?utf-8?B?TC91RVBOU1Badm1YUTFYMUh6aEpiV01TdlJSeERzREhvbEFqYkhYLzhCL1Ju?=
 =?utf-8?B?UXFia1JLU1cySkdIbU0yeWFxMWZmNjcxNjJ0Vk1oNTNZSWhnS0ozMG53ZHdv?=
 =?utf-8?B?OElDNTV3cGF4ZDBHMDlIU3AyWnFpNjQ1Sjllc1JoSFpJQ2l6anF0WW5hSUF2?=
 =?utf-8?B?RFVuMTJCM2tyVEN4TGNQUDdGb1Myb1JNVFB4RVhrK09WZGxNVktqVldHYkth?=
 =?utf-8?B?WjdiVkxrU0ZLajFLVDdCREZWbWZvNjZST1FSYkd6WWFBL2JNNHZ0eWJOQmJ2?=
 =?utf-8?B?VE40TmU5VEN4MUpZR05FT3pjd2RMOExlaEpURVBrdTVxellKeTBWVjlkQ3VY?=
 =?utf-8?B?ZzNwVW9JbUV5czRaaW05bGQvRTRrNUdRUUdETTU2dVluOU81azViaUNYS0w1?=
 =?utf-8?B?eGV4NkJicHhqMVdxTEVpM1JjTjI5Q0QzTmxOTWtGcVZ2MExuSmVoT1BQM1VD?=
 =?utf-8?B?b3V1VUd2ekcwMEJKeFN0cmd6cUlRVG9XM2NJelFYNWlESjBUOUpTTHJmOVhs?=
 =?utf-8?B?UWpOSmlFbFBWRkIyYVJPTWVpeXd0dER6OXlIYnRWL0h1TUQxQVlLbXBnUFF0?=
 =?utf-8?B?Vk5QOWIxNDRxbGRGaWFwMTVOQTB6b0l2VWgxYy96S0pyMW5tR3YxRDFsSHNt?=
 =?utf-8?B?SjhpdEd5YjIyR1dadU90SE1KakE2SXpZajJhVmlXMkovV0FLNXl2N0NJOWxU?=
 =?utf-8?B?S0Z4aVVxTVdUSFNGQnNhaWFSMHhuckN0NW5rNzRUNmR1WVdMZndidGxFQUlQ?=
 =?utf-8?B?clVpQ1J0T20wNzZtZ2xKQ3VyWm13dTljem5sSHpHR1hBajRWeEhCTlkyYjBp?=
 =?utf-8?B?WkJVemhGTlo4SmQrZ0syTkJHSWhENWJIWmlMKzg2clYxTlNremphNERnMEpk?=
 =?utf-8?B?T2ZJVG5GUW9uY1p4YkNDZ0pIZmh0dEd0ZkczcW1GUDY3MGxGWmIrVlkrMEZp?=
 =?utf-8?B?SEwzZGdzS2xyRytLQXdGM1JCcHNBVVRTYWo3V01MZEk5cFVVQzFsVXVxdHRG?=
 =?utf-8?B?Z1p2V2Y1eHhELzVVa01tdUxNbzA3bjJWdElwZW9ybDN2cUF5S0tXQ0p4cmZH?=
 =?utf-8?B?WEVoekozWE5kZXlZcE81SUZzaS9pV0JtT3E1aWhOVW1acEtkbzNSeVVsSGRm?=
 =?utf-8?B?ZWJLRWtZM0xUZnU3Q1J5V3ZydTg2OGwzZFdxalM3dUdLcHI2eFFtWUFGcDJO?=
 =?utf-8?B?dGFFZkx5dURVU0lyRGdjdGxIaHl0UXN2a0FKSUp1am1tY2FENkI4T0VCcktx?=
 =?utf-8?B?dUlXK3VKZnE2U001ZklyZXZFVlJHM2s2NDZVVkMyMW5UQ3dESlU1ejdnaWc5?=
 =?utf-8?B?STVhK1REbVI5TUNkcHlVTU8yYXNGTjRhVkxNS1ZWUlRmdWc1T1I2aGZod2RJ?=
 =?utf-8?B?a3lIVjRVNWpRUy9zQUxFRFA1aWE0Yk83NTdJUFRPeUFtcWJoV05IRGE3ZUho?=
 =?utf-8?B?WW0vR293RXhQWDdoenhpRDVRZnNYVFNlSGNRZHRTdUZHRVMyNzlvNHpFTVds?=
 =?utf-8?B?Unl3a3pFUTg2RDM2Vm40SkpaMmZsQytMdlJaQVlFdFV0RUovTE1JZEw4bDly?=
 =?utf-8?B?UzdBSlR3LzNrM3g3ZzdSTWNkb0h1Z0dqS0VMcFMvNzlTTXZ5dnV2ZWtPSmlD?=
 =?utf-8?B?T2NOWDY3RHg3OUZobXRzdzB5QmN0YWZWK0RTWWVFcStWTlNYc2dBdHp2MHpI?=
 =?utf-8?B?T2ppL2phRTZNQlFVZy9BWXlYTW11QjAvRzRWbDJ2UXU1azQ5OXpJVXJBTlVB?=
 =?utf-8?B?djJleXFoMXpJUjVibkVRLzh4WDdJaExyWFVHTGpKN0EwRlROK0tFdm4xd043?=
 =?utf-8?B?b0E9PQ==?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3991e881-7de8-45b6-6f3b-08db6b1f1410
X-MS-Exchange-CrossTenant-AuthSource: DU0PR04MB9563.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Jun 2023 08:29:02.9409
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Dp6W0xgr33cJEk0YwHABMmxVe5TODLqpTR0MwS5T7KRhp/8KI6owmCUJCszr2U8k+vw44cus3HZHtUHXQgwQdSlMcBN67pw10LE3TS9QUUE=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS5PR04MB9971
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-crypto.vger.kernel.org>
X-Mailing-List: linux-crypto@vger.kernel.org

From: "Victoria Milhoan (b42089)" <vicki.milhoan@freescale.com>

CAAM includes a Random Number Generator.  This change adds
a kernel configuration option to test the RNG's capabilities via the
hw_random framework.

Signed-off-by: Victoria Milhoan <vicki.milhoan@freescale.com>
Signed-off-by: Dan Douglass <dan.douglass@nxp.com>
Signed-off-by: Vipul Kumar <vipul_kumar@mentor.com>
Signed-off-by: Horia Geantă <horia.geanta@nxp.com>
Signed-off-by: Meenakshi Aggarwal <meenakshi.aggarwal@nxp.com>
---
 drivers/crypto/caam/Kconfig   |  9 +++++++
 drivers/crypto/caam/caamrng.c | 48 +++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)

diff --git a/drivers/crypto/caam/Kconfig b/drivers/crypto/caam/Kconfig
index ec6a9e6ad4d2..c631f99e415f 100644
--- a/drivers/crypto/caam/Kconfig
+++ b/drivers/crypto/caam/Kconfig
@@ -162,6 +162,15 @@ config CRYPTO_DEV_FSL_CAAM_PRNG_API
 config CRYPTO_DEV_FSL_CAAM_BLOB_GEN
 	bool
 
+config CRYPTO_DEV_FSL_CAAM_RNG_TEST
+	bool "Test caam rng"
+	select CRYPTO_DEV_FSL_CAAM_RNG_API
+	help
+	  Selecting this will enable a self-test to run for the
+	  caam RNG.
+	  This test is several minutes long and executes
+	  just before the RNG is registered with the hw_random API.
+
 endif # CRYPTO_DEV_FSL_CAAM_JR
 
 endif # CRYPTO_DEV_FSL_CAAM
diff --git a/drivers/crypto/caam/caamrng.c b/drivers/crypto/caam/caamrng.c
index 50eb55da45c2..b3d14a7f4dd1 100644
--- a/drivers/crypto/caam/caamrng.c
+++ b/drivers/crypto/caam/caamrng.c
@@ -172,6 +172,50 @@ static void caam_cleanup(struct hwrng *rng)
 	kfifo_free(&ctx->fifo);
 }
 
+#ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_RNG_TEST
+static inline void test_len(struct hwrng *rng, size_t len, bool wait)
+{
+	u8 *buf;
+	int read_len;
+	struct caam_rng_ctx *ctx = to_caam_rng_ctx(rng);
+	struct device *dev = ctx->ctrldev;
+
+	buf = kcalloc(CAAM_RNG_MAX_FIFO_STORE_SIZE, sizeof(u8), GFP_KERNEL);
+
+	while (len > 0) {
+		read_len = rng->read(rng, buf, len, wait);
+
+		if (read_len < 0 || (read_len == 0 && wait)) {
+			dev_err(dev, "RNG Read FAILED received %d bytes\n",
+				read_len);
+			kfree(buf);
+			return;
+		}
+
+		print_hex_dump_debug("random bytes@: ",
+			DUMP_PREFIX_ADDRESS, 16, 4,
+			buf, read_len, 1);
+
+		len = len - read_len;
+	}
+
+	kfree(buf);
+}
+
+static inline void test_mode_once(struct hwrng *rng, bool wait)
+{
+	test_len(rng, 32, wait);
+	test_len(rng, 64, wait);
+	test_len(rng, 128, wait);
+}
+
+static void self_test(struct hwrng *rng)
+{
+	pr_info("Executing RNG SELF-TEST with wait\n");
+	test_mode_once(rng, true);
+}
+#endif
+
 static int caam_init(struct hwrng *rng)
 {
 	struct caam_rng_ctx *ctx = to_caam_rng_ctx(rng);
@@ -258,6 +302,10 @@ int caam_rng_init(struct device *ctrldev)
 		return ret;
 	}
 
+#ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_RNG_TEST
+	self_test(&ctx->rng);
+#endif
+
 	devres_close_group(ctrldev, caam_rng_init);
 	return 0;
 }
-- 
2.25.1