1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Freescale MXS On-Chip OTP driver
5 * Copyright (C) 2015 Stefan Wahren <stefan.wahren@i2se.com>
7 * Based on the driver from Huang Shijie and Christoph G. Baumann
10 #include <linux/delay.h>
11 #include <linux/device.h>
12 #include <linux/err.h>
14 #include <linux/module.h>
15 #include <linux/nvmem-provider.h>
17 #include <linux/platform_device.h>
18 #include <linux/property.h>
19 #include <linux/slab.h>
20 #include <linux/stmp_device.h>
22 /* OCOTP registers and bits */
24 #define BM_OCOTP_CTRL_RD_BANK_OPEN BIT(12)
25 #define BM_OCOTP_CTRL_ERROR BIT(9)
26 #define BM_OCOTP_CTRL_BUSY BIT(8)
28 #define OCOTP_TIMEOUT 10000
29 #define OCOTP_DATA_OFFSET 0x20
34 struct nvmem_device
*nvmem
;
37 static int mxs_ocotp_wait(struct mxs_ocotp
*otp
)
39 int timeout
= OCOTP_TIMEOUT
;
40 unsigned int status
= 0;
43 status
= readl(otp
->base
);
45 if (!(status
& (BM_OCOTP_CTRL_BUSY
| BM_OCOTP_CTRL_ERROR
)))
51 if (status
& BM_OCOTP_CTRL_BUSY
)
53 else if (status
& BM_OCOTP_CTRL_ERROR
)
59 static int mxs_ocotp_read(void *context
, unsigned int offset
,
60 void *val
, size_t bytes
)
62 struct mxs_ocotp
*otp
= context
;
66 ret
= clk_enable(otp
->clk
);
70 writel(BM_OCOTP_CTRL_ERROR
, otp
->base
+ STMP_OFFSET_REG_CLR
);
72 ret
= mxs_ocotp_wait(otp
);
76 /* open OCOTP banks for read */
77 writel(BM_OCOTP_CTRL_RD_BANK_OPEN
, otp
->base
+ STMP_OFFSET_REG_SET
);
79 /* approximately wait 33 hclk cycles */
82 ret
= mxs_ocotp_wait(otp
);
87 if ((offset
< OCOTP_DATA_OFFSET
) || (offset
% 16)) {
88 /* fill up non-data register */
91 *buf
++ = readl(otp
->base
+ offset
);
99 /* close banks for power saving */
100 writel(BM_OCOTP_CTRL_RD_BANK_OPEN
, otp
->base
+ STMP_OFFSET_REG_CLR
);
103 clk_disable(otp
->clk
);
108 static struct nvmem_config ocotp_config
= {
112 .reg_read
= mxs_ocotp_read
,
119 static const struct mxs_data imx23_data
= {
123 static const struct mxs_data imx28_data
= {
127 static const struct of_device_id mxs_ocotp_match
[] = {
128 { .compatible
= "fsl,imx23-ocotp", .data
= &imx23_data
},
129 { .compatible
= "fsl,imx28-ocotp", .data
= &imx28_data
},
132 MODULE_DEVICE_TABLE(of
, mxs_ocotp_match
);
134 static void mxs_ocotp_action(void *data
)
139 static int mxs_ocotp_probe(struct platform_device
*pdev
)
141 struct device
*dev
= &pdev
->dev
;
142 const struct mxs_data
*data
;
143 struct mxs_ocotp
*otp
;
146 data
= device_get_match_data(dev
);
150 otp
= devm_kzalloc(dev
, sizeof(*otp
), GFP_KERNEL
);
154 otp
->base
= devm_platform_ioremap_resource(pdev
, 0);
155 if (IS_ERR(otp
->base
))
156 return PTR_ERR(otp
->base
);
158 otp
->clk
= devm_clk_get(&pdev
->dev
, NULL
);
159 if (IS_ERR(otp
->clk
))
160 return PTR_ERR(otp
->clk
);
162 ret
= clk_prepare(otp
->clk
);
164 dev_err(dev
, "failed to prepare clk: %d\n", ret
);
168 ret
= devm_add_action_or_reset(&pdev
->dev
, mxs_ocotp_action
, otp
->clk
);
172 ocotp_config
.size
= data
->size
;
173 ocotp_config
.priv
= otp
;
174 ocotp_config
.dev
= dev
;
175 otp
->nvmem
= devm_nvmem_register(dev
, &ocotp_config
);
176 if (IS_ERR(otp
->nvmem
))
177 return PTR_ERR(otp
->nvmem
);
179 platform_set_drvdata(pdev
, otp
);
184 static struct platform_driver mxs_ocotp_driver
= {
185 .probe
= mxs_ocotp_probe
,
188 .of_match_table
= mxs_ocotp_match
,
192 module_platform_driver(mxs_ocotp_driver
);
193 MODULE_AUTHOR("Stefan Wahren <wahrenst@gmx.net");
194 MODULE_DESCRIPTION("driver for OCOTP in i.MX23/i.MX28");
195 MODULE_LICENSE("GPL v2");