xref: /OK3568_Linux_fs/kernel/drivers/char/hw_random/rockchip-rng.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)

// SPDX-License-Identifier: GPL-2.0
/*
 * rockchip-rng.c Random Number Generator driver for the Rockchip
 *
 * Copyright (c) 2018, Fuzhou Rockchip Electronics Co., Ltd.
 * Author: Lin Jinhan <troy.lin@rock-chips.com>
 *
 */
#include <linux/clk.h>
#include <linux/hw_random.h>
#include <linux/iopoll.h>
#include <linux/module.h>
#include <linux/mod_devicetable.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>

#define _SBF(s, v)	((v) << (s))
#define HIWORD_UPDATE(val, mask, shift) \
			((val) << (shift) | (mask) << ((shift) + 16))

#define ROCKCHIP_AUTOSUSPEND_DELAY		100
#define ROCKCHIP_POLL_PERIOD_US			100
#define ROCKCHIP_POLL_TIMEOUT_US		50000
#define RK_MAX_RNG_BYTE				(32)

/* start of CRYPTO V1 register define */
#define CRYPTO_V1_CTRL				0x0008
#define CRYPTO_V1_RNG_START			BIT(8)
#define CRYPTO_V1_RNG_FLUSH			BIT(9)

#define CRYPTO_V1_TRNG_CTRL			0x0200
#define CRYPTO_V1_OSC_ENABLE			BIT(16)
#define CRYPTO_V1_TRNG_SAMPLE_PERIOD(x)		(x)

#define CRYPTO_V1_TRNG_DOUT_0			0x0204
/* end of CRYPTO V1 register define */

/* start of CRYPTO V2 register define */
#define CRYPTO_V2_RNG_DEFAULT_OFFSET		0x0400
#define CRYPTO_V2_RNG_CTL			0x0
#define CRYPTO_V2_RNG_64_BIT_LEN		_SBF(4, 0x00)
#define CRYPTO_V2_RNG_128_BIT_LEN		_SBF(4, 0x01)
#define CRYPTO_V2_RNG_192_BIT_LEN		_SBF(4, 0x02)
#define CRYPTO_V2_RNG_256_BIT_LEN		_SBF(4, 0x03)
#define CRYPTO_V2_RNG_FATESY_SOC_RING		_SBF(2, 0x00)
#define CRYPTO_V2_RNG_SLOWER_SOC_RING_0		_SBF(2, 0x01)
#define CRYPTO_V2_RNG_SLOWER_SOC_RING_1		_SBF(2, 0x02)
#define CRYPTO_V2_RNG_SLOWEST_SOC_RING		_SBF(2, 0x03)
#define CRYPTO_V2_RNG_ENABLE			BIT(1)
#define CRYPTO_V2_RNG_START			BIT(0)
#define CRYPTO_V2_RNG_SAMPLE_CNT		0x0004
#define CRYPTO_V2_RNG_DOUT_0			0x0010
/* end of CRYPTO V2 register define */

/* start of TRNG_V1 register define */
/* TRNG is no longer subordinate to the Crypto module */
#define TRNG_V1_CTRL				0x0000
#define TRNG_V1_CTRL_NOP			_SBF(0, 0x00)
#define TRNG_V1_CTRL_RAND			_SBF(0, 0x01)
#define TRNG_V1_CTRL_SEED			_SBF(0, 0x02)

#define TRNG_V1_STAT				0x0004
#define TRNG_V1_STAT_SEEDED			BIT(9)
#define TRNG_V1_STAT_GENERATING			BIT(30)
#define TRNG_V1_STAT_RESEEDING			BIT(31)

#define TRNG_V1_MODE				0x0008
#define TRNG_V1_MODE_128_BIT			_SBF(3, 0x00)
#define TRNG_V1_MODE_256_BIT			_SBF(3, 0x01)

#define TRNG_V1_IE				0x0010
#define TRNG_V1_IE_GLBL_EN			BIT(31)
#define TRNG_V1_IE_SEED_DONE_EN			BIT(1)
#define TRNG_V1_IE_RAND_RDY_EN			BIT(0)

#define TRNG_V1_ISTAT				0x0014
#define TRNG_V1_ISTAT_RAND_RDY			BIT(0)

/* RAND0 ~ RAND7 */
#define TRNG_V1_RAND0				0x0020
#define TRNG_V1_RAND7				0x003C

#define TRNG_V1_AUTO_RQSTS			0x0060

#define TRNG_V1_VERSION				0x00F0
#define TRNG_v1_VERSION_CODE			0x46bc
/* end of TRNG_V1 register define */

/* start of RKRNG register define */
#define RKRNG_CTRL				0x0010
#define RKRNG_CTRL_INST_REQ			BIT(0)
#define RKRNG_CTRL_RESEED_REQ			BIT(1)
#define RKRNG_CTRL_TEST_REQ			BIT(2)
#define RKRNG_CTRL_SW_DRNG_REQ			BIT(3)
#define RKRNG_CTRL_SW_TRNG_REQ			BIT(4)

#define RKRNG_STATE				0x0014
#define RKRNG_STATE_INST_ACK			BIT(0)
#define RKRNG_STATE_RESEED_ACK			BIT(1)
#define RKRNG_STATE_TEST_ACK			BIT(2)
#define RKRNG_STATE_SW_DRNG_ACK			BIT(3)
#define RKRNG_STATE_SW_TRNG_ACK			BIT(4)

/* DRNG_DATA_0 ~ DNG_DATA_7 */
#define RKRNG_DRNG_DATA_0			0x0070
#define RKRNG_DRNG_DATA_7			0x008C

/* end of RKRNG register define */

struct rk_rng_soc_data {
	u32 default_offset;

	int (*rk_rng_init)(struct hwrng *rng);
	int (*rk_rng_read)(struct hwrng *rng, void *buf, size_t max, bool wait);
};

struct rk_rng {
	struct device		*dev;
	struct hwrng		rng;
	void __iomem		*mem;
	struct rk_rng_soc_data	*soc_data;
	int			clk_num;
	struct clk_bulk_data	*clk_bulks;
};

static void rk_rng_writel(struct rk_rng *rng, u32 val, u32 offset)
{
	__raw_writel(val, rng->mem + offset);
}

static u32 rk_rng_readl(struct rk_rng *rng, u32 offset)
{
	return __raw_readl(rng->mem + offset);
}

static int rk_rng_init(struct hwrng *rng)
{
	int ret;
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);

	dev_dbg(rk_rng->dev, "clk_bulk_prepare_enable.\n");

	ret = clk_bulk_prepare_enable(rk_rng->clk_num, rk_rng->clk_bulks);
	if (ret < 0) {
		dev_err(rk_rng->dev, "failed to enable clks %d\n", ret);
		return ret;
	}

	return 0;
}

static void rk_rng_cleanup(struct hwrng *rng)
{
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);

	dev_dbg(rk_rng->dev, "clk_bulk_disable_unprepare.\n");
	clk_bulk_disable_unprepare(rk_rng->clk_num, rk_rng->clk_bulks);
}

static int rk_rng_read(struct hwrng *rng, void *buf, size_t max, bool wait)
{
	int ret;
	int read_len = 0;
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);

	if (!rk_rng->soc_data->rk_rng_read)
		return -EFAULT;

	ret = pm_runtime_get_sync(rk_rng->dev);
	if (ret < 0) {
		pm_runtime_put_noidle(rk_rng->dev);
		return ret;
	}

	ret = 0;
	while (max > ret) {
		read_len = rk_rng->soc_data->rk_rng_read(rng, buf + ret,
							 max - ret, wait);
		if (read_len < 0) {
			ret = read_len;
			break;
		}
		ret += read_len;
	}

	pm_runtime_mark_last_busy(rk_rng->dev);
	pm_runtime_put_sync_autosuspend(rk_rng->dev);

	return ret;
}

static void rk_rng_read_regs(struct rk_rng *rng, u32 offset, void *buf,
			     size_t size)
{
	u32 i;

	for (i = 0; i < size; i += 4)
		*(u32 *)(buf + i) = be32_to_cpu(rk_rng_readl(rng, offset + i));
}

static int crypto_v1_read(struct hwrng *rng, void *buf, size_t max, bool wait)
{
	int ret = 0;
	u32 reg_ctrl = 0;
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);

	/* enable osc_ring to get entropy, sample period is set as 100 */
	reg_ctrl = CRYPTO_V1_OSC_ENABLE | CRYPTO_V1_TRNG_SAMPLE_PERIOD(100);
	rk_rng_writel(rk_rng, reg_ctrl, CRYPTO_V1_TRNG_CTRL);

	reg_ctrl = HIWORD_UPDATE(CRYPTO_V1_RNG_START, CRYPTO_V1_RNG_START, 0);

	rk_rng_writel(rk_rng, reg_ctrl, CRYPTO_V1_CTRL);

	ret = read_poll_timeout(rk_rng_readl, reg_ctrl,
				!(reg_ctrl & CRYPTO_V1_RNG_START),
				ROCKCHIP_POLL_PERIOD_US,
				ROCKCHIP_POLL_TIMEOUT_US, false,
				rk_rng, CRYPTO_V1_CTRL);

	if (ret < 0)
		goto out;

	ret = min_t(size_t, max, RK_MAX_RNG_BYTE);

	rk_rng_read_regs(rk_rng, CRYPTO_V1_TRNG_DOUT_0, buf, ret);

out:
	/* close TRNG */
	rk_rng_writel(rk_rng, HIWORD_UPDATE(0, CRYPTO_V1_RNG_START, 0),
		      CRYPTO_V1_CTRL);

	return ret;
}

static int crypto_v2_read(struct hwrng *rng, void *buf, size_t max, bool wait)
{
	int ret = 0;
	u32 reg_ctrl = 0;
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);

	/* enable osc_ring to get entropy, sample period is set as 100 */
	rk_rng_writel(rk_rng, 100, CRYPTO_V2_RNG_SAMPLE_CNT);

	reg_ctrl |= CRYPTO_V2_RNG_256_BIT_LEN;
	reg_ctrl |= CRYPTO_V2_RNG_SLOWER_SOC_RING_0;
	reg_ctrl |= CRYPTO_V2_RNG_ENABLE;
	reg_ctrl |= CRYPTO_V2_RNG_START;

	rk_rng_writel(rk_rng, HIWORD_UPDATE(reg_ctrl, 0xffff, 0),
		      CRYPTO_V2_RNG_CTL);

	ret = read_poll_timeout(rk_rng_readl, reg_ctrl,
				!(reg_ctrl & CRYPTO_V2_RNG_START),
				ROCKCHIP_POLL_PERIOD_US,
				ROCKCHIP_POLL_TIMEOUT_US, false,
				rk_rng, CRYPTO_V2_RNG_CTL);
	if (ret < 0)
		goto out;

	ret = min_t(size_t, max, RK_MAX_RNG_BYTE);

	rk_rng_read_regs(rk_rng, CRYPTO_V2_RNG_DOUT_0, buf, ret);

out:
	/* close TRNG */
	rk_rng_writel(rk_rng, HIWORD_UPDATE(0, 0xffff, 0), CRYPTO_V2_RNG_CTL);

	return ret;
}

static int trng_v1_init(struct hwrng *rng)
{
	int ret;
	uint32_t auto_reseed_cnt = 1000;
	uint32_t reg_ctrl, status, version;
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);

	version = rk_rng_readl(rk_rng, TRNG_V1_VERSION);
	if (version != TRNG_v1_VERSION_CODE) {
		dev_err(rk_rng->dev,
			"wrong trng version, expected = %08x, actual = %08x\n",
			TRNG_V1_VERSION, version);
		ret = -EFAULT;
		goto exit;
	}

	status = rk_rng_readl(rk_rng, TRNG_V1_STAT);

	/* TRNG should wait RAND_RDY triggered if it is busy or not seeded */
	if (!(status & TRNG_V1_STAT_SEEDED) ||
	    (status & TRNG_V1_STAT_GENERATING) ||
	    (status & TRNG_V1_STAT_RESEEDING)) {
		uint32_t mask = TRNG_V1_STAT_SEEDED |
				TRNG_V1_STAT_GENERATING |
				TRNG_V1_STAT_RESEEDING;

		udelay(10);

		/* wait for GENERATING and RESEEDING flag to clear */
		read_poll_timeout(rk_rng_readl, reg_ctrl,
				  (reg_ctrl & mask) == TRNG_V1_STAT_SEEDED,
				  ROCKCHIP_POLL_PERIOD_US,
				  ROCKCHIP_POLL_TIMEOUT_US, false,
				  rk_rng, TRNG_V1_STAT);
	}

	/* clear ISTAT flag because trng may auto reseeding when power on */
	reg_ctrl = rk_rng_readl(rk_rng, TRNG_V1_ISTAT);
	rk_rng_writel(rk_rng, reg_ctrl, TRNG_V1_ISTAT);

	/* auto reseed after (auto_reseed_cnt * 16) byte rand generate */
	rk_rng_writel(rk_rng, auto_reseed_cnt, TRNG_V1_AUTO_RQSTS);

	ret = 0;
exit:

	return ret;
}

static int trng_v1_read(struct hwrng *rng, void *buf, size_t max, bool wait)
{
	int ret = 0;
	u32 reg_ctrl = 0;
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);

	/* clear ISTAT anyway */
	reg_ctrl = rk_rng_readl(rk_rng, TRNG_V1_ISTAT);
	rk_rng_writel(rk_rng, reg_ctrl, TRNG_V1_ISTAT);

	/* generate 256bit random */
	rk_rng_writel(rk_rng, TRNG_V1_MODE_256_BIT, TRNG_V1_MODE);
	rk_rng_writel(rk_rng, TRNG_V1_CTRL_RAND, TRNG_V1_CTRL);

	/*
	 * Generate2 56 bit random data will cost 1024 clock cycles.
	 * Estimated at 150M RNG module frequency, it takes 6.7 microseconds.
	 */
	udelay(10);
	reg_ctrl = rk_rng_readl(rk_rng, TRNG_V1_ISTAT);
	if (!(reg_ctrl & TRNG_V1_ISTAT_RAND_RDY)) {
		/* wait RAND_RDY triggered */
		ret = read_poll_timeout(rk_rng_readl, reg_ctrl,
					(reg_ctrl & TRNG_V1_ISTAT_RAND_RDY),
					ROCKCHIP_POLL_PERIOD_US,
					ROCKCHIP_POLL_TIMEOUT_US, false,
					rk_rng, TRNG_V1_ISTAT);
		if (ret < 0)
			goto out;
	}

	ret = min_t(size_t, max, RK_MAX_RNG_BYTE);

	rk_rng_read_regs(rk_rng, TRNG_V1_RAND0, buf, ret);

	/* clear all status flag */
	rk_rng_writel(rk_rng, reg_ctrl, TRNG_V1_ISTAT);
out:
	/* close TRNG */
	rk_rng_writel(rk_rng, TRNG_V1_CTRL_NOP, TRNG_V1_CTRL);

	return ret;
}

static int rkrng_init(struct hwrng *rng)
{
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);
	u32 reg = 0;

	rk_rng_writel(rk_rng, HIWORD_UPDATE(0, 0xffff, 0), RKRNG_CTRL);

	reg = rk_rng_readl(rk_rng, RKRNG_STATE);
	rk_rng_writel(rk_rng, reg, RKRNG_STATE);

	return 0;
}

static int rkrng_read(struct hwrng *rng, void *buf, size_t max, bool wait)
{
	struct rk_rng *rk_rng = container_of(rng, struct rk_rng, rng);
	u32 reg_ctrl = 0;
	int ret;

	reg_ctrl = RKRNG_CTRL_SW_DRNG_REQ;

	rk_rng_writel(rk_rng, HIWORD_UPDATE(reg_ctrl, 0xffff, 0), RKRNG_CTRL);

	ret = readl_poll_timeout(rk_rng->mem + RKRNG_STATE, reg_ctrl,
				 (reg_ctrl & RKRNG_STATE_SW_DRNG_ACK),
				 ROCKCHIP_POLL_PERIOD_US,
				 ROCKCHIP_POLL_TIMEOUT_US);

	if (ret)
		goto exit;

	rk_rng_writel(rk_rng, reg_ctrl, RKRNG_STATE);

	ret = min_t(size_t, max, RK_MAX_RNG_BYTE);

	rk_rng_read_regs(rk_rng, RKRNG_DRNG_DATA_0, buf, ret);

exit:
	/* close TRNG */
	rk_rng_writel(rk_rng, HIWORD_UPDATE(0, 0xffff, 0), RKRNG_CTRL);

	return ret;
}

static const struct rk_rng_soc_data crypto_v1_soc_data = {
	.default_offset = 0,

	.rk_rng_read = crypto_v1_read,
};

static const struct rk_rng_soc_data crypto_v2_soc_data = {
	.default_offset = CRYPTO_V2_RNG_DEFAULT_OFFSET,

	.rk_rng_read = crypto_v2_read,
};

static const struct rk_rng_soc_data trng_v1_soc_data = {
	.default_offset = 0,

	.rk_rng_init = trng_v1_init,
	.rk_rng_read = trng_v1_read,
};

static const struct rk_rng_soc_data rkrng_soc_data = {
	.default_offset = 0,

	.rk_rng_init = rkrng_init,
	.rk_rng_read = rkrng_read,
};

static const struct of_device_id rk_rng_dt_match[] = {
	{
		.compatible = "rockchip,cryptov1-rng",
		.data = (void *)&crypto_v1_soc_data,
	},
	{
		.compatible = "rockchip,cryptov2-rng",
		.data = (void *)&crypto_v2_soc_data,
	},
	{
		.compatible = "rockchip,trngv1",
		.data = (void *)&trng_v1_soc_data,
	},
		{
		.compatible = "rockchip,rkrng",
		.data = (void *)&rkrng_soc_data,
	},
	{ },
};

MODULE_DEVICE_TABLE(of, rk_rng_dt_match);

static int rk_rng_probe(struct platform_device *pdev)
{
	int ret;
	struct rk_rng *rk_rng;
	struct device_node *np = pdev->dev.of_node;
	const struct of_device_id *match;
	resource_size_t map_size;

	dev_dbg(&pdev->dev, "probing...\n");
	rk_rng = devm_kzalloc(&pdev->dev, sizeof(struct rk_rng), GFP_KERNEL);
	if (!rk_rng)
		return -ENOMEM;

	match = of_match_node(rk_rng_dt_match, np);
	rk_rng->soc_data = (struct rk_rng_soc_data *)match->data;

	rk_rng->dev = &pdev->dev;
	rk_rng->rng.name    = "rockchip";
#ifndef CONFIG_PM
	rk_rng->rng.init    = rk_rng_init;
	rk_rng->rng.cleanup = rk_rng_cleanup,
#endif
	rk_rng->rng.read    = rk_rng_read;
	rk_rng->rng.quality = 999;

	rk_rng->mem = devm_of_iomap(&pdev->dev, pdev->dev.of_node, 0, &map_size);
	if (IS_ERR(rk_rng->mem))
		return PTR_ERR(rk_rng->mem);

	/* compatible with crypto v2 module */
	/*
	 * With old dtsi configurations, the RNG base was equal to the crypto
	 * base, so both drivers could not be enabled at the same time.
	 * RNG base = CRYPTO base + RNG offset
	 * (Since RK356X, RNG module is no longer belongs to CRYPTO module)
	 *
	 * With new dtsi configurations, CRYPTO regs is divided into two parts
	 * |---cipher---|---rng---|---pka---|, and RNG base is real RNG base.
	 * RNG driver and CRYPTO driver could be enabled at the same time.
	 */
	if (map_size > rk_rng->soc_data->default_offset)
		rk_rng->mem += rk_rng->soc_data->default_offset;

	rk_rng->clk_num = devm_clk_bulk_get_all(&pdev->dev, &rk_rng->clk_bulks);
	if (rk_rng->clk_num < 0) {
		dev_err(&pdev->dev, "failed to get clks property\n");
		return -ENODEV;
	}

	platform_set_drvdata(pdev, rk_rng);

	pm_runtime_set_autosuspend_delay(&pdev->dev,
					 ROCKCHIP_AUTOSUSPEND_DELAY);
	pm_runtime_use_autosuspend(&pdev->dev);
	pm_runtime_enable(&pdev->dev);

	ret = devm_hwrng_register(&pdev->dev, &rk_rng->rng);
	if (ret) {
		pm_runtime_dont_use_autosuspend(&pdev->dev);
		pm_runtime_disable(&pdev->dev);
	}

	/* for some platform need hardware operation when probe */
	if (rk_rng->soc_data->rk_rng_init) {
		pm_runtime_get_sync(rk_rng->dev);

		ret = rk_rng->soc_data->rk_rng_init(&rk_rng->rng);

		pm_runtime_mark_last_busy(rk_rng->dev);
		pm_runtime_put_sync_autosuspend(rk_rng->dev);
	}

	return ret;
}

#ifdef CONFIG_PM
static int rk_rng_runtime_suspend(struct device *dev)
{
	struct rk_rng *rk_rng = dev_get_drvdata(dev);

	rk_rng_cleanup(&rk_rng->rng);

	return 0;
}

static int rk_rng_runtime_resume(struct device *dev)
{
	struct rk_rng *rk_rng = dev_get_drvdata(dev);

	return rk_rng_init(&rk_rng->rng);
}

static const struct dev_pm_ops rk_rng_pm_ops = {
	SET_RUNTIME_PM_OPS(rk_rng_runtime_suspend,
			   rk_rng_runtime_resume, NULL)
	SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
				pm_runtime_force_resume)
};

#endif

static struct platform_driver rk_rng_driver = {
	.driver	= {
		.name	= "rockchip-rng",
#ifdef CONFIG_PM
		.pm	= &rk_rng_pm_ops,
#endif
		.of_match_table = rk_rng_dt_match,
	},
	.probe	= rk_rng_probe,
};

module_platform_driver(rk_rng_driver);

MODULE_DESCRIPTION("ROCKCHIP H/W Random Number Generator driver");
MODULE_AUTHOR("Lin Jinhan <troy.lin@rock-chips.com>");
MODULE_LICENSE("GPL v2");