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 */
81 void __iomem
*regs_base
;
83 /* Pin request list */
87 struct bfin5xx_spi_master
*master_info
;
89 /* Driver message queue */
90 struct workqueue_struct
*workqueue
;
91 struct work_struct pump_messages
;
93 struct list_head queue
;
97 /* Message Transfer pump */
98 struct tasklet_struct pump_transfers
;
100 /* Current message transfer state info */
101 struct spi_message
*cur_msg
;
102 struct spi_transfer
*cur_transfer
;
103 struct chip_data
*cur_chip
;
122 void (*write
) (struct driver_data
*);
123 void (*read
) (struct driver_data
*);
124 void (*duplex
) (struct driver_data
*);
134 u8 width
; /* 0 or 1 */
136 u8 bits_per_word
; /* 8 or 16 */
137 u8 cs_change_per_word
;
138 u16 cs_chg_udelay
; /* Some devices require > 255usec delay */
139 void (*write
) (struct driver_data
*);
140 void (*read
) (struct driver_data
*);
141 void (*duplex
) (struct driver_data
*);
144 #define DEFINE_SPI_REG(reg, off) \
145 static inline u16 read_##reg(struct driver_data *drv_data) \
146 { return bfin_read16(drv_data->regs_base + off); } \
147 static inline void write_##reg(struct driver_data *drv_data, u16 v) \
148 { bfin_write16(drv_data->regs_base + off, v); }
150 DEFINE_SPI_REG(CTRL
, 0x00)
151 DEFINE_SPI_REG(FLAG
, 0x04)
152 DEFINE_SPI_REG(STAT
, 0x08)
153 DEFINE_SPI_REG(TDBR
, 0x0C)
154 DEFINE_SPI_REG(RDBR
, 0x10)
155 DEFINE_SPI_REG(BAUD
, 0x14)
156 DEFINE_SPI_REG(SHAW
, 0x18)
158 static void bfin_spi_enable(struct driver_data
*drv_data
)
162 cr
= read_CTRL(drv_data
);
163 write_CTRL(drv_data
, (cr
| BIT_CTL_ENABLE
));
166 static void bfin_spi_disable(struct driver_data
*drv_data
)
170 cr
= read_CTRL(drv_data
);
171 write_CTRL(drv_data
, (cr
& (~BIT_CTL_ENABLE
)));
174 /* Caculate the SPI_BAUD register value based on input HZ */
175 static u16
hz_to_spi_baud(u32 speed_hz
)
177 u_long sclk
= get_sclk();
178 u16 spi_baud
= (sclk
/ (2 * speed_hz
));
180 if ((sclk
% (2 * speed_hz
)) > 0)
186 static int flush(struct driver_data
*drv_data
)
188 unsigned long limit
= loops_per_jiffy
<< 1;
190 /* wait for stop and clear stat */
191 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
) && limit
--)
194 write_STAT(drv_data
, BIT_STAT_CLR
);
199 /* Chip select operation functions for cs_change flag */
200 static void cs_active(struct driver_data
*drv_data
, struct chip_data
*chip
)
202 u16 flag
= read_FLAG(drv_data
);
205 flag
&= ~(chip
->flag
<< 8);
207 write_FLAG(drv_data
, flag
);
210 static void cs_deactive(struct driver_data
*drv_data
, struct chip_data
*chip
)
212 u16 flag
= read_FLAG(drv_data
);
214 flag
|= (chip
->flag
<< 8);
216 write_FLAG(drv_data
, flag
);
218 /* Move delay here for consistency */
219 if (chip
->cs_chg_udelay
)
220 udelay(chip
->cs_chg_udelay
);
223 #define MAX_SPI_SSEL 7
225 /* stop controller and re-config current chip*/
226 static int restore_state(struct driver_data
*drv_data
)
228 struct chip_data
*chip
= drv_data
->cur_chip
;
231 /* Clear status and disable clock */
232 write_STAT(drv_data
, BIT_STAT_CLR
);
233 bfin_spi_disable(drv_data
);
234 dev_dbg(&drv_data
->pdev
->dev
, "restoring spi ctl state\n");
236 /* Load the registers */
237 write_BAUD(drv_data
, chip
->baud
);
238 chip
->ctl_reg
&= (~BIT_CTL_TIMOD
);
239 chip
->ctl_reg
|= (chip
->width
<< 8);
240 write_CTRL(drv_data
, chip
->ctl_reg
);
242 bfin_spi_enable(drv_data
);
243 cs_active(drv_data
, chip
);
246 dev_dbg(&drv_data
->pdev
->dev
,
247 ": request chip select number %d failed\n",
248 chip
->chip_select_num
);
253 /* used to kick off transfer in rx mode */
254 static unsigned short dummy_read(struct driver_data
*drv_data
)
257 tmp
= read_RDBR(drv_data
);
261 static void null_writer(struct driver_data
*drv_data
)
263 u8 n_bytes
= drv_data
->n_bytes
;
265 while (drv_data
->tx
< drv_data
->tx_end
) {
266 write_TDBR(drv_data
, 0);
267 while ((read_STAT(drv_data
) & BIT_STAT_TXS
))
269 drv_data
->tx
+= n_bytes
;
273 static void null_reader(struct driver_data
*drv_data
)
275 u8 n_bytes
= drv_data
->n_bytes
;
276 dummy_read(drv_data
);
278 while (drv_data
->rx
< drv_data
->rx_end
) {
279 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
281 dummy_read(drv_data
);
282 drv_data
->rx
+= n_bytes
;
286 static void u8_writer(struct driver_data
*drv_data
)
288 dev_dbg(&drv_data
->pdev
->dev
,
289 "cr8-s is 0x%x\n", read_STAT(drv_data
));
291 /* poll for SPI completion before start */
292 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
295 while (drv_data
->tx
< drv_data
->tx_end
) {
296 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
297 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
303 static void u8_cs_chg_writer(struct driver_data
*drv_data
)
305 struct chip_data
*chip
= drv_data
->cur_chip
;
307 /* poll for SPI completion before start */
308 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
311 while (drv_data
->tx
< drv_data
->tx_end
) {
312 cs_active(drv_data
, chip
);
314 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
315 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
318 cs_deactive(drv_data
, chip
);
324 static void u8_reader(struct driver_data
*drv_data
)
326 dev_dbg(&drv_data
->pdev
->dev
,
327 "cr-8 is 0x%x\n", read_STAT(drv_data
));
329 /* poll for SPI completion before start */
330 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
333 /* clear TDBR buffer before read(else it will be shifted out) */
334 write_TDBR(drv_data
, 0xFFFF);
336 dummy_read(drv_data
);
338 while (drv_data
->rx
< drv_data
->rx_end
- 1) {
339 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
341 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
345 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
347 *(u8
*) (drv_data
->rx
) = read_SHAW(drv_data
);
351 static void u8_cs_chg_reader(struct driver_data
*drv_data
)
353 struct chip_data
*chip
= drv_data
->cur_chip
;
355 /* poll for SPI completion before start */
356 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
359 /* clear TDBR buffer before read(else it will be shifted out) */
360 write_TDBR(drv_data
, 0xFFFF);
362 cs_active(drv_data
, chip
);
363 dummy_read(drv_data
);
365 while (drv_data
->rx
< drv_data
->rx_end
- 1) {
366 cs_deactive(drv_data
, chip
);
368 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
370 cs_active(drv_data
, chip
);
371 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
374 cs_deactive(drv_data
, chip
);
376 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
378 *(u8
*) (drv_data
->rx
) = read_SHAW(drv_data
);
382 static void u8_duplex(struct driver_data
*drv_data
)
384 /* poll for SPI completion before start */
385 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
388 /* in duplex mode, clk is triggered by writing of TDBR */
389 while (drv_data
->rx
< drv_data
->rx_end
) {
390 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
391 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
393 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
395 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
401 static void u8_cs_chg_duplex(struct driver_data
*drv_data
)
403 struct chip_data
*chip
= drv_data
->cur_chip
;
405 /* poll for SPI completion before start */
406 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
409 while (drv_data
->rx
< drv_data
->rx_end
) {
410 cs_active(drv_data
, chip
);
412 write_TDBR(drv_data
, (*(u8
*) (drv_data
->tx
)));
413 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
415 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
417 *(u8
*) (drv_data
->rx
) = read_RDBR(drv_data
);
419 cs_deactive(drv_data
, chip
);
426 static void u16_writer(struct driver_data
*drv_data
)
428 dev_dbg(&drv_data
->pdev
->dev
,
429 "cr16 is 0x%x\n", read_STAT(drv_data
));
431 /* poll for SPI completion before start */
432 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
435 while (drv_data
->tx
< drv_data
->tx_end
) {
436 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
437 while ((read_STAT(drv_data
) & BIT_STAT_TXS
))
443 static void u16_cs_chg_writer(struct driver_data
*drv_data
)
445 struct chip_data
*chip
= drv_data
->cur_chip
;
447 /* poll for SPI completion before start */
448 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
451 while (drv_data
->tx
< drv_data
->tx_end
) {
452 cs_active(drv_data
, chip
);
454 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
455 while ((read_STAT(drv_data
) & BIT_STAT_TXS
))
458 cs_deactive(drv_data
, chip
);
464 static void u16_reader(struct driver_data
*drv_data
)
466 dev_dbg(&drv_data
->pdev
->dev
,
467 "cr-16 is 0x%x\n", read_STAT(drv_data
));
469 /* poll for SPI completion before start */
470 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
473 /* clear TDBR buffer before read(else it will be shifted out) */
474 write_TDBR(drv_data
, 0xFFFF);
476 dummy_read(drv_data
);
478 while (drv_data
->rx
< (drv_data
->rx_end
- 2)) {
479 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
481 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
485 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
487 *(u16
*) (drv_data
->rx
) = read_SHAW(drv_data
);
491 static void u16_cs_chg_reader(struct driver_data
*drv_data
)
493 struct chip_data
*chip
= drv_data
->cur_chip
;
495 /* poll for SPI completion before start */
496 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
499 /* clear TDBR buffer before read(else it will be shifted out) */
500 write_TDBR(drv_data
, 0xFFFF);
502 cs_active(drv_data
, chip
);
503 dummy_read(drv_data
);
505 while (drv_data
->rx
< drv_data
->rx_end
- 2) {
506 cs_deactive(drv_data
, chip
);
508 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
510 cs_active(drv_data
, chip
);
511 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
514 cs_deactive(drv_data
, chip
);
516 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
518 *(u16
*) (drv_data
->rx
) = read_SHAW(drv_data
);
522 static void u16_duplex(struct driver_data
*drv_data
)
524 /* poll for SPI completion before start */
525 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
528 /* in duplex mode, clk is triggered by writing of TDBR */
529 while (drv_data
->tx
< drv_data
->tx_end
) {
530 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
531 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
533 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
535 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
541 static void u16_cs_chg_duplex(struct driver_data
*drv_data
)
543 struct chip_data
*chip
= drv_data
->cur_chip
;
545 /* poll for SPI completion before start */
546 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
549 while (drv_data
->tx
< drv_data
->tx_end
) {
550 cs_active(drv_data
, chip
);
552 write_TDBR(drv_data
, (*(u16
*) (drv_data
->tx
)));
553 while (read_STAT(drv_data
) & BIT_STAT_TXS
)
555 while (!(read_STAT(drv_data
) & BIT_STAT_RXS
))
557 *(u16
*) (drv_data
->rx
) = read_RDBR(drv_data
);
559 cs_deactive(drv_data
, chip
);
566 /* test if ther is more transfer to be done */
567 static void *next_transfer(struct driver_data
*drv_data
)
569 struct spi_message
*msg
= drv_data
->cur_msg
;
570 struct spi_transfer
*trans
= drv_data
->cur_transfer
;
572 /* Move to next transfer */
573 if (trans
->transfer_list
.next
!= &msg
->transfers
) {
574 drv_data
->cur_transfer
=
575 list_entry(trans
->transfer_list
.next
,
576 struct spi_transfer
, transfer_list
);
577 return RUNNING_STATE
;
583 * caller already set message->status;
584 * dma and pio irqs are blocked give finished message back
586 static void giveback(struct driver_data
*drv_data
)
588 struct chip_data
*chip
= drv_data
->cur_chip
;
589 struct spi_transfer
*last_transfer
;
591 struct spi_message
*msg
;
593 spin_lock_irqsave(&drv_data
->lock
, flags
);
594 msg
= drv_data
->cur_msg
;
595 drv_data
->cur_msg
= NULL
;
596 drv_data
->cur_transfer
= NULL
;
597 drv_data
->cur_chip
= NULL
;
598 queue_work(drv_data
->workqueue
, &drv_data
->pump_messages
);
599 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
601 last_transfer
= list_entry(msg
->transfers
.prev
,
602 struct spi_transfer
, transfer_list
);
606 /* disable chip select signal. And not stop spi in autobuffer mode */
607 if (drv_data
->tx_dma
!= 0xFFFF) {
608 cs_deactive(drv_data
, chip
);
609 bfin_spi_disable(drv_data
);
612 if (!drv_data
->cs_change
)
613 cs_deactive(drv_data
, chip
);
616 msg
->complete(msg
->context
);
619 static irqreturn_t
dma_irq_handler(int irq
, void *dev_id
)
621 struct driver_data
*drv_data
= (struct driver_data
*)dev_id
;
622 struct chip_data
*chip
= drv_data
->cur_chip
;
623 struct spi_message
*msg
= drv_data
->cur_msg
;
625 dev_dbg(&drv_data
->pdev
->dev
, "in dma_irq_handler\n");
626 clear_dma_irqstat(drv_data
->dma_channel
);
628 /* Wait for DMA to complete */
629 while (get_dma_curr_irqstat(drv_data
->dma_channel
) & DMA_RUN
)
633 * wait for the last transaction shifted out. HRM states:
634 * at this point there may still be data in the SPI DMA FIFO waiting
635 * to be transmitted ... software needs to poll TXS in the SPI_STAT
636 * register until it goes low for 2 successive reads
638 if (drv_data
->tx
!= NULL
) {
639 while ((read_STAT(drv_data
) & TXS
) ||
640 (read_STAT(drv_data
) & TXS
))
644 while (!(read_STAT(drv_data
) & SPIF
))
647 msg
->actual_length
+= drv_data
->len_in_bytes
;
649 if (drv_data
->cs_change
)
650 cs_deactive(drv_data
, chip
);
652 /* Move to next transfer */
653 msg
->state
= next_transfer(drv_data
);
655 /* Schedule transfer tasklet */
656 tasklet_schedule(&drv_data
->pump_transfers
);
658 /* free the irq handler before next transfer */
659 dev_dbg(&drv_data
->pdev
->dev
,
660 "disable dma channel irq%d\n",
661 drv_data
->dma_channel
);
662 dma_disable_irq(drv_data
->dma_channel
);
667 static void pump_transfers(unsigned long data
)
669 struct driver_data
*drv_data
= (struct driver_data
*)data
;
670 struct spi_message
*message
= NULL
;
671 struct spi_transfer
*transfer
= NULL
;
672 struct spi_transfer
*previous
= NULL
;
673 struct chip_data
*chip
= NULL
;
675 u16 cr
, dma_width
, dma_config
;
676 u32 tranf_success
= 1;
678 /* Get current state information */
679 message
= drv_data
->cur_msg
;
680 transfer
= drv_data
->cur_transfer
;
681 chip
= drv_data
->cur_chip
;
683 * if msg is error or done, report it back using complete() callback
686 /* Handle for abort */
687 if (message
->state
== ERROR_STATE
) {
688 message
->status
= -EIO
;
693 /* Handle end of message */
694 if (message
->state
== DONE_STATE
) {
700 /* Delay if requested at end of transfer */
701 if (message
->state
== RUNNING_STATE
) {
702 previous
= list_entry(transfer
->transfer_list
.prev
,
703 struct spi_transfer
, transfer_list
);
704 if (previous
->delay_usecs
)
705 udelay(previous
->delay_usecs
);
708 /* Setup the transfer state based on the type of transfer */
709 if (flush(drv_data
) == 0) {
710 dev_err(&drv_data
->pdev
->dev
, "pump_transfers: flush failed\n");
711 message
->status
= -EIO
;
716 if (transfer
->tx_buf
!= NULL
) {
717 drv_data
->tx
= (void *)transfer
->tx_buf
;
718 drv_data
->tx_end
= drv_data
->tx
+ transfer
->len
;
719 dev_dbg(&drv_data
->pdev
->dev
, "tx_buf is %p, tx_end is %p\n",
720 transfer
->tx_buf
, drv_data
->tx_end
);
725 if (transfer
->rx_buf
!= NULL
) {
726 drv_data
->rx
= transfer
->rx_buf
;
727 drv_data
->rx_end
= drv_data
->rx
+ transfer
->len
;
728 dev_dbg(&drv_data
->pdev
->dev
, "rx_buf is %p, rx_end is %p\n",
729 transfer
->rx_buf
, drv_data
->rx_end
);
734 drv_data
->rx_dma
= transfer
->rx_dma
;
735 drv_data
->tx_dma
= transfer
->tx_dma
;
736 drv_data
->len_in_bytes
= transfer
->len
;
737 drv_data
->cs_change
= transfer
->cs_change
;
740 if (width
== CFG_SPI_WORDSIZE16
) {
741 drv_data
->len
= (transfer
->len
) >> 1;
743 drv_data
->len
= transfer
->len
;
745 drv_data
->write
= drv_data
->tx
? chip
->write
: null_writer
;
746 drv_data
->read
= drv_data
->rx
? chip
->read
: null_reader
;
747 drv_data
->duplex
= chip
->duplex
? chip
->duplex
: null_writer
;
748 dev_dbg(&drv_data
->pdev
->dev
, "transfer: ",
749 "drv_data->write is %p, chip->write is %p, null_wr is %p\n",
750 drv_data
->write
, chip
->write
, null_writer
);
752 /* speed and width has been set on per message */
753 message
->state
= RUNNING_STATE
;
756 write_STAT(drv_data
, BIT_STAT_CLR
);
757 cr
= (read_CTRL(drv_data
) & (~BIT_CTL_TIMOD
));
758 cs_active(drv_data
, chip
);
760 dev_dbg(&drv_data
->pdev
->dev
,
761 "now pumping a transfer: width is %d, len is %d\n",
762 width
, transfer
->len
);
765 * Try to map dma buffer and do a dma transfer if
766 * successful use different way to r/w according to
767 * drv_data->cur_chip->enable_dma
769 if (drv_data
->cur_chip
->enable_dma
&& drv_data
->len
> 6) {
771 disable_dma(drv_data
->dma_channel
);
772 clear_dma_irqstat(drv_data
->dma_channel
);
773 bfin_spi_disable(drv_data
);
775 /* config dma channel */
776 dev_dbg(&drv_data
->pdev
->dev
, "doing dma transfer\n");
777 if (width
== CFG_SPI_WORDSIZE16
) {
778 set_dma_x_count(drv_data
->dma_channel
, drv_data
->len
);
779 set_dma_x_modify(drv_data
->dma_channel
, 2);
780 dma_width
= WDSIZE_16
;
782 set_dma_x_count(drv_data
->dma_channel
, drv_data
->len
);
783 set_dma_x_modify(drv_data
->dma_channel
, 1);
784 dma_width
= WDSIZE_8
;
787 /* poll for SPI completion before start */
788 while (!(read_STAT(drv_data
) & BIT_STAT_SPIF
))
791 /* dirty hack for autobuffer DMA mode */
792 if (drv_data
->tx_dma
== 0xFFFF) {
793 dev_dbg(&drv_data
->pdev
->dev
,
794 "doing autobuffer DMA out.\n");
796 /* no irq in autobuffer mode */
798 (DMAFLOW_AUTO
| RESTART
| dma_width
| DI_EN
);
799 set_dma_config(drv_data
->dma_channel
, dma_config
);
800 set_dma_start_addr(drv_data
->dma_channel
,
801 (unsigned long)drv_data
->tx
);
802 enable_dma(drv_data
->dma_channel
);
804 /* start SPI transfer */
806 (cr
| CFG_SPI_DMAWRITE
| BIT_CTL_ENABLE
));
808 /* just return here, there can only be one transfer
816 /* In dma mode, rx or tx must be NULL in one transfer */
817 if (drv_data
->rx
!= NULL
) {
818 /* set transfer mode, and enable SPI */
819 dev_dbg(&drv_data
->pdev
->dev
, "doing DMA in.\n");
821 /* clear tx reg soformer data is not shifted out */
822 write_TDBR(drv_data
, 0xFFFF);
824 set_dma_x_count(drv_data
->dma_channel
, drv_data
->len
);
827 dma_enable_irq(drv_data
->dma_channel
);
828 dma_config
= (WNR
| RESTART
| dma_width
| DI_EN
);
829 set_dma_config(drv_data
->dma_channel
, dma_config
);
830 set_dma_start_addr(drv_data
->dma_channel
,
831 (unsigned long)drv_data
->rx
);
832 enable_dma(drv_data
->dma_channel
);
834 /* start SPI transfer */
836 (cr
| CFG_SPI_DMAREAD
| BIT_CTL_ENABLE
));
838 } else if (drv_data
->tx
!= NULL
) {
839 dev_dbg(&drv_data
->pdev
->dev
, "doing DMA out.\n");
842 dma_enable_irq(drv_data
->dma_channel
);
843 dma_config
= (RESTART
| dma_width
| DI_EN
);
844 set_dma_config(drv_data
->dma_channel
, dma_config
);
845 set_dma_start_addr(drv_data
->dma_channel
,
846 (unsigned long)drv_data
->tx
);
847 enable_dma(drv_data
->dma_channel
);
849 /* start SPI transfer */
851 (cr
| CFG_SPI_DMAWRITE
| BIT_CTL_ENABLE
));
854 /* IO mode write then read */
855 dev_dbg(&drv_data
->pdev
->dev
, "doing IO transfer\n");
857 if (drv_data
->tx
!= NULL
&& drv_data
->rx
!= NULL
) {
858 /* full duplex mode */
859 BUG_ON((drv_data
->tx_end
- drv_data
->tx
) !=
860 (drv_data
->rx_end
- drv_data
->rx
));
861 dev_dbg(&drv_data
->pdev
->dev
,
862 "IO duplex: cr is 0x%x\n", cr
);
864 /* set SPI transfer mode */
865 write_CTRL(drv_data
, (cr
| CFG_SPI_WRITE
));
867 drv_data
->duplex(drv_data
);
869 if (drv_data
->tx
!= drv_data
->tx_end
)
871 } else if (drv_data
->tx
!= NULL
) {
872 /* write only half duplex */
873 dev_dbg(&drv_data
->pdev
->dev
,
874 "IO write: cr is 0x%x\n", cr
);
876 /* set SPI transfer mode */
877 write_CTRL(drv_data
, (cr
| CFG_SPI_WRITE
));
879 drv_data
->write(drv_data
);
881 if (drv_data
->tx
!= drv_data
->tx_end
)
883 } else if (drv_data
->rx
!= NULL
) {
884 /* read only half duplex */
885 dev_dbg(&drv_data
->pdev
->dev
,
886 "IO read: cr is 0x%x\n", cr
);
888 /* set SPI transfer mode */
889 write_CTRL(drv_data
, (cr
| CFG_SPI_READ
));
891 drv_data
->read(drv_data
);
892 if (drv_data
->rx
!= drv_data
->rx_end
)
896 if (!tranf_success
) {
897 dev_dbg(&drv_data
->pdev
->dev
,
898 "IO write error!\n");
899 message
->state
= ERROR_STATE
;
901 /* Update total byte transfered */
902 message
->actual_length
+= drv_data
->len
;
904 /* Move to next transfer of this msg */
905 message
->state
= next_transfer(drv_data
);
908 /* Schedule next transfer tasklet */
909 tasklet_schedule(&drv_data
->pump_transfers
);
914 /* pop a msg from queue and kick off real transfer */
915 static void pump_messages(struct work_struct
*work
)
917 struct driver_data
*drv_data
;
920 drv_data
= container_of(work
, struct driver_data
, pump_messages
);
922 /* Lock queue and check for queue work */
923 spin_lock_irqsave(&drv_data
->lock
, flags
);
924 if (list_empty(&drv_data
->queue
) || drv_data
->run
== QUEUE_STOPPED
) {
925 /* pumper kicked off but no work to do */
927 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
931 /* Make sure we are not already running a message */
932 if (drv_data
->cur_msg
) {
933 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
937 /* Extract head of queue */
938 drv_data
->cur_msg
= list_entry(drv_data
->queue
.next
,
939 struct spi_message
, queue
);
941 /* Setup the SSP using the per chip configuration */
942 drv_data
->cur_chip
= spi_get_ctldata(drv_data
->cur_msg
->spi
);
943 if (restore_state(drv_data
)) {
944 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
948 list_del_init(&drv_data
->cur_msg
->queue
);
950 /* Initial message state */
951 drv_data
->cur_msg
->state
= START_STATE
;
952 drv_data
->cur_transfer
= list_entry(drv_data
->cur_msg
->transfers
.next
,
953 struct spi_transfer
, transfer_list
);
955 dev_dbg(&drv_data
->pdev
->dev
, "got a message to pump, "
956 "state is set to: baud %d, flag 0x%x, ctl 0x%x\n",
957 drv_data
->cur_chip
->baud
, drv_data
->cur_chip
->flag
,
958 drv_data
->cur_chip
->ctl_reg
);
960 dev_dbg(&drv_data
->pdev
->dev
,
961 "the first transfer len is %d\n",
962 drv_data
->cur_transfer
->len
);
964 /* Mark as busy and launch transfers */
965 tasklet_schedule(&drv_data
->pump_transfers
);
968 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
972 * got a msg to transfer, queue it in drv_data->queue.
973 * And kick off message pumper
975 static int transfer(struct spi_device
*spi
, struct spi_message
*msg
)
977 struct driver_data
*drv_data
= spi_master_get_devdata(spi
->master
);
980 spin_lock_irqsave(&drv_data
->lock
, flags
);
982 if (drv_data
->run
== QUEUE_STOPPED
) {
983 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
987 msg
->actual_length
= 0;
988 msg
->status
= -EINPROGRESS
;
989 msg
->state
= START_STATE
;
991 dev_dbg(&spi
->dev
, "adding an msg in transfer() \n");
992 list_add_tail(&msg
->queue
, &drv_data
->queue
);
994 if (drv_data
->run
== QUEUE_RUNNING
&& !drv_data
->busy
)
995 queue_work(drv_data
->workqueue
, &drv_data
->pump_messages
);
997 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1002 #define MAX_SPI_SSEL 7
1004 static u16 ssel
[3][MAX_SPI_SSEL
] = {
1005 {P_SPI0_SSEL1
, P_SPI0_SSEL2
, P_SPI0_SSEL3
,
1006 P_SPI0_SSEL4
, P_SPI0_SSEL5
,
1007 P_SPI0_SSEL6
, P_SPI0_SSEL7
},
1009 {P_SPI1_SSEL1
, P_SPI1_SSEL2
, P_SPI1_SSEL3
,
1010 P_SPI1_SSEL4
, P_SPI1_SSEL5
,
1011 P_SPI1_SSEL6
, P_SPI1_SSEL7
},
1013 {P_SPI2_SSEL1
, P_SPI2_SSEL2
, P_SPI2_SSEL3
,
1014 P_SPI2_SSEL4
, P_SPI2_SSEL5
,
1015 P_SPI2_SSEL6
, P_SPI2_SSEL7
},
1018 /* first setup for new devices */
1019 static int setup(struct spi_device
*spi
)
1021 struct bfin5xx_spi_chip
*chip_info
= NULL
;
1022 struct chip_data
*chip
;
1023 struct driver_data
*drv_data
= spi_master_get_devdata(spi
->master
);
1026 /* Abort device setup if requested features are not supported */
1027 if (spi
->mode
& ~(SPI_CPOL
| SPI_CPHA
| SPI_LSB_FIRST
)) {
1028 dev_err(&spi
->dev
, "requested mode not fully supported\n");
1032 /* Zero (the default) here means 8 bits */
1033 if (!spi
->bits_per_word
)
1034 spi
->bits_per_word
= 8;
1036 if (spi
->bits_per_word
!= 8 && spi
->bits_per_word
!= 16)
1039 /* Only alloc (or use chip_info) on first setup */
1040 chip
= spi_get_ctldata(spi
);
1042 chip
= kzalloc(sizeof(struct chip_data
), GFP_KERNEL
);
1046 chip
->enable_dma
= 0;
1047 chip_info
= spi
->controller_data
;
1050 /* chip_info isn't always needed */
1052 /* Make sure people stop trying to set fields via ctl_reg
1053 * when they should actually be using common SPI framework.
1054 * Currently we let through: WOM EMISO PSSE GM SZ TIMOD.
1055 * Not sure if a user actually needs/uses any of these,
1056 * but let's assume (for now) they do.
1058 if (chip_info
->ctl_reg
& (SPE
|MSTR
|CPOL
|CPHA
|LSBF
|SIZE
)) {
1059 dev_err(&spi
->dev
, "do not set bits in ctl_reg "
1060 "that the SPI framework manages\n");
1064 chip
->enable_dma
= chip_info
->enable_dma
!= 0
1065 && drv_data
->master_info
->enable_dma
;
1066 chip
->ctl_reg
= chip_info
->ctl_reg
;
1067 chip
->bits_per_word
= chip_info
->bits_per_word
;
1068 chip
->cs_change_per_word
= chip_info
->cs_change_per_word
;
1069 chip
->cs_chg_udelay
= chip_info
->cs_chg_udelay
;
1072 /* translate common spi framework into our register */
1073 if (spi
->mode
& SPI_CPOL
)
1074 chip
->ctl_reg
|= CPOL
;
1075 if (spi
->mode
& SPI_CPHA
)
1076 chip
->ctl_reg
|= CPHA
;
1077 if (spi
->mode
& SPI_LSB_FIRST
)
1078 chip
->ctl_reg
|= LSBF
;
1079 /* we dont support running in slave mode (yet?) */
1080 chip
->ctl_reg
|= MSTR
;
1083 * if any one SPI chip is registered and wants DMA, request the
1084 * DMA channel for it
1086 if (chip
->enable_dma
&& !drv_data
->dma_requested
) {
1087 /* register dma irq handler */
1088 if (request_dma(drv_data
->dma_channel
, "BF53x_SPI_DMA") < 0) {
1090 "Unable to request BlackFin SPI DMA channel\n");
1093 if (set_dma_callback(drv_data
->dma_channel
,
1094 (void *)dma_irq_handler
, drv_data
) < 0) {
1095 dev_dbg(&spi
->dev
, "Unable to set dma callback\n");
1098 dma_disable_irq(drv_data
->dma_channel
);
1099 drv_data
->dma_requested
= 1;
1103 * Notice: for blackfin, the speed_hz is the value of register
1104 * SPI_BAUD, not the real baudrate
1106 chip
->baud
= hz_to_spi_baud(spi
->max_speed_hz
);
1107 spi_flg
= ~(1 << (spi
->chip_select
));
1108 chip
->flag
= ((u16
) spi_flg
<< 8) | (1 << (spi
->chip_select
));
1109 chip
->chip_select_num
= spi
->chip_select
;
1111 switch (chip
->bits_per_word
) {
1114 chip
->width
= CFG_SPI_WORDSIZE8
;
1115 chip
->read
= chip
->cs_change_per_word
?
1116 u8_cs_chg_reader
: u8_reader
;
1117 chip
->write
= chip
->cs_change_per_word
?
1118 u8_cs_chg_writer
: u8_writer
;
1119 chip
->duplex
= chip
->cs_change_per_word
?
1120 u8_cs_chg_duplex
: u8_duplex
;
1125 chip
->width
= CFG_SPI_WORDSIZE16
;
1126 chip
->read
= chip
->cs_change_per_word
?
1127 u16_cs_chg_reader
: u16_reader
;
1128 chip
->write
= chip
->cs_change_per_word
?
1129 u16_cs_chg_writer
: u16_writer
;
1130 chip
->duplex
= chip
->cs_change_per_word
?
1131 u16_cs_chg_duplex
: u16_duplex
;
1135 dev_err(&spi
->dev
, "%d bits_per_word is not supported\n",
1136 chip
->bits_per_word
);
1141 dev_dbg(&spi
->dev
, "setup spi chip %s, width is %d, dma is %d\n",
1142 spi
->modalias
, chip
->width
, chip
->enable_dma
);
1143 dev_dbg(&spi
->dev
, "ctl_reg is 0x%x, flag_reg is 0x%x\n",
1144 chip
->ctl_reg
, chip
->flag
);
1146 spi_set_ctldata(spi
, chip
);
1148 dev_dbg(&spi
->dev
, "chip select number is %d\n", chip
->chip_select_num
);
1149 if ((chip
->chip_select_num
> 0)
1150 && (chip
->chip_select_num
<= spi
->master
->num_chipselect
))
1151 peripheral_request(ssel
[spi
->master
->bus_num
]
1152 [chip
->chip_select_num
-1], DRV_NAME
);
1154 cs_deactive(drv_data
, chip
);
1160 * callback for spi framework.
1161 * clean driver specific data
1163 static void cleanup(struct spi_device
*spi
)
1165 struct chip_data
*chip
= spi_get_ctldata(spi
);
1167 if ((chip
->chip_select_num
> 0)
1168 && (chip
->chip_select_num
<= spi
->master
->num_chipselect
))
1169 peripheral_free(ssel
[spi
->master
->bus_num
]
1170 [chip
->chip_select_num
-1]);
1175 static inline int init_queue(struct driver_data
*drv_data
)
1177 INIT_LIST_HEAD(&drv_data
->queue
);
1178 spin_lock_init(&drv_data
->lock
);
1180 drv_data
->run
= QUEUE_STOPPED
;
1183 /* init transfer tasklet */
1184 tasklet_init(&drv_data
->pump_transfers
,
1185 pump_transfers
, (unsigned long)drv_data
);
1187 /* init messages workqueue */
1188 INIT_WORK(&drv_data
->pump_messages
, pump_messages
);
1189 drv_data
->workqueue
=
1190 create_singlethread_workqueue(drv_data
->master
->dev
.parent
->bus_id
);
1191 if (drv_data
->workqueue
== NULL
)
1197 static inline int start_queue(struct driver_data
*drv_data
)
1199 unsigned long flags
;
1201 spin_lock_irqsave(&drv_data
->lock
, flags
);
1203 if (drv_data
->run
== QUEUE_RUNNING
|| drv_data
->busy
) {
1204 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1208 drv_data
->run
= QUEUE_RUNNING
;
1209 drv_data
->cur_msg
= NULL
;
1210 drv_data
->cur_transfer
= NULL
;
1211 drv_data
->cur_chip
= NULL
;
1212 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1214 queue_work(drv_data
->workqueue
, &drv_data
->pump_messages
);
1219 static inline int stop_queue(struct driver_data
*drv_data
)
1221 unsigned long flags
;
1222 unsigned limit
= 500;
1225 spin_lock_irqsave(&drv_data
->lock
, flags
);
1228 * This is a bit lame, but is optimized for the common execution path.
1229 * A wait_queue on the drv_data->busy could be used, but then the common
1230 * execution path (pump_messages) would be required to call wake_up or
1231 * friends on every SPI message. Do this instead
1233 drv_data
->run
= QUEUE_STOPPED
;
1234 while (!list_empty(&drv_data
->queue
) && drv_data
->busy
&& limit
--) {
1235 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1237 spin_lock_irqsave(&drv_data
->lock
, flags
);
1240 if (!list_empty(&drv_data
->queue
) || drv_data
->busy
)
1243 spin_unlock_irqrestore(&drv_data
->lock
, flags
);
1248 static inline int destroy_queue(struct driver_data
*drv_data
)
1252 status
= stop_queue(drv_data
);
1256 destroy_workqueue(drv_data
->workqueue
);
1261 static int __init
bfin5xx_spi_probe(struct platform_device
*pdev
)
1263 struct device
*dev
= &pdev
->dev
;
1264 struct bfin5xx_spi_master
*platform_info
;
1265 struct spi_master
*master
;
1266 struct driver_data
*drv_data
= 0;
1267 struct resource
*res
;
1270 platform_info
= dev
->platform_data
;
1272 /* Allocate master with space for drv_data */
1273 master
= spi_alloc_master(dev
, sizeof(struct driver_data
) + 16);
1275 dev_err(&pdev
->dev
, "can not alloc spi_master\n");
1279 drv_data
= spi_master_get_devdata(master
);
1280 drv_data
->master
= master
;
1281 drv_data
->master_info
= platform_info
;
1282 drv_data
->pdev
= pdev
;
1283 drv_data
->pin_req
= platform_info
->pin_req
;
1285 master
->bus_num
= pdev
->id
;
1286 master
->num_chipselect
= platform_info
->num_chipselect
;
1287 master
->cleanup
= cleanup
;
1288 master
->setup
= setup
;
1289 master
->transfer
= transfer
;
1291 /* Find and map our resources */
1292 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1294 dev_err(dev
, "Cannot get IORESOURCE_MEM\n");
1296 goto out_error_get_res
;
1299 drv_data
->regs_base
= ioremap(res
->start
, (res
->end
- res
->start
+ 1));
1300 if (drv_data
->regs_base
== NULL
) {
1301 dev_err(dev
, "Cannot map IO\n");
1303 goto out_error_ioremap
;
1306 drv_data
->dma_channel
= platform_get_irq(pdev
, 0);
1307 if (drv_data
->dma_channel
< 0) {
1308 dev_err(dev
, "No DMA channel specified\n");
1310 goto out_error_no_dma_ch
;
1313 /* Initial and start queue */
1314 status
= init_queue(drv_data
);
1316 dev_err(dev
, "problem initializing queue\n");
1317 goto out_error_queue_alloc
;
1320 status
= start_queue(drv_data
);
1322 dev_err(dev
, "problem starting queue\n");
1323 goto out_error_queue_alloc
;
1326 /* Register with the SPI framework */
1327 platform_set_drvdata(pdev
, drv_data
);
1328 status
= spi_register_master(master
);
1330 dev_err(dev
, "problem registering spi master\n");
1331 goto out_error_queue_alloc
;
1334 status
= peripheral_request_list(drv_data
->pin_req
, DRV_NAME
);
1336 dev_err(&pdev
->dev
, ": Requesting Peripherals failed\n");
1340 dev_info(dev
, "%s, Version %s, regs_base@%p, dma channel@%d\n",
1341 DRV_DESC
, DRV_VERSION
, drv_data
->regs_base
,
1342 drv_data
->dma_channel
);
1345 out_error_queue_alloc
:
1346 destroy_queue(drv_data
);
1347 out_error_no_dma_ch
:
1348 iounmap((void *) drv_data
->regs_base
);
1352 spi_master_put(master
);
1357 /* stop hardware and remove the driver */
1358 static int __devexit
bfin5xx_spi_remove(struct platform_device
*pdev
)
1360 struct driver_data
*drv_data
= platform_get_drvdata(pdev
);
1366 /* Remove the queue */
1367 status
= destroy_queue(drv_data
);
1371 /* Disable the SSP at the peripheral and SOC level */
1372 bfin_spi_disable(drv_data
);
1375 if (drv_data
->master_info
->enable_dma
) {
1376 if (dma_channel_active(drv_data
->dma_channel
))
1377 free_dma(drv_data
->dma_channel
);
1380 /* Disconnect from the SPI framework */
1381 spi_unregister_master(drv_data
->master
);
1383 peripheral_free_list(drv_data
->pin_req
);
1385 /* Prevent double remove */
1386 platform_set_drvdata(pdev
, NULL
);
1392 static int bfin5xx_spi_suspend(struct platform_device
*pdev
, pm_message_t state
)
1394 struct driver_data
*drv_data
= platform_get_drvdata(pdev
);
1397 status
= stop_queue(drv_data
);
1402 bfin_spi_disable(drv_data
);
1407 static int bfin5xx_spi_resume(struct platform_device
*pdev
)
1409 struct driver_data
*drv_data
= platform_get_drvdata(pdev
);
1412 /* Enable the SPI interface */
1413 bfin_spi_enable(drv_data
);
1415 /* Start the queue running */
1416 status
= start_queue(drv_data
);
1418 dev_err(&pdev
->dev
, "problem starting queue (%d)\n", status
);
1425 #define bfin5xx_spi_suspend NULL
1426 #define bfin5xx_spi_resume NULL
1427 #endif /* CONFIG_PM */
1429 MODULE_ALIAS("bfin-spi-master"); /* for platform bus hotplug */
1430 static struct platform_driver bfin5xx_spi_driver
= {
1433 .owner
= THIS_MODULE
,
1435 .suspend
= bfin5xx_spi_suspend
,
1436 .resume
= bfin5xx_spi_resume
,
1437 .remove
= __devexit_p(bfin5xx_spi_remove
),
1440 static int __init
bfin5xx_spi_init(void)
1442 return platform_driver_probe(&bfin5xx_spi_driver
, bfin5xx_spi_probe
);
1444 module_init(bfin5xx_spi_init
);
1446 static void __exit
bfin5xx_spi_exit(void)
1448 platform_driver_unregister(&bfin5xx_spi_driver
);
1450 module_exit(bfin5xx_spi_exit
);