[mirror_ubuntu-focal-kernel.git] / drivers / nvmem / mxs-ocotp.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Freescale MXS On-Chip OTP driver
 *
 * Copyright (C) 2015 Stefan Wahren <stefan.wahren@i2se.com>
 *
 * Based on the driver from Huang Shijie and Christoph G. Baumann
 */
#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/nvmem-provider.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/stmp_device.h>

/* OCOTP registers and bits */

#define BM_OCOTP_CTRL_RD_BANK_OPEN	BIT(12)
#define BM_OCOTP_CTRL_ERROR		BIT(9)
#define BM_OCOTP_CTRL_BUSY		BIT(8)

#define OCOTP_TIMEOUT		10000
#define OCOTP_DATA_OFFSET	0x20

struct mxs_ocotp {
	struct clk *clk;
	void __iomem *base;
	struct nvmem_device *nvmem;
};

static int mxs_ocotp_wait(struct mxs_ocotp *otp)
{
	int timeout = OCOTP_TIMEOUT;
	unsigned int status = 0;

	while (timeout--) {
		status = readl(otp->base);

		if (!(status & (BM_OCOTP_CTRL_BUSY | BM_OCOTP_CTRL_ERROR)))
			break;

		cpu_relax();
	}

	if (status & BM_OCOTP_CTRL_BUSY)
		return -EBUSY;
	else if (status & BM_OCOTP_CTRL_ERROR)
		return -EIO;

	return 0;
}

static int mxs_ocotp_read(void *context, unsigned int offset,
			  void *val, size_t bytes)
{
	struct mxs_ocotp *otp = context;
	u32 *buf = val;
	int ret;

	ret = clk_enable(otp->clk);
	if (ret)
		return ret;

	writel(BM_OCOTP_CTRL_ERROR, otp->base + STMP_OFFSET_REG_CLR);

	ret = mxs_ocotp_wait(otp);
	if (ret)
		goto disable_clk;

	/* open OCOTP banks for read */
	writel(BM_OCOTP_CTRL_RD_BANK_OPEN, otp->base + STMP_OFFSET_REG_SET);

	/* approximately wait 33 hclk cycles */
	udelay(1);

	ret = mxs_ocotp_wait(otp);
	if (ret)
		goto close_banks;

	while (bytes) {
		if ((offset < OCOTP_DATA_OFFSET) || (offset % 16)) {
			/* fill up non-data register */
			*buf++ = 0;
		} else {
			*buf++ = readl(otp->base + offset);
		}

		bytes -= 4;
		offset += 4;
	}

close_banks:
	/* close banks for power saving */
	writel(BM_OCOTP_CTRL_RD_BANK_OPEN, otp->base + STMP_OFFSET_REG_CLR);

disable_clk:
	clk_disable(otp->clk);

	return ret;
}

static struct nvmem_config ocotp_config = {
	.name = "mxs-ocotp",
	.stride = 16,
	.word_size = 4,
	.reg_read = mxs_ocotp_read,
};

struct mxs_data {
	int size;
};

static const struct mxs_data imx23_data = {
	.size = 0x220,
};

static const struct mxs_data imx28_data = {
	.size = 0x2a0,
};

static const struct of_device_id mxs_ocotp_match[] = {
	{ .compatible = "fsl,imx23-ocotp", .data = &imx23_data },
	{ .compatible = "fsl,imx28-ocotp", .data = &imx28_data },
	{ /* sentinel */},
};
MODULE_DEVICE_TABLE(of, mxs_ocotp_match);

static int mxs_ocotp_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	const struct mxs_data *data;
	struct mxs_ocotp *otp;
	const struct of_device_id *match;
	int ret;

	match = of_match_device(dev->driver->of_match_table, dev);
	if (!match || !match->data)
		return -EINVAL;

	otp = devm_kzalloc(dev, sizeof(*otp), GFP_KERNEL);
	if (!otp)
		return -ENOMEM;

	otp->base = devm_platform_ioremap_resource(pdev, 0);
	if (IS_ERR(otp->base))
		return PTR_ERR(otp->base);

	otp->clk = devm_clk_get(&pdev->dev, NULL);
	if (IS_ERR(otp->clk))
		return PTR_ERR(otp->clk);

	ret = clk_prepare(otp->clk);
	if (ret < 0) {
		dev_err(dev, "failed to prepare clk: %d\n", ret);
		return ret;
	}

	data = match->data;

	ocotp_config.size = data->size;
	ocotp_config.priv = otp;
	ocotp_config.dev = dev;
	otp->nvmem = devm_nvmem_register(dev, &ocotp_config);
	if (IS_ERR(otp->nvmem)) {
		ret = PTR_ERR(otp->nvmem);
		goto err_clk;
	}

	platform_set_drvdata(pdev, otp);

	return 0;

err_clk:
	clk_unprepare(otp->clk);

	return ret;
}

static int mxs_ocotp_remove(struct platform_device *pdev)
{
	struct mxs_ocotp *otp = platform_get_drvdata(pdev);

	clk_unprepare(otp->clk);

	return 0;
}

static struct platform_driver mxs_ocotp_driver = {
	.probe = mxs_ocotp_probe,
	.remove = mxs_ocotp_remove,
	.driver = {
		.name = "mxs-ocotp",
		.of_match_table = mxs_ocotp_match,
	},
};

module_platform_driver(mxs_ocotp_driver);
MODULE_AUTHOR("Stefan Wahren <stefan.wahren@i2se.com>");
MODULE_DESCRIPTION("driver for OCOTP in i.MX23/i.MX28");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
c942fddf	1	// SPDX-License-Identifier: GPL-2.0-or-later
c01e9a11 SW	2	/*
	3	* Freescale MXS On-Chip OTP driver
	4	*
	5	* Copyright (C) 2015 Stefan Wahren <stefan.wahren@i2se.com>
	6	*
	7	* Based on the driver from Huang Shijie and Christoph G. Baumann
c01e9a11 SW	8	*/
	9	#include <linux/clk.h>
	10	#include <linux/delay.h>
	11	#include <linux/device.h>
	12	#include <linux/err.h>
	13	#include <linux/io.h>
	14	#include <linux/module.h>
	15	#include <linux/nvmem-provider.h>
	16	#include <linux/of_device.h>
	17	#include <linux/platform_device.h>
c01e9a11 SW	18	#include <linux/slab.h>
	19	#include <linux/stmp_device.h>
	20
	21	/* OCOTP registers and bits */
	22
	23	#define BM_OCOTP_CTRL_RD_BANK_OPEN BIT(12)
	24	#define BM_OCOTP_CTRL_ERROR BIT(9)
	25	#define BM_OCOTP_CTRL_BUSY BIT(8)
	26
	27	#define OCOTP_TIMEOUT 10000
	28	#define OCOTP_DATA_OFFSET 0x20
	29
	30	struct mxs_ocotp {
	31	struct clk *clk;
	32	void __iomem *base;
	33	struct nvmem_device *nvmem;
	34	};
	35
	36	static int mxs_ocotp_wait(struct mxs_ocotp *otp)
	37	{
	38	int timeout = OCOTP_TIMEOUT;
	39	unsigned int status = 0;
	40
	41	while (timeout--) {
	42	status = readl(otp->base);
	43
	44	if (!(status & (BM_OCOTP_CTRL_BUSY \| BM_OCOTP_CTRL_ERROR)))
	45	break;
	46
	47	cpu_relax();
	48	}
	49
	50	if (status & BM_OCOTP_CTRL_BUSY)
	51	return -EBUSY;
	52	else if (status & BM_OCOTP_CTRL_ERROR)
	53	return -EIO;
	54
	55	return 0;
	56	}
	57
7d8867d7 SK	58	static int mxs_ocotp_read(void *context, unsigned int offset,
7d8867d7 SK	59	void *val, size_t bytes)
c01e9a11 SW	60	{
c01e9a11 SW	61	struct mxs_ocotp *otp = context;
c01e9a11 SW	62	u32 *buf = val;
	63	int ret;
	64
	65	ret = clk_enable(otp->clk);
	66	if (ret)
	67	return ret;
	68
	69	writel(BM_OCOTP_CTRL_ERROR, otp->base + STMP_OFFSET_REG_CLR);
	70
	71	ret = mxs_ocotp_wait(otp);
	72	if (ret)
	73	goto disable_clk;
	74
	75	/* open OCOTP banks for read */
	76	writel(BM_OCOTP_CTRL_RD_BANK_OPEN, otp->base + STMP_OFFSET_REG_SET);
	77
	78	/* approximately wait 33 hclk cycles */
	79	udelay(1);
	80
	81	ret = mxs_ocotp_wait(otp);
	82	if (ret)
	83	goto close_banks;
	84
7d8867d7	85	while (bytes) {
c01e9a11 SW	86	if ((offset < OCOTP_DATA_OFFSET) \|\| (offset % 16)) {
c01e9a11 SW	87	/* fill up non-data register */
7d8867d7	88	*buf++ = 0;
c01e9a11	89	} else {
7d8867d7	90	*buf++ = readl(otp->base + offset);
c01e9a11 SW	91	}
c01e9a11 SW	92
7d8867d7 SK	93	bytes -= 4;
7d8867d7 SK	94	offset += 4;
c01e9a11 SW	95	}
	96
	97	close_banks:
	98	/* close banks for power saving */
	99	writel(BM_OCOTP_CTRL_RD_BANK_OPEN, otp->base + STMP_OFFSET_REG_CLR);
	100
	101	disable_clk:
	102	clk_disable(otp->clk);
	103
	104	return ret;
	105	}
	106
c01e9a11 SW	107	static struct nvmem_config ocotp_config = {
c01e9a11 SW	108	.name = "mxs-ocotp",
7d8867d7 SK	109	.stride = 16,
7d8867d7 SK	110	.word_size = 4,
7d8867d7	111	.reg_read = mxs_ocotp_read,
c01e9a11 SW	112	};
c01e9a11 SW	113
7d8867d7 SK	114	struct mxs_data {
7d8867d7 SK	115	int size;
c01e9a11 SW	116	};
c01e9a11 SW	117
7d8867d7 SK	118	static const struct mxs_data imx23_data = {
7d8867d7 SK	119	.size = 0x220,
c01e9a11 SW	120	};
c01e9a11 SW	121
7d8867d7 SK	122	static const struct mxs_data imx28_data = {
7d8867d7 SK	123	.size = 0x2a0,
c01e9a11 SW	124	};
	125
	126	static const struct of_device_id mxs_ocotp_match[] = {
7d8867d7 SK	127	{ .compatible = "fsl,imx23-ocotp", .data = &imx23_data },
7d8867d7 SK	128	{ .compatible = "fsl,imx28-ocotp", .data = &imx28_data },
c01e9a11 SW	129	{ /* sentinel */},
	130	};
	131	MODULE_DEVICE_TABLE(of, mxs_ocotp_match);
	132
	133	static int mxs_ocotp_probe(struct platform_device *pdev)
	134	{
	135	struct device *dev = &pdev->dev;
7d8867d7	136	const struct mxs_data *data;
c01e9a11	137	struct mxs_ocotp *otp;
c01e9a11	138	const struct of_device_id *match;
c01e9a11 SW	139	int ret;
	140
	141	match = of_match_device(dev->driver->of_match_table, dev);
	142	if (!match \|\| !match->data)
	143	return -EINVAL;
	144
	145	otp = devm_kzalloc(dev, sizeof(*otp), GFP_KERNEL);
	146	if (!otp)
	147	return -ENOMEM;
	148
794a1e22	149	otp->base = devm_platform_ioremap_resource(pdev, 0);
c01e9a11 SW	150	if (IS_ERR(otp->base))
	151	return PTR_ERR(otp->base);
	152
	153	otp->clk = devm_clk_get(&pdev->dev, NULL);
	154	if (IS_ERR(otp->clk))
	155	return PTR_ERR(otp->clk);
	156
	157	ret = clk_prepare(otp->clk);
	158	if (ret < 0) {
	159	dev_err(dev, "failed to prepare clk: %d\n", ret);
	160	return ret;
	161	}
	162
7d8867d7	163	data = match->data;
c01e9a11	164
7d8867d7 SK	165	ocotp_config.size = data->size;
7d8867d7 SK	166	ocotp_config.priv = otp;
c01e9a11	167	ocotp_config.dev = dev;
7d9f9f24	168	otp->nvmem = devm_nvmem_register(dev, &ocotp_config);
c01e9a11 SW	169	if (IS_ERR(otp->nvmem)) {
	170	ret = PTR_ERR(otp->nvmem);
	171	goto err_clk;
	172	}
	173
	174	platform_set_drvdata(pdev, otp);
	175
	176	return 0;
	177
	178	err_clk:
	179	clk_unprepare(otp->clk);
	180
	181	return ret;
	182	}
	183
	184	static int mxs_ocotp_remove(struct platform_device *pdev)
	185	{
	186	struct mxs_ocotp *otp = platform_get_drvdata(pdev);
	187
	188	clk_unprepare(otp->clk);
	189
7d9f9f24	190	return 0;
c01e9a11 SW	191	}
	192
	193	static struct platform_driver mxs_ocotp_driver = {
	194	.probe = mxs_ocotp_probe,
	195	.remove = mxs_ocotp_remove,
	196	.driver = {
	197	.name = "mxs-ocotp",
	198	.of_match_table = mxs_ocotp_match,
	199	},
	200	};
	201
	202	module_platform_driver(mxs_ocotp_driver);
	203	MODULE_AUTHOR("Stefan Wahren <stefan.wahren@i2se.com>");
	204	MODULE_DESCRIPTION("driver for OCOTP in i.MX23/i.MX28");
	205	MODULE_LICENSE("GPL v2");