1 // SPDX-License-Identifier: GPL-2.0-only
3 * i.MX6 OCOTP fusebox driver
5 * Copyright (c) 2015 Pengutronix, Philipp Zabel <p.zabel@pengutronix.de>
9 * Based on the barebox ocotp driver,
10 * Copyright (c) 2010 Baruch Siach <baruch@tkos.co.il>,
11 * Orex Computed Radiography
13 * Write support based on the fsl_otp driver,
14 * Copyright (C) 2010-2013 Freescale Semiconductor, Inc
17 #include <linux/clk.h>
18 #include <linux/device.h>
20 #include <linux/module.h>
21 #include <linux/nvmem-provider.h>
23 #include <linux/of_device.h>
24 #include <linux/platform_device.h>
25 #include <linux/slab.h>
26 #include <linux/delay.h>
28 #define IMX_OCOTP_OFFSET_B0W0 0x400 /* Offset from base address of the
31 #define IMX_OCOTP_OFFSET_PER_WORD 0x10 /* Offset between the start addr
32 * of two consecutive OTP words.
35 #define IMX_OCOTP_ADDR_CTRL 0x0000
36 #define IMX_OCOTP_ADDR_CTRL_SET 0x0004
37 #define IMX_OCOTP_ADDR_CTRL_CLR 0x0008
38 #define IMX_OCOTP_ADDR_TIMING 0x0010
39 #define IMX_OCOTP_ADDR_DATA0 0x0020
40 #define IMX_OCOTP_ADDR_DATA1 0x0030
41 #define IMX_OCOTP_ADDR_DATA2 0x0040
42 #define IMX_OCOTP_ADDR_DATA3 0x0050
44 #define IMX_OCOTP_BM_CTRL_ADDR 0x000000FF
45 #define IMX_OCOTP_BM_CTRL_BUSY 0x00000100
46 #define IMX_OCOTP_BM_CTRL_ERROR 0x00000200
47 #define IMX_OCOTP_BM_CTRL_REL_SHADOWS 0x00000400
49 #define IMX_OCOTP_BM_CTRL_ADDR_8MP 0x000001FF
50 #define IMX_OCOTP_BM_CTRL_BUSY_8MP 0x00000200
51 #define IMX_OCOTP_BM_CTRL_ERROR_8MP 0x00000400
52 #define IMX_OCOTP_BM_CTRL_REL_SHADOWS_8MP 0x00000800
54 #define IMX_OCOTP_BM_CTRL_DEFAULT \
56 .bm_addr = IMX_OCOTP_BM_CTRL_ADDR, \
57 .bm_busy = IMX_OCOTP_BM_CTRL_BUSY, \
58 .bm_error = IMX_OCOTP_BM_CTRL_ERROR, \
59 .bm_rel_shadows = IMX_OCOTP_BM_CTRL_REL_SHADOWS,\
62 #define IMX_OCOTP_BM_CTRL_8MP \
64 .bm_addr = IMX_OCOTP_BM_CTRL_ADDR_8MP, \
65 .bm_busy = IMX_OCOTP_BM_CTRL_BUSY_8MP, \
66 .bm_error = IMX_OCOTP_BM_CTRL_ERROR_8MP, \
67 .bm_rel_shadows = IMX_OCOTP_BM_CTRL_REL_SHADOWS_8MP,\
70 #define TIMING_STROBE_PROG_US 10 /* Min time to blow a fuse */
71 #define TIMING_STROBE_READ_NS 37 /* Min time before read */
72 #define TIMING_RELAX_NS 17
73 #define DEF_FSOURCE 1001 /* > 1000 ns */
74 #define DEF_STROBE_PROG 10000 /* IPG clocks */
75 #define IMX_OCOTP_WR_UNLOCK 0x3E770000
76 #define IMX_OCOTP_READ_LOCKED_VAL 0xBADABADA
78 static DEFINE_MUTEX(ocotp_mutex);
84 const struct ocotp_params *params;
85 struct nvmem_config *config;
88 struct ocotp_ctrl_reg {
97 unsigned int bank_address_words;
98 void (*set_timing)(struct ocotp_priv *priv);
99 struct ocotp_ctrl_reg ctrl;
100 bool reverse_mac_address;
103 static int imx_ocotp_wait_for_busy(struct ocotp_priv *priv, u32 flags)
107 u32 bm_ctrl_busy, bm_ctrl_error;
108 void __iomem *base = priv->base;
110 bm_ctrl_busy = priv->params->ctrl.bm_busy;
111 bm_ctrl_error = priv->params->ctrl.bm_error;
113 mask = bm_ctrl_busy | bm_ctrl_error | flags;
115 for (count = 10000; count >= 0; count--) {
116 c = readl(base + IMX_OCOTP_ADDR_CTRL);
123 /* HW_OCOTP_CTRL[ERROR] will be set under the following
125 * - A write is performed to a shadow register during a shadow
126 * reload (essentially, while HW_OCOTP_CTRL[RELOAD_SHADOWS] is
127 * set. In addition, the contents of the shadow register shall
129 * - A write is performed to a shadow register which has been
131 * - A read is performed to from a shadow register which has
133 * - A program is performed to a fuse word which has been locked
134 * - A read is performed to from a fuse word which has been read
137 if (c & bm_ctrl_error)
145 static void imx_ocotp_clr_err_if_set(struct ocotp_priv *priv)
147 u32 c, bm_ctrl_error;
148 void __iomem *base = priv->base;
150 bm_ctrl_error = priv->params->ctrl.bm_error;
152 c = readl(base + IMX_OCOTP_ADDR_CTRL);
153 if (!(c & bm_ctrl_error))
156 writel(bm_ctrl_error, base + IMX_OCOTP_ADDR_CTRL_CLR);
159 static int imx_ocotp_read(void *context, unsigned int offset,
160 void *val, size_t bytes)
162 struct ocotp_priv *priv = context;
166 u32 index, num_bytes;
169 num_bytes = round_up((offset % 4) + bytes, 4);
170 count = num_bytes >> 2;
172 if (count > (priv->params->nregs - index))
173 count = priv->params->nregs - index;
175 p = kzalloc(num_bytes, GFP_KERNEL);
179 mutex_lock(&ocotp_mutex);
183 ret = clk_prepare_enable(priv->clk);
185 mutex_unlock(&ocotp_mutex);
186 dev_err(priv->dev, "failed to prepare/enable ocotp clk\n");
191 ret = imx_ocotp_wait_for_busy(priv, 0);
193 dev_err(priv->dev, "timeout during read setup\n");
197 for (i = index; i < (index + count); i++) {
198 *(u32 *)buf = readl(priv->base + IMX_OCOTP_OFFSET_B0W0 +
199 i * IMX_OCOTP_OFFSET_PER_WORD);
202 * For "read locked" registers 0xBADABADA will be returned and
203 * HW_OCOTP_CTRL[ERROR] will be set. It must be cleared by
204 * software before any new write, read or reload access can be
207 if (*((u32 *)buf) == IMX_OCOTP_READ_LOCKED_VAL)
208 imx_ocotp_clr_err_if_set(priv);
214 memcpy(val, &p[index], bytes);
217 clk_disable_unprepare(priv->clk);
218 mutex_unlock(&ocotp_mutex);
225 static int imx_ocotp_cell_pp(void *context, const char *id, unsigned int offset,
226 void *data, size_t bytes)
228 struct ocotp_priv *priv = context;
230 /* Deal with some post processing of nvmem cell data */
231 if (id && !strcmp(id, "mac-address")) {
232 if (priv->params->reverse_mac_address) {
236 for (i = 0; i < bytes/2; i++)
237 swap(buf[i], buf[bytes - i - 1]);
244 static void imx_ocotp_set_imx6_timing(struct ocotp_priv *priv)
246 unsigned long clk_rate;
247 unsigned long strobe_read, relax, strobe_prog;
251 * Program HW_OCOTP_TIMING[STROBE_PROG] and HW_OCOTP_TIMING[RELAX]
252 * fields with timing values to match the current frequency of the
253 * ipg_clk. OTP writes will work at maximum bus frequencies as long
254 * as the HW_OCOTP_TIMING parameters are set correctly.
256 * Note: there are minimum timings required to ensure an OTP fuse burns
257 * correctly that are independent of the ipg_clk. Those values are not
258 * formally documented anywhere however, working from the minimum
259 * timings given in u-boot we can say:
261 * - Minimum STROBE_PROG time is 10 microseconds. Intuitively 10
262 * microseconds feels about right as representative of a minimum time
263 * to physically burn out a fuse.
265 * - Minimum STROBE_READ i.e. the time to wait post OTP fuse burn before
266 * performing another read is 37 nanoseconds
268 * - Minimum RELAX timing is 17 nanoseconds. This final RELAX minimum
269 * timing is not entirely clear the documentation says "This
270 * count value specifies the time to add to all default timing
271 * parameters other than the Tpgm and Trd. It is given in number
272 * of ipg_clk periods." where Tpgm and Trd refer to STROBE_PROG
273 * and STROBE_READ respectively. What the other timing parameters
274 * are though, is not specified. Experience shows a zero RELAX
275 * value will mess up a re-load of the shadow registers post OTP
278 clk_rate = clk_get_rate(priv->clk);
280 relax = DIV_ROUND_UP(clk_rate * TIMING_RELAX_NS, 1000000000) - 1;
281 strobe_read = DIV_ROUND_UP(clk_rate * TIMING_STROBE_READ_NS,
283 strobe_read += 2 * (relax + 1) - 1;
284 strobe_prog = DIV_ROUND_CLOSEST(clk_rate * TIMING_STROBE_PROG_US,
286 strobe_prog += 2 * (relax + 1) - 1;
288 timing = readl(priv->base + IMX_OCOTP_ADDR_TIMING) & 0x0FC00000;
289 timing |= strobe_prog & 0x00000FFF;
290 timing |= (relax << 12) & 0x0000F000;
291 timing |= (strobe_read << 16) & 0x003F0000;
293 writel(timing, priv->base + IMX_OCOTP_ADDR_TIMING);
296 static void imx_ocotp_set_imx7_timing(struct ocotp_priv *priv)
298 unsigned long clk_rate;
299 u64 fsource, strobe_prog;
302 /* i.MX 7Solo Applications Processor Reference Manual, Rev. 0.1
305 clk_rate = clk_get_rate(priv->clk);
306 fsource = DIV_ROUND_UP_ULL((u64)clk_rate * DEF_FSOURCE,
308 strobe_prog = DIV_ROUND_CLOSEST_ULL((u64)clk_rate * DEF_STROBE_PROG,
311 timing = strobe_prog & 0x00000FFF;
312 timing |= (fsource << 12) & 0x000FF000;
314 writel(timing, priv->base + IMX_OCOTP_ADDR_TIMING);
317 static int imx_ocotp_write(void *context, unsigned int offset, void *val,
320 struct ocotp_priv *priv = context;
328 /* allow only writing one complete OTP word at a time */
329 if ((bytes != priv->config->word_size) ||
330 (offset % priv->config->word_size))
333 mutex_lock(&ocotp_mutex);
335 ret = clk_prepare_enable(priv->clk);
337 mutex_unlock(&ocotp_mutex);
338 dev_err(priv->dev, "failed to prepare/enable ocotp clk\n");
342 /* Setup the write timing values */
343 priv->params->set_timing(priv);
346 * Check that HW_OCOTP_CTRL[BUSY] and HW_OCOTP_CTRL[ERROR] are clear.
347 * Overlapped accesses are not supported by the controller. Any pending
348 * write or reload must be completed before a write access can be
351 ret = imx_ocotp_wait_for_busy(priv, 0);
353 dev_err(priv->dev, "timeout during timing setup\n");
358 * Write the requested address to HW_OCOTP_CTRL[ADDR] and program the
359 * unlock code into HW_OCOTP_CTRL[WR_UNLOCK]. This must be programmed
360 * for each write access. The lock code is documented in the register
361 * description. Both the unlock code and address can be written in the
364 if (priv->params->bank_address_words != 0) {
366 * In banked/i.MX7 mode the OTP register bank goes into waddr
367 * see i.MX 7Solo Applications Processor Reference Manual, Rev.
368 * 0.1 section 6.4.3.1
370 offset = offset / priv->config->word_size;
371 waddr = offset / priv->params->bank_address_words;
372 word = offset & (priv->params->bank_address_words - 1);
375 * Non-banked i.MX6 mode.
376 * OTP write/read address specifies one of 128 word address
382 ctrl = readl(priv->base + IMX_OCOTP_ADDR_CTRL);
383 ctrl &= ~priv->params->ctrl.bm_addr;
384 ctrl |= waddr & priv->params->ctrl.bm_addr;
385 ctrl |= IMX_OCOTP_WR_UNLOCK;
387 writel(ctrl, priv->base + IMX_OCOTP_ADDR_CTRL);
390 * Write the data to the HW_OCOTP_DATA register. This will automatically
391 * set HW_OCOTP_CTRL[BUSY] and clear HW_OCOTP_CTRL[WR_UNLOCK]. To
392 * protect programming same OTP bit twice, before program OCOTP will
393 * automatically read fuse value in OTP and use read value to mask
394 * program data. The controller will use masked program data to program
395 * a 32-bit word in the OTP per the address in HW_OCOTP_CTRL[ADDR]. Bit
396 * fields with 1's will result in that OTP bit being programmed. Bit
397 * fields with 0's will be ignored. At the same time that the write is
398 * accepted, the controller makes an internal copy of
399 * HW_OCOTP_CTRL[ADDR] which cannot be updated until the next write
400 * sequence is initiated. This copy guarantees that erroneous writes to
401 * HW_OCOTP_CTRL[ADDR] will not affect an active write operation. It
402 * should also be noted that during the programming HW_OCOTP_DATA will
403 * shift right (with zero fill). This shifting is required to program
404 * the OTP serially. During the write operation, HW_OCOTP_DATA cannot be
406 * Note: on i.MX7 there are four data fields to write for banked write
407 * with the fuse blowing operation only taking place after data0
408 * has been written. This is why data0 must always be the last
411 if (priv->params->bank_address_words != 0) {
412 /* Banked/i.MX7 mode */
415 writel(0, priv->base + IMX_OCOTP_ADDR_DATA1);
416 writel(0, priv->base + IMX_OCOTP_ADDR_DATA2);
417 writel(0, priv->base + IMX_OCOTP_ADDR_DATA3);
418 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA0);
421 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA1);
422 writel(0, priv->base + IMX_OCOTP_ADDR_DATA2);
423 writel(0, priv->base + IMX_OCOTP_ADDR_DATA3);
424 writel(0, priv->base + IMX_OCOTP_ADDR_DATA0);
427 writel(0, priv->base + IMX_OCOTP_ADDR_DATA1);
428 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA2);
429 writel(0, priv->base + IMX_OCOTP_ADDR_DATA3);
430 writel(0, priv->base + IMX_OCOTP_ADDR_DATA0);
433 writel(0, priv->base + IMX_OCOTP_ADDR_DATA1);
434 writel(0, priv->base + IMX_OCOTP_ADDR_DATA2);
435 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA3);
436 writel(0, priv->base + IMX_OCOTP_ADDR_DATA0);
440 /* Non-banked i.MX6 mode */
441 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA0);
445 * Once complete, the controller will clear BUSY. A write request to a
446 * protected or locked region will result in no OTP access and no
447 * setting of HW_OCOTP_CTRL[BUSY]. In addition HW_OCOTP_CTRL[ERROR] will
448 * be set. It must be cleared by software before any new write access
451 ret = imx_ocotp_wait_for_busy(priv, 0);
454 dev_err(priv->dev, "failed write to locked region");
455 imx_ocotp_clr_err_if_set(priv);
457 dev_err(priv->dev, "timeout during data write\n");
463 * Write Postamble: Due to internal electrical characteristics of the
464 * OTP during writes, all OTP operations following a write must be
465 * separated by 2 us after the clearing of HW_OCOTP_CTRL_BUSY following
470 /* reload all shadow registers */
471 writel(priv->params->ctrl.bm_rel_shadows,
472 priv->base + IMX_OCOTP_ADDR_CTRL_SET);
473 ret = imx_ocotp_wait_for_busy(priv,
474 priv->params->ctrl.bm_rel_shadows);
476 dev_err(priv->dev, "timeout during shadow register reload\n");
479 clk_disable_unprepare(priv->clk);
480 mutex_unlock(&ocotp_mutex);
481 return ret < 0 ? ret : bytes;
484 static struct nvmem_config imx_ocotp_nvmem_config = {
489 .reg_read = imx_ocotp_read,
490 .reg_write = imx_ocotp_write,
491 .cell_post_process = imx_ocotp_cell_pp,
494 static const struct ocotp_params imx6q_params = {
496 .bank_address_words = 0,
497 .set_timing = imx_ocotp_set_imx6_timing,
498 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
501 static const struct ocotp_params imx6sl_params = {
503 .bank_address_words = 0,
504 .set_timing = imx_ocotp_set_imx6_timing,
505 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
508 static const struct ocotp_params imx6sll_params = {
510 .bank_address_words = 0,
511 .set_timing = imx_ocotp_set_imx6_timing,
512 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
515 static const struct ocotp_params imx6sx_params = {
517 .bank_address_words = 0,
518 .set_timing = imx_ocotp_set_imx6_timing,
519 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
522 static const struct ocotp_params imx6ul_params = {
524 .bank_address_words = 0,
525 .set_timing = imx_ocotp_set_imx6_timing,
526 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
529 static const struct ocotp_params imx6ull_params = {
531 .bank_address_words = 0,
532 .set_timing = imx_ocotp_set_imx6_timing,
533 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
536 static const struct ocotp_params imx7d_params = {
538 .bank_address_words = 4,
539 .set_timing = imx_ocotp_set_imx7_timing,
540 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
543 static const struct ocotp_params imx7ulp_params = {
545 .bank_address_words = 0,
546 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
549 static const struct ocotp_params imx8mq_params = {
551 .bank_address_words = 0,
552 .set_timing = imx_ocotp_set_imx6_timing,
553 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
554 .reverse_mac_address = true,
557 static const struct ocotp_params imx8mm_params = {
559 .bank_address_words = 0,
560 .set_timing = imx_ocotp_set_imx6_timing,
561 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
562 .reverse_mac_address = true,
565 static const struct ocotp_params imx8mn_params = {
567 .bank_address_words = 0,
568 .set_timing = imx_ocotp_set_imx6_timing,
569 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
570 .reverse_mac_address = true,
573 static const struct ocotp_params imx8mp_params = {
575 .bank_address_words = 0,
576 .set_timing = imx_ocotp_set_imx6_timing,
577 .ctrl = IMX_OCOTP_BM_CTRL_8MP,
578 .reverse_mac_address = true,
581 static const struct of_device_id imx_ocotp_dt_ids[] = {
582 { .compatible = "fsl,imx6q-ocotp", .data = &imx6q_params },
583 { .compatible = "fsl,imx6sl-ocotp", .data = &imx6sl_params },
584 { .compatible = "fsl,imx6sx-ocotp", .data = &imx6sx_params },
585 { .compatible = "fsl,imx6ul-ocotp", .data = &imx6ul_params },
586 { .compatible = "fsl,imx6ull-ocotp", .data = &imx6ull_params },
587 { .compatible = "fsl,imx7d-ocotp", .data = &imx7d_params },
588 { .compatible = "fsl,imx6sll-ocotp", .data = &imx6sll_params },
589 { .compatible = "fsl,imx7ulp-ocotp", .data = &imx7ulp_params },
590 { .compatible = "fsl,imx8mq-ocotp", .data = &imx8mq_params },
591 { .compatible = "fsl,imx8mm-ocotp", .data = &imx8mm_params },
592 { .compatible = "fsl,imx8mn-ocotp", .data = &imx8mn_params },
593 { .compatible = "fsl,imx8mp-ocotp", .data = &imx8mp_params },
596 MODULE_DEVICE_TABLE(of, imx_ocotp_dt_ids);
598 static int imx_ocotp_probe(struct platform_device *pdev)
600 struct device *dev = &pdev->dev;
601 struct ocotp_priv *priv;
602 struct nvmem_device *nvmem;
604 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
610 priv->base = devm_platform_ioremap_resource(pdev, 0);
611 if (IS_ERR(priv->base))
612 return PTR_ERR(priv->base);
614 priv->clk = devm_clk_get(dev, NULL);
615 if (IS_ERR(priv->clk))
616 return PTR_ERR(priv->clk);
618 priv->params = of_device_get_match_data(&pdev->dev);
619 imx_ocotp_nvmem_config.size = 4 * priv->params->nregs;
620 imx_ocotp_nvmem_config.dev = dev;
621 imx_ocotp_nvmem_config.priv = priv;
622 priv->config = &imx_ocotp_nvmem_config;
624 clk_prepare_enable(priv->clk);
625 imx_ocotp_clr_err_if_set(priv);
626 clk_disable_unprepare(priv->clk);
628 nvmem = devm_nvmem_register(dev, &imx_ocotp_nvmem_config);
630 return PTR_ERR_OR_ZERO(nvmem);
633 static struct platform_driver imx_ocotp_driver = {
634 .probe = imx_ocotp_probe,
637 .of_match_table = imx_ocotp_dt_ids,
640 module_platform_driver(imx_ocotp_driver);
642 MODULE_AUTHOR("Philipp Zabel <p.zabel@pengutronix.de>");
643 MODULE_DESCRIPTION("i.MX6/i.MX7 OCOTP fuse box driver");
644 MODULE_LICENSE("GPL v2");