Loading...
1/*
2 * Copyright (c) 2015 MediaTek Inc.
3 * Author: Leilk Liu <leilk.liu@mediatek.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 */
14
15#include <linux/clk.h>
16#include <linux/device.h>
17#include <linux/err.h>
18#include <linux/interrupt.h>
19#include <linux/io.h>
20#include <linux/ioport.h>
21#include <linux/module.h>
22#include <linux/of.h>
23#include <linux/of_gpio.h>
24#include <linux/platform_device.h>
25#include <linux/platform_data/spi-mt65xx.h>
26#include <linux/pm_runtime.h>
27#include <linux/spi/spi.h>
28
29#define SPI_CFG0_REG 0x0000
30#define SPI_CFG1_REG 0x0004
31#define SPI_TX_SRC_REG 0x0008
32#define SPI_RX_DST_REG 0x000c
33#define SPI_TX_DATA_REG 0x0010
34#define SPI_RX_DATA_REG 0x0014
35#define SPI_CMD_REG 0x0018
36#define SPI_STATUS0_REG 0x001c
37#define SPI_PAD_SEL_REG 0x0024
38
39#define SPI_CFG0_SCK_HIGH_OFFSET 0
40#define SPI_CFG0_SCK_LOW_OFFSET 8
41#define SPI_CFG0_CS_HOLD_OFFSET 16
42#define SPI_CFG0_CS_SETUP_OFFSET 24
43
44#define SPI_CFG1_CS_IDLE_OFFSET 0
45#define SPI_CFG1_PACKET_LOOP_OFFSET 8
46#define SPI_CFG1_PACKET_LENGTH_OFFSET 16
47#define SPI_CFG1_GET_TICK_DLY_OFFSET 30
48
49#define SPI_CFG1_CS_IDLE_MASK 0xff
50#define SPI_CFG1_PACKET_LOOP_MASK 0xff00
51#define SPI_CFG1_PACKET_LENGTH_MASK 0x3ff0000
52
53#define SPI_CMD_ACT BIT(0)
54#define SPI_CMD_RESUME BIT(1)
55#define SPI_CMD_RST BIT(2)
56#define SPI_CMD_PAUSE_EN BIT(4)
57#define SPI_CMD_DEASSERT BIT(5)
58#define SPI_CMD_CPHA BIT(8)
59#define SPI_CMD_CPOL BIT(9)
60#define SPI_CMD_RX_DMA BIT(10)
61#define SPI_CMD_TX_DMA BIT(11)
62#define SPI_CMD_TXMSBF BIT(12)
63#define SPI_CMD_RXMSBF BIT(13)
64#define SPI_CMD_RX_ENDIAN BIT(14)
65#define SPI_CMD_TX_ENDIAN BIT(15)
66#define SPI_CMD_FINISH_IE BIT(16)
67#define SPI_CMD_PAUSE_IE BIT(17)
68
69#define MT8173_SPI_MAX_PAD_SEL 3
70
71#define MTK_SPI_PAUSE_INT_STATUS 0x2
72
73#define MTK_SPI_IDLE 0
74#define MTK_SPI_PAUSED 1
75
76#define MTK_SPI_MAX_FIFO_SIZE 32
77#define MTK_SPI_PACKET_SIZE 1024
78
79struct mtk_spi_compatible {
80 bool need_pad_sel;
81 /* Must explicitly send dummy Tx bytes to do Rx only transfer */
82 bool must_tx;
83};
84
85struct mtk_spi {
86 void __iomem *base;
87 u32 state;
88 int pad_num;
89 u32 *pad_sel;
90 struct clk *parent_clk, *sel_clk, *spi_clk;
91 struct spi_transfer *cur_transfer;
92 u32 xfer_len;
93 struct scatterlist *tx_sgl, *rx_sgl;
94 u32 tx_sgl_len, rx_sgl_len;
95 const struct mtk_spi_compatible *dev_comp;
96};
97
98static const struct mtk_spi_compatible mtk_common_compat;
99static const struct mtk_spi_compatible mt8173_compat = {
100 .need_pad_sel = true,
101 .must_tx = true,
102};
103
104/*
105 * A piece of default chip info unless the platform
106 * supplies it.
107 */
108static const struct mtk_chip_config mtk_default_chip_info = {
109 .rx_mlsb = 1,
110 .tx_mlsb = 1,
111};
112
113static const struct of_device_id mtk_spi_of_match[] = {
114 { .compatible = "mediatek,mt2701-spi",
115 .data = (void *)&mtk_common_compat,
116 },
117 { .compatible = "mediatek,mt6589-spi",
118 .data = (void *)&mtk_common_compat,
119 },
120 { .compatible = "mediatek,mt8135-spi",
121 .data = (void *)&mtk_common_compat,
122 },
123 { .compatible = "mediatek,mt8173-spi",
124 .data = (void *)&mt8173_compat,
125 },
126 {}
127};
128MODULE_DEVICE_TABLE(of, mtk_spi_of_match);
129
130static void mtk_spi_reset(struct mtk_spi *mdata)
131{
132 u32 reg_val;
133
134 /* set the software reset bit in SPI_CMD_REG. */
135 reg_val = readl(mdata->base + SPI_CMD_REG);
136 reg_val |= SPI_CMD_RST;
137 writel(reg_val, mdata->base + SPI_CMD_REG);
138
139 reg_val = readl(mdata->base + SPI_CMD_REG);
140 reg_val &= ~SPI_CMD_RST;
141 writel(reg_val, mdata->base + SPI_CMD_REG);
142}
143
144static int mtk_spi_prepare_message(struct spi_master *master,
145 struct spi_message *msg)
146{
147 u16 cpha, cpol;
148 u32 reg_val;
149 struct spi_device *spi = msg->spi;
150 struct mtk_chip_config *chip_config = spi->controller_data;
151 struct mtk_spi *mdata = spi_master_get_devdata(master);
152
153 cpha = spi->mode & SPI_CPHA ? 1 : 0;
154 cpol = spi->mode & SPI_CPOL ? 1 : 0;
155
156 reg_val = readl(mdata->base + SPI_CMD_REG);
157 if (cpha)
158 reg_val |= SPI_CMD_CPHA;
159 else
160 reg_val &= ~SPI_CMD_CPHA;
161 if (cpol)
162 reg_val |= SPI_CMD_CPOL;
163 else
164 reg_val &= ~SPI_CMD_CPOL;
165
166 /* set the mlsbx and mlsbtx */
167 if (chip_config->tx_mlsb)
168 reg_val |= SPI_CMD_TXMSBF;
169 else
170 reg_val &= ~SPI_CMD_TXMSBF;
171 if (chip_config->rx_mlsb)
172 reg_val |= SPI_CMD_RXMSBF;
173 else
174 reg_val &= ~SPI_CMD_RXMSBF;
175
176 /* set the tx/rx endian */
177#ifdef __LITTLE_ENDIAN
178 reg_val &= ~SPI_CMD_TX_ENDIAN;
179 reg_val &= ~SPI_CMD_RX_ENDIAN;
180#else
181 reg_val |= SPI_CMD_TX_ENDIAN;
182 reg_val |= SPI_CMD_RX_ENDIAN;
183#endif
184
185 /* set finish and pause interrupt always enable */
186 reg_val |= SPI_CMD_FINISH_IE | SPI_CMD_PAUSE_IE;
187
188 /* disable dma mode */
189 reg_val &= ~(SPI_CMD_TX_DMA | SPI_CMD_RX_DMA);
190
191 /* disable deassert mode */
192 reg_val &= ~SPI_CMD_DEASSERT;
193
194 writel(reg_val, mdata->base + SPI_CMD_REG);
195
196 /* pad select */
197 if (mdata->dev_comp->need_pad_sel)
198 writel(mdata->pad_sel[spi->chip_select],
199 mdata->base + SPI_PAD_SEL_REG);
200
201 return 0;
202}
203
204static void mtk_spi_set_cs(struct spi_device *spi, bool enable)
205{
206 u32 reg_val;
207 struct mtk_spi *mdata = spi_master_get_devdata(spi->master);
208
209 reg_val = readl(mdata->base + SPI_CMD_REG);
210 if (!enable) {
211 reg_val |= SPI_CMD_PAUSE_EN;
212 writel(reg_val, mdata->base + SPI_CMD_REG);
213 } else {
214 reg_val &= ~SPI_CMD_PAUSE_EN;
215 writel(reg_val, mdata->base + SPI_CMD_REG);
216 mdata->state = MTK_SPI_IDLE;
217 mtk_spi_reset(mdata);
218 }
219}
220
221static void mtk_spi_prepare_transfer(struct spi_master *master,
222 struct spi_transfer *xfer)
223{
224 u32 spi_clk_hz, div, sck_time, cs_time, reg_val = 0;
225 struct mtk_spi *mdata = spi_master_get_devdata(master);
226
227 spi_clk_hz = clk_get_rate(mdata->spi_clk);
228 if (xfer->speed_hz < spi_clk_hz / 2)
229 div = DIV_ROUND_UP(spi_clk_hz, xfer->speed_hz);
230 else
231 div = 1;
232
233 sck_time = (div + 1) / 2;
234 cs_time = sck_time * 2;
235
236 reg_val |= (((sck_time - 1) & 0xff) << SPI_CFG0_SCK_HIGH_OFFSET);
237 reg_val |= (((sck_time - 1) & 0xff) << SPI_CFG0_SCK_LOW_OFFSET);
238 reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG0_CS_HOLD_OFFSET);
239 reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG0_CS_SETUP_OFFSET);
240 writel(reg_val, mdata->base + SPI_CFG0_REG);
241
242 reg_val = readl(mdata->base + SPI_CFG1_REG);
243 reg_val &= ~SPI_CFG1_CS_IDLE_MASK;
244 reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG1_CS_IDLE_OFFSET);
245 writel(reg_val, mdata->base + SPI_CFG1_REG);
246}
247
248static void mtk_spi_setup_packet(struct spi_master *master)
249{
250 u32 packet_size, packet_loop, reg_val;
251 struct mtk_spi *mdata = spi_master_get_devdata(master);
252
253 packet_size = min_t(u32, mdata->xfer_len, MTK_SPI_PACKET_SIZE);
254 packet_loop = mdata->xfer_len / packet_size;
255
256 reg_val = readl(mdata->base + SPI_CFG1_REG);
257 reg_val &= ~(SPI_CFG1_PACKET_LENGTH_MASK | SPI_CFG1_PACKET_LOOP_MASK);
258 reg_val |= (packet_size - 1) << SPI_CFG1_PACKET_LENGTH_OFFSET;
259 reg_val |= (packet_loop - 1) << SPI_CFG1_PACKET_LOOP_OFFSET;
260 writel(reg_val, mdata->base + SPI_CFG1_REG);
261}
262
263static void mtk_spi_enable_transfer(struct spi_master *master)
264{
265 u32 cmd;
266 struct mtk_spi *mdata = spi_master_get_devdata(master);
267
268 cmd = readl(mdata->base + SPI_CMD_REG);
269 if (mdata->state == MTK_SPI_IDLE)
270 cmd |= SPI_CMD_ACT;
271 else
272 cmd |= SPI_CMD_RESUME;
273 writel(cmd, mdata->base + SPI_CMD_REG);
274}
275
276static int mtk_spi_get_mult_delta(u32 xfer_len)
277{
278 u32 mult_delta;
279
280 if (xfer_len > MTK_SPI_PACKET_SIZE)
281 mult_delta = xfer_len % MTK_SPI_PACKET_SIZE;
282 else
283 mult_delta = 0;
284
285 return mult_delta;
286}
287
288static void mtk_spi_update_mdata_len(struct spi_master *master)
289{
290 int mult_delta;
291 struct mtk_spi *mdata = spi_master_get_devdata(master);
292
293 if (mdata->tx_sgl_len && mdata->rx_sgl_len) {
294 if (mdata->tx_sgl_len > mdata->rx_sgl_len) {
295 mult_delta = mtk_spi_get_mult_delta(mdata->rx_sgl_len);
296 mdata->xfer_len = mdata->rx_sgl_len - mult_delta;
297 mdata->rx_sgl_len = mult_delta;
298 mdata->tx_sgl_len -= mdata->xfer_len;
299 } else {
300 mult_delta = mtk_spi_get_mult_delta(mdata->tx_sgl_len);
301 mdata->xfer_len = mdata->tx_sgl_len - mult_delta;
302 mdata->tx_sgl_len = mult_delta;
303 mdata->rx_sgl_len -= mdata->xfer_len;
304 }
305 } else if (mdata->tx_sgl_len) {
306 mult_delta = mtk_spi_get_mult_delta(mdata->tx_sgl_len);
307 mdata->xfer_len = mdata->tx_sgl_len - mult_delta;
308 mdata->tx_sgl_len = mult_delta;
309 } else if (mdata->rx_sgl_len) {
310 mult_delta = mtk_spi_get_mult_delta(mdata->rx_sgl_len);
311 mdata->xfer_len = mdata->rx_sgl_len - mult_delta;
312 mdata->rx_sgl_len = mult_delta;
313 }
314}
315
316static void mtk_spi_setup_dma_addr(struct spi_master *master,
317 struct spi_transfer *xfer)
318{
319 struct mtk_spi *mdata = spi_master_get_devdata(master);
320
321 if (mdata->tx_sgl)
322 writel(xfer->tx_dma, mdata->base + SPI_TX_SRC_REG);
323 if (mdata->rx_sgl)
324 writel(xfer->rx_dma, mdata->base + SPI_RX_DST_REG);
325}
326
327static int mtk_spi_fifo_transfer(struct spi_master *master,
328 struct spi_device *spi,
329 struct spi_transfer *xfer)
330{
331 int cnt, remainder;
332 u32 reg_val;
333 struct mtk_spi *mdata = spi_master_get_devdata(master);
334
335 mdata->cur_transfer = xfer;
336 mdata->xfer_len = xfer->len;
337 mtk_spi_prepare_transfer(master, xfer);
338 mtk_spi_setup_packet(master);
339
340 cnt = xfer->len / 4;
341 iowrite32_rep(mdata->base + SPI_TX_DATA_REG, xfer->tx_buf, cnt);
342
343 remainder = xfer->len % 4;
344 if (remainder > 0) {
345 reg_val = 0;
346 memcpy(®_val, xfer->tx_buf + (cnt * 4), remainder);
347 writel(reg_val, mdata->base + SPI_TX_DATA_REG);
348 }
349
350 mtk_spi_enable_transfer(master);
351
352 return 1;
353}
354
355static int mtk_spi_dma_transfer(struct spi_master *master,
356 struct spi_device *spi,
357 struct spi_transfer *xfer)
358{
359 int cmd;
360 struct mtk_spi *mdata = spi_master_get_devdata(master);
361
362 mdata->tx_sgl = NULL;
363 mdata->rx_sgl = NULL;
364 mdata->tx_sgl_len = 0;
365 mdata->rx_sgl_len = 0;
366 mdata->cur_transfer = xfer;
367
368 mtk_spi_prepare_transfer(master, xfer);
369
370 cmd = readl(mdata->base + SPI_CMD_REG);
371 if (xfer->tx_buf)
372 cmd |= SPI_CMD_TX_DMA;
373 if (xfer->rx_buf)
374 cmd |= SPI_CMD_RX_DMA;
375 writel(cmd, mdata->base + SPI_CMD_REG);
376
377 if (xfer->tx_buf)
378 mdata->tx_sgl = xfer->tx_sg.sgl;
379 if (xfer->rx_buf)
380 mdata->rx_sgl = xfer->rx_sg.sgl;
381
382 if (mdata->tx_sgl) {
383 xfer->tx_dma = sg_dma_address(mdata->tx_sgl);
384 mdata->tx_sgl_len = sg_dma_len(mdata->tx_sgl);
385 }
386 if (mdata->rx_sgl) {
387 xfer->rx_dma = sg_dma_address(mdata->rx_sgl);
388 mdata->rx_sgl_len = sg_dma_len(mdata->rx_sgl);
389 }
390
391 mtk_spi_update_mdata_len(master);
392 mtk_spi_setup_packet(master);
393 mtk_spi_setup_dma_addr(master, xfer);
394 mtk_spi_enable_transfer(master);
395
396 return 1;
397}
398
399static int mtk_spi_transfer_one(struct spi_master *master,
400 struct spi_device *spi,
401 struct spi_transfer *xfer)
402{
403 if (master->can_dma(master, spi, xfer))
404 return mtk_spi_dma_transfer(master, spi, xfer);
405 else
406 return mtk_spi_fifo_transfer(master, spi, xfer);
407}
408
409static bool mtk_spi_can_dma(struct spi_master *master,
410 struct spi_device *spi,
411 struct spi_transfer *xfer)
412{
413 return xfer->len > MTK_SPI_MAX_FIFO_SIZE;
414}
415
416static int mtk_spi_setup(struct spi_device *spi)
417{
418 struct mtk_spi *mdata = spi_master_get_devdata(spi->master);
419
420 if (!spi->controller_data)
421 spi->controller_data = (void *)&mtk_default_chip_info;
422
423 if (mdata->dev_comp->need_pad_sel && gpio_is_valid(spi->cs_gpio))
424 gpio_direction_output(spi->cs_gpio, !(spi->mode & SPI_CS_HIGH));
425
426 return 0;
427}
428
429static irqreturn_t mtk_spi_interrupt(int irq, void *dev_id)
430{
431 u32 cmd, reg_val, cnt, remainder;
432 struct spi_master *master = dev_id;
433 struct mtk_spi *mdata = spi_master_get_devdata(master);
434 struct spi_transfer *trans = mdata->cur_transfer;
435
436 reg_val = readl(mdata->base + SPI_STATUS0_REG);
437 if (reg_val & MTK_SPI_PAUSE_INT_STATUS)
438 mdata->state = MTK_SPI_PAUSED;
439 else
440 mdata->state = MTK_SPI_IDLE;
441
442 if (!master->can_dma(master, master->cur_msg->spi, trans)) {
443 if (trans->rx_buf) {
444 cnt = mdata->xfer_len / 4;
445 ioread32_rep(mdata->base + SPI_RX_DATA_REG,
446 trans->rx_buf, cnt);
447 remainder = mdata->xfer_len % 4;
448 if (remainder > 0) {
449 reg_val = readl(mdata->base + SPI_RX_DATA_REG);
450 memcpy(trans->rx_buf + (cnt * 4),
451 ®_val, remainder);
452 }
453 }
454 spi_finalize_current_transfer(master);
455 return IRQ_HANDLED;
456 }
457
458 if (mdata->tx_sgl)
459 trans->tx_dma += mdata->xfer_len;
460 if (mdata->rx_sgl)
461 trans->rx_dma += mdata->xfer_len;
462
463 if (mdata->tx_sgl && (mdata->tx_sgl_len == 0)) {
464 mdata->tx_sgl = sg_next(mdata->tx_sgl);
465 if (mdata->tx_sgl) {
466 trans->tx_dma = sg_dma_address(mdata->tx_sgl);
467 mdata->tx_sgl_len = sg_dma_len(mdata->tx_sgl);
468 }
469 }
470 if (mdata->rx_sgl && (mdata->rx_sgl_len == 0)) {
471 mdata->rx_sgl = sg_next(mdata->rx_sgl);
472 if (mdata->rx_sgl) {
473 trans->rx_dma = sg_dma_address(mdata->rx_sgl);
474 mdata->rx_sgl_len = sg_dma_len(mdata->rx_sgl);
475 }
476 }
477
478 if (!mdata->tx_sgl && !mdata->rx_sgl) {
479 /* spi disable dma */
480 cmd = readl(mdata->base + SPI_CMD_REG);
481 cmd &= ~SPI_CMD_TX_DMA;
482 cmd &= ~SPI_CMD_RX_DMA;
483 writel(cmd, mdata->base + SPI_CMD_REG);
484
485 spi_finalize_current_transfer(master);
486 return IRQ_HANDLED;
487 }
488
489 mtk_spi_update_mdata_len(master);
490 mtk_spi_setup_packet(master);
491 mtk_spi_setup_dma_addr(master, trans);
492 mtk_spi_enable_transfer(master);
493
494 return IRQ_HANDLED;
495}
496
497static int mtk_spi_probe(struct platform_device *pdev)
498{
499 struct spi_master *master;
500 struct mtk_spi *mdata;
501 const struct of_device_id *of_id;
502 struct resource *res;
503 int i, irq, ret;
504
505 master = spi_alloc_master(&pdev->dev, sizeof(*mdata));
506 if (!master) {
507 dev_err(&pdev->dev, "failed to alloc spi master\n");
508 return -ENOMEM;
509 }
510
511 master->auto_runtime_pm = true;
512 master->dev.of_node = pdev->dev.of_node;
513 master->mode_bits = SPI_CPOL | SPI_CPHA;
514
515 master->set_cs = mtk_spi_set_cs;
516 master->prepare_message = mtk_spi_prepare_message;
517 master->transfer_one = mtk_spi_transfer_one;
518 master->can_dma = mtk_spi_can_dma;
519 master->setup = mtk_spi_setup;
520
521 of_id = of_match_node(mtk_spi_of_match, pdev->dev.of_node);
522 if (!of_id) {
523 dev_err(&pdev->dev, "failed to probe of_node\n");
524 ret = -EINVAL;
525 goto err_put_master;
526 }
527
528 mdata = spi_master_get_devdata(master);
529 mdata->dev_comp = of_id->data;
530 if (mdata->dev_comp->must_tx)
531 master->flags = SPI_MASTER_MUST_TX;
532
533 if (mdata->dev_comp->need_pad_sel) {
534 mdata->pad_num = of_property_count_u32_elems(
535 pdev->dev.of_node,
536 "mediatek,pad-select");
537 if (mdata->pad_num < 0) {
538 dev_err(&pdev->dev,
539 "No 'mediatek,pad-select' property\n");
540 ret = -EINVAL;
541 goto err_put_master;
542 }
543
544 mdata->pad_sel = devm_kmalloc_array(&pdev->dev, mdata->pad_num,
545 sizeof(u32), GFP_KERNEL);
546 if (!mdata->pad_sel) {
547 ret = -ENOMEM;
548 goto err_put_master;
549 }
550
551 for (i = 0; i < mdata->pad_num; i++) {
552 of_property_read_u32_index(pdev->dev.of_node,
553 "mediatek,pad-select",
554 i, &mdata->pad_sel[i]);
555 if (mdata->pad_sel[i] > MT8173_SPI_MAX_PAD_SEL) {
556 dev_err(&pdev->dev, "wrong pad-sel[%d]: %u\n",
557 i, mdata->pad_sel[i]);
558 ret = -EINVAL;
559 goto err_put_master;
560 }
561 }
562 }
563
564 platform_set_drvdata(pdev, master);
565
566 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
567 if (!res) {
568 ret = -ENODEV;
569 dev_err(&pdev->dev, "failed to determine base address\n");
570 goto err_put_master;
571 }
572
573 mdata->base = devm_ioremap_resource(&pdev->dev, res);
574 if (IS_ERR(mdata->base)) {
575 ret = PTR_ERR(mdata->base);
576 goto err_put_master;
577 }
578
579 irq = platform_get_irq(pdev, 0);
580 if (irq < 0) {
581 dev_err(&pdev->dev, "failed to get irq (%d)\n", irq);
582 ret = irq;
583 goto err_put_master;
584 }
585
586 if (!pdev->dev.dma_mask)
587 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
588
589 ret = devm_request_irq(&pdev->dev, irq, mtk_spi_interrupt,
590 IRQF_TRIGGER_NONE, dev_name(&pdev->dev), master);
591 if (ret) {
592 dev_err(&pdev->dev, "failed to register irq (%d)\n", ret);
593 goto err_put_master;
594 }
595
596 mdata->parent_clk = devm_clk_get(&pdev->dev, "parent-clk");
597 if (IS_ERR(mdata->parent_clk)) {
598 ret = PTR_ERR(mdata->parent_clk);
599 dev_err(&pdev->dev, "failed to get parent-clk: %d\n", ret);
600 goto err_put_master;
601 }
602
603 mdata->sel_clk = devm_clk_get(&pdev->dev, "sel-clk");
604 if (IS_ERR(mdata->sel_clk)) {
605 ret = PTR_ERR(mdata->sel_clk);
606 dev_err(&pdev->dev, "failed to get sel-clk: %d\n", ret);
607 goto err_put_master;
608 }
609
610 mdata->spi_clk = devm_clk_get(&pdev->dev, "spi-clk");
611 if (IS_ERR(mdata->spi_clk)) {
612 ret = PTR_ERR(mdata->spi_clk);
613 dev_err(&pdev->dev, "failed to get spi-clk: %d\n", ret);
614 goto err_put_master;
615 }
616
617 ret = clk_prepare_enable(mdata->spi_clk);
618 if (ret < 0) {
619 dev_err(&pdev->dev, "failed to enable spi_clk (%d)\n", ret);
620 goto err_put_master;
621 }
622
623 ret = clk_set_parent(mdata->sel_clk, mdata->parent_clk);
624 if (ret < 0) {
625 dev_err(&pdev->dev, "failed to clk_set_parent (%d)\n", ret);
626 clk_disable_unprepare(mdata->spi_clk);
627 goto err_put_master;
628 }
629
630 clk_disable_unprepare(mdata->spi_clk);
631
632 pm_runtime_enable(&pdev->dev);
633
634 ret = devm_spi_register_master(&pdev->dev, master);
635 if (ret) {
636 dev_err(&pdev->dev, "failed to register master (%d)\n", ret);
637 goto err_disable_runtime_pm;
638 }
639
640 if (mdata->dev_comp->need_pad_sel) {
641 if (mdata->pad_num != master->num_chipselect) {
642 dev_err(&pdev->dev,
643 "pad_num does not match num_chipselect(%d != %d)\n",
644 mdata->pad_num, master->num_chipselect);
645 ret = -EINVAL;
646 goto err_disable_runtime_pm;
647 }
648
649 if (!master->cs_gpios && master->num_chipselect > 1) {
650 dev_err(&pdev->dev,
651 "cs_gpios not specified and num_chipselect > 1\n");
652 ret = -EINVAL;
653 goto err_disable_runtime_pm;
654 }
655
656 if (master->cs_gpios) {
657 for (i = 0; i < master->num_chipselect; i++) {
658 ret = devm_gpio_request(&pdev->dev,
659 master->cs_gpios[i],
660 dev_name(&pdev->dev));
661 if (ret) {
662 dev_err(&pdev->dev,
663 "can't get CS GPIO %i\n", i);
664 goto err_disable_runtime_pm;
665 }
666 }
667 }
668 }
669
670 return 0;
671
672err_disable_runtime_pm:
673 pm_runtime_disable(&pdev->dev);
674err_put_master:
675 spi_master_put(master);
676
677 return ret;
678}
679
680static int mtk_spi_remove(struct platform_device *pdev)
681{
682 struct spi_master *master = platform_get_drvdata(pdev);
683 struct mtk_spi *mdata = spi_master_get_devdata(master);
684
685 pm_runtime_disable(&pdev->dev);
686
687 mtk_spi_reset(mdata);
688 spi_master_put(master);
689
690 return 0;
691}
692
693#ifdef CONFIG_PM_SLEEP
694static int mtk_spi_suspend(struct device *dev)
695{
696 int ret;
697 struct spi_master *master = dev_get_drvdata(dev);
698 struct mtk_spi *mdata = spi_master_get_devdata(master);
699
700 ret = spi_master_suspend(master);
701 if (ret)
702 return ret;
703
704 if (!pm_runtime_suspended(dev))
705 clk_disable_unprepare(mdata->spi_clk);
706
707 return ret;
708}
709
710static int mtk_spi_resume(struct device *dev)
711{
712 int ret;
713 struct spi_master *master = dev_get_drvdata(dev);
714 struct mtk_spi *mdata = spi_master_get_devdata(master);
715
716 if (!pm_runtime_suspended(dev)) {
717 ret = clk_prepare_enable(mdata->spi_clk);
718 if (ret < 0) {
719 dev_err(dev, "failed to enable spi_clk (%d)\n", ret);
720 return ret;
721 }
722 }
723
724 ret = spi_master_resume(master);
725 if (ret < 0)
726 clk_disable_unprepare(mdata->spi_clk);
727
728 return ret;
729}
730#endif /* CONFIG_PM_SLEEP */
731
732#ifdef CONFIG_PM
733static int mtk_spi_runtime_suspend(struct device *dev)
734{
735 struct spi_master *master = dev_get_drvdata(dev);
736 struct mtk_spi *mdata = spi_master_get_devdata(master);
737
738 clk_disable_unprepare(mdata->spi_clk);
739
740 return 0;
741}
742
743static int mtk_spi_runtime_resume(struct device *dev)
744{
745 struct spi_master *master = dev_get_drvdata(dev);
746 struct mtk_spi *mdata = spi_master_get_devdata(master);
747 int ret;
748
749 ret = clk_prepare_enable(mdata->spi_clk);
750 if (ret < 0) {
751 dev_err(dev, "failed to enable spi_clk (%d)\n", ret);
752 return ret;
753 }
754
755 return 0;
756}
757#endif /* CONFIG_PM */
758
759static const struct dev_pm_ops mtk_spi_pm = {
760 SET_SYSTEM_SLEEP_PM_OPS(mtk_spi_suspend, mtk_spi_resume)
761 SET_RUNTIME_PM_OPS(mtk_spi_runtime_suspend,
762 mtk_spi_runtime_resume, NULL)
763};
764
765static struct platform_driver mtk_spi_driver = {
766 .driver = {
767 .name = "mtk-spi",
768 .pm = &mtk_spi_pm,
769 .of_match_table = mtk_spi_of_match,
770 },
771 .probe = mtk_spi_probe,
772 .remove = mtk_spi_remove,
773};
774
775module_platform_driver(mtk_spi_driver);
776
777MODULE_DESCRIPTION("MTK SPI Controller driver");
778MODULE_AUTHOR("Leilk Liu <leilk.liu@mediatek.com>");
779MODULE_LICENSE("GPL v2");
780MODULE_ALIAS("platform:mtk-spi");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (c) 2015 MediaTek Inc.
4 * Author: Leilk Liu <leilk.liu@mediatek.com>
5 */
6
7#include <linux/clk.h>
8#include <linux/device.h>
9#include <linux/err.h>
10#include <linux/interrupt.h>
11#include <linux/io.h>
12#include <linux/ioport.h>
13#include <linux/module.h>
14#include <linux/of.h>
15#include <linux/of_gpio.h>
16#include <linux/platform_device.h>
17#include <linux/platform_data/spi-mt65xx.h>
18#include <linux/pm_runtime.h>
19#include <linux/spi/spi.h>
20#include <linux/dma-mapping.h>
21
22#define SPI_CFG0_REG 0x0000
23#define SPI_CFG1_REG 0x0004
24#define SPI_TX_SRC_REG 0x0008
25#define SPI_RX_DST_REG 0x000c
26#define SPI_TX_DATA_REG 0x0010
27#define SPI_RX_DATA_REG 0x0014
28#define SPI_CMD_REG 0x0018
29#define SPI_STATUS0_REG 0x001c
30#define SPI_PAD_SEL_REG 0x0024
31#define SPI_CFG2_REG 0x0028
32#define SPI_TX_SRC_REG_64 0x002c
33#define SPI_RX_DST_REG_64 0x0030
34
35#define SPI_CFG0_SCK_HIGH_OFFSET 0
36#define SPI_CFG0_SCK_LOW_OFFSET 8
37#define SPI_CFG0_CS_HOLD_OFFSET 16
38#define SPI_CFG0_CS_SETUP_OFFSET 24
39#define SPI_ADJUST_CFG0_CS_HOLD_OFFSET 0
40#define SPI_ADJUST_CFG0_CS_SETUP_OFFSET 16
41
42#define SPI_CFG1_CS_IDLE_OFFSET 0
43#define SPI_CFG1_PACKET_LOOP_OFFSET 8
44#define SPI_CFG1_PACKET_LENGTH_OFFSET 16
45#define SPI_CFG1_GET_TICK_DLY_OFFSET 30
46
47#define SPI_CFG1_CS_IDLE_MASK 0xff
48#define SPI_CFG1_PACKET_LOOP_MASK 0xff00
49#define SPI_CFG1_PACKET_LENGTH_MASK 0x3ff0000
50#define SPI_CFG2_SCK_HIGH_OFFSET 0
51#define SPI_CFG2_SCK_LOW_OFFSET 16
52
53#define SPI_CMD_ACT BIT(0)
54#define SPI_CMD_RESUME BIT(1)
55#define SPI_CMD_RST BIT(2)
56#define SPI_CMD_PAUSE_EN BIT(4)
57#define SPI_CMD_DEASSERT BIT(5)
58#define SPI_CMD_SAMPLE_SEL BIT(6)
59#define SPI_CMD_CS_POL BIT(7)
60#define SPI_CMD_CPHA BIT(8)
61#define SPI_CMD_CPOL BIT(9)
62#define SPI_CMD_RX_DMA BIT(10)
63#define SPI_CMD_TX_DMA BIT(11)
64#define SPI_CMD_TXMSBF BIT(12)
65#define SPI_CMD_RXMSBF BIT(13)
66#define SPI_CMD_RX_ENDIAN BIT(14)
67#define SPI_CMD_TX_ENDIAN BIT(15)
68#define SPI_CMD_FINISH_IE BIT(16)
69#define SPI_CMD_PAUSE_IE BIT(17)
70
71#define MT8173_SPI_MAX_PAD_SEL 3
72
73#define MTK_SPI_PAUSE_INT_STATUS 0x2
74
75#define MTK_SPI_IDLE 0
76#define MTK_SPI_PAUSED 1
77
78#define MTK_SPI_MAX_FIFO_SIZE 32U
79#define MTK_SPI_PACKET_SIZE 1024
80#define MTK_SPI_32BITS_MASK (0xffffffff)
81
82#define DMA_ADDR_EXT_BITS (36)
83#define DMA_ADDR_DEF_BITS (32)
84
85struct mtk_spi_compatible {
86 bool need_pad_sel;
87 /* Must explicitly send dummy Tx bytes to do Rx only transfer */
88 bool must_tx;
89 /* some IC design adjust cfg register to enhance time accuracy */
90 bool enhance_timing;
91 /* some IC support DMA addr extension */
92 bool dma_ext;
93};
94
95struct mtk_spi {
96 void __iomem *base;
97 u32 state;
98 int pad_num;
99 u32 *pad_sel;
100 struct clk *parent_clk, *sel_clk, *spi_clk;
101 struct spi_transfer *cur_transfer;
102 u32 xfer_len;
103 u32 num_xfered;
104 struct scatterlist *tx_sgl, *rx_sgl;
105 u32 tx_sgl_len, rx_sgl_len;
106 const struct mtk_spi_compatible *dev_comp;
107};
108
109static const struct mtk_spi_compatible mtk_common_compat;
110
111static const struct mtk_spi_compatible mt2712_compat = {
112 .must_tx = true,
113};
114
115static const struct mtk_spi_compatible mt6765_compat = {
116 .need_pad_sel = true,
117 .must_tx = true,
118 .enhance_timing = true,
119 .dma_ext = true,
120};
121
122static const struct mtk_spi_compatible mt7622_compat = {
123 .must_tx = true,
124 .enhance_timing = true,
125};
126
127static const struct mtk_spi_compatible mt8173_compat = {
128 .need_pad_sel = true,
129 .must_tx = true,
130};
131
132static const struct mtk_spi_compatible mt8183_compat = {
133 .need_pad_sel = true,
134 .must_tx = true,
135 .enhance_timing = true,
136};
137
138/*
139 * A piece of default chip info unless the platform
140 * supplies it.
141 */
142static const struct mtk_chip_config mtk_default_chip_info = {
143 .sample_sel = 0,
144};
145
146static const struct of_device_id mtk_spi_of_match[] = {
147 { .compatible = "mediatek,mt2701-spi",
148 .data = (void *)&mtk_common_compat,
149 },
150 { .compatible = "mediatek,mt2712-spi",
151 .data = (void *)&mt2712_compat,
152 },
153 { .compatible = "mediatek,mt6589-spi",
154 .data = (void *)&mtk_common_compat,
155 },
156 { .compatible = "mediatek,mt6765-spi",
157 .data = (void *)&mt6765_compat,
158 },
159 { .compatible = "mediatek,mt7622-spi",
160 .data = (void *)&mt7622_compat,
161 },
162 { .compatible = "mediatek,mt7629-spi",
163 .data = (void *)&mt7622_compat,
164 },
165 { .compatible = "mediatek,mt8135-spi",
166 .data = (void *)&mtk_common_compat,
167 },
168 { .compatible = "mediatek,mt8173-spi",
169 .data = (void *)&mt8173_compat,
170 },
171 { .compatible = "mediatek,mt8183-spi",
172 .data = (void *)&mt8183_compat,
173 },
174 { .compatible = "mediatek,mt8192-spi",
175 .data = (void *)&mt6765_compat,
176 },
177 {}
178};
179MODULE_DEVICE_TABLE(of, mtk_spi_of_match);
180
181static void mtk_spi_reset(struct mtk_spi *mdata)
182{
183 u32 reg_val;
184
185 /* set the software reset bit in SPI_CMD_REG. */
186 reg_val = readl(mdata->base + SPI_CMD_REG);
187 reg_val |= SPI_CMD_RST;
188 writel(reg_val, mdata->base + SPI_CMD_REG);
189
190 reg_val = readl(mdata->base + SPI_CMD_REG);
191 reg_val &= ~SPI_CMD_RST;
192 writel(reg_val, mdata->base + SPI_CMD_REG);
193}
194
195static int mtk_spi_prepare_message(struct spi_master *master,
196 struct spi_message *msg)
197{
198 u16 cpha, cpol;
199 u32 reg_val;
200 struct spi_device *spi = msg->spi;
201 struct mtk_chip_config *chip_config = spi->controller_data;
202 struct mtk_spi *mdata = spi_master_get_devdata(master);
203
204 cpha = spi->mode & SPI_CPHA ? 1 : 0;
205 cpol = spi->mode & SPI_CPOL ? 1 : 0;
206
207 reg_val = readl(mdata->base + SPI_CMD_REG);
208 if (cpha)
209 reg_val |= SPI_CMD_CPHA;
210 else
211 reg_val &= ~SPI_CMD_CPHA;
212 if (cpol)
213 reg_val |= SPI_CMD_CPOL;
214 else
215 reg_val &= ~SPI_CMD_CPOL;
216
217 /* set the mlsbx and mlsbtx */
218 if (spi->mode & SPI_LSB_FIRST) {
219 reg_val &= ~SPI_CMD_TXMSBF;
220 reg_val &= ~SPI_CMD_RXMSBF;
221 } else {
222 reg_val |= SPI_CMD_TXMSBF;
223 reg_val |= SPI_CMD_RXMSBF;
224 }
225
226 /* set the tx/rx endian */
227#ifdef __LITTLE_ENDIAN
228 reg_val &= ~SPI_CMD_TX_ENDIAN;
229 reg_val &= ~SPI_CMD_RX_ENDIAN;
230#else
231 reg_val |= SPI_CMD_TX_ENDIAN;
232 reg_val |= SPI_CMD_RX_ENDIAN;
233#endif
234
235 if (mdata->dev_comp->enhance_timing) {
236 /* set CS polarity */
237 if (spi->mode & SPI_CS_HIGH)
238 reg_val |= SPI_CMD_CS_POL;
239 else
240 reg_val &= ~SPI_CMD_CS_POL;
241
242 if (chip_config->sample_sel)
243 reg_val |= SPI_CMD_SAMPLE_SEL;
244 else
245 reg_val &= ~SPI_CMD_SAMPLE_SEL;
246 }
247
248 /* set finish and pause interrupt always enable */
249 reg_val |= SPI_CMD_FINISH_IE | SPI_CMD_PAUSE_IE;
250
251 /* disable dma mode */
252 reg_val &= ~(SPI_CMD_TX_DMA | SPI_CMD_RX_DMA);
253
254 /* disable deassert mode */
255 reg_val &= ~SPI_CMD_DEASSERT;
256
257 writel(reg_val, mdata->base + SPI_CMD_REG);
258
259 /* pad select */
260 if (mdata->dev_comp->need_pad_sel)
261 writel(mdata->pad_sel[spi->chip_select],
262 mdata->base + SPI_PAD_SEL_REG);
263
264 return 0;
265}
266
267static void mtk_spi_set_cs(struct spi_device *spi, bool enable)
268{
269 u32 reg_val;
270 struct mtk_spi *mdata = spi_master_get_devdata(spi->master);
271
272 if (spi->mode & SPI_CS_HIGH)
273 enable = !enable;
274
275 reg_val = readl(mdata->base + SPI_CMD_REG);
276 if (!enable) {
277 reg_val |= SPI_CMD_PAUSE_EN;
278 writel(reg_val, mdata->base + SPI_CMD_REG);
279 } else {
280 reg_val &= ~SPI_CMD_PAUSE_EN;
281 writel(reg_val, mdata->base + SPI_CMD_REG);
282 mdata->state = MTK_SPI_IDLE;
283 mtk_spi_reset(mdata);
284 }
285}
286
287static void mtk_spi_prepare_transfer(struct spi_master *master,
288 struct spi_transfer *xfer)
289{
290 u32 spi_clk_hz, div, sck_time, cs_time, reg_val;
291 struct mtk_spi *mdata = spi_master_get_devdata(master);
292
293 spi_clk_hz = clk_get_rate(mdata->spi_clk);
294 if (xfer->speed_hz < spi_clk_hz / 2)
295 div = DIV_ROUND_UP(spi_clk_hz, xfer->speed_hz);
296 else
297 div = 1;
298
299 sck_time = (div + 1) / 2;
300 cs_time = sck_time * 2;
301
302 if (mdata->dev_comp->enhance_timing) {
303 reg_val = (((sck_time - 1) & 0xffff)
304 << SPI_CFG2_SCK_HIGH_OFFSET);
305 reg_val |= (((sck_time - 1) & 0xffff)
306 << SPI_CFG2_SCK_LOW_OFFSET);
307 writel(reg_val, mdata->base + SPI_CFG2_REG);
308 reg_val = (((cs_time - 1) & 0xffff)
309 << SPI_ADJUST_CFG0_CS_HOLD_OFFSET);
310 reg_val |= (((cs_time - 1) & 0xffff)
311 << SPI_ADJUST_CFG0_CS_SETUP_OFFSET);
312 writel(reg_val, mdata->base + SPI_CFG0_REG);
313 } else {
314 reg_val = (((sck_time - 1) & 0xff)
315 << SPI_CFG0_SCK_HIGH_OFFSET);
316 reg_val |= (((sck_time - 1) & 0xff) << SPI_CFG0_SCK_LOW_OFFSET);
317 reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG0_CS_HOLD_OFFSET);
318 reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG0_CS_SETUP_OFFSET);
319 writel(reg_val, mdata->base + SPI_CFG0_REG);
320 }
321
322 reg_val = readl(mdata->base + SPI_CFG1_REG);
323 reg_val &= ~SPI_CFG1_CS_IDLE_MASK;
324 reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG1_CS_IDLE_OFFSET);
325 writel(reg_val, mdata->base + SPI_CFG1_REG);
326}
327
328static void mtk_spi_setup_packet(struct spi_master *master)
329{
330 u32 packet_size, packet_loop, reg_val;
331 struct mtk_spi *mdata = spi_master_get_devdata(master);
332
333 packet_size = min_t(u32, mdata->xfer_len, MTK_SPI_PACKET_SIZE);
334 packet_loop = mdata->xfer_len / packet_size;
335
336 reg_val = readl(mdata->base + SPI_CFG1_REG);
337 reg_val &= ~(SPI_CFG1_PACKET_LENGTH_MASK | SPI_CFG1_PACKET_LOOP_MASK);
338 reg_val |= (packet_size - 1) << SPI_CFG1_PACKET_LENGTH_OFFSET;
339 reg_val |= (packet_loop - 1) << SPI_CFG1_PACKET_LOOP_OFFSET;
340 writel(reg_val, mdata->base + SPI_CFG1_REG);
341}
342
343static void mtk_spi_enable_transfer(struct spi_master *master)
344{
345 u32 cmd;
346 struct mtk_spi *mdata = spi_master_get_devdata(master);
347
348 cmd = readl(mdata->base + SPI_CMD_REG);
349 if (mdata->state == MTK_SPI_IDLE)
350 cmd |= SPI_CMD_ACT;
351 else
352 cmd |= SPI_CMD_RESUME;
353 writel(cmd, mdata->base + SPI_CMD_REG);
354}
355
356static int mtk_spi_get_mult_delta(u32 xfer_len)
357{
358 u32 mult_delta;
359
360 if (xfer_len > MTK_SPI_PACKET_SIZE)
361 mult_delta = xfer_len % MTK_SPI_PACKET_SIZE;
362 else
363 mult_delta = 0;
364
365 return mult_delta;
366}
367
368static void mtk_spi_update_mdata_len(struct spi_master *master)
369{
370 int mult_delta;
371 struct mtk_spi *mdata = spi_master_get_devdata(master);
372
373 if (mdata->tx_sgl_len && mdata->rx_sgl_len) {
374 if (mdata->tx_sgl_len > mdata->rx_sgl_len) {
375 mult_delta = mtk_spi_get_mult_delta(mdata->rx_sgl_len);
376 mdata->xfer_len = mdata->rx_sgl_len - mult_delta;
377 mdata->rx_sgl_len = mult_delta;
378 mdata->tx_sgl_len -= mdata->xfer_len;
379 } else {
380 mult_delta = mtk_spi_get_mult_delta(mdata->tx_sgl_len);
381 mdata->xfer_len = mdata->tx_sgl_len - mult_delta;
382 mdata->tx_sgl_len = mult_delta;
383 mdata->rx_sgl_len -= mdata->xfer_len;
384 }
385 } else if (mdata->tx_sgl_len) {
386 mult_delta = mtk_spi_get_mult_delta(mdata->tx_sgl_len);
387 mdata->xfer_len = mdata->tx_sgl_len - mult_delta;
388 mdata->tx_sgl_len = mult_delta;
389 } else if (mdata->rx_sgl_len) {
390 mult_delta = mtk_spi_get_mult_delta(mdata->rx_sgl_len);
391 mdata->xfer_len = mdata->rx_sgl_len - mult_delta;
392 mdata->rx_sgl_len = mult_delta;
393 }
394}
395
396static void mtk_spi_setup_dma_addr(struct spi_master *master,
397 struct spi_transfer *xfer)
398{
399 struct mtk_spi *mdata = spi_master_get_devdata(master);
400
401 if (mdata->tx_sgl) {
402 writel((u32)(xfer->tx_dma & MTK_SPI_32BITS_MASK),
403 mdata->base + SPI_TX_SRC_REG);
404#ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
405 if (mdata->dev_comp->dma_ext)
406 writel((u32)(xfer->tx_dma >> 32),
407 mdata->base + SPI_TX_SRC_REG_64);
408#endif
409 }
410
411 if (mdata->rx_sgl) {
412 writel((u32)(xfer->rx_dma & MTK_SPI_32BITS_MASK),
413 mdata->base + SPI_RX_DST_REG);
414#ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
415 if (mdata->dev_comp->dma_ext)
416 writel((u32)(xfer->rx_dma >> 32),
417 mdata->base + SPI_RX_DST_REG_64);
418#endif
419 }
420}
421
422static int mtk_spi_fifo_transfer(struct spi_master *master,
423 struct spi_device *spi,
424 struct spi_transfer *xfer)
425{
426 int cnt, remainder;
427 u32 reg_val;
428 struct mtk_spi *mdata = spi_master_get_devdata(master);
429
430 mdata->cur_transfer = xfer;
431 mdata->xfer_len = min(MTK_SPI_MAX_FIFO_SIZE, xfer->len);
432 mdata->num_xfered = 0;
433 mtk_spi_prepare_transfer(master, xfer);
434 mtk_spi_setup_packet(master);
435
436 cnt = xfer->len / 4;
437 iowrite32_rep(mdata->base + SPI_TX_DATA_REG, xfer->tx_buf, cnt);
438
439 remainder = xfer->len % 4;
440 if (remainder > 0) {
441 reg_val = 0;
442 memcpy(®_val, xfer->tx_buf + (cnt * 4), remainder);
443 writel(reg_val, mdata->base + SPI_TX_DATA_REG);
444 }
445
446 mtk_spi_enable_transfer(master);
447
448 return 1;
449}
450
451static int mtk_spi_dma_transfer(struct spi_master *master,
452 struct spi_device *spi,
453 struct spi_transfer *xfer)
454{
455 int cmd;
456 struct mtk_spi *mdata = spi_master_get_devdata(master);
457
458 mdata->tx_sgl = NULL;
459 mdata->rx_sgl = NULL;
460 mdata->tx_sgl_len = 0;
461 mdata->rx_sgl_len = 0;
462 mdata->cur_transfer = xfer;
463 mdata->num_xfered = 0;
464
465 mtk_spi_prepare_transfer(master, xfer);
466
467 cmd = readl(mdata->base + SPI_CMD_REG);
468 if (xfer->tx_buf)
469 cmd |= SPI_CMD_TX_DMA;
470 if (xfer->rx_buf)
471 cmd |= SPI_CMD_RX_DMA;
472 writel(cmd, mdata->base + SPI_CMD_REG);
473
474 if (xfer->tx_buf)
475 mdata->tx_sgl = xfer->tx_sg.sgl;
476 if (xfer->rx_buf)
477 mdata->rx_sgl = xfer->rx_sg.sgl;
478
479 if (mdata->tx_sgl) {
480 xfer->tx_dma = sg_dma_address(mdata->tx_sgl);
481 mdata->tx_sgl_len = sg_dma_len(mdata->tx_sgl);
482 }
483 if (mdata->rx_sgl) {
484 xfer->rx_dma = sg_dma_address(mdata->rx_sgl);
485 mdata->rx_sgl_len = sg_dma_len(mdata->rx_sgl);
486 }
487
488 mtk_spi_update_mdata_len(master);
489 mtk_spi_setup_packet(master);
490 mtk_spi_setup_dma_addr(master, xfer);
491 mtk_spi_enable_transfer(master);
492
493 return 1;
494}
495
496static int mtk_spi_transfer_one(struct spi_master *master,
497 struct spi_device *spi,
498 struct spi_transfer *xfer)
499{
500 if (master->can_dma(master, spi, xfer))
501 return mtk_spi_dma_transfer(master, spi, xfer);
502 else
503 return mtk_spi_fifo_transfer(master, spi, xfer);
504}
505
506static bool mtk_spi_can_dma(struct spi_master *master,
507 struct spi_device *spi,
508 struct spi_transfer *xfer)
509{
510 /* Buffers for DMA transactions must be 4-byte aligned */
511 return (xfer->len > MTK_SPI_MAX_FIFO_SIZE &&
512 (unsigned long)xfer->tx_buf % 4 == 0 &&
513 (unsigned long)xfer->rx_buf % 4 == 0);
514}
515
516static int mtk_spi_setup(struct spi_device *spi)
517{
518 struct mtk_spi *mdata = spi_master_get_devdata(spi->master);
519
520 if (!spi->controller_data)
521 spi->controller_data = (void *)&mtk_default_chip_info;
522
523 if (mdata->dev_comp->need_pad_sel && gpio_is_valid(spi->cs_gpio))
524 gpio_direction_output(spi->cs_gpio, !(spi->mode & SPI_CS_HIGH));
525
526 return 0;
527}
528
529static irqreturn_t mtk_spi_interrupt(int irq, void *dev_id)
530{
531 u32 cmd, reg_val, cnt, remainder, len;
532 struct spi_master *master = dev_id;
533 struct mtk_spi *mdata = spi_master_get_devdata(master);
534 struct spi_transfer *trans = mdata->cur_transfer;
535
536 reg_val = readl(mdata->base + SPI_STATUS0_REG);
537 if (reg_val & MTK_SPI_PAUSE_INT_STATUS)
538 mdata->state = MTK_SPI_PAUSED;
539 else
540 mdata->state = MTK_SPI_IDLE;
541
542 if (!master->can_dma(master, master->cur_msg->spi, trans)) {
543 if (trans->rx_buf) {
544 cnt = mdata->xfer_len / 4;
545 ioread32_rep(mdata->base + SPI_RX_DATA_REG,
546 trans->rx_buf + mdata->num_xfered, cnt);
547 remainder = mdata->xfer_len % 4;
548 if (remainder > 0) {
549 reg_val = readl(mdata->base + SPI_RX_DATA_REG);
550 memcpy(trans->rx_buf +
551 mdata->num_xfered +
552 (cnt * 4),
553 ®_val,
554 remainder);
555 }
556 }
557
558 mdata->num_xfered += mdata->xfer_len;
559 if (mdata->num_xfered == trans->len) {
560 spi_finalize_current_transfer(master);
561 return IRQ_HANDLED;
562 }
563
564 len = trans->len - mdata->num_xfered;
565 mdata->xfer_len = min(MTK_SPI_MAX_FIFO_SIZE, len);
566 mtk_spi_setup_packet(master);
567
568 cnt = mdata->xfer_len / 4;
569 iowrite32_rep(mdata->base + SPI_TX_DATA_REG,
570 trans->tx_buf + mdata->num_xfered, cnt);
571
572 remainder = mdata->xfer_len % 4;
573 if (remainder > 0) {
574 reg_val = 0;
575 memcpy(®_val,
576 trans->tx_buf + (cnt * 4) + mdata->num_xfered,
577 remainder);
578 writel(reg_val, mdata->base + SPI_TX_DATA_REG);
579 }
580
581 mtk_spi_enable_transfer(master);
582
583 return IRQ_HANDLED;
584 }
585
586 if (mdata->tx_sgl)
587 trans->tx_dma += mdata->xfer_len;
588 if (mdata->rx_sgl)
589 trans->rx_dma += mdata->xfer_len;
590
591 if (mdata->tx_sgl && (mdata->tx_sgl_len == 0)) {
592 mdata->tx_sgl = sg_next(mdata->tx_sgl);
593 if (mdata->tx_sgl) {
594 trans->tx_dma = sg_dma_address(mdata->tx_sgl);
595 mdata->tx_sgl_len = sg_dma_len(mdata->tx_sgl);
596 }
597 }
598 if (mdata->rx_sgl && (mdata->rx_sgl_len == 0)) {
599 mdata->rx_sgl = sg_next(mdata->rx_sgl);
600 if (mdata->rx_sgl) {
601 trans->rx_dma = sg_dma_address(mdata->rx_sgl);
602 mdata->rx_sgl_len = sg_dma_len(mdata->rx_sgl);
603 }
604 }
605
606 if (!mdata->tx_sgl && !mdata->rx_sgl) {
607 /* spi disable dma */
608 cmd = readl(mdata->base + SPI_CMD_REG);
609 cmd &= ~SPI_CMD_TX_DMA;
610 cmd &= ~SPI_CMD_RX_DMA;
611 writel(cmd, mdata->base + SPI_CMD_REG);
612
613 spi_finalize_current_transfer(master);
614 return IRQ_HANDLED;
615 }
616
617 mtk_spi_update_mdata_len(master);
618 mtk_spi_setup_packet(master);
619 mtk_spi_setup_dma_addr(master, trans);
620 mtk_spi_enable_transfer(master);
621
622 return IRQ_HANDLED;
623}
624
625static int mtk_spi_probe(struct platform_device *pdev)
626{
627 struct spi_master *master;
628 struct mtk_spi *mdata;
629 const struct of_device_id *of_id;
630 int i, irq, ret, addr_bits;
631
632 master = spi_alloc_master(&pdev->dev, sizeof(*mdata));
633 if (!master) {
634 dev_err(&pdev->dev, "failed to alloc spi master\n");
635 return -ENOMEM;
636 }
637
638 master->auto_runtime_pm = true;
639 master->dev.of_node = pdev->dev.of_node;
640 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_LSB_FIRST;
641
642 master->set_cs = mtk_spi_set_cs;
643 master->prepare_message = mtk_spi_prepare_message;
644 master->transfer_one = mtk_spi_transfer_one;
645 master->can_dma = mtk_spi_can_dma;
646 master->setup = mtk_spi_setup;
647
648 of_id = of_match_node(mtk_spi_of_match, pdev->dev.of_node);
649 if (!of_id) {
650 dev_err(&pdev->dev, "failed to probe of_node\n");
651 ret = -EINVAL;
652 goto err_put_master;
653 }
654
655 mdata = spi_master_get_devdata(master);
656 mdata->dev_comp = of_id->data;
657
658 if (mdata->dev_comp->enhance_timing)
659 master->mode_bits |= SPI_CS_HIGH;
660
661 if (mdata->dev_comp->must_tx)
662 master->flags = SPI_MASTER_MUST_TX;
663
664 if (mdata->dev_comp->need_pad_sel) {
665 mdata->pad_num = of_property_count_u32_elems(
666 pdev->dev.of_node,
667 "mediatek,pad-select");
668 if (mdata->pad_num < 0) {
669 dev_err(&pdev->dev,
670 "No 'mediatek,pad-select' property\n");
671 ret = -EINVAL;
672 goto err_put_master;
673 }
674
675 mdata->pad_sel = devm_kmalloc_array(&pdev->dev, mdata->pad_num,
676 sizeof(u32), GFP_KERNEL);
677 if (!mdata->pad_sel) {
678 ret = -ENOMEM;
679 goto err_put_master;
680 }
681
682 for (i = 0; i < mdata->pad_num; i++) {
683 of_property_read_u32_index(pdev->dev.of_node,
684 "mediatek,pad-select",
685 i, &mdata->pad_sel[i]);
686 if (mdata->pad_sel[i] > MT8173_SPI_MAX_PAD_SEL) {
687 dev_err(&pdev->dev, "wrong pad-sel[%d]: %u\n",
688 i, mdata->pad_sel[i]);
689 ret = -EINVAL;
690 goto err_put_master;
691 }
692 }
693 }
694
695 platform_set_drvdata(pdev, master);
696 mdata->base = devm_platform_ioremap_resource(pdev, 0);
697 if (IS_ERR(mdata->base)) {
698 ret = PTR_ERR(mdata->base);
699 goto err_put_master;
700 }
701
702 irq = platform_get_irq(pdev, 0);
703 if (irq < 0) {
704 ret = irq;
705 goto err_put_master;
706 }
707
708 if (!pdev->dev.dma_mask)
709 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
710
711 ret = devm_request_irq(&pdev->dev, irq, mtk_spi_interrupt,
712 IRQF_TRIGGER_NONE, dev_name(&pdev->dev), master);
713 if (ret) {
714 dev_err(&pdev->dev, "failed to register irq (%d)\n", ret);
715 goto err_put_master;
716 }
717
718 mdata->parent_clk = devm_clk_get(&pdev->dev, "parent-clk");
719 if (IS_ERR(mdata->parent_clk)) {
720 ret = PTR_ERR(mdata->parent_clk);
721 dev_err(&pdev->dev, "failed to get parent-clk: %d\n", ret);
722 goto err_put_master;
723 }
724
725 mdata->sel_clk = devm_clk_get(&pdev->dev, "sel-clk");
726 if (IS_ERR(mdata->sel_clk)) {
727 ret = PTR_ERR(mdata->sel_clk);
728 dev_err(&pdev->dev, "failed to get sel-clk: %d\n", ret);
729 goto err_put_master;
730 }
731
732 mdata->spi_clk = devm_clk_get(&pdev->dev, "spi-clk");
733 if (IS_ERR(mdata->spi_clk)) {
734 ret = PTR_ERR(mdata->spi_clk);
735 dev_err(&pdev->dev, "failed to get spi-clk: %d\n", ret);
736 goto err_put_master;
737 }
738
739 ret = clk_prepare_enable(mdata->spi_clk);
740 if (ret < 0) {
741 dev_err(&pdev->dev, "failed to enable spi_clk (%d)\n", ret);
742 goto err_put_master;
743 }
744
745 ret = clk_set_parent(mdata->sel_clk, mdata->parent_clk);
746 if (ret < 0) {
747 dev_err(&pdev->dev, "failed to clk_set_parent (%d)\n", ret);
748 clk_disable_unprepare(mdata->spi_clk);
749 goto err_put_master;
750 }
751
752 clk_disable_unprepare(mdata->spi_clk);
753
754 pm_runtime_enable(&pdev->dev);
755
756 ret = devm_spi_register_master(&pdev->dev, master);
757 if (ret) {
758 dev_err(&pdev->dev, "failed to register master (%d)\n", ret);
759 goto err_disable_runtime_pm;
760 }
761
762 if (mdata->dev_comp->need_pad_sel) {
763 if (mdata->pad_num != master->num_chipselect) {
764 dev_err(&pdev->dev,
765 "pad_num does not match num_chipselect(%d != %d)\n",
766 mdata->pad_num, master->num_chipselect);
767 ret = -EINVAL;
768 goto err_disable_runtime_pm;
769 }
770
771 if (!master->cs_gpios && master->num_chipselect > 1) {
772 dev_err(&pdev->dev,
773 "cs_gpios not specified and num_chipselect > 1\n");
774 ret = -EINVAL;
775 goto err_disable_runtime_pm;
776 }
777
778 if (master->cs_gpios) {
779 for (i = 0; i < master->num_chipselect; i++) {
780 ret = devm_gpio_request(&pdev->dev,
781 master->cs_gpios[i],
782 dev_name(&pdev->dev));
783 if (ret) {
784 dev_err(&pdev->dev,
785 "can't get CS GPIO %i\n", i);
786 goto err_disable_runtime_pm;
787 }
788 }
789 }
790 }
791
792 if (mdata->dev_comp->dma_ext)
793 addr_bits = DMA_ADDR_EXT_BITS;
794 else
795 addr_bits = DMA_ADDR_DEF_BITS;
796 ret = dma_set_mask(&pdev->dev, DMA_BIT_MASK(addr_bits));
797 if (ret)
798 dev_notice(&pdev->dev, "SPI dma_set_mask(%d) failed, ret:%d\n",
799 addr_bits, ret);
800
801 return 0;
802
803err_disable_runtime_pm:
804 pm_runtime_disable(&pdev->dev);
805err_put_master:
806 spi_master_put(master);
807
808 return ret;
809}
810
811static int mtk_spi_remove(struct platform_device *pdev)
812{
813 struct spi_master *master = platform_get_drvdata(pdev);
814 struct mtk_spi *mdata = spi_master_get_devdata(master);
815
816 pm_runtime_disable(&pdev->dev);
817
818 mtk_spi_reset(mdata);
819
820 return 0;
821}
822
823#ifdef CONFIG_PM_SLEEP
824static int mtk_spi_suspend(struct device *dev)
825{
826 int ret;
827 struct spi_master *master = dev_get_drvdata(dev);
828 struct mtk_spi *mdata = spi_master_get_devdata(master);
829
830 ret = spi_master_suspend(master);
831 if (ret)
832 return ret;
833
834 if (!pm_runtime_suspended(dev))
835 clk_disable_unprepare(mdata->spi_clk);
836
837 return ret;
838}
839
840static int mtk_spi_resume(struct device *dev)
841{
842 int ret;
843 struct spi_master *master = dev_get_drvdata(dev);
844 struct mtk_spi *mdata = spi_master_get_devdata(master);
845
846 if (!pm_runtime_suspended(dev)) {
847 ret = clk_prepare_enable(mdata->spi_clk);
848 if (ret < 0) {
849 dev_err(dev, "failed to enable spi_clk (%d)\n", ret);
850 return ret;
851 }
852 }
853
854 ret = spi_master_resume(master);
855 if (ret < 0)
856 clk_disable_unprepare(mdata->spi_clk);
857
858 return ret;
859}
860#endif /* CONFIG_PM_SLEEP */
861
862#ifdef CONFIG_PM
863static int mtk_spi_runtime_suspend(struct device *dev)
864{
865 struct spi_master *master = dev_get_drvdata(dev);
866 struct mtk_spi *mdata = spi_master_get_devdata(master);
867
868 clk_disable_unprepare(mdata->spi_clk);
869
870 return 0;
871}
872
873static int mtk_spi_runtime_resume(struct device *dev)
874{
875 struct spi_master *master = dev_get_drvdata(dev);
876 struct mtk_spi *mdata = spi_master_get_devdata(master);
877 int ret;
878
879 ret = clk_prepare_enable(mdata->spi_clk);
880 if (ret < 0) {
881 dev_err(dev, "failed to enable spi_clk (%d)\n", ret);
882 return ret;
883 }
884
885 return 0;
886}
887#endif /* CONFIG_PM */
888
889static const struct dev_pm_ops mtk_spi_pm = {
890 SET_SYSTEM_SLEEP_PM_OPS(mtk_spi_suspend, mtk_spi_resume)
891 SET_RUNTIME_PM_OPS(mtk_spi_runtime_suspend,
892 mtk_spi_runtime_resume, NULL)
893};
894
895static struct platform_driver mtk_spi_driver = {
896 .driver = {
897 .name = "mtk-spi",
898 .pm = &mtk_spi_pm,
899 .of_match_table = mtk_spi_of_match,
900 },
901 .probe = mtk_spi_probe,
902 .remove = mtk_spi_remove,
903};
904
905module_platform_driver(mtk_spi_driver);
906
907MODULE_DESCRIPTION("MTK SPI Controller driver");
908MODULE_AUTHOR("Leilk Liu <leilk.liu@mediatek.com>");
909MODULE_LICENSE("GPL v2");
910MODULE_ALIAS("platform:mtk-spi");