drivers/spi/spi-bcm63xx.c

   1 /*
   2  * Broadcom BCM63xx SPI controller support
   3  *
   4  * Copyright (C) 2009-2012 Florian Fainelli <florian@openwrt.org>
   5  * Copyright (C) 2010 Tanguy Bouzeloc <tanguy.bouzeloc@efixo.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  */
  21
  22 #include <linux/kernel.h>
  23 #include <linux/init.h>
  24 #include <linux/clk.h>
  25 #include <linux/io.h>
  26 #include <linux/module.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/delay.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/spi/spi.h>
  31 #include <linux/completion.h>
  32 #include <linux/err.h>
  33 #include <linux/workqueue.h>
  34 #include <linux/pm_runtime.h>
  35
  36 #include <bcm63xx_dev_spi.h>
  37
  38 #define PFX             KBUILD_MODNAME
  39
  40 #define BCM63XX_SPI_MAX_PREPEND         15
  41
  42 struct bcm63xx_spi {
  43         struct completion       done;
  44
  45         void __iomem            *regs;
  46         int                     irq;
  47
  48         /* Platform data */
  49         unsigned                fifo_size;
  50         unsigned int            msg_type_shift;
  51         unsigned int            msg_ctl_width;
  52
  53         /* data iomem */
  54         u8 __iomem              *tx_io;
  55         const u8 __iomem        *rx_io;
  56
  57         struct clk              *clk;
  58         struct platform_device  *pdev;
  59 };
  60
  61 static inline u8 bcm_spi_readb(struct bcm63xx_spi *bs,
  62                                 unsigned int offset)
  63 {
  64         return bcm_readb(bs->regs + bcm63xx_spireg(offset));
  65 }
  66
  67 static inline u16 bcm_spi_readw(struct bcm63xx_spi *bs,
  68                                 unsigned int offset)
  69 {
  70         return bcm_readw(bs->regs + bcm63xx_spireg(offset));
  71 }
  72
  73 static inline void bcm_spi_writeb(struct bcm63xx_spi *bs,
  74                                   u8 value, unsigned int offset)
  75 {
  76         bcm_writeb(value, bs->regs + bcm63xx_spireg(offset));
  77 }
  78
  79 static inline void bcm_spi_writew(struct bcm63xx_spi *bs,
  80                                   u16 value, unsigned int offset)
  81 {
  82         bcm_writew(value, bs->regs + bcm63xx_spireg(offset));
  83 }
  84
  85 static const unsigned bcm63xx_spi_freq_table[SPI_CLK_MASK][2] = {
  86         { 20000000, SPI_CLK_20MHZ },
  87         { 12500000, SPI_CLK_12_50MHZ },
  88         {  6250000, SPI_CLK_6_250MHZ },
  89         {  3125000, SPI_CLK_3_125MHZ },
  90         {  1563000, SPI_CLK_1_563MHZ },
  91         {   781000, SPI_CLK_0_781MHZ },
  92         {   391000, SPI_CLK_0_391MHZ }
  93 };
  94
  95 static void bcm63xx_spi_setup_transfer(struct spi_device *spi,
  96                                       struct spi_transfer *t)
  97 {
  98         struct bcm63xx_spi *bs = spi_master_get_devdata(spi->master);
  99         u8 clk_cfg, reg;
 100         int i;
 101
 102         /* Find the closest clock configuration */
 103         for (i = 0; i < SPI_CLK_MASK; i++) {
 104                 if (t->speed_hz >= bcm63xx_spi_freq_table[i][0]) {
 105                         clk_cfg = bcm63xx_spi_freq_table[i][1];
 106                         break;
 107                 }
 108         }
 109
 110         /* No matching configuration found, default to lowest */
 111         if (i == SPI_CLK_MASK)
 112                 clk_cfg = SPI_CLK_0_391MHZ;
 113
 114         /* clear existing clock configuration bits of the register */
 115         reg = bcm_spi_readb(bs, SPI_CLK_CFG);
 116         reg &= ~SPI_CLK_MASK;
 117         reg |= clk_cfg;
 118
 119         bcm_spi_writeb(bs, reg, SPI_CLK_CFG);
 120         dev_dbg(&spi->dev, "Setting clock register to %02x (hz %d)\n",
 121                 clk_cfg, t->speed_hz);
 122 }
 123
 124 /* the spi->mode bits understood by this driver: */
 125 #define MODEBITS (SPI_CPOL | SPI_CPHA)
 126
 127 static int bcm63xx_txrx_bufs(struct spi_device *spi, struct spi_transfer *first,
 128                                 unsigned int num_transfers)
 129 {
 130         struct bcm63xx_spi *bs = spi_master_get_devdata(spi->master);
 131         u16 msg_ctl;
 132         u16 cmd;
 133         u8 rx_tail;
 134         unsigned int i, timeout = 0, prepend_len = 0, len = 0;
 135         struct spi_transfer *t = first;
 136         bool do_rx = false;
 137         bool do_tx = false;
 138
 139         /* Disable the CMD_DONE interrupt */
 140         bcm_spi_writeb(bs, 0, SPI_INT_MASK);
 141
 142         dev_dbg(&spi->dev, "txrx: tx %p, rx %p, len %d\n",
 143                 t->tx_buf, t->rx_buf, t->len);
 144
 145         if (num_transfers > 1 && t->tx_buf && t->len <= BCM63XX_SPI_MAX_PREPEND)
 146                 prepend_len = t->len;
 147
 148         /* prepare the buffer */
 149         for (i = 0; i < num_transfers; i++) {
 150                 if (t->tx_buf) {
 151                         do_tx = true;
 152                         memcpy_toio(bs->tx_io + len, t->tx_buf, t->len);
 153
 154                         /* don't prepend more than one tx */
 155                         if (t != first)
 156                                 prepend_len = 0;
 157                 }
 158
 159                 if (t->rx_buf) {
 160                         do_rx = true;
 161                         /* prepend is half-duplex write only */
 162                         if (t == first)
 163                                 prepend_len = 0;
 164                 }
 165
 166                 len += t->len;
 167
 168                 t = list_entry(t->transfer_list.next, struct spi_transfer,
 169                                transfer_list);
 170         }
 171
 172         init_completion(&bs->done);
 173
 174         /* Fill in the Message control register */
 175         msg_ctl = (len << SPI_BYTE_CNT_SHIFT);
 176
 177         if (do_rx && do_tx && prepend_len == 0)
 178                 msg_ctl |= (SPI_FD_RW << bs->msg_type_shift);
 179         else if (do_rx)
 180                 msg_ctl |= (SPI_HD_R << bs->msg_type_shift);
 181         else if (do_tx)
 182                 msg_ctl |= (SPI_HD_W << bs->msg_type_shift);
 183
 184         switch (bs->msg_ctl_width) {
 185         case 8:
 186                 bcm_spi_writeb(bs, msg_ctl, SPI_MSG_CTL);
 187                 break;
 188         case 16:
 189                 bcm_spi_writew(bs, msg_ctl, SPI_MSG_CTL);
 190                 break;
 191         }
 192
 193         /* Issue the transfer */
 194         cmd = SPI_CMD_START_IMMEDIATE;
 195         cmd |= (prepend_len << SPI_CMD_PREPEND_BYTE_CNT_SHIFT);
 196         cmd |= (spi->chip_select << SPI_CMD_DEVICE_ID_SHIFT);
 197         bcm_spi_writew(bs, cmd, SPI_CMD);
 198
 199         /* Enable the CMD_DONE interrupt */
 200         bcm_spi_writeb(bs, SPI_INTR_CMD_DONE, SPI_INT_MASK);
 201
 202         timeout = wait_for_completion_timeout(&bs->done, HZ);
 203         if (!timeout)
 204                 return -ETIMEDOUT;
 205
 206         /* read out all data */
 207         rx_tail = bcm_spi_readb(bs, SPI_RX_TAIL);
 208
 209         if (do_rx && rx_tail != len)
 210                 return -EIO;
 211
 212         if (!rx_tail)
 213                 return 0;
 214
 215         len = 0;
 216         t = first;
 217         /* Read out all the data */
 218         for (i = 0; i < num_transfers; i++) {
 219                 if (t->rx_buf)
 220                         memcpy_fromio(t->rx_buf, bs->rx_io + len, t->len);
 221
 222                 if (t != first || prepend_len == 0)
 223                         len += t->len;
 224
 225                 t = list_entry(t->transfer_list.next, struct spi_transfer,
 226                                transfer_list);
 227         }
 228
 229         return 0;
 230 }
 231
 232 static int bcm63xx_spi_transfer_one(struct spi_master *master,
 233                                         struct spi_message *m)
 234 {
 235         struct bcm63xx_spi *bs = spi_master_get_devdata(master);
 236         struct spi_transfer *t, *first = NULL;
 237         struct spi_device *spi = m->spi;
 238         int status = 0;
 239         unsigned int n_transfers = 0, total_len = 0;
 240         bool can_use_prepend = false;
 241
 242         /*
 243          * This SPI controller does not support keeping CS active after a
 244          * transfer.
 245          * Work around this by merging as many transfers we can into one big
 246          * full-duplex transfers.
 247          */
 248         list_for_each_entry(t, &m->transfers, transfer_list) {
 249                 if (!first)
 250                         first = t;
 251
 252                 n_transfers++;
 253                 total_len += t->len;
 254
 255                 if (n_transfers == 2 && !first->rx_buf && !t->tx_buf &&
 256                     first->len <= BCM63XX_SPI_MAX_PREPEND)
 257                         can_use_prepend = true;
 258                 else if (can_use_prepend && t->tx_buf)
 259                         can_use_prepend = false;
 260
 261                 /* we can only transfer one fifo worth of data */
 262                 if ((can_use_prepend &&
 263                      total_len > (bs->fifo_size + BCM63XX_SPI_MAX_PREPEND)) ||
 264                     (!can_use_prepend && total_len > bs->fifo_size)) {
 265                         dev_err(&spi->dev, "unable to do transfers larger than FIFO size (%i > %i)\n",
 266                                 total_len, bs->fifo_size);
 267                         status = -EINVAL;
 268                         goto exit;
 269                 }
 270
 271                 /* all combined transfers have to have the same speed */
 272                 if (t->speed_hz != first->speed_hz) {
 273                         dev_err(&spi->dev, "unable to change speed between transfers\n");
 274                         status = -EINVAL;
 275                         goto exit;
 276                 }
 277
 278                 /* CS will be deasserted directly after transfer */
 279                 if (t->delay_usecs) {
 280                         dev_err(&spi->dev, "unable to keep CS asserted after transfer\n");
 281                         status = -EINVAL;
 282                         goto exit;
 283                 }
 284
 285                 if (t->cs_change ||
 286                     list_is_last(&t->transfer_list, &m->transfers)) {
 287                         /* configure adapter for a new transfer */
 288                         bcm63xx_spi_setup_transfer(spi, first);
 289
 290                         /* send the data */
 291                         status = bcm63xx_txrx_bufs(spi, first, n_transfers);
 292                         if (status)
 293                                 goto exit;
 294
 295                         m->actual_length += total_len;
 296
 297                         first = NULL;
 298                         n_transfers = 0;
 299                         total_len = 0;
 300                         can_use_prepend = false;
 301                 }
 302         }
 303 exit:
 304         m->status = status;
 305         spi_finalize_current_message(master);
 306
 307         return 0;
 308 }
 309
 310 /* This driver supports single master mode only. Hence
 311  * CMD_DONE is the only interrupt we care about
 312  */
 313 static irqreturn_t bcm63xx_spi_interrupt(int irq, void *dev_id)
 314 {
 315         struct spi_master *master = (struct spi_master *)dev_id;
 316         struct bcm63xx_spi *bs = spi_master_get_devdata(master);
 317         u8 intr;
 318
 319         /* Read interupts and clear them immediately */
 320         intr = bcm_spi_readb(bs, SPI_INT_STATUS);
 321         bcm_spi_writeb(bs, SPI_INTR_CLEAR_ALL, SPI_INT_STATUS);
 322         bcm_spi_writeb(bs, 0, SPI_INT_MASK);
 323
 324         /* A transfer completed */
 325         if (intr & SPI_INTR_CMD_DONE)
 326                 complete(&bs->done);
 327
 328         return IRQ_HANDLED;
 329 }
 330
 331
 332 static int bcm63xx_spi_probe(struct platform_device *pdev)
 333 {
 334         struct resource *r;
 335         struct device *dev = &pdev->dev;
 336         struct bcm63xx_spi_pdata *pdata = dev_get_platdata(&pdev->dev);
 337         int irq;
 338         struct spi_master *master;
 339         struct clk *clk;
 340         struct bcm63xx_spi *bs;
 341         int ret;
 342
 343         irq = platform_get_irq(pdev, 0);
 344         if (irq < 0) {
 345                 dev_err(dev, "no irq\n");
 346                 ret = -ENXIO;
 347                 goto out;
 348         }
 349
 350         clk = clk_get(dev, "spi");
 351         if (IS_ERR(clk)) {
 352                 dev_err(dev, "no clock for device\n");
 353                 ret = PTR_ERR(clk);
 354                 goto out;
 355         }
 356
 357         master = spi_alloc_master(dev, sizeof(*bs));
 358         if (!master) {
 359                 dev_err(dev, "out of memory\n");
 360                 ret = -ENOMEM;
 361                 goto out_clk;
 362         }
 363
 364         bs = spi_master_get_devdata(master);
 365
 366         platform_set_drvdata(pdev, master);
 367         bs->pdev = pdev;
 368
 369         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 370         bs->regs = devm_ioremap_resource(&pdev->dev, r);
 371         if (IS_ERR(bs->regs)) {
 372                 ret = PTR_ERR(bs->regs);
 373                 goto out_err;
 374         }
 375
 376         bs->irq = irq;
 377         bs->clk = clk;
 378         bs->fifo_size = pdata->fifo_size;
 379
 380         ret = devm_request_irq(&pdev->dev, irq, bcm63xx_spi_interrupt, 0,
 381                                                         pdev->name, master);
 382         if (ret) {
 383                 dev_err(dev, "unable to request irq\n");
 384                 goto out_err;
 385         }
 386
 387         master->bus_num = pdata->bus_num;
 388         master->num_chipselect = pdata->num_chipselect;
 389         master->transfer_one_message = bcm63xx_spi_transfer_one;
 390         master->mode_bits = MODEBITS;
 391         master->bits_per_word_mask = SPI_BPW_MASK(8);
 392         master->auto_runtime_pm = true;
 393         bs->msg_type_shift = pdata->msg_type_shift;
 394         bs->msg_ctl_width = pdata->msg_ctl_width;
 395         bs->tx_io = (u8 *)(bs->regs + bcm63xx_spireg(SPI_MSG_DATA));
 396         bs->rx_io = (const u8 *)(bs->regs + bcm63xx_spireg(SPI_RX_DATA));
 397
 398         switch (bs->msg_ctl_width) {
 399         case 8:
 400         case 16:
 401                 break;
 402         default:
 403                 dev_err(dev, "unsupported MSG_CTL width: %d\n",
 404                          bs->msg_ctl_width);
 405                 goto out_err;
 406         }
 407
 408         /* Initialize hardware */
 409         clk_prepare_enable(bs->clk);
 410         bcm_spi_writeb(bs, SPI_INTR_CLEAR_ALL, SPI_INT_STATUS);
 411
 412         /* register and we are done */
 413         ret = devm_spi_register_master(dev, master);
 414         if (ret) {
 415                 dev_err(dev, "spi register failed\n");
 416                 goto out_clk_disable;
 417         }
 418
 419         dev_info(dev, "at 0x%08x (irq %d, FIFOs size %d)\n",
 420                  r->start, irq, bs->fifo_size);
 421
 422         return 0;
 423
 424 out_clk_disable:
 425         clk_disable_unprepare(clk);
 426 out_err:
 427         spi_master_put(master);
 428 out_clk:
 429         clk_put(clk);
 430 out:
 431         return ret;
 432 }
 433
 434 static int bcm63xx_spi_remove(struct platform_device *pdev)
 435 {
 436         struct spi_master *master = spi_master_get(platform_get_drvdata(pdev));
 437         struct bcm63xx_spi *bs = spi_master_get_devdata(master);
 438
 439         /* reset spi block */
 440         bcm_spi_writeb(bs, 0, SPI_INT_MASK);
 441
 442         /* HW shutdown */
 443         clk_disable_unprepare(bs->clk);
 444         clk_put(bs->clk);
 445
 446         return 0;
 447 }
 448
 449 #ifdef CONFIG_PM
 450 static int bcm63xx_spi_suspend(struct device *dev)
 451 {
 452         struct spi_master *master = dev_get_drvdata(dev);
 453         struct bcm63xx_spi *bs = spi_master_get_devdata(master);
 454
 455         spi_master_suspend(master);
 456
 457         clk_disable_unprepare(bs->clk);
 458
 459         return 0;
 460 }
 461
 462 static int bcm63xx_spi_resume(struct device *dev)
 463 {
 464         struct spi_master *master = dev_get_drvdata(dev);
 465         struct bcm63xx_spi *bs = spi_master_get_devdata(master);
 466
 467         clk_prepare_enable(bs->clk);
 468
 469         spi_master_resume(master);
 470
 471         return 0;
 472 }
 473
 474 static const struct dev_pm_ops bcm63xx_spi_pm_ops = {
 475         .suspend        = bcm63xx_spi_suspend,
 476         .resume         = bcm63xx_spi_resume,
 477 };
 478
 479 #define BCM63XX_SPI_PM_OPS      (&bcm63xx_spi_pm_ops)
 480 #else
 481 #define BCM63XX_SPI_PM_OPS      NULL
 482 #endif
 483
 484 static struct platform_driver bcm63xx_spi_driver = {
 485         .driver = {
 486                 .name   = "bcm63xx-spi",
 487                 .owner  = THIS_MODULE,
 488                 .pm     = BCM63XX_SPI_PM_OPS,
 489         },
 490         .probe          = bcm63xx_spi_probe,
 491         .remove         = bcm63xx_spi_remove,
 492 };
 493
 494 module_platform_driver(bcm63xx_spi_driver);
 495
 496 MODULE_ALIAS("platform:bcm63xx_spi");
 497 MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
 498 MODULE_AUTHOR("Tanguy Bouzeloc <tanguy.bouzeloc@efixo.com>");
 499 MODULE_DESCRIPTION("Broadcom BCM63xx SPI Controller driver");
 500 MODULE_LICENSE("GPL");