blob: 14284e866f26e9b166a00514155cc849326ce59c [file] [log] [blame]
Thomas Gleixneracee2e82019-06-04 10:10:53 +02001// SPDX-License-Identifier: GPL-2.0-only
Philipp Zabel3edba6b2015-09-30 13:55:47 +01002/*
3 * i.MX6 OCOTP fusebox driver
4 *
5 * Copyright (c) 2015 Pengutronix, Philipp Zabel <p.zabel@pengutronix.de>
6 *
Peng Fan3311bf12020-11-27 10:28:37 +00007 * Copyright 2019 NXP
8 *
Philipp Zabel3edba6b2015-09-30 13:55:47 +01009 * Based on the barebox ocotp driver,
10 * Copyright (c) 2010 Baruch Siach <baruch@tkos.co.il>,
11 * Orex Computed Radiography
12 *
Richard Leitner0642bac2017-03-31 13:44:55 +010013 * Write support based on the fsl_otp driver,
14 * Copyright (C) 2010-2013 Freescale Semiconductor, Inc
Philipp Zabel3edba6b2015-09-30 13:55:47 +010015 */
16
Peng Fandeb31972016-06-02 12:05:11 +010017#include <linux/clk.h>
Philipp Zabel3edba6b2015-09-30 13:55:47 +010018#include <linux/device.h>
19#include <linux/io.h>
20#include <linux/module.h>
21#include <linux/nvmem-provider.h>
22#include <linux/of.h>
23#include <linux/of_device.h>
24#include <linux/platform_device.h>
Philipp Zabel3edba6b2015-09-30 13:55:47 +010025#include <linux/slab.h>
Richard Leitner0642bac2017-03-31 13:44:55 +010026#include <linux/delay.h>
Philipp Zabel3edba6b2015-09-30 13:55:47 +010027
Richard Leitner9b665872017-03-31 13:44:54 +010028#define IMX_OCOTP_OFFSET_B0W0 0x400 /* Offset from base address of the
29 * OTP Bank0 Word0
30 */
31#define IMX_OCOTP_OFFSET_PER_WORD 0x10 /* Offset between the start addr
32 * of two consecutive OTP words.
33 */
Richard Leitner0642bac2017-03-31 13:44:55 +010034
Richard Leitner9b665872017-03-31 13:44:54 +010035#define IMX_OCOTP_ADDR_CTRL 0x0000
Richard Leitner0642bac2017-03-31 13:44:55 +010036#define IMX_OCOTP_ADDR_CTRL_SET 0x0004
Richard Leitner9b665872017-03-31 13:44:54 +010037#define IMX_OCOTP_ADDR_CTRL_CLR 0x0008
Richard Leitner0642bac2017-03-31 13:44:55 +010038#define IMX_OCOTP_ADDR_TIMING 0x0010
Bryan O'Donoghueffd91152017-10-24 10:54:29 +010039#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
Richard Leitner9b665872017-03-31 13:44:54 +010043
Bryan O'Donoghuec03bb442019-06-26 11:27:28 +010044#define IMX_OCOTP_BM_CTRL_ADDR 0x000000FF
Richard Leitner0642bac2017-03-31 13:44:55 +010045#define IMX_OCOTP_BM_CTRL_BUSY 0x00000100
Richard Leitner9b665872017-03-31 13:44:54 +010046#define IMX_OCOTP_BM_CTRL_ERROR 0x00000200
Richard Leitner0642bac2017-03-31 13:44:55 +010047#define IMX_OCOTP_BM_CTRL_REL_SHADOWS 0x00000400
Richard Leitner9b665872017-03-31 13:44:54 +010048
Peng Fanc3f4af82020-03-10 13:22:44 +000049#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
53
Peng Fan226c5122020-01-09 10:40:16 +000054#define IMX_OCOTP_BM_CTRL_DEFAULT \
55 { \
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,\
60 }
61
Peng Fanc3f4af82020-03-10 13:22:44 +000062#define IMX_OCOTP_BM_CTRL_8MP \
63 { \
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,\
68 }
69
Bryan O'Donoghue159dbaf2019-06-26 11:27:30 +010070#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
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +010073#define DEF_FSOURCE 1001 /* > 1000 ns */
74#define DEF_STROBE_PROG 10000 /* IPG clocks */
Richard Leitner0642bac2017-03-31 13:44:55 +010075#define IMX_OCOTP_WR_UNLOCK 0x3E770000
Richard Leitner9b665872017-03-31 13:44:54 +010076#define IMX_OCOTP_READ_LOCKED_VAL 0xBADABADA
77
Richard Leitner0642bac2017-03-31 13:44:55 +010078static DEFINE_MUTEX(ocotp_mutex);
79
Philipp Zabel3edba6b2015-09-30 13:55:47 +010080struct ocotp_priv {
81 struct device *dev;
Peng Fandeb31972016-06-02 12:05:11 +010082 struct clk *clk;
Philipp Zabel3edba6b2015-09-30 13:55:47 +010083 void __iomem *base;
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +010084 const struct ocotp_params *params;
Richard Leitner0642bac2017-03-31 13:44:55 +010085 struct nvmem_config *config;
Philipp Zabel3edba6b2015-09-30 13:55:47 +010086};
87
Peng Fan226c5122020-01-09 10:40:16 +000088struct ocotp_ctrl_reg {
89 u32 bm_addr;
90 u32 bm_busy;
91 u32 bm_error;
92 u32 bm_rel_shadows;
93};
94
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +010095struct ocotp_params {
96 unsigned int nregs;
97 unsigned int bank_address_words;
98 void (*set_timing)(struct ocotp_priv *priv);
Peng Fan226c5122020-01-09 10:40:16 +000099 struct ocotp_ctrl_reg ctrl;
Srinivas Kandagatlad0221a72021-10-13 14:19:57 +0100100 bool reverse_mac_address;
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100101};
102
Peng Fan226c5122020-01-09 10:40:16 +0000103static int imx_ocotp_wait_for_busy(struct ocotp_priv *priv, u32 flags)
Richard Leitner0642bac2017-03-31 13:44:55 +0100104{
105 int count;
106 u32 c, mask;
Peng Fan226c5122020-01-09 10:40:16 +0000107 u32 bm_ctrl_busy, bm_ctrl_error;
108 void __iomem *base = priv->base;
Richard Leitner0642bac2017-03-31 13:44:55 +0100109
Peng Fan226c5122020-01-09 10:40:16 +0000110 bm_ctrl_busy = priv->params->ctrl.bm_busy;
111 bm_ctrl_error = priv->params->ctrl.bm_error;
112
113 mask = bm_ctrl_busy | bm_ctrl_error | flags;
Richard Leitner0642bac2017-03-31 13:44:55 +0100114
115 for (count = 10000; count >= 0; count--) {
116 c = readl(base + IMX_OCOTP_ADDR_CTRL);
117 if (!(c & mask))
118 break;
119 cpu_relax();
120 }
121
122 if (count < 0) {
123 /* HW_OCOTP_CTRL[ERROR] will be set under the following
124 * conditions:
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
128 * not be updated.
129 * - A write is performed to a shadow register which has been
130 * locked.
131 * - A read is performed to from a shadow register which has
132 * been read locked.
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
135 * locked.
136 */
Peng Fan226c5122020-01-09 10:40:16 +0000137 if (c & bm_ctrl_error)
Richard Leitner0642bac2017-03-31 13:44:55 +0100138 return -EPERM;
139 return -ETIMEDOUT;
140 }
141
142 return 0;
143}
144
Peng Fan226c5122020-01-09 10:40:16 +0000145static void imx_ocotp_clr_err_if_set(struct ocotp_priv *priv)
Richard Leitner9b665872017-03-31 13:44:54 +0100146{
Peng Fan226c5122020-01-09 10:40:16 +0000147 u32 c, bm_ctrl_error;
148 void __iomem *base = priv->base;
149
150 bm_ctrl_error = priv->params->ctrl.bm_error;
Richard Leitner9b665872017-03-31 13:44:54 +0100151
152 c = readl(base + IMX_OCOTP_ADDR_CTRL);
Peng Fan226c5122020-01-09 10:40:16 +0000153 if (!(c & bm_ctrl_error))
Richard Leitner9b665872017-03-31 13:44:54 +0100154 return;
155
Peng Fan226c5122020-01-09 10:40:16 +0000156 writel(bm_ctrl_error, base + IMX_OCOTP_ADDR_CTRL_CLR);
Richard Leitner9b665872017-03-31 13:44:54 +0100157}
158
Srinivas Kandagatla33e5e292016-04-24 20:28:13 +0100159static int imx_ocotp_read(void *context, unsigned int offset,
160 void *val, size_t bytes)
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100161{
162 struct ocotp_priv *priv = context;
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100163 unsigned int count;
Peng Fan3311bf12020-11-27 10:28:37 +0000164 u8 *buf, *p;
Peng Fandeb31972016-06-02 12:05:11 +0100165 int i, ret;
Peng Fan3311bf12020-11-27 10:28:37 +0000166 u32 index, num_bytes;
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100167
168 index = offset >> 2;
Peng Fan3311bf12020-11-27 10:28:37 +0000169 num_bytes = round_up((offset % 4) + bytes, 4);
170 count = num_bytes >> 2;
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100171
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100172 if (count > (priv->params->nregs - index))
173 count = priv->params->nregs - index;
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100174
Peng Fan3311bf12020-11-27 10:28:37 +0000175 p = kzalloc(num_bytes, GFP_KERNEL);
176 if (!p)
177 return -ENOMEM;
178
Richard Leitner0642bac2017-03-31 13:44:55 +0100179 mutex_lock(&ocotp_mutex);
180
Peng Fan3311bf12020-11-27 10:28:37 +0000181 buf = p;
182
Peng Fandeb31972016-06-02 12:05:11 +0100183 ret = clk_prepare_enable(priv->clk);
184 if (ret < 0) {
Richard Leitner0642bac2017-03-31 13:44:55 +0100185 mutex_unlock(&ocotp_mutex);
Peng Fandeb31972016-06-02 12:05:11 +0100186 dev_err(priv->dev, "failed to prepare/enable ocotp clk\n");
Peng Fan3311bf12020-11-27 10:28:37 +0000187 kfree(p);
Peng Fandeb31972016-06-02 12:05:11 +0100188 return ret;
189 }
Richard Leitner9b665872017-03-31 13:44:54 +0100190
Peng Fan226c5122020-01-09 10:40:16 +0000191 ret = imx_ocotp_wait_for_busy(priv, 0);
Richard Leitner0642bac2017-03-31 13:44:55 +0100192 if (ret < 0) {
193 dev_err(priv->dev, "timeout during read setup\n");
194 goto read_end;
195 }
196
Richard Leitner9b665872017-03-31 13:44:54 +0100197 for (i = index; i < (index + count); i++) {
Peng Fan3311bf12020-11-27 10:28:37 +0000198 *(u32 *)buf = readl(priv->base + IMX_OCOTP_OFFSET_B0W0 +
Richard Leitner9b665872017-03-31 13:44:54 +0100199 i * IMX_OCOTP_OFFSET_PER_WORD);
200
201 /* 47.3.1.2
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
205 * issued
206 */
Peng Fan3311bf12020-11-27 10:28:37 +0000207 if (*((u32 *)buf) == IMX_OCOTP_READ_LOCKED_VAL)
Peng Fan226c5122020-01-09 10:40:16 +0000208 imx_ocotp_clr_err_if_set(priv);
Peng Fan3311bf12020-11-27 10:28:37 +0000209
210 buf += 4;
Richard Leitner9b665872017-03-31 13:44:54 +0100211 }
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100212
Peng Fan3311bf12020-11-27 10:28:37 +0000213 index = offset % 4;
214 memcpy(val, &p[index], bytes);
215
Richard Leitner0642bac2017-03-31 13:44:55 +0100216read_end:
Peng Fandeb31972016-06-02 12:05:11 +0100217 clk_disable_unprepare(priv->clk);
Richard Leitner0642bac2017-03-31 13:44:55 +0100218 mutex_unlock(&ocotp_mutex);
Peng Fan3311bf12020-11-27 10:28:37 +0000219
220 kfree(p);
221
Richard Leitner0642bac2017-03-31 13:44:55 +0100222 return ret;
223}
224
Srinivas Kandagatlad0221a72021-10-13 14:19:57 +0100225static int imx_ocotp_cell_pp(void *context, const char *id, unsigned int offset,
226 void *data, size_t bytes)
227{
228 struct ocotp_priv *priv = context;
229
230 /* Deal with some post processing of nvmem cell data */
231 if (id && !strcmp(id, "mac-address")) {
232 if (priv->params->reverse_mac_address) {
233 u8 *buf = data;
234 int i;
235
236 for (i = 0; i < bytes/2; i++)
237 swap(buf[i], buf[bytes - i - 1]);
238 }
239 }
240
241 return 0;
242}
243
Bryan O'Donoghueb50cb682017-10-24 10:54:30 +0100244static void imx_ocotp_set_imx6_timing(struct ocotp_priv *priv)
Richard Leitner0642bac2017-03-31 13:44:55 +0100245{
Anson Huang13d588b2020-03-10 13:22:53 +0000246 unsigned long clk_rate;
Richard Leitner0642bac2017-03-31 13:44:55 +0100247 unsigned long strobe_read, relax, strobe_prog;
Anson Huang13d588b2020-03-10 13:22:53 +0000248 u32 timing;
Richard Leitner0642bac2017-03-31 13:44:55 +0100249
250 /* 47.3.1.3.1
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.
Bryan O'Donoghue159dbaf2019-06-26 11:27:30 +0100255 *
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:
260 *
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.
264 *
265 * - Minimum STROBE_READ i.e. the time to wait post OTP fuse burn before
266 * performing another read is 37 nanoseconds
267 *
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
276 * burn.
Richard Leitner0642bac2017-03-31 13:44:55 +0100277 */
278 clk_rate = clk_get_rate(priv->clk);
279
Bryan O'Donoghue159dbaf2019-06-26 11:27:30 +0100280 relax = DIV_ROUND_UP(clk_rate * TIMING_RELAX_NS, 1000000000) - 1;
281 strobe_read = DIV_ROUND_UP(clk_rate * TIMING_STROBE_READ_NS,
282 1000000000);
283 strobe_read += 2 * (relax + 1) - 1;
284 strobe_prog = DIV_ROUND_CLOSEST(clk_rate * TIMING_STROBE_PROG_US,
285 1000000);
286 strobe_prog += 2 * (relax + 1) - 1;
Richard Leitner0642bac2017-03-31 13:44:55 +0100287
Bryan O'Donoghue0493c472019-06-26 11:27:29 +0100288 timing = readl(priv->base + IMX_OCOTP_ADDR_TIMING) & 0x0FC00000;
289 timing |= strobe_prog & 0x00000FFF;
Richard Leitner0642bac2017-03-31 13:44:55 +0100290 timing |= (relax << 12) & 0x0000F000;
291 timing |= (strobe_read << 16) & 0x003F0000;
292
293 writel(timing, priv->base + IMX_OCOTP_ADDR_TIMING);
Bryan O'Donoghueb50cb682017-10-24 10:54:30 +0100294}
295
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100296static void imx_ocotp_set_imx7_timing(struct ocotp_priv *priv)
297{
Anson Huang13d588b2020-03-10 13:22:53 +0000298 unsigned long clk_rate;
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100299 u64 fsource, strobe_prog;
Anson Huang13d588b2020-03-10 13:22:53 +0000300 u32 timing;
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100301
302 /* i.MX 7Solo Applications Processor Reference Manual, Rev. 0.1
303 * 6.4.3.3
304 */
305 clk_rate = clk_get_rate(priv->clk);
306 fsource = DIV_ROUND_UP_ULL((u64)clk_rate * DEF_FSOURCE,
307 NSEC_PER_SEC) + 1;
308 strobe_prog = DIV_ROUND_CLOSEST_ULL((u64)clk_rate * DEF_STROBE_PROG,
309 NSEC_PER_SEC) + 1;
310
311 timing = strobe_prog & 0x00000FFF;
312 timing |= (fsource << 12) & 0x000FF000;
313
314 writel(timing, priv->base + IMX_OCOTP_ADDR_TIMING);
315}
316
Bryan O'Donoghueb50cb682017-10-24 10:54:30 +0100317static int imx_ocotp_write(void *context, unsigned int offset, void *val,
318 size_t bytes)
319{
320 struct ocotp_priv *priv = context;
321 u32 *buf = val;
322 int ret;
323
324 u32 ctrl;
325 u8 waddr;
326 u8 word = 0;
327
328 /* allow only writing one complete OTP word at a time */
329 if ((bytes != priv->config->word_size) ||
330 (offset % priv->config->word_size))
331 return -EINVAL;
332
333 mutex_lock(&ocotp_mutex);
334
335 ret = clk_prepare_enable(priv->clk);
336 if (ret < 0) {
337 mutex_unlock(&ocotp_mutex);
338 dev_err(priv->dev, "failed to prepare/enable ocotp clk\n");
339 return ret;
340 }
341
342 /* Setup the write timing values */
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100343 priv->params->set_timing(priv);
Richard Leitner0642bac2017-03-31 13:44:55 +0100344
345 /* 47.3.1.3.2
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
349 * requested.
350 */
Peng Fan226c5122020-01-09 10:40:16 +0000351 ret = imx_ocotp_wait_for_busy(priv, 0);
Richard Leitner0642bac2017-03-31 13:44:55 +0100352 if (ret < 0) {
353 dev_err(priv->dev, "timeout during timing setup\n");
354 goto write_end;
355 }
356
357 /* 47.3.1.3.3
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
362 * same operation.
363 */
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100364 if (priv->params->bank_address_words != 0) {
365 /*
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
369 */
370 offset = offset / priv->config->word_size;
371 waddr = offset / priv->params->bank_address_words;
372 word = offset & (priv->params->bank_address_words - 1);
373 } else {
374 /*
375 * Non-banked i.MX6 mode.
376 * OTP write/read address specifies one of 128 word address
377 * locations
378 */
379 waddr = offset / 4;
380 }
Richard Leitner0642bac2017-03-31 13:44:55 +0100381
382 ctrl = readl(priv->base + IMX_OCOTP_ADDR_CTRL);
Peng Fan226c5122020-01-09 10:40:16 +0000383 ctrl &= ~priv->params->ctrl.bm_addr;
384 ctrl |= waddr & priv->params->ctrl.bm_addr;
Richard Leitner0642bac2017-03-31 13:44:55 +0100385 ctrl |= IMX_OCOTP_WR_UNLOCK;
386
387 writel(ctrl, priv->base + IMX_OCOTP_ADDR_CTRL);
388
389 /* 47.3.1.3.4
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
405 * modified.
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100406 * 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
409 * register written.
Richard Leitner0642bac2017-03-31 13:44:55 +0100410 */
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100411 if (priv->params->bank_address_words != 0) {
412 /* Banked/i.MX7 mode */
413 switch (word) {
414 case 0:
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);
419 break;
420 case 1:
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);
425 break;
426 case 2:
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);
431 break;
432 case 3:
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);
437 break;
438 }
439 } else {
440 /* Non-banked i.MX6 mode */
441 writel(*buf, priv->base + IMX_OCOTP_ADDR_DATA0);
442 }
Richard Leitner0642bac2017-03-31 13:44:55 +0100443
444 /* 47.4.1.4.5
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
449 * can be issued.
450 */
Peng Fan226c5122020-01-09 10:40:16 +0000451 ret = imx_ocotp_wait_for_busy(priv, 0);
Richard Leitner0642bac2017-03-31 13:44:55 +0100452 if (ret < 0) {
453 if (ret == -EPERM) {
454 dev_err(priv->dev, "failed write to locked region");
Peng Fan226c5122020-01-09 10:40:16 +0000455 imx_ocotp_clr_err_if_set(priv);
Richard Leitner0642bac2017-03-31 13:44:55 +0100456 } else {
457 dev_err(priv->dev, "timeout during data write\n");
458 }
459 goto write_end;
460 }
461
462 /* 47.3.1.4
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
466 * the write.
467 */
468 udelay(2);
469
470 /* reload all shadow registers */
Peng Fan226c5122020-01-09 10:40:16 +0000471 writel(priv->params->ctrl.bm_rel_shadows,
Richard Leitner0642bac2017-03-31 13:44:55 +0100472 priv->base + IMX_OCOTP_ADDR_CTRL_SET);
Peng Fan226c5122020-01-09 10:40:16 +0000473 ret = imx_ocotp_wait_for_busy(priv,
474 priv->params->ctrl.bm_rel_shadows);
Anson Huang0e2abff2020-05-11 15:50:40 +0100475 if (ret < 0)
Richard Leitner0642bac2017-03-31 13:44:55 +0100476 dev_err(priv->dev, "timeout during shadow register reload\n");
Richard Leitner0642bac2017-03-31 13:44:55 +0100477
478write_end:
479 clk_disable_unprepare(priv->clk);
480 mutex_unlock(&ocotp_mutex);
Anson Huang0e2abff2020-05-11 15:50:40 +0100481 return ret < 0 ? ret : bytes;
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100482}
483
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100484static struct nvmem_config imx_ocotp_nvmem_config = {
485 .name = "imx-ocotp",
Richard Leitner0642bac2017-03-31 13:44:55 +0100486 .read_only = false,
Srinivas Kandagatla33e5e292016-04-24 20:28:13 +0100487 .word_size = 4,
Peng Fan3311bf12020-11-27 10:28:37 +0000488 .stride = 1,
Srinivas Kandagatla33e5e292016-04-24 20:28:13 +0100489 .reg_read = imx_ocotp_read,
Richard Leitner0642bac2017-03-31 13:44:55 +0100490 .reg_write = imx_ocotp_write,
Srinivas Kandagatlad0221a72021-10-13 14:19:57 +0100491 .cell_post_process = imx_ocotp_cell_pp,
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100492};
493
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100494static const struct ocotp_params imx6q_params = {
495 .nregs = 128,
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100496 .bank_address_words = 0,
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100497 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000498 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100499};
500
501static const struct ocotp_params imx6sl_params = {
502 .nregs = 64,
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100503 .bank_address_words = 0,
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100504 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000505 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100506};
507
Anson Huang6da27822018-07-11 11:20:43 +0100508static const struct ocotp_params imx6sll_params = {
509 .nregs = 128,
510 .bank_address_words = 0,
511 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000512 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Anson Huang6da27822018-07-11 11:20:43 +0100513};
514
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100515static const struct ocotp_params imx6sx_params = {
516 .nregs = 128,
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100517 .bank_address_words = 0,
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100518 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000519 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100520};
521
522static const struct ocotp_params imx6ul_params = {
523 .nregs = 128,
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100524 .bank_address_words = 0,
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100525 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000526 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100527};
528
Stefan Wahrenffbc34b2019-01-28 15:54:59 +0000529static const struct ocotp_params imx6ull_params = {
530 .nregs = 64,
531 .bank_address_words = 0,
532 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000533 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Stefan Wahrenffbc34b2019-01-28 15:54:59 +0000534};
535
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100536static const struct ocotp_params imx7d_params = {
537 .nregs = 64,
Bryan O'Donoghueffd91152017-10-24 10:54:29 +0100538 .bank_address_words = 4,
Bryan O'Donoghue828ae7a42017-10-24 10:54:31 +0100539 .set_timing = imx_ocotp_set_imx7_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000540 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100541};
542
Anson Huangc8b63dd2019-01-28 15:54:57 +0000543static const struct ocotp_params imx7ulp_params = {
544 .nregs = 256,
545 .bank_address_words = 0,
Peng Fan226c5122020-01-09 10:40:16 +0000546 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Anson Huangc8b63dd2019-01-28 15:54:57 +0000547};
548
Lucas Stach38e7b6e2019-04-13 11:32:47 +0100549static const struct ocotp_params imx8mq_params = {
550 .nregs = 256,
Leonard Crestez5a1c1722019-06-26 11:27:33 +0100551 .bank_address_words = 0,
552 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000553 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Srinivas Kandagatlad0221a72021-10-13 14:19:57 +0100554 .reverse_mac_address = true,
Lucas Stach38e7b6e2019-04-13 11:32:47 +0100555};
556
Bryan O'Donoghue4112c8532019-06-26 11:27:31 +0100557static const struct ocotp_params imx8mm_params = {
558 .nregs = 256,
559 .bank_address_words = 0,
560 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000561 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Srinivas Kandagatlad0221a72021-10-13 14:19:57 +0100562 .reverse_mac_address = true,
Bryan O'Donoghue4112c8532019-06-26 11:27:31 +0100563};
564
Anson Huangd93b5d42019-08-18 10:33:40 +0100565static const struct ocotp_params imx8mn_params = {
566 .nregs = 256,
567 .bank_address_words = 0,
568 .set_timing = imx_ocotp_set_imx6_timing,
Peng Fan226c5122020-01-09 10:40:16 +0000569 .ctrl = IMX_OCOTP_BM_CTRL_DEFAULT,
Srinivas Kandagatlad0221a72021-10-13 14:19:57 +0100570 .reverse_mac_address = true,
Anson Huangd93b5d42019-08-18 10:33:40 +0100571};
572
Peng Fanc3f4af82020-03-10 13:22:44 +0000573static const struct ocotp_params imx8mp_params = {
574 .nregs = 384,
575 .bank_address_words = 0,
576 .set_timing = imx_ocotp_set_imx6_timing,
577 .ctrl = IMX_OCOTP_BM_CTRL_8MP,
Srinivas Kandagatlad0221a72021-10-13 14:19:57 +0100578 .reverse_mac_address = true,
Peng Fanc3f4af82020-03-10 13:22:44 +0000579};
580
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100581static const struct of_device_id imx_ocotp_dt_ids[] = {
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100582 { .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 },
Stefan Wahrenffbc34b2019-01-28 15:54:59 +0000586 { .compatible = "fsl,imx6ull-ocotp", .data = &imx6ull_params },
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100587 { .compatible = "fsl,imx7d-ocotp", .data = &imx7d_params },
Anson Huang6da27822018-07-11 11:20:43 +0100588 { .compatible = "fsl,imx6sll-ocotp", .data = &imx6sll_params },
Anson Huangc8b63dd2019-01-28 15:54:57 +0000589 { .compatible = "fsl,imx7ulp-ocotp", .data = &imx7ulp_params },
Lucas Stach38e7b6e2019-04-13 11:32:47 +0100590 { .compatible = "fsl,imx8mq-ocotp", .data = &imx8mq_params },
Bryan O'Donoghue4112c8532019-06-26 11:27:31 +0100591 { .compatible = "fsl,imx8mm-ocotp", .data = &imx8mm_params },
Anson Huangd93b5d42019-08-18 10:33:40 +0100592 { .compatible = "fsl,imx8mn-ocotp", .data = &imx8mn_params },
Peng Fanc3f4af82020-03-10 13:22:44 +0000593 { .compatible = "fsl,imx8mp-ocotp", .data = &imx8mp_params },
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100594 { },
595};
596MODULE_DEVICE_TABLE(of, imx_ocotp_dt_ids);
597
598static int imx_ocotp_probe(struct platform_device *pdev)
599{
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100600 struct device *dev = &pdev->dev;
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100601 struct ocotp_priv *priv;
602 struct nvmem_device *nvmem;
603
604 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
605 if (!priv)
606 return -ENOMEM;
607
Richard Leitner4cefb742017-03-31 13:44:49 +0100608 priv->dev = dev;
609
Anson Huang3b26cd82019-04-13 11:32:59 +0100610 priv->base = devm_platform_ioremap_resource(pdev, 0);
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100611 if (IS_ERR(priv->base))
612 return PTR_ERR(priv->base);
613
Richard Leitner4cefb742017-03-31 13:44:49 +0100614 priv->clk = devm_clk_get(dev, NULL);
Peng Fandeb31972016-06-02 12:05:11 +0100615 if (IS_ERR(priv->clk))
616 return PTR_ERR(priv->clk);
617
Bryan O'Donoghuee20d2b22017-10-24 10:54:28 +0100618 priv->params = of_device_get_match_data(&pdev->dev);
619 imx_ocotp_nvmem_config.size = 4 * priv->params->nregs;
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100620 imx_ocotp_nvmem_config.dev = dev;
Srinivas Kandagatla33e5e292016-04-24 20:28:13 +0100621 imx_ocotp_nvmem_config.priv = priv;
Richard Leitner0642bac2017-03-31 13:44:55 +0100622 priv->config = &imx_ocotp_nvmem_config;
Richard Leitner0642bac2017-03-31 13:44:55 +0100623
Peng Fan226c5122020-01-09 10:40:16 +0000624 clk_prepare_enable(priv->clk);
625 imx_ocotp_clr_err_if_set(priv);
626 clk_disable_unprepare(priv->clk);
627
628 nvmem = devm_nvmem_register(dev, &imx_ocotp_nvmem_config);
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100629
Andrey Smirnova8302742018-03-09 14:46:59 +0000630 return PTR_ERR_OR_ZERO(nvmem);
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100631}
632
633static struct platform_driver imx_ocotp_driver = {
634 .probe = imx_ocotp_probe,
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100635 .driver = {
636 .name = "imx_ocotp",
637 .of_match_table = imx_ocotp_dt_ids,
638 },
639};
640module_platform_driver(imx_ocotp_driver);
641
642MODULE_AUTHOR("Philipp Zabel <p.zabel@pengutronix.de>");
Bryan O'Donoghueaef9a4d2017-10-24 10:54:33 +0100643MODULE_DESCRIPTION("i.MX6/i.MX7 OCOTP fuse box driver");
Philipp Zabel3edba6b2015-09-30 13:55:47 +0100644MODULE_LICENSE("GPL v2");