2 * Blackfin On-Chip SPI Driver
4 * Copyright 2004-2007 Analog Devices Inc.
6 * Enter bugs at http://blackfin.uclinux.org/
8 * Licensed under the GPL-2 or later.
11 #include <linux/init.h>
12 #include <linux/module.h>
13 #include <linux/delay.h>
14 #include <linux/device.h>
16 #include <linux/ioport.h>
17 #include <linux/irq.h>
18 #include <linux/errno.h>
19 #include <linux/interrupt.h>
20 #include <linux/platform_device.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/spi/spi.h>
23 #include <linux/workqueue.h>
26 #include <asm/portmux.h>
27 #include <asm/bfin5xx_spi.h>
28 #include <asm/cacheflush.h>
30 #define DRV_NAME "bfin-spi"
31 #define DRV_AUTHOR "Bryan Wu, Luke Yang"
32 #define DRV_DESC "Blackfin on-chip SPI Controller Driver"
33 #define DRV_VERSION "1.0"
35 MODULE_AUTHOR(DRV_AUTHOR);
36 MODULE_DESCRIPTION(DRV_DESC);
37 MODULE_LICENSE("GPL");
39 #define START_STATE ((void *)0)
40 #define RUNNING_STATE ((void *)1)
41 #define DONE_STATE ((void *)2)
42 #define ERROR_STATE ((void *)-1)
43 #define QUEUE_RUNNING 0
44 #define QUEUE_STOPPED 1
46 /* Value to send if no TX value is supplied */
47 #define SPI_IDLE_TXVAL 0x0000
50 /* Driver model hookup */
51 struct platform_device *pdev;
53 /* SPI framework hookup */
54 struct spi_master *master;
56 /* Regs base of SPI controller */
57 void __iomem *regs_base;
59 /* Pin request list */
63 struct bfin5xx_spi_master *master_info;
65 /* Driver message queue */
66 struct workqueue_struct *workqueue;
67 struct work_struct pump_messages;
69 struct list_head queue;
73 /* Message Transfer pump */
74 struct tasklet_struct pump_transfers;
76 /* Current message transfer state info */
77 struct spi_message *cur_msg;
78 struct spi_transfer *cur_transfer;
79 struct chip_data *cur_chip;
98 void (*write) (struct driver_data *);
99 void (*read) (struct driver_data *);
100 void (*duplex) (struct driver_data *);
110 u8 width; /* 0 or 1 */
112 u8 bits_per_word; /* 8 or 16 */
113 u8 cs_change_per_word;
114 u16 cs_chg_udelay; /* Some devices require > 255usec delay */
117 void (*write) (struct driver_data *);
118 void (*read) (struct driver_data *);
119 void (*duplex) (struct driver_data *);
122 #define DEFINE_SPI_REG(reg, off) \
123 static inline u16 read_##reg(struct driver_data *drv_data) \
124 { return bfin_read16(drv_data->regs_base + off); } \
125 static inline void write_##reg(struct driver_data *drv_data, u16 v) \
126 { bfin_write16(drv_data->regs_base + off, v); }
128 DEFINE_SPI_REG(CTRL, 0x00)
129 DEFINE_SPI_REG(FLAG, 0x04)
130 DEFINE_SPI_REG(STAT, 0x08)
131 DEFINE_SPI_REG(TDBR, 0x0C)
132 DEFINE_SPI_REG(RDBR, 0x10)
133 DEFINE_SPI_REG(BAUD, 0x14)
134 DEFINE_SPI_REG(SHAW, 0x18)
136 static void bfin_spi_enable(struct driver_data *drv_data)
140 cr = read_CTRL(drv_data);
141 write_CTRL(drv_data, (cr | BIT_CTL_ENABLE));
144 static void bfin_spi_disable(struct driver_data *drv_data)
148 cr = read_CTRL(drv_data);
149 write_CTRL(drv_data, (cr & (~BIT_CTL_ENABLE)));
152 /* Caculate the SPI_BAUD register value based on input HZ */
153 static u16 hz_to_spi_baud(u32 speed_hz)
155 u_long sclk = get_sclk();
156 u16 spi_baud = (sclk / (2 * speed_hz));
158 if ((sclk % (2 * speed_hz)) > 0)
161 if (spi_baud < MIN_SPI_BAUD_VAL)
162 spi_baud = MIN_SPI_BAUD_VAL;
167 static int bfin_spi_flush(struct driver_data *drv_data)
169 unsigned long limit = loops_per_jiffy << 1;
171 /* wait for stop and clear stat */
172 while (!(read_STAT(drv_data) & BIT_STAT_SPIF) && --limit)
175 write_STAT(drv_data, BIT_STAT_CLR);
180 /* Chip select operation functions for cs_change flag */
181 static void bfin_spi_cs_active(struct driver_data *drv_data, struct chip_data *chip)
183 if (likely(chip->chip_select_num)) {
184 u16 flag = read_FLAG(drv_data);
187 flag &= ~(chip->flag << 8);
189 write_FLAG(drv_data, flag);
191 gpio_set_value(chip->cs_gpio, 0);
195 static void bfin_spi_cs_deactive(struct driver_data *drv_data, struct chip_data *chip)
197 if (likely(chip->chip_select_num)) {
198 u16 flag = read_FLAG(drv_data);
201 flag |= (chip->flag << 8);
203 write_FLAG(drv_data, flag);
205 gpio_set_value(chip->cs_gpio, 1);
208 /* Move delay here for consistency */
209 if (chip->cs_chg_udelay)
210 udelay(chip->cs_chg_udelay);
213 /* stop controller and re-config current chip*/
214 static void bfin_spi_restore_state(struct driver_data *drv_data)
216 struct chip_data *chip = drv_data->cur_chip;
218 /* Clear status and disable clock */
219 write_STAT(drv_data, BIT_STAT_CLR);
220 bfin_spi_disable(drv_data);
221 dev_dbg(&drv_data->pdev->dev, "restoring spi ctl state\n");
223 /* Load the registers */
224 write_CTRL(drv_data, chip->ctl_reg);
225 write_BAUD(drv_data, chip->baud);
227 bfin_spi_enable(drv_data);
228 bfin_spi_cs_active(drv_data, chip);
231 /* used to kick off transfer in rx mode and read unwanted RX data */
232 static inline void bfin_spi_dummy_read(struct driver_data *drv_data)
234 (void) read_RDBR(drv_data);
237 static void bfin_spi_null_writer(struct driver_data *drv_data)
239 u8 n_bytes = drv_data->n_bytes;
240 u16 tx_val = drv_data->cur_chip->idle_tx_val;
242 /* clear RXS (we check for RXS inside the loop) */
243 bfin_spi_dummy_read(drv_data);
245 while (drv_data->tx < drv_data->tx_end) {
246 write_TDBR(drv_data, tx_val);
247 drv_data->tx += n_bytes;
248 /* wait until transfer finished.
249 checking SPIF or TXS may not guarantee transfer completion */
250 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
252 /* discard RX data and clear RXS */
253 bfin_spi_dummy_read(drv_data);
257 static void bfin_spi_null_reader(struct driver_data *drv_data)
259 u8 n_bytes = drv_data->n_bytes;
260 u16 tx_val = drv_data->cur_chip->idle_tx_val;
262 /* discard old RX data and clear RXS */
263 bfin_spi_dummy_read(drv_data);
265 while (drv_data->rx < drv_data->rx_end) {
266 write_TDBR(drv_data, tx_val);
267 drv_data->rx += n_bytes;
268 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
270 bfin_spi_dummy_read(drv_data);
274 static void bfin_spi_u8_writer(struct driver_data *drv_data)
276 /* clear RXS (we check for RXS inside the loop) */
277 bfin_spi_dummy_read(drv_data);
279 while (drv_data->tx < drv_data->tx_end) {
280 write_TDBR(drv_data, (*(u8 *) (drv_data->tx++)));
281 /* wait until transfer finished.
282 checking SPIF or TXS may not guarantee transfer completion */
283 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
285 /* discard RX data and clear RXS */
286 bfin_spi_dummy_read(drv_data);
290 static void bfin_spi_u8_cs_chg_writer(struct driver_data *drv_data)
292 struct chip_data *chip = drv_data->cur_chip;
294 /* clear RXS (we check for RXS inside the loop) */
295 bfin_spi_dummy_read(drv_data);
297 while (drv_data->tx < drv_data->tx_end) {
298 bfin_spi_cs_active(drv_data, chip);
299 write_TDBR(drv_data, (*(u8 *) (drv_data->tx++)));
300 /* make sure transfer finished before deactiving CS */
301 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
303 bfin_spi_dummy_read(drv_data);
304 bfin_spi_cs_deactive(drv_data, chip);
308 static void bfin_spi_u8_reader(struct driver_data *drv_data)
310 u16 tx_val = drv_data->cur_chip->idle_tx_val;
312 /* discard old RX data and clear RXS */
313 bfin_spi_dummy_read(drv_data);
315 while (drv_data->rx < drv_data->rx_end) {
316 write_TDBR(drv_data, tx_val);
317 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
319 *(u8 *) (drv_data->rx++) = read_RDBR(drv_data);
323 static void bfin_spi_u8_cs_chg_reader(struct driver_data *drv_data)
325 struct chip_data *chip = drv_data->cur_chip;
326 u16 tx_val = chip->idle_tx_val;
328 /* discard old RX data and clear RXS */
329 bfin_spi_dummy_read(drv_data);
331 while (drv_data->rx < drv_data->rx_end) {
332 bfin_spi_cs_active(drv_data, chip);
333 write_TDBR(drv_data, tx_val);
334 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
336 *(u8 *) (drv_data->rx++) = read_RDBR(drv_data);
337 bfin_spi_cs_deactive(drv_data, chip);
341 static void bfin_spi_u8_duplex(struct driver_data *drv_data)
343 /* discard old RX data and clear RXS */
344 bfin_spi_dummy_read(drv_data);
346 while (drv_data->rx < drv_data->rx_end) {
347 write_TDBR(drv_data, (*(u8 *) (drv_data->tx++)));
348 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
350 *(u8 *) (drv_data->rx++) = read_RDBR(drv_data);
354 static void bfin_spi_u8_cs_chg_duplex(struct driver_data *drv_data)
356 struct chip_data *chip = drv_data->cur_chip;
358 /* discard old RX data and clear RXS */
359 bfin_spi_dummy_read(drv_data);
361 while (drv_data->rx < drv_data->rx_end) {
362 bfin_spi_cs_active(drv_data, chip);
363 write_TDBR(drv_data, (*(u8 *) (drv_data->tx++)));
364 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
366 *(u8 *) (drv_data->rx++) = read_RDBR(drv_data);
367 bfin_spi_cs_deactive(drv_data, chip);
371 static void bfin_spi_u16_writer(struct driver_data *drv_data)
373 /* clear RXS (we check for RXS inside the loop) */
374 bfin_spi_dummy_read(drv_data);
376 while (drv_data->tx < drv_data->tx_end) {
377 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
379 /* wait until transfer finished.
380 checking SPIF or TXS may not guarantee transfer completion */
381 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
383 /* discard RX data and clear RXS */
384 bfin_spi_dummy_read(drv_data);
388 static void bfin_spi_u16_cs_chg_writer(struct driver_data *drv_data)
390 struct chip_data *chip = drv_data->cur_chip;
392 /* clear RXS (we check for RXS inside the loop) */
393 bfin_spi_dummy_read(drv_data);
395 while (drv_data->tx < drv_data->tx_end) {
396 bfin_spi_cs_active(drv_data, chip);
397 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
399 /* make sure transfer finished before deactiving CS */
400 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
402 bfin_spi_dummy_read(drv_data);
403 bfin_spi_cs_deactive(drv_data, chip);
407 static void bfin_spi_u16_reader(struct driver_data *drv_data)
409 u16 tx_val = drv_data->cur_chip->idle_tx_val;
411 /* discard old RX data and clear RXS */
412 bfin_spi_dummy_read(drv_data);
414 while (drv_data->rx < drv_data->rx_end) {
415 write_TDBR(drv_data, tx_val);
416 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
418 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
423 static void bfin_spi_u16_cs_chg_reader(struct driver_data *drv_data)
425 struct chip_data *chip = drv_data->cur_chip;
426 u16 tx_val = chip->idle_tx_val;
428 /* discard old RX data and clear RXS */
429 bfin_spi_dummy_read(drv_data);
431 while (drv_data->rx < drv_data->rx_end) {
432 bfin_spi_cs_active(drv_data, chip);
433 write_TDBR(drv_data, tx_val);
434 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
436 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
438 bfin_spi_cs_deactive(drv_data, chip);
442 static void bfin_spi_u16_duplex(struct driver_data *drv_data)
444 /* discard old RX data and clear RXS */
445 bfin_spi_dummy_read(drv_data);
447 while (drv_data->rx < drv_data->rx_end) {
448 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
450 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
452 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
457 static void bfin_spi_u16_cs_chg_duplex(struct driver_data *drv_data)
459 struct chip_data *chip = drv_data->cur_chip;
461 /* discard old RX data and clear RXS */
462 bfin_spi_dummy_read(drv_data);
464 while (drv_data->rx < drv_data->rx_end) {
465 bfin_spi_cs_active(drv_data, chip);
466 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
468 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
470 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
472 bfin_spi_cs_deactive(drv_data, chip);
476 /* test if ther is more transfer to be done */
477 static void *bfin_spi_next_transfer(struct driver_data *drv_data)
479 struct spi_message *msg = drv_data->cur_msg;
480 struct spi_transfer *trans = drv_data->cur_transfer;
482 /* Move to next transfer */
483 if (trans->transfer_list.next != &msg->transfers) {
484 drv_data->cur_transfer =
485 list_entry(trans->transfer_list.next,
486 struct spi_transfer, transfer_list);
487 return RUNNING_STATE;
493 * caller already set message->status;
494 * dma and pio irqs are blocked give finished message back
496 static void bfin_spi_giveback(struct driver_data *drv_data)
498 struct chip_data *chip = drv_data->cur_chip;
499 struct spi_transfer *last_transfer;
501 struct spi_message *msg;
503 spin_lock_irqsave(&drv_data->lock, flags);
504 msg = drv_data->cur_msg;
505 drv_data->cur_msg = NULL;
506 drv_data->cur_transfer = NULL;
507 drv_data->cur_chip = NULL;
508 queue_work(drv_data->workqueue, &drv_data->pump_messages);
509 spin_unlock_irqrestore(&drv_data->lock, flags);
511 last_transfer = list_entry(msg->transfers.prev,
512 struct spi_transfer, transfer_list);
516 if (!drv_data->cs_change)
517 bfin_spi_cs_deactive(drv_data, chip);
519 /* Not stop spi in autobuffer mode */
520 if (drv_data->tx_dma != 0xFFFF)
521 bfin_spi_disable(drv_data);
524 msg->complete(msg->context);
527 static irqreturn_t bfin_spi_dma_irq_handler(int irq, void *dev_id)
529 struct driver_data *drv_data = dev_id;
530 struct chip_data *chip = drv_data->cur_chip;
531 struct spi_message *msg = drv_data->cur_msg;
532 unsigned long timeout;
533 unsigned short dmastat = get_dma_curr_irqstat(drv_data->dma_channel);
534 u16 spistat = read_STAT(drv_data);
536 dev_dbg(&drv_data->pdev->dev,
537 "in dma_irq_handler dmastat:0x%x spistat:0x%x\n",
540 clear_dma_irqstat(drv_data->dma_channel);
542 /* Wait for DMA to complete */
543 while (get_dma_curr_irqstat(drv_data->dma_channel) & DMA_RUN)
547 * wait for the last transaction shifted out. HRM states:
548 * at this point there may still be data in the SPI DMA FIFO waiting
549 * to be transmitted ... software needs to poll TXS in the SPI_STAT
550 * register until it goes low for 2 successive reads
552 if (drv_data->tx != NULL) {
553 while ((read_STAT(drv_data) & TXS) ||
554 (read_STAT(drv_data) & TXS))
558 dev_dbg(&drv_data->pdev->dev,
559 "in dma_irq_handler dmastat:0x%x spistat:0x%x\n",
560 dmastat, read_STAT(drv_data));
562 timeout = jiffies + HZ;
563 while (!(read_STAT(drv_data) & SPIF))
564 if (!time_before(jiffies, timeout)) {
565 dev_warn(&drv_data->pdev->dev, "timeout waiting for SPIF");
570 if ((dmastat & DMA_ERR) && (spistat & RBSY)) {
571 msg->state = ERROR_STATE;
572 dev_err(&drv_data->pdev->dev, "dma receive: fifo/buffer overflow\n");
574 msg->actual_length += drv_data->len_in_bytes;
576 if (drv_data->cs_change)
577 bfin_spi_cs_deactive(drv_data, chip);
579 /* Move to next transfer */
580 msg->state = bfin_spi_next_transfer(drv_data);
583 /* Schedule transfer tasklet */
584 tasklet_schedule(&drv_data->pump_transfers);
586 /* free the irq handler before next transfer */
587 dev_dbg(&drv_data->pdev->dev,
588 "disable dma channel irq%d\n",
589 drv_data->dma_channel);
590 dma_disable_irq(drv_data->dma_channel);
595 static void bfin_spi_pump_transfers(unsigned long data)
597 struct driver_data *drv_data = (struct driver_data *)data;
598 struct spi_message *message = NULL;
599 struct spi_transfer *transfer = NULL;
600 struct spi_transfer *previous = NULL;
601 struct chip_data *chip = NULL;
603 u16 cr, dma_width, dma_config;
604 u32 tranf_success = 1;
607 /* Get current state information */
608 message = drv_data->cur_msg;
609 transfer = drv_data->cur_transfer;
610 chip = drv_data->cur_chip;
613 * if msg is error or done, report it back using complete() callback
616 /* Handle for abort */
617 if (message->state == ERROR_STATE) {
618 dev_dbg(&drv_data->pdev->dev, "transfer: we've hit an error\n");
619 message->status = -EIO;
620 bfin_spi_giveback(drv_data);
624 /* Handle end of message */
625 if (message->state == DONE_STATE) {
626 dev_dbg(&drv_data->pdev->dev, "transfer: all done!\n");
628 bfin_spi_giveback(drv_data);
632 /* Delay if requested at end of transfer */
633 if (message->state == RUNNING_STATE) {
634 dev_dbg(&drv_data->pdev->dev, "transfer: still running ...\n");
635 previous = list_entry(transfer->transfer_list.prev,
636 struct spi_transfer, transfer_list);
637 if (previous->delay_usecs)
638 udelay(previous->delay_usecs);
641 /* Setup the transfer state based on the type of transfer */
642 if (bfin_spi_flush(drv_data) == 0) {
643 dev_err(&drv_data->pdev->dev, "pump_transfers: flush failed\n");
644 message->status = -EIO;
645 bfin_spi_giveback(drv_data);
649 if (transfer->len == 0) {
650 /* Move to next transfer of this msg */
651 message->state = bfin_spi_next_transfer(drv_data);
652 /* Schedule next transfer tasklet */
653 tasklet_schedule(&drv_data->pump_transfers);
656 if (transfer->tx_buf != NULL) {
657 drv_data->tx = (void *)transfer->tx_buf;
658 drv_data->tx_end = drv_data->tx + transfer->len;
659 dev_dbg(&drv_data->pdev->dev, "tx_buf is %p, tx_end is %p\n",
660 transfer->tx_buf, drv_data->tx_end);
665 if (transfer->rx_buf != NULL) {
666 full_duplex = transfer->tx_buf != NULL;
667 drv_data->rx = transfer->rx_buf;
668 drv_data->rx_end = drv_data->rx + transfer->len;
669 dev_dbg(&drv_data->pdev->dev, "rx_buf is %p, rx_end is %p\n",
670 transfer->rx_buf, drv_data->rx_end);
675 drv_data->rx_dma = transfer->rx_dma;
676 drv_data->tx_dma = transfer->tx_dma;
677 drv_data->len_in_bytes = transfer->len;
678 drv_data->cs_change = transfer->cs_change;
680 /* Bits per word setup */
681 switch (transfer->bits_per_word) {
683 drv_data->n_bytes = 1;
684 width = CFG_SPI_WORDSIZE8;
685 drv_data->read = chip->cs_change_per_word ?
686 bfin_spi_u8_cs_chg_reader : bfin_spi_u8_reader;
687 drv_data->write = chip->cs_change_per_word ?
688 bfin_spi_u8_cs_chg_writer : bfin_spi_u8_writer;
689 drv_data->duplex = chip->cs_change_per_word ?
690 bfin_spi_u8_cs_chg_duplex : bfin_spi_u8_duplex;
694 drv_data->n_bytes = 2;
695 width = CFG_SPI_WORDSIZE16;
696 drv_data->read = chip->cs_change_per_word ?
697 bfin_spi_u16_cs_chg_reader : bfin_spi_u16_reader;
698 drv_data->write = chip->cs_change_per_word ?
699 bfin_spi_u16_cs_chg_writer : bfin_spi_u16_writer;
700 drv_data->duplex = chip->cs_change_per_word ?
701 bfin_spi_u16_cs_chg_duplex : bfin_spi_u16_duplex;
705 /* No change, the same as default setting */
706 drv_data->n_bytes = chip->n_bytes;
708 drv_data->write = drv_data->tx ? chip->write : bfin_spi_null_writer;
709 drv_data->read = drv_data->rx ? chip->read : bfin_spi_null_reader;
710 drv_data->duplex = chip->duplex ? chip->duplex : bfin_spi_null_writer;
713 cr = (read_CTRL(drv_data) & (~BIT_CTL_TIMOD));
715 write_CTRL(drv_data, cr);
717 if (width == CFG_SPI_WORDSIZE16) {
718 drv_data->len = (transfer->len) >> 1;
720 drv_data->len = transfer->len;
722 dev_dbg(&drv_data->pdev->dev,
723 "transfer: drv_data->write is %p, chip->write is %p, null_wr is %p\n",
724 drv_data->write, chip->write, bfin_spi_null_writer);
726 /* speed and width has been set on per message */
727 message->state = RUNNING_STATE;
730 /* Speed setup (surely valid because already checked) */
731 if (transfer->speed_hz)
732 write_BAUD(drv_data, hz_to_spi_baud(transfer->speed_hz));
734 write_BAUD(drv_data, chip->baud);
736 write_STAT(drv_data, BIT_STAT_CLR);
737 cr = (read_CTRL(drv_data) & (~BIT_CTL_TIMOD));
738 if (drv_data->cs_change)
739 bfin_spi_cs_active(drv_data, chip);
741 dev_dbg(&drv_data->pdev->dev,
742 "now pumping a transfer: width is %d, len is %d\n",
743 width, transfer->len);
746 * Try to map dma buffer and do a dma transfer. If successful use,
747 * different way to r/w according to the enable_dma settings and if
748 * we are not doing a full duplex transfer (since the hardware does
749 * not support full duplex DMA transfers).
751 if (!full_duplex && drv_data->cur_chip->enable_dma
752 && drv_data->len > 6) {
754 unsigned long dma_start_addr, flags;
756 disable_dma(drv_data->dma_channel);
757 clear_dma_irqstat(drv_data->dma_channel);
759 /* config dma channel */
760 dev_dbg(&drv_data->pdev->dev, "doing dma transfer\n");
761 set_dma_x_count(drv_data->dma_channel, drv_data->len);
762 if (width == CFG_SPI_WORDSIZE16) {
763 set_dma_x_modify(drv_data->dma_channel, 2);
764 dma_width = WDSIZE_16;
766 set_dma_x_modify(drv_data->dma_channel, 1);
767 dma_width = WDSIZE_8;
770 /* poll for SPI completion before start */
771 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
774 /* dirty hack for autobuffer DMA mode */
775 if (drv_data->tx_dma == 0xFFFF) {
776 dev_dbg(&drv_data->pdev->dev,
777 "doing autobuffer DMA out.\n");
779 /* no irq in autobuffer mode */
781 (DMAFLOW_AUTO | RESTART | dma_width | DI_EN);
782 set_dma_config(drv_data->dma_channel, dma_config);
783 set_dma_start_addr(drv_data->dma_channel,
784 (unsigned long)drv_data->tx);
785 enable_dma(drv_data->dma_channel);
787 /* start SPI transfer */
788 write_CTRL(drv_data, cr | BIT_CTL_TIMOD_DMA_TX);
790 /* just return here, there can only be one transfer
794 bfin_spi_giveback(drv_data);
798 /* In dma mode, rx or tx must be NULL in one transfer */
799 dma_config = (RESTART | dma_width | DI_EN);
800 if (drv_data->rx != NULL) {
801 /* set transfer mode, and enable SPI */
802 dev_dbg(&drv_data->pdev->dev, "doing DMA in to %p (size %zx)\n",
803 drv_data->rx, drv_data->len_in_bytes);
805 /* invalidate caches, if needed */
806 if (bfin_addr_dcacheable((unsigned long) drv_data->rx))
807 invalidate_dcache_range((unsigned long) drv_data->rx,
808 (unsigned long) (drv_data->rx +
809 drv_data->len_in_bytes));
812 dma_start_addr = (unsigned long)drv_data->rx;
813 cr |= BIT_CTL_TIMOD_DMA_RX | BIT_CTL_SENDOPT;
815 } else if (drv_data->tx != NULL) {
816 dev_dbg(&drv_data->pdev->dev, "doing DMA out.\n");
818 /* flush caches, if needed */
819 if (bfin_addr_dcacheable((unsigned long) drv_data->tx))
820 flush_dcache_range((unsigned long) drv_data->tx,
821 (unsigned long) (drv_data->tx +
822 drv_data->len_in_bytes));
824 dma_start_addr = (unsigned long)drv_data->tx;
825 cr |= BIT_CTL_TIMOD_DMA_TX;
830 /* oh man, here there be monsters ... and i dont mean the
831 * fluffy cute ones from pixar, i mean the kind that'll eat
832 * your data, kick your dog, and love it all. do *not* try
833 * and change these lines unless you (1) heavily test DMA
834 * with SPI flashes on a loaded system (e.g. ping floods),
835 * (2) know just how broken the DMA engine interaction with
836 * the SPI peripheral is, and (3) have someone else to blame
837 * when you screw it all up anyways.
839 set_dma_start_addr(drv_data->dma_channel, dma_start_addr);
840 set_dma_config(drv_data->dma_channel, dma_config);
841 local_irq_save(flags);
843 write_CTRL(drv_data, cr);
844 enable_dma(drv_data->dma_channel);
845 dma_enable_irq(drv_data->dma_channel);
846 local_irq_restore(flags);
849 /* IO mode write then read */
850 dev_dbg(&drv_data->pdev->dev, "doing IO transfer\n");
852 /* we always use SPI_WRITE mode. SPI_READ mode
853 seems to have problems with setting up the
854 output value in TDBR prior to the transfer. */
855 write_CTRL(drv_data, (cr | CFG_SPI_WRITE));
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 drv_data->duplex(drv_data);
866 if (drv_data->tx != drv_data->tx_end)
868 } else if (drv_data->tx != NULL) {
869 /* write only half duplex */
870 dev_dbg(&drv_data->pdev->dev,
871 "IO write: cr is 0x%x\n", cr);
873 drv_data->write(drv_data);
875 if (drv_data->tx != drv_data->tx_end)
877 } else if (drv_data->rx != NULL) {
878 /* read only half duplex */
879 dev_dbg(&drv_data->pdev->dev,
880 "IO read: cr is 0x%x\n", cr);
882 drv_data->read(drv_data);
883 if (drv_data->rx != drv_data->rx_end)
887 if (!tranf_success) {
888 dev_dbg(&drv_data->pdev->dev,
889 "IO write error!\n");
890 message->state = ERROR_STATE;
892 /* Update total byte transfered */
893 message->actual_length += drv_data->len_in_bytes;
894 /* Move to next transfer of this msg */
895 message->state = bfin_spi_next_transfer(drv_data);
896 if (drv_data->cs_change)
897 bfin_spi_cs_deactive(drv_data, chip);
899 /* Schedule next transfer tasklet */
900 tasklet_schedule(&drv_data->pump_transfers);
904 /* pop a msg from queue and kick off real transfer */
905 static void bfin_spi_pump_messages(struct work_struct *work)
907 struct driver_data *drv_data;
910 drv_data = container_of(work, struct driver_data, pump_messages);
912 /* Lock queue and check for queue work */
913 spin_lock_irqsave(&drv_data->lock, flags);
914 if (list_empty(&drv_data->queue) || drv_data->run == QUEUE_STOPPED) {
915 /* pumper kicked off but no work to do */
917 spin_unlock_irqrestore(&drv_data->lock, flags);
921 /* Make sure we are not already running a message */
922 if (drv_data->cur_msg) {
923 spin_unlock_irqrestore(&drv_data->lock, flags);
927 /* Extract head of queue */
928 drv_data->cur_msg = list_entry(drv_data->queue.next,
929 struct spi_message, queue);
931 /* Setup the SSP using the per chip configuration */
932 drv_data->cur_chip = spi_get_ctldata(drv_data->cur_msg->spi);
933 bfin_spi_restore_state(drv_data);
935 list_del_init(&drv_data->cur_msg->queue);
937 /* Initial message state */
938 drv_data->cur_msg->state = START_STATE;
939 drv_data->cur_transfer = list_entry(drv_data->cur_msg->transfers.next,
940 struct spi_transfer, transfer_list);
942 dev_dbg(&drv_data->pdev->dev, "got a message to pump, "
943 "state is set to: baud %d, flag 0x%x, ctl 0x%x\n",
944 drv_data->cur_chip->baud, drv_data->cur_chip->flag,
945 drv_data->cur_chip->ctl_reg);
947 dev_dbg(&drv_data->pdev->dev,
948 "the first transfer len is %d\n",
949 drv_data->cur_transfer->len);
951 /* Mark as busy and launch transfers */
952 tasklet_schedule(&drv_data->pump_transfers);
955 spin_unlock_irqrestore(&drv_data->lock, flags);
959 * got a msg to transfer, queue it in drv_data->queue.
960 * And kick off message pumper
962 static int bfin_spi_transfer(struct spi_device *spi, struct spi_message *msg)
964 struct driver_data *drv_data = spi_master_get_devdata(spi->master);
967 spin_lock_irqsave(&drv_data->lock, flags);
969 if (drv_data->run == QUEUE_STOPPED) {
970 spin_unlock_irqrestore(&drv_data->lock, flags);
974 msg->actual_length = 0;
975 msg->status = -EINPROGRESS;
976 msg->state = START_STATE;
978 dev_dbg(&spi->dev, "adding an msg in transfer() \n");
979 list_add_tail(&msg->queue, &drv_data->queue);
981 if (drv_data->run == QUEUE_RUNNING && !drv_data->busy)
982 queue_work(drv_data->workqueue, &drv_data->pump_messages);
984 spin_unlock_irqrestore(&drv_data->lock, flags);
989 #define MAX_SPI_SSEL 7
991 static u16 ssel[][MAX_SPI_SSEL] = {
992 {P_SPI0_SSEL1, P_SPI0_SSEL2, P_SPI0_SSEL3,
993 P_SPI0_SSEL4, P_SPI0_SSEL5,
994 P_SPI0_SSEL6, P_SPI0_SSEL7},
996 {P_SPI1_SSEL1, P_SPI1_SSEL2, P_SPI1_SSEL3,
997 P_SPI1_SSEL4, P_SPI1_SSEL5,
998 P_SPI1_SSEL6, P_SPI1_SSEL7},
1000 {P_SPI2_SSEL1, P_SPI2_SSEL2, P_SPI2_SSEL3,
1001 P_SPI2_SSEL4, P_SPI2_SSEL5,
1002 P_SPI2_SSEL6, P_SPI2_SSEL7},
1005 /* first setup for new devices */
1006 static int bfin_spi_setup(struct spi_device *spi)
1008 struct bfin5xx_spi_chip *chip_info = NULL;
1009 struct chip_data *chip;
1010 struct driver_data *drv_data = spi_master_get_devdata(spi->master);
1013 if (spi->bits_per_word != 8 && spi->bits_per_word != 16)
1016 /* Only alloc (or use chip_info) on first setup */
1017 chip = spi_get_ctldata(spi);
1019 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
1023 chip->enable_dma = 0;
1024 chip_info = spi->controller_data;
1027 /* chip_info isn't always needed */
1029 /* Make sure people stop trying to set fields via ctl_reg
1030 * when they should actually be using common SPI framework.
1031 * Currently we let through: WOM EMISO PSSE GM SZ TIMOD.
1032 * Not sure if a user actually needs/uses any of these,
1033 * but let's assume (for now) they do.
1035 if (chip_info->ctl_reg & (SPE|MSTR|CPOL|CPHA|LSBF|SIZE)) {
1036 dev_err(&spi->dev, "do not set bits in ctl_reg "
1037 "that the SPI framework manages\n");
1041 chip->enable_dma = chip_info->enable_dma != 0
1042 && drv_data->master_info->enable_dma;
1043 chip->ctl_reg = chip_info->ctl_reg;
1044 chip->bits_per_word = chip_info->bits_per_word;
1045 chip->cs_change_per_word = chip_info->cs_change_per_word;
1046 chip->cs_chg_udelay = chip_info->cs_chg_udelay;
1047 chip->cs_gpio = chip_info->cs_gpio;
1048 chip->idle_tx_val = chip_info->idle_tx_val;
1051 /* translate common spi framework into our register */
1052 if (spi->mode & SPI_CPOL)
1053 chip->ctl_reg |= CPOL;
1054 if (spi->mode & SPI_CPHA)
1055 chip->ctl_reg |= CPHA;
1056 if (spi->mode & SPI_LSB_FIRST)
1057 chip->ctl_reg |= LSBF;
1058 /* we dont support running in slave mode (yet?) */
1059 chip->ctl_reg |= MSTR;
1062 * if any one SPI chip is registered and wants DMA, request the
1063 * DMA channel for it
1065 if (chip->enable_dma && !drv_data->dma_requested) {
1066 /* register dma irq handler */
1067 if (request_dma(drv_data->dma_channel, "BFIN_SPI_DMA") < 0) {
1069 "Unable to request BlackFin SPI DMA channel\n");
1072 if (set_dma_callback(drv_data->dma_channel,
1073 bfin_spi_dma_irq_handler, drv_data) < 0) {
1074 dev_dbg(&spi->dev, "Unable to set dma callback\n");
1077 dma_disable_irq(drv_data->dma_channel);
1078 drv_data->dma_requested = 1;
1082 * Notice: for blackfin, the speed_hz is the value of register
1083 * SPI_BAUD, not the real baudrate
1085 chip->baud = hz_to_spi_baud(spi->max_speed_hz);
1086 chip->flag = 1 << (spi->chip_select);
1087 chip->chip_select_num = spi->chip_select;
1089 if (chip->chip_select_num == 0) {
1090 ret = gpio_request(chip->cs_gpio, spi->modalias);
1092 if (drv_data->dma_requested)
1093 free_dma(drv_data->dma_channel);
1096 gpio_direction_output(chip->cs_gpio, 1);
1099 switch (chip->bits_per_word) {
1102 chip->width = CFG_SPI_WORDSIZE8;
1103 chip->read = chip->cs_change_per_word ?
1104 bfin_spi_u8_cs_chg_reader : bfin_spi_u8_reader;
1105 chip->write = chip->cs_change_per_word ?
1106 bfin_spi_u8_cs_chg_writer : bfin_spi_u8_writer;
1107 chip->duplex = chip->cs_change_per_word ?
1108 bfin_spi_u8_cs_chg_duplex : bfin_spi_u8_duplex;
1113 chip->width = CFG_SPI_WORDSIZE16;
1114 chip->read = chip->cs_change_per_word ?
1115 bfin_spi_u16_cs_chg_reader : bfin_spi_u16_reader;
1116 chip->write = chip->cs_change_per_word ?
1117 bfin_spi_u16_cs_chg_writer : bfin_spi_u16_writer;
1118 chip->duplex = chip->cs_change_per_word ?
1119 bfin_spi_u16_cs_chg_duplex : bfin_spi_u16_duplex;
1123 dev_err(&spi->dev, "%d bits_per_word is not supported\n",
1124 chip->bits_per_word);
1130 dev_dbg(&spi->dev, "setup spi chip %s, width is %d, dma is %d\n",
1131 spi->modalias, chip->width, chip->enable_dma);
1132 dev_dbg(&spi->dev, "ctl_reg is 0x%x, flag_reg is 0x%x\n",
1133 chip->ctl_reg, chip->flag);
1135 spi_set_ctldata(spi, chip);
1137 dev_dbg(&spi->dev, "chip select number is %d\n", chip->chip_select_num);
1138 if ((chip->chip_select_num > 0)
1139 && (chip->chip_select_num <= spi->master->num_chipselect))
1140 peripheral_request(ssel[spi->master->bus_num]
1141 [chip->chip_select_num-1], spi->modalias);
1143 bfin_spi_cs_deactive(drv_data, chip);
1149 * callback for spi framework.
1150 * clean driver specific data
1152 static void bfin_spi_cleanup(struct spi_device *spi)
1154 struct chip_data *chip = spi_get_ctldata(spi);
1159 if ((chip->chip_select_num > 0)
1160 && (chip->chip_select_num <= spi->master->num_chipselect))
1161 peripheral_free(ssel[spi->master->bus_num]
1162 [chip->chip_select_num-1]);
1164 if (chip->chip_select_num == 0)
1165 gpio_free(chip->cs_gpio);
1170 static inline int bfin_spi_init_queue(struct driver_data *drv_data)
1172 INIT_LIST_HEAD(&drv_data->queue);
1173 spin_lock_init(&drv_data->lock);
1175 drv_data->run = QUEUE_STOPPED;
1178 /* init transfer tasklet */
1179 tasklet_init(&drv_data->pump_transfers,
1180 bfin_spi_pump_transfers, (unsigned long)drv_data);
1182 /* init messages workqueue */
1183 INIT_WORK(&drv_data->pump_messages, bfin_spi_pump_messages);
1184 drv_data->workqueue = create_singlethread_workqueue(
1185 dev_name(drv_data->master->dev.parent));
1186 if (drv_data->workqueue == NULL)
1192 static inline int bfin_spi_start_queue(struct driver_data *drv_data)
1194 unsigned long flags;
1196 spin_lock_irqsave(&drv_data->lock, flags);
1198 if (drv_data->run == QUEUE_RUNNING || drv_data->busy) {
1199 spin_unlock_irqrestore(&drv_data->lock, flags);
1203 drv_data->run = QUEUE_RUNNING;
1204 drv_data->cur_msg = NULL;
1205 drv_data->cur_transfer = NULL;
1206 drv_data->cur_chip = NULL;
1207 spin_unlock_irqrestore(&drv_data->lock, flags);
1209 queue_work(drv_data->workqueue, &drv_data->pump_messages);
1214 static inline int bfin_spi_stop_queue(struct driver_data *drv_data)
1216 unsigned long flags;
1217 unsigned limit = 500;
1220 spin_lock_irqsave(&drv_data->lock, flags);
1223 * This is a bit lame, but is optimized for the common execution path.
1224 * A wait_queue on the drv_data->busy could be used, but then the common
1225 * execution path (pump_messages) would be required to call wake_up or
1226 * friends on every SPI message. Do this instead
1228 drv_data->run = QUEUE_STOPPED;
1229 while (!list_empty(&drv_data->queue) && drv_data->busy && limit--) {
1230 spin_unlock_irqrestore(&drv_data->lock, flags);
1232 spin_lock_irqsave(&drv_data->lock, flags);
1235 if (!list_empty(&drv_data->queue) || drv_data->busy)
1238 spin_unlock_irqrestore(&drv_data->lock, flags);
1243 static inline int bfin_spi_destroy_queue(struct driver_data *drv_data)
1247 status = bfin_spi_stop_queue(drv_data);
1251 destroy_workqueue(drv_data->workqueue);
1256 static int __init bfin_spi_probe(struct platform_device *pdev)
1258 struct device *dev = &pdev->dev;
1259 struct bfin5xx_spi_master *platform_info;
1260 struct spi_master *master;
1261 struct driver_data *drv_data = 0;
1262 struct resource *res;
1265 platform_info = dev->platform_data;
1267 /* Allocate master with space for drv_data */
1268 master = spi_alloc_master(dev, sizeof(struct driver_data) + 16);
1270 dev_err(&pdev->dev, "can not alloc spi_master\n");
1274 drv_data = spi_master_get_devdata(master);
1275 drv_data->master = master;
1276 drv_data->master_info = platform_info;
1277 drv_data->pdev = pdev;
1278 drv_data->pin_req = platform_info->pin_req;
1280 /* the spi->mode bits supported by this driver: */
1281 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_LSB_FIRST;
1283 master->bus_num = pdev->id;
1284 master->num_chipselect = platform_info->num_chipselect;
1285 master->cleanup = bfin_spi_cleanup;
1286 master->setup = bfin_spi_setup;
1287 master->transfer = bfin_spi_transfer;
1289 /* Find and map our resources */
1290 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1292 dev_err(dev, "Cannot get IORESOURCE_MEM\n");
1294 goto out_error_get_res;
1297 drv_data->regs_base = ioremap(res->start, (res->end - res->start + 1));
1298 if (drv_data->regs_base == NULL) {
1299 dev_err(dev, "Cannot map IO\n");
1301 goto out_error_ioremap;
1304 drv_data->dma_channel = platform_get_irq(pdev, 0);
1305 if (drv_data->dma_channel < 0) {
1306 dev_err(dev, "No DMA channel specified\n");
1308 goto out_error_no_dma_ch;
1311 /* Initial and start queue */
1312 status = bfin_spi_init_queue(drv_data);
1314 dev_err(dev, "problem initializing queue\n");
1315 goto out_error_queue_alloc;
1318 status = bfin_spi_start_queue(drv_data);
1320 dev_err(dev, "problem starting queue\n");
1321 goto out_error_queue_alloc;
1324 status = peripheral_request_list(drv_data->pin_req, DRV_NAME);
1326 dev_err(&pdev->dev, ": Requesting Peripherals failed\n");
1327 goto out_error_queue_alloc;
1330 /* Register with the SPI framework */
1331 platform_set_drvdata(pdev, drv_data);
1332 status = spi_register_master(master);
1334 dev_err(dev, "problem registering spi master\n");
1335 goto out_error_queue_alloc;
1338 dev_info(dev, "%s, Version %s, regs_base@%p, dma channel@%d\n",
1339 DRV_DESC, DRV_VERSION, drv_data->regs_base,
1340 drv_data->dma_channel);
1343 out_error_queue_alloc:
1344 bfin_spi_destroy_queue(drv_data);
1345 out_error_no_dma_ch:
1346 iounmap((void *) drv_data->regs_base);
1349 spi_master_put(master);
1354 /* stop hardware and remove the driver */
1355 static int __devexit bfin_spi_remove(struct platform_device *pdev)
1357 struct driver_data *drv_data = platform_get_drvdata(pdev);
1363 /* Remove the queue */
1364 status = bfin_spi_destroy_queue(drv_data);
1368 /* Disable the SSP at the peripheral and SOC level */
1369 bfin_spi_disable(drv_data);
1372 if (drv_data->master_info->enable_dma) {
1373 if (dma_channel_active(drv_data->dma_channel))
1374 free_dma(drv_data->dma_channel);
1377 /* Disconnect from the SPI framework */
1378 spi_unregister_master(drv_data->master);
1380 peripheral_free_list(drv_data->pin_req);
1382 /* Prevent double remove */
1383 platform_set_drvdata(pdev, NULL);
1389 static int bfin_spi_suspend(struct platform_device *pdev, pm_message_t state)
1391 struct driver_data *drv_data = platform_get_drvdata(pdev);
1394 status = bfin_spi_stop_queue(drv_data);
1399 bfin_spi_disable(drv_data);
1404 static int bfin_spi_resume(struct platform_device *pdev)
1406 struct driver_data *drv_data = platform_get_drvdata(pdev);
1409 /* Enable the SPI interface */
1410 bfin_spi_enable(drv_data);
1412 /* Start the queue running */
1413 status = bfin_spi_start_queue(drv_data);
1415 dev_err(&pdev->dev, "problem starting queue (%d)\n", status);
1422 #define bfin_spi_suspend NULL
1423 #define bfin_spi_resume NULL
1424 #endif /* CONFIG_PM */
1426 MODULE_ALIAS("platform:bfin-spi");
1427 static struct platform_driver bfin_spi_driver = {
1430 .owner = THIS_MODULE,
1432 .suspend = bfin_spi_suspend,
1433 .resume = bfin_spi_resume,
1434 .remove = __devexit_p(bfin_spi_remove),
1437 static int __init bfin_spi_init(void)
1439 return platform_driver_probe(&bfin_spi_driver, bfin_spi_probe);
1441 module_init(bfin_spi_init);
1443 static void __exit bfin_spi_exit(void)
1445 platform_driver_unregister(&bfin_spi_driver);
1447 module_exit(bfin_spi_exit);