1 // SPDX-License-Identifier: GPL-2.0-only
3 * i.MX6 OCOTP fusebox driver
7 * Based on the barebox ocotp driver,
9 * Orex Computed Radiography
11 * Write support based on the fsl_otp driver,
12 * Copyright (C) 2010-2013 Freescale Semiconductor, Inc
15 #include <linux/clk.h>
16 #include <linux/device.h>
18 #include <linux/module.h>
19 #include <linux/nvmem-provider.h>
21 #include <linux/of_device.h>
22 #include <linux/platform_device.h>
23 #include <linux/slab.h>
24 #include <linux/delay.h>
26 #define IMX_OCOTP_OFFSET_B0W0 0x400 /* Offset from base address of the
29 #define IMX_OCOTP_OFFSET_PER_WORD 0x10 /* Offset between the start addr
30 * of two consecutive OTP words.
33 #define IMX_OCOTP_ADDR_CTRL 0x0000
34 #define IMX_OCOTP_ADDR_CTRL_SET 0x0004
35 #define IMX_OCOTP_ADDR_CTRL_CLR 0x0008
36 #define IMX_OCOTP_ADDR_TIMING 0x0010
37 #define IMX_OCOTP_ADDR_DATA0 0x0020
38 #define IMX_OCOTP_ADDR_DATA1 0x0030
39 #define IMX_OCOTP_ADDR_DATA2 0x0040
40 #define IMX_OCOTP_ADDR_DATA3 0x0050
42 #define IMX_OCOTP_BM_CTRL_ADDR 0x000000FF
43 #define IMX_OCOTP_BM_CTRL_BUSY 0x00000100
44 #define IMX_OCOTP_BM_CTRL_ERROR 0x00000200
45 #define IMX_OCOTP_BM_CTRL_REL_SHADOWS 0x00000400
47 #define IMX_OCOTP_BM_CTRL_DEFAULT \
49 .bm_addr = IMX_OCOTP_BM_CTRL_ADDR, \
50 .bm_busy = IMX_OCOTP_BM_CTRL_BUSY, \
51 .bm_error = IMX_OCOTP_BM_CTRL_ERROR, \
52 .bm_rel_shadows = IMX_OCOTP_BM_CTRL_REL_SHADOWS,\
55 #define TIMING_STROBE_PROG_US 10 /* Min time to blow a fuse */
56 #define TIMING_STROBE_READ_NS 37 /* Min time before read */
57 #define TIMING_RELAX_NS 17
58 #define DEF_FSOURCE 1001 /* > 1000 ns */
59 #define DEF_STROBE_PROG 10000 /* IPG clocks */
60 #define IMX_OCOTP_WR_UNLOCK 0x3E770000
61 #define IMX_OCOTP_READ_LOCKED_VAL 0xBADABADA
63 static DEFINE_MUTEX(ocotp_mutex);
69 const struct ocotp_params *params;
70 struct nvmem_config *config;
73 struct ocotp_ctrl_reg {
82 unsigned int bank_address_words;
83 void (*set_timing)(struct ocotp_priv *priv);
84 struct ocotp_ctrl_reg ctrl;
87 static int imx_ocotp_wait_for_busy(struct ocotp_priv *priv, u32 flags)
91 u32 bm_ctrl_busy, bm_ctrl_error;
92 void __iomem *base = priv->base;
94 bm_ctrl_busy = priv->params->ctrl.bm_busy;
95 bm_ctrl_error = priv->params->ctrl.bm_error;
97 mask = bm_ctrl_busy | bm_ctrl_error | flags;
99 for (count = 10000; count >= 0; count--) {
100 c = readl(base + IMX_OCOTP_ADDR_CTRL);
107 /* HW_OCOTP_CTRL[ERROR] will be set under the following
109 * - A write is performed to a shadow register during a shadow
110 * reload (essentially, while HW_OCOTP_CTRL[RELOAD_SHADOWS] is
111 * set. In addition, the contents of the shadow register shall
113 * - A write is performed to a shadow register which has been
115 * - A read is performed to from a shadow register which has
117 * - A program is performed to a fuse word which has been locked
118 * - A read is performed to from a fuse word which has been read
121 if (c & bm_ctrl_error)
129 static void imx_ocotp_clr_err_if_set(struct ocotp_priv *priv)
131 u32 c, bm_ctrl_error;
132 void __iomem *base = priv->base;
134 bm_ctrl_error = priv->params->ctrl.bm_error;
136 c = readl(base + IMX_OCOTP_ADDR_CTRL);
137 if (!(c & bm_ctrl_error))
140 writel(bm_ctrl_error, base + IMX_OCOTP_ADDR_CTRL_CLR);
143 static int imx_ocotp_read(void *context, unsigned int offset,
144 void *val, size_t bytes)
146 struct ocotp_priv *priv = context;
155 if (count > (priv->params->nregs - index))
156 count = priv->params->nregs - index;
158 mutex_lock(&ocotp_mutex);
160 ret = clk_prepare_enable(priv->clk);
162 mutex_unlock(&ocotp_mutex);
163 dev_err(priv->dev, "failed to prepare/enable ocotp clk\n");
167 ret = imx_ocotp_wait_for_busy(priv, 0);
169 dev_err(priv->dev, "timeout during read setup\n");
173 for (i = index; i < (index + count); i++) {
174 *buf++ = readl(priv->base + IMX_OCOTP_OFFSET_B0W0 +
175 i * IMX_OCOTP_OFFSET_PER_WORD);
178 * For "read locked" registers 0xBADABADA will be returned and
179 * HW_OCOTP_CTRL[ERROR] will be set. It must be cleared by
180 * software before any new write, read or reload access can be
183 if (*(buf - 1) == IMX_OCOTP_READ_LOCKED_VAL)
184 imx_ocotp_clr_err_if_set(priv);
189 clk_disable_unprepare(priv->clk);
190 mutex_unlock(&ocotp_mutex);
194 static void imx_ocotp_set_imx6_timing(struct ocotp_priv *priv)
196 unsigned long clk_rate = 0;
197 unsigned long strobe_read, relax, strobe_prog;
201 * Program HW_OCOTP_TIMING[STROBE_PROG] and HW_OCOTP_TIMING[RELAX]
202 * fields with timing values to match the current frequency of the
203 * ipg_clk. OTP writes will work at maximum bus frequencies as long
204 * as the HW_OCOTP_TIMING parameters are set correctly.
206 * Note: there are minimum timings required to ensure an OTP fuse burns
207 * correctly that are independent of the ipg_clk. Those values are not
208 * formally documented anywhere however, working from the minimum
209 * timings given in u-boot we can say:
211 * - Minimum STROBE_PROG time is 10 microseconds. Intuitively 10
212 * microseconds feels about right as representative of a minimum time
213 * to physically burn out a fuse.
215 * - Minimum STROBE_READ i.e. the time to wait post OTP fuse burn before
216 * performing another read is 37 nanoseconds
218 * - Minimum RELAX timing is 17 nanoseconds. This final RELAX minimum
219 * timing is not entirely clear the documentation says "This
220 * count value specifies the time to add to all default timing
221 * parameters other than the Tpgm and Trd. It is given in number
222 * of ipg_clk periods." where Tpgm and Trd refer to STROBE_PROG
223 * and STROBE_READ respectively. What the other timing parameters
224 * are though, is not specified. Experience shows a zero RELAX
225 * value will mess up a re-load of the shadow registers post OTP
228 clk_rate = clk_get_rate(priv->clk);
230 relax = DIV_ROUND_UP(clk_rate * TIMING_RELAX_NS, 1000000000) - 1;
231 strobe_read = DIV_ROUND_UP(clk_rate * TIMING_STROBE_READ_NS,
233 strobe_read += 2 * (relax + 1) - 1;
234 strobe_prog = DIV_ROUND_CLOSEST(clk_rate * TIMING_STROBE_PROG_US,
236 strobe_prog += 2 * (relax + 1) - 1;
238 timing = readl(priv->base + IMX_OCOTP_ADDR_TIMING) & 0x0FC00000;
239 timing |= strobe_prog & 0x00000FFF;
240 timing |= (relax << 12) & 0x0000F000;
241 timing |= (strobe_read << 16) & 0x003F0000;
243 writel(timing, priv->base + IMX_OCOTP_ADDR_TIMING);
246 static void imx_ocotp_set_imx7_timing(struct ocotp_priv *priv)
248 unsigned long clk_rate = 0;
249 u64 fsource, strobe_prog;
252 /* i.MX 7Solo Applications Processor Reference Manual, Rev. 0.1
255 clk_rate = clk_get_rate(priv->clk);
256 fsource = DIV_ROUND_UP_ULL((u64)clk_rate * DEF_FSOURCE,
258 strobe_prog = DIV_ROUND_CLOSEST_ULL((u64)clk_rate * DEF_STROBE_PROG,
261 timing = strobe_prog & 0x00000FFF;
262 timing |= (fsource << 12) & 0x000FF000;
264 writel(timing, priv->base + IMX_OCOTP_ADDR_TIMING);
267 static int imx_ocotp_write(void *context, unsigned int offset, void *val,
270 struct ocotp_priv *priv = context;
278 /* allow only writing one complete OTP word at a time */
279 if ((bytes != priv->config->word_size) ||
280 (offset % priv->config->word_size))
283 mutex_lock(&ocotp_mutex);
285 ret = clk_prepare_enable(priv->clk);
287 mutex_unlock(&ocotp_mutex);
288 dev_err(priv->dev, "failed to prepare/enable ocotp clk\n");
292 /* Setup the write timing values */
293 priv->params->set_timing(priv);
296 * Check that HW_OCOTP_CTRL[BUSY] and HW_OCOTP_CTRL[ERROR] are clear.
297 * Overlapped accesses are not supported by the controller. Any pending
298 * write or reload must be completed before a write access can be
301 ret = imx_ocotp_wait_for_busy(priv, 0);
303 dev_err(priv->dev, "timeout during timing setup\n");
308 * Write the requested address to HW_OCOTP_CTRL[ADDR] and program the
309 * unlock code into HW_OCOTP_CTRL[WR_UNLOCK]. This must be programmed
310 * for each write access. The lock code is documented in the register
311 * description. Both the unlock code and address can be written in the
314 if (priv->params->bank_address_words != 0) {
316 * In banked/i.MX7 mode the OTP register bank goes into waddr
317 * see i.MX 7Solo Applications Processor Reference Manual, Rev.
318 * 0.1 section 6.4.3.1
320 offset = offset / priv->config->word_size;
321 waddr = offset / priv->params->bank_address_words;
322 word = offset & (priv->params->bank_address_words - 1);
325 * Non-banked i.MX6 mode.
326 * OTP write/read address specifies one of 128 word address
332 ctrl = readl(priv->base + IMX_OCOTP_ADDR_CTRL);
333 ctrl &= ~priv->params->ctrl.bm_addr;
334 ctrl |= waddr & priv->params->ctrl.bm_addr;
335 ctrl |= IMX_OCOTP_WR_UNLOCK;
337 writel(ctrl, priv->base + IMX_OCOTP_ADDR_CTRL);
340 * Write the data to the HW_OCOTP_DATA register. This will automatically
341 * set HW_OCOTP_CTRL[BUSY] and clear HW_OCOTP_CTRL[WR_UNLOCK]. To
342 * protect programming same OTP bit twice, before program OCOTP will
343 * automatically read fuse value in OTP and use read value to mask
344 * program data. The controller will use masked program data to program
345 * a 32-bit word in the OTP per the address in HW_OCOTP_CTRL[ADDR]. Bit
346 * fields with 1's will result in that OTP bit being programmed. Bit
347 * fields with 0's will be ignored. At the same time that the write is
348 * accepted, the controller makes an internal copy of
349 * HW_OCOTP_CTRL[ADDR] which cannot be updated until the next write
350 * sequence is initiated. This copy guarantees that erroneous writes to
351 * HW_OCOTP_CTRL[ADDR] will not affect an active write operation. It
352 * should also be noted that during the programming HW_OCOTP_DATA will
353 * shift right (with zero fill). This shifting is required to program
354 * the OTP serially. During the write operation, HW_OCOTP_DATA cannot be
356 * Note: on i.MX7 there are four data fields to write for banked write
357 * with the fuse blowing operation only taking place after data0
358 * has been written. This is why data0 must always be the last
361 if (priv->params->bank_address_words != 0) {
362 /* Banked/i.MX7 mode */
365 writel(0, priv->base + IMX_OCOTP_ADDR_DATA1);
366 writel(0, priv->base + IMX_OCOTP_ADDR_DATA2);
367 writel(0, priv->base + IMX_OCOTP_ADDR_DATA3);
368 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA0);
371 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA1);
372 writel(0, priv->base + IMX_OCOTP_ADDR_DATA2);
373 writel(0, priv->base + IMX_OCOTP_ADDR_DATA3);
374 writel(0, priv->base + IMX_OCOTP_ADDR_DATA0);
377 writel(0, priv->base + IMX_OCOTP_ADDR_DATA1);
378 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA2);
379 writel(0, priv->base + IMX_OCOTP_ADDR_DATA3);
380 writel(0, priv->base + IMX_OCOTP_ADDR_DATA0);
383 writel(0, priv->base + IMX_OCOTP_ADDR_DATA1);
384 writel(0, priv->base + IMX_OCOTP_ADDR_DATA2);
385 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA3);
386 writel(0, priv->base + IMX_OCOTP_ADDR_DATA0);
390 /* Non-banked i.MX6 mode */
391 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA0);
395 * Once complete, the controller will clear BUSY. A write request to a
396 * protected or locked region will result in no OTP access and no
397 * setting of HW_OCOTP_CTRL[BUSY]. In addition HW_OCOTP_CTRL[ERROR] will
398 * be set. It must be cleared by software before any new write access
401 ret = imx_ocotp_wait_for_busy(priv, 0);
404 dev_err(priv->dev, "failed write to locked region");
405 imx_ocotp_clr_err_if_set(priv);
407 dev_err(priv->dev, "timeout during data write\n");
413 * Write Postamble: Due to internal electrical characteristics of the
414 * OTP during writes, all OTP operations following a write must be
415 * separated by 2 us after the clearing of HW_OCOTP_CTRL_BUSY following
420 /* reload all shadow registers */
421 writel(priv->params->ctrl.bm_rel_shadows,
422 priv->base + IMX_OCOTP_ADDR_CTRL_SET);
423 ret = imx_ocotp_wait_for_busy(priv,
424 priv->params->ctrl.bm_rel_shadows);
426 dev_err(priv->dev, "timeout during shadow register reload\n");
431 clk_disable_unprepare(priv->clk);
432 mutex_unlock(&ocotp_mutex);
438 static struct nvmem_config imx_ocotp_nvmem_config = {
443 .reg_read = imx_ocotp_read,
444 .reg_write = imx_ocotp_write,
447 static const struct ocotp_params imx6q_params = {
449 .bank_address_words = 0,
450 .set_timing = imx_ocotp_set_imx6_timing,
451 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
454 static const struct ocotp_params imx6sl_params = {
456 .bank_address_words = 0,
457 .set_timing = imx_ocotp_set_imx6_timing,
458 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
461 static const struct ocotp_params imx6sll_params = {
463 .bank_address_words = 0,
464 .set_timing = imx_ocotp_set_imx6_timing,
465 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
468 static const struct ocotp_params imx6sx_params = {
470 .bank_address_words = 0,
471 .set_timing = imx_ocotp_set_imx6_timing,
472 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
475 static const struct ocotp_params imx6ul_params = {
477 .bank_address_words = 0,
478 .set_timing = imx_ocotp_set_imx6_timing,
479 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
482 static const struct ocotp_params imx6ull_params = {
484 .bank_address_words = 0,
485 .set_timing = imx_ocotp_set_imx6_timing,
486 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
489 static const struct ocotp_params imx7d_params = {
491 .bank_address_words = 4,
492 .set_timing = imx_ocotp_set_imx7_timing,
493 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
496 static const struct ocotp_params imx7ulp_params = {
498 .bank_address_words = 0,
499 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
502 static const struct ocotp_params imx8mq_params = {
504 .bank_address_words = 0,
505 .set_timing = imx_ocotp_set_imx6_timing,
506 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
509 static const struct ocotp_params imx8mm_params = {
511 .bank_address_words = 0,
512 .set_timing = imx_ocotp_set_imx6_timing,
513 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
516 static const struct ocotp_params imx8mn_params = {
518 .bank_address_words = 0,
519 .set_timing = imx_ocotp_set_imx6_timing,
520 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
523 static const struct of_device_id imx_ocotp_dt_ids[] = {
524 { .compatible = "fsl,imx6q-ocotp", .data = &imx6q_params },
525 { .compatible = "fsl,imx6sl-ocotp", .data = &imx6sl_params },
526 { .compatible = "fsl,imx6sx-ocotp", .data = &imx6sx_params },
527 { .compatible = "fsl,imx6ul-ocotp", .data = &imx6ul_params },
528 { .compatible = "fsl,imx6ull-ocotp", .data = &imx6ull_params },
529 { .compatible = "fsl,imx7d-ocotp", .data = &imx7d_params },
530 { .compatible = "fsl,imx6sll-ocotp", .data = &imx6sll_params },
531 { .compatible = "fsl,imx7ulp-ocotp", .data = &imx7ulp_params },
532 { .compatible = "fsl,imx8mq-ocotp", .data = &imx8mq_params },
533 { .compatible = "fsl,imx8mm-ocotp", .data = &imx8mm_params },
534 { .compatible = "fsl,imx8mn-ocotp", .data = &imx8mn_params },
537 MODULE_DEVICE_TABLE(of, imx_ocotp_dt_ids);
539 static int imx_ocotp_probe(struct platform_device *pdev)
541 struct device *dev = &pdev->dev;
542 struct ocotp_priv *priv;
543 struct nvmem_device *nvmem;
545 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
551 priv->base = devm_platform_ioremap_resource(pdev, 0);
552 if (IS_ERR(priv->base))
553 return PTR_ERR(priv->base);
555 priv->clk = devm_clk_get(dev, NULL);
556 if (IS_ERR(priv->clk))
557 return PTR_ERR(priv->clk);
559 priv->params = of_device_get_match_data(&pdev->dev);
560 imx_ocotp_nvmem_config.size = 4 * priv->params->nregs;
561 imx_ocotp_nvmem_config.dev = dev;
562 imx_ocotp_nvmem_config.priv = priv;
563 priv->config = &imx_ocotp_nvmem_config;
565 clk_prepare_enable(priv->clk);
566 imx_ocotp_clr_err_if_set(priv);
567 clk_disable_unprepare(priv->clk);
569 nvmem = devm_nvmem_register(dev, &imx_ocotp_nvmem_config);
571 return PTR_ERR_OR_ZERO(nvmem);
574 static struct platform_driver imx_ocotp_driver = {
575 .probe = imx_ocotp_probe,
578 .of_match_table = imx_ocotp_dt_ids,
581 module_platform_driver(imx_ocotp_driver);
584 MODULE_DESCRIPTION("i.MX6/i.MX7 OCOTP fuse box driver");
585 MODULE_LICENSE("GPL v2");