2 * File: drivers/spi/bfin5xx_spi.c
4 * Bryan Wu <bryan.wu@analog.com>
6 * Luke Yang (Analog Devices Inc.)
8 * Created: March. 10th 2006
9 * Description: SPI controller driver for Blackfin BF5xx
10 * Bugs: Enter bugs at http://blackfin.uclinux.org/
13 * March 10, 2006 bfin5xx_spi.c Created. (Luke Yang)
14 * August 7, 2006 added full duplex mode (Axel Weiss & Luke Yang)
15 * July 17, 2007 add support for BF54x SPI0 controller (Bryan Wu)
16 * July 30, 2007 add platfrom_resource interface to support multi-port
17 * SPI controller (Bryan Wu)
19 * Copyright 2004-2007 Analog Devices Inc.
21 * This program is free software ; you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation ; either version 2, or (at your option)
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY ; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program ; see the file COPYING.
33 * If not, write to the Free Software Foundation,
34 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
37 #include <linux/init.h>
38 #include <linux/module.h>
39 #include <linux/delay.h>
40 #include <linux/device.h>
42 #include <linux/ioport.h>
43 #include <linux/irq.h>
44 #include <linux/errno.h>
45 #include <linux/interrupt.h>
46 #include <linux/platform_device.h>
47 #include <linux/dma-mapping.h>
48 #include <linux/spi/spi.h>
49 #include <linux/workqueue.h>
52 #include <asm/portmux.h>
53 #include <asm/bfin5xx_spi.h>
55 #define DRV_NAME "bfin-spi"
56 #define DRV_AUTHOR "Bryan Wu, Luke Yang"
57 #define DRV_DESC "Blackfin BF5xx on-chip SPI Contoller Driver"
58 #define DRV_VERSION "1.0"
60 MODULE_AUTHOR(DRV_AUTHOR
);
61 MODULE_DESCRIPTION(DRV_DESC
);
62 MODULE_LICENSE("GPL");
64 #define IS_DMA_ALIGNED(x) (((u32)(x)&0x07) == 0)
66 #define START_STATE ((void *)0)
67 #define RUNNING_STATE ((void *)1)
68 #define DONE_STATE ((void *)2)
69 #define ERROR_STATE ((void *)-1)
70 #define QUEUE_RUNNING 0
71 #define QUEUE_STOPPED 1
74 /* Driver model hookup */
75 struct platform_device
*pdev
;
77 /* SPI framework hookup */
78 struct spi_master
*master
;
80 /* Regs base of SPI controller */
84 struct bfin5xx_spi_master
*master_info
;
86 /* Driver message queue */
87 struct workqueue_struct
*workqueue
;
88 struct work_struct pump_messages
;
90 struct list_head queue
;
94 /* Message Transfer pump */
95 struct tasklet_struct pump_transfers
;
97 /* Current message transfer state info */
98 struct spi_message
*cur_msg
;
99 struct spi_transfer
*cur_transfer
;
100 struct chip_data
*cur_chip
;
119 void (*write
) (struct driver_data
*);
120 void (*read
) (struct driver_data
*);
121 void (*duplex
) (struct driver_data
*);
131 u8 width
; /* 0 or 1 */
133 u8 bits_per_word
; /* 8 or 16 */
134 u8 cs_change_per_word
;
136 void (*write
) (struct driver_data
*);
137 void (*read
) (struct driver_data
*);
138 void (*duplex
) (struct driver_data
*);
141 #define DEFINE_SPI_REG(reg, off) \
142 static inline u16 read_##reg(struct driver_data *drv_data) \
143 { return bfin_read16(drv_data->regs_base + off); } \
144 static inline void write_##reg(struct driver_data *drv_data, u16 v) \
145 { bfin_write16(drv_data->regs_base + off, v); }
147 DEFINE_SPI_REG(CTRL
, 0x00)
148 DEFINE_SPI_REG(FLAG
, 0x04)
149 DEFINE_SPI_REG(STAT
, 0x08)
150 DEFINE_SPI_REG(TDBR
, 0x0C)
151 DEFINE_SPI_REG(RDBR
, 0x10)
152 DEFINE_SPI_REG(BAUD
, 0x14)
153 DEFINE_SPI_REG(SHAW
, 0x18)
155 static void bfin_spi_enable(struct driver_data
*drv_data
)
159 cr
= read_CTRL(drv_data
);
160 write_CTRL(drv_data
, (cr
| BIT_CTL_ENABLE
));
163 static void bfin_spi_disable(struct driver_data
*drv_data
)
167 cr
= read_CTRL(drv_data
);
168 write_CTRL(drv_data
, (cr
& (~BIT_CTL_ENABLE
)));
171 /* Caculate the SPI_BAUD register value based on input HZ */
172 static u16
hz_to_spi_baud(u32 speed_hz
)
174 u_long sclk
= get_sclk();
175 u16 spi_baud
= (sclk
/ (2 * speed_hz
));
177 if ((sclk
% (2 * speed_hz
)) > 0)
183 static int flush(struct driver_data
*drv_data
)
185 unsigned long limit
= loops_per_jiffy
<< 1;
187 /* wait for stop and clear stat */
188 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
) && limit
--)
191 write_STAT(drv_data
, BIT_STAT_CLR
);
196 /* Chip select operation functions for cs_change flag */
197 static void cs_active(struct driver_data
*drv_data
, struct chip_data
*chip
)
199 u16 flag
= read_FLAG(drv_data
);
202 flag
&= ~(chip
->flag
<< 8);
204 write_FLAG(drv_data
, flag
);
207 static void cs_deactive(struct driver_data
*drv_data
, struct chip_data
*chip
)
209 u16 flag
= read_FLAG(drv_data
);
211 flag
|= (chip
->flag
<< 8);
213 write_FLAG(drv_data
, flag
);
216 #define MAX_SPI_SSEL 7
218 /* stop controller and re-config current chip*/
219 static int restore_state(struct driver_data
*drv_data
)
221 struct chip_data
*chip
= drv_data
->cur_chip
;
224 /* Clear status and disable clock */
225 write_STAT(drv_data
, BIT_STAT_CLR
);
226 bfin_spi_disable(drv_data
);
227 dev_dbg(&drv_data
->pdev
->dev
, "restoring spi ctl state\n");
229 /* Load the registers */
230 cs_deactive(drv_data
, chip
);
231 write_BAUD(drv_data
, chip
->baud
);
232 chip
->ctl_reg
&= (~BIT_CTL_TIMOD
);
233 chip
->ctl_reg
|= (chip
->width
<< 8);
234 write_CTRL(drv_data
, chip
->ctl_reg
);
236 bfin_spi_enable(drv_data
);
239 dev_dbg(&drv_data
->pdev
->dev
,
240 ": request chip select number %d failed\n",
241 chip
->chip_select_num
);
246 /* used to kick off transfer in rx mode */
247 static unsigned short dummy_read(struct driver_data
*drv_data
)
250 tmp
= read_RDBR(drv_data
);
254 static void null_writer(struct driver_data
*drv_data
)
256 u8 n_bytes
= drv_data
->n_bytes
;
258 while (drv_data
->tx
< drv_data
->tx_end
) {
259 write_TDBR(drv_data
, 0);
260 while ((read_STAT(drv_data
) & BIT_STAT_TXS
))
262 drv_data
->tx
+= n_bytes
;
266 static void null_reader(struct driver_data
*drv_data
)
268 u8 n_bytes
= drv_data
->n_bytes
;
269 dummy_read(drv_data
);
271 while (drv_data
->rx
< drv_data
->rx_end
) {
272 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
274 dummy_read(drv_data
);
275 drv_data
->rx
+= n_bytes
;
279 static void u8_writer(struct driver_data
*drv_data
)
281 dev_dbg(&drv_data
->pdev
->dev
,
282 "cr8-s is 0x%x\n", read_STAT(drv_data
));
284 /* poll for SPI completion before start */
285 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
288 while (drv_data
->tx
< drv_data
->tx_end
) {
289 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
290 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
296 static void u8_cs_chg_writer(struct driver_data
*drv_data
)
298 struct chip_data
*chip
= drv_data
->cur_chip
;
300 /* poll for SPI completion before start */
301 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
304 while (drv_data
->tx
< drv_data
->tx_end
) {
305 cs_active(drv_data
, chip
);
307 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
308 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
310 cs_deactive(drv_data
, chip
);
312 if (chip
->cs_chg_udelay
)
313 udelay(chip
->cs_chg_udelay
);
318 static void u8_reader(struct driver_data
*drv_data
)
320 dev_dbg(&drv_data
->pdev
->dev
,
321 "cr-8 is 0x%x\n", read_STAT(drv_data
));
323 /* poll for SPI completion before start */
324 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
327 /* clear TDBR buffer before read(else it will be shifted out) */
328 write_TDBR(drv_data
, 0xFFFF);
330 dummy_read(drv_data
);
332 while (drv_data
->rx
< drv_data
->rx_end
- 1) {
333 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
335 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
339 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
341 *(u8
*) (drv_data
->rx
) = read_SHAW(drv_data
);
345 static void u8_cs_chg_reader(struct driver_data
*drv_data
)
347 struct chip_data
*chip
= drv_data
->cur_chip
;
349 /* poll for SPI completion before start */
350 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
353 /* clear TDBR buffer before read(else it will be shifted out) */
354 write_TDBR(drv_data
, 0xFFFF);
356 cs_active(drv_data
, chip
);
357 dummy_read(drv_data
);
359 while (drv_data
->rx
< drv_data
->rx_end
- 1) {
360 cs_deactive(drv_data
, chip
);
362 if (chip
->cs_chg_udelay
)
363 udelay(chip
->cs_chg_udelay
);
365 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
367 cs_active(drv_data
, chip
);
368 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
371 cs_deactive(drv_data
, chip
);
373 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
375 *(u8
*) (drv_data
->rx
) = read_SHAW(drv_data
);
379 static void u8_duplex(struct driver_data
*drv_data
)
381 /* poll for SPI completion before start */
382 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
385 /* in duplex mode, clk is triggered by writing of TDBR */
386 while (drv_data
->rx
< drv_data
->rx_end
) {
387 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
388 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
390 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
392 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
398 static void u8_cs_chg_duplex(struct driver_data
*drv_data
)
400 struct chip_data
*chip
= drv_data
->cur_chip
;
402 /* poll for SPI completion before start */
403 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
406 while (drv_data
->rx
< drv_data
->rx_end
) {
407 cs_active(drv_data
, chip
);
409 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
410 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
412 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
414 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
415 cs_deactive(drv_data
, chip
);
417 if (chip
->cs_chg_udelay
)
418 udelay(chip
->cs_chg_udelay
);
424 static void u16_writer(struct driver_data
*drv_data
)
426 dev_dbg(&drv_data
->pdev
->dev
,
427 "cr16 is 0x%x\n", read_STAT(drv_data
));
429 /* poll for SPI completion before start */
430 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
433 while (drv_data
->tx
< drv_data
->tx_end
) {
434 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
435 while ((read_STAT(drv_data
) & BIT_STAT_TXS
))
441 static void u16_cs_chg_writer(struct driver_data
*drv_data
)
443 struct chip_data
*chip
= drv_data
->cur_chip
;
445 /* poll for SPI completion before start */
446 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
449 while (drv_data
->tx
< drv_data
->tx_end
) {
450 cs_active(drv_data
, chip
);
452 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
453 while ((read_STAT(drv_data
) & BIT_STAT_TXS
))
455 cs_deactive(drv_data
, chip
);
457 if (chip
->cs_chg_udelay
)
458 udelay(chip
->cs_chg_udelay
);
463 static void u16_reader(struct driver_data
*drv_data
)
465 dev_dbg(&drv_data
->pdev
->dev
,
466 "cr-16 is 0x%x\n", read_STAT(drv_data
));
468 /* poll for SPI completion before start */
469 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
472 /* clear TDBR buffer before read(else it will be shifted out) */
473 write_TDBR(drv_data
, 0xFFFF);
475 dummy_read(drv_data
);
477 while (drv_data
->rx
< (drv_data
->rx_end
- 2)) {
478 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
480 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
484 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
486 *(u16
*) (drv_data
->rx
) = read_SHAW(drv_data
);
490 static void u16_cs_chg_reader(struct driver_data
*drv_data
)
492 struct chip_data
*chip
= drv_data
->cur_chip
;
494 /* poll for SPI completion before start */
495 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
498 /* clear TDBR buffer before read(else it will be shifted out) */
499 write_TDBR(drv_data
, 0xFFFF);
501 cs_active(drv_data
, chip
);
502 dummy_read(drv_data
);
504 while (drv_data
->rx
< drv_data
->rx_end
) {
505 cs_deactive(drv_data
, chip
);
507 if (chip
->cs_chg_udelay
)
508 udelay(chip
->cs_chg_udelay
);
510 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
512 cs_active(drv_data
, chip
);
513 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
516 cs_deactive(drv_data
, chip
);
518 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
520 *(u16
*) (drv_data
->rx
) = read_SHAW(drv_data
);
524 static void u16_duplex(struct driver_data
*drv_data
)
526 /* poll for SPI completion before start */
527 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
530 /* in duplex mode, clk is triggered by writing of TDBR */
531 while (drv_data
->tx
< drv_data
->tx_end
) {
532 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
533 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
535 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
537 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
543 static void u16_cs_chg_duplex(struct driver_data
*drv_data
)
545 struct chip_data
*chip
= drv_data
->cur_chip
;
547 /* poll for SPI completion before start */
548 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
551 while (drv_data
->tx
< drv_data
->tx_end
) {
552 cs_active(drv_data
, chip
);
554 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
555 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
557 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
559 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
560 cs_deactive(drv_data
, chip
);
562 if (chip
->cs_chg_udelay
)
563 udelay(chip
->cs_chg_udelay
);
569 /* test if ther is more transfer to be done */
570 static void *next_transfer(struct driver_data
*drv_data
)
572 struct spi_message
*msg
= drv_data
->cur_msg
;
573 struct spi_transfer
*trans
= drv_data
->cur_transfer
;
575 /* Move to next transfer */
576 if (trans
->transfer_list
.next
!= &msg
->transfers
) {
577 drv_data
->cur_transfer
=
578 list_entry(trans
->transfer_list
.next
,
579 struct spi_transfer
, transfer_list
);
580 return RUNNING_STATE
;
586 * caller already set message->status;
587 * dma and pio irqs are blocked give finished message back
589 static void giveback(struct driver_data
*drv_data
)
591 struct chip_data
*chip
= drv_data
->cur_chip
;
592 struct spi_transfer
*last_transfer
;
594 struct spi_message
*msg
;
596 spin_lock_irqsave(&drv_data
->lock
, flags
);
597 msg
= drv_data
->cur_msg
;
598 drv_data
->cur_msg
= NULL
;
599 drv_data
->cur_transfer
= NULL
;
600 drv_data
->cur_chip
= NULL
;
601 queue_work(drv_data
->workqueue
, &drv_data
->pump_messages
);
602 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
604 last_transfer
= list_entry(msg
->transfers
.prev
,
605 struct spi_transfer
, transfer_list
);
609 /* disable chip select signal. And not stop spi in autobuffer mode */
610 if (drv_data
->tx_dma
!= 0xFFFF) {
611 cs_deactive(drv_data
, chip
);
612 bfin_spi_disable(drv_data
);
615 if (!drv_data
->cs_change
)
616 cs_deactive(drv_data
, chip
);
619 msg
->complete(msg
->context
);
622 static irqreturn_t
dma_irq_handler(int irq
, void *dev_id
)
624 struct driver_data
*drv_data
= (struct driver_data
*)dev_id
;
625 struct chip_data
*chip
= drv_data
->cur_chip
;
626 struct spi_message
*msg
= drv_data
->cur_msg
;
628 dev_dbg(&drv_data
->pdev
->dev
, "in dma_irq_handler\n");
629 clear_dma_irqstat(drv_data
->dma_channel
);
631 /* Wait for DMA to complete */
632 while (get_dma_curr_irqstat(drv_data
->dma_channel
) & DMA_RUN
)
636 * wait for the last transaction shifted out. HRM states:
637 * at this point there may still be data in the SPI DMA FIFO waiting
638 * to be transmitted ... software needs to poll TXS in the SPI_STAT
639 * register until it goes low for 2 successive reads
641 if (drv_data
->tx
!= NULL
) {
642 while ((read_STAT(drv_data
) & TXS
) ||
643 (read_STAT(drv_data
) & TXS
))
647 while (!(read_STAT(drv_data
) & SPIF
))
650 msg
->actual_length
+= drv_data
->len_in_bytes
;
652 if (drv_data
->cs_change
)
653 cs_deactive(drv_data
, chip
);
655 /* Move to next transfer */
656 msg
->state
= next_transfer(drv_data
);
658 /* Schedule transfer tasklet */
659 tasklet_schedule(&drv_data
->pump_transfers
);
661 /* free the irq handler before next transfer */
662 dev_dbg(&drv_data
->pdev
->dev
,
663 "disable dma channel irq%d\n",
664 drv_data
->dma_channel
);
665 dma_disable_irq(drv_data
->dma_channel
);
670 static void pump_transfers(unsigned long data
)
672 struct driver_data
*drv_data
= (struct driver_data
*)data
;
673 struct spi_message
*message
= NULL
;
674 struct spi_transfer
*transfer
= NULL
;
675 struct spi_transfer
*previous
= NULL
;
676 struct chip_data
*chip
= NULL
;
678 u16 cr
, dma_width
, dma_config
;
679 u32 tranf_success
= 1;
681 /* Get current state information */
682 message
= drv_data
->cur_msg
;
683 transfer
= drv_data
->cur_transfer
;
684 chip
= drv_data
->cur_chip
;
686 * if msg is error or done, report it back using complete() callback
689 /* Handle for abort */
690 if (message
->state
== ERROR_STATE
) {
691 message
->status
= -EIO
;
696 /* Handle end of message */
697 if (message
->state
== DONE_STATE
) {
703 /* Delay if requested at end of transfer */
704 if (message
->state
== RUNNING_STATE
) {
705 previous
= list_entry(transfer
->transfer_list
.prev
,
706 struct spi_transfer
, transfer_list
);
707 if (previous
->delay_usecs
)
708 udelay(previous
->delay_usecs
);
711 /* Setup the transfer state based on the type of transfer */
712 if (flush(drv_data
) == 0) {
713 dev_err(&drv_data
->pdev
->dev
, "pump_transfers: flush failed\n");
714 message
->status
= -EIO
;
719 if (transfer
->tx_buf
!= NULL
) {
720 drv_data
->tx
= (void *)transfer
->tx_buf
;
721 drv_data
->tx_end
= drv_data
->tx
+ transfer
->len
;
722 dev_dbg(&drv_data
->pdev
->dev
, "tx_buf is %p, tx_end is %p\n",
723 transfer
->tx_buf
, drv_data
->tx_end
);
728 if (transfer
->rx_buf
!= NULL
) {
729 drv_data
->rx
= transfer
->rx_buf
;
730 drv_data
->rx_end
= drv_data
->rx
+ transfer
->len
;
731 dev_dbg(&drv_data
->pdev
->dev
, "rx_buf is %p, rx_end is %p\n",
732 transfer
->rx_buf
, drv_data
->rx_end
);
737 drv_data
->rx_dma
= transfer
->rx_dma
;
738 drv_data
->tx_dma
= transfer
->tx_dma
;
739 drv_data
->len_in_bytes
= transfer
->len
;
740 drv_data
->cs_change
= transfer
->cs_change
;
743 if (width
== CFG_SPI_WORDSIZE16
) {
744 drv_data
->len
= (transfer
->len
) >> 1;
746 drv_data
->len
= transfer
->len
;
748 drv_data
->write
= drv_data
->tx
? chip
->write
: null_writer
;
749 drv_data
->read
= drv_data
->rx
? chip
->read
: null_reader
;
750 drv_data
->duplex
= chip
->duplex
? chip
->duplex
: null_writer
;
751 dev_dbg(&drv_data
->pdev
->dev
, "transfer: ",
752 "drv_data->write is %p, chip->write is %p, null_wr is %p\n",
753 drv_data
->write
, chip
->write
, null_writer
);
755 /* speed and width has been set on per message */
756 message
->state
= RUNNING_STATE
;
759 write_STAT(drv_data
, BIT_STAT_CLR
);
760 cr
= (read_CTRL(drv_data
) & (~BIT_CTL_TIMOD
));
761 cs_active(drv_data
, chip
);
763 dev_dbg(&drv_data
->pdev
->dev
,
764 "now pumping a transfer: width is %d, len is %d\n",
765 width
, transfer
->len
);
768 * Try to map dma buffer and do a dma transfer if
769 * successful use different way to r/w according to
770 * drv_data->cur_chip->enable_dma
772 if (drv_data
->cur_chip
->enable_dma
&& drv_data
->len
> 6) {
774 disable_dma(drv_data
->dma_channel
);
775 clear_dma_irqstat(drv_data
->dma_channel
);
777 /* config dma channel */
778 dev_dbg(&drv_data
->pdev
->dev
, "doing dma transfer\n");
779 if (width
== CFG_SPI_WORDSIZE16
) {
780 set_dma_x_count(drv_data
->dma_channel
, drv_data
->len
);
781 set_dma_x_modify(drv_data
->dma_channel
, 2);
782 dma_width
= WDSIZE_16
;
784 set_dma_x_count(drv_data
->dma_channel
, drv_data
->len
);
785 set_dma_x_modify(drv_data
->dma_channel
, 1);
786 dma_width
= WDSIZE_8
;
789 /* poll for SPI completion before start */
790 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
793 /* dirty hack for autobuffer DMA mode */
794 if (drv_data
->tx_dma
== 0xFFFF) {
795 dev_dbg(&drv_data
->pdev
->dev
,
796 "doing autobuffer DMA out.\n");
798 /* set SPI transfer mode */
799 write_CTRL(drv_data
, (cr
| CFG_SPI_DMAWRITE
));
801 /* no irq in autobuffer mode */
803 (DMAFLOW_AUTO
| RESTART
| dma_width
| DI_EN
);
804 set_dma_config(drv_data
->dma_channel
, dma_config
);
805 set_dma_start_addr(drv_data
->dma_channel
,
806 (unsigned long)drv_data
->tx
);
807 enable_dma(drv_data
->dma_channel
);
809 /* just return here, there can only be one transfer in this mode */
815 /* In dma mode, rx or tx must be NULL in one transfer */
816 if (drv_data
->rx
!= NULL
) {
817 /* set transfer mode, and enable SPI */
818 dev_dbg(&drv_data
->pdev
->dev
, "doing DMA in.\n");
820 /* set SPI transfer mode */
821 write_CTRL(drv_data
, (cr
| CFG_SPI_DMAREAD
));
823 /* clear tx reg soformer data is not shifted out */
824 write_TDBR(drv_data
, 0xFFFF);
826 set_dma_x_count(drv_data
->dma_channel
, drv_data
->len
);
829 dma_enable_irq(drv_data
->dma_channel
);
830 dma_config
= (WNR
| RESTART
| dma_width
| DI_EN
);
831 set_dma_config(drv_data
->dma_channel
, dma_config
);
832 set_dma_start_addr(drv_data
->dma_channel
,
833 (unsigned long)drv_data
->rx
);
834 enable_dma(drv_data
->dma_channel
);
836 } else if (drv_data
->tx
!= NULL
) {
837 dev_dbg(&drv_data
->pdev
->dev
, "doing DMA out.\n");
839 /* set SPI transfer mode */
840 write_CTRL(drv_data
, (cr
| CFG_SPI_DMAWRITE
));
843 dma_enable_irq(drv_data
->dma_channel
);
844 dma_config
= (RESTART
| dma_width
| DI_EN
);
845 set_dma_config(drv_data
->dma_channel
, dma_config
);
846 set_dma_start_addr(drv_data
->dma_channel
,
847 (unsigned long)drv_data
->tx
);
848 enable_dma(drv_data
->dma_channel
);
851 /* IO mode write then read */
852 dev_dbg(&drv_data
->pdev
->dev
, "doing IO transfer\n");
854 if (drv_data
->tx
!= NULL
&& drv_data
->rx
!= NULL
) {
855 /* full duplex mode */
856 BUG_ON((drv_data
->tx_end
- drv_data
->tx
) !=
857 (drv_data
->rx_end
- drv_data
->rx
));
858 dev_dbg(&drv_data
->pdev
->dev
,
859 "IO duplex: cr is 0x%x\n", cr
);
861 /* set SPI transfer mode */
862 write_CTRL(drv_data
, (cr
| CFG_SPI_WRITE
));
864 drv_data
->duplex(drv_data
);
866 if (drv_data
->tx
!= drv_data
->tx_end
)
868 } else if (drv_data
->tx
!= NULL
) {
869 /* write only half duplex */
870 dev_dbg(&drv_data
->pdev
->dev
,
871 "IO write: cr is 0x%x\n", cr
);
873 /* set SPI transfer mode */
874 write_CTRL(drv_data
, (cr
| CFG_SPI_WRITE
));
876 drv_data
->write(drv_data
);
878 if (drv_data
->tx
!= drv_data
->tx_end
)
880 } else if (drv_data
->rx
!= NULL
) {
881 /* read only half duplex */
882 dev_dbg(&drv_data
->pdev
->dev
,
883 "IO read: cr is 0x%x\n", cr
);
885 /* set SPI transfer mode */
886 write_CTRL(drv_data
, (cr
| CFG_SPI_READ
));
888 drv_data
->read(drv_data
);
889 if (drv_data
->rx
!= drv_data
->rx_end
)
893 if (!tranf_success
) {
894 dev_dbg(&drv_data
->pdev
->dev
,
895 "IO write error!\n");
896 message
->state
= ERROR_STATE
;
898 /* Update total byte transfered */
899 message
->actual_length
+= drv_data
->len
;
901 /* Move to next transfer of this msg */
902 message
->state
= next_transfer(drv_data
);
905 /* Schedule next transfer tasklet */
906 tasklet_schedule(&drv_data
->pump_transfers
);
911 /* pop a msg from queue and kick off real transfer */
912 static void pump_messages(struct work_struct
*work
)
914 struct driver_data
*drv_data
;
917 drv_data
= container_of(work
, struct driver_data
, pump_messages
);
919 /* Lock queue and check for queue work */
920 spin_lock_irqsave(&drv_data
->lock
, flags
);
921 if (list_empty(&drv_data
->queue
) || drv_data
->run
== QUEUE_STOPPED
) {
922 /* pumper kicked off but no work to do */
924 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
928 /* Make sure we are not already running a message */
929 if (drv_data
->cur_msg
) {
930 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
934 /* Extract head of queue */
935 drv_data
->cur_msg
= list_entry(drv_data
->queue
.next
,
936 struct spi_message
, queue
);
938 /* Setup the SSP using the per chip configuration */
939 drv_data
->cur_chip
= spi_get_ctldata(drv_data
->cur_msg
->spi
);
940 if (restore_state(drv_data
)) {
941 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
945 list_del_init(&drv_data
->cur_msg
->queue
);
947 /* Initial message state */
948 drv_data
->cur_msg
->state
= START_STATE
;
949 drv_data
->cur_transfer
= list_entry(drv_data
->cur_msg
->transfers
.next
,
950 struct spi_transfer
, transfer_list
);
952 dev_dbg(&drv_data
->pdev
->dev
, "got a message to pump, "
953 "state is set to: baud %d, flag 0x%x, ctl 0x%x\n",
954 drv_data
->cur_chip
->baud
, drv_data
->cur_chip
->flag
,
955 drv_data
->cur_chip
->ctl_reg
);
957 dev_dbg(&drv_data
->pdev
->dev
,
958 "the first transfer len is %d\n",
959 drv_data
->cur_transfer
->len
);
961 /* Mark as busy and launch transfers */
962 tasklet_schedule(&drv_data
->pump_transfers
);
965 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
969 * got a msg to transfer, queue it in drv_data->queue.
970 * And kick off message pumper
972 static int transfer(struct spi_device
*spi
, struct spi_message
*msg
)
974 struct driver_data
*drv_data
= spi_master_get_devdata(spi
->master
);
977 spin_lock_irqsave(&drv_data
->lock
, flags
);
979 if (drv_data
->run
== QUEUE_STOPPED
) {
980 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
984 msg
->actual_length
= 0;
985 msg
->status
= -EINPROGRESS
;
986 msg
->state
= START_STATE
;
988 dev_dbg(&spi
->dev
, "adding an msg in transfer() \n");
989 list_add_tail(&msg
->queue
, &drv_data
->queue
);
991 if (drv_data
->run
== QUEUE_RUNNING
&& !drv_data
->busy
)
992 queue_work(drv_data
->workqueue
, &drv_data
->pump_messages
);
994 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
999 #define MAX_SPI_SSEL 7
1001 static u16 ssel
[3][MAX_SPI_SSEL
] = {
1002 {P_SPI0_SSEL1
, P_SPI0_SSEL2
, P_SPI0_SSEL3
,
1003 P_SPI0_SSEL4
, P_SPI0_SSEL5
,
1004 P_SPI0_SSEL6
, P_SPI0_SSEL7
},
1006 {P_SPI1_SSEL1
, P_SPI1_SSEL2
, P_SPI1_SSEL3
,
1007 P_SPI1_SSEL4
, P_SPI1_SSEL5
,
1008 P_SPI1_SSEL6
, P_SPI1_SSEL7
},
1010 {P_SPI2_SSEL1
, P_SPI2_SSEL2
, P_SPI2_SSEL3
,
1011 P_SPI2_SSEL4
, P_SPI2_SSEL5
,
1012 P_SPI2_SSEL6
, P_SPI2_SSEL7
},
1015 /* first setup for new devices */
1016 static int setup(struct spi_device
*spi
)
1018 struct bfin5xx_spi_chip
*chip_info
= NULL
;
1019 struct chip_data
*chip
;
1020 struct driver_data
*drv_data
= spi_master_get_devdata(spi
->master
);
1023 /* Abort device setup if requested features are not supported */
1024 if (spi
->mode
& ~(SPI_CPOL
| SPI_CPHA
| SPI_LSB_FIRST
)) {
1025 dev_err(&spi
->dev
, "requested mode not fully supported\n");
1029 /* Zero (the default) here means 8 bits */
1030 if (!spi
->bits_per_word
)
1031 spi
->bits_per_word
= 8;
1033 if (spi
->bits_per_word
!= 8 && spi
->bits_per_word
!= 16)
1036 /* Only alloc (or use chip_info) on first setup */
1037 chip
= spi_get_ctldata(spi
);
1039 chip
= kzalloc(sizeof(struct chip_data
), GFP_KERNEL
);
1043 chip
->enable_dma
= 0;
1044 chip_info
= spi
->controller_data
;
1047 /* chip_info isn't always needed */
1049 /* Make sure people stop trying to set fields via ctl_reg
1050 * when they should actually be using common SPI framework.
1051 * Currently we let through: WOM EMISO PSSE GM SZ TIMOD.
1052 * Not sure if a user actually needs/uses any of these,
1053 * but let's assume (for now) they do.
1055 if (chip_info
->ctl_reg
& (SPE
|MSTR
|CPOL
|CPHA
|LSBF
|SIZE
)) {
1056 dev_err(&spi
->dev
, "do not set bits in ctl_reg "
1057 "that the SPI framework manages\n");
1061 chip
->enable_dma
= chip_info
->enable_dma
!= 0
1062 && drv_data
->master_info
->enable_dma
;
1063 chip
->ctl_reg
= chip_info
->ctl_reg
;
1064 chip
->bits_per_word
= chip_info
->bits_per_word
;
1065 chip
->cs_change_per_word
= chip_info
->cs_change_per_word
;
1066 chip
->cs_chg_udelay
= chip_info
->cs_chg_udelay
;
1069 /* translate common spi framework into our register */
1070 if (spi
->mode
& SPI_CPOL
)
1071 chip
->ctl_reg
|= CPOL
;
1072 if (spi
->mode
& SPI_CPHA
)
1073 chip
->ctl_reg
|= CPHA
;
1074 if (spi
->mode
& SPI_LSB_FIRST
)
1075 chip
->ctl_reg
|= LSBF
;
1076 /* we dont support running in slave mode (yet?) */
1077 chip
->ctl_reg
|= MSTR
;
1080 * if any one SPI chip is registered and wants DMA, request the
1081 * DMA channel for it
1083 if (chip
->enable_dma
&& !drv_data
->dma_requested
) {
1084 /* register dma irq handler */
1085 if (request_dma(drv_data
->dma_channel
, "BF53x_SPI_DMA") < 0) {
1087 "Unable to request BlackFin SPI DMA channel\n");
1090 if (set_dma_callback(drv_data
->dma_channel
,
1091 (void *)dma_irq_handler
, drv_data
) < 0) {
1092 dev_dbg(&spi
->dev
, "Unable to set dma callback\n");
1095 dma_disable_irq(drv_data
->dma_channel
);
1096 drv_data
->dma_requested
= 1;
1100 * Notice: for blackfin, the speed_hz is the value of register
1101 * SPI_BAUD, not the real baudrate
1103 chip
->baud
= hz_to_spi_baud(spi
->max_speed_hz
);
1104 spi_flg
= ~(1 << (spi
->chip_select
));
1105 chip
->flag
= ((u16
) spi_flg
<< 8) | (1 << (spi
->chip_select
));
1106 chip
->chip_select_num
= spi
->chip_select
;
1108 switch (chip
->bits_per_word
) {
1111 chip
->width
= CFG_SPI_WORDSIZE8
;
1112 chip
->read
= chip
->cs_change_per_word
?
1113 u8_cs_chg_reader
: u8_reader
;
1114 chip
->write
= chip
->cs_change_per_word
?
1115 u8_cs_chg_writer
: u8_writer
;
1116 chip
->duplex
= chip
->cs_change_per_word
?
1117 u8_cs_chg_duplex
: u8_duplex
;
1122 chip
->width
= CFG_SPI_WORDSIZE16
;
1123 chip
->read
= chip
->cs_change_per_word
?
1124 u16_cs_chg_reader
: u16_reader
;
1125 chip
->write
= chip
->cs_change_per_word
?
1126 u16_cs_chg_writer
: u16_writer
;
1127 chip
->duplex
= chip
->cs_change_per_word
?
1128 u16_cs_chg_duplex
: u16_duplex
;
1132 dev_err(&spi
->dev
, "%d bits_per_word is not supported\n",
1133 chip
->bits_per_word
);
1138 dev_dbg(&spi
->dev
, "setup spi chip %s, width is %d, dma is %d\n",
1139 spi
->modalias
, chip
->width
, chip
->enable_dma
);
1140 dev_dbg(&spi
->dev
, "ctl_reg is 0x%x, flag_reg is 0x%x\n",
1141 chip
->ctl_reg
, chip
->flag
);
1143 spi_set_ctldata(spi
, chip
);
1145 dev_dbg(&spi
->dev
, "chip select number is %d\n", chip
->chip_select_num
);
1146 if ((chip
->chip_select_num
> 0)
1147 && (chip
->chip_select_num
<= spi
->master
->num_chipselect
))
1148 peripheral_request(ssel
[spi
->master
->bus_num
]
1149 [chip
->chip_select_num
-1], DRV_NAME
);
1155 * callback for spi framework.
1156 * clean driver specific data
1158 static void cleanup(struct spi_device
*spi
)
1160 struct chip_data
*chip
= spi_get_ctldata(spi
);
1162 if ((chip
->chip_select_num
> 0)
1163 && (chip
->chip_select_num
<= spi
->master
->num_chipselect
))
1164 peripheral_free(ssel
[spi
->master
->bus_num
]
1165 [chip
->chip_select_num
-1]);
1170 static inline int init_queue(struct driver_data
*drv_data
)
1172 INIT_LIST_HEAD(&drv_data
->queue
);
1173 spin_lock_init(&drv_data
->lock
);
1175 drv_data
->run
= QUEUE_STOPPED
;
1178 /* init transfer tasklet */
1179 tasklet_init(&drv_data
->pump_transfers
,
1180 pump_transfers
, (unsigned long)drv_data
);
1182 /* init messages workqueue */
1183 INIT_WORK(&drv_data
->pump_messages
, pump_messages
);
1184 drv_data
->workqueue
=
1185 create_singlethread_workqueue(drv_data
->master
->dev
.parent
->bus_id
);
1186 if (drv_data
->workqueue
== NULL
)
1192 static inline int start_queue(struct driver_data
*drv_data
)
1194 unsigned long flags
;
1196 spin_lock_irqsave(&drv_data
->lock
, flags
);
1198 if (drv_data
->run
== QUEUE_RUNNING
|| drv_data
->busy
) {
1199 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1203 drv_data
->run
= QUEUE_RUNNING
;
1204 drv_data
->cur_msg
= NULL
;
1205 drv_data
->cur_transfer
= NULL
;
1206 drv_data
->cur_chip
= NULL
;
1207 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1209 queue_work(drv_data
->workqueue
, &drv_data
->pump_messages
);
1214 static inline int stop_queue(struct driver_data
*drv_data
)
1216 unsigned long flags
;
1217 unsigned limit
= 500;
1220 spin_lock_irqsave(&drv_data
->lock
, flags
);
1223 * This is a bit lame, but is optimized for the common execution path.
1224 * A wait_queue on the drv_data->busy could be used, but then the common
1225 * execution path (pump_messages) would be required to call wake_up or
1226 * friends on every SPI message. Do this instead
1228 drv_data
->run
= QUEUE_STOPPED
;
1229 while (!list_empty(&drv_data
->queue
) && drv_data
->busy
&& limit
--) {
1230 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1232 spin_lock_irqsave(&drv_data
->lock
, flags
);
1235 if (!list_empty(&drv_data
->queue
) || drv_data
->busy
)
1238 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1243 static inline int destroy_queue(struct driver_data
*drv_data
)
1247 status
= stop_queue(drv_data
);
1251 destroy_workqueue(drv_data
->workqueue
);
1256 static int setup_pin_mux(int action
, int bus_num
)
1259 u16 pin_req
[3][4] = {
1260 {P_SPI0_SCK
, P_SPI0_MISO
, P_SPI0_MOSI
, 0},
1261 {P_SPI1_SCK
, P_SPI1_MISO
, P_SPI1_MOSI
, 0},
1262 {P_SPI2_SCK
, P_SPI2_MISO
, P_SPI2_MOSI
, 0},
1266 if (peripheral_request_list(pin_req
[bus_num
], DRV_NAME
))
1269 peripheral_free_list(pin_req
[bus_num
]);
1275 static int __init
bfin5xx_spi_probe(struct platform_device
*pdev
)
1277 struct device
*dev
= &pdev
->dev
;
1278 struct bfin5xx_spi_master
*platform_info
;
1279 struct spi_master
*master
;
1280 struct driver_data
*drv_data
= 0;
1281 struct resource
*res
;
1284 platform_info
= dev
->platform_data
;
1286 /* Allocate master with space for drv_data */
1287 master
= spi_alloc_master(dev
, sizeof(struct driver_data
) + 16);
1289 dev_err(&pdev
->dev
, "can not alloc spi_master\n");
1293 drv_data
= spi_master_get_devdata(master
);
1294 drv_data
->master
= master
;
1295 drv_data
->master_info
= platform_info
;
1296 drv_data
->pdev
= pdev
;
1298 master
->bus_num
= pdev
->id
;
1299 master
->num_chipselect
= platform_info
->num_chipselect
;
1300 master
->cleanup
= cleanup
;
1301 master
->setup
= setup
;
1302 master
->transfer
= transfer
;
1304 /* Find and map our resources */
1305 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1307 dev_err(dev
, "Cannot get IORESOURCE_MEM\n");
1309 goto out_error_get_res
;
1312 drv_data
->regs_base
= (u32
) ioremap(res
->start
,
1313 (res
->end
- res
->start
+ 1));
1314 if (!drv_data
->regs_base
) {
1315 dev_err(dev
, "Cannot map IO\n");
1317 goto out_error_ioremap
;
1320 drv_data
->dma_channel
= platform_get_irq(pdev
, 0);
1321 if (drv_data
->dma_channel
< 0) {
1322 dev_err(dev
, "No DMA channel specified\n");
1324 goto out_error_no_dma_ch
;
1327 /* Initial and start queue */
1328 status
= init_queue(drv_data
);
1330 dev_err(dev
, "problem initializing queue\n");
1331 goto out_error_queue_alloc
;
1334 status
= start_queue(drv_data
);
1336 dev_err(dev
, "problem starting queue\n");
1337 goto out_error_queue_alloc
;
1340 /* Register with the SPI framework */
1341 platform_set_drvdata(pdev
, drv_data
);
1342 status
= spi_register_master(master
);
1344 dev_err(dev
, "problem registering spi master\n");
1345 goto out_error_queue_alloc
;
1348 if (setup_pin_mux(1, master
->bus_num
)) {
1349 dev_err(&pdev
->dev
, ": Requesting Peripherals failed\n");
1353 dev_info(dev
, "%s, Version %s, regs_base@0x%08x, dma channel@%d\n",
1354 DRV_DESC
, DRV_VERSION
, drv_data
->regs_base
,
1355 drv_data
->dma_channel
);
1358 out_error_queue_alloc
:
1359 destroy_queue(drv_data
);
1360 out_error_no_dma_ch
:
1361 iounmap((void *) drv_data
->regs_base
);
1365 spi_master_put(master
);
1370 /* stop hardware and remove the driver */
1371 static int __devexit
bfin5xx_spi_remove(struct platform_device
*pdev
)
1373 struct driver_data
*drv_data
= platform_get_drvdata(pdev
);
1379 /* Remove the queue */
1380 status
= destroy_queue(drv_data
);
1384 /* Disable the SSP at the peripheral and SOC level */
1385 bfin_spi_disable(drv_data
);
1388 if (drv_data
->master_info
->enable_dma
) {
1389 if (dma_channel_active(drv_data
->dma_channel
))
1390 free_dma(drv_data
->dma_channel
);
1393 /* Disconnect from the SPI framework */
1394 spi_unregister_master(drv_data
->master
);
1396 setup_pin_mux(0, drv_data
->master
->bus_num
);
1398 /* Prevent double remove */
1399 platform_set_drvdata(pdev
, NULL
);
1405 static int bfin5xx_spi_suspend(struct platform_device
*pdev
, pm_message_t state
)
1407 struct driver_data
*drv_data
= platform_get_drvdata(pdev
);
1410 status
= stop_queue(drv_data
);
1415 bfin_spi_disable(drv_data
);
1420 static int bfin5xx_spi_resume(struct platform_device
*pdev
)
1422 struct driver_data
*drv_data
= platform_get_drvdata(pdev
);
1425 /* Enable the SPI interface */
1426 bfin_spi_enable(drv_data
);
1428 /* Start the queue running */
1429 status
= start_queue(drv_data
);
1431 dev_err(&pdev
->dev
, "problem starting queue (%d)\n", status
);
1438 #define bfin5xx_spi_suspend NULL
1439 #define bfin5xx_spi_resume NULL
1440 #endif /* CONFIG_PM */
1442 MODULE_ALIAS("bfin-spi-master"); /* for platform bus hotplug */
1443 static struct platform_driver bfin5xx_spi_driver
= {
1446 .owner
= THIS_MODULE
,
1448 .suspend
= bfin5xx_spi_suspend
,
1449 .resume
= bfin5xx_spi_resume
,
1450 .remove
= __devexit_p(bfin5xx_spi_remove
),
1453 static int __init
bfin5xx_spi_init(void)
1455 return platform_driver_probe(&bfin5xx_spi_driver
, bfin5xx_spi_probe
);
1457 module_init(bfin5xx_spi_init
);
1459 static void __exit
bfin5xx_spi_exit(void)
1461 platform_driver_unregister(&bfin5xx_spi_driver
);
1463 module_exit(bfin5xx_spi_exit
);