1 // SPDX-License-Identifier: GPL-2.0
3 // Copyright (C) 2018 Macronix International Co., Ltd.
6 // Mason Yang <masonccyang@mxic.com.tw>
7 // zhengxunli <zhengxunli@mxic.com.tw>
8 // Boris Brezillon <boris.brezillon@bootlin.com>
11 #include <linux/clk.h>
13 #include <linux/iopoll.h>
14 #include <linux/module.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/spi/spi.h>
18 #include <linux/spi/spi-mem.h>
21 #define HC_CFG_IF_CFG(x) ((x) << 27)
22 #define HC_CFG_DUAL_SLAVE BIT(31)
23 #define HC_CFG_INDIVIDUAL BIT(30)
24 #define HC_CFG_NIO(x) (((x) / 4) << 27)
25 #define HC_CFG_TYPE(s, t) ((t) << (23 + ((s) * 2)))
26 #define HC_CFG_TYPE_SPI_NOR 0
27 #define HC_CFG_TYPE_SPI_NAND 1
28 #define HC_CFG_TYPE_SPI_RAM 2
29 #define HC_CFG_TYPE_RAW_NAND 3
30 #define HC_CFG_SLV_ACT(x) ((x) << 21)
31 #define HC_CFG_CLK_PH_EN BIT(20)
32 #define HC_CFG_CLK_POL_INV BIT(19)
33 #define HC_CFG_BIG_ENDIAN BIT(18)
34 #define HC_CFG_DATA_PASS BIT(17)
35 #define HC_CFG_IDLE_SIO_LVL(x) ((x) << 16)
36 #define HC_CFG_MAN_START_EN BIT(3)
37 #define HC_CFG_MAN_START BIT(2)
38 #define HC_CFG_MAN_CS_EN BIT(1)
39 #define HC_CFG_MAN_CS_ASSERT BIT(0)
42 #define INT_STS_EN 0x8
43 #define INT_SIG_EN 0xc
44 #define INT_STS_ALL GENMASK(31, 0)
45 #define INT_RDY_PIN BIT(26)
46 #define INT_RDY_SR BIT(25)
47 #define INT_LNR_SUSP BIT(24)
48 #define INT_ECC_ERR BIT(17)
49 #define INT_CRC_ERR BIT(16)
50 #define INT_LWR_DIS BIT(12)
51 #define INT_LRD_DIS BIT(11)
52 #define INT_SDMA_INT BIT(10)
53 #define INT_DMA_FINISH BIT(9)
54 #define INT_RX_NOT_FULL BIT(3)
55 #define INT_RX_NOT_EMPTY BIT(2)
56 #define INT_TX_NOT_FULL BIT(1)
57 #define INT_TX_EMPTY BIT(0)
60 #define HC_EN_BIT BIT(0)
62 #define TXD(x) (0x14 + ((x) * 4))
65 #define SS_CTRL(s) (0x30 + ((s) * 4))
69 #define OP_READ BIT(23)
70 #define OP_DUMMY_CYC(x) ((x) << 17)
71 #define OP_ADDR_BYTES(x) ((x) << 14)
72 #define OP_CMD_BYTES(x) (((x) - 1) << 13)
73 #define OP_OCTA_CRC_EN BIT(12)
74 #define OP_DQS_EN BIT(11)
75 #define OP_ENHC_EN BIT(10)
76 #define OP_PREAMBLE_EN BIT(9)
77 #define OP_DATA_DDR BIT(8)
78 #define OP_DATA_BUSW(x) ((x) << 6)
79 #define OP_ADDR_DDR BIT(5)
80 #define OP_ADDR_BUSW(x) ((x) << 3)
81 #define OP_CMD_DDR BIT(2)
82 #define OP_CMD_BUSW(x) (x)
89 #define OCTA_CRC_IN_EN(s) BIT(3 + ((s) * 16))
90 #define OCTA_CRC_CHUNK(s, x) ((fls((x) / 32)) << (1 + ((s) * 16)))
91 #define OCTA_CRC_OUT_EN(s) BIT(0 + ((s) * 16))
93 #define ONFI_DIN_CNT(s) (0x3c + (s))
98 #define LMODE_EN BIT(31)
99 #define LMODE_SLV_ACT(x) ((x) << 21)
100 #define LMODE_CMD1(x) ((x) << 8)
101 #define LMODE_CMD0(x) (x)
103 #define LRD_ADDR 0x4c
104 #define LWR_ADDR 0x88
105 #define LRD_RANGE 0x50
106 #define LWR_RANGE 0x8c
108 #define AXI_SLV_ADDR 0x54
110 #define DMAC_RD_CFG 0x58
111 #define DMAC_WR_CFG 0x94
112 #define DMAC_CFG_PERIPH_EN BIT(31)
113 #define DMAC_CFG_ALLFLUSH_EN BIT(30)
114 #define DMAC_CFG_LASTFLUSH_EN BIT(29)
115 #define DMAC_CFG_QE(x) (((x) + 1) << 16)
116 #define DMAC_CFG_BURST_LEN(x) (((x) + 1) << 12)
117 #define DMAC_CFG_BURST_SZ(x) ((x) << 8)
118 #define DMAC_CFG_DIR_READ BIT(1)
119 #define DMAC_CFG_START BIT(0)
121 #define DMAC_RD_CNT 0x5c
122 #define DMAC_WR_CNT 0x98
124 #define SDMA_ADDR 0x60
126 #define DMAM_CFG 0x64
127 #define DMAM_CFG_START BIT(31)
128 #define DMAM_CFG_CONT BIT(30)
129 #define DMAM_CFG_SDMA_GAP(x) (fls((x) / 8192) << 2)
130 #define DMAM_CFG_DIR_READ BIT(1)
131 #define DMAM_CFG_EN BIT(0)
133 #define DMAM_CNT 0x68
135 #define LNR_TIMER_TH 0x6c
137 #define RDM_CFG0 0x78
138 #define RDM_CFG0_POLY(x) (x)
140 #define RDM_CFG1 0x7c
141 #define RDM_CFG1_RDM_EN BIT(31)
142 #define RDM_CFG1_SEED(x) (x)
144 #define LWR_SUSP_CTRL 0x90
145 #define LWR_SUSP_CTRL_EN BIT(31)
147 #define DMAS_CTRL 0x9c
148 #define DMAS_CTRL_EN BIT(31)
149 #define DMAS_CTRL_DIR_READ BIT(30)
151 #define DATA_STROB 0xa0
152 #define DATA_STROB_EDO_EN BIT(2)
153 #define DATA_STROB_INV_POL BIT(1)
154 #define DATA_STROB_DELAY_2CYC BIT(0)
156 #define IDLY_CODE(x) (0xa4 + ((x) * 4))
157 #define IDLY_CODE_VAL(x, v) ((v) << (((x) % 4) * 8))
160 #define GPIO_PT(x) BIT(3 + ((x) * 16))
161 #define GPIO_RESET(x) BIT(2 + ((x) * 16))
162 #define GPIO_HOLDB(x) BIT(1 + ((x) * 16))
163 #define GPIO_WPB(x) BIT((x) * 16)
167 #define HW_TEST(x) (0xe0 + ((x) * 4))
171 struct clk *send_clk;
172 struct clk *send_dly_clk;
177 static int mxic_spi_clk_enable(struct mxic_spi *mxic)
181 ret = clk_prepare_enable(mxic->send_clk);
185 ret = clk_prepare_enable(mxic->send_dly_clk);
187 goto err_send_dly_clk;
192 clk_disable_unprepare(mxic->send_clk);
197 static void mxic_spi_clk_disable(struct mxic_spi *mxic)
199 clk_disable_unprepare(mxic->send_clk);
200 clk_disable_unprepare(mxic->send_dly_clk);
203 static void mxic_spi_set_input_delay_dqs(struct mxic_spi *mxic, u8 idly_code)
205 writel(IDLY_CODE_VAL(0, idly_code) |
206 IDLY_CODE_VAL(1, idly_code) |
207 IDLY_CODE_VAL(2, idly_code) |
208 IDLY_CODE_VAL(3, idly_code),
209 mxic->regs + IDLY_CODE(0));
210 writel(IDLY_CODE_VAL(4, idly_code) |
211 IDLY_CODE_VAL(5, idly_code) |
212 IDLY_CODE_VAL(6, idly_code) |
213 IDLY_CODE_VAL(7, idly_code),
214 mxic->regs + IDLY_CODE(1));
217 static int mxic_spi_clk_setup(struct mxic_spi *mxic, unsigned long freq)
221 ret = clk_set_rate(mxic->send_clk, freq);
225 ret = clk_set_rate(mxic->send_dly_clk, freq);
230 * A constant delay range from 0x0 ~ 0x1F for input delay,
231 * the unit is 78 ps, the max input delay is 2.418 ns.
233 mxic_spi_set_input_delay_dqs(mxic, 0xf);
236 * Phase degree = 360 * freq * output-delay
237 * where output-delay is a constant value 1 ns in FPGA.
239 * Get Phase degree = 360 * freq * 1 ns
240 * = 360 * freq * 1 sec / 1000000000
241 * = 9 * freq / 25000000
243 ret = clk_set_phase(mxic->send_dly_clk, 9 * freq / 25000000);
250 static int mxic_spi_set_freq(struct mxic_spi *mxic, unsigned long freq)
254 if (mxic->cur_speed_hz == freq)
257 mxic_spi_clk_disable(mxic);
258 ret = mxic_spi_clk_setup(mxic, freq);
262 ret = mxic_spi_clk_enable(mxic);
266 mxic->cur_speed_hz = freq;
271 static void mxic_spi_hw_init(struct mxic_spi *mxic)
273 writel(0, mxic->regs + DATA_STROB);
274 writel(INT_STS_ALL, mxic->regs + INT_STS_EN);
275 writel(0, mxic->regs + HC_EN);
276 writel(0, mxic->regs + LRD_CFG);
277 writel(0, mxic->regs + LRD_CTRL);
278 writel(HC_CFG_NIO(1) | HC_CFG_TYPE(0, HC_CFG_TYPE_SPI_NOR) |
279 HC_CFG_SLV_ACT(0) | HC_CFG_MAN_CS_EN | HC_CFG_IDLE_SIO_LVL(1),
280 mxic->regs + HC_CFG);
283 static int mxic_spi_data_xfer(struct mxic_spi *mxic, const void *txbuf,
284 void *rxbuf, unsigned int len)
286 unsigned int pos = 0;
289 unsigned int nbytes = len - pos;
290 u32 data = 0xffffffff;
298 memcpy(&data, txbuf + pos, nbytes);
300 ret = readl_poll_timeout(mxic->regs + INT_STS, sts,
301 sts & INT_TX_EMPTY, 0, USEC_PER_SEC);
305 writel(data, mxic->regs + TXD(nbytes % 4));
307 ret = readl_poll_timeout(mxic->regs + INT_STS, sts,
308 sts & INT_TX_EMPTY, 0, USEC_PER_SEC);
312 ret = readl_poll_timeout(mxic->regs + INT_STS, sts,
313 sts & INT_RX_NOT_EMPTY, 0,
318 data = readl(mxic->regs + RXD);
320 data >>= (8 * (4 - nbytes));
321 memcpy(rxbuf + pos, &data, nbytes);
323 WARN_ON(readl(mxic->regs + INT_STS) & INT_RX_NOT_EMPTY);
331 static bool mxic_spi_mem_supports_op(struct spi_mem *mem,
332 const struct spi_mem_op *op)
334 if (op->data.buswidth > 4 || op->addr.buswidth > 4 ||
335 op->dummy.buswidth > 4 || op->cmd.buswidth > 4)
338 if (op->data.nbytes && op->dummy.nbytes &&
339 op->data.buswidth != op->dummy.buswidth)
342 if (op->addr.nbytes > 7)
345 return spi_mem_default_supports_op(mem, op);
348 static int mxic_spi_mem_exec_op(struct spi_mem *mem,
349 const struct spi_mem_op *op)
351 struct mxic_spi *mxic = spi_master_get_devdata(mem->spi->master);
355 u8 opcode = op->cmd.opcode;
357 ret = mxic_spi_set_freq(mxic, mem->spi->max_speed_hz);
361 if (mem->spi->mode & (SPI_TX_QUAD | SPI_RX_QUAD))
363 else if (mem->spi->mode & (SPI_TX_DUAL | SPI_RX_DUAL))
366 writel(HC_CFG_NIO(nio) |
367 HC_CFG_TYPE(mem->spi->chip_select, HC_CFG_TYPE_SPI_NOR) |
368 HC_CFG_SLV_ACT(mem->spi->chip_select) | HC_CFG_IDLE_SIO_LVL(1) |
370 mxic->regs + HC_CFG);
371 writel(HC_EN_BIT, mxic->regs + HC_EN);
373 ss_ctrl = OP_CMD_BYTES(1) | OP_CMD_BUSW(fls(op->cmd.buswidth) - 1);
376 ss_ctrl |= OP_ADDR_BYTES(op->addr.nbytes) |
377 OP_ADDR_BUSW(fls(op->addr.buswidth) - 1);
379 if (op->dummy.nbytes)
380 ss_ctrl |= OP_DUMMY_CYC(op->dummy.nbytes);
382 if (op->data.nbytes) {
383 ss_ctrl |= OP_DATA_BUSW(fls(op->data.buswidth) - 1);
384 if (op->data.dir == SPI_MEM_DATA_IN)
388 writel(ss_ctrl, mxic->regs + SS_CTRL(mem->spi->chip_select));
390 writel(readl(mxic->regs + HC_CFG) | HC_CFG_MAN_CS_ASSERT,
391 mxic->regs + HC_CFG);
393 ret = mxic_spi_data_xfer(mxic, &opcode, NULL, 1);
397 for (i = 0; i < op->addr.nbytes; i++)
398 addr[i] = op->addr.val >> (8 * (op->addr.nbytes - i - 1));
400 ret = mxic_spi_data_xfer(mxic, addr, NULL, op->addr.nbytes);
404 ret = mxic_spi_data_xfer(mxic, NULL, NULL, op->dummy.nbytes);
408 ret = mxic_spi_data_xfer(mxic,
409 op->data.dir == SPI_MEM_DATA_OUT ?
410 op->data.buf.out : NULL,
411 op->data.dir == SPI_MEM_DATA_IN ?
412 op->data.buf.in : NULL,
416 writel(readl(mxic->regs + HC_CFG) & ~HC_CFG_MAN_CS_ASSERT,
417 mxic->regs + HC_CFG);
418 writel(0, mxic->regs + HC_EN);
423 static const struct spi_controller_mem_ops mxic_spi_mem_ops = {
424 .supports_op = mxic_spi_mem_supports_op,
425 .exec_op = mxic_spi_mem_exec_op,
428 static void mxic_spi_set_cs(struct spi_device *spi, bool lvl)
430 struct mxic_spi *mxic = spi_master_get_devdata(spi->master);
433 writel(readl(mxic->regs + HC_CFG) | HC_CFG_MAN_CS_EN,
434 mxic->regs + HC_CFG);
435 writel(HC_EN_BIT, mxic->regs + HC_EN);
436 writel(readl(mxic->regs + HC_CFG) | HC_CFG_MAN_CS_ASSERT,
437 mxic->regs + HC_CFG);
439 writel(readl(mxic->regs + HC_CFG) & ~HC_CFG_MAN_CS_ASSERT,
440 mxic->regs + HC_CFG);
441 writel(0, mxic->regs + HC_EN);
445 static int mxic_spi_transfer_one(struct spi_master *master,
446 struct spi_device *spi,
447 struct spi_transfer *t)
449 struct mxic_spi *mxic = spi_master_get_devdata(master);
450 unsigned int busw = OP_BUSW_1;
453 if (t->rx_buf && t->tx_buf) {
454 if (((spi->mode & SPI_TX_QUAD) &&
455 !(spi->mode & SPI_RX_QUAD)) ||
456 ((spi->mode & SPI_TX_DUAL) &&
457 !(spi->mode & SPI_RX_DUAL)))
461 ret = mxic_spi_set_freq(mxic, t->speed_hz);
466 if (spi->mode & SPI_TX_QUAD)
468 else if (spi->mode & SPI_TX_DUAL)
470 } else if (t->rx_buf) {
471 if (spi->mode & SPI_RX_QUAD)
473 else if (spi->mode & SPI_RX_DUAL)
477 writel(OP_CMD_BYTES(1) | OP_CMD_BUSW(busw) |
478 OP_DATA_BUSW(busw) | (t->rx_buf ? OP_READ : 0),
479 mxic->regs + SS_CTRL(0));
481 ret = mxic_spi_data_xfer(mxic, t->tx_buf, t->rx_buf, t->len);
485 spi_finalize_current_transfer(master);
490 static int __maybe_unused mxic_spi_runtime_suspend(struct device *dev)
492 struct spi_master *master = dev_get_drvdata(dev);
493 struct mxic_spi *mxic = spi_master_get_devdata(master);
495 mxic_spi_clk_disable(mxic);
496 clk_disable_unprepare(mxic->ps_clk);
501 static int __maybe_unused mxic_spi_runtime_resume(struct device *dev)
503 struct spi_master *master = dev_get_drvdata(dev);
504 struct mxic_spi *mxic = spi_master_get_devdata(master);
507 ret = clk_prepare_enable(mxic->ps_clk);
509 dev_err(dev, "Cannot enable ps_clock.\n");
513 return mxic_spi_clk_enable(mxic);
516 static const struct dev_pm_ops mxic_spi_dev_pm_ops = {
517 SET_RUNTIME_PM_OPS(mxic_spi_runtime_suspend,
518 mxic_spi_runtime_resume, NULL)
521 static int mxic_spi_probe(struct platform_device *pdev)
523 struct spi_master *master;
524 struct resource *res;
525 struct mxic_spi *mxic;
528 master = devm_spi_alloc_master(&pdev->dev, sizeof(struct mxic_spi));
532 platform_set_drvdata(pdev, master);
534 mxic = spi_master_get_devdata(master);
536 master->dev.of_node = pdev->dev.of_node;
538 mxic->ps_clk = devm_clk_get(&pdev->dev, "ps_clk");
539 if (IS_ERR(mxic->ps_clk))
540 return PTR_ERR(mxic->ps_clk);
542 mxic->send_clk = devm_clk_get(&pdev->dev, "send_clk");
543 if (IS_ERR(mxic->send_clk))
544 return PTR_ERR(mxic->send_clk);
546 mxic->send_dly_clk = devm_clk_get(&pdev->dev, "send_dly_clk");
547 if (IS_ERR(mxic->send_dly_clk))
548 return PTR_ERR(mxic->send_dly_clk);
550 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "regs");
551 mxic->regs = devm_ioremap_resource(&pdev->dev, res);
552 if (IS_ERR(mxic->regs))
553 return PTR_ERR(mxic->regs);
555 pm_runtime_enable(&pdev->dev);
556 master->auto_runtime_pm = true;
558 master->num_chipselect = 1;
559 master->mem_ops = &mxic_spi_mem_ops;
561 master->set_cs = mxic_spi_set_cs;
562 master->transfer_one = mxic_spi_transfer_one;
563 master->bits_per_word_mask = SPI_BPW_MASK(8);
564 master->mode_bits = SPI_CPOL | SPI_CPHA |
565 SPI_RX_DUAL | SPI_TX_DUAL |
566 SPI_RX_QUAD | SPI_TX_QUAD;
568 mxic_spi_hw_init(mxic);
570 ret = spi_register_master(master);
572 dev_err(&pdev->dev, "spi_register_master failed\n");
573 pm_runtime_disable(&pdev->dev);
579 static int mxic_spi_remove(struct platform_device *pdev)
581 struct spi_master *master = platform_get_drvdata(pdev);
583 pm_runtime_disable(&pdev->dev);
584 spi_unregister_master(master);
589 static const struct of_device_id mxic_spi_of_ids[] = {
590 { .compatible = "mxicy,mx25f0a-spi", },
593 MODULE_DEVICE_TABLE(of, mxic_spi_of_ids);
595 static struct platform_driver mxic_spi_driver = {
596 .probe = mxic_spi_probe,
597 .remove = mxic_spi_remove,
600 .of_match_table = mxic_spi_of_ids,
601 .pm = &mxic_spi_dev_pm_ops,
604 module_platform_driver(mxic_spi_driver);
606 MODULE_AUTHOR("Mason Yang <masonccyang@mxic.com.tw>");
607 MODULE_DESCRIPTION("MX25F0A SPI controller driver");
608 MODULE_LICENSE("GPL v2");