2 * OMAP2 McSPI controller driver
4 * Copyright (C) 2005, 2006 Nokia Corporation
5 * Author: Samuel Ortiz <samuel.ortiz@nokia.com> and
6 * Juha Yrjölä <juha.yrjola@nokia.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/kernel.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
27 #include <linux/module.h>
28 #include <linux/device.h>
29 #include <linux/delay.h>
30 #include <linux/dma-mapping.h>
31 #include <linux/platform_device.h>
32 #include <linux/err.h>
33 #include <linux/clk.h>
35 #include <linux/slab.h>
37 #include <linux/spi/spi.h>
40 #include <plat/clock.h>
41 #include <plat/mcspi.h>
43 #define OMAP2_MCSPI_MAX_FREQ 48000000
45 /* OMAP2 has 3 SPI controllers, while OMAP3 has 4 */
46 #define OMAP2_MCSPI_MAX_CTRL 4
48 #define OMAP2_MCSPI_REVISION 0x00
49 #define OMAP2_MCSPI_SYSCONFIG 0x10
50 #define OMAP2_MCSPI_SYSSTATUS 0x14
51 #define OMAP2_MCSPI_IRQSTATUS 0x18
52 #define OMAP2_MCSPI_IRQENABLE 0x1c
53 #define OMAP2_MCSPI_WAKEUPENABLE 0x20
54 #define OMAP2_MCSPI_SYST 0x24
55 #define OMAP2_MCSPI_MODULCTRL 0x28
57 /* per-channel banks, 0x14 bytes each, first is: */
58 #define OMAP2_MCSPI_CHCONF0 0x2c
59 #define OMAP2_MCSPI_CHSTAT0 0x30
60 #define OMAP2_MCSPI_CHCTRL0 0x34
61 #define OMAP2_MCSPI_TX0 0x38
62 #define OMAP2_MCSPI_RX0 0x3c
64 /* per-register bitmasks: */
66 #define OMAP2_MCSPI_SYSCONFIG_SMARTIDLE BIT(4)
67 #define OMAP2_MCSPI_SYSCONFIG_ENAWAKEUP BIT(2)
68 #define OMAP2_MCSPI_SYSCONFIG_AUTOIDLE BIT(0)
69 #define OMAP2_MCSPI_SYSCONFIG_SOFTRESET BIT(1)
71 #define OMAP2_MCSPI_SYSSTATUS_RESETDONE BIT(0)
73 #define OMAP2_MCSPI_MODULCTRL_SINGLE BIT(0)
74 #define OMAP2_MCSPI_MODULCTRL_MS BIT(2)
75 #define OMAP2_MCSPI_MODULCTRL_STEST BIT(3)
77 #define OMAP2_MCSPI_CHCONF_PHA BIT(0)
78 #define OMAP2_MCSPI_CHCONF_POL BIT(1)
79 #define OMAP2_MCSPI_CHCONF_CLKD_MASK (0x0f << 2)
80 #define OMAP2_MCSPI_CHCONF_EPOL BIT(6)
81 #define OMAP2_MCSPI_CHCONF_WL_MASK (0x1f << 7)
82 #define OMAP2_MCSPI_CHCONF_TRM_RX_ONLY BIT(12)
83 #define OMAP2_MCSPI_CHCONF_TRM_TX_ONLY BIT(13)
84 #define OMAP2_MCSPI_CHCONF_TRM_MASK (0x03 << 12)
85 #define OMAP2_MCSPI_CHCONF_DMAW BIT(14)
86 #define OMAP2_MCSPI_CHCONF_DMAR BIT(15)
87 #define OMAP2_MCSPI_CHCONF_DPE0 BIT(16)
88 #define OMAP2_MCSPI_CHCONF_DPE1 BIT(17)
89 #define OMAP2_MCSPI_CHCONF_IS BIT(18)
90 #define OMAP2_MCSPI_CHCONF_TURBO BIT(19)
91 #define OMAP2_MCSPI_CHCONF_FORCE BIT(20)
93 #define OMAP2_MCSPI_CHSTAT_RXS BIT(0)
94 #define OMAP2_MCSPI_CHSTAT_TXS BIT(1)
95 #define OMAP2_MCSPI_CHSTAT_EOT BIT(2)
97 #define OMAP2_MCSPI_CHCTRL_EN BIT(0)
99 #define OMAP2_MCSPI_WAKEUPENABLE_WKEN BIT(0)
101 /* We have 2 DMA channels per CS, one for RX and one for TX */
102 struct omap2_mcspi_dma {
109 struct completion dma_tx_completion;
110 struct completion dma_rx_completion;
113 /* use PIO for small transfers, avoiding DMA setup/teardown overhead and
114 * cache operations; better heuristics consider wordsize and bitrate.
116 #define DMA_MIN_BYTES 160
120 struct work_struct work;
121 /* lock protects queue and registers */
123 struct list_head msg_queue;
124 struct spi_master *master;
127 /* Virtual base address of the controller */
130 /* SPI1 has 4 channels, while SPI2 has 2 */
131 struct omap2_mcspi_dma *dma_channels;
134 struct omap2_mcspi_cs {
138 struct list_head node;
139 /* Context save and restore shadow register */
143 /* used for context save and restore, structure members to be updated whenever
144 * corresponding registers are modified.
146 struct omap2_mcspi_regs {
153 static struct omap2_mcspi_regs omap2_mcspi_ctx[OMAP2_MCSPI_MAX_CTRL];
155 static struct workqueue_struct *omap2_mcspi_wq;
157 #define MOD_REG_BIT(val, mask, set) do { \
164 static inline void mcspi_write_reg(struct spi_master *master,
167 struct omap2_mcspi *mcspi = spi_master_get_devdata(master);
169 __raw_writel(val, mcspi->base + idx);
172 static inline u32 mcspi_read_reg(struct spi_master *master, int idx)
174 struct omap2_mcspi *mcspi = spi_master_get_devdata(master);
176 return __raw_readl(mcspi->base + idx);
179 static inline void mcspi_write_cs_reg(const struct spi_device *spi,
182 struct omap2_mcspi_cs *cs = spi->controller_state;
184 __raw_writel(val, cs->base + idx);
187 static inline u32 mcspi_read_cs_reg(const struct spi_device *spi, int idx)
189 struct omap2_mcspi_cs *cs = spi->controller_state;
191 return __raw_readl(cs->base + idx);
194 static inline u32 mcspi_cached_chconf0(const struct spi_device *spi)
196 struct omap2_mcspi_cs *cs = spi->controller_state;
201 static inline void mcspi_write_chconf0(const struct spi_device *spi, u32 val)
203 struct omap2_mcspi_cs *cs = spi->controller_state;
206 mcspi_write_cs_reg(spi, OMAP2_MCSPI_CHCONF0, val);
207 mcspi_read_cs_reg(spi, OMAP2_MCSPI_CHCONF0);
210 static void omap2_mcspi_set_dma_req(const struct spi_device *spi,
211 int is_read, int enable)
215 l = mcspi_cached_chconf0(spi);
217 if (is_read) /* 1 is read, 0 write */
218 rw = OMAP2_MCSPI_CHCONF_DMAR;
220 rw = OMAP2_MCSPI_CHCONF_DMAW;
222 MOD_REG_BIT(l, rw, enable);
223 mcspi_write_chconf0(spi, l);
226 static void omap2_mcspi_set_enable(const struct spi_device *spi, int enable)
230 l = enable ? OMAP2_MCSPI_CHCTRL_EN : 0;
231 mcspi_write_cs_reg(spi, OMAP2_MCSPI_CHCTRL0, l);
232 /* Flash post-writes */
233 mcspi_read_cs_reg(spi, OMAP2_MCSPI_CHCTRL0);
236 static void omap2_mcspi_force_cs(struct spi_device *spi, int cs_active)
240 l = mcspi_cached_chconf0(spi);
241 MOD_REG_BIT(l, OMAP2_MCSPI_CHCONF_FORCE, cs_active);
242 mcspi_write_chconf0(spi, l);
245 static void omap2_mcspi_set_master_mode(struct spi_master *master)
249 /* setup when switching from (reset default) slave mode
250 * to single-channel master mode
252 l = mcspi_read_reg(master, OMAP2_MCSPI_MODULCTRL);
253 MOD_REG_BIT(l, OMAP2_MCSPI_MODULCTRL_STEST, 0);
254 MOD_REG_BIT(l, OMAP2_MCSPI_MODULCTRL_MS, 0);
255 MOD_REG_BIT(l, OMAP2_MCSPI_MODULCTRL_SINGLE, 1);
256 mcspi_write_reg(master, OMAP2_MCSPI_MODULCTRL, l);
258 omap2_mcspi_ctx[master->bus_num - 1].modulctrl = l;
261 static void omap2_mcspi_restore_ctx(struct omap2_mcspi *mcspi)
263 struct spi_master *spi_cntrl;
264 struct omap2_mcspi_cs *cs;
265 spi_cntrl = mcspi->master;
267 /* McSPI: context restore */
268 mcspi_write_reg(spi_cntrl, OMAP2_MCSPI_MODULCTRL,
269 omap2_mcspi_ctx[spi_cntrl->bus_num - 1].modulctrl);
271 mcspi_write_reg(spi_cntrl, OMAP2_MCSPI_SYSCONFIG,
272 omap2_mcspi_ctx[spi_cntrl->bus_num - 1].sysconfig);
274 mcspi_write_reg(spi_cntrl, OMAP2_MCSPI_WAKEUPENABLE,
275 omap2_mcspi_ctx[spi_cntrl->bus_num - 1].wakeupenable);
277 list_for_each_entry(cs, &omap2_mcspi_ctx[spi_cntrl->bus_num - 1].cs,
279 __raw_writel(cs->chconf0, cs->base + OMAP2_MCSPI_CHCONF0);
281 static void omap2_mcspi_disable_clocks(struct omap2_mcspi *mcspi)
283 clk_disable(mcspi->ick);
284 clk_disable(mcspi->fck);
287 static int omap2_mcspi_enable_clocks(struct omap2_mcspi *mcspi)
289 if (clk_enable(mcspi->ick))
291 if (clk_enable(mcspi->fck))
294 omap2_mcspi_restore_ctx(mcspi);
300 omap2_mcspi_txrx_dma(struct spi_device *spi, struct spi_transfer *xfer)
302 struct omap2_mcspi *mcspi;
303 struct omap2_mcspi_cs *cs = spi->controller_state;
304 struct omap2_mcspi_dma *mcspi_dma;
305 unsigned int count, c;
306 unsigned long base, tx_reg, rx_reg;
307 int word_len, data_type, element_count;
313 mcspi = spi_master_get_devdata(spi->master);
314 mcspi_dma = &mcspi->dma_channels[spi->chip_select];
315 l = mcspi_cached_chconf0(spi);
319 word_len = cs->word_len;
322 tx_reg = base + OMAP2_MCSPI_TX0;
323 rx_reg = base + OMAP2_MCSPI_RX0;
328 data_type = OMAP_DMA_DATA_TYPE_S8;
329 element_count = count;
330 } else if (word_len <= 16) {
331 data_type = OMAP_DMA_DATA_TYPE_S16;
332 element_count = count >> 1;
333 } else /* word_len <= 32 */ {
334 data_type = OMAP_DMA_DATA_TYPE_S32;
335 element_count = count >> 2;
339 omap_set_dma_transfer_params(mcspi_dma->dma_tx_channel,
340 data_type, element_count, 1,
341 OMAP_DMA_SYNC_ELEMENT,
342 mcspi_dma->dma_tx_sync_dev, 0);
344 omap_set_dma_dest_params(mcspi_dma->dma_tx_channel, 0,
345 OMAP_DMA_AMODE_CONSTANT,
348 omap_set_dma_src_params(mcspi_dma->dma_tx_channel, 0,
349 OMAP_DMA_AMODE_POST_INC,
354 elements = element_count - 1;
355 if (l & OMAP2_MCSPI_CHCONF_TURBO)
358 omap_set_dma_transfer_params(mcspi_dma->dma_rx_channel,
359 data_type, elements, 1,
360 OMAP_DMA_SYNC_ELEMENT,
361 mcspi_dma->dma_rx_sync_dev, 1);
363 omap_set_dma_src_params(mcspi_dma->dma_rx_channel, 0,
364 OMAP_DMA_AMODE_CONSTANT,
367 omap_set_dma_dest_params(mcspi_dma->dma_rx_channel, 0,
368 OMAP_DMA_AMODE_POST_INC,
373 omap_start_dma(mcspi_dma->dma_tx_channel);
374 omap2_mcspi_set_dma_req(spi, 0, 1);
378 omap_start_dma(mcspi_dma->dma_rx_channel);
379 omap2_mcspi_set_dma_req(spi, 1, 1);
383 wait_for_completion(&mcspi_dma->dma_tx_completion);
384 dma_unmap_single(NULL, xfer->tx_dma, count, DMA_TO_DEVICE);
388 wait_for_completion(&mcspi_dma->dma_rx_completion);
389 dma_unmap_single(NULL, xfer->rx_dma, count, DMA_FROM_DEVICE);
390 omap2_mcspi_set_enable(spi, 0);
392 if (l & OMAP2_MCSPI_CHCONF_TURBO) {
394 if (likely(mcspi_read_cs_reg(spi, OMAP2_MCSPI_CHSTAT0)
395 & OMAP2_MCSPI_CHSTAT_RXS)) {
398 w = mcspi_read_cs_reg(spi, OMAP2_MCSPI_RX0);
400 ((u8 *)xfer->rx_buf)[elements++] = w;
401 else if (word_len <= 16)
402 ((u16 *)xfer->rx_buf)[elements++] = w;
403 else /* word_len <= 32 */
404 ((u32 *)xfer->rx_buf)[elements++] = w;
407 "DMA RX penultimate word empty");
408 count -= (word_len <= 8) ? 2 :
409 (word_len <= 16) ? 4 :
410 /* word_len <= 32 */ 8;
411 omap2_mcspi_set_enable(spi, 1);
416 if (likely(mcspi_read_cs_reg(spi, OMAP2_MCSPI_CHSTAT0)
417 & OMAP2_MCSPI_CHSTAT_RXS)) {
420 w = mcspi_read_cs_reg(spi, OMAP2_MCSPI_RX0);
422 ((u8 *)xfer->rx_buf)[elements] = w;
423 else if (word_len <= 16)
424 ((u16 *)xfer->rx_buf)[elements] = w;
425 else /* word_len <= 32 */
426 ((u32 *)xfer->rx_buf)[elements] = w;
428 dev_err(&spi->dev, "DMA RX last word empty");
429 count -= (word_len <= 8) ? 1 :
430 (word_len <= 16) ? 2 :
431 /* word_len <= 32 */ 4;
433 omap2_mcspi_set_enable(spi, 1);
438 static int mcspi_wait_for_reg_bit(void __iomem *reg, unsigned long bit)
440 unsigned long timeout;
442 timeout = jiffies + msecs_to_jiffies(1000);
443 while (!(__raw_readl(reg) & bit)) {
444 if (time_after(jiffies, timeout))
452 omap2_mcspi_txrx_pio(struct spi_device *spi, struct spi_transfer *xfer)
454 struct omap2_mcspi *mcspi;
455 struct omap2_mcspi_cs *cs = spi->controller_state;
456 unsigned int count, c;
458 void __iomem *base = cs->base;
459 void __iomem *tx_reg;
460 void __iomem *rx_reg;
461 void __iomem *chstat_reg;
464 mcspi = spi_master_get_devdata(spi->master);
467 word_len = cs->word_len;
469 l = mcspi_cached_chconf0(spi);
471 /* We store the pre-calculated register addresses on stack to speed
472 * up the transfer loop. */
473 tx_reg = base + OMAP2_MCSPI_TX0;
474 rx_reg = base + OMAP2_MCSPI_RX0;
475 chstat_reg = base + OMAP2_MCSPI_CHSTAT0;
487 if (mcspi_wait_for_reg_bit(chstat_reg,
488 OMAP2_MCSPI_CHSTAT_TXS) < 0) {
489 dev_err(&spi->dev, "TXS timed out\n");
492 dev_vdbg(&spi->dev, "write-%d %02x\n",
494 __raw_writel(*tx++, tx_reg);
497 if (mcspi_wait_for_reg_bit(chstat_reg,
498 OMAP2_MCSPI_CHSTAT_RXS) < 0) {
499 dev_err(&spi->dev, "RXS timed out\n");
503 if (c == 1 && tx == NULL &&
504 (l & OMAP2_MCSPI_CHCONF_TURBO)) {
505 omap2_mcspi_set_enable(spi, 0);
506 *rx++ = __raw_readl(rx_reg);
507 dev_vdbg(&spi->dev, "read-%d %02x\n",
508 word_len, *(rx - 1));
509 if (mcspi_wait_for_reg_bit(chstat_reg,
510 OMAP2_MCSPI_CHSTAT_RXS) < 0) {
516 } else if (c == 0 && tx == NULL) {
517 omap2_mcspi_set_enable(spi, 0);
520 *rx++ = __raw_readl(rx_reg);
521 dev_vdbg(&spi->dev, "read-%d %02x\n",
522 word_len, *(rx - 1));
525 } else if (word_len <= 16) {
534 if (mcspi_wait_for_reg_bit(chstat_reg,
535 OMAP2_MCSPI_CHSTAT_TXS) < 0) {
536 dev_err(&spi->dev, "TXS timed out\n");
539 dev_vdbg(&spi->dev, "write-%d %04x\n",
541 __raw_writel(*tx++, tx_reg);
544 if (mcspi_wait_for_reg_bit(chstat_reg,
545 OMAP2_MCSPI_CHSTAT_RXS) < 0) {
546 dev_err(&spi->dev, "RXS timed out\n");
550 if (c == 2 && tx == NULL &&
551 (l & OMAP2_MCSPI_CHCONF_TURBO)) {
552 omap2_mcspi_set_enable(spi, 0);
553 *rx++ = __raw_readl(rx_reg);
554 dev_vdbg(&spi->dev, "read-%d %04x\n",
555 word_len, *(rx - 1));
556 if (mcspi_wait_for_reg_bit(chstat_reg,
557 OMAP2_MCSPI_CHSTAT_RXS) < 0) {
563 } else if (c == 0 && tx == NULL) {
564 omap2_mcspi_set_enable(spi, 0);
567 *rx++ = __raw_readl(rx_reg);
568 dev_vdbg(&spi->dev, "read-%d %04x\n",
569 word_len, *(rx - 1));
572 } else if (word_len <= 32) {
581 if (mcspi_wait_for_reg_bit(chstat_reg,
582 OMAP2_MCSPI_CHSTAT_TXS) < 0) {
583 dev_err(&spi->dev, "TXS timed out\n");
586 dev_vdbg(&spi->dev, "write-%d %08x\n",
588 __raw_writel(*tx++, tx_reg);
591 if (mcspi_wait_for_reg_bit(chstat_reg,
592 OMAP2_MCSPI_CHSTAT_RXS) < 0) {
593 dev_err(&spi->dev, "RXS timed out\n");
597 if (c == 4 && tx == NULL &&
598 (l & OMAP2_MCSPI_CHCONF_TURBO)) {
599 omap2_mcspi_set_enable(spi, 0);
600 *rx++ = __raw_readl(rx_reg);
601 dev_vdbg(&spi->dev, "read-%d %08x\n",
602 word_len, *(rx - 1));
603 if (mcspi_wait_for_reg_bit(chstat_reg,
604 OMAP2_MCSPI_CHSTAT_RXS) < 0) {
610 } else if (c == 0 && tx == NULL) {
611 omap2_mcspi_set_enable(spi, 0);
614 *rx++ = __raw_readl(rx_reg);
615 dev_vdbg(&spi->dev, "read-%d %08x\n",
616 word_len, *(rx - 1));
621 /* for TX_ONLY mode, be sure all words have shifted out */
622 if (xfer->rx_buf == NULL) {
623 if (mcspi_wait_for_reg_bit(chstat_reg,
624 OMAP2_MCSPI_CHSTAT_TXS) < 0) {
625 dev_err(&spi->dev, "TXS timed out\n");
626 } else if (mcspi_wait_for_reg_bit(chstat_reg,
627 OMAP2_MCSPI_CHSTAT_EOT) < 0)
628 dev_err(&spi->dev, "EOT timed out\n");
631 omap2_mcspi_set_enable(spi, 1);
635 /* called only when no transfer is active to this device */
636 static int omap2_mcspi_setup_transfer(struct spi_device *spi,
637 struct spi_transfer *t)
639 struct omap2_mcspi_cs *cs = spi->controller_state;
640 struct omap2_mcspi *mcspi;
641 struct spi_master *spi_cntrl;
643 u8 word_len = spi->bits_per_word;
644 u32 speed_hz = spi->max_speed_hz;
646 mcspi = spi_master_get_devdata(spi->master);
647 spi_cntrl = mcspi->master;
649 if (t != NULL && t->bits_per_word)
650 word_len = t->bits_per_word;
652 cs->word_len = word_len;
654 if (t && t->speed_hz)
655 speed_hz = t->speed_hz;
658 while (div <= 15 && (OMAP2_MCSPI_MAX_FREQ / (1 << div))
664 l = mcspi_cached_chconf0(spi);
666 /* standard 4-wire master mode: SCK, MOSI/out, MISO/in, nCS
667 * REVISIT: this controller could support SPI_3WIRE mode.
669 l &= ~(OMAP2_MCSPI_CHCONF_IS|OMAP2_MCSPI_CHCONF_DPE1);
670 l |= OMAP2_MCSPI_CHCONF_DPE0;
673 l &= ~OMAP2_MCSPI_CHCONF_WL_MASK;
674 l |= (word_len - 1) << 7;
676 /* set chipselect polarity; manage with FORCE */
677 if (!(spi->mode & SPI_CS_HIGH))
678 l |= OMAP2_MCSPI_CHCONF_EPOL; /* active-low; normal */
680 l &= ~OMAP2_MCSPI_CHCONF_EPOL;
682 /* set clock divisor */
683 l &= ~OMAP2_MCSPI_CHCONF_CLKD_MASK;
686 /* set SPI mode 0..3 */
687 if (spi->mode & SPI_CPOL)
688 l |= OMAP2_MCSPI_CHCONF_POL;
690 l &= ~OMAP2_MCSPI_CHCONF_POL;
691 if (spi->mode & SPI_CPHA)
692 l |= OMAP2_MCSPI_CHCONF_PHA;
694 l &= ~OMAP2_MCSPI_CHCONF_PHA;
696 mcspi_write_chconf0(spi, l);
698 dev_dbg(&spi->dev, "setup: speed %d, sample %s edge, clk %s\n",
699 OMAP2_MCSPI_MAX_FREQ / (1 << div),
700 (spi->mode & SPI_CPHA) ? "trailing" : "leading",
701 (spi->mode & SPI_CPOL) ? "inverted" : "normal");
706 static void omap2_mcspi_dma_rx_callback(int lch, u16 ch_status, void *data)
708 struct spi_device *spi = data;
709 struct omap2_mcspi *mcspi;
710 struct omap2_mcspi_dma *mcspi_dma;
712 mcspi = spi_master_get_devdata(spi->master);
713 mcspi_dma = &(mcspi->dma_channels[spi->chip_select]);
715 complete(&mcspi_dma->dma_rx_completion);
717 /* We must disable the DMA RX request */
718 omap2_mcspi_set_dma_req(spi, 1, 0);
721 static void omap2_mcspi_dma_tx_callback(int lch, u16 ch_status, void *data)
723 struct spi_device *spi = data;
724 struct omap2_mcspi *mcspi;
725 struct omap2_mcspi_dma *mcspi_dma;
727 mcspi = spi_master_get_devdata(spi->master);
728 mcspi_dma = &(mcspi->dma_channels[spi->chip_select]);
730 complete(&mcspi_dma->dma_tx_completion);
732 /* We must disable the DMA TX request */
733 omap2_mcspi_set_dma_req(spi, 0, 0);
736 static int omap2_mcspi_request_dma(struct spi_device *spi)
738 struct spi_master *master = spi->master;
739 struct omap2_mcspi *mcspi;
740 struct omap2_mcspi_dma *mcspi_dma;
742 mcspi = spi_master_get_devdata(master);
743 mcspi_dma = mcspi->dma_channels + spi->chip_select;
745 if (omap_request_dma(mcspi_dma->dma_rx_sync_dev, "McSPI RX",
746 omap2_mcspi_dma_rx_callback, spi,
747 &mcspi_dma->dma_rx_channel)) {
748 dev_err(&spi->dev, "no RX DMA channel for McSPI\n");
752 if (omap_request_dma(mcspi_dma->dma_tx_sync_dev, "McSPI TX",
753 omap2_mcspi_dma_tx_callback, spi,
754 &mcspi_dma->dma_tx_channel)) {
755 omap_free_dma(mcspi_dma->dma_rx_channel);
756 mcspi_dma->dma_rx_channel = -1;
757 dev_err(&spi->dev, "no TX DMA channel for McSPI\n");
761 init_completion(&mcspi_dma->dma_rx_completion);
762 init_completion(&mcspi_dma->dma_tx_completion);
767 static int omap2_mcspi_setup(struct spi_device *spi)
770 struct omap2_mcspi *mcspi;
771 struct omap2_mcspi_dma *mcspi_dma;
772 struct omap2_mcspi_cs *cs = spi->controller_state;
774 if (spi->bits_per_word < 4 || spi->bits_per_word > 32) {
775 dev_dbg(&spi->dev, "setup: unsupported %d bit words\n",
780 mcspi = spi_master_get_devdata(spi->master);
781 mcspi_dma = &mcspi->dma_channels[spi->chip_select];
784 cs = kzalloc(sizeof *cs, GFP_KERNEL);
787 cs->base = mcspi->base + spi->chip_select * 0x14;
788 cs->phys = mcspi->phys + spi->chip_select * 0x14;
790 spi->controller_state = cs;
791 /* Link this to context save list */
792 list_add_tail(&cs->node,
793 &omap2_mcspi_ctx[mcspi->master->bus_num - 1].cs);
796 if (mcspi_dma->dma_rx_channel == -1
797 || mcspi_dma->dma_tx_channel == -1) {
798 ret = omap2_mcspi_request_dma(spi);
803 if (omap2_mcspi_enable_clocks(mcspi))
806 ret = omap2_mcspi_setup_transfer(spi, NULL);
807 omap2_mcspi_disable_clocks(mcspi);
812 static void omap2_mcspi_cleanup(struct spi_device *spi)
814 struct omap2_mcspi *mcspi;
815 struct omap2_mcspi_dma *mcspi_dma;
816 struct omap2_mcspi_cs *cs;
818 mcspi = spi_master_get_devdata(spi->master);
820 if (spi->controller_state) {
821 /* Unlink controller state from context save list */
822 cs = spi->controller_state;
825 kfree(spi->controller_state);
828 if (spi->chip_select < spi->master->num_chipselect) {
829 mcspi_dma = &mcspi->dma_channels[spi->chip_select];
831 if (mcspi_dma->dma_rx_channel != -1) {
832 omap_free_dma(mcspi_dma->dma_rx_channel);
833 mcspi_dma->dma_rx_channel = -1;
835 if (mcspi_dma->dma_tx_channel != -1) {
836 omap_free_dma(mcspi_dma->dma_tx_channel);
837 mcspi_dma->dma_tx_channel = -1;
842 static void omap2_mcspi_work(struct work_struct *work)
844 struct omap2_mcspi *mcspi;
846 mcspi = container_of(work, struct omap2_mcspi, work);
847 spin_lock_irq(&mcspi->lock);
849 if (omap2_mcspi_enable_clocks(mcspi))
852 /* We only enable one channel at a time -- the one whose message is
853 * at the head of the queue -- although this controller would gladly
854 * arbitrate among multiple channels. This corresponds to "single
855 * channel" master mode. As a side effect, we need to manage the
856 * chipselect with the FORCE bit ... CS != channel enable.
858 while (!list_empty(&mcspi->msg_queue)) {
859 struct spi_message *m;
860 struct spi_device *spi;
861 struct spi_transfer *t = NULL;
863 struct omap2_mcspi_cs *cs;
864 struct omap2_mcspi_device_config *cd;
865 int par_override = 0;
869 m = container_of(mcspi->msg_queue.next, struct spi_message,
872 list_del_init(&m->queue);
873 spin_unlock_irq(&mcspi->lock);
876 cs = spi->controller_state;
877 cd = spi->controller_data;
879 omap2_mcspi_set_enable(spi, 1);
880 list_for_each_entry(t, &m->transfers, transfer_list) {
881 if (t->tx_buf == NULL && t->rx_buf == NULL && t->len) {
885 if (par_override || t->speed_hz || t->bits_per_word) {
887 status = omap2_mcspi_setup_transfer(spi, t);
890 if (!t->speed_hz && !t->bits_per_word)
895 omap2_mcspi_force_cs(spi, 1);
899 chconf = mcspi_cached_chconf0(spi);
900 chconf &= ~OMAP2_MCSPI_CHCONF_TRM_MASK;
901 chconf &= ~OMAP2_MCSPI_CHCONF_TURBO;
903 if (t->tx_buf == NULL)
904 chconf |= OMAP2_MCSPI_CHCONF_TRM_RX_ONLY;
905 else if (t->rx_buf == NULL)
906 chconf |= OMAP2_MCSPI_CHCONF_TRM_TX_ONLY;
908 if (cd && cd->turbo_mode && t->tx_buf == NULL) {
909 /* Turbo mode is for more than one word */
910 if (t->len > ((cs->word_len + 7) >> 3))
911 chconf |= OMAP2_MCSPI_CHCONF_TURBO;
914 mcspi_write_chconf0(spi, chconf);
919 /* RX_ONLY mode needs dummy data in TX reg */
920 if (t->tx_buf == NULL)
921 __raw_writel(0, cs->base
924 if (m->is_dma_mapped || t->len >= DMA_MIN_BYTES)
925 count = omap2_mcspi_txrx_dma(spi, t);
927 count = omap2_mcspi_txrx_pio(spi, t);
928 m->actual_length += count;
930 if (count != t->len) {
937 udelay(t->delay_usecs);
939 /* ignore the "leave it on after last xfer" hint */
941 omap2_mcspi_force_cs(spi, 0);
946 /* Restore defaults if they were overriden */
949 status = omap2_mcspi_setup_transfer(spi, NULL);
953 omap2_mcspi_force_cs(spi, 0);
955 omap2_mcspi_set_enable(spi, 0);
958 m->complete(m->context);
960 spin_lock_irq(&mcspi->lock);
963 omap2_mcspi_disable_clocks(mcspi);
966 spin_unlock_irq(&mcspi->lock);
969 static int omap2_mcspi_transfer(struct spi_device *spi, struct spi_message *m)
971 struct omap2_mcspi *mcspi;
973 struct spi_transfer *t;
975 m->actual_length = 0;
978 /* reject invalid messages and transfers */
979 if (list_empty(&m->transfers) || !m->complete)
981 list_for_each_entry(t, &m->transfers, transfer_list) {
982 const void *tx_buf = t->tx_buf;
983 void *rx_buf = t->rx_buf;
984 unsigned len = t->len;
986 if (t->speed_hz > OMAP2_MCSPI_MAX_FREQ
987 || (len && !(rx_buf || tx_buf))
988 || (t->bits_per_word &&
989 ( t->bits_per_word < 4
990 || t->bits_per_word > 32))) {
991 dev_dbg(&spi->dev, "transfer: %d Hz, %d %s%s, %d bpw\n",
999 if (t->speed_hz && t->speed_hz < OMAP2_MCSPI_MAX_FREQ/(1<<16)) {
1000 dev_dbg(&spi->dev, "%d Hz max exceeds %d\n",
1002 OMAP2_MCSPI_MAX_FREQ/(1<<16));
1006 if (m->is_dma_mapped || len < DMA_MIN_BYTES)
1009 /* Do DMA mapping "early" for better error reporting and
1010 * dcache use. Note that if dma_unmap_single() ever starts
1011 * to do real work on ARM, we'd need to clean up mappings
1012 * for previous transfers on *ALL* exits of this loop...
1014 if (tx_buf != NULL) {
1015 t->tx_dma = dma_map_single(&spi->dev, (void *) tx_buf,
1016 len, DMA_TO_DEVICE);
1017 if (dma_mapping_error(&spi->dev, t->tx_dma)) {
1018 dev_dbg(&spi->dev, "dma %cX %d bytes error\n",
1023 if (rx_buf != NULL) {
1024 t->rx_dma = dma_map_single(&spi->dev, rx_buf, t->len,
1026 if (dma_mapping_error(&spi->dev, t->rx_dma)) {
1027 dev_dbg(&spi->dev, "dma %cX %d bytes error\n",
1030 dma_unmap_single(NULL, t->tx_dma,
1031 len, DMA_TO_DEVICE);
1037 mcspi = spi_master_get_devdata(spi->master);
1039 spin_lock_irqsave(&mcspi->lock, flags);
1040 list_add_tail(&m->queue, &mcspi->msg_queue);
1041 queue_work(omap2_mcspi_wq, &mcspi->work);
1042 spin_unlock_irqrestore(&mcspi->lock, flags);
1047 static int __init omap2_mcspi_reset(struct omap2_mcspi *mcspi)
1049 struct spi_master *master = mcspi->master;
1052 if (omap2_mcspi_enable_clocks(mcspi))
1055 mcspi_write_reg(master, OMAP2_MCSPI_SYSCONFIG,
1056 OMAP2_MCSPI_SYSCONFIG_SOFTRESET);
1058 tmp = mcspi_read_reg(master, OMAP2_MCSPI_SYSSTATUS);
1059 } while (!(tmp & OMAP2_MCSPI_SYSSTATUS_RESETDONE));
1061 tmp = OMAP2_MCSPI_SYSCONFIG_AUTOIDLE |
1062 OMAP2_MCSPI_SYSCONFIG_ENAWAKEUP |
1063 OMAP2_MCSPI_SYSCONFIG_SMARTIDLE;
1064 mcspi_write_reg(master, OMAP2_MCSPI_SYSCONFIG, tmp);
1065 omap2_mcspi_ctx[master->bus_num - 1].sysconfig = tmp;
1067 tmp = OMAP2_MCSPI_WAKEUPENABLE_WKEN;
1068 mcspi_write_reg(master, OMAP2_MCSPI_WAKEUPENABLE, tmp);
1069 omap2_mcspi_ctx[master->bus_num - 1].wakeupenable = tmp;
1071 omap2_mcspi_set_master_mode(master);
1072 omap2_mcspi_disable_clocks(mcspi);
1076 static u8 __initdata spi1_rxdma_id [] = {
1077 OMAP24XX_DMA_SPI1_RX0,
1078 OMAP24XX_DMA_SPI1_RX1,
1079 OMAP24XX_DMA_SPI1_RX2,
1080 OMAP24XX_DMA_SPI1_RX3,
1083 static u8 __initdata spi1_txdma_id [] = {
1084 OMAP24XX_DMA_SPI1_TX0,
1085 OMAP24XX_DMA_SPI1_TX1,
1086 OMAP24XX_DMA_SPI1_TX2,
1087 OMAP24XX_DMA_SPI1_TX3,
1090 static u8 __initdata spi2_rxdma_id[] = {
1091 OMAP24XX_DMA_SPI2_RX0,
1092 OMAP24XX_DMA_SPI2_RX1,
1095 static u8 __initdata spi2_txdma_id[] = {
1096 OMAP24XX_DMA_SPI2_TX0,
1097 OMAP24XX_DMA_SPI2_TX1,
1100 #if defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP3) \
1101 || defined(CONFIG_ARCH_OMAP4)
1102 static u8 __initdata spi3_rxdma_id[] = {
1103 OMAP24XX_DMA_SPI3_RX0,
1104 OMAP24XX_DMA_SPI3_RX1,
1107 static u8 __initdata spi3_txdma_id[] = {
1108 OMAP24XX_DMA_SPI3_TX0,
1109 OMAP24XX_DMA_SPI3_TX1,
1113 #if defined(CONFIG_ARCH_OMAP3) || defined(CONFIG_ARCH_OMAP4)
1114 static u8 __initdata spi4_rxdma_id[] = {
1115 OMAP34XX_DMA_SPI4_RX0,
1118 static u8 __initdata spi4_txdma_id[] = {
1119 OMAP34XX_DMA_SPI4_TX0,
1123 static int __init omap2_mcspi_probe(struct platform_device *pdev)
1125 struct spi_master *master;
1126 struct omap2_mcspi *mcspi;
1129 const u8 *rxdma_id, *txdma_id;
1130 unsigned num_chipselect;
1134 rxdma_id = spi1_rxdma_id;
1135 txdma_id = spi1_txdma_id;
1139 rxdma_id = spi2_rxdma_id;
1140 txdma_id = spi2_txdma_id;
1143 #if defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP3) \
1144 || defined(CONFIG_ARCH_OMAP4)
1146 rxdma_id = spi3_rxdma_id;
1147 txdma_id = spi3_txdma_id;
1151 #if defined(CONFIG_ARCH_OMAP3) || defined(CONFIG_ARCH_OMAP4)
1153 rxdma_id = spi4_rxdma_id;
1154 txdma_id = spi4_txdma_id;
1162 master = spi_alloc_master(&pdev->dev, sizeof *mcspi);
1163 if (master == NULL) {
1164 dev_dbg(&pdev->dev, "master allocation failed\n");
1168 /* the spi->mode bits understood by this driver: */
1169 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
1172 master->bus_num = pdev->id;
1174 master->setup = omap2_mcspi_setup;
1175 master->transfer = omap2_mcspi_transfer;
1176 master->cleanup = omap2_mcspi_cleanup;
1177 master->num_chipselect = num_chipselect;
1179 dev_set_drvdata(&pdev->dev, master);
1181 mcspi = spi_master_get_devdata(master);
1182 mcspi->master = master;
1184 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1189 if (!request_mem_region(r->start, (r->end - r->start) + 1,
1190 dev_name(&pdev->dev))) {
1195 mcspi->phys = r->start;
1196 mcspi->base = ioremap(r->start, r->end - r->start + 1);
1198 dev_dbg(&pdev->dev, "can't ioremap MCSPI\n");
1203 INIT_WORK(&mcspi->work, omap2_mcspi_work);
1205 spin_lock_init(&mcspi->lock);
1206 INIT_LIST_HEAD(&mcspi->msg_queue);
1207 INIT_LIST_HEAD(&omap2_mcspi_ctx[master->bus_num - 1].cs);
1209 mcspi->ick = clk_get(&pdev->dev, "ick");
1210 if (IS_ERR(mcspi->ick)) {
1211 dev_dbg(&pdev->dev, "can't get mcspi_ick\n");
1212 status = PTR_ERR(mcspi->ick);
1215 mcspi->fck = clk_get(&pdev->dev, "fck");
1216 if (IS_ERR(mcspi->fck)) {
1217 dev_dbg(&pdev->dev, "can't get mcspi_fck\n");
1218 status = PTR_ERR(mcspi->fck);
1222 mcspi->dma_channels = kcalloc(master->num_chipselect,
1223 sizeof(struct omap2_mcspi_dma),
1226 if (mcspi->dma_channels == NULL)
1229 for (i = 0; i < num_chipselect; i++) {
1230 mcspi->dma_channels[i].dma_rx_channel = -1;
1231 mcspi->dma_channels[i].dma_rx_sync_dev = rxdma_id[i];
1232 mcspi->dma_channels[i].dma_tx_channel = -1;
1233 mcspi->dma_channels[i].dma_tx_sync_dev = txdma_id[i];
1236 if (omap2_mcspi_reset(mcspi) < 0)
1239 status = spi_register_master(master);
1246 kfree(mcspi->dma_channels);
1248 clk_put(mcspi->fck);
1250 clk_put(mcspi->ick);
1252 iounmap(mcspi->base);
1254 release_mem_region(r->start, (r->end - r->start) + 1);
1256 spi_master_put(master);
1260 static int __exit omap2_mcspi_remove(struct platform_device *pdev)
1262 struct spi_master *master;
1263 struct omap2_mcspi *mcspi;
1264 struct omap2_mcspi_dma *dma_channels;
1268 master = dev_get_drvdata(&pdev->dev);
1269 mcspi = spi_master_get_devdata(master);
1270 dma_channels = mcspi->dma_channels;
1272 clk_put(mcspi->fck);
1273 clk_put(mcspi->ick);
1275 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1276 release_mem_region(r->start, (r->end - r->start) + 1);
1279 spi_unregister_master(master);
1281 kfree(dma_channels);
1286 /* work with hotplug and coldplug */
1287 MODULE_ALIAS("platform:omap2_mcspi");
1289 static struct platform_driver omap2_mcspi_driver = {
1291 .name = "omap2_mcspi",
1292 .owner = THIS_MODULE,
1294 .remove = __exit_p(omap2_mcspi_remove),
1298 static int __init omap2_mcspi_init(void)
1300 omap2_mcspi_wq = create_singlethread_workqueue(
1301 omap2_mcspi_driver.driver.name);
1302 if (omap2_mcspi_wq == NULL)
1304 return platform_driver_probe(&omap2_mcspi_driver, omap2_mcspi_probe);
1306 subsys_initcall(omap2_mcspi_init);
1308 static void __exit omap2_mcspi_exit(void)
1310 platform_driver_unregister(&omap2_mcspi_driver);
1312 destroy_workqueue(omap2_mcspi_wq);
1314 module_exit(omap2_mcspi_exit);
1316 MODULE_LICENSE("GPL");