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 struct spi_imx_config {
60 unsigned int speed_hz;
64 enum spi_imx_devtype {
69 IMX35_CSPI, /* CSPI on all i.mx except above */
70 IMX51_ECSPI, /* ECSPI on i.mx51 and later */
75 struct spi_imx_devtype_data {
76 void (*intctrl)(struct spi_imx_data *, int);
77 int (*config)(struct spi_device *, struct spi_imx_config *);
78 void (*trigger)(struct spi_imx_data *);
79 int (*rx_available)(struct spi_imx_data *);
80 void (*reset)(struct spi_imx_data *);
81 enum spi_imx_devtype devtype;
85 struct spi_bitbang bitbang;
88 struct completion xfer_done;
90 unsigned long base_phys;
94 unsigned long spi_clk;
95 unsigned int spi_bus_clk;
97 unsigned int bytes_per_word;
100 void (*tx)(struct spi_imx_data *);
101 void (*rx)(struct spi_imx_data *);
104 unsigned int txfifo; /* number of words pushed in tx FIFO */
109 struct completion dma_rx_completion;
110 struct completion dma_tx_completion;
112 const struct spi_imx_devtype_data *devtype_data;
115 static inline int is_imx27_cspi(struct spi_imx_data *d)
117 return d->devtype_data->devtype == IMX27_CSPI;
120 static inline int is_imx35_cspi(struct spi_imx_data *d)
122 return d->devtype_data->devtype == IMX35_CSPI;
125 static inline int is_imx51_ecspi(struct spi_imx_data *d)
127 return d->devtype_data->devtype == IMX51_ECSPI;
130 static inline unsigned spi_imx_get_fifosize(struct spi_imx_data *d)
132 return is_imx51_ecspi(d) ? 64 : 8;
135 #define MXC_SPI_BUF_RX(type) \
136 static void spi_imx_buf_rx_##type(struct spi_imx_data *spi_imx) \
138 unsigned int val = readl(spi_imx->base + MXC_CSPIRXDATA); \
140 if (spi_imx->rx_buf) { \
141 *(type *)spi_imx->rx_buf = val; \
142 spi_imx->rx_buf += sizeof(type); \
146 #define MXC_SPI_BUF_TX(type) \
147 static void spi_imx_buf_tx_##type(struct spi_imx_data *spi_imx) \
151 if (spi_imx->tx_buf) { \
152 val = *(type *)spi_imx->tx_buf; \
153 spi_imx->tx_buf += sizeof(type); \
156 spi_imx->count -= sizeof(type); \
158 writel(val, spi_imx->base + MXC_CSPITXDATA); \
168 /* First entry is reserved, second entry is valid only if SDHC_SPIEN is set
169 * (which is currently not the case in this driver)
171 static int mxc_clkdivs[] = {0, 3, 4, 6, 8, 12, 16, 24, 32, 48, 64, 96, 128, 192,
172 256, 384, 512, 768, 1024};
175 static unsigned int spi_imx_clkdiv_1(unsigned int fin,
176 unsigned int fspi, unsigned int max, unsigned int *fres)
180 for (i = 2; i < max; i++)
181 if (fspi * mxc_clkdivs[i] >= fin)
184 *fres = fin / mxc_clkdivs[i];
188 /* MX1, MX31, MX35, MX51 CSPI */
189 static unsigned int spi_imx_clkdiv_2(unsigned int fin,
190 unsigned int fspi, unsigned int *fres)
194 for (i = 0; i < 7; i++) {
195 if (fspi * div >= fin)
205 static int spi_imx_bytes_per_word(const int bpw)
207 return DIV_ROUND_UP(bpw, BITS_PER_BYTE);
210 static bool spi_imx_can_dma(struct spi_master *master, struct spi_device *spi,
211 struct spi_transfer *transfer)
213 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
222 bpw = transfer->bits_per_word;
224 bpw = spi->bits_per_word;
226 bpw = spi_imx_bytes_per_word(bpw);
228 if (bpw != 1 && bpw != 2 && bpw != 4)
231 if (transfer->len < spi_imx->wml * bpw)
234 if (transfer->len % (spi_imx->wml * bpw))
240 #define MX51_ECSPI_CTRL 0x08
241 #define MX51_ECSPI_CTRL_ENABLE (1 << 0)
242 #define MX51_ECSPI_CTRL_XCH (1 << 2)
243 #define MX51_ECSPI_CTRL_SMC (1 << 3)
244 #define MX51_ECSPI_CTRL_MODE_MASK (0xf << 4)
245 #define MX51_ECSPI_CTRL_POSTDIV_OFFSET 8
246 #define MX51_ECSPI_CTRL_PREDIV_OFFSET 12
247 #define MX51_ECSPI_CTRL_CS(cs) ((cs) << 18)
248 #define MX51_ECSPI_CTRL_BL_OFFSET 20
250 #define MX51_ECSPI_CONFIG 0x0c
251 #define MX51_ECSPI_CONFIG_SCLKPHA(cs) (1 << ((cs) + 0))
252 #define MX51_ECSPI_CONFIG_SCLKPOL(cs) (1 << ((cs) + 4))
253 #define MX51_ECSPI_CONFIG_SBBCTRL(cs) (1 << ((cs) + 8))
254 #define MX51_ECSPI_CONFIG_SSBPOL(cs) (1 << ((cs) + 12))
255 #define MX51_ECSPI_CONFIG_SCLKCTL(cs) (1 << ((cs) + 20))
257 #define MX51_ECSPI_INT 0x10
258 #define MX51_ECSPI_INT_TEEN (1 << 0)
259 #define MX51_ECSPI_INT_RREN (1 << 3)
261 #define MX51_ECSPI_DMA 0x14
262 #define MX51_ECSPI_DMA_TX_WML(wml) ((wml) & 0x3f)
263 #define MX51_ECSPI_DMA_RX_WML(wml) (((wml) & 0x3f) << 16)
264 #define MX51_ECSPI_DMA_RXT_WML(wml) (((wml) & 0x3f) << 24)
266 #define MX51_ECSPI_DMA_TEDEN (1 << 7)
267 #define MX51_ECSPI_DMA_RXDEN (1 << 23)
268 #define MX51_ECSPI_DMA_RXTDEN (1 << 31)
270 #define MX51_ECSPI_STAT 0x18
271 #define MX51_ECSPI_STAT_RR (1 << 3)
273 #define MX51_ECSPI_TESTREG 0x20
274 #define MX51_ECSPI_TESTREG_LBC BIT(31)
277 static unsigned int mx51_ecspi_clkdiv(struct spi_imx_data *spi_imx,
278 unsigned int fspi, unsigned int *fres)
281 * there are two 4-bit dividers, the pre-divider divides by
282 * $pre, the post-divider by 2^$post
284 unsigned int pre, post;
285 unsigned int fin = spi_imx->spi_clk;
287 if (unlikely(fspi > fin))
290 post = fls(fin) - fls(fspi);
291 if (fin > fspi << post)
294 /* now we have: (fin <= fspi << post) with post being minimal */
296 post = max(4U, post) - 4;
297 if (unlikely(post > 0xf)) {
298 dev_err(spi_imx->dev, "cannot set clock freq: %u (base freq: %u)\n",
303 pre = DIV_ROUND_UP(fin, fspi << post) - 1;
305 dev_dbg(spi_imx->dev, "%s: fin: %u, fspi: %u, post: %u, pre: %u\n",
306 __func__, fin, fspi, post, pre);
308 /* Resulting frequency for the SCLK line. */
309 *fres = (fin / (pre + 1)) >> post;
311 return (pre << MX51_ECSPI_CTRL_PREDIV_OFFSET) |
312 (post << MX51_ECSPI_CTRL_POSTDIV_OFFSET);
315 static void mx51_ecspi_intctrl(struct spi_imx_data *spi_imx, int enable)
319 if (enable & MXC_INT_TE)
320 val |= MX51_ECSPI_INT_TEEN;
322 if (enable & MXC_INT_RR)
323 val |= MX51_ECSPI_INT_RREN;
325 writel(val, spi_imx->base + MX51_ECSPI_INT);
328 static void mx51_ecspi_trigger(struct spi_imx_data *spi_imx)
332 reg = readl(spi_imx->base + MX51_ECSPI_CTRL);
333 reg |= MX51_ECSPI_CTRL_XCH;
334 writel(reg, spi_imx->base + MX51_ECSPI_CTRL);
337 static int mx51_ecspi_config(struct spi_device *spi,
338 struct spi_imx_config *config)
340 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
341 u32 ctrl = MX51_ECSPI_CTRL_ENABLE;
342 u32 clk = config->speed_hz, delay, reg;
343 u32 cfg = readl(spi_imx->base + MX51_ECSPI_CONFIG);
346 * The hardware seems to have a race condition when changing modes. The
347 * current assumption is that the selection of the channel arrives
348 * earlier in the hardware than the mode bits when they are written at
350 * So set master mode for all channels as we do not support slave mode.
352 ctrl |= MX51_ECSPI_CTRL_MODE_MASK;
354 /* set clock speed */
355 ctrl |= mx51_ecspi_clkdiv(spi_imx, config->speed_hz, &clk);
356 spi_imx->spi_bus_clk = clk;
358 /* set chip select to use */
359 ctrl |= MX51_ECSPI_CTRL_CS(spi->chip_select);
361 ctrl |= (config->bpw - 1) << MX51_ECSPI_CTRL_BL_OFFSET;
363 cfg |= MX51_ECSPI_CONFIG_SBBCTRL(spi->chip_select);
365 if (spi->mode & SPI_CPHA)
366 cfg |= MX51_ECSPI_CONFIG_SCLKPHA(spi->chip_select);
368 cfg &= ~MX51_ECSPI_CONFIG_SCLKPHA(spi->chip_select);
370 if (spi->mode & SPI_CPOL) {
371 cfg |= MX51_ECSPI_CONFIG_SCLKPOL(spi->chip_select);
372 cfg |= MX51_ECSPI_CONFIG_SCLKCTL(spi->chip_select);
374 cfg &= ~MX51_ECSPI_CONFIG_SCLKPOL(spi->chip_select);
375 cfg &= ~MX51_ECSPI_CONFIG_SCLKCTL(spi->chip_select);
377 if (spi->mode & SPI_CS_HIGH)
378 cfg |= MX51_ECSPI_CONFIG_SSBPOL(spi->chip_select);
380 cfg &= ~MX51_ECSPI_CONFIG_SSBPOL(spi->chip_select);
383 ctrl |= MX51_ECSPI_CTRL_SMC;
385 /* CTRL register always go first to bring out controller from reset */
386 writel(ctrl, spi_imx->base + MX51_ECSPI_CTRL);
388 reg = readl(spi_imx->base + MX51_ECSPI_TESTREG);
389 if (spi->mode & SPI_LOOP)
390 reg |= MX51_ECSPI_TESTREG_LBC;
392 reg &= ~MX51_ECSPI_TESTREG_LBC;
393 writel(reg, spi_imx->base + MX51_ECSPI_TESTREG);
395 writel(cfg, spi_imx->base + MX51_ECSPI_CONFIG);
398 * Wait until the changes in the configuration register CONFIGREG
399 * propagate into the hardware. It takes exactly one tick of the
400 * SCLK clock, but we will wait two SCLK clock just to be sure. The
401 * effect of the delay it takes for the hardware to apply changes
402 * is noticable if the SCLK clock run very slow. In such a case, if
403 * the polarity of SCLK should be inverted, the GPIO ChipSelect might
404 * be asserted before the SCLK polarity changes, which would disrupt
405 * the SPI communication as the device on the other end would consider
406 * the change of SCLK polarity as a clock tick already.
408 delay = (2 * 1000000) / clk;
409 if (likely(delay < 10)) /* SCLK is faster than 100 kHz */
411 else /* SCLK is _very_ slow */
412 usleep_range(delay, delay + 10);
415 * Configure the DMA register: setup the watermark
416 * and enable DMA request.
419 writel(MX51_ECSPI_DMA_RX_WML(spi_imx->wml) |
420 MX51_ECSPI_DMA_TX_WML(spi_imx->wml) |
421 MX51_ECSPI_DMA_RXT_WML(spi_imx->wml) |
422 MX51_ECSPI_DMA_TEDEN | MX51_ECSPI_DMA_RXDEN |
423 MX51_ECSPI_DMA_RXTDEN, spi_imx->base + MX51_ECSPI_DMA);
428 static int mx51_ecspi_rx_available(struct spi_imx_data *spi_imx)
430 return readl(spi_imx->base + MX51_ECSPI_STAT) & MX51_ECSPI_STAT_RR;
433 static void mx51_ecspi_reset(struct spi_imx_data *spi_imx)
435 /* drain receive buffer */
436 while (mx51_ecspi_rx_available(spi_imx))
437 readl(spi_imx->base + MXC_CSPIRXDATA);
440 #define MX31_INTREG_TEEN (1 << 0)
441 #define MX31_INTREG_RREN (1 << 3)
443 #define MX31_CSPICTRL_ENABLE (1 << 0)
444 #define MX31_CSPICTRL_MASTER (1 << 1)
445 #define MX31_CSPICTRL_XCH (1 << 2)
446 #define MX31_CSPICTRL_SMC (1 << 3)
447 #define MX31_CSPICTRL_POL (1 << 4)
448 #define MX31_CSPICTRL_PHA (1 << 5)
449 #define MX31_CSPICTRL_SSCTL (1 << 6)
450 #define MX31_CSPICTRL_SSPOL (1 << 7)
451 #define MX31_CSPICTRL_BC_SHIFT 8
452 #define MX35_CSPICTRL_BL_SHIFT 20
453 #define MX31_CSPICTRL_CS_SHIFT 24
454 #define MX35_CSPICTRL_CS_SHIFT 12
455 #define MX31_CSPICTRL_DR_SHIFT 16
457 #define MX31_CSPI_DMAREG 0x10
458 #define MX31_DMAREG_RH_DEN (1<<4)
459 #define MX31_DMAREG_TH_DEN (1<<1)
461 #define MX31_CSPISTATUS 0x14
462 #define MX31_STATUS_RR (1 << 3)
464 #define MX31_CSPI_TESTREG 0x1C
465 #define MX31_TEST_LBC (1 << 14)
467 /* These functions also work for the i.MX35, but be aware that
468 * the i.MX35 has a slightly different register layout for bits
469 * we do not use here.
471 static void mx31_intctrl(struct spi_imx_data *spi_imx, int enable)
473 unsigned int val = 0;
475 if (enable & MXC_INT_TE)
476 val |= MX31_INTREG_TEEN;
477 if (enable & MXC_INT_RR)
478 val |= MX31_INTREG_RREN;
480 writel(val, spi_imx->base + MXC_CSPIINT);
483 static void mx31_trigger(struct spi_imx_data *spi_imx)
487 reg = readl(spi_imx->base + MXC_CSPICTRL);
488 reg |= MX31_CSPICTRL_XCH;
489 writel(reg, spi_imx->base + MXC_CSPICTRL);
492 static int mx31_config(struct spi_device *spi, struct spi_imx_config *config)
494 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
495 unsigned int reg = MX31_CSPICTRL_ENABLE | MX31_CSPICTRL_MASTER;
498 reg |= spi_imx_clkdiv_2(spi_imx->spi_clk, config->speed_hz, &clk) <<
499 MX31_CSPICTRL_DR_SHIFT;
500 spi_imx->spi_bus_clk = clk;
502 if (is_imx35_cspi(spi_imx)) {
503 reg |= (config->bpw - 1) << MX35_CSPICTRL_BL_SHIFT;
504 reg |= MX31_CSPICTRL_SSCTL;
506 reg |= (config->bpw - 1) << MX31_CSPICTRL_BC_SHIFT;
509 if (spi->mode & SPI_CPHA)
510 reg |= MX31_CSPICTRL_PHA;
511 if (spi->mode & SPI_CPOL)
512 reg |= MX31_CSPICTRL_POL;
513 if (spi->mode & SPI_CS_HIGH)
514 reg |= MX31_CSPICTRL_SSPOL;
515 if (spi->cs_gpio < 0)
516 reg |= (spi->cs_gpio + 32) <<
517 (is_imx35_cspi(spi_imx) ? MX35_CSPICTRL_CS_SHIFT :
518 MX31_CSPICTRL_CS_SHIFT);
521 reg |= MX31_CSPICTRL_SMC;
523 writel(reg, spi_imx->base + MXC_CSPICTRL);
525 reg = readl(spi_imx->base + MX31_CSPI_TESTREG);
526 if (spi->mode & SPI_LOOP)
527 reg |= MX31_TEST_LBC;
529 reg &= ~MX31_TEST_LBC;
530 writel(reg, spi_imx->base + MX31_CSPI_TESTREG);
532 if (spi_imx->usedma) {
533 /* configure DMA requests when RXFIFO is half full and
534 when TXFIFO is half empty */
535 writel(MX31_DMAREG_RH_DEN | MX31_DMAREG_TH_DEN,
536 spi_imx->base + MX31_CSPI_DMAREG);
542 static int mx31_rx_available(struct spi_imx_data *spi_imx)
544 return readl(spi_imx->base + MX31_CSPISTATUS) & MX31_STATUS_RR;
547 static void mx31_reset(struct spi_imx_data *spi_imx)
549 /* drain receive buffer */
550 while (readl(spi_imx->base + MX31_CSPISTATUS) & MX31_STATUS_RR)
551 readl(spi_imx->base + MXC_CSPIRXDATA);
554 #define MX21_INTREG_RR (1 << 4)
555 #define MX21_INTREG_TEEN (1 << 9)
556 #define MX21_INTREG_RREN (1 << 13)
558 #define MX21_CSPICTRL_POL (1 << 5)
559 #define MX21_CSPICTRL_PHA (1 << 6)
560 #define MX21_CSPICTRL_SSPOL (1 << 8)
561 #define MX21_CSPICTRL_XCH (1 << 9)
562 #define MX21_CSPICTRL_ENABLE (1 << 10)
563 #define MX21_CSPICTRL_MASTER (1 << 11)
564 #define MX21_CSPICTRL_DR_SHIFT 14
565 #define MX21_CSPICTRL_CS_SHIFT 19
567 static void mx21_intctrl(struct spi_imx_data *spi_imx, int enable)
569 unsigned int val = 0;
571 if (enable & MXC_INT_TE)
572 val |= MX21_INTREG_TEEN;
573 if (enable & MXC_INT_RR)
574 val |= MX21_INTREG_RREN;
576 writel(val, spi_imx->base + MXC_CSPIINT);
579 static void mx21_trigger(struct spi_imx_data *spi_imx)
583 reg = readl(spi_imx->base + MXC_CSPICTRL);
584 reg |= MX21_CSPICTRL_XCH;
585 writel(reg, spi_imx->base + MXC_CSPICTRL);
588 static int mx21_config(struct spi_device *spi, struct spi_imx_config *config)
590 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
591 unsigned int reg = MX21_CSPICTRL_ENABLE | MX21_CSPICTRL_MASTER;
592 unsigned int max = is_imx27_cspi(spi_imx) ? 16 : 18;
595 reg |= spi_imx_clkdiv_1(spi_imx->spi_clk, config->speed_hz, max, &clk)
596 << MX21_CSPICTRL_DR_SHIFT;
597 spi_imx->spi_bus_clk = clk;
599 reg |= config->bpw - 1;
601 if (spi->mode & SPI_CPHA)
602 reg |= MX21_CSPICTRL_PHA;
603 if (spi->mode & SPI_CPOL)
604 reg |= MX21_CSPICTRL_POL;
605 if (spi->mode & SPI_CS_HIGH)
606 reg |= MX21_CSPICTRL_SSPOL;
607 if (spi->cs_gpio < 0)
608 reg |= (spi->cs_gpio + 32) << MX21_CSPICTRL_CS_SHIFT;
610 writel(reg, spi_imx->base + MXC_CSPICTRL);
615 static int mx21_rx_available(struct spi_imx_data *spi_imx)
617 return readl(spi_imx->base + MXC_CSPIINT) & MX21_INTREG_RR;
620 static void mx21_reset(struct spi_imx_data *spi_imx)
622 writel(1, spi_imx->base + MXC_RESET);
625 #define MX1_INTREG_RR (1 << 3)
626 #define MX1_INTREG_TEEN (1 << 8)
627 #define MX1_INTREG_RREN (1 << 11)
629 #define MX1_CSPICTRL_POL (1 << 4)
630 #define MX1_CSPICTRL_PHA (1 << 5)
631 #define MX1_CSPICTRL_XCH (1 << 8)
632 #define MX1_CSPICTRL_ENABLE (1 << 9)
633 #define MX1_CSPICTRL_MASTER (1 << 10)
634 #define MX1_CSPICTRL_DR_SHIFT 13
636 static void mx1_intctrl(struct spi_imx_data *spi_imx, int enable)
638 unsigned int val = 0;
640 if (enable & MXC_INT_TE)
641 val |= MX1_INTREG_TEEN;
642 if (enable & MXC_INT_RR)
643 val |= MX1_INTREG_RREN;
645 writel(val, spi_imx->base + MXC_CSPIINT);
648 static void mx1_trigger(struct spi_imx_data *spi_imx)
652 reg = readl(spi_imx->base + MXC_CSPICTRL);
653 reg |= MX1_CSPICTRL_XCH;
654 writel(reg, spi_imx->base + MXC_CSPICTRL);
657 static int mx1_config(struct spi_device *spi, struct spi_imx_config *config)
659 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
660 unsigned int reg = MX1_CSPICTRL_ENABLE | MX1_CSPICTRL_MASTER;
663 reg |= spi_imx_clkdiv_2(spi_imx->spi_clk, config->speed_hz, &clk) <<
664 MX1_CSPICTRL_DR_SHIFT;
665 spi_imx->spi_bus_clk = clk;
667 reg |= config->bpw - 1;
669 if (spi->mode & SPI_CPHA)
670 reg |= MX1_CSPICTRL_PHA;
671 if (spi->mode & SPI_CPOL)
672 reg |= MX1_CSPICTRL_POL;
674 writel(reg, spi_imx->base + MXC_CSPICTRL);
679 static int mx1_rx_available(struct spi_imx_data *spi_imx)
681 return readl(spi_imx->base + MXC_CSPIINT) & MX1_INTREG_RR;
684 static void mx1_reset(struct spi_imx_data *spi_imx)
686 writel(1, spi_imx->base + MXC_RESET);
689 static struct spi_imx_devtype_data imx1_cspi_devtype_data = {
690 .intctrl = mx1_intctrl,
691 .config = mx1_config,
692 .trigger = mx1_trigger,
693 .rx_available = mx1_rx_available,
695 .devtype = IMX1_CSPI,
698 static struct spi_imx_devtype_data imx21_cspi_devtype_data = {
699 .intctrl = mx21_intctrl,
700 .config = mx21_config,
701 .trigger = mx21_trigger,
702 .rx_available = mx21_rx_available,
704 .devtype = IMX21_CSPI,
707 static struct spi_imx_devtype_data imx27_cspi_devtype_data = {
708 /* i.mx27 cspi shares the functions with i.mx21 one */
709 .intctrl = mx21_intctrl,
710 .config = mx21_config,
711 .trigger = mx21_trigger,
712 .rx_available = mx21_rx_available,
714 .devtype = IMX27_CSPI,
717 static struct spi_imx_devtype_data imx31_cspi_devtype_data = {
718 .intctrl = mx31_intctrl,
719 .config = mx31_config,
720 .trigger = mx31_trigger,
721 .rx_available = mx31_rx_available,
723 .devtype = IMX31_CSPI,
726 static struct spi_imx_devtype_data imx35_cspi_devtype_data = {
727 /* i.mx35 and later cspi shares the functions with i.mx31 one */
728 .intctrl = mx31_intctrl,
729 .config = mx31_config,
730 .trigger = mx31_trigger,
731 .rx_available = mx31_rx_available,
733 .devtype = IMX35_CSPI,
736 static struct spi_imx_devtype_data imx51_ecspi_devtype_data = {
737 .intctrl = mx51_ecspi_intctrl,
738 .config = mx51_ecspi_config,
739 .trigger = mx51_ecspi_trigger,
740 .rx_available = mx51_ecspi_rx_available,
741 .reset = mx51_ecspi_reset,
742 .devtype = IMX51_ECSPI,
745 static const struct platform_device_id spi_imx_devtype[] = {
748 .driver_data = (kernel_ulong_t) &imx1_cspi_devtype_data,
750 .name = "imx21-cspi",
751 .driver_data = (kernel_ulong_t) &imx21_cspi_devtype_data,
753 .name = "imx27-cspi",
754 .driver_data = (kernel_ulong_t) &imx27_cspi_devtype_data,
756 .name = "imx31-cspi",
757 .driver_data = (kernel_ulong_t) &imx31_cspi_devtype_data,
759 .name = "imx35-cspi",
760 .driver_data = (kernel_ulong_t) &imx35_cspi_devtype_data,
762 .name = "imx51-ecspi",
763 .driver_data = (kernel_ulong_t) &imx51_ecspi_devtype_data,
769 static const struct of_device_id spi_imx_dt_ids[] = {
770 { .compatible = "fsl,imx1-cspi", .data = &imx1_cspi_devtype_data, },
771 { .compatible = "fsl,imx21-cspi", .data = &imx21_cspi_devtype_data, },
772 { .compatible = "fsl,imx27-cspi", .data = &imx27_cspi_devtype_data, },
773 { .compatible = "fsl,imx31-cspi", .data = &imx31_cspi_devtype_data, },
774 { .compatible = "fsl,imx35-cspi", .data = &imx35_cspi_devtype_data, },
775 { .compatible = "fsl,imx51-ecspi", .data = &imx51_ecspi_devtype_data, },
778 MODULE_DEVICE_TABLE(of, spi_imx_dt_ids);
780 static void spi_imx_chipselect(struct spi_device *spi, int is_active)
782 int active = is_active != BITBANG_CS_INACTIVE;
783 int dev_is_lowactive = !(spi->mode & SPI_CS_HIGH);
785 if (!gpio_is_valid(spi->cs_gpio))
788 gpio_set_value(spi->cs_gpio, dev_is_lowactive ^ active);
791 static void spi_imx_push(struct spi_imx_data *spi_imx)
793 while (spi_imx->txfifo < spi_imx_get_fifosize(spi_imx)) {
796 spi_imx->tx(spi_imx);
800 spi_imx->devtype_data->trigger(spi_imx);
803 static irqreturn_t spi_imx_isr(int irq, void *dev_id)
805 struct spi_imx_data *spi_imx = dev_id;
807 while (spi_imx->devtype_data->rx_available(spi_imx)) {
808 spi_imx->rx(spi_imx);
812 if (spi_imx->count) {
813 spi_imx_push(spi_imx);
817 if (spi_imx->txfifo) {
818 /* No data left to push, but still waiting for rx data,
819 * enable receive data available interrupt.
821 spi_imx->devtype_data->intctrl(
822 spi_imx, MXC_INT_RR);
826 spi_imx->devtype_data->intctrl(spi_imx, 0);
827 complete(&spi_imx->xfer_done);
832 static int spi_imx_dma_configure(struct spi_master *master,
836 enum dma_slave_buswidth buswidth;
837 struct dma_slave_config rx = {}, tx = {};
838 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
840 if (bytes_per_word == spi_imx->bytes_per_word)
841 /* Same as last time */
844 switch (bytes_per_word) {
846 buswidth = DMA_SLAVE_BUSWIDTH_4_BYTES;
849 buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
852 buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE;
858 tx.direction = DMA_MEM_TO_DEV;
859 tx.dst_addr = spi_imx->base_phys + MXC_CSPITXDATA;
860 tx.dst_addr_width = buswidth;
861 tx.dst_maxburst = spi_imx->wml;
862 ret = dmaengine_slave_config(master->dma_tx, &tx);
864 dev_err(spi_imx->dev, "TX dma configuration failed with %d\n", ret);
868 rx.direction = DMA_DEV_TO_MEM;
869 rx.src_addr = spi_imx->base_phys + MXC_CSPIRXDATA;
870 rx.src_addr_width = buswidth;
871 rx.src_maxburst = spi_imx->wml;
872 ret = dmaengine_slave_config(master->dma_rx, &rx);
874 dev_err(spi_imx->dev, "RX dma configuration failed with %d\n", ret);
878 spi_imx->bytes_per_word = bytes_per_word;
883 static int spi_imx_setupxfer(struct spi_device *spi,
884 struct spi_transfer *t)
886 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
887 struct spi_imx_config config;
890 config.bpw = t ? t->bits_per_word : spi->bits_per_word;
891 config.speed_hz = t ? t->speed_hz : spi->max_speed_hz;
893 if (!config.speed_hz)
894 config.speed_hz = spi->max_speed_hz;
896 config.bpw = spi->bits_per_word;
898 /* Initialize the functions for transfer */
899 if (config.bpw <= 8) {
900 spi_imx->rx = spi_imx_buf_rx_u8;
901 spi_imx->tx = spi_imx_buf_tx_u8;
902 } else if (config.bpw <= 16) {
903 spi_imx->rx = spi_imx_buf_rx_u16;
904 spi_imx->tx = spi_imx_buf_tx_u16;
906 spi_imx->rx = spi_imx_buf_rx_u32;
907 spi_imx->tx = spi_imx_buf_tx_u32;
910 if (spi_imx_can_dma(spi_imx->bitbang.master, spi, t))
915 if (spi_imx->usedma) {
916 ret = spi_imx_dma_configure(spi->master,
917 spi_imx_bytes_per_word(config.bpw));
922 spi_imx->devtype_data->config(spi, &config);
927 static void spi_imx_sdma_exit(struct spi_imx_data *spi_imx)
929 struct spi_master *master = spi_imx->bitbang.master;
931 if (master->dma_rx) {
932 dma_release_channel(master->dma_rx);
933 master->dma_rx = NULL;
936 if (master->dma_tx) {
937 dma_release_channel(master->dma_tx);
938 master->dma_tx = NULL;
942 static int spi_imx_sdma_init(struct device *dev, struct spi_imx_data *spi_imx,
943 struct spi_master *master)
947 /* use pio mode for i.mx6dl chip TKT238285 */
948 if (of_machine_is_compatible("fsl,imx6dl"))
951 spi_imx->wml = spi_imx_get_fifosize(spi_imx) / 2;
953 /* Prepare for TX DMA: */
954 master->dma_tx = dma_request_slave_channel_reason(dev, "tx");
955 if (IS_ERR(master->dma_tx)) {
956 ret = PTR_ERR(master->dma_tx);
957 dev_dbg(dev, "can't get the TX DMA channel, error %d!\n", ret);
958 master->dma_tx = NULL;
962 /* Prepare for RX : */
963 master->dma_rx = dma_request_slave_channel_reason(dev, "rx");
964 if (IS_ERR(master->dma_rx)) {
965 ret = PTR_ERR(master->dma_rx);
966 dev_dbg(dev, "can't get the RX DMA channel, error %d\n", ret);
967 master->dma_rx = NULL;
971 spi_imx_dma_configure(master, 1);
973 init_completion(&spi_imx->dma_rx_completion);
974 init_completion(&spi_imx->dma_tx_completion);
975 master->can_dma = spi_imx_can_dma;
976 master->max_dma_len = MAX_SDMA_BD_BYTES;
977 spi_imx->bitbang.master->flags = SPI_MASTER_MUST_RX |
982 spi_imx_sdma_exit(spi_imx);
986 static void spi_imx_dma_rx_callback(void *cookie)
988 struct spi_imx_data *spi_imx = (struct spi_imx_data *)cookie;
990 complete(&spi_imx->dma_rx_completion);
993 static void spi_imx_dma_tx_callback(void *cookie)
995 struct spi_imx_data *spi_imx = (struct spi_imx_data *)cookie;
997 complete(&spi_imx->dma_tx_completion);
1000 static int spi_imx_calculate_timeout(struct spi_imx_data *spi_imx, int size)
1002 unsigned long timeout = 0;
1004 /* Time with actual data transfer and CS change delay related to HW */
1005 timeout = (8 + 4) * size / spi_imx->spi_bus_clk;
1007 /* Add extra second for scheduler related activities */
1010 /* Double calculated timeout */
1011 return msecs_to_jiffies(2 * timeout * MSEC_PER_SEC);
1014 static int spi_imx_dma_transfer(struct spi_imx_data *spi_imx,
1015 struct spi_transfer *transfer)
1017 struct dma_async_tx_descriptor *desc_tx, *desc_rx;
1018 unsigned long transfer_timeout;
1019 unsigned long timeout;
1020 struct spi_master *master = spi_imx->bitbang.master;
1021 struct sg_table *tx = &transfer->tx_sg, *rx = &transfer->rx_sg;
1024 * The TX DMA setup starts the transfer, so make sure RX is configured
1027 desc_rx = dmaengine_prep_slave_sg(master->dma_rx,
1028 rx->sgl, rx->nents, DMA_DEV_TO_MEM,
1029 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1033 desc_rx->callback = spi_imx_dma_rx_callback;
1034 desc_rx->callback_param = (void *)spi_imx;
1035 dmaengine_submit(desc_rx);
1036 reinit_completion(&spi_imx->dma_rx_completion);
1037 dma_async_issue_pending(master->dma_rx);
1039 desc_tx = dmaengine_prep_slave_sg(master->dma_tx,
1040 tx->sgl, tx->nents, DMA_MEM_TO_DEV,
1041 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1043 dmaengine_terminate_all(master->dma_tx);
1047 desc_tx->callback = spi_imx_dma_tx_callback;
1048 desc_tx->callback_param = (void *)spi_imx;
1049 dmaengine_submit(desc_tx);
1050 reinit_completion(&spi_imx->dma_tx_completion);
1051 dma_async_issue_pending(master->dma_tx);
1053 transfer_timeout = spi_imx_calculate_timeout(spi_imx, transfer->len);
1055 /* Wait SDMA to finish the data transfer.*/
1056 timeout = wait_for_completion_timeout(&spi_imx->dma_tx_completion,
1059 dev_err(spi_imx->dev, "I/O Error in DMA TX\n");
1060 dmaengine_terminate_all(master->dma_tx);
1061 dmaengine_terminate_all(master->dma_rx);
1065 timeout = wait_for_completion_timeout(&spi_imx->dma_rx_completion,
1068 dev_err(&master->dev, "I/O Error in DMA RX\n");
1069 spi_imx->devtype_data->reset(spi_imx);
1070 dmaengine_terminate_all(master->dma_rx);
1074 return transfer->len;
1077 static int spi_imx_pio_transfer(struct spi_device *spi,
1078 struct spi_transfer *transfer)
1080 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
1081 unsigned long transfer_timeout;
1082 unsigned long timeout;
1084 spi_imx->tx_buf = transfer->tx_buf;
1085 spi_imx->rx_buf = transfer->rx_buf;
1086 spi_imx->count = transfer->len;
1087 spi_imx->txfifo = 0;
1089 reinit_completion(&spi_imx->xfer_done);
1091 spi_imx_push(spi_imx);
1093 spi_imx->devtype_data->intctrl(spi_imx, MXC_INT_TE);
1095 transfer_timeout = spi_imx_calculate_timeout(spi_imx, transfer->len);
1097 timeout = wait_for_completion_timeout(&spi_imx->xfer_done,
1100 dev_err(&spi->dev, "I/O Error in PIO\n");
1101 spi_imx->devtype_data->reset(spi_imx);
1105 return transfer->len;
1108 static int spi_imx_transfer(struct spi_device *spi,
1109 struct spi_transfer *transfer)
1111 struct spi_imx_data *spi_imx = spi_master_get_devdata(spi->master);
1113 if (spi_imx->usedma)
1114 return spi_imx_dma_transfer(spi_imx, transfer);
1116 return spi_imx_pio_transfer(spi, transfer);
1119 static int spi_imx_setup(struct spi_device *spi)
1121 dev_dbg(&spi->dev, "%s: mode %d, %u bpw, %d hz\n", __func__,
1122 spi->mode, spi->bits_per_word, spi->max_speed_hz);
1124 if (gpio_is_valid(spi->cs_gpio))
1125 gpio_direction_output(spi->cs_gpio,
1126 spi->mode & SPI_CS_HIGH ? 0 : 1);
1128 spi_imx_chipselect(spi, BITBANG_CS_INACTIVE);
1133 static void spi_imx_cleanup(struct spi_device *spi)
1138 spi_imx_prepare_message(struct spi_master *master, struct spi_message *msg)
1140 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
1143 ret = clk_enable(spi_imx->clk_per);
1147 ret = clk_enable(spi_imx->clk_ipg);
1149 clk_disable(spi_imx->clk_per);
1157 spi_imx_unprepare_message(struct spi_master *master, struct spi_message *msg)
1159 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
1161 clk_disable(spi_imx->clk_ipg);
1162 clk_disable(spi_imx->clk_per);
1166 static int spi_imx_probe(struct platform_device *pdev)
1168 struct device_node *np = pdev->dev.of_node;
1169 const struct of_device_id *of_id =
1170 of_match_device(spi_imx_dt_ids, &pdev->dev);
1171 struct spi_imx_master *mxc_platform_info =
1172 dev_get_platdata(&pdev->dev);
1173 struct spi_master *master;
1174 struct spi_imx_data *spi_imx;
1175 struct resource *res;
1178 if (!np && !mxc_platform_info) {
1179 dev_err(&pdev->dev, "can't get the platform data\n");
1183 master = spi_alloc_master(&pdev->dev, sizeof(struct spi_imx_data));
1187 platform_set_drvdata(pdev, master);
1189 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(1, 32);
1190 master->bus_num = np ? -1 : pdev->id;
1192 spi_imx = spi_master_get_devdata(master);
1193 spi_imx->bitbang.master = master;
1194 spi_imx->dev = &pdev->dev;
1196 spi_imx->devtype_data = of_id ? of_id->data :
1197 (struct spi_imx_devtype_data *)pdev->id_entry->driver_data;
1199 if (mxc_platform_info) {
1200 master->num_chipselect = mxc_platform_info->num_chipselect;
1201 master->cs_gpios = devm_kzalloc(&master->dev,
1202 sizeof(int) * master->num_chipselect, GFP_KERNEL);
1203 if (!master->cs_gpios)
1206 for (i = 0; i < master->num_chipselect; i++)
1207 master->cs_gpios[i] = mxc_platform_info->chipselect[i];
1210 spi_imx->bitbang.chipselect = spi_imx_chipselect;
1211 spi_imx->bitbang.setup_transfer = spi_imx_setupxfer;
1212 spi_imx->bitbang.txrx_bufs = spi_imx_transfer;
1213 spi_imx->bitbang.master->setup = spi_imx_setup;
1214 spi_imx->bitbang.master->cleanup = spi_imx_cleanup;
1215 spi_imx->bitbang.master->prepare_message = spi_imx_prepare_message;
1216 spi_imx->bitbang.master->unprepare_message = spi_imx_unprepare_message;
1217 spi_imx->bitbang.master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
1218 if (is_imx35_cspi(spi_imx) || is_imx51_ecspi(spi_imx))
1219 spi_imx->bitbang.master->mode_bits |= SPI_LOOP;
1221 init_completion(&spi_imx->xfer_done);
1223 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1224 spi_imx->base = devm_ioremap_resource(&pdev->dev, res);
1225 if (IS_ERR(spi_imx->base)) {
1226 ret = PTR_ERR(spi_imx->base);
1227 goto out_master_put;
1229 spi_imx->base_phys = res->start;
1231 irq = platform_get_irq(pdev, 0);
1234 goto out_master_put;
1237 ret = devm_request_irq(&pdev->dev, irq, spi_imx_isr, 0,
1238 dev_name(&pdev->dev), spi_imx);
1240 dev_err(&pdev->dev, "can't get irq%d: %d\n", irq, ret);
1241 goto out_master_put;
1244 spi_imx->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
1245 if (IS_ERR(spi_imx->clk_ipg)) {
1246 ret = PTR_ERR(spi_imx->clk_ipg);
1247 goto out_master_put;
1250 spi_imx->clk_per = devm_clk_get(&pdev->dev, "per");
1251 if (IS_ERR(spi_imx->clk_per)) {
1252 ret = PTR_ERR(spi_imx->clk_per);
1253 goto out_master_put;
1256 ret = clk_prepare_enable(spi_imx->clk_per);
1258 goto out_master_put;
1260 ret = clk_prepare_enable(spi_imx->clk_ipg);
1264 spi_imx->spi_clk = clk_get_rate(spi_imx->clk_per);
1266 * Only validated on i.mx35 and i.mx6 now, can remove the constraint
1267 * if validated on other chips.
1269 if (is_imx35_cspi(spi_imx) || is_imx51_ecspi(spi_imx)) {
1270 ret = spi_imx_sdma_init(&pdev->dev, spi_imx, master);
1271 if (ret == -EPROBE_DEFER)
1275 dev_err(&pdev->dev, "dma setup error %d, use pio\n",
1279 spi_imx->devtype_data->reset(spi_imx);
1281 spi_imx->devtype_data->intctrl(spi_imx, 0);
1283 master->dev.of_node = pdev->dev.of_node;
1284 ret = spi_bitbang_start(&spi_imx->bitbang);
1286 dev_err(&pdev->dev, "bitbang start failed with %d\n", ret);
1290 if (!master->cs_gpios) {
1291 dev_err(&pdev->dev, "No CS GPIOs available\n");
1296 for (i = 0; i < master->num_chipselect; i++) {
1297 if (!gpio_is_valid(master->cs_gpios[i]))
1300 ret = devm_gpio_request(&pdev->dev, master->cs_gpios[i],
1303 dev_err(&pdev->dev, "Can't get CS GPIO %i\n",
1304 master->cs_gpios[i]);
1309 dev_info(&pdev->dev, "probed\n");
1311 clk_disable(spi_imx->clk_ipg);
1312 clk_disable(spi_imx->clk_per);
1316 clk_disable_unprepare(spi_imx->clk_ipg);
1318 clk_disable_unprepare(spi_imx->clk_per);
1320 spi_master_put(master);
1325 static int spi_imx_remove(struct platform_device *pdev)
1327 struct spi_master *master = platform_get_drvdata(pdev);
1328 struct spi_imx_data *spi_imx = spi_master_get_devdata(master);
1330 spi_bitbang_stop(&spi_imx->bitbang);
1332 writel(0, spi_imx->base + MXC_CSPICTRL);
1333 clk_unprepare(spi_imx->clk_ipg);
1334 clk_unprepare(spi_imx->clk_per);
1335 spi_imx_sdma_exit(spi_imx);
1336 spi_master_put(master);
1341 static struct platform_driver spi_imx_driver = {
1343 .name = DRIVER_NAME,
1344 .of_match_table = spi_imx_dt_ids,
1346 .id_table = spi_imx_devtype,
1347 .probe = spi_imx_probe,
1348 .remove = spi_imx_remove,
1350 module_platform_driver(spi_imx_driver);
1352 MODULE_DESCRIPTION("SPI Master Controller driver");
1353 MODULE_AUTHOR("Sascha Hauer, Pengutronix");
1354 MODULE_LICENSE("GPL");
1355 MODULE_ALIAS("platform:" DRIVER_NAME);