2 * Copyright 2004-2007 Freescale Semiconductor, Inc. All Rights Reserved.
3 * Copyright (C) 2008 Juergen Beisert
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
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.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the
16 * Free Software Foundation
17 * 51 Franklin Street, Fifth Floor
18 * Boston, MA 02110-1301, USA.
21 #include <linux/clk.h>
22 #include <linux/completion.h>
23 #include <linux/delay.h>
24 #include <linux/dmaengine.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/err.h>
27 #include <linux/gpio.h>
28 #include <linux/interrupt.h>
30 #include <linux/irq.h>
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/platform_device.h>
34 #include <linux/slab.h>
35 #include <linux/spi/spi.h>
36 #include <linux/spi/spi_bitbang.h>
37 #include <linux/types.h>
39 #include <linux/of_device.h>
40 #include <linux/of_gpio.h>
42 #include <linux/platform_data/dma-imx.h>
43 #include <linux/platform_data/spi-imx.h>
45 #define DRIVER_NAME "spi_imx"
47 #define MXC_CSPIRXDATA 0x00
48 #define MXC_CSPITXDATA 0x04
49 #define MXC_CSPICTRL 0x08
50 #define MXC_CSPIINT 0x0c
51 #define MXC_RESET 0x1c
53 /* generic defines to abstract from the different register layouts */
54 #define MXC_INT_RR (1 << 0) /* Receive data ready interrupt */
55 #define MXC_INT_TE (1 << 1) /* Transmit FIFO empty interrupt */
57 /* The maximum bytes that a sdma BD can transfer.*/
58 #define MAX_SDMA_BD_BYTES (1 << 15)
59 #define IMX_DMA_TIMEOUT (msecs_to_jiffies(3000))
60 struct spi_imx_config {
61 unsigned int speed_hz;
67 enum spi_imx_devtype {
72 IMX35_CSPI, /* CSPI on all i.mx except above */
73 IMX51_ECSPI, /* ECSPI on i.mx51 and later */
78 struct spi_imx_devtype_data {
79 void (*intctrl)(struct spi_imx_data *, int);
80 int (*config)(struct spi_imx_data *, struct spi_imx_config *);
81 void (*trigger)(struct spi_imx_data *);
82 int (*rx_available)(struct spi_imx_data *);
83 void (*reset)(struct spi_imx_data *);
84 enum spi_imx_devtype devtype;
88 struct spi_bitbang bitbang;
91 struct completion xfer_done;
95 unsigned long spi_clk;
98 void (*tx)(struct spi_imx_data *);
99 void (*rx)(struct spi_imx_data *);
102 unsigned int txfifo; /* number of words pushed in tx FIFO */
105 unsigned int dma_is_inited;
106 unsigned int dma_finished;
109 struct completion dma_rx_completion;
110 struct completion dma_tx_completion;
112 const struct spi_imx_devtype_data *devtype_data;
116 static inline int is_imx27_cspi(struct spi_imx_data *d)
118 return d->devtype_data->devtype == IMX27_CSPI;
121 static inline int is_imx35_cspi(struct spi_imx_data *d)
123 return d->devtype_data->devtype == IMX35_CSPI;
126 static inline int is_imx51_ecspi(struct spi_imx_data *d)
128 return d->devtype_data->devtype == IMX51_ECSPI;
131 static inline unsigned spi_imx_get_fifosize(struct spi_imx_data *d)
133 return is_imx51_ecspi(d) ? 64 : 8;
136 #define MXC_SPI_BUF_RX(type) \
137 static void spi_imx_buf_rx_##type(struct spi_imx_data *spi_imx) \
139 unsigned int val = readl(spi_imx->base + MXC_CSPIRXDATA); \
141 if (spi_imx->rx_buf) { \
142 *(type *)spi_imx->rx_buf = val; \
143 spi_imx->rx_buf += sizeof(type); \
147 #define MXC_SPI_BUF_TX(type) \
148 static void spi_imx_buf_tx_##type(struct spi_imx_data *spi_imx) \
152 if (spi_imx->tx_buf) { \
153 val = *(type *)spi_imx->tx_buf; \
154 spi_imx->tx_buf += sizeof(type); \
157 spi_imx->count -= sizeof(type); \
159 writel(val, spi_imx->base + MXC_CSPITXDATA); \
169 /* First entry is reserved, second entry is valid only if SDHC_SPIEN is set
170 * (which is currently not the case in this driver)
172 static int mxc_clkdivs[] = {0, 3, 4, 6, 8, 12, 16, 24, 32, 48, 64, 96, 128, 192,
173 256, 384, 512, 768, 1024};
176 static unsigned int spi_imx_clkdiv_1(unsigned int fin,
177 unsigned int fspi, unsigned int max)
181 for (i = 2; i < max; i++)
182 if (fspi * mxc_clkdivs[i] >= fin)
188 /* MX1, MX31, MX35, MX51 CSPI */
189 static unsigned int spi_imx_clkdiv_2(unsigned int fin,
194 for (i = 0; i < 7; i++) {
195 if (fspi * div >= fin)
203 static bool spi_imx_can_dma(struct spi_master *master, struct spi_device *spi,
204 struct spi_transfer *transfer)
206 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
208 if (spi_imx->dma_is_inited && transfer->len >= spi_imx->wml &&
209 (transfer->len % spi_imx->wml) == 0)
214 #define MX51_ECSPI_CTRL 0x08
215 #define MX51_ECSPI_CTRL_ENABLE (1 << 0)
216 #define MX51_ECSPI_CTRL_XCH (1 << 2)
217 #define MX51_ECSPI_CTRL_SMC (1 << 3)
218 #define MX51_ECSPI_CTRL_MODE_MASK (0xf << 4)
219 #define MX51_ECSPI_CTRL_POSTDIV_OFFSET 8
220 #define MX51_ECSPI_CTRL_PREDIV_OFFSET 12
221 #define MX51_ECSPI_CTRL_CS(cs) ((cs) << 18)
222 #define MX51_ECSPI_CTRL_BL_OFFSET 20
224 #define MX51_ECSPI_CONFIG 0x0c
225 #define MX51_ECSPI_CONFIG_SCLKPHA(cs) (1 << ((cs) + 0))
226 #define MX51_ECSPI_CONFIG_SCLKPOL(cs) (1 << ((cs) + 4))
227 #define MX51_ECSPI_CONFIG_SBBCTRL(cs) (1 << ((cs) + 8))
228 #define MX51_ECSPI_CONFIG_SSBPOL(cs) (1 << ((cs) + 12))
229 #define MX51_ECSPI_CONFIG_SCLKCTL(cs) (1 << ((cs) + 20))
231 #define MX51_ECSPI_INT 0x10
232 #define MX51_ECSPI_INT_TEEN (1 << 0)
233 #define MX51_ECSPI_INT_RREN (1 << 3)
235 #define MX51_ECSPI_DMA 0x14
236 #define MX51_ECSPI_DMA_TX_WML_OFFSET 0
237 #define MX51_ECSPI_DMA_TX_WML_MASK 0x3F
238 #define MX51_ECSPI_DMA_RX_WML_OFFSET 16
239 #define MX51_ECSPI_DMA_RX_WML_MASK (0x3F << 16)
240 #define MX51_ECSPI_DMA_RXT_WML_OFFSET 24
241 #define MX51_ECSPI_DMA_RXT_WML_MASK (0x3F << 24)
243 #define MX51_ECSPI_DMA_TEDEN_OFFSET 7
244 #define MX51_ECSPI_DMA_RXDEN_OFFSET 23
245 #define MX51_ECSPI_DMA_RXTDEN_OFFSET 31
247 #define MX51_ECSPI_STAT 0x18
248 #define MX51_ECSPI_STAT_RR (1 << 3)
250 #define MX51_ECSPI_TESTREG 0x20
251 #define MX51_ECSPI_TESTREG_LBC BIT(31)
254 static unsigned int mx51_ecspi_clkdiv(struct spi_imx_data *spi_imx,
255 unsigned int fspi, unsigned int *fres)
258 * there are two 4-bit dividers, the pre-divider divides by
259 * $pre, the post-divider by 2^$post
261 unsigned int pre, post;
262 unsigned int fin = spi_imx->spi_clk;
264 if (unlikely(fspi > fin))
267 post = fls(fin) - fls(fspi);
268 if (fin > fspi << post)
271 /* now we have: (fin <= fspi << post) with post being minimal */
273 post = max(4U, post) - 4;
274 if (unlikely(post > 0xf)) {
275 dev_err(spi_imx->dev, "cannot set clock freq: %u (base freq: %u)\n",
280 pre = DIV_ROUND_UP(fin, fspi << post) - 1;
282 dev_dbg(spi_imx->dev, "%s: fin: %u, fspi: %u, post: %u, pre: %u\n",
283 __func__, fin, fspi, post, pre);
285 /* Resulting frequency for the SCLK line. */
286 *fres = (fin / (pre + 1)) >> post;
288 return (pre << MX51_ECSPI_CTRL_PREDIV_OFFSET) |
289 (post << MX51_ECSPI_CTRL_POSTDIV_OFFSET);
292 static void __maybe_unused mx51_ecspi_intctrl(struct spi_imx_data *spi_imx, int enable)
296 if (enable & MXC_INT_TE)
297 val |= MX51_ECSPI_INT_TEEN;
299 if (enable & MXC_INT_RR)
300 val |= MX51_ECSPI_INT_RREN;
302 writel(val, spi_imx->base + MX51_ECSPI_INT);
305 static void __maybe_unused mx51_ecspi_trigger(struct spi_imx_data *spi_imx)
307 u32 reg = readl(spi_imx->base + MX51_ECSPI_CTRL);
309 if (!spi_imx->usedma)
310 reg |= MX51_ECSPI_CTRL_XCH;
311 else if (!spi_imx->dma_finished)
312 reg |= MX51_ECSPI_CTRL_SMC;
314 reg &= ~MX51_ECSPI_CTRL_SMC;
315 writel(reg, spi_imx->base + MX51_ECSPI_CTRL);
318 static int __maybe_unused mx51_ecspi_config(struct spi_imx_data *spi_imx,
319 struct spi_imx_config *config)
321 u32 ctrl = MX51_ECSPI_CTRL_ENABLE, cfg = 0, dma = 0;
322 u32 tx_wml_cfg, rx_wml_cfg, rxt_wml_cfg;
323 u32 clk = config->speed_hz, delay, reg;
326 * The hardware seems to have a race condition when changing modes. The
327 * current assumption is that the selection of the channel arrives
328 * earlier in the hardware than the mode bits when they are written at
330 * So set master mode for all channels as we do not support slave mode.
332 ctrl |= MX51_ECSPI_CTRL_MODE_MASK;
334 /* set clock speed */
335 ctrl |= mx51_ecspi_clkdiv(spi_imx, config->speed_hz, &clk);
337 /* set chip select to use */
338 ctrl |= MX51_ECSPI_CTRL_CS(config->cs);
340 ctrl |= (config->bpw - 1) << MX51_ECSPI_CTRL_BL_OFFSET;
342 cfg |= MX51_ECSPI_CONFIG_SBBCTRL(config->cs);
344 if (config->mode & SPI_CPHA)
345 cfg |= MX51_ECSPI_CONFIG_SCLKPHA(config->cs);
347 cfg &= ~MX51_ECSPI_CONFIG_SCLKPHA(config->cs);
349 if (config->mode & SPI_CPOL) {
350 cfg |= MX51_ECSPI_CONFIG_SCLKPOL(config->cs);
351 cfg |= MX51_ECSPI_CONFIG_SCLKCTL(config->cs);
353 cfg &= ~MX51_ECSPI_CONFIG_SCLKPOL(config->cs);
354 cfg &= ~MX51_ECSPI_CONFIG_SCLKCTL(config->cs);
356 if (config->mode & SPI_CS_HIGH)
357 cfg |= MX51_ECSPI_CONFIG_SSBPOL(config->cs);
359 cfg &= ~MX51_ECSPI_CONFIG_SSBPOL(config->cs);
361 /* CTRL register always go first to bring out controller from reset */
362 writel(ctrl, spi_imx->base + MX51_ECSPI_CTRL);
364 reg = readl(spi_imx->base + MX51_ECSPI_TESTREG);
365 if (config->mode & SPI_LOOP)
366 reg |= MX51_ECSPI_TESTREG_LBC;
368 reg &= ~MX51_ECSPI_TESTREG_LBC;
369 writel(reg, spi_imx->base + MX51_ECSPI_TESTREG);
371 writel(cfg, spi_imx->base + MX51_ECSPI_CONFIG);
374 * Wait until the changes in the configuration register CONFIGREG
375 * propagate into the hardware. It takes exactly one tick of the
376 * SCLK clock, but we will wait two SCLK clock just to be sure. The
377 * effect of the delay it takes for the hardware to apply changes
378 * is noticable if the SCLK clock run very slow. In such a case, if
379 * the polarity of SCLK should be inverted, the GPIO ChipSelect might
380 * be asserted before the SCLK polarity changes, which would disrupt
381 * the SPI communication as the device on the other end would consider
382 * the change of SCLK polarity as a clock tick already.
384 delay = (2 * 1000000) / clk;
385 if (likely(delay < 10)) /* SCLK is faster than 100 kHz */
387 else /* SCLK is _very_ slow */
388 usleep_range(delay, delay + 10);
391 * Configure the DMA register: setup the watermark
392 * and enable DMA request.
394 if (spi_imx->dma_is_inited) {
395 dma = readl(spi_imx->base + MX51_ECSPI_DMA);
397 rx_wml_cfg = spi_imx->wml << MX51_ECSPI_DMA_RX_WML_OFFSET;
398 tx_wml_cfg = spi_imx->wml << MX51_ECSPI_DMA_TX_WML_OFFSET;
399 rxt_wml_cfg = spi_imx->wml << MX51_ECSPI_DMA_RXT_WML_OFFSET;
400 dma = (dma & ~MX51_ECSPI_DMA_TX_WML_MASK
401 & ~MX51_ECSPI_DMA_RX_WML_MASK
402 & ~MX51_ECSPI_DMA_RXT_WML_MASK)
403 | rx_wml_cfg | tx_wml_cfg | rxt_wml_cfg
404 |(1 << MX51_ECSPI_DMA_TEDEN_OFFSET)
405 |(1 << MX51_ECSPI_DMA_RXDEN_OFFSET)
406 |(1 << MX51_ECSPI_DMA_RXTDEN_OFFSET);
408 writel(dma, spi_imx->base + MX51_ECSPI_DMA);
414 static int __maybe_unused mx51_ecspi_rx_available(struct spi_imx_data *spi_imx)
416 return readl(spi_imx->base + MX51_ECSPI_STAT) & MX51_ECSPI_STAT_RR;
419 static void __maybe_unused mx51_ecspi_reset(struct spi_imx_data *spi_imx)
421 /* drain receive buffer */
422 while (mx51_ecspi_rx_available(spi_imx))
423 readl(spi_imx->base + MXC_CSPIRXDATA);
426 #define MX31_INTREG_TEEN (1 << 0)
427 #define MX31_INTREG_RREN (1 << 3)
429 #define MX31_CSPICTRL_ENABLE (1 << 0)
430 #define MX31_CSPICTRL_MASTER (1 << 1)
431 #define MX31_CSPICTRL_XCH (1 << 2)
432 #define MX31_CSPICTRL_POL (1 << 4)
433 #define MX31_CSPICTRL_PHA (1 << 5)
434 #define MX31_CSPICTRL_SSCTL (1 << 6)
435 #define MX31_CSPICTRL_SSPOL (1 << 7)
436 #define MX31_CSPICTRL_BC_SHIFT 8
437 #define MX35_CSPICTRL_BL_SHIFT 20
438 #define MX31_CSPICTRL_CS_SHIFT 24
439 #define MX35_CSPICTRL_CS_SHIFT 12
440 #define MX31_CSPICTRL_DR_SHIFT 16
442 #define MX31_CSPISTATUS 0x14
443 #define MX31_STATUS_RR (1 << 3)
445 /* These functions also work for the i.MX35, but be aware that
446 * the i.MX35 has a slightly different register layout for bits
447 * we do not use here.
449 static void __maybe_unused mx31_intctrl(struct spi_imx_data *spi_imx, int enable)
451 unsigned int val = 0;
453 if (enable & MXC_INT_TE)
454 val |= MX31_INTREG_TEEN;
455 if (enable & MXC_INT_RR)
456 val |= MX31_INTREG_RREN;
458 writel(val, spi_imx->base + MXC_CSPIINT);
461 static void __maybe_unused mx31_trigger(struct spi_imx_data *spi_imx)
465 reg = readl(spi_imx->base + MXC_CSPICTRL);
466 reg |= MX31_CSPICTRL_XCH;
467 writel(reg, spi_imx->base + MXC_CSPICTRL);
470 static int __maybe_unused mx31_config(struct spi_imx_data *spi_imx,
471 struct spi_imx_config *config)
473 unsigned int reg = MX31_CSPICTRL_ENABLE | MX31_CSPICTRL_MASTER;
474 int cs = spi_imx->chipselect[config->cs];
476 reg |= spi_imx_clkdiv_2(spi_imx->spi_clk, config->speed_hz) <<
477 MX31_CSPICTRL_DR_SHIFT;
479 if (is_imx35_cspi(spi_imx)) {
480 reg |= (config->bpw - 1) << MX35_CSPICTRL_BL_SHIFT;
481 reg |= MX31_CSPICTRL_SSCTL;
483 reg |= (config->bpw - 1) << MX31_CSPICTRL_BC_SHIFT;
486 if (config->mode & SPI_CPHA)
487 reg |= MX31_CSPICTRL_PHA;
488 if (config->mode & SPI_CPOL)
489 reg |= MX31_CSPICTRL_POL;
490 if (config->mode & SPI_CS_HIGH)
491 reg |= MX31_CSPICTRL_SSPOL;
494 (is_imx35_cspi(spi_imx) ? MX35_CSPICTRL_CS_SHIFT :
495 MX31_CSPICTRL_CS_SHIFT);
497 writel(reg, spi_imx->base + MXC_CSPICTRL);
502 static int __maybe_unused mx31_rx_available(struct spi_imx_data *spi_imx)
504 return readl(spi_imx->base + MX31_CSPISTATUS) & MX31_STATUS_RR;
507 static void __maybe_unused mx31_reset(struct spi_imx_data *spi_imx)
509 /* drain receive buffer */
510 while (readl(spi_imx->base + MX31_CSPISTATUS) & MX31_STATUS_RR)
511 readl(spi_imx->base + MXC_CSPIRXDATA);
514 #define MX21_INTREG_RR (1 << 4)
515 #define MX21_INTREG_TEEN (1 << 9)
516 #define MX21_INTREG_RREN (1 << 13)
518 #define MX21_CSPICTRL_POL (1 << 5)
519 #define MX21_CSPICTRL_PHA (1 << 6)
520 #define MX21_CSPICTRL_SSPOL (1 << 8)
521 #define MX21_CSPICTRL_XCH (1 << 9)
522 #define MX21_CSPICTRL_ENABLE (1 << 10)
523 #define MX21_CSPICTRL_MASTER (1 << 11)
524 #define MX21_CSPICTRL_DR_SHIFT 14
525 #define MX21_CSPICTRL_CS_SHIFT 19
527 static void __maybe_unused mx21_intctrl(struct spi_imx_data *spi_imx, int enable)
529 unsigned int val = 0;
531 if (enable & MXC_INT_TE)
532 val |= MX21_INTREG_TEEN;
533 if (enable & MXC_INT_RR)
534 val |= MX21_INTREG_RREN;
536 writel(val, spi_imx->base + MXC_CSPIINT);
539 static void __maybe_unused mx21_trigger(struct spi_imx_data *spi_imx)
543 reg = readl(spi_imx->base + MXC_CSPICTRL);
544 reg |= MX21_CSPICTRL_XCH;
545 writel(reg, spi_imx->base + MXC_CSPICTRL);
548 static int __maybe_unused mx21_config(struct spi_imx_data *spi_imx,
549 struct spi_imx_config *config)
551 unsigned int reg = MX21_CSPICTRL_ENABLE | MX21_CSPICTRL_MASTER;
552 int cs = spi_imx->chipselect[config->cs];
553 unsigned int max = is_imx27_cspi(spi_imx) ? 16 : 18;
555 reg |= spi_imx_clkdiv_1(spi_imx->spi_clk, config->speed_hz, max) <<
556 MX21_CSPICTRL_DR_SHIFT;
557 reg |= config->bpw - 1;
559 if (config->mode & SPI_CPHA)
560 reg |= MX21_CSPICTRL_PHA;
561 if (config->mode & SPI_CPOL)
562 reg |= MX21_CSPICTRL_POL;
563 if (config->mode & SPI_CS_HIGH)
564 reg |= MX21_CSPICTRL_SSPOL;
566 reg |= (cs + 32) << MX21_CSPICTRL_CS_SHIFT;
568 writel(reg, spi_imx->base + MXC_CSPICTRL);
573 static int __maybe_unused mx21_rx_available(struct spi_imx_data *spi_imx)
575 return readl(spi_imx->base + MXC_CSPIINT) & MX21_INTREG_RR;
578 static void __maybe_unused mx21_reset(struct spi_imx_data *spi_imx)
580 writel(1, spi_imx->base + MXC_RESET);
583 #define MX1_INTREG_RR (1 << 3)
584 #define MX1_INTREG_TEEN (1 << 8)
585 #define MX1_INTREG_RREN (1 << 11)
587 #define MX1_CSPICTRL_POL (1 << 4)
588 #define MX1_CSPICTRL_PHA (1 << 5)
589 #define MX1_CSPICTRL_XCH (1 << 8)
590 #define MX1_CSPICTRL_ENABLE (1 << 9)
591 #define MX1_CSPICTRL_MASTER (1 << 10)
592 #define MX1_CSPICTRL_DR_SHIFT 13
594 static void __maybe_unused mx1_intctrl(struct spi_imx_data *spi_imx, int enable)
596 unsigned int val = 0;
598 if (enable & MXC_INT_TE)
599 val |= MX1_INTREG_TEEN;
600 if (enable & MXC_INT_RR)
601 val |= MX1_INTREG_RREN;
603 writel(val, spi_imx->base + MXC_CSPIINT);
606 static void __maybe_unused mx1_trigger(struct spi_imx_data *spi_imx)
610 reg = readl(spi_imx->base + MXC_CSPICTRL);
611 reg |= MX1_CSPICTRL_XCH;
612 writel(reg, spi_imx->base + MXC_CSPICTRL);
615 static int __maybe_unused mx1_config(struct spi_imx_data *spi_imx,
616 struct spi_imx_config *config)
618 unsigned int reg = MX1_CSPICTRL_ENABLE | MX1_CSPICTRL_MASTER;
620 reg |= spi_imx_clkdiv_2(spi_imx->spi_clk, config->speed_hz) <<
621 MX1_CSPICTRL_DR_SHIFT;
622 reg |= config->bpw - 1;
624 if (config->mode & SPI_CPHA)
625 reg |= MX1_CSPICTRL_PHA;
626 if (config->mode & SPI_CPOL)
627 reg |= MX1_CSPICTRL_POL;
629 writel(reg, spi_imx->base + MXC_CSPICTRL);
634 static int __maybe_unused mx1_rx_available(struct spi_imx_data *spi_imx)
636 return readl(spi_imx->base + MXC_CSPIINT) & MX1_INTREG_RR;
639 static void __maybe_unused mx1_reset(struct spi_imx_data *spi_imx)
641 writel(1, spi_imx->base + MXC_RESET);
644 static struct spi_imx_devtype_data imx1_cspi_devtype_data = {
645 .intctrl = mx1_intctrl,
646 .config = mx1_config,
647 .trigger = mx1_trigger,
648 .rx_available = mx1_rx_available,
650 .devtype = IMX1_CSPI,
653 static struct spi_imx_devtype_data imx21_cspi_devtype_data = {
654 .intctrl = mx21_intctrl,
655 .config = mx21_config,
656 .trigger = mx21_trigger,
657 .rx_available = mx21_rx_available,
659 .devtype = IMX21_CSPI,
662 static struct spi_imx_devtype_data imx27_cspi_devtype_data = {
663 /* i.mx27 cspi shares the functions with i.mx21 one */
664 .intctrl = mx21_intctrl,
665 .config = mx21_config,
666 .trigger = mx21_trigger,
667 .rx_available = mx21_rx_available,
669 .devtype = IMX27_CSPI,
672 static struct spi_imx_devtype_data imx31_cspi_devtype_data = {
673 .intctrl = mx31_intctrl,
674 .config = mx31_config,
675 .trigger = mx31_trigger,
676 .rx_available = mx31_rx_available,
678 .devtype = IMX31_CSPI,
681 static struct spi_imx_devtype_data imx35_cspi_devtype_data = {
682 /* i.mx35 and later cspi shares the functions with i.mx31 one */
683 .intctrl = mx31_intctrl,
684 .config = mx31_config,
685 .trigger = mx31_trigger,
686 .rx_available = mx31_rx_available,
688 .devtype = IMX35_CSPI,
691 static struct spi_imx_devtype_data imx51_ecspi_devtype_data = {
692 .intctrl = mx51_ecspi_intctrl,
693 .config = mx51_ecspi_config,
694 .trigger = mx51_ecspi_trigger,
695 .rx_available = mx51_ecspi_rx_available,
696 .reset = mx51_ecspi_reset,
697 .devtype = IMX51_ECSPI,
700 static const struct platform_device_id spi_imx_devtype[] = {
703 .driver_data = (kernel_ulong_t) &imx1_cspi_devtype_data,
705 .name = "imx21-cspi",
706 .driver_data = (kernel_ulong_t) &imx21_cspi_devtype_data,
708 .name = "imx27-cspi",
709 .driver_data = (kernel_ulong_t) &imx27_cspi_devtype_data,
711 .name = "imx31-cspi",
712 .driver_data = (kernel_ulong_t) &imx31_cspi_devtype_data,
714 .name = "imx35-cspi",
715 .driver_data = (kernel_ulong_t) &imx35_cspi_devtype_data,
717 .name = "imx51-ecspi",
718 .driver_data = (kernel_ulong_t) &imx51_ecspi_devtype_data,
724 static const struct of_device_id spi_imx_dt_ids[] = {
725 { .compatible = "fsl,imx1-cspi", .data = &imx1_cspi_devtype_data, },
726 { .compatible = "fsl,imx21-cspi", .data = &imx21_cspi_devtype_data, },
727 { .compatible = "fsl,imx27-cspi", .data = &imx27_cspi_devtype_data, },
728 { .compatible = "fsl,imx31-cspi", .data = &imx31_cspi_devtype_data, },
729 { .compatible = "fsl,imx35-cspi", .data = &imx35_cspi_devtype_data, },
730 { .compatible = "fsl,imx51-ecspi", .data = &imx51_ecspi_devtype_data, },
733 MODULE_DEVICE_TABLE(of, spi_imx_dt_ids);
735 static void spi_imx_chipselect(struct spi_device *spi, int is_active)
737 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
738 int gpio = spi_imx->chipselect[spi->chip_select];
739 int active = is_active != BITBANG_CS_INACTIVE;
740 int dev_is_lowactive = !(spi->mode & SPI_CS_HIGH);
742 if (!gpio_is_valid(gpio))
745 gpio_set_value(gpio, dev_is_lowactive ^ active);
748 static void spi_imx_push(struct spi_imx_data *spi_imx)
750 while (spi_imx->txfifo < spi_imx_get_fifosize(spi_imx)) {
753 spi_imx->tx(spi_imx);
757 spi_imx->devtype_data->trigger(spi_imx);
760 static irqreturn_t spi_imx_isr(int irq, void *dev_id)
762 struct spi_imx_data *spi_imx = dev_id;
764 while (spi_imx->devtype_data->rx_available(spi_imx)) {
765 spi_imx->rx(spi_imx);
769 if (spi_imx->count) {
770 spi_imx_push(spi_imx);
774 if (spi_imx->txfifo) {
775 /* No data left to push, but still waiting for rx data,
776 * enable receive data available interrupt.
778 spi_imx->devtype_data->intctrl(
779 spi_imx, MXC_INT_RR);
783 spi_imx->devtype_data->intctrl(spi_imx, 0);
784 complete(&spi_imx->xfer_done);
789 static int spi_imx_setupxfer(struct spi_device *spi,
790 struct spi_transfer *t)
792 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
793 struct spi_imx_config config;
795 config.bpw = t ? t->bits_per_word : spi->bits_per_word;
796 config.speed_hz = t ? t->speed_hz : spi->max_speed_hz;
797 config.mode = spi->mode;
798 config.cs = spi->chip_select;
800 if (!config.speed_hz)
801 config.speed_hz = spi->max_speed_hz;
803 config.bpw = spi->bits_per_word;
805 /* Initialize the functions for transfer */
806 if (config.bpw <= 8) {
807 spi_imx->rx = spi_imx_buf_rx_u8;
808 spi_imx->tx = spi_imx_buf_tx_u8;
809 } else if (config.bpw <= 16) {
810 spi_imx->rx = spi_imx_buf_rx_u16;
811 spi_imx->tx = spi_imx_buf_tx_u16;
813 spi_imx->rx = spi_imx_buf_rx_u32;
814 spi_imx->tx = spi_imx_buf_tx_u32;
817 spi_imx->devtype_data->config(spi_imx, &config);
822 static void spi_imx_sdma_exit(struct spi_imx_data *spi_imx)
824 struct spi_master *master = spi_imx->bitbang.master;
826 if (master->dma_rx) {
827 dma_release_channel(master->dma_rx);
828 master->dma_rx = NULL;
831 if (master->dma_tx) {
832 dma_release_channel(master->dma_tx);
833 master->dma_tx = NULL;
836 spi_imx->dma_is_inited = 0;
839 static int spi_imx_sdma_init(struct device *dev, struct spi_imx_data *spi_imx,
840 struct spi_master *master,
841 const struct resource *res)
843 struct dma_slave_config slave_config = {};
846 /* use pio mode for i.mx6dl chip TKT238285 */
847 if (of_machine_is_compatible("fsl,imx6dl"))
850 spi_imx->wml = spi_imx_get_fifosize(spi_imx) / 2;
852 /* Prepare for TX DMA: */
853 master->dma_tx = dma_request_slave_channel_reason(dev, "tx");
854 if (IS_ERR(master->dma_tx)) {
855 ret = PTR_ERR(master->dma_tx);
856 dev_dbg(dev, "can't get the TX DMA channel, error %d!\n", ret);
857 master->dma_tx = NULL;
861 slave_config.direction = DMA_MEM_TO_DEV;
862 slave_config.dst_addr = res->start + MXC_CSPITXDATA;
863 slave_config.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
864 slave_config.dst_maxburst = spi_imx->wml;
865 ret = dmaengine_slave_config(master->dma_tx, &slave_config);
867 dev_err(dev, "error in TX dma configuration.\n");
871 /* Prepare for RX : */
872 master->dma_rx = dma_request_slave_channel_reason(dev, "rx");
873 if (IS_ERR(master->dma_rx)) {
874 ret = PTR_ERR(master->dma_rx);
875 dev_dbg(dev, "can't get the RX DMA channel, error %d\n", ret);
876 master->dma_rx = NULL;
880 slave_config.direction = DMA_DEV_TO_MEM;
881 slave_config.src_addr = res->start + MXC_CSPIRXDATA;
882 slave_config.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
883 slave_config.src_maxburst = spi_imx->wml;
884 ret = dmaengine_slave_config(master->dma_rx, &slave_config);
886 dev_err(dev, "error in RX dma configuration.\n");
890 init_completion(&spi_imx->dma_rx_completion);
891 init_completion(&spi_imx->dma_tx_completion);
892 master->can_dma = spi_imx_can_dma;
893 master->max_dma_len = MAX_SDMA_BD_BYTES;
894 spi_imx->bitbang.master->flags = SPI_MASTER_MUST_RX |
896 spi_imx->dma_is_inited = 1;
900 spi_imx_sdma_exit(spi_imx);
904 static void spi_imx_dma_rx_callback(void *cookie)
906 struct spi_imx_data *spi_imx = (struct spi_imx_data *)cookie;
908 complete(&spi_imx->dma_rx_completion);
911 static void spi_imx_dma_tx_callback(void *cookie)
913 struct spi_imx_data *spi_imx = (struct spi_imx_data *)cookie;
915 complete(&spi_imx->dma_tx_completion);
918 static int spi_imx_dma_transfer(struct spi_imx_data *spi_imx,
919 struct spi_transfer *transfer)
921 struct dma_async_tx_descriptor *desc_tx = NULL, *desc_rx = NULL;
923 unsigned long timeout;
924 struct spi_master *master = spi_imx->bitbang.master;
925 struct sg_table *tx = &transfer->tx_sg, *rx = &transfer->rx_sg;
928 desc_tx = dmaengine_prep_slave_sg(master->dma_tx,
929 tx->sgl, tx->nents, DMA_MEM_TO_DEV,
930 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
934 desc_tx->callback = spi_imx_dma_tx_callback;
935 desc_tx->callback_param = (void *)spi_imx;
936 dmaengine_submit(desc_tx);
940 desc_rx = dmaengine_prep_slave_sg(master->dma_rx,
941 rx->sgl, rx->nents, DMA_DEV_TO_MEM,
942 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
946 desc_rx->callback = spi_imx_dma_rx_callback;
947 desc_rx->callback_param = (void *)spi_imx;
948 dmaengine_submit(desc_rx);
951 reinit_completion(&spi_imx->dma_rx_completion);
952 reinit_completion(&spi_imx->dma_tx_completion);
954 /* Trigger the cspi module. */
955 spi_imx->dma_finished = 0;
958 * Set these order to avoid potential RX overflow. The overflow may
959 * happen if we enable SPI HW before starting RX DMA due to rescheduling
960 * for another task and/or interrupt.
961 * So RX DMA enabled first to make sure data would be read out from FIFO
962 * ASAP. TX DMA enabled next to start filling TX FIFO with new data.
963 * And finaly SPI HW enabled to start actual data transfer.
965 dma_async_issue_pending(master->dma_rx);
966 dma_async_issue_pending(master->dma_tx);
967 spi_imx->devtype_data->trigger(spi_imx);
969 /* Wait SDMA to finish the data transfer.*/
970 timeout = wait_for_completion_timeout(&spi_imx->dma_tx_completion,
973 dev_err(spi_imx->dev, "I/O Error in DMA TX\n");
974 dmaengine_terminate_all(master->dma_tx);
975 dmaengine_terminate_all(master->dma_rx);
977 timeout = wait_for_completion_timeout(
978 &spi_imx->dma_rx_completion, IMX_DMA_TIMEOUT);
980 dev_err(spi_imx->dev, "I/O Error in DMA RX\n");
981 spi_imx->devtype_data->reset(spi_imx);
982 dmaengine_terminate_all(master->dma_rx);
986 spi_imx->dma_finished = 1;
987 spi_imx->devtype_data->trigger(spi_imx);
997 dmaengine_terminate_all(master->dma_tx);
999 dev_warn_once(spi_imx->dev, "DMA not available, falling back to PIO\n");
1003 static int spi_imx_pio_transfer(struct spi_device *spi,
1004 struct spi_transfer *transfer)
1006 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
1008 spi_imx->tx_buf = transfer->tx_buf;
1009 spi_imx->rx_buf = transfer->rx_buf;
1010 spi_imx->count = transfer->len;
1011 spi_imx->txfifo = 0;
1013 reinit_completion(&spi_imx->xfer_done);
1015 spi_imx_push(spi_imx);
1017 spi_imx->devtype_data->intctrl(spi_imx, MXC_INT_TE);
1019 wait_for_completion(&spi_imx->xfer_done);
1021 return transfer->len;
1024 static int spi_imx_transfer(struct spi_device *spi,
1025 struct spi_transfer *transfer)
1028 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
1030 if (spi_imx->bitbang.master->can_dma &&
1031 spi_imx_can_dma(spi_imx->bitbang.master, spi, transfer)) {
1032 spi_imx->usedma = true;
1033 ret = spi_imx_dma_transfer(spi_imx, transfer);
1037 spi_imx->usedma = false;
1039 return spi_imx_pio_transfer(spi, transfer);
1042 static int spi_imx_setup(struct spi_device *spi)
1044 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
1045 int gpio = spi_imx->chipselect[spi->chip_select];
1047 dev_dbg(&spi->dev, "%s: mode %d, %u bpw, %d hz\n", __func__,
1048 spi->mode, spi->bits_per_word, spi->max_speed_hz);
1050 if (gpio_is_valid(gpio))
1051 gpio_direction_output(gpio, spi->mode & SPI_CS_HIGH ? 0 : 1);
1053 spi_imx_chipselect(spi, BITBANG_CS_INACTIVE);
1058 static void spi_imx_cleanup(struct spi_device *spi)
1063 spi_imx_prepare_message(struct spi_master *master, struct spi_message *msg)
1065 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
1068 ret = clk_enable(spi_imx->clk_per);
1072 ret = clk_enable(spi_imx->clk_ipg);
1074 clk_disable(spi_imx->clk_per);
1082 spi_imx_unprepare_message(struct spi_master *master, struct spi_message *msg)
1084 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
1086 clk_disable(spi_imx->clk_ipg);
1087 clk_disable(spi_imx->clk_per);
1091 static int spi_imx_probe(struct platform_device *pdev)
1093 struct device_node *np = pdev->dev.of_node;
1094 const struct of_device_id *of_id =
1095 of_match_device(spi_imx_dt_ids, &pdev->dev);
1096 struct spi_imx_master *mxc_platform_info =
1097 dev_get_platdata(&pdev->dev);
1098 struct spi_master *master;
1099 struct spi_imx_data *spi_imx;
1100 struct resource *res;
1101 int i, ret, num_cs, irq;
1103 if (!np && !mxc_platform_info) {
1104 dev_err(&pdev->dev, "can't get the platform data\n");
1108 ret = of_property_read_u32(np, "fsl,spi-num-chipselects", &num_cs);
1110 if (mxc_platform_info)
1111 num_cs = mxc_platform_info->num_chipselect;
1116 master = spi_alloc_master(&pdev->dev,
1117 sizeof(struct spi_imx_data) + sizeof(int) * num_cs);
1121 platform_set_drvdata(pdev, master);
1123 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(1, 32);
1124 master->bus_num = pdev->id;
1125 master->num_chipselect = num_cs;
1127 spi_imx = spi_master_get_devdata(master);
1128 spi_imx->bitbang.master = master;
1129 spi_imx->dev = &pdev->dev;
1131 spi_imx->devtype_data = of_id ? of_id->data :
1132 (struct spi_imx_devtype_data *)pdev->id_entry->driver_data;
1134 for (i = 0; i < master->num_chipselect; i++) {
1135 int cs_gpio = of_get_named_gpio(np, "cs-gpios", i);
1136 if (!gpio_is_valid(cs_gpio) && mxc_platform_info)
1137 cs_gpio = mxc_platform_info->chipselect[i];
1139 spi_imx->chipselect[i] = cs_gpio;
1140 if (!gpio_is_valid(cs_gpio))
1143 ret = devm_gpio_request(&pdev->dev, spi_imx->chipselect[i],
1146 dev_err(&pdev->dev, "can't get cs gpios\n");
1147 goto out_master_put;
1151 spi_imx->bitbang.chipselect = spi_imx_chipselect;
1152 spi_imx->bitbang.setup_transfer = spi_imx_setupxfer;
1153 spi_imx->bitbang.txrx_bufs = spi_imx_transfer;
1154 spi_imx->bitbang.master->setup = spi_imx_setup;
1155 spi_imx->bitbang.master->cleanup = spi_imx_cleanup;
1156 spi_imx->bitbang.master->prepare_message = spi_imx_prepare_message;
1157 spi_imx->bitbang.master->unprepare_message = spi_imx_unprepare_message;
1158 spi_imx->bitbang.master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
1159 if (is_imx51_ecspi(spi_imx))
1160 spi_imx->bitbang.master->mode_bits |= SPI_LOOP;
1162 init_completion(&spi_imx->xfer_done);
1164 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1165 spi_imx->base = devm_ioremap_resource(&pdev->dev, res);
1166 if (IS_ERR(spi_imx->base)) {
1167 ret = PTR_ERR(spi_imx->base);
1168 goto out_master_put;
1171 irq = platform_get_irq(pdev, 0);
1174 goto out_master_put;
1177 ret = devm_request_irq(&pdev->dev, irq, spi_imx_isr, 0,
1178 dev_name(&pdev->dev), spi_imx);
1180 dev_err(&pdev->dev, "can't get irq%d: %d\n", irq, ret);
1181 goto out_master_put;
1184 spi_imx->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
1185 if (IS_ERR(spi_imx->clk_ipg)) {
1186 ret = PTR_ERR(spi_imx->clk_ipg);
1187 goto out_master_put;
1190 spi_imx->clk_per = devm_clk_get(&pdev->dev, "per");
1191 if (IS_ERR(spi_imx->clk_per)) {
1192 ret = PTR_ERR(spi_imx->clk_per);
1193 goto out_master_put;
1196 ret = clk_prepare_enable(spi_imx->clk_per);
1198 goto out_master_put;
1200 ret = clk_prepare_enable(spi_imx->clk_ipg);
1204 spi_imx->spi_clk = clk_get_rate(spi_imx->clk_per);
1206 * Only validated on i.mx6 now, can remove the constrain if validated on
1209 if (is_imx51_ecspi(spi_imx)) {
1210 ret = spi_imx_sdma_init(&pdev->dev, spi_imx, master, res);
1211 if (ret == -EPROBE_DEFER)
1215 dev_err(&pdev->dev, "dma setup error %d, use pio\n",
1219 spi_imx->devtype_data->reset(spi_imx);
1221 spi_imx->devtype_data->intctrl(spi_imx, 0);
1223 master->dev.of_node = pdev->dev.of_node;
1224 ret = spi_bitbang_start(&spi_imx->bitbang);
1226 dev_err(&pdev->dev, "bitbang start failed with %d\n", ret);
1230 dev_info(&pdev->dev, "probed\n");
1232 clk_disable(spi_imx->clk_ipg);
1233 clk_disable(spi_imx->clk_per);
1237 clk_disable_unprepare(spi_imx->clk_ipg);
1239 clk_disable_unprepare(spi_imx->clk_per);
1241 spi_master_put(master);
1246 static int spi_imx_remove(struct platform_device *pdev)
1248 struct spi_master *master = platform_get_drvdata(pdev);
1249 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
1251 spi_bitbang_stop(&spi_imx->bitbang);
1253 writel(0, spi_imx->base + MXC_CSPICTRL);
1254 clk_unprepare(spi_imx->clk_ipg);
1255 clk_unprepare(spi_imx->clk_per);
1256 spi_imx_sdma_exit(spi_imx);
1257 spi_master_put(master);
1262 static struct platform_driver spi_imx_driver = {
1264 .name = DRIVER_NAME,
1265 .of_match_table = spi_imx_dt_ids,
1267 .id_table = spi_imx_devtype,
1268 .probe = spi_imx_probe,
1269 .remove = spi_imx_remove,
1271 module_platform_driver(spi_imx_driver);
1273 MODULE_DESCRIPTION("SPI Master Controller driver");
1274 MODULE_AUTHOR("Sascha Hauer, Pengutronix");
1275 MODULE_LICENSE("GPL");
1276 MODULE_ALIAS("platform:" DRIVER_NAME);