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>
36 #include <linux/pm_runtime.h>
38 #include <linux/of_device.h>
40 #include <linux/spi/spi.h>
43 #include <plat/clock.h>
44 #include <plat/mcspi.h>
46 #define OMAP2_MCSPI_MAX_FREQ 48000000
47 #define SPI_AUTOSUSPEND_TIMEOUT 2000
49 #define OMAP2_MCSPI_REVISION 0x00
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_MODULCTRL_SINGLE BIT(0)
67 #define OMAP2_MCSPI_MODULCTRL_MS BIT(2)
68 #define OMAP2_MCSPI_MODULCTRL_STEST BIT(3)
70 #define OMAP2_MCSPI_CHCONF_PHA BIT(0)
71 #define OMAP2_MCSPI_CHCONF_POL BIT(1)
72 #define OMAP2_MCSPI_CHCONF_CLKD_MASK (0x0f << 2)
73 #define OMAP2_MCSPI_CHCONF_EPOL BIT(6)
74 #define OMAP2_MCSPI_CHCONF_WL_MASK (0x1f << 7)
75 #define OMAP2_MCSPI_CHCONF_TRM_RX_ONLY BIT(12)
76 #define OMAP2_MCSPI_CHCONF_TRM_TX_ONLY BIT(13)
77 #define OMAP2_MCSPI_CHCONF_TRM_MASK (0x03 << 12)
78 #define OMAP2_MCSPI_CHCONF_DMAW BIT(14)
79 #define OMAP2_MCSPI_CHCONF_DMAR BIT(15)
80 #define OMAP2_MCSPI_CHCONF_DPE0 BIT(16)
81 #define OMAP2_MCSPI_CHCONF_DPE1 BIT(17)
82 #define OMAP2_MCSPI_CHCONF_IS BIT(18)
83 #define OMAP2_MCSPI_CHCONF_TURBO BIT(19)
84 #define OMAP2_MCSPI_CHCONF_FORCE BIT(20)
86 #define OMAP2_MCSPI_CHSTAT_RXS BIT(0)
87 #define OMAP2_MCSPI_CHSTAT_TXS BIT(1)
88 #define OMAP2_MCSPI_CHSTAT_EOT BIT(2)
90 #define OMAP2_MCSPI_CHCTRL_EN BIT(0)
92 #define OMAP2_MCSPI_WAKEUPENABLE_WKEN BIT(0)
94 /* We have 2 DMA channels per CS, one for RX and one for TX */
95 struct omap2_mcspi_dma
{
102 struct completion dma_tx_completion
;
103 struct completion dma_rx_completion
;
106 /* use PIO for small transfers, avoiding DMA setup/teardown overhead and
107 * cache operations; better heuristics consider wordsize and bitrate.
109 #define DMA_MIN_BYTES 160
113 * Used for context save and restore, structure members to be updated whenever
114 * corresponding registers are modified.
116 struct omap2_mcspi_regs
{
123 struct spi_master
*master
;
124 /* Virtual base address of the controller */
127 /* SPI1 has 4 channels, while SPI2 has 2 */
128 struct omap2_mcspi_dma
*dma_channels
;
130 struct omap2_mcspi_regs ctx
;
133 struct omap2_mcspi_cs
{
137 struct list_head node
;
138 /* Context save and restore shadow register */
142 #define MOD_REG_BIT(val, mask, set) do { \
149 static inline void mcspi_write_reg(struct spi_master
*master
,
152 struct omap2_mcspi
*mcspi
= spi_master_get_devdata(master
);
154 __raw_writel(val
, mcspi
->base
+ idx
);
157 static inline u32
mcspi_read_reg(struct spi_master
*master
, int idx
)
159 struct omap2_mcspi
*mcspi
= spi_master_get_devdata(master
);
161 return __raw_readl(mcspi
->base
+ idx
);
164 static inline void mcspi_write_cs_reg(const struct spi_device
*spi
,
167 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
169 __raw_writel(val
, cs
->base
+ idx
);
172 static inline u32
mcspi_read_cs_reg(const struct spi_device
*spi
, int idx
)
174 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
176 return __raw_readl(cs
->base
+ idx
);
179 static inline u32
mcspi_cached_chconf0(const struct spi_device
*spi
)
181 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
186 static inline void mcspi_write_chconf0(const struct spi_device
*spi
, u32 val
)
188 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
191 mcspi_write_cs_reg(spi
, OMAP2_MCSPI_CHCONF0
, val
);
192 mcspi_read_cs_reg(spi
, OMAP2_MCSPI_CHCONF0
);
195 static void omap2_mcspi_set_dma_req(const struct spi_device
*spi
,
196 int is_read
, int enable
)
200 l
= mcspi_cached_chconf0(spi
);
202 if (is_read
) /* 1 is read, 0 write */
203 rw
= OMAP2_MCSPI_CHCONF_DMAR
;
205 rw
= OMAP2_MCSPI_CHCONF_DMAW
;
207 MOD_REG_BIT(l
, rw
, enable
);
208 mcspi_write_chconf0(spi
, l
);
211 static void omap2_mcspi_set_enable(const struct spi_device
*spi
, int enable
)
215 l
= enable
? OMAP2_MCSPI_CHCTRL_EN
: 0;
216 mcspi_write_cs_reg(spi
, OMAP2_MCSPI_CHCTRL0
, l
);
217 /* Flash post-writes */
218 mcspi_read_cs_reg(spi
, OMAP2_MCSPI_CHCTRL0
);
221 static void omap2_mcspi_force_cs(struct spi_device
*spi
, int cs_active
)
225 l
= mcspi_cached_chconf0(spi
);
226 MOD_REG_BIT(l
, OMAP2_MCSPI_CHCONF_FORCE
, cs_active
);
227 mcspi_write_chconf0(spi
, l
);
230 static void omap2_mcspi_set_master_mode(struct spi_master
*master
)
232 struct omap2_mcspi
*mcspi
= spi_master_get_devdata(master
);
233 struct omap2_mcspi_regs
*ctx
= &mcspi
->ctx
;
237 * Setup when switching from (reset default) slave mode
238 * to single-channel master mode
240 l
= mcspi_read_reg(master
, OMAP2_MCSPI_MODULCTRL
);
241 MOD_REG_BIT(l
, OMAP2_MCSPI_MODULCTRL_STEST
, 0);
242 MOD_REG_BIT(l
, OMAP2_MCSPI_MODULCTRL_MS
, 0);
243 MOD_REG_BIT(l
, OMAP2_MCSPI_MODULCTRL_SINGLE
, 1);
244 mcspi_write_reg(master
, OMAP2_MCSPI_MODULCTRL
, l
);
249 static void omap2_mcspi_restore_ctx(struct omap2_mcspi
*mcspi
)
251 struct spi_master
*spi_cntrl
= mcspi
->master
;
252 struct omap2_mcspi_regs
*ctx
= &mcspi
->ctx
;
253 struct omap2_mcspi_cs
*cs
;
255 /* McSPI: context restore */
256 mcspi_write_reg(spi_cntrl
, OMAP2_MCSPI_MODULCTRL
, ctx
->modulctrl
);
257 mcspi_write_reg(spi_cntrl
, OMAP2_MCSPI_WAKEUPENABLE
, ctx
->wakeupenable
);
259 list_for_each_entry(cs
, &ctx
->cs
, node
)
260 __raw_writel(cs
->chconf0
, cs
->base
+ OMAP2_MCSPI_CHCONF0
);
262 static void omap2_mcspi_disable_clocks(struct omap2_mcspi
*mcspi
)
264 pm_runtime_mark_last_busy(mcspi
->dev
);
265 pm_runtime_put_autosuspend(mcspi
->dev
);
268 static int omap2_mcspi_enable_clocks(struct omap2_mcspi
*mcspi
)
270 return pm_runtime_get_sync(mcspi
->dev
);
273 static int omap2_prepare_transfer(struct spi_master
*master
)
275 struct omap2_mcspi
*mcspi
= spi_master_get_devdata(master
);
277 pm_runtime_get_sync(mcspi
->dev
);
281 static int omap2_unprepare_transfer(struct spi_master
*master
)
283 struct omap2_mcspi
*mcspi
= spi_master_get_devdata(master
);
285 pm_runtime_mark_last_busy(mcspi
->dev
);
286 pm_runtime_put_autosuspend(mcspi
->dev
);
290 static int mcspi_wait_for_reg_bit(void __iomem
*reg
, unsigned long bit
)
292 unsigned long timeout
;
294 timeout
= jiffies
+ msecs_to_jiffies(1000);
295 while (!(__raw_readl(reg
) & bit
)) {
296 if (time_after(jiffies
, timeout
))
304 omap2_mcspi_txrx_dma(struct spi_device
*spi
, struct spi_transfer
*xfer
)
306 struct omap2_mcspi
*mcspi
;
307 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
308 struct omap2_mcspi_dma
*mcspi_dma
;
309 unsigned int count
, c
;
310 unsigned long base
, tx_reg
, rx_reg
;
311 int word_len
, data_type
, element_count
;
316 void __iomem
*chstat_reg
;
318 mcspi
= spi_master_get_devdata(spi
->master
);
319 mcspi_dma
= &mcspi
->dma_channels
[spi
->chip_select
];
320 l
= mcspi_cached_chconf0(spi
);
322 chstat_reg
= cs
->base
+ OMAP2_MCSPI_CHSTAT0
;
326 word_len
= cs
->word_len
;
329 tx_reg
= base
+ OMAP2_MCSPI_TX0
;
330 rx_reg
= base
+ OMAP2_MCSPI_RX0
;
335 data_type
= OMAP_DMA_DATA_TYPE_S8
;
336 element_count
= count
;
337 } else if (word_len
<= 16) {
338 data_type
= OMAP_DMA_DATA_TYPE_S16
;
339 element_count
= count
>> 1;
340 } else /* word_len <= 32 */ {
341 data_type
= OMAP_DMA_DATA_TYPE_S32
;
342 element_count
= count
>> 2;
346 omap_set_dma_transfer_params(mcspi_dma
->dma_tx_channel
,
347 data_type
, element_count
, 1,
348 OMAP_DMA_SYNC_ELEMENT
,
349 mcspi_dma
->dma_tx_sync_dev
, 0);
351 omap_set_dma_dest_params(mcspi_dma
->dma_tx_channel
, 0,
352 OMAP_DMA_AMODE_CONSTANT
,
355 omap_set_dma_src_params(mcspi_dma
->dma_tx_channel
, 0,
356 OMAP_DMA_AMODE_POST_INC
,
361 elements
= element_count
- 1;
362 if (l
& OMAP2_MCSPI_CHCONF_TURBO
)
365 omap_set_dma_transfer_params(mcspi_dma
->dma_rx_channel
,
366 data_type
, elements
, 1,
367 OMAP_DMA_SYNC_ELEMENT
,
368 mcspi_dma
->dma_rx_sync_dev
, 1);
370 omap_set_dma_src_params(mcspi_dma
->dma_rx_channel
, 0,
371 OMAP_DMA_AMODE_CONSTANT
,
374 omap_set_dma_dest_params(mcspi_dma
->dma_rx_channel
, 0,
375 OMAP_DMA_AMODE_POST_INC
,
380 omap_start_dma(mcspi_dma
->dma_tx_channel
);
381 omap2_mcspi_set_dma_req(spi
, 0, 1);
385 omap_start_dma(mcspi_dma
->dma_rx_channel
);
386 omap2_mcspi_set_dma_req(spi
, 1, 1);
390 wait_for_completion(&mcspi_dma
->dma_tx_completion
);
391 dma_unmap_single(&spi
->dev
, xfer
->tx_dma
, count
, DMA_TO_DEVICE
);
393 /* for TX_ONLY mode, be sure all words have shifted out */
395 if (mcspi_wait_for_reg_bit(chstat_reg
,
396 OMAP2_MCSPI_CHSTAT_TXS
) < 0)
397 dev_err(&spi
->dev
, "TXS timed out\n");
398 else if (mcspi_wait_for_reg_bit(chstat_reg
,
399 OMAP2_MCSPI_CHSTAT_EOT
) < 0)
400 dev_err(&spi
->dev
, "EOT timed out\n");
405 wait_for_completion(&mcspi_dma
->dma_rx_completion
);
406 dma_unmap_single(&spi
->dev
, xfer
->rx_dma
, count
, DMA_FROM_DEVICE
);
407 omap2_mcspi_set_enable(spi
, 0);
409 if (l
& OMAP2_MCSPI_CHCONF_TURBO
) {
411 if (likely(mcspi_read_cs_reg(spi
, OMAP2_MCSPI_CHSTAT0
)
412 & OMAP2_MCSPI_CHSTAT_RXS
)) {
415 w
= mcspi_read_cs_reg(spi
, OMAP2_MCSPI_RX0
);
417 ((u8
*)xfer
->rx_buf
)[elements
++] = w
;
418 else if (word_len
<= 16)
419 ((u16
*)xfer
->rx_buf
)[elements
++] = w
;
420 else /* word_len <= 32 */
421 ((u32
*)xfer
->rx_buf
)[elements
++] = w
;
424 "DMA RX penultimate word empty");
425 count
-= (word_len
<= 8) ? 2 :
426 (word_len
<= 16) ? 4 :
427 /* word_len <= 32 */ 8;
428 omap2_mcspi_set_enable(spi
, 1);
433 if (likely(mcspi_read_cs_reg(spi
, OMAP2_MCSPI_CHSTAT0
)
434 & OMAP2_MCSPI_CHSTAT_RXS
)) {
437 w
= mcspi_read_cs_reg(spi
, OMAP2_MCSPI_RX0
);
439 ((u8
*)xfer
->rx_buf
)[elements
] = w
;
440 else if (word_len
<= 16)
441 ((u16
*)xfer
->rx_buf
)[elements
] = w
;
442 else /* word_len <= 32 */
443 ((u32
*)xfer
->rx_buf
)[elements
] = w
;
445 dev_err(&spi
->dev
, "DMA RX last word empty");
446 count
-= (word_len
<= 8) ? 1 :
447 (word_len
<= 16) ? 2 :
448 /* word_len <= 32 */ 4;
450 omap2_mcspi_set_enable(spi
, 1);
456 omap2_mcspi_txrx_pio(struct spi_device
*spi
, struct spi_transfer
*xfer
)
458 struct omap2_mcspi
*mcspi
;
459 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
460 unsigned int count
, c
;
462 void __iomem
*base
= cs
->base
;
463 void __iomem
*tx_reg
;
464 void __iomem
*rx_reg
;
465 void __iomem
*chstat_reg
;
468 mcspi
= spi_master_get_devdata(spi
->master
);
471 word_len
= cs
->word_len
;
473 l
= mcspi_cached_chconf0(spi
);
475 /* We store the pre-calculated register addresses on stack to speed
476 * up the transfer loop. */
477 tx_reg
= base
+ OMAP2_MCSPI_TX0
;
478 rx_reg
= base
+ OMAP2_MCSPI_RX0
;
479 chstat_reg
= base
+ OMAP2_MCSPI_CHSTAT0
;
481 if (c
< (word_len
>>3))
494 if (mcspi_wait_for_reg_bit(chstat_reg
,
495 OMAP2_MCSPI_CHSTAT_TXS
) < 0) {
496 dev_err(&spi
->dev
, "TXS timed out\n");
499 dev_vdbg(&spi
->dev
, "write-%d %02x\n",
501 __raw_writel(*tx
++, tx_reg
);
504 if (mcspi_wait_for_reg_bit(chstat_reg
,
505 OMAP2_MCSPI_CHSTAT_RXS
) < 0) {
506 dev_err(&spi
->dev
, "RXS timed out\n");
510 if (c
== 1 && tx
== NULL
&&
511 (l
& OMAP2_MCSPI_CHCONF_TURBO
)) {
512 omap2_mcspi_set_enable(spi
, 0);
513 *rx
++ = __raw_readl(rx_reg
);
514 dev_vdbg(&spi
->dev
, "read-%d %02x\n",
515 word_len
, *(rx
- 1));
516 if (mcspi_wait_for_reg_bit(chstat_reg
,
517 OMAP2_MCSPI_CHSTAT_RXS
) < 0) {
523 } else if (c
== 0 && tx
== NULL
) {
524 omap2_mcspi_set_enable(spi
, 0);
527 *rx
++ = __raw_readl(rx_reg
);
528 dev_vdbg(&spi
->dev
, "read-%d %02x\n",
529 word_len
, *(rx
- 1));
532 } else if (word_len
<= 16) {
541 if (mcspi_wait_for_reg_bit(chstat_reg
,
542 OMAP2_MCSPI_CHSTAT_TXS
) < 0) {
543 dev_err(&spi
->dev
, "TXS timed out\n");
546 dev_vdbg(&spi
->dev
, "write-%d %04x\n",
548 __raw_writel(*tx
++, tx_reg
);
551 if (mcspi_wait_for_reg_bit(chstat_reg
,
552 OMAP2_MCSPI_CHSTAT_RXS
) < 0) {
553 dev_err(&spi
->dev
, "RXS timed out\n");
557 if (c
== 2 && tx
== NULL
&&
558 (l
& OMAP2_MCSPI_CHCONF_TURBO
)) {
559 omap2_mcspi_set_enable(spi
, 0);
560 *rx
++ = __raw_readl(rx_reg
);
561 dev_vdbg(&spi
->dev
, "read-%d %04x\n",
562 word_len
, *(rx
- 1));
563 if (mcspi_wait_for_reg_bit(chstat_reg
,
564 OMAP2_MCSPI_CHSTAT_RXS
) < 0) {
570 } else if (c
== 0 && tx
== NULL
) {
571 omap2_mcspi_set_enable(spi
, 0);
574 *rx
++ = __raw_readl(rx_reg
);
575 dev_vdbg(&spi
->dev
, "read-%d %04x\n",
576 word_len
, *(rx
- 1));
579 } else if (word_len
<= 32) {
588 if (mcspi_wait_for_reg_bit(chstat_reg
,
589 OMAP2_MCSPI_CHSTAT_TXS
) < 0) {
590 dev_err(&spi
->dev
, "TXS timed out\n");
593 dev_vdbg(&spi
->dev
, "write-%d %08x\n",
595 __raw_writel(*tx
++, tx_reg
);
598 if (mcspi_wait_for_reg_bit(chstat_reg
,
599 OMAP2_MCSPI_CHSTAT_RXS
) < 0) {
600 dev_err(&spi
->dev
, "RXS timed out\n");
604 if (c
== 4 && tx
== NULL
&&
605 (l
& OMAP2_MCSPI_CHCONF_TURBO
)) {
606 omap2_mcspi_set_enable(spi
, 0);
607 *rx
++ = __raw_readl(rx_reg
);
608 dev_vdbg(&spi
->dev
, "read-%d %08x\n",
609 word_len
, *(rx
- 1));
610 if (mcspi_wait_for_reg_bit(chstat_reg
,
611 OMAP2_MCSPI_CHSTAT_RXS
) < 0) {
617 } else if (c
== 0 && tx
== NULL
) {
618 omap2_mcspi_set_enable(spi
, 0);
621 *rx
++ = __raw_readl(rx_reg
);
622 dev_vdbg(&spi
->dev
, "read-%d %08x\n",
623 word_len
, *(rx
- 1));
628 /* for TX_ONLY mode, be sure all words have shifted out */
629 if (xfer
->rx_buf
== NULL
) {
630 if (mcspi_wait_for_reg_bit(chstat_reg
,
631 OMAP2_MCSPI_CHSTAT_TXS
) < 0) {
632 dev_err(&spi
->dev
, "TXS timed out\n");
633 } else if (mcspi_wait_for_reg_bit(chstat_reg
,
634 OMAP2_MCSPI_CHSTAT_EOT
) < 0)
635 dev_err(&spi
->dev
, "EOT timed out\n");
637 /* disable chan to purge rx datas received in TX_ONLY transfer,
638 * otherwise these rx datas will affect the direct following
641 omap2_mcspi_set_enable(spi
, 0);
644 omap2_mcspi_set_enable(spi
, 1);
648 static u32
omap2_mcspi_calc_divisor(u32 speed_hz
)
652 for (div
= 0; div
< 15; div
++)
653 if (speed_hz
>= (OMAP2_MCSPI_MAX_FREQ
>> div
))
659 /* called only when no transfer is active to this device */
660 static int omap2_mcspi_setup_transfer(struct spi_device
*spi
,
661 struct spi_transfer
*t
)
663 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
664 struct omap2_mcspi
*mcspi
;
665 struct spi_master
*spi_cntrl
;
667 u8 word_len
= spi
->bits_per_word
;
668 u32 speed_hz
= spi
->max_speed_hz
;
670 mcspi
= spi_master_get_devdata(spi
->master
);
671 spi_cntrl
= mcspi
->master
;
673 if (t
!= NULL
&& t
->bits_per_word
)
674 word_len
= t
->bits_per_word
;
676 cs
->word_len
= word_len
;
678 if (t
&& t
->speed_hz
)
679 speed_hz
= t
->speed_hz
;
681 speed_hz
= min_t(u32
, speed_hz
, OMAP2_MCSPI_MAX_FREQ
);
682 div
= omap2_mcspi_calc_divisor(speed_hz
);
684 l
= mcspi_cached_chconf0(spi
);
686 /* standard 4-wire master mode: SCK, MOSI/out, MISO/in, nCS
687 * REVISIT: this controller could support SPI_3WIRE mode.
689 l
&= ~(OMAP2_MCSPI_CHCONF_IS
|OMAP2_MCSPI_CHCONF_DPE1
);
690 l
|= OMAP2_MCSPI_CHCONF_DPE0
;
693 l
&= ~OMAP2_MCSPI_CHCONF_WL_MASK
;
694 l
|= (word_len
- 1) << 7;
696 /* set chipselect polarity; manage with FORCE */
697 if (!(spi
->mode
& SPI_CS_HIGH
))
698 l
|= OMAP2_MCSPI_CHCONF_EPOL
; /* active-low; normal */
700 l
&= ~OMAP2_MCSPI_CHCONF_EPOL
;
702 /* set clock divisor */
703 l
&= ~OMAP2_MCSPI_CHCONF_CLKD_MASK
;
706 /* set SPI mode 0..3 */
707 if (spi
->mode
& SPI_CPOL
)
708 l
|= OMAP2_MCSPI_CHCONF_POL
;
710 l
&= ~OMAP2_MCSPI_CHCONF_POL
;
711 if (spi
->mode
& SPI_CPHA
)
712 l
|= OMAP2_MCSPI_CHCONF_PHA
;
714 l
&= ~OMAP2_MCSPI_CHCONF_PHA
;
716 mcspi_write_chconf0(spi
, l
);
718 dev_dbg(&spi
->dev
, "setup: speed %d, sample %s edge, clk %s\n",
719 OMAP2_MCSPI_MAX_FREQ
>> div
,
720 (spi
->mode
& SPI_CPHA
) ? "trailing" : "leading",
721 (spi
->mode
& SPI_CPOL
) ? "inverted" : "normal");
726 static void omap2_mcspi_dma_rx_callback(int lch
, u16 ch_status
, void *data
)
728 struct spi_device
*spi
= data
;
729 struct omap2_mcspi
*mcspi
;
730 struct omap2_mcspi_dma
*mcspi_dma
;
732 mcspi
= spi_master_get_devdata(spi
->master
);
733 mcspi_dma
= &(mcspi
->dma_channels
[spi
->chip_select
]);
735 complete(&mcspi_dma
->dma_rx_completion
);
737 /* We must disable the DMA RX request */
738 omap2_mcspi_set_dma_req(spi
, 1, 0);
741 static void omap2_mcspi_dma_tx_callback(int lch
, u16 ch_status
, void *data
)
743 struct spi_device
*spi
= data
;
744 struct omap2_mcspi
*mcspi
;
745 struct omap2_mcspi_dma
*mcspi_dma
;
747 mcspi
= spi_master_get_devdata(spi
->master
);
748 mcspi_dma
= &(mcspi
->dma_channels
[spi
->chip_select
]);
750 complete(&mcspi_dma
->dma_tx_completion
);
752 /* We must disable the DMA TX request */
753 omap2_mcspi_set_dma_req(spi
, 0, 0);
756 static int omap2_mcspi_request_dma(struct spi_device
*spi
)
758 struct spi_master
*master
= spi
->master
;
759 struct omap2_mcspi
*mcspi
;
760 struct omap2_mcspi_dma
*mcspi_dma
;
762 mcspi
= spi_master_get_devdata(master
);
763 mcspi_dma
= mcspi
->dma_channels
+ spi
->chip_select
;
765 if (omap_request_dma(mcspi_dma
->dma_rx_sync_dev
, "McSPI RX",
766 omap2_mcspi_dma_rx_callback
, spi
,
767 &mcspi_dma
->dma_rx_channel
)) {
768 dev_err(&spi
->dev
, "no RX DMA channel for McSPI\n");
772 if (omap_request_dma(mcspi_dma
->dma_tx_sync_dev
, "McSPI TX",
773 omap2_mcspi_dma_tx_callback
, spi
,
774 &mcspi_dma
->dma_tx_channel
)) {
775 omap_free_dma(mcspi_dma
->dma_rx_channel
);
776 mcspi_dma
->dma_rx_channel
= -1;
777 dev_err(&spi
->dev
, "no TX DMA channel for McSPI\n");
781 init_completion(&mcspi_dma
->dma_rx_completion
);
782 init_completion(&mcspi_dma
->dma_tx_completion
);
787 static int omap2_mcspi_setup(struct spi_device
*spi
)
790 struct omap2_mcspi
*mcspi
= spi_master_get_devdata(spi
->master
);
791 struct omap2_mcspi_regs
*ctx
= &mcspi
->ctx
;
792 struct omap2_mcspi_dma
*mcspi_dma
;
793 struct omap2_mcspi_cs
*cs
= spi
->controller_state
;
795 if (spi
->bits_per_word
< 4 || spi
->bits_per_word
> 32) {
796 dev_dbg(&spi
->dev
, "setup: unsupported %d bit words\n",
801 mcspi_dma
= &mcspi
->dma_channels
[spi
->chip_select
];
804 cs
= devm_kzalloc(&spi
->dev
, sizeof *cs
, GFP_KERNEL
);
807 cs
->base
= mcspi
->base
+ spi
->chip_select
* 0x14;
808 cs
->phys
= mcspi
->phys
+ spi
->chip_select
* 0x14;
810 spi
->controller_state
= cs
;
811 /* Link this to context save list */
812 list_add_tail(&cs
->node
, &ctx
->cs
);
815 if (mcspi_dma
->dma_rx_channel
== -1
816 || mcspi_dma
->dma_tx_channel
== -1) {
817 ret
= omap2_mcspi_request_dma(spi
);
822 ret
= omap2_mcspi_enable_clocks(mcspi
);
826 ret
= omap2_mcspi_setup_transfer(spi
, NULL
);
827 omap2_mcspi_disable_clocks(mcspi
);
832 static void omap2_mcspi_cleanup(struct spi_device
*spi
)
834 struct omap2_mcspi
*mcspi
;
835 struct omap2_mcspi_dma
*mcspi_dma
;
836 struct omap2_mcspi_cs
*cs
;
838 mcspi
= spi_master_get_devdata(spi
->master
);
840 if (spi
->controller_state
) {
841 /* Unlink controller state from context save list */
842 cs
= spi
->controller_state
;
847 if (spi
->chip_select
< spi
->master
->num_chipselect
) {
848 mcspi_dma
= &mcspi
->dma_channels
[spi
->chip_select
];
850 if (mcspi_dma
->dma_rx_channel
!= -1) {
851 omap_free_dma(mcspi_dma
->dma_rx_channel
);
852 mcspi_dma
->dma_rx_channel
= -1;
854 if (mcspi_dma
->dma_tx_channel
!= -1) {
855 omap_free_dma(mcspi_dma
->dma_tx_channel
);
856 mcspi_dma
->dma_tx_channel
= -1;
861 static void omap2_mcspi_work(struct omap2_mcspi
*mcspi
, struct spi_message
*m
)
864 /* We only enable one channel at a time -- the one whose message is
865 * -- although this controller would gladly
866 * arbitrate among multiple channels. This corresponds to "single
867 * channel" master mode. As a side effect, we need to manage the
868 * chipselect with the FORCE bit ... CS != channel enable.
871 struct spi_device
*spi
;
872 struct spi_transfer
*t
= NULL
;
874 struct omap2_mcspi_cs
*cs
;
875 struct omap2_mcspi_device_config
*cd
;
876 int par_override
= 0;
881 cs
= spi
->controller_state
;
882 cd
= spi
->controller_data
;
884 omap2_mcspi_set_enable(spi
, 1);
885 list_for_each_entry(t
, &m
->transfers
, transfer_list
) {
886 if (t
->tx_buf
== NULL
&& t
->rx_buf
== NULL
&& t
->len
) {
890 if (par_override
|| t
->speed_hz
|| t
->bits_per_word
) {
892 status
= omap2_mcspi_setup_transfer(spi
, t
);
895 if (!t
->speed_hz
&& !t
->bits_per_word
)
900 omap2_mcspi_force_cs(spi
, 1);
904 chconf
= mcspi_cached_chconf0(spi
);
905 chconf
&= ~OMAP2_MCSPI_CHCONF_TRM_MASK
;
906 chconf
&= ~OMAP2_MCSPI_CHCONF_TURBO
;
908 if (t
->tx_buf
== NULL
)
909 chconf
|= OMAP2_MCSPI_CHCONF_TRM_RX_ONLY
;
910 else if (t
->rx_buf
== NULL
)
911 chconf
|= OMAP2_MCSPI_CHCONF_TRM_TX_ONLY
;
913 if (cd
&& cd
->turbo_mode
&& t
->tx_buf
== NULL
) {
914 /* Turbo mode is for more than one word */
915 if (t
->len
> ((cs
->word_len
+ 7) >> 3))
916 chconf
|= OMAP2_MCSPI_CHCONF_TURBO
;
919 mcspi_write_chconf0(spi
, chconf
);
924 /* RX_ONLY mode needs dummy data in TX reg */
925 if (t
->tx_buf
== NULL
)
926 __raw_writel(0, cs
->base
929 if (m
->is_dma_mapped
|| t
->len
>= DMA_MIN_BYTES
)
930 count
= omap2_mcspi_txrx_dma(spi
, t
);
932 count
= omap2_mcspi_txrx_pio(spi
, t
);
933 m
->actual_length
+= count
;
935 if (count
!= t
->len
) {
942 udelay(t
->delay_usecs
);
944 /* ignore the "leave it on after last xfer" hint */
946 omap2_mcspi_force_cs(spi
, 0);
950 /* Restore defaults if they were overriden */
953 status
= omap2_mcspi_setup_transfer(spi
, NULL
);
957 omap2_mcspi_force_cs(spi
, 0);
959 omap2_mcspi_set_enable(spi
, 0);
965 static int omap2_mcspi_transfer_one_message(struct spi_master
*master
,
966 struct spi_message
*m
)
968 struct omap2_mcspi
*mcspi
;
969 struct spi_transfer
*t
;
971 mcspi
= spi_master_get_devdata(master
);
972 m
->actual_length
= 0;
975 /* reject invalid messages and transfers */
976 if (list_empty(&m
->transfers
))
978 list_for_each_entry(t
, &m
->transfers
, transfer_list
) {
979 const void *tx_buf
= t
->tx_buf
;
980 void *rx_buf
= t
->rx_buf
;
981 unsigned len
= t
->len
;
983 if (t
->speed_hz
> OMAP2_MCSPI_MAX_FREQ
984 || (len
&& !(rx_buf
|| tx_buf
))
985 || (t
->bits_per_word
&&
986 ( t
->bits_per_word
< 4
987 || t
->bits_per_word
> 32))) {
988 dev_dbg(mcspi
->dev
, "transfer: %d Hz, %d %s%s, %d bpw\n",
996 if (t
->speed_hz
&& t
->speed_hz
< (OMAP2_MCSPI_MAX_FREQ
>> 15)) {
997 dev_dbg(mcspi
->dev
, "speed_hz %d below minimum %d Hz\n",
999 OMAP2_MCSPI_MAX_FREQ
>> 15);
1003 if (m
->is_dma_mapped
|| len
< DMA_MIN_BYTES
)
1006 if (tx_buf
!= NULL
) {
1007 t
->tx_dma
= dma_map_single(mcspi
->dev
, (void *) tx_buf
,
1008 len
, DMA_TO_DEVICE
);
1009 if (dma_mapping_error(mcspi
->dev
, t
->tx_dma
)) {
1010 dev_dbg(mcspi
->dev
, "dma %cX %d bytes error\n",
1015 if (rx_buf
!= NULL
) {
1016 t
->rx_dma
= dma_map_single(mcspi
->dev
, rx_buf
, t
->len
,
1018 if (dma_mapping_error(mcspi
->dev
, t
->rx_dma
)) {
1019 dev_dbg(mcspi
->dev
, "dma %cX %d bytes error\n",
1022 dma_unmap_single(mcspi
->dev
, t
->tx_dma
,
1023 len
, DMA_TO_DEVICE
);
1029 omap2_mcspi_work(mcspi
, m
);
1030 spi_finalize_current_message(master
);
1034 static int __init
omap2_mcspi_master_setup(struct omap2_mcspi
*mcspi
)
1036 struct spi_master
*master
= mcspi
->master
;
1037 struct omap2_mcspi_regs
*ctx
= &mcspi
->ctx
;
1040 ret
= omap2_mcspi_enable_clocks(mcspi
);
1044 mcspi_write_reg(master
, OMAP2_MCSPI_WAKEUPENABLE
,
1045 OMAP2_MCSPI_WAKEUPENABLE_WKEN
);
1046 ctx
->wakeupenable
= OMAP2_MCSPI_WAKEUPENABLE_WKEN
;
1048 omap2_mcspi_set_master_mode(master
);
1049 omap2_mcspi_disable_clocks(mcspi
);
1053 static int omap_mcspi_runtime_resume(struct device
*dev
)
1055 struct omap2_mcspi
*mcspi
;
1056 struct spi_master
*master
;
1058 master
= dev_get_drvdata(dev
);
1059 mcspi
= spi_master_get_devdata(master
);
1060 omap2_mcspi_restore_ctx(mcspi
);
1065 static struct omap2_mcspi_platform_config omap2_pdata
= {
1069 static struct omap2_mcspi_platform_config omap4_pdata
= {
1070 .regs_offset
= OMAP4_MCSPI_REG_OFFSET
,
1073 static const struct of_device_id omap_mcspi_of_match
[] = {
1075 .compatible
= "ti,omap2-mcspi",
1076 .data
= &omap2_pdata
,
1079 .compatible
= "ti,omap4-mcspi",
1080 .data
= &omap4_pdata
,
1084 MODULE_DEVICE_TABLE(of
, omap_mcspi_of_match
);
1086 static int __devinit
omap2_mcspi_probe(struct platform_device
*pdev
)
1088 struct spi_master
*master
;
1089 struct omap2_mcspi_platform_config
*pdata
;
1090 struct omap2_mcspi
*mcspi
;
1093 u32 regs_offset
= 0;
1094 static int bus_num
= 1;
1095 struct device_node
*node
= pdev
->dev
.of_node
;
1096 const struct of_device_id
*match
;
1098 master
= spi_alloc_master(&pdev
->dev
, sizeof *mcspi
);
1099 if (master
== NULL
) {
1100 dev_dbg(&pdev
->dev
, "master allocation failed\n");
1104 /* the spi->mode bits understood by this driver: */
1105 master
->mode_bits
= SPI_CPOL
| SPI_CPHA
| SPI_CS_HIGH
;
1107 master
->setup
= omap2_mcspi_setup
;
1108 master
->prepare_transfer_hardware
= omap2_prepare_transfer
;
1109 master
->unprepare_transfer_hardware
= omap2_unprepare_transfer
;
1110 master
->transfer_one_message
= omap2_mcspi_transfer_one_message
;
1111 master
->cleanup
= omap2_mcspi_cleanup
;
1112 master
->dev
.of_node
= node
;
1114 match
= of_match_device(omap_mcspi_of_match
, &pdev
->dev
);
1116 u32 num_cs
= 1; /* default number of chipselect */
1117 pdata
= match
->data
;
1119 of_property_read_u32(node
, "ti,spi-num-cs", &num_cs
);
1120 master
->num_chipselect
= num_cs
;
1121 master
->bus_num
= bus_num
++;
1123 pdata
= pdev
->dev
.platform_data
;
1124 master
->num_chipselect
= pdata
->num_cs
;
1126 master
->bus_num
= pdev
->id
;
1128 regs_offset
= pdata
->regs_offset
;
1130 dev_set_drvdata(&pdev
->dev
, master
);
1132 mcspi
= spi_master_get_devdata(master
);
1133 mcspi
->master
= master
;
1135 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1141 r
->start
+= regs_offset
;
1142 r
->end
+= regs_offset
;
1143 mcspi
->phys
= r
->start
;
1145 mcspi
->base
= devm_request_and_ioremap(&pdev
->dev
, r
);
1147 dev_dbg(&pdev
->dev
, "can't ioremap MCSPI\n");
1152 mcspi
->dev
= &pdev
->dev
;
1154 INIT_LIST_HEAD(&mcspi
->ctx
.cs
);
1156 mcspi
->dma_channels
= kcalloc(master
->num_chipselect
,
1157 sizeof(struct omap2_mcspi_dma
),
1160 if (mcspi
->dma_channels
== NULL
)
1163 for (i
= 0; i
< master
->num_chipselect
; i
++) {
1164 char dma_ch_name
[14];
1165 struct resource
*dma_res
;
1167 sprintf(dma_ch_name
, "rx%d", i
);
1168 dma_res
= platform_get_resource_byname(pdev
, IORESOURCE_DMA
,
1171 dev_dbg(&pdev
->dev
, "cannot get DMA RX channel\n");
1176 mcspi
->dma_channels
[i
].dma_rx_channel
= -1;
1177 mcspi
->dma_channels
[i
].dma_rx_sync_dev
= dma_res
->start
;
1178 sprintf(dma_ch_name
, "tx%d", i
);
1179 dma_res
= platform_get_resource_byname(pdev
, IORESOURCE_DMA
,
1182 dev_dbg(&pdev
->dev
, "cannot get DMA TX channel\n");
1187 mcspi
->dma_channels
[i
].dma_tx_channel
= -1;
1188 mcspi
->dma_channels
[i
].dma_tx_sync_dev
= dma_res
->start
;
1194 pm_runtime_use_autosuspend(&pdev
->dev
);
1195 pm_runtime_set_autosuspend_delay(&pdev
->dev
, SPI_AUTOSUSPEND_TIMEOUT
);
1196 pm_runtime_enable(&pdev
->dev
);
1198 if (status
|| omap2_mcspi_master_setup(mcspi
) < 0)
1201 status
= spi_register_master(master
);
1203 goto err_spi_register
;
1208 spi_master_put(master
);
1210 pm_runtime_disable(&pdev
->dev
);
1212 kfree(mcspi
->dma_channels
);
1215 platform_set_drvdata(pdev
, NULL
);
1219 static int __devexit
omap2_mcspi_remove(struct platform_device
*pdev
)
1221 struct spi_master
*master
;
1222 struct omap2_mcspi
*mcspi
;
1223 struct omap2_mcspi_dma
*dma_channels
;
1225 master
= dev_get_drvdata(&pdev
->dev
);
1226 mcspi
= spi_master_get_devdata(master
);
1227 dma_channels
= mcspi
->dma_channels
;
1229 omap2_mcspi_disable_clocks(mcspi
);
1230 pm_runtime_disable(&pdev
->dev
);
1232 spi_unregister_master(master
);
1233 kfree(dma_channels
);
1234 platform_set_drvdata(pdev
, NULL
);
1239 /* work with hotplug and coldplug */
1240 MODULE_ALIAS("platform:omap2_mcspi");
1242 #ifdef CONFIG_SUSPEND
1244 * When SPI wake up from off-mode, CS is in activate state. If it was in
1245 * unactive state when driver was suspend, then force it to unactive state at
1248 static int omap2_mcspi_resume(struct device
*dev
)
1250 struct spi_master
*master
= dev_get_drvdata(dev
);
1251 struct omap2_mcspi
*mcspi
= spi_master_get_devdata(master
);
1252 struct omap2_mcspi_regs
*ctx
= &mcspi
->ctx
;
1253 struct omap2_mcspi_cs
*cs
;
1255 omap2_mcspi_enable_clocks(mcspi
);
1256 list_for_each_entry(cs
, &ctx
->cs
, node
) {
1257 if ((cs
->chconf0
& OMAP2_MCSPI_CHCONF_FORCE
) == 0) {
1259 * We need to toggle CS state for OMAP take this
1260 * change in account.
1262 MOD_REG_BIT(cs
->chconf0
, OMAP2_MCSPI_CHCONF_FORCE
, 1);
1263 __raw_writel(cs
->chconf0
, cs
->base
+ OMAP2_MCSPI_CHCONF0
);
1264 MOD_REG_BIT(cs
->chconf0
, OMAP2_MCSPI_CHCONF_FORCE
, 0);
1265 __raw_writel(cs
->chconf0
, cs
->base
+ OMAP2_MCSPI_CHCONF0
);
1268 omap2_mcspi_disable_clocks(mcspi
);
1272 #define omap2_mcspi_resume NULL
1275 static const struct dev_pm_ops omap2_mcspi_pm_ops
= {
1276 .resume
= omap2_mcspi_resume
,
1277 .runtime_resume
= omap_mcspi_runtime_resume
,
1280 static struct platform_driver omap2_mcspi_driver
= {
1282 .name
= "omap2_mcspi",
1283 .owner
= THIS_MODULE
,
1284 .pm
= &omap2_mcspi_pm_ops
,
1285 .of_match_table
= omap_mcspi_of_match
,
1287 .probe
= omap2_mcspi_probe
,
1288 .remove
= __devexit_p(omap2_mcspi_remove
),
1291 module_platform_driver(omap2_mcspi_driver
);
1292 MODULE_LICENSE("GPL");