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 static u32 spi_dma_ch;
67 static u32 spi_regs_base;
69 #define DEFINE_SPI_REG(reg, off) \
70 static inline u16 read_##reg(void) \
71 { return bfin_read16(spi_regs_base + off); } \
72 static inline void write_##reg(u16 v) \
73 {bfin_write16(spi_regs_base + off, v); }
75 DEFINE_SPI_REG(CTRL, 0x00)
76 DEFINE_SPI_REG(FLAG, 0x04)
77 DEFINE_SPI_REG(STAT, 0x08)
78 DEFINE_SPI_REG(TDBR, 0x0C)
79 DEFINE_SPI_REG(RDBR, 0x10)
80 DEFINE_SPI_REG(BAUD, 0x14)
81 DEFINE_SPI_REG(SHAW, 0x18)
82 #define START_STATE ((void*)0)
83 #define RUNNING_STATE ((void*)1)
84 #define DONE_STATE ((void*)2)
85 #define ERROR_STATE ((void*)-1)
86 #define QUEUE_RUNNING 0
87 #define QUEUE_STOPPED 1
91 /* Driver model hookup */
92 struct platform_device *pdev;
94 /* SPI framework hookup */
95 struct spi_master *master;
98 struct bfin5xx_spi_master *master_info;
100 /* Driver message queue */
101 struct workqueue_struct *workqueue;
102 struct work_struct pump_messages;
104 struct list_head queue;
108 /* Message Transfer pump */
109 struct tasklet_struct pump_transfers;
111 /* Current message transfer state info */
112 struct spi_message *cur_msg;
113 struct spi_transfer *cur_transfer;
114 struct chip_data *cur_chip;
128 void (*write) (struct driver_data *);
129 void (*read) (struct driver_data *);
130 void (*duplex) (struct driver_data *);
139 u8 chip_select_requested;
141 u8 width; /* 0 or 1 */
143 u8 bits_per_word; /* 8 or 16 */
144 u8 cs_change_per_word;
146 void (*write) (struct driver_data *);
147 void (*read) (struct driver_data *);
148 void (*duplex) (struct driver_data *);
151 static void bfin_spi_enable(struct driver_data *drv_data)
156 write_CTRL(cr | BIT_CTL_ENABLE);
159 static void bfin_spi_disable(struct driver_data *drv_data)
164 write_CTRL(cr & (~BIT_CTL_ENABLE));
167 /* Caculate the SPI_BAUD register value based on input HZ */
168 static u16 hz_to_spi_baud(u32 speed_hz)
170 u_long sclk = get_sclk();
171 u16 spi_baud = (sclk / (2 * speed_hz));
173 if ((sclk % (2 * speed_hz)) > 0)
179 static int flush(struct driver_data *drv_data)
181 unsigned long limit = loops_per_jiffy << 1;
183 /* wait for stop and clear stat */
184 while (!(read_STAT() & BIT_STAT_SPIF) && limit--)
187 write_STAT(BIT_STAT_CLR);
192 /* Chip select operation functions for cs_change flag */
193 static void cs_active(struct chip_data *chip)
195 u16 flag = read_FLAG();
198 flag &= ~(chip->flag << 8);
203 static void cs_deactive(struct chip_data *chip)
205 u16 flag = read_FLAG();
207 flag |= (chip->flag << 8);
212 #define MAX_SPI_SSEL 7
214 /* stop controller and re-config current chip*/
215 static int restore_state(struct driver_data *drv_data)
217 struct chip_data *chip = drv_data->cur_chip;
219 u16 ssel[3][MAX_SPI_SSEL] = {
220 {P_SPI0_SSEL1, P_SPI0_SSEL2, P_SPI0_SSEL3,
221 P_SPI0_SSEL4, P_SPI0_SSEL5,
222 P_SPI0_SSEL6, P_SPI0_SSEL7},
224 {P_SPI1_SSEL1, P_SPI1_SSEL2, P_SPI1_SSEL3,
225 P_SPI1_SSEL4, P_SPI1_SSEL5,
226 P_SPI1_SSEL6, P_SPI1_SSEL7},
228 {P_SPI2_SSEL1, P_SPI2_SSEL2, P_SPI2_SSEL3,
229 P_SPI2_SSEL4, P_SPI2_SSEL5,
230 P_SPI2_SSEL6, P_SPI2_SSEL7},
232 /* Clear status and disable clock */
233 write_STAT(BIT_STAT_CLR);
234 bfin_spi_disable(drv_data);
235 dev_dbg(&drv_data->pdev->dev, "restoring spi ctl state\n");
237 /* Load the registers */
238 write_CTRL(chip->ctl_reg);
239 write_BAUD(chip->baud);
242 if (!chip->chip_select_requested) {
243 int i = chip->chip_select_num;
245 dev_dbg(&drv_data->pdev->dev, "chip select number is %d\n", i);
246 if ((i > 0) && (i <= MAX_SPI_SSEL))
247 ret = peripheral_request(
248 ssel[drv_data->master->bus_num][i-1], DRV_NAME);
250 chip->chip_select_requested = 1;
254 dev_dbg(&drv_data->pdev->dev,
255 ": request chip select number %d failed\n",
256 chip->chip_select_num);
261 /* used to kick off transfer in rx mode */
262 static unsigned short dummy_read(void)
269 static void null_writer(struct driver_data *drv_data)
271 u8 n_bytes = drv_data->n_bytes;
273 while (drv_data->tx < drv_data->tx_end) {
275 while ((read_STAT() & BIT_STAT_TXS))
277 drv_data->tx += n_bytes;
281 static void null_reader(struct driver_data *drv_data)
283 u8 n_bytes = drv_data->n_bytes;
286 while (drv_data->rx < drv_data->rx_end) {
287 while (!(read_STAT() & BIT_STAT_RXS))
290 drv_data->rx += n_bytes;
294 static void u8_writer(struct driver_data *drv_data)
296 dev_dbg(&drv_data->pdev->dev,
297 "cr8-s is 0x%x\n", read_STAT());
298 while (drv_data->tx < drv_data->tx_end) {
299 write_TDBR(*(u8 *) (drv_data->tx));
300 while (read_STAT() & BIT_STAT_TXS)
305 /* poll for SPI completion before returning */
306 while (!(read_STAT() & BIT_STAT_SPIF))
310 static void u8_cs_chg_writer(struct driver_data *drv_data)
312 struct chip_data *chip = drv_data->cur_chip;
314 while (drv_data->tx < drv_data->tx_end) {
317 write_TDBR(*(u8 *) (drv_data->tx));
318 while (read_STAT() & BIT_STAT_TXS)
320 while (!(read_STAT() & BIT_STAT_SPIF))
324 if (chip->cs_chg_udelay)
325 udelay(chip->cs_chg_udelay);
332 static void u8_reader(struct driver_data *drv_data)
334 dev_dbg(&drv_data->pdev->dev,
335 "cr-8 is 0x%x\n", read_STAT());
337 /* clear TDBR buffer before read(else it will be shifted out) */
341 while (drv_data->rx < drv_data->rx_end - 1) {
342 while (!(read_STAT() & BIT_STAT_RXS))
344 *(u8 *) (drv_data->rx) = read_RDBR();
348 while (!(read_STAT() & BIT_STAT_RXS))
350 *(u8 *) (drv_data->rx) = read_SHAW();
354 static void u8_cs_chg_reader(struct driver_data *drv_data)
356 struct chip_data *chip = drv_data->cur_chip;
358 while (drv_data->rx < drv_data->rx_end) {
361 read_RDBR(); /* kick off */
362 while (!(read_STAT() & BIT_STAT_RXS))
364 while (!(read_STAT() & BIT_STAT_SPIF))
366 *(u8 *) (drv_data->rx) = read_SHAW();
369 if (chip->cs_chg_udelay)
370 udelay(chip->cs_chg_udelay);
377 static void u8_duplex(struct driver_data *drv_data)
379 /* in duplex mode, clk is triggered by writing of TDBR */
380 while (drv_data->rx < drv_data->rx_end) {
381 write_TDBR(*(u8 *) (drv_data->tx));
382 while (!(read_STAT() & BIT_STAT_SPIF))
384 while (!(read_STAT() & BIT_STAT_RXS))
386 *(u8 *) (drv_data->rx) = read_RDBR();
392 static void u8_cs_chg_duplex(struct driver_data *drv_data)
394 struct chip_data *chip = drv_data->cur_chip;
396 while (drv_data->rx < drv_data->rx_end) {
400 write_TDBR(*(u8 *) (drv_data->tx));
401 while (!(read_STAT() & BIT_STAT_SPIF))
403 while (!(read_STAT() & BIT_STAT_RXS))
405 *(u8 *) (drv_data->rx) = read_RDBR();
408 if (chip->cs_chg_udelay)
409 udelay(chip->cs_chg_udelay);
416 static void u16_writer(struct driver_data *drv_data)
418 dev_dbg(&drv_data->pdev->dev,
419 "cr16 is 0x%x\n", read_STAT());
421 while (drv_data->tx < drv_data->tx_end) {
422 write_TDBR(*(u16 *) (drv_data->tx));
423 while ((read_STAT() & BIT_STAT_TXS))
428 /* poll for SPI completion before returning */
429 while (!(read_STAT() & BIT_STAT_SPIF))
433 static void u16_cs_chg_writer(struct driver_data *drv_data)
435 struct chip_data *chip = drv_data->cur_chip;
437 while (drv_data->tx < drv_data->tx_end) {
440 write_TDBR(*(u16 *) (drv_data->tx));
441 while ((read_STAT() & BIT_STAT_TXS))
443 while (!(read_STAT() & BIT_STAT_SPIF))
447 if (chip->cs_chg_udelay)
448 udelay(chip->cs_chg_udelay);
454 static void u16_reader(struct driver_data *drv_data)
456 dev_dbg(&drv_data->pdev->dev,
457 "cr-16 is 0x%x\n", read_STAT());
460 while (drv_data->rx < (drv_data->rx_end - 2)) {
461 while (!(read_STAT() & BIT_STAT_RXS))
463 *(u16 *) (drv_data->rx) = read_RDBR();
467 while (!(read_STAT() & BIT_STAT_RXS))
469 *(u16 *) (drv_data->rx) = read_SHAW();
473 static void u16_cs_chg_reader(struct driver_data *drv_data)
475 struct chip_data *chip = drv_data->cur_chip;
477 while (drv_data->rx < drv_data->rx_end) {
480 read_RDBR(); /* kick off */
481 while (!(read_STAT() & BIT_STAT_RXS))
483 while (!(read_STAT() & BIT_STAT_SPIF))
485 *(u16 *) (drv_data->rx) = read_SHAW();
488 if (chip->cs_chg_udelay)
489 udelay(chip->cs_chg_udelay);
495 static void u16_duplex(struct driver_data *drv_data)
497 /* in duplex mode, clk is triggered by writing of TDBR */
498 while (drv_data->tx < drv_data->tx_end) {
499 write_TDBR(*(u16 *) (drv_data->tx));
500 while (!(read_STAT() & BIT_STAT_SPIF))
502 while (!(read_STAT() & BIT_STAT_RXS))
504 *(u16 *) (drv_data->rx) = read_RDBR();
510 static void u16_cs_chg_duplex(struct driver_data *drv_data)
512 struct chip_data *chip = drv_data->cur_chip;
514 while (drv_data->tx < drv_data->tx_end) {
517 write_TDBR(*(u16 *) (drv_data->tx));
518 while (!(read_STAT() & BIT_STAT_SPIF))
520 while (!(read_STAT() & BIT_STAT_RXS))
522 *(u16 *) (drv_data->rx) = read_RDBR();
525 if (chip->cs_chg_udelay)
526 udelay(chip->cs_chg_udelay);
533 /* test if ther is more transfer to be done */
534 static void *next_transfer(struct driver_data *drv_data)
536 struct spi_message *msg = drv_data->cur_msg;
537 struct spi_transfer *trans = drv_data->cur_transfer;
539 /* Move to next transfer */
540 if (trans->transfer_list.next != &msg->transfers) {
541 drv_data->cur_transfer =
542 list_entry(trans->transfer_list.next,
543 struct spi_transfer, transfer_list);
544 return RUNNING_STATE;
550 * caller already set message->status;
551 * dma and pio irqs are blocked give finished message back
553 static void giveback(struct driver_data *drv_data)
555 struct chip_data *chip = drv_data->cur_chip;
556 struct spi_transfer *last_transfer;
558 struct spi_message *msg;
560 spin_lock_irqsave(&drv_data->lock, flags);
561 msg = drv_data->cur_msg;
562 drv_data->cur_msg = NULL;
563 drv_data->cur_transfer = NULL;
564 drv_data->cur_chip = NULL;
565 queue_work(drv_data->workqueue, &drv_data->pump_messages);
566 spin_unlock_irqrestore(&drv_data->lock, flags);
568 last_transfer = list_entry(msg->transfers.prev,
569 struct spi_transfer, transfer_list);
573 /* disable chip select signal. And not stop spi in autobuffer mode */
574 if (drv_data->tx_dma != 0xFFFF) {
576 bfin_spi_disable(drv_data);
579 if (!drv_data->cs_change)
583 msg->complete(msg->context);
586 static irqreturn_t dma_irq_handler(int irq, void *dev_id)
588 struct driver_data *drv_data = (struct driver_data *)dev_id;
589 struct spi_message *msg = drv_data->cur_msg;
590 struct chip_data *chip = drv_data->cur_chip;
592 dev_dbg(&drv_data->pdev->dev, "in dma_irq_handler\n");
593 clear_dma_irqstat(spi_dma_ch);
595 /* Wait for DMA to complete */
596 while (get_dma_curr_irqstat(spi_dma_ch) & DMA_RUN)
600 * wait for the last transaction shifted out. HRM states:
601 * at this point there may still be data in the SPI DMA FIFO waiting
602 * to be transmitted ... software needs to poll TXS in the SPI_STAT
603 * register until it goes low for 2 successive reads
605 if (drv_data->tx != NULL) {
606 while ((read_STAT() & TXS) ||
611 while (!(read_STAT() & SPIF))
614 bfin_spi_disable(drv_data);
616 msg->actual_length += drv_data->len_in_bytes;
618 if (drv_data->cs_change)
621 /* Move to next transfer */
622 msg->state = next_transfer(drv_data);
624 /* Schedule transfer tasklet */
625 tasklet_schedule(&drv_data->pump_transfers);
627 /* free the irq handler before next transfer */
628 dev_dbg(&drv_data->pdev->dev,
629 "disable dma channel irq%d\n",
631 dma_disable_irq(spi_dma_ch);
636 static void pump_transfers(unsigned long data)
638 struct driver_data *drv_data = (struct driver_data *)data;
639 struct spi_message *message = NULL;
640 struct spi_transfer *transfer = NULL;
641 struct spi_transfer *previous = NULL;
642 struct chip_data *chip = NULL;
644 u16 cr, dma_width, dma_config;
645 u32 tranf_success = 1;
647 /* Get current state information */
648 message = drv_data->cur_msg;
649 transfer = drv_data->cur_transfer;
650 chip = drv_data->cur_chip;
652 * if msg is error or done, report it back using complete() callback
655 /* Handle for abort */
656 if (message->state == ERROR_STATE) {
657 message->status = -EIO;
662 /* Handle end of message */
663 if (message->state == DONE_STATE) {
669 /* Delay if requested at end of transfer */
670 if (message->state == RUNNING_STATE) {
671 previous = list_entry(transfer->transfer_list.prev,
672 struct spi_transfer, transfer_list);
673 if (previous->delay_usecs)
674 udelay(previous->delay_usecs);
677 /* Setup the transfer state based on the type of transfer */
678 if (flush(drv_data) == 0) {
679 dev_err(&drv_data->pdev->dev, "pump_transfers: flush failed\n");
680 message->status = -EIO;
685 if (transfer->tx_buf != NULL) {
686 drv_data->tx = (void *)transfer->tx_buf;
687 drv_data->tx_end = drv_data->tx + transfer->len;
688 dev_dbg(&drv_data->pdev->dev, "tx_buf is %p, tx_end is %p\n",
689 transfer->tx_buf, drv_data->tx_end);
694 if (transfer->rx_buf != NULL) {
695 drv_data->rx = transfer->rx_buf;
696 drv_data->rx_end = drv_data->rx + transfer->len;
697 dev_dbg(&drv_data->pdev->dev, "rx_buf is %p, rx_end is %p\n",
698 transfer->rx_buf, drv_data->rx_end);
703 drv_data->rx_dma = transfer->rx_dma;
704 drv_data->tx_dma = transfer->tx_dma;
705 drv_data->len_in_bytes = transfer->len;
706 drv_data->cs_change = transfer->cs_change;
709 if (width == CFG_SPI_WORDSIZE16) {
710 drv_data->len = (transfer->len) >> 1;
712 drv_data->len = transfer->len;
714 drv_data->write = drv_data->tx ? chip->write : null_writer;
715 drv_data->read = drv_data->rx ? chip->read : null_reader;
716 drv_data->duplex = chip->duplex ? chip->duplex : null_writer;
717 dev_dbg(&drv_data->pdev->dev, "transfer: ",
718 "drv_data->write is %p, chip->write is %p, null_wr is %p\n",
719 drv_data->write, chip->write, null_writer);
721 /* speed and width has been set on per message */
722 message->state = RUNNING_STATE;
725 /* restore spi status for each spi transfer */
726 if (transfer->speed_hz) {
727 write_BAUD(hz_to_spi_baud(transfer->speed_hz));
729 write_BAUD(chip->baud);
733 dev_dbg(&drv_data->pdev->dev,
734 "now pumping a transfer: width is %d, len is %d\n",
735 width, transfer->len);
738 * Try to map dma buffer and do a dma transfer if
739 * successful use different way to r/w according to
740 * drv_data->cur_chip->enable_dma
742 if (drv_data->cur_chip->enable_dma && drv_data->len > 6) {
744 write_STAT(BIT_STAT_CLR);
745 disable_dma(spi_dma_ch);
746 clear_dma_irqstat(spi_dma_ch);
747 bfin_spi_disable(drv_data);
749 /* config dma channel */
750 dev_dbg(&drv_data->pdev->dev, "doing dma transfer\n");
751 if (width == CFG_SPI_WORDSIZE16) {
752 set_dma_x_count(spi_dma_ch, drv_data->len);
753 set_dma_x_modify(spi_dma_ch, 2);
754 dma_width = WDSIZE_16;
756 set_dma_x_count(spi_dma_ch, drv_data->len);
757 set_dma_x_modify(spi_dma_ch, 1);
758 dma_width = WDSIZE_8;
761 /* set transfer width,direction. And enable spi */
762 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
764 /* dirty hack for autobuffer DMA mode */
765 if (drv_data->tx_dma == 0xFFFF) {
766 dev_dbg(&drv_data->pdev->dev,
767 "doing autobuffer DMA out.\n");
769 /* no irq in autobuffer mode */
771 (DMAFLOW_AUTO | RESTART | dma_width | DI_EN);
772 set_dma_config(spi_dma_ch, dma_config);
773 set_dma_start_addr(spi_dma_ch,
774 (unsigned long)drv_data->tx);
775 enable_dma(spi_dma_ch);
776 write_CTRL(cr | CFG_SPI_DMAWRITE | (width << 8) |
777 (CFG_SPI_ENABLE << 14));
779 /* just return here, there can only be one transfer in this mode */
785 /* In dma mode, rx or tx must be NULL in one transfer */
786 if (drv_data->rx != NULL) {
787 /* set transfer mode, and enable SPI */
788 dev_dbg(&drv_data->pdev->dev, "doing DMA in.\n");
790 /* disable SPI before write to TDBR */
791 write_CTRL(cr & ~BIT_CTL_ENABLE);
793 /* clear tx reg soformer data is not shifted out */
796 set_dma_x_count(spi_dma_ch, drv_data->len);
799 dma_enable_irq(spi_dma_ch);
800 dma_config = (WNR | RESTART | dma_width | DI_EN);
801 set_dma_config(spi_dma_ch, dma_config);
802 set_dma_start_addr(spi_dma_ch,
803 (unsigned long)drv_data->rx);
804 enable_dma(spi_dma_ch);
807 CFG_SPI_DMAREAD | (width << 8) | (CFG_SPI_ENABLE <<
809 /* set transfer mode, and enable SPI */
811 } else if (drv_data->tx != NULL) {
812 dev_dbg(&drv_data->pdev->dev, "doing DMA out.\n");
815 dma_enable_irq(spi_dma_ch);
816 dma_config = (RESTART | dma_width | DI_EN);
817 set_dma_config(spi_dma_ch, dma_config);
818 set_dma_start_addr(spi_dma_ch,
819 (unsigned long)drv_data->tx);
820 enable_dma(spi_dma_ch);
822 write_CTRL(cr | CFG_SPI_DMAWRITE | (width << 8) |
823 (CFG_SPI_ENABLE << 14));
827 /* IO mode write then read */
828 dev_dbg(&drv_data->pdev->dev, "doing IO transfer\n");
830 write_STAT(BIT_STAT_CLR);
832 if (drv_data->tx != NULL && drv_data->rx != NULL) {
833 /* full duplex mode */
834 BUG_ON((drv_data->tx_end - drv_data->tx) !=
835 (drv_data->rx_end - drv_data->rx));
836 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
837 cr |= CFG_SPI_WRITE | (width << 8) |
838 (CFG_SPI_ENABLE << 14);
839 dev_dbg(&drv_data->pdev->dev,
840 "IO duplex: cr is 0x%x\n", cr);
844 drv_data->duplex(drv_data);
846 if (drv_data->tx != drv_data->tx_end)
848 } else if (drv_data->tx != NULL) {
849 /* write only half duplex */
850 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
851 cr |= CFG_SPI_WRITE | (width << 8) |
852 (CFG_SPI_ENABLE << 14);
853 dev_dbg(&drv_data->pdev->dev,
854 "IO write: cr is 0x%x\n", cr);
858 drv_data->write(drv_data);
860 if (drv_data->tx != drv_data->tx_end)
862 } else if (drv_data->rx != NULL) {
863 /* read only half duplex */
864 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
865 cr |= CFG_SPI_READ | (width << 8) |
866 (CFG_SPI_ENABLE << 14);
867 dev_dbg(&drv_data->pdev->dev,
868 "IO read: cr is 0x%x\n", cr);
872 drv_data->read(drv_data);
873 if (drv_data->rx != drv_data->rx_end)
877 if (!tranf_success) {
878 dev_dbg(&drv_data->pdev->dev,
879 "IO write error!\n");
880 message->state = ERROR_STATE;
882 /* Update total byte transfered */
883 message->actual_length += drv_data->len;
885 if (drv_data->cs_change)
888 /* Move to next transfer of this msg */
889 message->state = next_transfer(drv_data);
892 /* Schedule next transfer tasklet */
893 tasklet_schedule(&drv_data->pump_transfers);
898 /* pop a msg from queue and kick off real transfer */
899 static void pump_messages(struct work_struct *work)
901 struct driver_data *drv_data;
904 drv_data = container_of(work, struct driver_data, pump_messages);
906 /* Lock queue and check for queue work */
907 spin_lock_irqsave(&drv_data->lock, flags);
908 if (list_empty(&drv_data->queue) || drv_data->run == QUEUE_STOPPED) {
909 /* pumper kicked off but no work to do */
911 spin_unlock_irqrestore(&drv_data->lock, flags);
915 /* Make sure we are not already running a message */
916 if (drv_data->cur_msg) {
917 spin_unlock_irqrestore(&drv_data->lock, flags);
921 /* Extract head of queue */
922 drv_data->cur_msg = list_entry(drv_data->queue.next,
923 struct spi_message, queue);
925 /* Setup the SSP using the per chip configuration */
926 drv_data->cur_chip = spi_get_ctldata(drv_data->cur_msg->spi);
927 if (restore_state(drv_data)) {
928 spin_unlock_irqrestore(&drv_data->lock, flags);
932 list_del_init(&drv_data->cur_msg->queue);
934 /* Initial message state */
935 drv_data->cur_msg->state = START_STATE;
936 drv_data->cur_transfer = list_entry(drv_data->cur_msg->transfers.next,
937 struct spi_transfer, transfer_list);
939 dev_dbg(&drv_data->pdev->dev, "got a message to pump, "
940 "state is set to: baud %d, flag 0x%x, ctl 0x%x\n",
941 drv_data->cur_chip->baud, drv_data->cur_chip->flag,
942 drv_data->cur_chip->ctl_reg);
944 dev_dbg(&drv_data->pdev->dev,
945 "the first transfer len is %d\n",
946 drv_data->cur_transfer->len);
948 /* Mark as busy and launch transfers */
949 tasklet_schedule(&drv_data->pump_transfers);
952 spin_unlock_irqrestore(&drv_data->lock, flags);
956 * got a msg to transfer, queue it in drv_data->queue.
957 * And kick off message pumper
959 static int transfer(struct spi_device *spi, struct spi_message *msg)
961 struct driver_data *drv_data = spi_master_get_devdata(spi->master);
964 spin_lock_irqsave(&drv_data->lock, flags);
966 if (drv_data->run == QUEUE_STOPPED) {
967 spin_unlock_irqrestore(&drv_data->lock, flags);
971 msg->actual_length = 0;
972 msg->status = -EINPROGRESS;
973 msg->state = START_STATE;
975 dev_dbg(&spi->dev, "adding an msg in transfer() \n");
976 list_add_tail(&msg->queue, &drv_data->queue);
978 if (drv_data->run == QUEUE_RUNNING && !drv_data->busy)
979 queue_work(drv_data->workqueue, &drv_data->pump_messages);
981 spin_unlock_irqrestore(&drv_data->lock, flags);
986 /* first setup for new devices */
987 static int setup(struct spi_device *spi)
989 struct bfin5xx_spi_chip *chip_info = NULL;
990 struct chip_data *chip;
991 struct driver_data *drv_data = spi_master_get_devdata(spi->master);
994 /* Abort device setup if requested features are not supported */
995 if (spi->mode & ~(SPI_CPOL | SPI_CPHA | SPI_LSB_FIRST)) {
996 dev_err(&spi->dev, "requested mode not fully supported\n");
1000 /* Zero (the default) here means 8 bits */
1001 if (!spi->bits_per_word)
1002 spi->bits_per_word = 8;
1004 if (spi->bits_per_word != 8 && spi->bits_per_word != 16)
1007 /* Only alloc (or use chip_info) on first setup */
1008 chip = spi_get_ctldata(spi);
1010 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
1014 chip->enable_dma = 0;
1015 chip_info = spi->controller_data;
1018 /* chip_info isn't always needed */
1020 /* Make sure people stop trying to set fields via ctl_reg
1021 * when they should actually be using common SPI framework.
1022 * Currently we let through: WOM EMISO PSSE GM SZ TIMOD.
1023 * Not sure if a user actually needs/uses any of these,
1024 * but let's assume (for now) they do.
1026 if (chip_info->ctl_reg & (SPE|MSTR|CPOL|CPHA|LSBF|SIZE)) {
1027 dev_err(&spi->dev, "do not set bits in ctl_reg "
1028 "that the SPI framework manages\n");
1032 chip->enable_dma = chip_info->enable_dma != 0
1033 && drv_data->master_info->enable_dma;
1034 chip->ctl_reg = chip_info->ctl_reg;
1035 chip->bits_per_word = chip_info->bits_per_word;
1036 chip->cs_change_per_word = chip_info->cs_change_per_word;
1037 chip->cs_chg_udelay = chip_info->cs_chg_udelay;
1040 /* translate common spi framework into our register */
1041 if (spi->mode & SPI_CPOL)
1042 chip->ctl_reg |= CPOL;
1043 if (spi->mode & SPI_CPHA)
1044 chip->ctl_reg |= CPHA;
1045 if (spi->mode & SPI_LSB_FIRST)
1046 chip->ctl_reg |= LSBF;
1047 /* we dont support running in slave mode (yet?) */
1048 chip->ctl_reg |= MSTR;
1051 * if any one SPI chip is registered and wants DMA, request the
1052 * DMA channel for it
1054 if (chip->enable_dma && !dma_requested) {
1055 /* register dma irq handler */
1056 if (request_dma(spi_dma_ch, "BF53x_SPI_DMA") < 0) {
1058 "Unable to request BlackFin SPI DMA channel\n");
1061 if (set_dma_callback(spi_dma_ch, (void *)dma_irq_handler,
1063 dev_dbg(&spi->dev, "Unable to set dma callback\n");
1066 dma_disable_irq(spi_dma_ch);
1071 * Notice: for blackfin, the speed_hz is the value of register
1072 * SPI_BAUD, not the real baudrate
1074 chip->baud = hz_to_spi_baud(spi->max_speed_hz);
1075 spi_flg = ~(1 << (spi->chip_select));
1076 chip->flag = ((u16) spi_flg << 8) | (1 << (spi->chip_select));
1077 chip->chip_select_num = spi->chip_select;
1079 switch (chip->bits_per_word) {
1082 chip->width = CFG_SPI_WORDSIZE8;
1083 chip->read = chip->cs_change_per_word ?
1084 u8_cs_chg_reader : u8_reader;
1085 chip->write = chip->cs_change_per_word ?
1086 u8_cs_chg_writer : u8_writer;
1087 chip->duplex = chip->cs_change_per_word ?
1088 u8_cs_chg_duplex : u8_duplex;
1093 chip->width = CFG_SPI_WORDSIZE16;
1094 chip->read = chip->cs_change_per_word ?
1095 u16_cs_chg_reader : u16_reader;
1096 chip->write = chip->cs_change_per_word ?
1097 u16_cs_chg_writer : u16_writer;
1098 chip->duplex = chip->cs_change_per_word ?
1099 u16_cs_chg_duplex : u16_duplex;
1103 dev_err(&spi->dev, "%d bits_per_word is not supported\n",
1104 chip->bits_per_word);
1109 dev_dbg(&spi->dev, "setup spi chip %s, width is %d, dma is %d\n",
1110 spi->modalias, chip->width, chip->enable_dma);
1111 dev_dbg(&spi->dev, "ctl_reg is 0x%x, flag_reg is 0x%x\n",
1112 chip->ctl_reg, chip->flag);
1114 spi_set_ctldata(spi, chip);
1120 * callback for spi framework.
1121 * clean driver specific data
1123 static void cleanup(struct spi_device *spi)
1125 struct chip_data *chip = spi_get_ctldata(spi);
1130 static inline int init_queue(struct driver_data *drv_data)
1132 INIT_LIST_HEAD(&drv_data->queue);
1133 spin_lock_init(&drv_data->lock);
1135 drv_data->run = QUEUE_STOPPED;
1138 /* init transfer tasklet */
1139 tasklet_init(&drv_data->pump_transfers,
1140 pump_transfers, (unsigned long)drv_data);
1142 /* init messages workqueue */
1143 INIT_WORK(&drv_data->pump_messages, pump_messages);
1144 drv_data->workqueue =
1145 create_singlethread_workqueue(drv_data->master->dev.parent->bus_id);
1146 if (drv_data->workqueue == NULL)
1152 static inline int start_queue(struct driver_data *drv_data)
1154 unsigned long flags;
1156 spin_lock_irqsave(&drv_data->lock, flags);
1158 if (drv_data->run == QUEUE_RUNNING || drv_data->busy) {
1159 spin_unlock_irqrestore(&drv_data->lock, flags);
1163 drv_data->run = QUEUE_RUNNING;
1164 drv_data->cur_msg = NULL;
1165 drv_data->cur_transfer = NULL;
1166 drv_data->cur_chip = NULL;
1167 spin_unlock_irqrestore(&drv_data->lock, flags);
1169 queue_work(drv_data->workqueue, &drv_data->pump_messages);
1174 static inline int stop_queue(struct driver_data *drv_data)
1176 unsigned long flags;
1177 unsigned limit = 500;
1180 spin_lock_irqsave(&drv_data->lock, flags);
1183 * This is a bit lame, but is optimized for the common execution path.
1184 * A wait_queue on the drv_data->busy could be used, but then the common
1185 * execution path (pump_messages) would be required to call wake_up or
1186 * friends on every SPI message. Do this instead
1188 drv_data->run = QUEUE_STOPPED;
1189 while (!list_empty(&drv_data->queue) && drv_data->busy && limit--) {
1190 spin_unlock_irqrestore(&drv_data->lock, flags);
1192 spin_lock_irqsave(&drv_data->lock, flags);
1195 if (!list_empty(&drv_data->queue) || drv_data->busy)
1198 spin_unlock_irqrestore(&drv_data->lock, flags);
1203 static inline int destroy_queue(struct driver_data *drv_data)
1207 status = stop_queue(drv_data);
1211 destroy_workqueue(drv_data->workqueue);
1216 static int setup_pin_mux(int action, int bus_num)
1219 u16 pin_req[3][4] = {
1220 {P_SPI0_SCK, P_SPI0_MISO, P_SPI0_MOSI, 0},
1221 {P_SPI1_SCK, P_SPI1_MISO, P_SPI1_MOSI, 0},
1222 {P_SPI2_SCK, P_SPI2_MISO, P_SPI2_MOSI, 0},
1226 if (peripheral_request_list(pin_req[bus_num], DRV_NAME))
1229 peripheral_free_list(pin_req[bus_num]);
1235 static int __init bfin5xx_spi_probe(struct platform_device *pdev)
1237 struct device *dev = &pdev->dev;
1238 struct bfin5xx_spi_master *platform_info;
1239 struct spi_master *master;
1240 struct driver_data *drv_data = 0;
1241 struct resource *res;
1244 platform_info = dev->platform_data;
1246 /* Allocate master with space for drv_data */
1247 master = spi_alloc_master(dev, sizeof(struct driver_data) + 16);
1249 dev_err(&pdev->dev, "can not alloc spi_master\n");
1253 drv_data = spi_master_get_devdata(master);
1254 drv_data->master = master;
1255 drv_data->master_info = platform_info;
1256 drv_data->pdev = pdev;
1258 master->bus_num = pdev->id;
1259 master->num_chipselect = platform_info->num_chipselect;
1260 master->cleanup = cleanup;
1261 master->setup = setup;
1262 master->transfer = transfer;
1264 /* Find and map our resources */
1265 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1267 dev_err(dev, "Cannot get IORESOURCE_MEM\n");
1269 goto out_error_get_res;
1272 spi_regs_base = (u32) ioremap(res->start, (res->end - res->start)+1);
1273 if (!spi_regs_base) {
1274 dev_err(dev, "Cannot map IO\n");
1276 goto out_error_ioremap;
1279 spi_dma_ch = platform_get_irq(pdev, 0);
1280 if (spi_dma_ch < 0) {
1281 dev_err(dev, "No DMA channel specified\n");
1283 goto out_error_no_dma_ch;
1286 /* Initial and start queue */
1287 status = init_queue(drv_data);
1289 dev_err(dev, "problem initializing queue\n");
1290 goto out_error_queue_alloc;
1293 status = start_queue(drv_data);
1295 dev_err(dev, "problem starting queue\n");
1296 goto out_error_queue_alloc;
1299 /* Register with the SPI framework */
1300 platform_set_drvdata(pdev, drv_data);
1301 status = spi_register_master(master);
1303 dev_err(dev, "problem registering spi master\n");
1304 goto out_error_queue_alloc;
1307 if (setup_pin_mux(1, master->bus_num)) {
1308 dev_err(&pdev->dev, ": Requesting Peripherals failed\n");
1312 dev_info(dev, "%s, Version %s, regs_base @ 0x%08x\n",
1313 DRV_DESC, DRV_VERSION, spi_regs_base);
1316 out_error_queue_alloc:
1317 destroy_queue(drv_data);
1318 out_error_no_dma_ch:
1319 iounmap((void *) spi_regs_base);
1323 spi_master_put(master);
1328 /* stop hardware and remove the driver */
1329 static int __devexit bfin5xx_spi_remove(struct platform_device *pdev)
1331 struct driver_data *drv_data = platform_get_drvdata(pdev);
1337 /* Remove the queue */
1338 status = destroy_queue(drv_data);
1342 /* Disable the SSP at the peripheral and SOC level */
1343 bfin_spi_disable(drv_data);
1346 if (drv_data->master_info->enable_dma) {
1347 if (dma_channel_active(spi_dma_ch))
1348 free_dma(spi_dma_ch);
1351 /* Disconnect from the SPI framework */
1352 spi_unregister_master(drv_data->master);
1354 setup_pin_mux(0, drv_data->master->bus_num);
1356 /* Prevent double remove */
1357 platform_set_drvdata(pdev, NULL);
1363 static int bfin5xx_spi_suspend(struct platform_device *pdev, pm_message_t state)
1365 struct driver_data *drv_data = platform_get_drvdata(pdev);
1368 status = stop_queue(drv_data);
1373 bfin_spi_disable(drv_data);
1378 static int bfin5xx_spi_resume(struct platform_device *pdev)
1380 struct driver_data *drv_data = platform_get_drvdata(pdev);
1383 /* Enable the SPI interface */
1384 bfin_spi_enable(drv_data);
1386 /* Start the queue running */
1387 status = start_queue(drv_data);
1389 dev_err(&pdev->dev, "problem starting queue (%d)\n", status);
1396 #define bfin5xx_spi_suspend NULL
1397 #define bfin5xx_spi_resume NULL
1398 #endif /* CONFIG_PM */
1400 MODULE_ALIAS("bfin-spi-master"); /* for platform bus hotplug */
1401 static struct platform_driver bfin5xx_spi_driver = {
1404 .owner = THIS_MODULE,
1406 .suspend = bfin5xx_spi_suspend,
1407 .resume = bfin5xx_spi_resume,
1408 .remove = __devexit_p(bfin5xx_spi_remove),
1411 static int __init bfin5xx_spi_init(void)
1413 return platform_driver_probe(&bfin5xx_spi_driver, bfin5xx_spi_probe);
1415 module_init(bfin5xx_spi_init);
1417 static void __exit bfin5xx_spi_exit(void)
1419 platform_driver_unregister(&bfin5xx_spi_driver);
1421 module_exit(bfin5xx_spi_exit);