xref: /openbmc/linux/drivers/nvmem/imx-ocotp-ele.c (revision 22e9e6fcfb5042cb6d6c7874c459b034800092f1)
1*22e9e6fcSPeng Fan // SPDX-License-Identifier: GPL-2.0-only
2*22e9e6fcSPeng Fan /*
3*22e9e6fcSPeng Fan  * i.MX9 OCOTP fusebox driver
4*22e9e6fcSPeng Fan  *
5*22e9e6fcSPeng Fan  * Copyright 2023 NXP
6*22e9e6fcSPeng Fan  */
7*22e9e6fcSPeng Fan 
8*22e9e6fcSPeng Fan #include <linux/device.h>
9*22e9e6fcSPeng Fan #include <linux/io.h>
10*22e9e6fcSPeng Fan #include <linux/module.h>
11*22e9e6fcSPeng Fan #include <linux/nvmem-provider.h>
12*22e9e6fcSPeng Fan #include <linux/of_device.h>
13*22e9e6fcSPeng Fan #include <linux/platform_device.h>
14*22e9e6fcSPeng Fan #include <linux/slab.h>
15*22e9e6fcSPeng Fan 
16*22e9e6fcSPeng Fan enum fuse_type {
17*22e9e6fcSPeng Fan 	FUSE_FSB = 1,
18*22e9e6fcSPeng Fan 	FUSE_ELE = 2,
19*22e9e6fcSPeng Fan 	FUSE_INVALID = -1
20*22e9e6fcSPeng Fan };
21*22e9e6fcSPeng Fan 
22*22e9e6fcSPeng Fan struct ocotp_map_entry {
23*22e9e6fcSPeng Fan 	u32 start; /* start word */
24*22e9e6fcSPeng Fan 	u32 num; /* num words */
25*22e9e6fcSPeng Fan 	enum fuse_type type;
26*22e9e6fcSPeng Fan };
27*22e9e6fcSPeng Fan 
28*22e9e6fcSPeng Fan struct ocotp_devtype_data {
29*22e9e6fcSPeng Fan 	u32 reg_off;
30*22e9e6fcSPeng Fan 	char *name;
31*22e9e6fcSPeng Fan 	u32 size;
32*22e9e6fcSPeng Fan 	u32 num_entry;
33*22e9e6fcSPeng Fan 	u32 flag;
34*22e9e6fcSPeng Fan 	nvmem_reg_read_t reg_read;
35*22e9e6fcSPeng Fan 	struct ocotp_map_entry entry[];
36*22e9e6fcSPeng Fan };
37*22e9e6fcSPeng Fan 
38*22e9e6fcSPeng Fan struct imx_ocotp_priv {
39*22e9e6fcSPeng Fan 	struct device *dev;
40*22e9e6fcSPeng Fan 	void __iomem *base;
41*22e9e6fcSPeng Fan 	struct nvmem_config config;
42*22e9e6fcSPeng Fan 	struct mutex lock;
43*22e9e6fcSPeng Fan 	const struct ocotp_devtype_data *data;
44*22e9e6fcSPeng Fan };
45*22e9e6fcSPeng Fan 
46*22e9e6fcSPeng Fan static enum fuse_type imx_ocotp_fuse_type(void *context, u32 index)
47*22e9e6fcSPeng Fan {
48*22e9e6fcSPeng Fan 	struct imx_ocotp_priv *priv = context;
49*22e9e6fcSPeng Fan 	const struct ocotp_devtype_data *data = priv->data;
50*22e9e6fcSPeng Fan 	u32 start, end;
51*22e9e6fcSPeng Fan 	int i;
52*22e9e6fcSPeng Fan 
53*22e9e6fcSPeng Fan 	for (i = 0; i < data->num_entry; i++) {
54*22e9e6fcSPeng Fan 		start = data->entry[i].start;
55*22e9e6fcSPeng Fan 		end = data->entry[i].start + data->entry[i].num;
56*22e9e6fcSPeng Fan 
57*22e9e6fcSPeng Fan 		if (index >= start && index < end)
58*22e9e6fcSPeng Fan 			return data->entry[i].type;
59*22e9e6fcSPeng Fan 	}
60*22e9e6fcSPeng Fan 
61*22e9e6fcSPeng Fan 	return FUSE_INVALID;
62*22e9e6fcSPeng Fan }
63*22e9e6fcSPeng Fan 
64*22e9e6fcSPeng Fan static int imx_ocotp_reg_read(void *context, unsigned int offset, void *val, size_t bytes)
65*22e9e6fcSPeng Fan {
66*22e9e6fcSPeng Fan 	struct imx_ocotp_priv *priv = context;
67*22e9e6fcSPeng Fan 	void __iomem *reg = priv->base + priv->data->reg_off;
68*22e9e6fcSPeng Fan 	u32 count, index, num_bytes;
69*22e9e6fcSPeng Fan 	enum fuse_type type;
70*22e9e6fcSPeng Fan 	u32 *buf;
71*22e9e6fcSPeng Fan 	void *p;
72*22e9e6fcSPeng Fan 	int i;
73*22e9e6fcSPeng Fan 
74*22e9e6fcSPeng Fan 	index = offset;
75*22e9e6fcSPeng Fan 	num_bytes = round_up(bytes, 4);
76*22e9e6fcSPeng Fan 	count = num_bytes >> 2;
77*22e9e6fcSPeng Fan 
78*22e9e6fcSPeng Fan 	if (count > ((priv->data->size >> 2) - index))
79*22e9e6fcSPeng Fan 		count = (priv->data->size >> 2) - index;
80*22e9e6fcSPeng Fan 
81*22e9e6fcSPeng Fan 	p = kzalloc(num_bytes, GFP_KERNEL);
82*22e9e6fcSPeng Fan 	if (!p)
83*22e9e6fcSPeng Fan 		return -ENOMEM;
84*22e9e6fcSPeng Fan 
85*22e9e6fcSPeng Fan 	mutex_lock(&priv->lock);
86*22e9e6fcSPeng Fan 
87*22e9e6fcSPeng Fan 	buf = p;
88*22e9e6fcSPeng Fan 
89*22e9e6fcSPeng Fan 	for (i = index; i < (index + count); i++) {
90*22e9e6fcSPeng Fan 		type = imx_ocotp_fuse_type(context, i);
91*22e9e6fcSPeng Fan 		if (type == FUSE_INVALID || type == FUSE_ELE) {
92*22e9e6fcSPeng Fan 			*buf++ = 0;
93*22e9e6fcSPeng Fan 			continue;
94*22e9e6fcSPeng Fan 		}
95*22e9e6fcSPeng Fan 
96*22e9e6fcSPeng Fan 		*buf++ = readl_relaxed(reg + (i << 2));
97*22e9e6fcSPeng Fan 	}
98*22e9e6fcSPeng Fan 
99*22e9e6fcSPeng Fan 	memcpy(val, (u8 *)p, bytes);
100*22e9e6fcSPeng Fan 
101*22e9e6fcSPeng Fan 	mutex_unlock(&priv->lock);
102*22e9e6fcSPeng Fan 
103*22e9e6fcSPeng Fan 	kfree(p);
104*22e9e6fcSPeng Fan 
105*22e9e6fcSPeng Fan 	return 0;
106*22e9e6fcSPeng Fan };
107*22e9e6fcSPeng Fan 
108*22e9e6fcSPeng Fan static int imx_ele_ocotp_probe(struct platform_device *pdev)
109*22e9e6fcSPeng Fan {
110*22e9e6fcSPeng Fan 	struct device *dev = &pdev->dev;
111*22e9e6fcSPeng Fan 	struct imx_ocotp_priv *priv;
112*22e9e6fcSPeng Fan 	struct nvmem_device *nvmem;
113*22e9e6fcSPeng Fan 
114*22e9e6fcSPeng Fan 	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
115*22e9e6fcSPeng Fan 	if (!priv)
116*22e9e6fcSPeng Fan 		return -ENOMEM;
117*22e9e6fcSPeng Fan 
118*22e9e6fcSPeng Fan 	priv->data = of_device_get_match_data(dev);
119*22e9e6fcSPeng Fan 
120*22e9e6fcSPeng Fan 	priv->base = devm_platform_ioremap_resource(pdev, 0);
121*22e9e6fcSPeng Fan 	if (IS_ERR(priv->base))
122*22e9e6fcSPeng Fan 		return PTR_ERR(priv->base);
123*22e9e6fcSPeng Fan 
124*22e9e6fcSPeng Fan 	priv->config.dev = dev;
125*22e9e6fcSPeng Fan 	priv->config.name = "ELE-OCOTP";
126*22e9e6fcSPeng Fan 	priv->config.id = NVMEM_DEVID_AUTO;
127*22e9e6fcSPeng Fan 	priv->config.owner = THIS_MODULE;
128*22e9e6fcSPeng Fan 	priv->config.size = priv->data->size;
129*22e9e6fcSPeng Fan 	priv->config.reg_read = priv->data->reg_read;
130*22e9e6fcSPeng Fan 	priv->config.word_size = 4;
131*22e9e6fcSPeng Fan 	priv->config.stride = 1;
132*22e9e6fcSPeng Fan 	priv->config.priv = priv;
133*22e9e6fcSPeng Fan 	priv->config.read_only = true;
134*22e9e6fcSPeng Fan 	mutex_init(&priv->lock);
135*22e9e6fcSPeng Fan 
136*22e9e6fcSPeng Fan 	nvmem = devm_nvmem_register(dev, &priv->config);
137*22e9e6fcSPeng Fan 	if (IS_ERR(nvmem))
138*22e9e6fcSPeng Fan 		return PTR_ERR(nvmem);
139*22e9e6fcSPeng Fan 
140*22e9e6fcSPeng Fan 	return 0;
141*22e9e6fcSPeng Fan }
142*22e9e6fcSPeng Fan 
143*22e9e6fcSPeng Fan static const struct ocotp_devtype_data imx93_ocotp_data = {
144*22e9e6fcSPeng Fan 	.reg_off = 0x8000,
145*22e9e6fcSPeng Fan 	.reg_read = imx_ocotp_reg_read,
146*22e9e6fcSPeng Fan 	.size = 2048,
147*22e9e6fcSPeng Fan 	.num_entry = 6,
148*22e9e6fcSPeng Fan 	.entry = {
149*22e9e6fcSPeng Fan 		{ 0, 52, FUSE_FSB },
150*22e9e6fcSPeng Fan 		{ 63, 1, FUSE_ELE},
151*22e9e6fcSPeng Fan 		{ 128, 16, FUSE_ELE },
152*22e9e6fcSPeng Fan 		{ 182, 1, FUSE_ELE },
153*22e9e6fcSPeng Fan 		{ 188, 1, FUSE_ELE },
154*22e9e6fcSPeng Fan 		{ 312, 200, FUSE_FSB }
155*22e9e6fcSPeng Fan 	},
156*22e9e6fcSPeng Fan };
157*22e9e6fcSPeng Fan 
158*22e9e6fcSPeng Fan static const struct of_device_id imx_ele_ocotp_dt_ids[] = {
159*22e9e6fcSPeng Fan 	{ .compatible = "fsl,imx93-ocotp", .data = &imx93_ocotp_data, },
160*22e9e6fcSPeng Fan 	{},
161*22e9e6fcSPeng Fan };
162*22e9e6fcSPeng Fan MODULE_DEVICE_TABLE(of, imx_ele_ocotp_dt_ids);
163*22e9e6fcSPeng Fan 
164*22e9e6fcSPeng Fan static struct platform_driver imx_ele_ocotp_driver = {
165*22e9e6fcSPeng Fan 	.driver = {
166*22e9e6fcSPeng Fan 		.name = "imx_ele_ocotp",
167*22e9e6fcSPeng Fan 		.of_match_table = imx_ele_ocotp_dt_ids,
168*22e9e6fcSPeng Fan 	},
169*22e9e6fcSPeng Fan 	.probe = imx_ele_ocotp_probe,
170*22e9e6fcSPeng Fan };
171*22e9e6fcSPeng Fan module_platform_driver(imx_ele_ocotp_driver);
172*22e9e6fcSPeng Fan 
173*22e9e6fcSPeng Fan MODULE_DESCRIPTION("i.MX OCOTP/ELE driver");
174*22e9e6fcSPeng Fan MODULE_AUTHOR("Peng Fan <peng.fan@nxp.com>");
175*22e9e6fcSPeng Fan MODULE_LICENSE("GPL");
176