PM / sleep: Asynchronous threads for suspend_noirq
[linux/fpc-iii.git] / drivers / spi / spi-davinci.c
blob5e7389faa2a0189472d71fedcba95ae8ecd1cf35
1 /*
2 * Copyright (C) 2009 Texas Instruments.
3 * Copyright (C) 2010 EF Johnson Technologies
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/interrupt.h>
21 #include <linux/io.h>
22 #include <linux/gpio.h>
23 #include <linux/module.h>
24 #include <linux/delay.h>
25 #include <linux/platform_device.h>
26 #include <linux/err.h>
27 #include <linux/clk.h>
28 #include <linux/dmaengine.h>
29 #include <linux/dma-mapping.h>
30 #include <linux/edma.h>
31 #include <linux/of.h>
32 #include <linux/of_device.h>
33 #include <linux/spi/spi.h>
34 #include <linux/spi/spi_bitbang.h>
35 #include <linux/slab.h>
37 #include <linux/platform_data/spi-davinci.h>
39 #define SPI_NO_RESOURCE ((resource_size_t)-1)
41 #define SPI_MAX_CHIPSELECT 2
43 #define CS_DEFAULT 0xFF
45 #define SPIFMT_PHASE_MASK BIT(16)
46 #define SPIFMT_POLARITY_MASK BIT(17)
47 #define SPIFMT_DISTIMER_MASK BIT(18)
48 #define SPIFMT_SHIFTDIR_MASK BIT(20)
49 #define SPIFMT_WAITENA_MASK BIT(21)
50 #define SPIFMT_PARITYENA_MASK BIT(22)
51 #define SPIFMT_ODD_PARITY_MASK BIT(23)
52 #define SPIFMT_WDELAY_MASK 0x3f000000u
53 #define SPIFMT_WDELAY_SHIFT 24
54 #define SPIFMT_PRESCALE_SHIFT 8
56 /* SPIPC0 */
57 #define SPIPC0_DIFUN_MASK BIT(11) /* MISO */
58 #define SPIPC0_DOFUN_MASK BIT(10) /* MOSI */
59 #define SPIPC0_CLKFUN_MASK BIT(9) /* CLK */
60 #define SPIPC0_SPIENA_MASK BIT(8) /* nREADY */
62 #define SPIINT_MASKALL 0x0101035F
63 #define SPIINT_MASKINT 0x0000015F
64 #define SPI_INTLVL_1 0x000001FF
65 #define SPI_INTLVL_0 0x00000000
67 /* SPIDAT1 (upper 16 bit defines) */
68 #define SPIDAT1_CSHOLD_MASK BIT(12)
70 /* SPIGCR1 */
71 #define SPIGCR1_CLKMOD_MASK BIT(1)
72 #define SPIGCR1_MASTER_MASK BIT(0)
73 #define SPIGCR1_POWERDOWN_MASK BIT(8)
74 #define SPIGCR1_LOOPBACK_MASK BIT(16)
75 #define SPIGCR1_SPIENA_MASK BIT(24)
77 /* SPIBUF */
78 #define SPIBUF_TXFULL_MASK BIT(29)
79 #define SPIBUF_RXEMPTY_MASK BIT(31)
81 /* SPIDELAY */
82 #define SPIDELAY_C2TDELAY_SHIFT 24
83 #define SPIDELAY_C2TDELAY_MASK (0xFF << SPIDELAY_C2TDELAY_SHIFT)
84 #define SPIDELAY_T2CDELAY_SHIFT 16
85 #define SPIDELAY_T2CDELAY_MASK (0xFF << SPIDELAY_T2CDELAY_SHIFT)
86 #define SPIDELAY_T2EDELAY_SHIFT 8
87 #define SPIDELAY_T2EDELAY_MASK (0xFF << SPIDELAY_T2EDELAY_SHIFT)
88 #define SPIDELAY_C2EDELAY_SHIFT 0
89 #define SPIDELAY_C2EDELAY_MASK 0xFF
91 /* Error Masks */
92 #define SPIFLG_DLEN_ERR_MASK BIT(0)
93 #define SPIFLG_TIMEOUT_MASK BIT(1)
94 #define SPIFLG_PARERR_MASK BIT(2)
95 #define SPIFLG_DESYNC_MASK BIT(3)
96 #define SPIFLG_BITERR_MASK BIT(4)
97 #define SPIFLG_OVRRUN_MASK BIT(6)
98 #define SPIFLG_BUF_INIT_ACTIVE_MASK BIT(24)
99 #define SPIFLG_ERROR_MASK (SPIFLG_DLEN_ERR_MASK \
100 | SPIFLG_TIMEOUT_MASK | SPIFLG_PARERR_MASK \
101 | SPIFLG_DESYNC_MASK | SPIFLG_BITERR_MASK \
102 | SPIFLG_OVRRUN_MASK)
104 #define SPIINT_DMA_REQ_EN BIT(16)
106 /* SPI Controller registers */
107 #define SPIGCR0 0x00
108 #define SPIGCR1 0x04
109 #define SPIINT 0x08
110 #define SPILVL 0x0c
111 #define SPIFLG 0x10
112 #define SPIPC0 0x14
113 #define SPIDAT1 0x3c
114 #define SPIBUF 0x40
115 #define SPIDELAY 0x48
116 #define SPIDEF 0x4c
117 #define SPIFMT0 0x50
119 /* SPI Controller driver's private data. */
120 struct davinci_spi {
121 struct spi_bitbang bitbang;
122 struct clk *clk;
124 u8 version;
125 resource_size_t pbase;
126 void __iomem *base;
127 u32 irq;
128 struct completion done;
130 const void *tx;
131 void *rx;
132 int rcount;
133 int wcount;
135 struct dma_chan *dma_rx;
136 struct dma_chan *dma_tx;
137 int dma_rx_chnum;
138 int dma_tx_chnum;
140 struct davinci_spi_platform_data pdata;
142 void (*get_rx)(u32 rx_data, struct davinci_spi *);
143 u32 (*get_tx)(struct davinci_spi *);
145 u8 bytes_per_word[SPI_MAX_CHIPSELECT];
148 static struct davinci_spi_config davinci_spi_default_cfg;
150 static void davinci_spi_rx_buf_u8(u32 data, struct davinci_spi *dspi)
152 if (dspi->rx) {
153 u8 *rx = dspi->rx;
154 *rx++ = (u8)data;
155 dspi->rx = rx;
159 static void davinci_spi_rx_buf_u16(u32 data, struct davinci_spi *dspi)
161 if (dspi->rx) {
162 u16 *rx = dspi->rx;
163 *rx++ = (u16)data;
164 dspi->rx = rx;
168 static u32 davinci_spi_tx_buf_u8(struct davinci_spi *dspi)
170 u32 data = 0;
171 if (dspi->tx) {
172 const u8 *tx = dspi->tx;
173 data = *tx++;
174 dspi->tx = tx;
176 return data;
179 static u32 davinci_spi_tx_buf_u16(struct davinci_spi *dspi)
181 u32 data = 0;
182 if (dspi->tx) {
183 const u16 *tx = dspi->tx;
184 data = *tx++;
185 dspi->tx = tx;
187 return data;
190 static inline void set_io_bits(void __iomem *addr, u32 bits)
192 u32 v = ioread32(addr);
194 v |= bits;
195 iowrite32(v, addr);
198 static inline void clear_io_bits(void __iomem *addr, u32 bits)
200 u32 v = ioread32(addr);
202 v &= ~bits;
203 iowrite32(v, addr);
207 * Interface to control the chip select signal
209 static void davinci_spi_chipselect(struct spi_device *spi, int value)
211 struct davinci_spi *dspi;
212 struct davinci_spi_platform_data *pdata;
213 u8 chip_sel = spi->chip_select;
214 u16 spidat1 = CS_DEFAULT;
215 bool gpio_chipsel = false;
217 dspi = spi_master_get_devdata(spi->master);
218 pdata = &dspi->pdata;
220 if (pdata->chip_sel && chip_sel < pdata->num_chipselect &&
221 pdata->chip_sel[chip_sel] != SPI_INTERN_CS)
222 gpio_chipsel = true;
225 * Board specific chip select logic decides the polarity and cs
226 * line for the controller
228 if (gpio_chipsel) {
229 if (value == BITBANG_CS_ACTIVE)
230 gpio_set_value(pdata->chip_sel[chip_sel], 0);
231 else
232 gpio_set_value(pdata->chip_sel[chip_sel], 1);
233 } else {
234 if (value == BITBANG_CS_ACTIVE) {
235 spidat1 |= SPIDAT1_CSHOLD_MASK;
236 spidat1 &= ~(0x1 << chip_sel);
239 iowrite16(spidat1, dspi->base + SPIDAT1 + 2);
244 * davinci_spi_get_prescale - Calculates the correct prescale value
245 * @maxspeed_hz: the maximum rate the SPI clock can run at
247 * This function calculates the prescale value that generates a clock rate
248 * less than or equal to the specified maximum.
250 * Returns: calculated prescale - 1 for easy programming into SPI registers
251 * or negative error number if valid prescalar cannot be updated.
253 static inline int davinci_spi_get_prescale(struct davinci_spi *dspi,
254 u32 max_speed_hz)
256 int ret;
258 ret = DIV_ROUND_UP(clk_get_rate(dspi->clk), max_speed_hz);
260 if (ret < 3 || ret > 256)
261 return -EINVAL;
263 return ret - 1;
267 * davinci_spi_setup_transfer - This functions will determine transfer method
268 * @spi: spi device on which data transfer to be done
269 * @t: spi transfer in which transfer info is filled
271 * This function determines data transfer method (8/16/32 bit transfer).
272 * It will also set the SPI Clock Control register according to
273 * SPI slave device freq.
275 static int davinci_spi_setup_transfer(struct spi_device *spi,
276 struct spi_transfer *t)
279 struct davinci_spi *dspi;
280 struct davinci_spi_config *spicfg;
281 u8 bits_per_word = 0;
282 u32 hz = 0, spifmt = 0;
283 int prescale;
285 dspi = spi_master_get_devdata(spi->master);
286 spicfg = (struct davinci_spi_config *)spi->controller_data;
287 if (!spicfg)
288 spicfg = &davinci_spi_default_cfg;
290 if (t) {
291 bits_per_word = t->bits_per_word;
292 hz = t->speed_hz;
295 /* if bits_per_word is not set then set it default */
296 if (!bits_per_word)
297 bits_per_word = spi->bits_per_word;
300 * Assign function pointer to appropriate transfer method
301 * 8bit, 16bit or 32bit transfer
303 if (bits_per_word <= 8) {
304 dspi->get_rx = davinci_spi_rx_buf_u8;
305 dspi->get_tx = davinci_spi_tx_buf_u8;
306 dspi->bytes_per_word[spi->chip_select] = 1;
307 } else {
308 dspi->get_rx = davinci_spi_rx_buf_u16;
309 dspi->get_tx = davinci_spi_tx_buf_u16;
310 dspi->bytes_per_word[spi->chip_select] = 2;
313 if (!hz)
314 hz = spi->max_speed_hz;
316 /* Set up SPIFMTn register, unique to this chipselect. */
318 prescale = davinci_spi_get_prescale(dspi, hz);
319 if (prescale < 0)
320 return prescale;
322 spifmt = (prescale << SPIFMT_PRESCALE_SHIFT) | (bits_per_word & 0x1f);
324 if (spi->mode & SPI_LSB_FIRST)
325 spifmt |= SPIFMT_SHIFTDIR_MASK;
327 if (spi->mode & SPI_CPOL)
328 spifmt |= SPIFMT_POLARITY_MASK;
330 if (!(spi->mode & SPI_CPHA))
331 spifmt |= SPIFMT_PHASE_MASK;
334 * Version 1 hardware supports two basic SPI modes:
335 * - Standard SPI mode uses 4 pins, with chipselect
336 * - 3 pin SPI is a 4 pin variant without CS (SPI_NO_CS)
337 * (distinct from SPI_3WIRE, with just one data wire;
338 * or similar variants without MOSI or without MISO)
340 * Version 2 hardware supports an optional handshaking signal,
341 * so it can support two more modes:
342 * - 5 pin SPI variant is standard SPI plus SPI_READY
343 * - 4 pin with enable is (SPI_READY | SPI_NO_CS)
346 if (dspi->version == SPI_VERSION_2) {
348 u32 delay = 0;
350 spifmt |= ((spicfg->wdelay << SPIFMT_WDELAY_SHIFT)
351 & SPIFMT_WDELAY_MASK);
353 if (spicfg->odd_parity)
354 spifmt |= SPIFMT_ODD_PARITY_MASK;
356 if (spicfg->parity_enable)
357 spifmt |= SPIFMT_PARITYENA_MASK;
359 if (spicfg->timer_disable) {
360 spifmt |= SPIFMT_DISTIMER_MASK;
361 } else {
362 delay |= (spicfg->c2tdelay << SPIDELAY_C2TDELAY_SHIFT)
363 & SPIDELAY_C2TDELAY_MASK;
364 delay |= (spicfg->t2cdelay << SPIDELAY_T2CDELAY_SHIFT)
365 & SPIDELAY_T2CDELAY_MASK;
368 if (spi->mode & SPI_READY) {
369 spifmt |= SPIFMT_WAITENA_MASK;
370 delay |= (spicfg->t2edelay << SPIDELAY_T2EDELAY_SHIFT)
371 & SPIDELAY_T2EDELAY_MASK;
372 delay |= (spicfg->c2edelay << SPIDELAY_C2EDELAY_SHIFT)
373 & SPIDELAY_C2EDELAY_MASK;
376 iowrite32(delay, dspi->base + SPIDELAY);
379 iowrite32(spifmt, dspi->base + SPIFMT0);
381 return 0;
385 * davinci_spi_setup - This functions will set default transfer method
386 * @spi: spi device on which data transfer to be done
388 * This functions sets the default transfer method.
390 static int davinci_spi_setup(struct spi_device *spi)
392 int retval = 0;
393 struct davinci_spi *dspi;
394 struct davinci_spi_platform_data *pdata;
396 dspi = spi_master_get_devdata(spi->master);
397 pdata = &dspi->pdata;
399 if (!(spi->mode & SPI_NO_CS)) {
400 if ((pdata->chip_sel == NULL) ||
401 (pdata->chip_sel[spi->chip_select] == SPI_INTERN_CS))
402 set_io_bits(dspi->base + SPIPC0, 1 << spi->chip_select);
406 if (spi->mode & SPI_READY)
407 set_io_bits(dspi->base + SPIPC0, SPIPC0_SPIENA_MASK);
409 if (spi->mode & SPI_LOOP)
410 set_io_bits(dspi->base + SPIGCR1, SPIGCR1_LOOPBACK_MASK);
411 else
412 clear_io_bits(dspi->base + SPIGCR1, SPIGCR1_LOOPBACK_MASK);
414 return retval;
417 static int davinci_spi_check_error(struct davinci_spi *dspi, int int_status)
419 struct device *sdev = dspi->bitbang.master->dev.parent;
421 if (int_status & SPIFLG_TIMEOUT_MASK) {
422 dev_dbg(sdev, "SPI Time-out Error\n");
423 return -ETIMEDOUT;
425 if (int_status & SPIFLG_DESYNC_MASK) {
426 dev_dbg(sdev, "SPI Desynchronization Error\n");
427 return -EIO;
429 if (int_status & SPIFLG_BITERR_MASK) {
430 dev_dbg(sdev, "SPI Bit error\n");
431 return -EIO;
434 if (dspi->version == SPI_VERSION_2) {
435 if (int_status & SPIFLG_DLEN_ERR_MASK) {
436 dev_dbg(sdev, "SPI Data Length Error\n");
437 return -EIO;
439 if (int_status & SPIFLG_PARERR_MASK) {
440 dev_dbg(sdev, "SPI Parity Error\n");
441 return -EIO;
443 if (int_status & SPIFLG_OVRRUN_MASK) {
444 dev_dbg(sdev, "SPI Data Overrun error\n");
445 return -EIO;
447 if (int_status & SPIFLG_BUF_INIT_ACTIVE_MASK) {
448 dev_dbg(sdev, "SPI Buffer Init Active\n");
449 return -EBUSY;
453 return 0;
457 * davinci_spi_process_events - check for and handle any SPI controller events
458 * @dspi: the controller data
460 * This function will check the SPIFLG register and handle any events that are
461 * detected there
463 static int davinci_spi_process_events(struct davinci_spi *dspi)
465 u32 buf, status, errors = 0, spidat1;
467 buf = ioread32(dspi->base + SPIBUF);
469 if (dspi->rcount > 0 && !(buf & SPIBUF_RXEMPTY_MASK)) {
470 dspi->get_rx(buf & 0xFFFF, dspi);
471 dspi->rcount--;
474 status = ioread32(dspi->base + SPIFLG);
476 if (unlikely(status & SPIFLG_ERROR_MASK)) {
477 errors = status & SPIFLG_ERROR_MASK;
478 goto out;
481 if (dspi->wcount > 0 && !(buf & SPIBUF_TXFULL_MASK)) {
482 spidat1 = ioread32(dspi->base + SPIDAT1);
483 dspi->wcount--;
484 spidat1 &= ~0xFFFF;
485 spidat1 |= 0xFFFF & dspi->get_tx(dspi);
486 iowrite32(spidat1, dspi->base + SPIDAT1);
489 out:
490 return errors;
493 static void davinci_spi_dma_rx_callback(void *data)
495 struct davinci_spi *dspi = (struct davinci_spi *)data;
497 dspi->rcount = 0;
499 if (!dspi->wcount && !dspi->rcount)
500 complete(&dspi->done);
503 static void davinci_spi_dma_tx_callback(void *data)
505 struct davinci_spi *dspi = (struct davinci_spi *)data;
507 dspi->wcount = 0;
509 if (!dspi->wcount && !dspi->rcount)
510 complete(&dspi->done);
514 * davinci_spi_bufs - functions which will handle transfer data
515 * @spi: spi device on which data transfer to be done
516 * @t: spi transfer in which transfer info is filled
518 * This function will put data to be transferred into data register
519 * of SPI controller and then wait until the completion will be marked
520 * by the IRQ Handler.
522 static int davinci_spi_bufs(struct spi_device *spi, struct spi_transfer *t)
524 struct davinci_spi *dspi;
525 int data_type, ret = -ENOMEM;
526 u32 tx_data, spidat1;
527 u32 errors = 0;
528 struct davinci_spi_config *spicfg;
529 struct davinci_spi_platform_data *pdata;
530 unsigned uninitialized_var(rx_buf_count);
531 void *dummy_buf = NULL;
532 struct scatterlist sg_rx, sg_tx;
534 dspi = spi_master_get_devdata(spi->master);
535 pdata = &dspi->pdata;
536 spicfg = (struct davinci_spi_config *)spi->controller_data;
537 if (!spicfg)
538 spicfg = &davinci_spi_default_cfg;
540 /* convert len to words based on bits_per_word */
541 data_type = dspi->bytes_per_word[spi->chip_select];
543 dspi->tx = t->tx_buf;
544 dspi->rx = t->rx_buf;
545 dspi->wcount = t->len / data_type;
546 dspi->rcount = dspi->wcount;
548 spidat1 = ioread32(dspi->base + SPIDAT1);
550 clear_io_bits(dspi->base + SPIGCR1, SPIGCR1_POWERDOWN_MASK);
551 set_io_bits(dspi->base + SPIGCR1, SPIGCR1_SPIENA_MASK);
553 reinit_completion(&dspi->done);
555 if (spicfg->io_type == SPI_IO_TYPE_INTR)
556 set_io_bits(dspi->base + SPIINT, SPIINT_MASKINT);
558 if (spicfg->io_type != SPI_IO_TYPE_DMA) {
559 /* start the transfer */
560 dspi->wcount--;
561 tx_data = dspi->get_tx(dspi);
562 spidat1 &= 0xFFFF0000;
563 spidat1 |= tx_data & 0xFFFF;
564 iowrite32(spidat1, dspi->base + SPIDAT1);
565 } else {
566 struct dma_slave_config dma_rx_conf = {
567 .direction = DMA_DEV_TO_MEM,
568 .src_addr = (unsigned long)dspi->pbase + SPIBUF,
569 .src_addr_width = data_type,
570 .src_maxburst = 1,
572 struct dma_slave_config dma_tx_conf = {
573 .direction = DMA_MEM_TO_DEV,
574 .dst_addr = (unsigned long)dspi->pbase + SPIDAT1,
575 .dst_addr_width = data_type,
576 .dst_maxburst = 1,
578 struct dma_async_tx_descriptor *rxdesc;
579 struct dma_async_tx_descriptor *txdesc;
580 void *buf;
582 dummy_buf = kzalloc(t->len, GFP_KERNEL);
583 if (!dummy_buf)
584 goto err_alloc_dummy_buf;
586 dmaengine_slave_config(dspi->dma_rx, &dma_rx_conf);
587 dmaengine_slave_config(dspi->dma_tx, &dma_tx_conf);
589 sg_init_table(&sg_rx, 1);
590 if (!t->rx_buf)
591 buf = dummy_buf;
592 else
593 buf = t->rx_buf;
594 t->rx_dma = dma_map_single(&spi->dev, buf,
595 t->len, DMA_FROM_DEVICE);
596 if (!t->rx_dma) {
597 ret = -EFAULT;
598 goto err_rx_map;
600 sg_dma_address(&sg_rx) = t->rx_dma;
601 sg_dma_len(&sg_rx) = t->len;
603 sg_init_table(&sg_tx, 1);
604 if (!t->tx_buf)
605 buf = dummy_buf;
606 else
607 buf = (void *)t->tx_buf;
608 t->tx_dma = dma_map_single(&spi->dev, buf,
609 t->len, DMA_TO_DEVICE);
610 if (!t->tx_dma) {
611 ret = -EFAULT;
612 goto err_tx_map;
614 sg_dma_address(&sg_tx) = t->tx_dma;
615 sg_dma_len(&sg_tx) = t->len;
617 rxdesc = dmaengine_prep_slave_sg(dspi->dma_rx,
618 &sg_rx, 1, DMA_DEV_TO_MEM,
619 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
620 if (!rxdesc)
621 goto err_desc;
623 txdesc = dmaengine_prep_slave_sg(dspi->dma_tx,
624 &sg_tx, 1, DMA_MEM_TO_DEV,
625 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
626 if (!txdesc)
627 goto err_desc;
629 rxdesc->callback = davinci_spi_dma_rx_callback;
630 rxdesc->callback_param = (void *)dspi;
631 txdesc->callback = davinci_spi_dma_tx_callback;
632 txdesc->callback_param = (void *)dspi;
634 if (pdata->cshold_bug)
635 iowrite16(spidat1 >> 16, dspi->base + SPIDAT1 + 2);
637 dmaengine_submit(rxdesc);
638 dmaengine_submit(txdesc);
640 dma_async_issue_pending(dspi->dma_rx);
641 dma_async_issue_pending(dspi->dma_tx);
643 set_io_bits(dspi->base + SPIINT, SPIINT_DMA_REQ_EN);
646 /* Wait for the transfer to complete */
647 if (spicfg->io_type != SPI_IO_TYPE_POLL) {
648 wait_for_completion_interruptible(&(dspi->done));
649 } else {
650 while (dspi->rcount > 0 || dspi->wcount > 0) {
651 errors = davinci_spi_process_events(dspi);
652 if (errors)
653 break;
654 cpu_relax();
658 clear_io_bits(dspi->base + SPIINT, SPIINT_MASKALL);
659 if (spicfg->io_type == SPI_IO_TYPE_DMA) {
660 clear_io_bits(dspi->base + SPIINT, SPIINT_DMA_REQ_EN);
662 dma_unmap_single(&spi->dev, t->rx_dma,
663 t->len, DMA_FROM_DEVICE);
664 dma_unmap_single(&spi->dev, t->tx_dma,
665 t->len, DMA_TO_DEVICE);
666 kfree(dummy_buf);
669 clear_io_bits(dspi->base + SPIGCR1, SPIGCR1_SPIENA_MASK);
670 set_io_bits(dspi->base + SPIGCR1, SPIGCR1_POWERDOWN_MASK);
673 * Check for bit error, desync error,parity error,timeout error and
674 * receive overflow errors
676 if (errors) {
677 ret = davinci_spi_check_error(dspi, errors);
678 WARN(!ret, "%s: error reported but no error found!\n",
679 dev_name(&spi->dev));
680 return ret;
683 if (dspi->rcount != 0 || dspi->wcount != 0) {
684 dev_err(&spi->dev, "SPI data transfer error\n");
685 return -EIO;
688 return t->len;
690 err_desc:
691 dma_unmap_single(&spi->dev, t->tx_dma, t->len, DMA_TO_DEVICE);
692 err_tx_map:
693 dma_unmap_single(&spi->dev, t->rx_dma, t->len, DMA_FROM_DEVICE);
694 err_rx_map:
695 kfree(dummy_buf);
696 err_alloc_dummy_buf:
697 return ret;
701 * dummy_thread_fn - dummy thread function
702 * @irq: IRQ number for this SPI Master
703 * @context_data: structure for SPI Master controller davinci_spi
705 * This is to satisfy the request_threaded_irq() API so that the irq
706 * handler is called in interrupt context.
708 static irqreturn_t dummy_thread_fn(s32 irq, void *data)
710 return IRQ_HANDLED;
714 * davinci_spi_irq - Interrupt handler for SPI Master Controller
715 * @irq: IRQ number for this SPI Master
716 * @context_data: structure for SPI Master controller davinci_spi
718 * ISR will determine that interrupt arrives either for READ or WRITE command.
719 * According to command it will do the appropriate action. It will check
720 * transfer length and if it is not zero then dispatch transfer command again.
721 * If transfer length is zero then it will indicate the COMPLETION so that
722 * davinci_spi_bufs function can go ahead.
724 static irqreturn_t davinci_spi_irq(s32 irq, void *data)
726 struct davinci_spi *dspi = data;
727 int status;
729 status = davinci_spi_process_events(dspi);
730 if (unlikely(status != 0))
731 clear_io_bits(dspi->base + SPIINT, SPIINT_MASKINT);
733 if ((!dspi->rcount && !dspi->wcount) || status)
734 complete(&dspi->done);
736 return IRQ_HANDLED;
739 static int davinci_spi_request_dma(struct davinci_spi *dspi)
741 dma_cap_mask_t mask;
742 struct device *sdev = dspi->bitbang.master->dev.parent;
743 int r;
745 dma_cap_zero(mask);
746 dma_cap_set(DMA_SLAVE, mask);
748 dspi->dma_rx = dma_request_channel(mask, edma_filter_fn,
749 &dspi->dma_rx_chnum);
750 if (!dspi->dma_rx) {
751 dev_err(sdev, "request RX DMA channel failed\n");
752 r = -ENODEV;
753 goto rx_dma_failed;
756 dspi->dma_tx = dma_request_channel(mask, edma_filter_fn,
757 &dspi->dma_tx_chnum);
758 if (!dspi->dma_tx) {
759 dev_err(sdev, "request TX DMA channel failed\n");
760 r = -ENODEV;
761 goto tx_dma_failed;
764 return 0;
766 tx_dma_failed:
767 dma_release_channel(dspi->dma_rx);
768 rx_dma_failed:
769 return r;
772 #if defined(CONFIG_OF)
773 static const struct of_device_id davinci_spi_of_match[] = {
775 .compatible = "ti,dm6441-spi",
778 .compatible = "ti,da830-spi",
779 .data = (void *)SPI_VERSION_2,
781 { },
783 MODULE_DEVICE_TABLE(of, davinci_spi_of_match);
786 * spi_davinci_get_pdata - Get platform data from DTS binding
787 * @pdev: ptr to platform data
788 * @dspi: ptr to driver data
790 * Parses and populates pdata in dspi from device tree bindings.
792 * NOTE: Not all platform data params are supported currently.
794 static int spi_davinci_get_pdata(struct platform_device *pdev,
795 struct davinci_spi *dspi)
797 struct device_node *node = pdev->dev.of_node;
798 struct davinci_spi_platform_data *pdata;
799 unsigned int num_cs, intr_line = 0;
800 const struct of_device_id *match;
802 pdata = &dspi->pdata;
804 pdata->version = SPI_VERSION_1;
805 match = of_match_device(of_match_ptr(davinci_spi_of_match),
806 &pdev->dev);
807 if (!match)
808 return -ENODEV;
810 /* match data has the SPI version number for SPI_VERSION_2 */
811 if (match->data == (void *)SPI_VERSION_2)
812 pdata->version = SPI_VERSION_2;
815 * default num_cs is 1 and all chipsel are internal to the chip
816 * indicated by chip_sel being NULL. GPIO based CS is not
817 * supported yet in DT bindings.
819 num_cs = 1;
820 of_property_read_u32(node, "num-cs", &num_cs);
821 pdata->num_chipselect = num_cs;
822 of_property_read_u32(node, "ti,davinci-spi-intr-line", &intr_line);
823 pdata->intr_line = intr_line;
824 return 0;
826 #else
827 #define davinci_spi_of_match NULL
828 static struct davinci_spi_platform_data
829 *spi_davinci_get_pdata(struct platform_device *pdev,
830 struct davinci_spi *dspi)
832 return -ENODEV;
834 #endif
837 * davinci_spi_probe - probe function for SPI Master Controller
838 * @pdev: platform_device structure which contains plateform specific data
840 * According to Linux Device Model this function will be invoked by Linux
841 * with platform_device struct which contains the device specific info.
842 * This function will map the SPI controller's memory, register IRQ,
843 * Reset SPI controller and setting its registers to default value.
844 * It will invoke spi_bitbang_start to create work queue so that client driver
845 * can register transfer method to work queue.
847 static int davinci_spi_probe(struct platform_device *pdev)
849 struct spi_master *master;
850 struct davinci_spi *dspi;
851 struct davinci_spi_platform_data *pdata;
852 struct resource *r;
853 resource_size_t dma_rx_chan = SPI_NO_RESOURCE;
854 resource_size_t dma_tx_chan = SPI_NO_RESOURCE;
855 int i = 0, ret = 0;
856 u32 spipc0;
858 master = spi_alloc_master(&pdev->dev, sizeof(struct davinci_spi));
859 if (master == NULL) {
860 ret = -ENOMEM;
861 goto err;
864 platform_set_drvdata(pdev, master);
866 dspi = spi_master_get_devdata(master);
867 if (dspi == NULL) {
868 ret = -ENOENT;
869 goto free_master;
872 if (dev_get_platdata(&pdev->dev)) {
873 pdata = dev_get_platdata(&pdev->dev);
874 dspi->pdata = *pdata;
875 } else {
876 /* update dspi pdata with that from the DT */
877 ret = spi_davinci_get_pdata(pdev, dspi);
878 if (ret < 0)
879 goto free_master;
882 /* pdata in dspi is now updated and point pdata to that */
883 pdata = &dspi->pdata;
885 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
886 if (r == NULL) {
887 ret = -ENOENT;
888 goto free_master;
891 dspi->pbase = r->start;
893 dspi->base = devm_ioremap_resource(&pdev->dev, r);
894 if (IS_ERR(dspi->base)) {
895 ret = PTR_ERR(dspi->base);
896 goto free_master;
899 dspi->irq = platform_get_irq(pdev, 0);
900 if (dspi->irq <= 0) {
901 ret = -EINVAL;
902 goto free_master;
905 ret = devm_request_threaded_irq(&pdev->dev, dspi->irq, davinci_spi_irq,
906 dummy_thread_fn, 0, dev_name(&pdev->dev), dspi);
907 if (ret)
908 goto free_master;
910 dspi->bitbang.master = master;
911 if (dspi->bitbang.master == NULL) {
912 ret = -ENODEV;
913 goto free_master;
916 dspi->clk = devm_clk_get(&pdev->dev, NULL);
917 if (IS_ERR(dspi->clk)) {
918 ret = -ENODEV;
919 goto free_master;
921 clk_prepare_enable(dspi->clk);
923 master->dev.of_node = pdev->dev.of_node;
924 master->bus_num = pdev->id;
925 master->num_chipselect = pdata->num_chipselect;
926 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(2, 16);
927 master->setup = davinci_spi_setup;
929 dspi->bitbang.chipselect = davinci_spi_chipselect;
930 dspi->bitbang.setup_transfer = davinci_spi_setup_transfer;
932 dspi->version = pdata->version;
934 dspi->bitbang.flags = SPI_NO_CS | SPI_LSB_FIRST | SPI_LOOP;
935 if (dspi->version == SPI_VERSION_2)
936 dspi->bitbang.flags |= SPI_READY;
938 r = platform_get_resource(pdev, IORESOURCE_DMA, 0);
939 if (r)
940 dma_rx_chan = r->start;
941 r = platform_get_resource(pdev, IORESOURCE_DMA, 1);
942 if (r)
943 dma_tx_chan = r->start;
945 dspi->bitbang.txrx_bufs = davinci_spi_bufs;
946 if (dma_rx_chan != SPI_NO_RESOURCE &&
947 dma_tx_chan != SPI_NO_RESOURCE) {
948 dspi->dma_rx_chnum = dma_rx_chan;
949 dspi->dma_tx_chnum = dma_tx_chan;
951 ret = davinci_spi_request_dma(dspi);
952 if (ret)
953 goto free_clk;
955 dev_info(&pdev->dev, "DMA: supported\n");
956 dev_info(&pdev->dev, "DMA: RX channel: %pa, TX channel: %pa, "
957 "event queue: %d\n", &dma_rx_chan, &dma_tx_chan,
958 pdata->dma_event_q);
961 dspi->get_rx = davinci_spi_rx_buf_u8;
962 dspi->get_tx = davinci_spi_tx_buf_u8;
964 init_completion(&dspi->done);
966 /* Reset In/OUT SPI module */
967 iowrite32(0, dspi->base + SPIGCR0);
968 udelay(100);
969 iowrite32(1, dspi->base + SPIGCR0);
971 /* Set up SPIPC0. CS and ENA init is done in davinci_spi_setup */
972 spipc0 = SPIPC0_DIFUN_MASK | SPIPC0_DOFUN_MASK | SPIPC0_CLKFUN_MASK;
973 iowrite32(spipc0, dspi->base + SPIPC0);
975 /* initialize chip selects */
976 if (pdata->chip_sel) {
977 for (i = 0; i < pdata->num_chipselect; i++) {
978 if (pdata->chip_sel[i] != SPI_INTERN_CS)
979 gpio_direction_output(pdata->chip_sel[i], 1);
983 if (pdata->intr_line)
984 iowrite32(SPI_INTLVL_1, dspi->base + SPILVL);
985 else
986 iowrite32(SPI_INTLVL_0, dspi->base + SPILVL);
988 iowrite32(CS_DEFAULT, dspi->base + SPIDEF);
990 /* master mode default */
991 set_io_bits(dspi->base + SPIGCR1, SPIGCR1_CLKMOD_MASK);
992 set_io_bits(dspi->base + SPIGCR1, SPIGCR1_MASTER_MASK);
993 set_io_bits(dspi->base + SPIGCR1, SPIGCR1_POWERDOWN_MASK);
995 ret = spi_bitbang_start(&dspi->bitbang);
996 if (ret)
997 goto free_dma;
999 dev_info(&pdev->dev, "Controller at 0x%p\n", dspi->base);
1001 return ret;
1003 free_dma:
1004 dma_release_channel(dspi->dma_rx);
1005 dma_release_channel(dspi->dma_tx);
1006 free_clk:
1007 clk_disable_unprepare(dspi->clk);
1008 free_master:
1009 spi_master_put(master);
1010 err:
1011 return ret;
1015 * davinci_spi_remove - remove function for SPI Master Controller
1016 * @pdev: platform_device structure which contains plateform specific data
1018 * This function will do the reverse action of davinci_spi_probe function
1019 * It will free the IRQ and SPI controller's memory region.
1020 * It will also call spi_bitbang_stop to destroy the work queue which was
1021 * created by spi_bitbang_start.
1023 static int davinci_spi_remove(struct platform_device *pdev)
1025 struct davinci_spi *dspi;
1026 struct spi_master *master;
1028 master = platform_get_drvdata(pdev);
1029 dspi = spi_master_get_devdata(master);
1031 spi_bitbang_stop(&dspi->bitbang);
1033 clk_disable_unprepare(dspi->clk);
1034 spi_master_put(master);
1036 return 0;
1039 static struct platform_driver davinci_spi_driver = {
1040 .driver = {
1041 .name = "spi_davinci",
1042 .owner = THIS_MODULE,
1043 .of_match_table = davinci_spi_of_match,
1045 .probe = davinci_spi_probe,
1046 .remove = davinci_spi_remove,
1048 module_platform_driver(davinci_spi_driver);
1050 MODULE_DESCRIPTION("TI DaVinci SPI Master Controller Driver");
1051 MODULE_LICENSE("GPL");