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_SPI0_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[MAX_SPI0_SSEL] = {P_SPI0_SSEL1, P_SPI0_SSEL2, P_SPI0_SSEL3,
220 P_SPI0_SSEL4, P_SPI0_SSEL5,
221 P_SPI0_SSEL6, P_SPI0_SSEL7,};
223 /* Clear status and disable clock */
224 write_STAT(BIT_STAT_CLR);
225 bfin_spi_disable(drv_data);
226 dev_dbg(&drv_data->pdev->dev, "restoring spi ctl state\n");
228 /* Load the registers */
229 write_CTRL(chip->ctl_reg);
230 write_BAUD(chip->baud);
233 if (!chip->chip_select_requested) {
234 int i = chip->chip_select_num;
236 dev_dbg(&drv_data->pdev->dev, "chip select number is %d\n", i);
238 if ((i > 0) && (i <= MAX_SPI0_SSEL))
239 ret = peripheral_request(ssel[i-1], DRV_NAME);
241 chip->chip_select_requested = 1;
245 dev_dbg(&drv_data->pdev->dev,
246 ": request chip select number %d failed\n",
247 chip->chip_select_num);
252 /* used to kick off transfer in rx mode */
253 static unsigned short dummy_read(void)
260 static void null_writer(struct driver_data *drv_data)
262 u8 n_bytes = drv_data->n_bytes;
264 while (drv_data->tx < drv_data->tx_end) {
266 while ((read_STAT() & BIT_STAT_TXS))
268 drv_data->tx += n_bytes;
272 static void null_reader(struct driver_data *drv_data)
274 u8 n_bytes = drv_data->n_bytes;
277 while (drv_data->rx < drv_data->rx_end) {
278 while (!(read_STAT() & BIT_STAT_RXS))
281 drv_data->rx += n_bytes;
285 static void u8_writer(struct driver_data *drv_data)
287 dev_dbg(&drv_data->pdev->dev,
288 "cr8-s is 0x%x\n", read_STAT());
289 while (drv_data->tx < drv_data->tx_end) {
290 write_TDBR(*(u8 *) (drv_data->tx));
291 while (read_STAT() & BIT_STAT_TXS)
296 /* poll for SPI completion before returning */
297 while (!(read_STAT() & BIT_STAT_SPIF))
301 static void u8_cs_chg_writer(struct driver_data *drv_data)
303 struct chip_data *chip = drv_data->cur_chip;
305 while (drv_data->tx < drv_data->tx_end) {
308 write_TDBR(*(u8 *) (drv_data->tx));
309 while (read_STAT() & BIT_STAT_TXS)
311 while (!(read_STAT() & BIT_STAT_SPIF))
315 if (chip->cs_chg_udelay)
316 udelay(chip->cs_chg_udelay);
323 static void u8_reader(struct driver_data *drv_data)
325 dev_dbg(&drv_data->pdev->dev,
326 "cr-8 is 0x%x\n", read_STAT());
328 /* clear TDBR buffer before read(else it will be shifted out) */
333 while (drv_data->rx < drv_data->rx_end - 1) {
334 while (!(read_STAT() & BIT_STAT_RXS))
336 *(u8 *) (drv_data->rx) = read_RDBR();
340 while (!(read_STAT() & BIT_STAT_RXS))
342 *(u8 *) (drv_data->rx) = read_SHAW();
346 static void u8_cs_chg_reader(struct driver_data *drv_data)
348 struct chip_data *chip = drv_data->cur_chip;
350 while (drv_data->rx < drv_data->rx_end) {
353 read_RDBR(); /* kick off */
354 while (!(read_STAT() & BIT_STAT_RXS))
356 while (!(read_STAT() & BIT_STAT_SPIF))
358 *(u8 *) (drv_data->rx) = read_SHAW();
361 if (chip->cs_chg_udelay)
362 udelay(chip->cs_chg_udelay);
369 static void u8_duplex(struct driver_data *drv_data)
371 /* in duplex mode, clk is triggered by writing of TDBR */
372 while (drv_data->rx < drv_data->rx_end) {
373 write_TDBR(*(u8 *) (drv_data->tx));
374 while (!(read_STAT() & BIT_STAT_SPIF))
376 while (!(read_STAT() & BIT_STAT_RXS))
378 *(u8 *) (drv_data->rx) = read_RDBR();
384 static void u8_cs_chg_duplex(struct driver_data *drv_data)
386 struct chip_data *chip = drv_data->cur_chip;
388 while (drv_data->rx < drv_data->rx_end) {
392 write_TDBR(*(u8 *) (drv_data->tx));
393 while (!(read_STAT() & BIT_STAT_SPIF))
395 while (!(read_STAT() & BIT_STAT_RXS))
397 *(u8 *) (drv_data->rx) = read_RDBR();
400 if (chip->cs_chg_udelay)
401 udelay(chip->cs_chg_udelay);
408 static void u16_writer(struct driver_data *drv_data)
410 dev_dbg(&drv_data->pdev->dev,
411 "cr16 is 0x%x\n", read_STAT());
413 while (drv_data->tx < drv_data->tx_end) {
414 write_TDBR(*(u16 *) (drv_data->tx));
415 while ((read_STAT() & BIT_STAT_TXS))
420 /* poll for SPI completion before returning */
421 while (!(read_STAT() & BIT_STAT_SPIF))
425 static void u16_cs_chg_writer(struct driver_data *drv_data)
427 struct chip_data *chip = drv_data->cur_chip;
429 while (drv_data->tx < drv_data->tx_end) {
432 write_TDBR(*(u16 *) (drv_data->tx));
433 while ((read_STAT() & BIT_STAT_TXS))
435 while (!(read_STAT() & BIT_STAT_SPIF))
439 if (chip->cs_chg_udelay)
440 udelay(chip->cs_chg_udelay);
446 static void u16_reader(struct driver_data *drv_data)
448 dev_dbg(&drv_data->pdev->dev,
449 "cr-16 is 0x%x\n", read_STAT());
452 while (drv_data->rx < (drv_data->rx_end - 2)) {
453 while (!(read_STAT() & BIT_STAT_RXS))
455 *(u16 *) (drv_data->rx) = read_RDBR();
459 while (!(read_STAT() & BIT_STAT_RXS))
461 *(u16 *) (drv_data->rx) = read_SHAW();
465 static void u16_cs_chg_reader(struct driver_data *drv_data)
467 struct chip_data *chip = drv_data->cur_chip;
469 while (drv_data->rx < drv_data->rx_end) {
472 read_RDBR(); /* kick off */
473 while (!(read_STAT() & BIT_STAT_RXS))
475 while (!(read_STAT() & BIT_STAT_SPIF))
477 *(u16 *) (drv_data->rx) = read_SHAW();
480 if (chip->cs_chg_udelay)
481 udelay(chip->cs_chg_udelay);
487 static void u16_duplex(struct driver_data *drv_data)
489 /* in duplex mode, clk is triggered by writing of TDBR */
490 while (drv_data->tx < drv_data->tx_end) {
491 write_TDBR(*(u16 *) (drv_data->tx));
492 while (!(read_STAT() & BIT_STAT_SPIF))
494 while (!(read_STAT() & BIT_STAT_RXS))
496 *(u16 *) (drv_data->rx) = read_RDBR();
502 static void u16_cs_chg_duplex(struct driver_data *drv_data)
504 struct chip_data *chip = drv_data->cur_chip;
506 while (drv_data->tx < drv_data->tx_end) {
509 write_TDBR(*(u16 *) (drv_data->tx));
510 while (!(read_STAT() & BIT_STAT_SPIF))
512 while (!(read_STAT() & BIT_STAT_RXS))
514 *(u16 *) (drv_data->rx) = read_RDBR();
517 if (chip->cs_chg_udelay)
518 udelay(chip->cs_chg_udelay);
525 /* test if ther is more transfer to be done */
526 static void *next_transfer(struct driver_data *drv_data)
528 struct spi_message *msg = drv_data->cur_msg;
529 struct spi_transfer *trans = drv_data->cur_transfer;
531 /* Move to next transfer */
532 if (trans->transfer_list.next != &msg->transfers) {
533 drv_data->cur_transfer =
534 list_entry(trans->transfer_list.next,
535 struct spi_transfer, transfer_list);
536 return RUNNING_STATE;
542 * caller already set message->status;
543 * dma and pio irqs are blocked give finished message back
545 static void giveback(struct driver_data *drv_data)
547 struct chip_data *chip = drv_data->cur_chip;
548 struct spi_transfer *last_transfer;
550 struct spi_message *msg;
552 spin_lock_irqsave(&drv_data->lock, flags);
553 msg = drv_data->cur_msg;
554 drv_data->cur_msg = NULL;
555 drv_data->cur_transfer = NULL;
556 drv_data->cur_chip = NULL;
557 queue_work(drv_data->workqueue, &drv_data->pump_messages);
558 spin_unlock_irqrestore(&drv_data->lock, flags);
560 last_transfer = list_entry(msg->transfers.prev,
561 struct spi_transfer, transfer_list);
565 /* disable chip select signal. And not stop spi in autobuffer mode */
566 if (drv_data->tx_dma != 0xFFFF) {
568 bfin_spi_disable(drv_data);
571 if (!drv_data->cs_change)
575 msg->complete(msg->context);
578 static irqreturn_t dma_irq_handler(int irq, void *dev_id)
580 struct driver_data *drv_data = (struct driver_data *)dev_id;
581 struct spi_message *msg = drv_data->cur_msg;
582 struct chip_data *chip = drv_data->cur_chip;
584 dev_dbg(&drv_data->pdev->dev, "in dma_irq_handler\n");
585 clear_dma_irqstat(spi_dma_ch);
587 /* Wait for DMA to complete */
588 while (get_dma_curr_irqstat(spi_dma_ch) & DMA_RUN)
592 * wait for the last transaction shifted out. HRM states:
593 * at this point there may still be data in the SPI DMA FIFO waiting
594 * to be transmitted ... software needs to poll TXS in the SPI_STAT
595 * register until it goes low for 2 successive reads
597 if (drv_data->tx != NULL) {
598 while ((read_STAT() & TXS) ||
603 while (!(read_STAT() & SPIF))
606 bfin_spi_disable(drv_data);
608 msg->actual_length += drv_data->len_in_bytes;
610 if (drv_data->cs_change)
613 /* Move to next transfer */
614 msg->state = next_transfer(drv_data);
616 /* Schedule transfer tasklet */
617 tasklet_schedule(&drv_data->pump_transfers);
619 /* free the irq handler before next transfer */
620 dev_dbg(&drv_data->pdev->dev,
621 "disable dma channel irq%d\n",
623 dma_disable_irq(spi_dma_ch);
628 static void pump_transfers(unsigned long data)
630 struct driver_data *drv_data = (struct driver_data *)data;
631 struct spi_message *message = NULL;
632 struct spi_transfer *transfer = NULL;
633 struct spi_transfer *previous = NULL;
634 struct chip_data *chip = NULL;
636 u16 cr, dma_width, dma_config;
637 u32 tranf_success = 1;
639 /* Get current state information */
640 message = drv_data->cur_msg;
641 transfer = drv_data->cur_transfer;
642 chip = drv_data->cur_chip;
645 * if msg is error or done, report it back using complete() callback
648 /* Handle for abort */
649 if (message->state == ERROR_STATE) {
650 message->status = -EIO;
655 /* Handle end of message */
656 if (message->state == DONE_STATE) {
662 /* Delay if requested at end of transfer */
663 if (message->state == RUNNING_STATE) {
664 previous = list_entry(transfer->transfer_list.prev,
665 struct spi_transfer, transfer_list);
666 if (previous->delay_usecs)
667 udelay(previous->delay_usecs);
670 /* Setup the transfer state based on the type of transfer */
671 if (flush(drv_data) == 0) {
672 dev_err(&drv_data->pdev->dev, "pump_transfers: flush failed\n");
673 message->status = -EIO;
678 if (transfer->tx_buf != NULL) {
679 drv_data->tx = (void *)transfer->tx_buf;
680 drv_data->tx_end = drv_data->tx + transfer->len;
681 dev_dbg(&drv_data->pdev->dev, "tx_buf is %p, tx_end is %p\n",
682 transfer->tx_buf, drv_data->tx_end);
687 if (transfer->rx_buf != NULL) {
688 drv_data->rx = transfer->rx_buf;
689 drv_data->rx_end = drv_data->rx + transfer->len;
690 dev_dbg(&drv_data->pdev->dev, "rx_buf is %p, rx_end is %p\n",
691 transfer->rx_buf, drv_data->rx_end);
696 drv_data->rx_dma = transfer->rx_dma;
697 drv_data->tx_dma = transfer->tx_dma;
698 drv_data->len_in_bytes = transfer->len;
699 drv_data->cs_change = transfer->cs_change;
702 if (width == CFG_SPI_WORDSIZE16) {
703 drv_data->len = (transfer->len) >> 1;
705 drv_data->len = transfer->len;
707 drv_data->write = drv_data->tx ? chip->write : null_writer;
708 drv_data->read = drv_data->rx ? chip->read : null_reader;
709 drv_data->duplex = chip->duplex ? chip->duplex : null_writer;
710 dev_dbg(&drv_data->pdev->dev, "transfer: ",
711 "drv_data->write is %p, chip->write is %p, null_wr is %p\n",
712 drv_data->write, chip->write, null_writer);
714 /* speed and width has been set on per message */
715 message->state = RUNNING_STATE;
718 /* restore spi status for each spi transfer */
719 if (transfer->speed_hz) {
720 write_BAUD(hz_to_spi_baud(transfer->speed_hz));
722 write_BAUD(chip->baud);
726 dev_dbg(&drv_data->pdev->dev,
727 "now pumping a transfer: width is %d, len is %d\n",
728 width, transfer->len);
731 * Try to map dma buffer and do a dma transfer if
732 * successful use different way to r/w according to
733 * drv_data->cur_chip->enable_dma
735 if (drv_data->cur_chip->enable_dma && drv_data->len > 6) {
737 write_STAT(BIT_STAT_CLR);
738 disable_dma(spi_dma_ch);
739 clear_dma_irqstat(spi_dma_ch);
740 bfin_spi_disable(drv_data);
742 /* config dma channel */
743 dev_dbg(&drv_data->pdev->dev, "doing dma transfer\n");
744 if (width == CFG_SPI_WORDSIZE16) {
745 set_dma_x_count(spi_dma_ch, drv_data->len);
746 set_dma_x_modify(spi_dma_ch, 2);
747 dma_width = WDSIZE_16;
749 set_dma_x_count(spi_dma_ch, drv_data->len);
750 set_dma_x_modify(spi_dma_ch, 1);
751 dma_width = WDSIZE_8;
754 /* set transfer width,direction. And enable spi */
755 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
757 /* dirty hack for autobuffer DMA mode */
758 if (drv_data->tx_dma == 0xFFFF) {
759 dev_dbg(&drv_data->pdev->dev,
760 "doing autobuffer DMA out.\n");
762 /* no irq in autobuffer mode */
764 (DMAFLOW_AUTO | RESTART | dma_width | DI_EN);
765 set_dma_config(spi_dma_ch, dma_config);
766 set_dma_start_addr(spi_dma_ch,
767 (unsigned long)drv_data->tx);
768 enable_dma(spi_dma_ch);
769 write_CTRL(cr | CFG_SPI_DMAWRITE | (width << 8) |
770 (CFG_SPI_ENABLE << 14));
772 /* just return here, there can only be one transfer in this mode */
778 /* In dma mode, rx or tx must be NULL in one transfer */
779 if (drv_data->rx != NULL) {
780 /* set transfer mode, and enable SPI */
781 dev_dbg(&drv_data->pdev->dev, "doing DMA in.\n");
783 /* disable SPI before write to TDBR */
784 write_CTRL(cr & ~BIT_CTL_ENABLE);
786 /* clear tx reg soformer data is not shifted out */
789 set_dma_x_count(spi_dma_ch, drv_data->len);
792 dma_enable_irq(spi_dma_ch);
793 dma_config = (WNR | RESTART | dma_width | DI_EN);
794 set_dma_config(spi_dma_ch, dma_config);
795 set_dma_start_addr(spi_dma_ch,
796 (unsigned long)drv_data->rx);
797 enable_dma(spi_dma_ch);
800 CFG_SPI_DMAREAD | (width << 8) | (CFG_SPI_ENABLE <<
802 /* set transfer mode, and enable SPI */
804 } else if (drv_data->tx != NULL) {
805 dev_dbg(&drv_data->pdev->dev, "doing DMA out.\n");
808 dma_enable_irq(spi_dma_ch);
809 dma_config = (RESTART | dma_width | DI_EN);
810 set_dma_config(spi_dma_ch, dma_config);
811 set_dma_start_addr(spi_dma_ch,
812 (unsigned long)drv_data->tx);
813 enable_dma(spi_dma_ch);
815 write_CTRL(cr | CFG_SPI_DMAWRITE | (width << 8) |
816 (CFG_SPI_ENABLE << 14));
820 /* IO mode write then read */
821 dev_dbg(&drv_data->pdev->dev, "doing IO transfer\n");
823 write_STAT(BIT_STAT_CLR);
825 if (drv_data->tx != NULL && drv_data->rx != NULL) {
826 /* full duplex mode */
827 BUG_ON((drv_data->tx_end - drv_data->tx) !=
828 (drv_data->rx_end - drv_data->rx));
829 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
830 cr |= CFG_SPI_WRITE | (width << 8) |
831 (CFG_SPI_ENABLE << 14);
832 dev_dbg(&drv_data->pdev->dev,
833 "IO duplex: cr is 0x%x\n", cr);
837 drv_data->duplex(drv_data);
839 if (drv_data->tx != drv_data->tx_end)
841 } else if (drv_data->tx != NULL) {
842 /* write only half duplex */
843 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
844 cr |= CFG_SPI_WRITE | (width << 8) |
845 (CFG_SPI_ENABLE << 14);
846 dev_dbg(&drv_data->pdev->dev,
847 "IO write: cr is 0x%x\n", cr);
851 drv_data->write(drv_data);
853 if (drv_data->tx != drv_data->tx_end)
855 } else if (drv_data->rx != NULL) {
856 /* read only half duplex */
857 cr = (read_CTRL() & (~BIT_CTL_TIMOD));
858 cr |= CFG_SPI_READ | (width << 8) |
859 (CFG_SPI_ENABLE << 14);
860 dev_dbg(&drv_data->pdev->dev,
861 "IO read: cr is 0x%x\n", cr);
865 drv_data->read(drv_data);
866 if (drv_data->rx != drv_data->rx_end)
870 if (!tranf_success) {
871 dev_dbg(&drv_data->pdev->dev,
872 "IO write error!\n");
873 message->state = ERROR_STATE;
875 /* Update total byte transfered */
876 message->actual_length += drv_data->len;
878 if (drv_data->cs_change)
881 /* Move to next transfer of this msg */
882 message->state = next_transfer(drv_data);
885 /* Schedule next transfer tasklet */
886 tasklet_schedule(&drv_data->pump_transfers);
891 /* pop a msg from queue and kick off real transfer */
892 static void pump_messages(struct work_struct *work)
894 struct driver_data *drv_data;
897 drv_data = container_of(work, struct driver_data, pump_messages);
899 /* Lock queue and check for queue work */
900 spin_lock_irqsave(&drv_data->lock, flags);
901 if (list_empty(&drv_data->queue) || drv_data->run == QUEUE_STOPPED) {
902 /* pumper kicked off but no work to do */
904 spin_unlock_irqrestore(&drv_data->lock, flags);
908 /* Make sure we are not already running a message */
909 if (drv_data->cur_msg) {
910 spin_unlock_irqrestore(&drv_data->lock, flags);
914 /* Extract head of queue */
915 drv_data->cur_msg = list_entry(drv_data->queue.next,
916 struct spi_message, queue);
918 /* Setup the SSP using the per chip configuration */
919 drv_data->cur_chip = spi_get_ctldata(drv_data->cur_msg->spi);
920 if (restore_state(drv_data)) {
921 spin_unlock_irqrestore(&drv_data->lock, flags);
925 list_del_init(&drv_data->cur_msg->queue);
927 /* Initial message state */
928 drv_data->cur_msg->state = START_STATE;
929 drv_data->cur_transfer = list_entry(drv_data->cur_msg->transfers.next,
930 struct spi_transfer, transfer_list);
932 dev_dbg(&drv_data->pdev->dev, "got a message to pump, "
933 "state is set to: baud %d, flag 0x%x, ctl 0x%x\n",
934 drv_data->cur_chip->baud, drv_data->cur_chip->flag,
935 drv_data->cur_chip->ctl_reg);
937 dev_dbg(&drv_data->pdev->dev,
938 "the first transfer len is %d\n",
939 drv_data->cur_transfer->len);
941 /* Mark as busy and launch transfers */
942 tasklet_schedule(&drv_data->pump_transfers);
945 spin_unlock_irqrestore(&drv_data->lock, flags);
949 * got a msg to transfer, queue it in drv_data->queue.
950 * And kick off message pumper
952 static int transfer(struct spi_device *spi, struct spi_message *msg)
954 struct driver_data *drv_data = spi_master_get_devdata(spi->master);
957 spin_lock_irqsave(&drv_data->lock, flags);
959 if (drv_data->run == QUEUE_STOPPED) {
960 spin_unlock_irqrestore(&drv_data->lock, flags);
964 msg->actual_length = 0;
965 msg->status = -EINPROGRESS;
966 msg->state = START_STATE;
968 dev_dbg(&spi->dev, "adding an msg in transfer() \n");
969 list_add_tail(&msg->queue, &drv_data->queue);
971 if (drv_data->run == QUEUE_RUNNING && !drv_data->busy)
972 queue_work(drv_data->workqueue, &drv_data->pump_messages);
974 spin_unlock_irqrestore(&drv_data->lock, flags);
979 /* first setup for new devices */
980 static int setup(struct spi_device *spi)
982 struct bfin5xx_spi_chip *chip_info = NULL;
983 struct chip_data *chip;
984 struct driver_data *drv_data = spi_master_get_devdata(spi->master);
987 /* Abort device setup if requested features are not supported */
988 if (spi->mode & ~(SPI_CPOL | SPI_CPHA | SPI_LSB_FIRST)) {
989 dev_err(&spi->dev, "requested mode not fully supported\n");
993 /* Zero (the default) here means 8 bits */
994 if (!spi->bits_per_word)
995 spi->bits_per_word = 8;
997 if (spi->bits_per_word != 8 && spi->bits_per_word != 16)
1000 /* Only alloc (or use chip_info) on first setup */
1001 chip = spi_get_ctldata(spi);
1003 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
1007 chip->enable_dma = 0;
1008 chip_info = spi->controller_data;
1011 /* chip_info isn't always needed */
1013 /* Make sure people stop trying to set fields via ctl_reg
1014 * when they should actually be using common SPI framework.
1015 * Currently we let through: WOM EMISO PSSE GM SZ TIMOD.
1016 * Not sure if a user actually needs/uses any of these,
1017 * but let's assume (for now) they do.
1019 if (chip_info->ctl_reg & (SPE|MSTR|CPOL|CPHA|LSBF|SIZE)) {
1020 dev_err(&spi->dev, "do not set bits in ctl_reg "
1021 "that the SPI framework manages\n");
1025 chip->enable_dma = chip_info->enable_dma != 0
1026 && drv_data->master_info->enable_dma;
1027 chip->ctl_reg = chip_info->ctl_reg;
1028 chip->bits_per_word = chip_info->bits_per_word;
1029 chip->cs_change_per_word = chip_info->cs_change_per_word;
1030 chip->cs_chg_udelay = chip_info->cs_chg_udelay;
1033 /* translate common spi framework into our register */
1034 if (spi->mode & SPI_CPOL)
1035 chip->ctl_reg |= CPOL;
1036 if (spi->mode & SPI_CPHA)
1037 chip->ctl_reg |= CPHA;
1038 if (spi->mode & SPI_LSB_FIRST)
1039 chip->ctl_reg |= LSBF;
1040 /* we dont support running in slave mode (yet?) */
1041 chip->ctl_reg |= MSTR;
1044 * if any one SPI chip is registered and wants DMA, request the
1045 * DMA channel for it
1047 if (chip->enable_dma && !dma_requested) {
1048 /* register dma irq handler */
1049 if (request_dma(spi_dma_ch, "BF53x_SPI_DMA") < 0) {
1051 "Unable to request BlackFin SPI DMA channel\n");
1054 if (set_dma_callback(spi_dma_ch, (void *)dma_irq_handler,
1056 dev_dbg(&spi->dev, "Unable to set dma callback\n");
1059 dma_disable_irq(spi_dma_ch);
1064 * Notice: for blackfin, the speed_hz is the value of register
1065 * SPI_BAUD, not the real baudrate
1067 chip->baud = hz_to_spi_baud(spi->max_speed_hz);
1068 spi_flg = ~(1 << (spi->chip_select));
1069 chip->flag = ((u16) spi_flg << 8) | (1 << (spi->chip_select));
1070 chip->chip_select_num = spi->chip_select;
1072 switch (chip->bits_per_word) {
1075 chip->width = CFG_SPI_WORDSIZE8;
1076 chip->read = chip->cs_change_per_word ?
1077 u8_cs_chg_reader : u8_reader;
1078 chip->write = chip->cs_change_per_word ?
1079 u8_cs_chg_writer : u8_writer;
1080 chip->duplex = chip->cs_change_per_word ?
1081 u8_cs_chg_duplex : u8_duplex;
1086 chip->width = CFG_SPI_WORDSIZE16;
1087 chip->read = chip->cs_change_per_word ?
1088 u16_cs_chg_reader : u16_reader;
1089 chip->write = chip->cs_change_per_word ?
1090 u16_cs_chg_writer : u16_writer;
1091 chip->duplex = chip->cs_change_per_word ?
1092 u16_cs_chg_duplex : u16_duplex;
1096 dev_err(&spi->dev, "%d bits_per_word is not supported\n",
1097 chip->bits_per_word);
1102 dev_dbg(&spi->dev, "setup spi chip %s, width is %d, dma is %d\n",
1103 spi->modalias, chip->width, chip->enable_dma);
1104 dev_dbg(&spi->dev, "ctl_reg is 0x%x, flag_reg is 0x%x\n",
1105 chip->ctl_reg, chip->flag);
1107 spi_set_ctldata(spi, chip);
1113 * callback for spi framework.
1114 * clean driver specific data
1116 static void cleanup(struct spi_device *spi)
1118 struct chip_data *chip = spi_get_ctldata(spi);
1123 static inline int init_queue(struct driver_data *drv_data)
1125 INIT_LIST_HEAD(&drv_data->queue);
1126 spin_lock_init(&drv_data->lock);
1128 drv_data->run = QUEUE_STOPPED;
1131 /* init transfer tasklet */
1132 tasklet_init(&drv_data->pump_transfers,
1133 pump_transfers, (unsigned long)drv_data);
1135 /* init messages workqueue */
1136 INIT_WORK(&drv_data->pump_messages, pump_messages);
1137 drv_data->workqueue =
1138 create_singlethread_workqueue(drv_data->master->dev.parent->bus_id);
1139 if (drv_data->workqueue == NULL)
1145 static inline int start_queue(struct driver_data *drv_data)
1147 unsigned long flags;
1149 spin_lock_irqsave(&drv_data->lock, flags);
1151 if (drv_data->run == QUEUE_RUNNING || drv_data->busy) {
1152 spin_unlock_irqrestore(&drv_data->lock, flags);
1156 drv_data->run = QUEUE_RUNNING;
1157 drv_data->cur_msg = NULL;
1158 drv_data->cur_transfer = NULL;
1159 drv_data->cur_chip = NULL;
1160 spin_unlock_irqrestore(&drv_data->lock, flags);
1162 queue_work(drv_data->workqueue, &drv_data->pump_messages);
1167 static inline int stop_queue(struct driver_data *drv_data)
1169 unsigned long flags;
1170 unsigned limit = 500;
1173 spin_lock_irqsave(&drv_data->lock, flags);
1176 * This is a bit lame, but is optimized for the common execution path.
1177 * A wait_queue on the drv_data->busy could be used, but then the common
1178 * execution path (pump_messages) would be required to call wake_up or
1179 * friends on every SPI message. Do this instead
1181 drv_data->run = QUEUE_STOPPED;
1182 while (!list_empty(&drv_data->queue) && drv_data->busy && limit--) {
1183 spin_unlock_irqrestore(&drv_data->lock, flags);
1185 spin_lock_irqsave(&drv_data->lock, flags);
1188 if (!list_empty(&drv_data->queue) || drv_data->busy)
1191 spin_unlock_irqrestore(&drv_data->lock, flags);
1196 static inline int destroy_queue(struct driver_data *drv_data)
1200 status = stop_queue(drv_data);
1204 destroy_workqueue(drv_data->workqueue);
1209 static int setup_pin_mux(int action)
1212 u16 pin_req[] = {P_SPI0_SCK, P_SPI0_MISO, P_SPI0_MOSI, 0};
1215 if (peripheral_request_list(pin_req, DRV_NAME))
1218 peripheral_free_list(pin_req);
1224 static int __init bfin5xx_spi_probe(struct platform_device *pdev)
1226 struct device *dev = &pdev->dev;
1227 struct bfin5xx_spi_master *platform_info;
1228 struct spi_master *master;
1229 struct driver_data *drv_data = 0;
1230 struct resource *res;
1233 platform_info = dev->platform_data;
1235 /* Allocate master with space for drv_data */
1236 master = spi_alloc_master(dev, sizeof(struct driver_data) + 16);
1238 dev_err(&pdev->dev, "can not alloc spi_master\n");
1242 if (setup_pin_mux(1)) {
1243 dev_err(&pdev->dev, ": Requesting Peripherals failed\n");
1247 drv_data = spi_master_get_devdata(master);
1248 drv_data->master = master;
1249 drv_data->master_info = platform_info;
1250 drv_data->pdev = pdev;
1252 master->bus_num = pdev->id;
1253 master->num_chipselect = platform_info->num_chipselect;
1254 master->cleanup = cleanup;
1255 master->setup = setup;
1256 master->transfer = transfer;
1258 /* Find and map our resources */
1259 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1261 dev_err(dev, "Cannot get IORESOURCE_MEM\n");
1263 goto out_error_get_res;
1266 spi_regs_base = (u32) ioremap(res->start, (res->end - res->start)+1);
1267 if (!spi_regs_base) {
1268 dev_err(dev, "Cannot map IO\n");
1270 goto out_error_ioremap;
1273 spi_dma_ch = platform_get_irq(pdev, 0);
1274 if (spi_dma_ch < 0) {
1275 dev_err(dev, "No DMA channel specified\n");
1277 goto out_error_no_dma_ch;
1280 /* Initial and start queue */
1281 status = init_queue(drv_data);
1283 dev_err(dev, "problem initializing queue\n");
1284 goto out_error_queue_alloc;
1287 status = start_queue(drv_data);
1289 dev_err(dev, "problem starting queue\n");
1290 goto out_error_queue_alloc;
1293 /* Register with the SPI framework */
1294 platform_set_drvdata(pdev, drv_data);
1295 status = spi_register_master(master);
1297 dev_err(dev, "problem registering spi master\n");
1298 goto out_error_queue_alloc;
1301 dev_info(dev, "%s, Version %s, regs_base @ 0x%08x\n",
1302 DRV_DESC, DRV_VERSION, spi_regs_base);
1305 out_error_queue_alloc:
1306 destroy_queue(drv_data);
1307 out_error_no_dma_ch:
1308 iounmap((void *) spi_regs_base);
1312 spi_master_put(master);
1317 /* stop hardware and remove the driver */
1318 static int __devexit bfin5xx_spi_remove(struct platform_device *pdev)
1320 struct driver_data *drv_data = platform_get_drvdata(pdev);
1326 /* Remove the queue */
1327 status = destroy_queue(drv_data);
1331 /* Disable the SSP at the peripheral and SOC level */
1332 bfin_spi_disable(drv_data);
1335 if (drv_data->master_info->enable_dma) {
1336 if (dma_channel_active(spi_dma_ch))
1337 free_dma(spi_dma_ch);
1340 /* Disconnect from the SPI framework */
1341 spi_unregister_master(drv_data->master);
1345 /* Prevent double remove */
1346 platform_set_drvdata(pdev, NULL);
1352 static int bfin5xx_spi_suspend(struct platform_device *pdev, pm_message_t state)
1354 struct driver_data *drv_data = platform_get_drvdata(pdev);
1357 status = stop_queue(drv_data);
1362 bfin_spi_disable(drv_data);
1367 static int bfin5xx_spi_resume(struct platform_device *pdev)
1369 struct driver_data *drv_data = platform_get_drvdata(pdev);
1372 /* Enable the SPI interface */
1373 bfin_spi_enable(drv_data);
1375 /* Start the queue running */
1376 status = start_queue(drv_data);
1378 dev_err(&pdev->dev, "problem starting queue (%d)\n", status);
1385 #define bfin5xx_spi_suspend NULL
1386 #define bfin5xx_spi_resume NULL
1387 #endif /* CONFIG_PM */
1389 MODULE_ALIAS("bfin-spi-master"); /* for platform bus hotplug */
1390 static struct platform_driver bfin5xx_spi_driver = {
1393 .owner = THIS_MODULE,
1395 .suspend = bfin5xx_spi_suspend,
1396 .resume = bfin5xx_spi_resume,
1397 .remove = __devexit_p(bfin5xx_spi_remove),
1400 static int __init bfin5xx_spi_init(void)
1402 return platform_driver_probe(&bfin5xx_spi_driver, bfin5xx_spi_probe);
1404 module_init(bfin5xx_spi_init);
1406 static void __exit bfin5xx_spi_exit(void)
1408 platform_driver_unregister(&bfin5xx_spi_driver);
1410 module_exit(bfin5xx_spi_exit);