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>
 
  29 #define DRV_NAME        "bfin-spi"
 
  30 #define DRV_AUTHOR      "Bryan Wu, Luke Yang"
 
  31 #define DRV_DESC        "Blackfin BF5xx on-chip SPI Controller Driver"
 
  32 #define DRV_VERSION     "1.0"
 
  34 MODULE_AUTHOR(DRV_AUTHOR);
 
  35 MODULE_DESCRIPTION(DRV_DESC);
 
  36 MODULE_LICENSE("GPL");
 
  38 #define IS_DMA_ALIGNED(x) (((u32)(x)&0x07) == 0)
 
  40 #define START_STATE     ((void *)0)
 
  41 #define RUNNING_STATE   ((void *)1)
 
  42 #define DONE_STATE      ((void *)2)
 
  43 #define ERROR_STATE     ((void *)-1)
 
  44 #define QUEUE_RUNNING   0
 
  45 #define QUEUE_STOPPED   1
 
  48         /* Driver model hookup */
 
  49         struct platform_device *pdev;
 
  51         /* SPI framework hookup */
 
  52         struct spi_master *master;
 
  54         /* Regs base of SPI controller */
 
  55         void __iomem *regs_base;
 
  57         /* Pin request list */
 
  61         struct bfin5xx_spi_master *master_info;
 
  63         /* Driver message queue */
 
  64         struct workqueue_struct *workqueue;
 
  65         struct work_struct pump_messages;
 
  67         struct list_head queue;
 
  71         /* Message Transfer pump */
 
  72         struct tasklet_struct pump_transfers;
 
  74         /* Current message transfer state info */
 
  75         struct spi_message *cur_msg;
 
  76         struct spi_transfer *cur_transfer;
 
  77         struct chip_data *cur_chip;
 
  96         void (*write) (struct driver_data *);
 
  97         void (*read) (struct driver_data *);
 
  98         void (*duplex) (struct driver_data *);
 
 108         u8 width;               /* 0 or 1 */
 
 110         u8 bits_per_word;       /* 8 or 16 */
 
 111         u8 cs_change_per_word;
 
 112         u16 cs_chg_udelay;      /* Some devices require > 255usec delay */
 
 113         void (*write) (struct driver_data *);
 
 114         void (*read) (struct driver_data *);
 
 115         void (*duplex) (struct driver_data *);
 
 118 #define DEFINE_SPI_REG(reg, off) \
 
 119 static inline u16 read_##reg(struct driver_data *drv_data) \
 
 120         { return bfin_read16(drv_data->regs_base + off); } \
 
 121 static inline void write_##reg(struct driver_data *drv_data, u16 v) \
 
 122         { bfin_write16(drv_data->regs_base + off, v); }
 
 124 DEFINE_SPI_REG(CTRL, 0x00)
 
 125 DEFINE_SPI_REG(FLAG, 0x04)
 
 126 DEFINE_SPI_REG(STAT, 0x08)
 
 127 DEFINE_SPI_REG(TDBR, 0x0C)
 
 128 DEFINE_SPI_REG(RDBR, 0x10)
 
 129 DEFINE_SPI_REG(BAUD, 0x14)
 
 130 DEFINE_SPI_REG(SHAW, 0x18)
 
 132 static void bfin_spi_enable(struct driver_data *drv_data)
 
 136         cr = read_CTRL(drv_data);
 
 137         write_CTRL(drv_data, (cr | BIT_CTL_ENABLE));
 
 140 static void bfin_spi_disable(struct driver_data *drv_data)
 
 144         cr = read_CTRL(drv_data);
 
 145         write_CTRL(drv_data, (cr & (~BIT_CTL_ENABLE)));
 
 148 /* Caculate the SPI_BAUD register value based on input HZ */
 
 149 static u16 hz_to_spi_baud(u32 speed_hz)
 
 151         u_long sclk = get_sclk();
 
 152         u16 spi_baud = (sclk / (2 * speed_hz));
 
 154         if ((sclk % (2 * speed_hz)) > 0)
 
 160 static int flush(struct driver_data *drv_data)
 
 162         unsigned long limit = loops_per_jiffy << 1;
 
 164         /* wait for stop and clear stat */
 
 165         while (!(read_STAT(drv_data) & BIT_STAT_SPIF) && limit--)
 
 168         write_STAT(drv_data, BIT_STAT_CLR);
 
 173 /* Chip select operation functions for cs_change flag */
 
 174 static void cs_active(struct driver_data *drv_data, struct chip_data *chip)
 
 176         u16 flag = read_FLAG(drv_data);
 
 179         flag &= ~(chip->flag << 8);
 
 181         write_FLAG(drv_data, flag);
 
 184 static void cs_deactive(struct driver_data *drv_data, struct chip_data *chip)
 
 186         u16 flag = read_FLAG(drv_data);
 
 188         flag |= (chip->flag << 8);
 
 190         write_FLAG(drv_data, flag);
 
 192         /* Move delay here for consistency */
 
 193         if (chip->cs_chg_udelay)
 
 194                 udelay(chip->cs_chg_udelay);
 
 197 #define MAX_SPI_SSEL    7
 
 199 /* stop controller and re-config current chip*/
 
 200 static void restore_state(struct driver_data *drv_data)
 
 202         struct chip_data *chip = drv_data->cur_chip;
 
 204         /* Clear status and disable clock */
 
 205         write_STAT(drv_data, BIT_STAT_CLR);
 
 206         bfin_spi_disable(drv_data);
 
 207         dev_dbg(&drv_data->pdev->dev, "restoring spi ctl state\n");
 
 209         /* Load the registers */
 
 210         write_CTRL(drv_data, chip->ctl_reg);
 
 211         write_BAUD(drv_data, chip->baud);
 
 213         bfin_spi_enable(drv_data);
 
 214         cs_active(drv_data, chip);
 
 217 /* used to kick off transfer in rx mode */
 
 218 static unsigned short dummy_read(struct driver_data *drv_data)
 
 221         tmp = read_RDBR(drv_data);
 
 225 static void null_writer(struct driver_data *drv_data)
 
 227         u8 n_bytes = drv_data->n_bytes;
 
 229         while (drv_data->tx < drv_data->tx_end) {
 
 230                 write_TDBR(drv_data, 0);
 
 231                 while ((read_STAT(drv_data) & BIT_STAT_TXS))
 
 233                 drv_data->tx += n_bytes;
 
 237 static void null_reader(struct driver_data *drv_data)
 
 239         u8 n_bytes = drv_data->n_bytes;
 
 240         dummy_read(drv_data);
 
 242         while (drv_data->rx < drv_data->rx_end) {
 
 243                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 245                 dummy_read(drv_data);
 
 246                 drv_data->rx += n_bytes;
 
 250 static void u8_writer(struct driver_data *drv_data)
 
 252         dev_dbg(&drv_data->pdev->dev,
 
 253                 "cr8-s is 0x%x\n", read_STAT(drv_data));
 
 255         while (drv_data->tx < drv_data->tx_end) {
 
 256                 write_TDBR(drv_data, (*(u8 *) (drv_data->tx)));
 
 257                 while (read_STAT(drv_data) & BIT_STAT_TXS)
 
 262         /* poll for SPI completion before return */
 
 263         while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 267 static void u8_cs_chg_writer(struct driver_data *drv_data)
 
 269         struct chip_data *chip = drv_data->cur_chip;
 
 271         while (drv_data->tx < drv_data->tx_end) {
 
 272                 cs_active(drv_data, chip);
 
 274                 write_TDBR(drv_data, (*(u8 *) (drv_data->tx)));
 
 275                 while (read_STAT(drv_data) & BIT_STAT_TXS)
 
 277                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 280                 cs_deactive(drv_data, chip);
 
 286 static void u8_reader(struct driver_data *drv_data)
 
 288         dev_dbg(&drv_data->pdev->dev,
 
 289                 "cr-8 is 0x%x\n", read_STAT(drv_data));
 
 291         /* poll for SPI completion before start */
 
 292         while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 295         /* clear TDBR buffer before read(else it will be shifted out) */
 
 296         write_TDBR(drv_data, 0xFFFF);
 
 298         dummy_read(drv_data);
 
 300         while (drv_data->rx < drv_data->rx_end - 1) {
 
 301                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 303                 *(u8 *) (drv_data->rx) = read_RDBR(drv_data);
 
 307         while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 309         *(u8 *) (drv_data->rx) = read_SHAW(drv_data);
 
 313 static void u8_cs_chg_reader(struct driver_data *drv_data)
 
 315         struct chip_data *chip = drv_data->cur_chip;
 
 317         while (drv_data->rx < drv_data->rx_end) {
 
 318                 cs_active(drv_data, chip);
 
 319                 read_RDBR(drv_data);    /* kick off */
 
 321                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 323                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 326                 *(u8 *) (drv_data->rx) = read_SHAW(drv_data);
 
 327                 cs_deactive(drv_data, chip);
 
 333 static void u8_duplex(struct driver_data *drv_data)
 
 335         /* in duplex mode, clk is triggered by writing of TDBR */
 
 336         while (drv_data->rx < drv_data->rx_end) {
 
 337                 write_TDBR(drv_data, (*(u8 *) (drv_data->tx)));
 
 338                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 340                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 342                 *(u8 *) (drv_data->rx) = read_RDBR(drv_data);
 
 348 static void u8_cs_chg_duplex(struct driver_data *drv_data)
 
 350         struct chip_data *chip = drv_data->cur_chip;
 
 352         while (drv_data->rx < drv_data->rx_end) {
 
 353                 cs_active(drv_data, chip);
 
 355                 write_TDBR(drv_data, (*(u8 *) (drv_data->tx)));
 
 357                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 359                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 361                 *(u8 *) (drv_data->rx) = read_RDBR(drv_data);
 
 363                 cs_deactive(drv_data, chip);
 
 370 static void u16_writer(struct driver_data *drv_data)
 
 372         dev_dbg(&drv_data->pdev->dev,
 
 373                 "cr16 is 0x%x\n", read_STAT(drv_data));
 
 375         while (drv_data->tx < drv_data->tx_end) {
 
 376                 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
 
 377                 while ((read_STAT(drv_data) & BIT_STAT_TXS))
 
 382         /* poll for SPI completion before return */
 
 383         while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 387 static void u16_cs_chg_writer(struct driver_data *drv_data)
 
 389         struct chip_data *chip = drv_data->cur_chip;
 
 391         while (drv_data->tx < drv_data->tx_end) {
 
 392                 cs_active(drv_data, chip);
 
 394                 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
 
 395                 while ((read_STAT(drv_data) & BIT_STAT_TXS))
 
 397                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 400                 cs_deactive(drv_data, chip);
 
 406 static void u16_reader(struct driver_data *drv_data)
 
 408         dev_dbg(&drv_data->pdev->dev,
 
 409                 "cr-16 is 0x%x\n", read_STAT(drv_data));
 
 411         /* poll for SPI completion before start */
 
 412         while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 415         /* clear TDBR buffer before read(else it will be shifted out) */
 
 416         write_TDBR(drv_data, 0xFFFF);
 
 418         dummy_read(drv_data);
 
 420         while (drv_data->rx < (drv_data->rx_end - 2)) {
 
 421                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 423                 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
 
 427         while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 429         *(u16 *) (drv_data->rx) = read_SHAW(drv_data);
 
 433 static void u16_cs_chg_reader(struct driver_data *drv_data)
 
 435         struct chip_data *chip = drv_data->cur_chip;
 
 437         /* poll for SPI completion before start */
 
 438         while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 441         /* clear TDBR buffer before read(else it will be shifted out) */
 
 442         write_TDBR(drv_data, 0xFFFF);
 
 444         cs_active(drv_data, chip);
 
 445         dummy_read(drv_data);
 
 447         while (drv_data->rx < drv_data->rx_end - 2) {
 
 448                 cs_deactive(drv_data, chip);
 
 450                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 452                 cs_active(drv_data, chip);
 
 453                 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
 
 456         cs_deactive(drv_data, chip);
 
 458         while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 460         *(u16 *) (drv_data->rx) = read_SHAW(drv_data);
 
 464 static void u16_duplex(struct driver_data *drv_data)
 
 466         /* in duplex mode, clk is triggered by writing of TDBR */
 
 467         while (drv_data->tx < drv_data->tx_end) {
 
 468                 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
 
 469                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 471                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 473                 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
 
 479 static void u16_cs_chg_duplex(struct driver_data *drv_data)
 
 481         struct chip_data *chip = drv_data->cur_chip;
 
 483         while (drv_data->tx < drv_data->tx_end) {
 
 484                 cs_active(drv_data, chip);
 
 486                 write_TDBR(drv_data, (*(u16 *) (drv_data->tx)));
 
 487                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 489                 while (!(read_STAT(drv_data) & BIT_STAT_RXS))
 
 491                 *(u16 *) (drv_data->rx) = read_RDBR(drv_data);
 
 493                 cs_deactive(drv_data, chip);
 
 500 /* test if ther is more transfer to be done */
 
 501 static void *next_transfer(struct driver_data *drv_data)
 
 503         struct spi_message *msg = drv_data->cur_msg;
 
 504         struct spi_transfer *trans = drv_data->cur_transfer;
 
 506         /* Move to next transfer */
 
 507         if (trans->transfer_list.next != &msg->transfers) {
 
 508                 drv_data->cur_transfer =
 
 509                     list_entry(trans->transfer_list.next,
 
 510                                struct spi_transfer, transfer_list);
 
 511                 return RUNNING_STATE;
 
 517  * caller already set message->status;
 
 518  * dma and pio irqs are blocked give finished message back
 
 520 static void giveback(struct driver_data *drv_data)
 
 522         struct chip_data *chip = drv_data->cur_chip;
 
 523         struct spi_transfer *last_transfer;
 
 525         struct spi_message *msg;
 
 527         spin_lock_irqsave(&drv_data->lock, flags);
 
 528         msg = drv_data->cur_msg;
 
 529         drv_data->cur_msg = NULL;
 
 530         drv_data->cur_transfer = NULL;
 
 531         drv_data->cur_chip = NULL;
 
 532         queue_work(drv_data->workqueue, &drv_data->pump_messages);
 
 533         spin_unlock_irqrestore(&drv_data->lock, flags);
 
 535         last_transfer = list_entry(msg->transfers.prev,
 
 536                                    struct spi_transfer, transfer_list);
 
 540         /* disable chip select signal. And not stop spi in autobuffer mode */
 
 541         if (drv_data->tx_dma != 0xFFFF) {
 
 542                 cs_deactive(drv_data, chip);
 
 543                 bfin_spi_disable(drv_data);
 
 546         if (!drv_data->cs_change)
 
 547                 cs_deactive(drv_data, chip);
 
 550                 msg->complete(msg->context);
 
 553 static irqreturn_t dma_irq_handler(int irq, void *dev_id)
 
 555         struct driver_data *drv_data = dev_id;
 
 556         struct chip_data *chip = drv_data->cur_chip;
 
 557         struct spi_message *msg = drv_data->cur_msg;
 
 559         dev_dbg(&drv_data->pdev->dev, "in dma_irq_handler\n");
 
 560         clear_dma_irqstat(drv_data->dma_channel);
 
 562         /* Wait for DMA to complete */
 
 563         while (get_dma_curr_irqstat(drv_data->dma_channel) & DMA_RUN)
 
 567          * wait for the last transaction shifted out.  HRM states:
 
 568          * at this point there may still be data in the SPI DMA FIFO waiting
 
 569          * to be transmitted ... software needs to poll TXS in the SPI_STAT
 
 570          * register until it goes low for 2 successive reads
 
 572         if (drv_data->tx != NULL) {
 
 573                 while ((read_STAT(drv_data) & TXS) ||
 
 574                        (read_STAT(drv_data) & TXS))
 
 578         while (!(read_STAT(drv_data) & SPIF))
 
 581         msg->actual_length += drv_data->len_in_bytes;
 
 583         if (drv_data->cs_change)
 
 584                 cs_deactive(drv_data, chip);
 
 586         /* Move to next transfer */
 
 587         msg->state = next_transfer(drv_data);
 
 589         /* Schedule transfer tasklet */
 
 590         tasklet_schedule(&drv_data->pump_transfers);
 
 592         /* free the irq handler before next transfer */
 
 593         dev_dbg(&drv_data->pdev->dev,
 
 594                 "disable dma channel irq%d\n",
 
 595                 drv_data->dma_channel);
 
 596         dma_disable_irq(drv_data->dma_channel);
 
 601 static void pump_transfers(unsigned long data)
 
 603         struct driver_data *drv_data = (struct driver_data *)data;
 
 604         struct spi_message *message = NULL;
 
 605         struct spi_transfer *transfer = NULL;
 
 606         struct spi_transfer *previous = NULL;
 
 607         struct chip_data *chip = NULL;
 
 609         u16 cr, dma_width, dma_config;
 
 610         u32 tranf_success = 1;
 
 613         /* Get current state information */
 
 614         message = drv_data->cur_msg;
 
 615         transfer = drv_data->cur_transfer;
 
 616         chip = drv_data->cur_chip;
 
 619          * if msg is error or done, report it back using complete() callback
 
 622          /* Handle for abort */
 
 623         if (message->state == ERROR_STATE) {
 
 624                 message->status = -EIO;
 
 629         /* Handle end of message */
 
 630         if (message->state == DONE_STATE) {
 
 636         /* Delay if requested at end of transfer */
 
 637         if (message->state == RUNNING_STATE) {
 
 638                 previous = list_entry(transfer->transfer_list.prev,
 
 639                                       struct spi_transfer, transfer_list);
 
 640                 if (previous->delay_usecs)
 
 641                         udelay(previous->delay_usecs);
 
 644         /* Setup the transfer state based on the type of transfer */
 
 645         if (flush(drv_data) == 0) {
 
 646                 dev_err(&drv_data->pdev->dev, "pump_transfers: flush failed\n");
 
 647                 message->status = -EIO;
 
 652         if (transfer->tx_buf != NULL) {
 
 653                 drv_data->tx = (void *)transfer->tx_buf;
 
 654                 drv_data->tx_end = drv_data->tx + transfer->len;
 
 655                 dev_dbg(&drv_data->pdev->dev, "tx_buf is %p, tx_end is %p\n",
 
 656                         transfer->tx_buf, drv_data->tx_end);
 
 661         if (transfer->rx_buf != NULL) {
 
 662                 full_duplex = transfer->tx_buf != NULL;
 
 663                 drv_data->rx = transfer->rx_buf;
 
 664                 drv_data->rx_end = drv_data->rx + transfer->len;
 
 665                 dev_dbg(&drv_data->pdev->dev, "rx_buf is %p, rx_end is %p\n",
 
 666                         transfer->rx_buf, drv_data->rx_end);
 
 671         drv_data->rx_dma = transfer->rx_dma;
 
 672         drv_data->tx_dma = transfer->tx_dma;
 
 673         drv_data->len_in_bytes = transfer->len;
 
 674         drv_data->cs_change = transfer->cs_change;
 
 676         /* Bits per word setup */
 
 677         switch (transfer->bits_per_word) {
 
 679                 drv_data->n_bytes = 1;
 
 680                 width = CFG_SPI_WORDSIZE8;
 
 681                 drv_data->read = chip->cs_change_per_word ?
 
 682                         u8_cs_chg_reader : u8_reader;
 
 683                 drv_data->write = chip->cs_change_per_word ?
 
 684                         u8_cs_chg_writer : u8_writer;
 
 685                 drv_data->duplex = chip->cs_change_per_word ?
 
 686                         u8_cs_chg_duplex : u8_duplex;
 
 690                 drv_data->n_bytes = 2;
 
 691                 width = CFG_SPI_WORDSIZE16;
 
 692                 drv_data->read = chip->cs_change_per_word ?
 
 693                         u16_cs_chg_reader : u16_reader;
 
 694                 drv_data->write = chip->cs_change_per_word ?
 
 695                         u16_cs_chg_writer : u16_writer;
 
 696                 drv_data->duplex = chip->cs_change_per_word ?
 
 697                         u16_cs_chg_duplex : u16_duplex;
 
 701                 /* No change, the same as default setting */
 
 702                 drv_data->n_bytes = chip->n_bytes;
 
 704                 drv_data->write = drv_data->tx ? chip->write : null_writer;
 
 705                 drv_data->read = drv_data->rx ? chip->read : null_reader;
 
 706                 drv_data->duplex = chip->duplex ? chip->duplex : null_writer;
 
 709         cr = (read_CTRL(drv_data) & (~BIT_CTL_TIMOD));
 
 711         write_CTRL(drv_data, cr);
 
 713         if (width == CFG_SPI_WORDSIZE16) {
 
 714                 drv_data->len = (transfer->len) >> 1;
 
 716                 drv_data->len = transfer->len;
 
 718         dev_dbg(&drv_data->pdev->dev,
 
 719                 "transfer: drv_data->write is %p, chip->write is %p, null_wr is %p\n",
 
 720                 drv_data->write, chip->write, null_writer);
 
 722         /* speed and width has been set on per message */
 
 723         message->state = RUNNING_STATE;
 
 726         /* Speed setup (surely valid because already checked) */
 
 727         if (transfer->speed_hz)
 
 728                 write_BAUD(drv_data, hz_to_spi_baud(transfer->speed_hz));
 
 730                 write_BAUD(drv_data, chip->baud);
 
 732         write_STAT(drv_data, BIT_STAT_CLR);
 
 733         cr = (read_CTRL(drv_data) & (~BIT_CTL_TIMOD));
 
 734         cs_active(drv_data, chip);
 
 736         dev_dbg(&drv_data->pdev->dev,
 
 737                 "now pumping a transfer: width is %d, len is %d\n",
 
 738                 width, transfer->len);
 
 741          * Try to map dma buffer and do a dma transfer if
 
 742          * successful use different way to r/w according to
 
 743          * drv_data->cur_chip->enable_dma
 
 745         if (!full_duplex && drv_data->cur_chip->enable_dma
 
 746                                 && drv_data->len > 6) {
 
 748                 disable_dma(drv_data->dma_channel);
 
 749                 clear_dma_irqstat(drv_data->dma_channel);
 
 750                 bfin_spi_disable(drv_data);
 
 752                 /* config dma channel */
 
 753                 dev_dbg(&drv_data->pdev->dev, "doing dma transfer\n");
 
 754                 if (width == CFG_SPI_WORDSIZE16) {
 
 755                         set_dma_x_count(drv_data->dma_channel, drv_data->len);
 
 756                         set_dma_x_modify(drv_data->dma_channel, 2);
 
 757                         dma_width = WDSIZE_16;
 
 759                         set_dma_x_count(drv_data->dma_channel, drv_data->len);
 
 760                         set_dma_x_modify(drv_data->dma_channel, 1);
 
 761                         dma_width = WDSIZE_8;
 
 764                 /* poll for SPI completion before start */
 
 765                 while (!(read_STAT(drv_data) & BIT_STAT_SPIF))
 
 768                 /* dirty hack for autobuffer DMA mode */
 
 769                 if (drv_data->tx_dma == 0xFFFF) {
 
 770                         dev_dbg(&drv_data->pdev->dev,
 
 771                                 "doing autobuffer DMA out.\n");
 
 773                         /* no irq in autobuffer mode */
 
 775                             (DMAFLOW_AUTO | RESTART | dma_width | DI_EN);
 
 776                         set_dma_config(drv_data->dma_channel, dma_config);
 
 777                         set_dma_start_addr(drv_data->dma_channel,
 
 778                                         (unsigned long)drv_data->tx);
 
 779                         enable_dma(drv_data->dma_channel);
 
 781                         /* start SPI transfer */
 
 783                                 (cr | CFG_SPI_DMAWRITE | BIT_CTL_ENABLE));
 
 785                         /* just return here, there can only be one transfer
 
 793                 /* In dma mode, rx or tx must be NULL in one transfer */
 
 794                 if (drv_data->rx != NULL) {
 
 795                         /* set transfer mode, and enable SPI */
 
 796                         dev_dbg(&drv_data->pdev->dev, "doing DMA in.\n");
 
 798                         /* clear tx reg soformer data is not shifted out */
 
 799                         write_TDBR(drv_data, 0xFFFF);
 
 801                         set_dma_x_count(drv_data->dma_channel, drv_data->len);
 
 804                         dma_enable_irq(drv_data->dma_channel);
 
 805                         dma_config = (WNR | RESTART | dma_width | DI_EN);
 
 806                         set_dma_config(drv_data->dma_channel, dma_config);
 
 807                         set_dma_start_addr(drv_data->dma_channel,
 
 808                                         (unsigned long)drv_data->rx);
 
 809                         enable_dma(drv_data->dma_channel);
 
 811                         /* start SPI transfer */
 
 813                                 (cr | CFG_SPI_DMAREAD | BIT_CTL_ENABLE));
 
 815                 } else if (drv_data->tx != NULL) {
 
 816                         dev_dbg(&drv_data->pdev->dev, "doing DMA out.\n");
 
 819                         dma_enable_irq(drv_data->dma_channel);
 
 820                         dma_config = (RESTART | dma_width | DI_EN);
 
 821                         set_dma_config(drv_data->dma_channel, dma_config);
 
 822                         set_dma_start_addr(drv_data->dma_channel,
 
 823                                         (unsigned long)drv_data->tx);
 
 824                         enable_dma(drv_data->dma_channel);
 
 826                         /* start SPI transfer */
 
 828                                 (cr | CFG_SPI_DMAWRITE | BIT_CTL_ENABLE));
 
 831                 /* IO mode write then read */
 
 832                 dev_dbg(&drv_data->pdev->dev, "doing IO transfer\n");
 
 835                         /* full duplex mode */
 
 836                         BUG_ON((drv_data->tx_end - drv_data->tx) !=
 
 837                                (drv_data->rx_end - drv_data->rx));
 
 838                         dev_dbg(&drv_data->pdev->dev,
 
 839                                 "IO duplex: cr is 0x%x\n", cr);
 
 841                         /* set SPI transfer mode */
 
 842                         write_CTRL(drv_data, (cr | CFG_SPI_WRITE));
 
 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                         dev_dbg(&drv_data->pdev->dev,
 
 851                                 "IO write: cr is 0x%x\n", cr);
 
 853                         /* set SPI transfer mode */
 
 854                         write_CTRL(drv_data, (cr | CFG_SPI_WRITE));
 
 856                         drv_data->write(drv_data);
 
 858                         if (drv_data->tx != drv_data->tx_end)
 
 860                 } else if (drv_data->rx != NULL) {
 
 861                         /* read only half duplex */
 
 862                         dev_dbg(&drv_data->pdev->dev,
 
 863                                 "IO read: cr is 0x%x\n", cr);
 
 865                         /* set SPI transfer mode */
 
 866                         write_CTRL(drv_data, (cr | CFG_SPI_READ));
 
 868                         drv_data->read(drv_data);
 
 869                         if (drv_data->rx != drv_data->rx_end)
 
 873                 if (!tranf_success) {
 
 874                         dev_dbg(&drv_data->pdev->dev,
 
 875                                 "IO write error!\n");
 
 876                         message->state = ERROR_STATE;
 
 878                         /* Update total byte transfered */
 
 879                         message->actual_length += drv_data->len;
 
 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         restore_state(drv_data);
 
 922         list_del_init(&drv_data->cur_msg->queue);
 
 924         /* Initial message state */
 
 925         drv_data->cur_msg->state = START_STATE;
 
 926         drv_data->cur_transfer = list_entry(drv_data->cur_msg->transfers.next,
 
 927                                             struct spi_transfer, transfer_list);
 
 929         dev_dbg(&drv_data->pdev->dev, "got a message to pump, "
 
 930                 "state is set to: baud %d, flag 0x%x, ctl 0x%x\n",
 
 931                 drv_data->cur_chip->baud, drv_data->cur_chip->flag,
 
 932                 drv_data->cur_chip->ctl_reg);
 
 934         dev_dbg(&drv_data->pdev->dev,
 
 935                 "the first transfer len is %d\n",
 
 936                 drv_data->cur_transfer->len);
 
 938         /* Mark as busy and launch transfers */
 
 939         tasklet_schedule(&drv_data->pump_transfers);
 
 942         spin_unlock_irqrestore(&drv_data->lock, flags);
 
 946  * got a msg to transfer, queue it in drv_data->queue.
 
 947  * And kick off message pumper
 
 949 static int transfer(struct spi_device *spi, struct spi_message *msg)
 
 951         struct driver_data *drv_data = spi_master_get_devdata(spi->master);
 
 954         spin_lock_irqsave(&drv_data->lock, flags);
 
 956         if (drv_data->run == QUEUE_STOPPED) {
 
 957                 spin_unlock_irqrestore(&drv_data->lock, flags);
 
 961         msg->actual_length = 0;
 
 962         msg->status = -EINPROGRESS;
 
 963         msg->state = START_STATE;
 
 965         dev_dbg(&spi->dev, "adding an msg in transfer() \n");
 
 966         list_add_tail(&msg->queue, &drv_data->queue);
 
 968         if (drv_data->run == QUEUE_RUNNING && !drv_data->busy)
 
 969                 queue_work(drv_data->workqueue, &drv_data->pump_messages);
 
 971         spin_unlock_irqrestore(&drv_data->lock, flags);
 
 976 #define MAX_SPI_SSEL    7
 
 978 static u16 ssel[3][MAX_SPI_SSEL] = {
 
 979         {P_SPI0_SSEL1, P_SPI0_SSEL2, P_SPI0_SSEL3,
 
 980         P_SPI0_SSEL4, P_SPI0_SSEL5,
 
 981         P_SPI0_SSEL6, P_SPI0_SSEL7},
 
 983         {P_SPI1_SSEL1, P_SPI1_SSEL2, P_SPI1_SSEL3,
 
 984         P_SPI1_SSEL4, P_SPI1_SSEL5,
 
 985         P_SPI1_SSEL6, P_SPI1_SSEL7},
 
 987         {P_SPI2_SSEL1, P_SPI2_SSEL2, P_SPI2_SSEL3,
 
 988         P_SPI2_SSEL4, P_SPI2_SSEL5,
 
 989         P_SPI2_SSEL6, P_SPI2_SSEL7},
 
 992 /* first setup for new devices */
 
 993 static int setup(struct spi_device *spi)
 
 995         struct bfin5xx_spi_chip *chip_info = NULL;
 
 996         struct chip_data *chip;
 
 997         struct driver_data *drv_data = spi_master_get_devdata(spi->master);
 
1000         /* Abort device setup if requested features are not supported */
 
1001         if (spi->mode & ~(SPI_CPOL | SPI_CPHA | SPI_LSB_FIRST)) {
 
1002                 dev_err(&spi->dev, "requested mode not fully supported\n");
 
1006         /* Zero (the default) here means 8 bits */
 
1007         if (!spi->bits_per_word)
 
1008                 spi->bits_per_word = 8;
 
1010         if (spi->bits_per_word != 8 && spi->bits_per_word != 16)
 
1013         /* Only alloc (or use chip_info) on first setup */
 
1014         chip = spi_get_ctldata(spi);
 
1016                 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
 
1020                 chip->enable_dma = 0;
 
1021                 chip_info = spi->controller_data;
 
1024         /* chip_info isn't always needed */
 
1026                 /* Make sure people stop trying to set fields via ctl_reg
 
1027                  * when they should actually be using common SPI framework.
 
1028                  * Currently we let through: WOM EMISO PSSE GM SZ TIMOD.
 
1029                  * Not sure if a user actually needs/uses any of these,
 
1030                  * but let's assume (for now) they do.
 
1032                 if (chip_info->ctl_reg & (SPE|MSTR|CPOL|CPHA|LSBF|SIZE)) {
 
1033                         dev_err(&spi->dev, "do not set bits in ctl_reg "
 
1034                                 "that the SPI framework manages\n");
 
1038                 chip->enable_dma = chip_info->enable_dma != 0
 
1039                     && drv_data->master_info->enable_dma;
 
1040                 chip->ctl_reg = chip_info->ctl_reg;
 
1041                 chip->bits_per_word = chip_info->bits_per_word;
 
1042                 chip->cs_change_per_word = chip_info->cs_change_per_word;
 
1043                 chip->cs_chg_udelay = chip_info->cs_chg_udelay;
 
1046         /* translate common spi framework into our register */
 
1047         if (spi->mode & SPI_CPOL)
 
1048                 chip->ctl_reg |= CPOL;
 
1049         if (spi->mode & SPI_CPHA)
 
1050                 chip->ctl_reg |= CPHA;
 
1051         if (spi->mode & SPI_LSB_FIRST)
 
1052                 chip->ctl_reg |= LSBF;
 
1053         /* we dont support running in slave mode (yet?) */
 
1054         chip->ctl_reg |= MSTR;
 
1057          * if any one SPI chip is registered and wants DMA, request the
 
1058          * DMA channel for it
 
1060         if (chip->enable_dma && !drv_data->dma_requested) {
 
1061                 /* register dma irq handler */
 
1062                 if (request_dma(drv_data->dma_channel, "BF53x_SPI_DMA") < 0) {
 
1064                                 "Unable to request BlackFin SPI DMA channel\n");
 
1067                 if (set_dma_callback(drv_data->dma_channel,
 
1068                         (void *)dma_irq_handler, drv_data) < 0) {
 
1069                         dev_dbg(&spi->dev, "Unable to set dma callback\n");
 
1072                 dma_disable_irq(drv_data->dma_channel);
 
1073                 drv_data->dma_requested = 1;
 
1077          * Notice: for blackfin, the speed_hz is the value of register
 
1078          * SPI_BAUD, not the real baudrate
 
1080         chip->baud = hz_to_spi_baud(spi->max_speed_hz);
 
1081         spi_flg = ~(1 << (spi->chip_select));
 
1082         chip->flag = ((u16) spi_flg << 8) | (1 << (spi->chip_select));
 
1083         chip->chip_select_num = spi->chip_select;
 
1085         switch (chip->bits_per_word) {
 
1088                 chip->width = CFG_SPI_WORDSIZE8;
 
1089                 chip->read = chip->cs_change_per_word ?
 
1090                         u8_cs_chg_reader : u8_reader;
 
1091                 chip->write = chip->cs_change_per_word ?
 
1092                         u8_cs_chg_writer : u8_writer;
 
1093                 chip->duplex = chip->cs_change_per_word ?
 
1094                         u8_cs_chg_duplex : u8_duplex;
 
1099                 chip->width = CFG_SPI_WORDSIZE16;
 
1100                 chip->read = chip->cs_change_per_word ?
 
1101                         u16_cs_chg_reader : u16_reader;
 
1102                 chip->write = chip->cs_change_per_word ?
 
1103                         u16_cs_chg_writer : u16_writer;
 
1104                 chip->duplex = chip->cs_change_per_word ?
 
1105                         u16_cs_chg_duplex : u16_duplex;
 
1109                 dev_err(&spi->dev, "%d bits_per_word is not supported\n",
 
1110                                 chip->bits_per_word);
 
1115         dev_dbg(&spi->dev, "setup spi chip %s, width is %d, dma is %d\n",
 
1116                         spi->modalias, chip->width, chip->enable_dma);
 
1117         dev_dbg(&spi->dev, "ctl_reg is 0x%x, flag_reg is 0x%x\n",
 
1118                         chip->ctl_reg, chip->flag);
 
1120         spi_set_ctldata(spi, chip);
 
1122         dev_dbg(&spi->dev, "chip select number is %d\n", chip->chip_select_num);
 
1123         if ((chip->chip_select_num > 0)
 
1124                 && (chip->chip_select_num <= spi->master->num_chipselect))
 
1125                 peripheral_request(ssel[spi->master->bus_num]
 
1126                         [chip->chip_select_num-1], spi->modalias);
 
1128         cs_deactive(drv_data, chip);
 
1134  * callback for spi framework.
 
1135  * clean driver specific data
 
1137 static void cleanup(struct spi_device *spi)
 
1139         struct chip_data *chip = spi_get_ctldata(spi);
 
1141         if ((chip->chip_select_num > 0)
 
1142                 && (chip->chip_select_num <= spi->master->num_chipselect))
 
1143                 peripheral_free(ssel[spi->master->bus_num]
 
1144                                         [chip->chip_select_num-1]);
 
1149 static inline int init_queue(struct driver_data *drv_data)
 
1151         INIT_LIST_HEAD(&drv_data->queue);
 
1152         spin_lock_init(&drv_data->lock);
 
1154         drv_data->run = QUEUE_STOPPED;
 
1157         /* init transfer tasklet */
 
1158         tasklet_init(&drv_data->pump_transfers,
 
1159                      pump_transfers, (unsigned long)drv_data);
 
1161         /* init messages workqueue */
 
1162         INIT_WORK(&drv_data->pump_messages, pump_messages);
 
1163         drv_data->workqueue =
 
1164             create_singlethread_workqueue(drv_data->master->dev.parent->bus_id);
 
1165         if (drv_data->workqueue == NULL)
 
1171 static inline int start_queue(struct driver_data *drv_data)
 
1173         unsigned long flags;
 
1175         spin_lock_irqsave(&drv_data->lock, flags);
 
1177         if (drv_data->run == QUEUE_RUNNING || drv_data->busy) {
 
1178                 spin_unlock_irqrestore(&drv_data->lock, flags);
 
1182         drv_data->run = QUEUE_RUNNING;
 
1183         drv_data->cur_msg = NULL;
 
1184         drv_data->cur_transfer = NULL;
 
1185         drv_data->cur_chip = NULL;
 
1186         spin_unlock_irqrestore(&drv_data->lock, flags);
 
1188         queue_work(drv_data->workqueue, &drv_data->pump_messages);
 
1193 static inline int stop_queue(struct driver_data *drv_data)
 
1195         unsigned long flags;
 
1196         unsigned limit = 500;
 
1199         spin_lock_irqsave(&drv_data->lock, flags);
 
1202          * This is a bit lame, but is optimized for the common execution path.
 
1203          * A wait_queue on the drv_data->busy could be used, but then the common
 
1204          * execution path (pump_messages) would be required to call wake_up or
 
1205          * friends on every SPI message. Do this instead
 
1207         drv_data->run = QUEUE_STOPPED;
 
1208         while (!list_empty(&drv_data->queue) && drv_data->busy && limit--) {
 
1209                 spin_unlock_irqrestore(&drv_data->lock, flags);
 
1211                 spin_lock_irqsave(&drv_data->lock, flags);
 
1214         if (!list_empty(&drv_data->queue) || drv_data->busy)
 
1217         spin_unlock_irqrestore(&drv_data->lock, flags);
 
1222 static inline int destroy_queue(struct driver_data *drv_data)
 
1226         status = stop_queue(drv_data);
 
1230         destroy_workqueue(drv_data->workqueue);
 
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;
 
1257         drv_data->pin_req = platform_info->pin_req;
 
1259         master->bus_num = pdev->id;
 
1260         master->num_chipselect = platform_info->num_chipselect;
 
1261         master->cleanup = cleanup;
 
1262         master->setup = setup;
 
1263         master->transfer = transfer;
 
1265         /* Find and map our resources */
 
1266         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 
1268                 dev_err(dev, "Cannot get IORESOURCE_MEM\n");
 
1270                 goto out_error_get_res;
 
1273         drv_data->regs_base = ioremap(res->start, (res->end - res->start + 1));
 
1274         if (drv_data->regs_base == NULL) {
 
1275                 dev_err(dev, "Cannot map IO\n");
 
1277                 goto out_error_ioremap;
 
1280         drv_data->dma_channel = platform_get_irq(pdev, 0);
 
1281         if (drv_data->dma_channel < 0) {
 
1282                 dev_err(dev, "No DMA channel specified\n");
 
1284                 goto out_error_no_dma_ch;
 
1287         /* Initial and start queue */
 
1288         status = init_queue(drv_data);
 
1290                 dev_err(dev, "problem initializing queue\n");
 
1291                 goto out_error_queue_alloc;
 
1294         status = start_queue(drv_data);
 
1296                 dev_err(dev, "problem starting queue\n");
 
1297                 goto out_error_queue_alloc;
 
1300         status = peripheral_request_list(drv_data->pin_req, DRV_NAME);
 
1302                 dev_err(&pdev->dev, ": Requesting Peripherals failed\n");
 
1303                 goto out_error_queue_alloc;
 
1306         /* Register with the SPI framework */
 
1307         platform_set_drvdata(pdev, drv_data);
 
1308         status = spi_register_master(master);
 
1310                 dev_err(dev, "problem registering spi master\n");
 
1311                 goto out_error_queue_alloc;
 
1314         dev_info(dev, "%s, Version %s, regs_base@%p, dma channel@%d\n",
 
1315                 DRV_DESC, DRV_VERSION, drv_data->regs_base,
 
1316                 drv_data->dma_channel);
 
1319 out_error_queue_alloc:
 
1320         destroy_queue(drv_data);
 
1321 out_error_no_dma_ch:
 
1322         iounmap((void *) drv_data->regs_base);
 
1325         spi_master_put(master);
 
1330 /* stop hardware and remove the driver */
 
1331 static int __devexit bfin5xx_spi_remove(struct platform_device *pdev)
 
1333         struct driver_data *drv_data = platform_get_drvdata(pdev);
 
1339         /* Remove the queue */
 
1340         status = destroy_queue(drv_data);
 
1344         /* Disable the SSP at the peripheral and SOC level */
 
1345         bfin_spi_disable(drv_data);
 
1348         if (drv_data->master_info->enable_dma) {
 
1349                 if (dma_channel_active(drv_data->dma_channel))
 
1350                         free_dma(drv_data->dma_channel);
 
1353         /* Disconnect from the SPI framework */
 
1354         spi_unregister_master(drv_data->master);
 
1356         peripheral_free_list(drv_data->pin_req);
 
1358         /* Prevent double remove */
 
1359         platform_set_drvdata(pdev, NULL);
 
1365 static int bfin5xx_spi_suspend(struct platform_device *pdev, pm_message_t state)
 
1367         struct driver_data *drv_data = platform_get_drvdata(pdev);
 
1370         status = stop_queue(drv_data);
 
1375         bfin_spi_disable(drv_data);
 
1380 static int bfin5xx_spi_resume(struct platform_device *pdev)
 
1382         struct driver_data *drv_data = platform_get_drvdata(pdev);
 
1385         /* Enable the SPI interface */
 
1386         bfin_spi_enable(drv_data);
 
1388         /* Start the queue running */
 
1389         status = start_queue(drv_data);
 
1391                 dev_err(&pdev->dev, "problem starting queue (%d)\n", status);
 
1398 #define bfin5xx_spi_suspend NULL
 
1399 #define bfin5xx_spi_resume NULL
 
1400 #endif                          /* CONFIG_PM */
 
1402 MODULE_ALIAS("platform:bfin-spi");
 
1403 static struct platform_driver bfin5xx_spi_driver = {
 
1406                 .owner  = THIS_MODULE,
 
1408         .suspend        = bfin5xx_spi_suspend,
 
1409         .resume         = bfin5xx_spi_resume,
 
1410         .remove         = __devexit_p(bfin5xx_spi_remove),
 
1413 static int __init bfin5xx_spi_init(void)
 
1415         return platform_driver_probe(&bfin5xx_spi_driver, bfin5xx_spi_probe);
 
1417 module_init(bfin5xx_spi_init);
 
1419 static void __exit bfin5xx_spi_exit(void)
 
1421         platform_driver_unregister(&bfin5xx_spi_driver);
 
1423 module_exit(bfin5xx_spi_exit);