1 // SPDX-License-Identifier: GPL-2.0
3 // Mediatek SPI-NOR controller driver
7 // Some parts are based on drivers/spi/spi-mtk-nor.c of linux version
12 #include <dm/device.h>
13 #include <dm/device_compat.h>
14 #include <dm/devres.h>
15 #include <dm/pinctrl.h>
16 #include <linux/bitops.h>
17 #include <linux/completion.h>
19 #include <linux/iopoll.h>
24 #include <linux/dma-mapping.h>
26 #define DRIVER_NAME "mtk-spi-nor"
28 #define MTK_NOR_REG_CMD 0x00
29 #define MTK_NOR_CMD_WRSR BIT(5)
30 #define MTK_NOR_CMD_WRITE BIT(4)
31 #define MTK_NOR_CMD_PROGRAM BIT(2)
32 #define MTK_NOR_CMD_RDSR BIT(1)
33 #define MTK_NOR_CMD_READ BIT(0)
34 #define MTK_NOR_CMD_MASK GENMASK(5, 0)
36 #define MTK_NOR_REG_PRG_CNT 0x04
37 #define MTK_NOR_REG_RDSR 0x08
38 #define MTK_NOR_REG_RDATA 0x0c
40 #define MTK_NOR_REG_RADR0 0x10
41 #define MTK_NOR_REG_RADR(n) (MTK_NOR_REG_RADR0 + 4 * (n))
42 #define MTK_NOR_REG_RADR3 0xc8
44 #define MTK_NOR_REG_WDATA 0x1c
46 #define MTK_NOR_REG_PRGDATA0 0x20
47 #define MTK_NOR_REG_PRGDATA(n) (MTK_NOR_REG_PRGDATA0 + 4 * (n))
48 #define MTK_NOR_REG_PRGDATA_MAX 5
50 #define MTK_NOR_REG_SHIFT0 0x38
51 #define MTK_NOR_REG_SHIFT(n) (MTK_NOR_REG_SHIFT0 + 4 * (n))
52 #define MTK_NOR_REG_SHIFT_MAX 9
54 #define MTK_NOR_REG_CFG1 0x60
55 #define MTK_NOR_FAST_READ BIT(0)
57 #define MTK_NOR_REG_CFG2 0x64
58 #define MTK_NOR_WR_CUSTOM_OP_EN BIT(4)
59 #define MTK_NOR_WR_BUF_EN BIT(0)
61 #define MTK_NOR_REG_PP_DATA 0x98
63 #define MTK_NOR_REG_IRQ_STAT 0xa8
64 #define MTK_NOR_REG_IRQ_EN 0xac
65 #define MTK_NOR_IRQ_DMA BIT(7)
66 #define MTK_NOR_IRQ_WRSR BIT(5)
67 #define MTK_NOR_IRQ_MASK GENMASK(7, 0)
69 #define MTK_NOR_REG_CFG3 0xb4
70 #define MTK_NOR_DISABLE_WREN BIT(7)
71 #define MTK_NOR_DISABLE_SR_POLL BIT(5)
73 #define MTK_NOR_REG_WP 0xc4
74 #define MTK_NOR_ENABLE_SF_CMD 0x30
76 #define MTK_NOR_REG_BUSCFG 0xcc
77 #define MTK_NOR_4B_ADDR BIT(4)
78 #define MTK_NOR_QUAD_ADDR BIT(3)
79 #define MTK_NOR_QUAD_READ BIT(2)
80 #define MTK_NOR_DUAL_ADDR BIT(1)
81 #define MTK_NOR_DUAL_READ BIT(0)
82 #define MTK_NOR_BUS_MODE_MASK GENMASK(4, 0)
84 #define MTK_NOR_REG_DMA_CTL 0x718
85 #define MTK_NOR_DMA_START BIT(0)
87 #define MTK_NOR_REG_DMA_FADR 0x71c
88 #define MTK_NOR_REG_DMA_DADR 0x720
89 #define MTK_NOR_REG_DMA_END_DADR 0x724
91 #define MTK_NOR_PRG_MAX_SIZE 6
92 // Reading DMA src/dst addresses have to be 16-byte aligned
93 #define MTK_NOR_DMA_ALIGN 16
94 #define MTK_NOR_DMA_ALIGN_MASK (MTK_NOR_DMA_ALIGN - 1)
95 // and we allocate a bounce buffer if destination address isn't aligned.
96 #define MTK_NOR_BOUNCE_BUF_SIZE PAGE_SIZE
98 // Buffered page program can do one 128-byte transfer
99 #define MTK_NOR_PP_SIZE 128
101 #define CLK_TO_US(priv, clkcnt) DIV_ROUND_UP(clkcnt, (priv)->spi_freq / 1000000)
103 #define MTK_NOR_UNLOCK_ALL 0x0
105 struct mtk_snor_priv {
111 unsigned int spi_freq;
115 static inline void mtk_snor_rmw(struct mtk_snor_priv *priv, u32 reg, u32 set,
118 u32 val = readl(priv->base + reg);
122 writel(val, priv->base + reg);
125 static inline int mtk_snor_cmd_exec(struct mtk_snor_priv *priv, u32 cmd,
128 unsigned long long delay = CLK_TO_US(priv, clk);
132 writel(cmd, priv->base + MTK_NOR_REG_CMD);
133 delay = (delay + 1) * 200;
134 ret = readl_poll_timeout(priv->base + MTK_NOR_REG_CMD, reg,
135 !(reg & cmd), delay);
137 dev_err(priv->dev, "command %u timeout.\n", cmd);
141 static void mtk_snor_set_addr(struct mtk_snor_priv *priv,
142 const struct spi_mem_op *op)
144 u32 addr = op->addr.val;
147 for (i = 0; i < 3; i++) {
148 writeb(addr & 0xff, priv->base + MTK_NOR_REG_RADR(i));
151 if (op->addr.nbytes == 4) {
152 writeb(addr & 0xff, priv->base + MTK_NOR_REG_RADR3);
153 mtk_snor_rmw(priv, MTK_NOR_REG_BUSCFG, MTK_NOR_4B_ADDR, 0);
155 mtk_snor_rmw(priv, MTK_NOR_REG_BUSCFG, 0, MTK_NOR_4B_ADDR);
159 static bool need_bounce(const struct spi_mem_op *op)
161 return ((uintptr_t)op->data.buf.in & MTK_NOR_DMA_ALIGN_MASK);
164 static int mtk_snor_adjust_op_size(struct spi_slave *slave,
165 struct spi_mem_op *op)
167 if (!op->data.nbytes)
170 if (op->addr.nbytes == 3 || op->addr.nbytes == 4) {
171 if (op->data.dir == SPI_MEM_DATA_IN) { //&&
172 // limit size to prevent timeout calculation overflow
173 if (op->data.nbytes > 0x400000)
174 op->data.nbytes = 0x400000;
175 if (op->addr.val & MTK_NOR_DMA_ALIGN_MASK ||
176 op->data.nbytes < MTK_NOR_DMA_ALIGN)
178 else if (!need_bounce(op))
179 op->data.nbytes &= ~MTK_NOR_DMA_ALIGN_MASK;
180 else if (op->data.nbytes > MTK_NOR_BOUNCE_BUF_SIZE)
181 op->data.nbytes = MTK_NOR_BOUNCE_BUF_SIZE;
183 } else if (op->data.dir == SPI_MEM_DATA_OUT) {
184 if (op->data.nbytes >= MTK_NOR_PP_SIZE)
185 op->data.nbytes = MTK_NOR_PP_SIZE;
195 static bool mtk_snor_supports_op(struct spi_slave *slave,
196 const struct spi_mem_op *op)
198 /* This controller only supports 1-1-1 write mode */
199 if (op->data.dir == SPI_MEM_DATA_OUT &&
200 (op->cmd.buswidth != 1 || op->data.buswidth != 1))
206 static void mtk_snor_setup_bus(struct mtk_snor_priv *priv,
207 const struct spi_mem_op *op)
211 if (op->addr.nbytes == 4)
212 reg |= MTK_NOR_4B_ADDR;
214 if (op->data.buswidth == 4) {
215 reg |= MTK_NOR_QUAD_READ;
216 writeb(op->cmd.opcode, priv->base + MTK_NOR_REG_PRGDATA(4));
217 if (op->addr.buswidth == 4)
218 reg |= MTK_NOR_QUAD_ADDR;
219 } else if (op->data.buswidth == 2) {
220 reg |= MTK_NOR_DUAL_READ;
221 writeb(op->cmd.opcode, priv->base + MTK_NOR_REG_PRGDATA(3));
222 if (op->addr.buswidth == 2)
223 reg |= MTK_NOR_DUAL_ADDR;
225 if (op->cmd.opcode == 0x0b)
226 mtk_snor_rmw(priv, MTK_NOR_REG_CFG1, MTK_NOR_FAST_READ,
229 mtk_snor_rmw(priv, MTK_NOR_REG_CFG1, 0,
232 mtk_snor_rmw(priv, MTK_NOR_REG_BUSCFG, reg, MTK_NOR_BUS_MODE_MASK);
235 static int mtk_snor_dma_exec(struct mtk_snor_priv *priv, u32 from,
236 unsigned int length, dma_addr_t dma_addr)
242 writel(from, priv->base + MTK_NOR_REG_DMA_FADR);
243 writel(dma_addr, priv->base + MTK_NOR_REG_DMA_DADR);
244 writel(dma_addr + length, priv->base + MTK_NOR_REG_DMA_END_DADR);
246 mtk_snor_rmw(priv, MTK_NOR_REG_DMA_CTL, MTK_NOR_DMA_START, 0);
248 delay = CLK_TO_US(priv, (length + 5) * BITS_PER_BYTE);
250 delay = (delay + 1) * 100;
251 ret = readl_poll_timeout(priv->base + MTK_NOR_REG_DMA_CTL, reg,
252 !(reg & MTK_NOR_DMA_START), delay);
255 dev_err(priv->dev, "dma read timeout.\n");
260 static int mtk_snor_read_bounce(struct mtk_snor_priv *priv,
261 const struct spi_mem_op *op)
266 if (op->data.nbytes & MTK_NOR_DMA_ALIGN_MASK)
267 rdlen = (op->data.nbytes + MTK_NOR_DMA_ALIGN) &
268 ~MTK_NOR_DMA_ALIGN_MASK;
270 rdlen = op->data.nbytes;
272 ret = mtk_snor_dma_exec(priv, op->addr.val, rdlen,
273 (dma_addr_t)priv->buffer);
276 memcpy(op->data.buf.in, priv->buffer, op->data.nbytes);
281 static int mtk_snor_read_dma(struct mtk_snor_priv *priv,
282 const struct spi_mem_op *op)
288 return mtk_snor_read_bounce(priv, op);
290 dma_addr = dma_map_single(op->data.buf.in, op->data.nbytes,
293 if (dma_mapping_error(priv->dev, dma_addr))
296 ret = mtk_snor_dma_exec(priv, op->addr.val, op->data.nbytes, dma_addr);
298 dma_unmap_single(dma_addr, op->data.nbytes, DMA_FROM_DEVICE);
303 static int mtk_snor_read_pio(struct mtk_snor_priv *priv,
304 const struct spi_mem_op *op)
306 u8 *buf = op->data.buf.in;
309 ret = mtk_snor_cmd_exec(priv, MTK_NOR_CMD_READ, 6 * BITS_PER_BYTE);
311 buf[0] = readb(priv->base + MTK_NOR_REG_RDATA);
315 static int mtk_snor_write_buffer_enable(struct mtk_snor_priv *priv)
323 val = readl(priv->base + MTK_NOR_REG_CFG2);
324 writel(val | MTK_NOR_WR_BUF_EN, priv->base + MTK_NOR_REG_CFG2);
325 ret = readl_poll_timeout(priv->base + MTK_NOR_REG_CFG2, val,
326 val & MTK_NOR_WR_BUF_EN, 10000);
328 priv->wbuf_en = true;
332 static int mtk_snor_write_buffer_disable(struct mtk_snor_priv *priv)
339 val = readl(priv->base + MTK_NOR_REG_CFG2);
340 writel(val & ~MTK_NOR_WR_BUF_EN, priv->base + MTK_NOR_REG_CFG2);
341 ret = readl_poll_timeout(priv->base + MTK_NOR_REG_CFG2, val,
342 !(val & MTK_NOR_WR_BUF_EN), 10000);
344 priv->wbuf_en = false;
348 static int mtk_snor_pp_buffered(struct mtk_snor_priv *priv,
349 const struct spi_mem_op *op)
351 const u8 *buf = op->data.buf.out;
355 ret = mtk_snor_write_buffer_enable(priv);
359 for (i = 0; i < op->data.nbytes; i += 4) {
360 val = buf[i + 3] << 24 | buf[i + 2] << 16 | buf[i + 1] << 8 |
362 writel(val, priv->base + MTK_NOR_REG_PP_DATA);
364 mtk_snor_cmd_exec(priv, MTK_NOR_CMD_WRITE,
365 (op->data.nbytes + 5) * BITS_PER_BYTE);
366 return mtk_snor_write_buffer_disable(priv);
369 static int mtk_snor_pp_unbuffered(struct mtk_snor_priv *priv,
370 const struct spi_mem_op *op)
372 const u8 *buf = op->data.buf.out;
375 ret = mtk_snor_write_buffer_disable(priv);
378 writeb(buf[0], priv->base + MTK_NOR_REG_WDATA);
379 return mtk_snor_cmd_exec(priv, MTK_NOR_CMD_WRITE, 6 * BITS_PER_BYTE);
382 static int mtk_snor_cmd_program(struct mtk_snor_priv *priv,
383 const struct spi_mem_op *op)
387 int reg_offset = MTK_NOR_REG_PRGDATA_MAX;
391 u8 *rxbuf = op->data.buf.in;
394 tx_len = 1 + op->addr.nbytes + op->dummy.nbytes;
395 trx_len = tx_len + op->data.nbytes;
396 if (op->data.dir == SPI_MEM_DATA_OUT)
397 tx_len += op->data.nbytes;
399 txbuf = kmalloc_array(tx_len, sizeof(u8), GFP_KERNEL);
400 memset(txbuf, 0x0, tx_len * sizeof(u8));
402 /* Join all bytes to be transferred */
403 txbuf[tx_cnt] = op->cmd.opcode;
405 for (i = op->addr.nbytes; i > 0; i--, tx_cnt++)
406 txbuf[tx_cnt] = ((u8 *)&op->addr.val)[i - 1];
407 for (i = op->dummy.nbytes; i > 0; i--, tx_cnt++)
409 if (op->data.dir == SPI_MEM_DATA_OUT)
410 for (i = op->data.nbytes; i > 0; i--, tx_cnt++)
411 txbuf[tx_cnt] = ((u8 *)op->data.buf.out)[i - 1];
413 for (i = MTK_NOR_REG_PRGDATA_MAX; i >= 0; i--)
414 writeb(0, priv->base + MTK_NOR_REG_PRGDATA(i));
416 for (i = 0; i < tx_len; i++, reg_offset--)
417 writeb(txbuf[i], priv->base + MTK_NOR_REG_PRGDATA(reg_offset));
421 writel(trx_len * BITS_PER_BYTE, priv->base + MTK_NOR_REG_PRG_CNT);
423 mtk_snor_cmd_exec(priv, MTK_NOR_CMD_PROGRAM, trx_len * BITS_PER_BYTE);
425 reg_offset = op->data.nbytes - 1;
426 for (i = 0; i < op->data.nbytes; i++, reg_offset--) {
427 reg = priv->base + MTK_NOR_REG_SHIFT(reg_offset);
428 rxbuf[i] = readb(reg);
434 static int mtk_snor_exec_op(struct spi_slave *slave,
435 const struct spi_mem_op *op)
437 struct udevice *bus = dev_get_parent(slave->dev);
438 struct mtk_snor_priv *priv = dev_get_priv(bus);
441 if (op->data.dir == SPI_MEM_NO_DATA || op->addr.nbytes == 0) {
442 return mtk_snor_cmd_program(priv, op);
443 } else if (op->data.dir == SPI_MEM_DATA_OUT) {
444 mtk_snor_set_addr(priv, op);
445 writeb(op->cmd.opcode, priv->base + MTK_NOR_REG_PRGDATA0);
446 if (op->data.nbytes == MTK_NOR_PP_SIZE)
447 return mtk_snor_pp_buffered(priv, op);
448 return mtk_snor_pp_unbuffered(priv, op);
449 } else if (op->data.dir == SPI_MEM_DATA_IN) {
450 ret = mtk_snor_write_buffer_disable(priv);
453 mtk_snor_setup_bus(priv, op);
454 if (op->data.nbytes == 1) {
455 mtk_snor_set_addr(priv, op);
456 return mtk_snor_read_pio(priv, op);
458 return mtk_snor_read_dma(priv, op);
465 static int mtk_snor_probe(struct udevice *bus)
467 struct mtk_snor_priv *priv = dev_get_priv(bus);
472 priv->base = devfdt_get_addr_ptr(bus);
476 ret = clk_get_by_name(bus, "spi", &priv->spi_clk);
480 ret = clk_get_by_name(bus, "sf", &priv->ctlr_clk);
484 buffer = devm_kmalloc(bus, MTK_NOR_BOUNCE_BUF_SIZE + MTK_NOR_DMA_ALIGN,
488 if ((ulong)buffer & MTK_NOR_DMA_ALIGN_MASK)
489 buffer = (u8 *)(((ulong)buffer + MTK_NOR_DMA_ALIGN) &
490 ~MTK_NOR_DMA_ALIGN_MASK);
491 priv->buffer = buffer;
493 clk_enable(&priv->spi_clk);
494 clk_enable(&priv->ctlr_clk);
496 priv->spi_freq = clk_get_rate(&priv->spi_clk);
497 printf("spi frequency: %d Hz\n", priv->spi_freq);
499 /* With this setting, we issue one command at a time to
500 * accommodate to SPI-mem framework.
502 writel(MTK_NOR_ENABLE_SF_CMD, priv->base + MTK_NOR_REG_WP);
503 mtk_snor_rmw(priv, MTK_NOR_REG_CFG2, MTK_NOR_WR_CUSTOM_OP_EN, 0);
504 mtk_snor_rmw(priv, MTK_NOR_REG_CFG3,
505 MTK_NOR_DISABLE_WREN | MTK_NOR_DISABLE_SR_POLL, 0);
507 /* Unlock all blocks using write status command.
508 * SPI-MEM hasn't implemented unlock procedure on MXIC devices.
509 * We may remove this later.
511 writel(2 * BITS_PER_BYTE, priv->base + MTK_NOR_REG_PRG_CNT);
512 writel(MTK_NOR_UNLOCK_ALL, priv->base + MTK_NOR_REG_PRGDATA(5));
513 writel(MTK_NOR_IRQ_WRSR, priv->base + MTK_NOR_REG_IRQ_EN);
514 writel(MTK_NOR_CMD_WRSR, priv->base + MTK_NOR_REG_CMD);
515 ret = readl_poll_timeout(priv->base + MTK_NOR_REG_IRQ_STAT, reg,
516 !(reg & MTK_NOR_IRQ_WRSR),
517 ((3 * BITS_PER_BYTE) + 1) * 200);
522 static int mtk_snor_set_speed(struct udevice *bus, uint speed)
524 /* MTK's SNOR controller does not have a bus clock divider.
525 * We setup maximum bus clock in dts.
531 static int mtk_snor_set_mode(struct udevice *bus, uint mode)
533 /* We set up mode later for each transmission.
538 static const struct spi_controller_mem_ops mtk_snor_mem_ops = {
539 .adjust_op_size = mtk_snor_adjust_op_size,
540 .supports_op = mtk_snor_supports_op,
541 .exec_op = mtk_snor_exec_op
544 static const struct dm_spi_ops mtk_snor_ops = {
545 .mem_ops = &mtk_snor_mem_ops,
546 .set_speed = mtk_snor_set_speed,
547 .set_mode = mtk_snor_set_mode,
550 static const struct udevice_id mtk_snor_ids[] = {
551 { .compatible = "mediatek,mtk-snor" },
555 U_BOOT_DRIVER(mtk_snor) = {
558 .of_match = mtk_snor_ids,
559 .ops = &mtk_snor_ops,
560 .priv_auto = sizeof(struct mtk_snor_priv),
561 .probe = mtk_snor_probe,