drivers/spi/spi-mxs.c

   1 /*
   2  * Freescale MXS SPI master driver
   3  *
   4  * Copyright 2012 DENX Software Engineering, GmbH.
   5  * Copyright 2012 Freescale Semiconductor, Inc.
   6  * Copyright 2008 Embedded Alley Solutions, Inc All Rights Reserved.
   7  *
   8  * Rework and transition to new API by:
   9  * Marek Vasut <marex@denx.de>
  10  *
  11  * Based on previous attempt by:
  12  * Fabio Estevam <fabio.estevam@freescale.com>
  13  *
  14  * Based on code from U-Boot bootloader by:
  15  * Marek Vasut <marex@denx.de>
  16  *
  17  * Based on spi-stmp.c, which is:
  18  * Author: Dmitry Pervushin <dimka@embeddedalley.com>
  19  *
  20  * This program is free software; you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation; either version 2 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  28  * GNU General Public License for more details.
  29  */
  30
  31 #include <linux/kernel.h>
  32 #include <linux/init.h>
  33 #include <linux/ioport.h>
  34 #include <linux/of.h>
  35 #include <linux/of_device.h>
  36 #include <linux/of_gpio.h>
  37 #include <linux/platform_device.h>
  38 #include <linux/delay.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/dma-mapping.h>
  41 #include <linux/dmaengine.h>
  42 #include <linux/highmem.h>
  43 #include <linux/clk.h>
  44 #include <linux/err.h>
  45 #include <linux/completion.h>
  46 #include <linux/gpio.h>
  47 #include <linux/regulator/consumer.h>
  48 #include <linux/module.h>
  49 #include <linux/stmp_device.h>
  50 #include <linux/spi/spi.h>
  51 #include <linux/spi/mxs-spi.h>
  52
  53 #define DRIVER_NAME             "mxs-spi"
  54
  55 /* Use 10S timeout for very long transfers, it should suffice. */
  56 #define SSP_TIMEOUT             10000
  57
  58 #define SG_MAXLEN               0xff00
  59
  60 /*
  61  * Flags for txrx functions.  More efficient that using an argument register for
  62  * each one.
  63  */
  64 #define TXRX_WRITE              (1<<0)  /* This is a write */
  65 #define TXRX_DEASSERT_CS        (1<<1)  /* De-assert CS at end of txrx */
  66
  67 struct mxs_spi {
  68         struct mxs_ssp          ssp;
  69         struct completion       c;
  70 };
  71
  72 static int mxs_spi_setup_transfer(struct spi_device *dev,
  73                                 struct spi_transfer *t)
  74 {
  75         struct mxs_spi *spi = spi_master_get_devdata(dev->master);
  76         struct mxs_ssp *ssp = &spi->ssp;
  77         uint32_t hz = 0;
  78
  79         hz = dev->max_speed_hz;
  80         if (t && t->speed_hz)
  81                 hz = min(hz, t->speed_hz);
  82         if (hz == 0) {
  83                 dev_err(&dev->dev, "Cannot continue with zero clock\n");
  84                 return -EINVAL;
  85         }
  86
  87         mxs_ssp_set_clk_rate(ssp, hz);
  88
  89         writel(BM_SSP_CTRL0_LOCK_CS,
  90                 ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_SET);
  91         writel(BF_SSP_CTRL1_SSP_MODE(BV_SSP_CTRL1_SSP_MODE__SPI) |
  92                      BF_SSP_CTRL1_WORD_LENGTH
  93                      (BV_SSP_CTRL1_WORD_LENGTH__EIGHT_BITS) |
  94                      ((dev->mode & SPI_CPOL) ? BM_SSP_CTRL1_POLARITY : 0) |
  95                      ((dev->mode & SPI_CPHA) ? BM_SSP_CTRL1_PHASE : 0),
  96                      ssp->base + HW_SSP_CTRL1(ssp));
  97
  98         writel(0x0, ssp->base + HW_SSP_CMD0);
  99         writel(0x0, ssp->base + HW_SSP_CMD1);
 100
 101         return 0;
 102 }
 103
 104 static int mxs_spi_setup(struct spi_device *dev)
 105 {
 106         int err = 0;
 107
 108         if (!dev->bits_per_word)
 109                 dev->bits_per_word = 8;
 110
 111         if (dev->mode & ~(SPI_CPOL | SPI_CPHA))
 112                 return -EINVAL;
 113
 114         err = mxs_spi_setup_transfer(dev, NULL);
 115         if (err) {
 116                 dev_err(&dev->dev,
 117                         "Failed to setup transfer, error = %d\n", err);
 118         }
 119
 120         return err;
 121 }
 122
 123 static uint32_t mxs_spi_cs_to_reg(unsigned cs)
 124 {
 125         uint32_t select = 0;
 126
 127         /*
 128          * i.MX28 Datasheet: 17.10.1: HW_SSP_CTRL0
 129          *
 130          * The bits BM_SSP_CTRL0_WAIT_FOR_CMD and BM_SSP_CTRL0_WAIT_FOR_IRQ
 131          * in HW_SSP_CTRL0 register do have multiple usage, please refer to
 132          * the datasheet for further details. In SPI mode, they are used to
 133          * toggle the chip-select lines (nCS pins).
 134          */
 135         if (cs & 1)
 136                 select |= BM_SSP_CTRL0_WAIT_FOR_CMD;
 137         if (cs & 2)
 138                 select |= BM_SSP_CTRL0_WAIT_FOR_IRQ;
 139
 140         return select;
 141 }
 142
 143 static int mxs_ssp_wait(struct mxs_spi *spi, int offset, int mask, bool set)
 144 {
 145         const unsigned long timeout = jiffies + msecs_to_jiffies(SSP_TIMEOUT);
 146         struct mxs_ssp *ssp = &spi->ssp;
 147         uint32_t reg;
 148
 149         do {
 150                 reg = readl_relaxed(ssp->base + offset);
 151
 152                 if (!set)
 153                         reg = ~reg;
 154
 155                 reg &= mask;
 156
 157                 if (reg == mask)
 158                         return 0;
 159         } while (time_before(jiffies, timeout));
 160
 161         return -ETIMEDOUT;
 162 }
 163
 164 static void mxs_ssp_dma_irq_callback(void *param)
 165 {
 166         struct mxs_spi *spi = param;
 167         complete(&spi->c);
 168 }
 169
 170 static irqreturn_t mxs_ssp_irq_handler(int irq, void *dev_id)
 171 {
 172         struct mxs_ssp *ssp = dev_id;
 173         dev_err(ssp->dev, "%s[%i] CTRL1=%08x STATUS=%08x\n",
 174                 __func__, __LINE__,
 175                 readl(ssp->base + HW_SSP_CTRL1(ssp)),
 176                 readl(ssp->base + HW_SSP_STATUS(ssp)));
 177         return IRQ_HANDLED;
 178 }
 179
 180 static int mxs_spi_txrx_dma(struct mxs_spi *spi,
 181                             unsigned char *buf, int len,
 182                             unsigned int flags)
 183 {
 184         struct mxs_ssp *ssp = &spi->ssp;
 185         struct dma_async_tx_descriptor *desc = NULL;
 186         const bool vmalloced_buf = is_vmalloc_addr(buf);
 187         const int desc_len = vmalloced_buf ? PAGE_SIZE : SG_MAXLEN;
 188         const int sgs = DIV_ROUND_UP(len, desc_len);
 189         int sg_count;
 190         int min, ret;
 191         uint32_t ctrl0;
 192         struct page *vm_page;
 193         void *sg_buf;
 194         struct {
 195                 uint32_t                pio[4];
 196                 struct scatterlist      sg;
 197         } *dma_xfer;
 198
 199         if (!len)
 200                 return -EINVAL;
 201
 202         dma_xfer = kzalloc(sizeof(*dma_xfer) * sgs, GFP_KERNEL);
 203         if (!dma_xfer)
 204                 return -ENOMEM;
 205
 206         INIT_COMPLETION(spi->c);
 207
 208         /* Chip select was already programmed into CTRL0 */
 209         ctrl0 = readl(ssp->base + HW_SSP_CTRL0);
 210         ctrl0 &= ~(BM_SSP_CTRL0_XFER_COUNT | BM_SSP_CTRL0_IGNORE_CRC |
 211                  BM_SSP_CTRL0_READ);
 212         ctrl0 |= BM_SSP_CTRL0_DATA_XFER;
 213
 214         if (!(flags & TXRX_WRITE))
 215                 ctrl0 |= BM_SSP_CTRL0_READ;
 216
 217         /* Queue the DMA data transfer. */
 218         for (sg_count = 0; sg_count < sgs; sg_count++) {
 219                 /* Prepare the transfer descriptor. */
 220                 min = min(len, desc_len);
 221
 222                 /*
 223                  * De-assert CS on last segment if flag is set (i.e., no more
 224                  * transfers will follow)
 225                  */
 226                 if ((sg_count + 1 == sgs) && (flags & TXRX_DEASSERT_CS))
 227                         ctrl0 |= BM_SSP_CTRL0_IGNORE_CRC;
 228
 229                 if (ssp->devid == IMX23_SSP) {
 230                         ctrl0 &= ~BM_SSP_CTRL0_XFER_COUNT;
 231                         ctrl0 |= min;
 232                 }
 233
 234                 dma_xfer[sg_count].pio[0] = ctrl0;
 235                 dma_xfer[sg_count].pio[3] = min;
 236
 237                 if (vmalloced_buf) {
 238                         vm_page = vmalloc_to_page(buf);
 239                         if (!vm_page) {
 240                                 ret = -ENOMEM;
 241                                 goto err_vmalloc;
 242                         }
 243                         sg_buf = page_address(vm_page) +
 244                                 ((size_t)buf & ~PAGE_MASK);
 245                 } else {
 246                         sg_buf = buf;
 247                 }
 248
 249                 sg_init_one(&dma_xfer[sg_count].sg, sg_buf, min);
 250                 ret = dma_map_sg(ssp->dev, &dma_xfer[sg_count].sg, 1,
 251                         (flags & TXRX_WRITE) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
 252
 253                 len -= min;
 254                 buf += min;
 255
 256                 /* Queue the PIO register write transfer. */
 257                 desc = dmaengine_prep_slave_sg(ssp->dmach,
 258                                 (struct scatterlist *)dma_xfer[sg_count].pio,
 259                                 (ssp->devid == IMX23_SSP) ? 1 : 4,
 260                                 DMA_TRANS_NONE,
 261                                 sg_count ? DMA_PREP_INTERRUPT : 0);
 262                 if (!desc) {
 263                         dev_err(ssp->dev,
 264                                 "Failed to get PIO reg. write descriptor.\n");
 265                         ret = -EINVAL;
 266                         goto err_mapped;
 267                 }
 268
 269                 desc = dmaengine_prep_slave_sg(ssp->dmach,
 270                                 &dma_xfer[sg_count].sg, 1,
 271                                 (flags & TXRX_WRITE) ? DMA_MEM_TO_DEV : DMA_DEV_TO_MEM,
 272                                 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 273
 274                 if (!desc) {
 275                         dev_err(ssp->dev,
 276                                 "Failed to get DMA data write descriptor.\n");
 277                         ret = -EINVAL;
 278                         goto err_mapped;
 279                 }
 280         }
 281
 282         /*
 283          * The last descriptor must have this callback,
 284          * to finish the DMA transaction.
 285          */
 286         desc->callback = mxs_ssp_dma_irq_callback;
 287         desc->callback_param = spi;
 288
 289         /* Start the transfer. */
 290         dmaengine_submit(desc);
 291         dma_async_issue_pending(ssp->dmach);
 292
 293         ret = wait_for_completion_timeout(&spi->c,
 294                                 msecs_to_jiffies(SSP_TIMEOUT));
 295         if (!ret) {
 296                 dev_err(ssp->dev, "DMA transfer timeout\n");
 297                 ret = -ETIMEDOUT;
 298                 dmaengine_terminate_all(ssp->dmach);
 299                 goto err_vmalloc;
 300         }
 301
 302         ret = 0;
 303
 304 err_vmalloc:
 305         while (--sg_count >= 0) {
 306 err_mapped:
 307                 dma_unmap_sg(ssp->dev, &dma_xfer[sg_count].sg, 1,
 308                         (flags & TXRX_WRITE) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
 309         }
 310
 311         kfree(dma_xfer);
 312
 313         return ret;
 314 }
 315
 316 static int mxs_spi_txrx_pio(struct mxs_spi *spi,
 317                             unsigned char *buf, int len,
 318                             unsigned int flags)
 319 {
 320         struct mxs_ssp *ssp = &spi->ssp;
 321
 322         writel(BM_SSP_CTRL0_IGNORE_CRC,
 323                ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_CLR);
 324
 325         while (len--) {
 326                 if (len == 0 && (flags & TXRX_DEASSERT_CS))
 327                         writel(BM_SSP_CTRL0_IGNORE_CRC,
 328                                ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_SET);
 329
 330                 if (ssp->devid == IMX23_SSP) {
 331                         writel(BM_SSP_CTRL0_XFER_COUNT,
 332                                 ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_CLR);
 333                         writel(1,
 334                                 ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_SET);
 335                 } else {
 336                         writel(1, ssp->base + HW_SSP_XFER_SIZE);
 337                 }
 338
 339                 if (flags & TXRX_WRITE)
 340                         writel(BM_SSP_CTRL0_READ,
 341                                 ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_CLR);
 342                 else
 343                         writel(BM_SSP_CTRL0_READ,
 344                                 ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_SET);
 345
 346                 writel(BM_SSP_CTRL0_RUN,
 347                                 ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_SET);
 348
 349                 if (mxs_ssp_wait(spi, HW_SSP_CTRL0, BM_SSP_CTRL0_RUN, 1))
 350                         return -ETIMEDOUT;
 351
 352                 if (flags & TXRX_WRITE)
 353                         writel(*buf, ssp->base + HW_SSP_DATA(ssp));
 354
 355                 writel(BM_SSP_CTRL0_DATA_XFER,
 356                              ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_SET);
 357
 358                 if (!(flags & TXRX_WRITE)) {
 359                         if (mxs_ssp_wait(spi, HW_SSP_STATUS(ssp),
 360                                                 BM_SSP_STATUS_FIFO_EMPTY, 0))
 361                                 return -ETIMEDOUT;
 362
 363                         *buf = (readl(ssp->base + HW_SSP_DATA(ssp)) & 0xff);
 364                 }
 365
 366                 if (mxs_ssp_wait(spi, HW_SSP_CTRL0, BM_SSP_CTRL0_RUN, 0))
 367                         return -ETIMEDOUT;
 368
 369                 buf++;
 370         }
 371
 372         if (len <= 0)
 373                 return 0;
 374
 375         return -ETIMEDOUT;
 376 }
 377
 378 static int mxs_spi_transfer_one(struct spi_master *master,
 379                                 struct spi_message *m)
 380 {
 381         struct mxs_spi *spi = spi_master_get_devdata(master);
 382         struct mxs_ssp *ssp = &spi->ssp;
 383         struct spi_transfer *t, *tmp_t;
 384         unsigned int flag;
 385         int status = 0;
 386
 387         /* Program CS register bits here, it will be used for all transfers. */
 388         writel(BM_SSP_CTRL0_WAIT_FOR_CMD | BM_SSP_CTRL0_WAIT_FOR_IRQ,
 389                ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_CLR);
 390         writel(mxs_spi_cs_to_reg(m->spi->chip_select),
 391                ssp->base + HW_SSP_CTRL0 + STMP_OFFSET_REG_SET);
 392
 393         list_for_each_entry_safe(t, tmp_t, &m->transfers, transfer_list) {
 394
 395                 status = mxs_spi_setup_transfer(m->spi, t);
 396                 if (status)
 397                         break;
 398
 399                 /* De-assert on last transfer, inverted by cs_change flag */
 400                 flag = (&t->transfer_list == m->transfers.prev) ^ t->cs_change ?
 401                        TXRX_DEASSERT_CS : 0;
 402
 403                 /*
 404                  * Small blocks can be transfered via PIO.
 405                  * Measured by empiric means:
 406                  *
 407                  * dd if=/dev/mtdblock0 of=/dev/null bs=1024k count=1
 408                  *
 409                  * DMA only: 2.164808 seconds, 473.0KB/s
 410                  * Combined: 1.676276 seconds, 610.9KB/s
 411                  */
 412                 if (t->len < 32) {
 413                         writel(BM_SSP_CTRL1_DMA_ENABLE,
 414                                 ssp->base + HW_SSP_CTRL1(ssp) +
 415                                 STMP_OFFSET_REG_CLR);
 416
 417                         if (t->tx_buf)
 418                                 status = mxs_spi_txrx_pio(spi,
 419                                                 (void *)t->tx_buf,
 420                                                 t->len, flag | TXRX_WRITE);
 421                         if (t->rx_buf)
 422                                 status = mxs_spi_txrx_pio(spi,
 423                                                 t->rx_buf, t->len,
 424                                                 flag);
 425                 } else {
 426                         writel(BM_SSP_CTRL1_DMA_ENABLE,
 427                                 ssp->base + HW_SSP_CTRL1(ssp) +
 428                                 STMP_OFFSET_REG_SET);
 429
 430                         if (t->tx_buf)
 431                                 status = mxs_spi_txrx_dma(spi,
 432                                                 (void *)t->tx_buf, t->len,
 433                                                 flag | TXRX_WRITE);
 434                         if (t->rx_buf)
 435                                 status = mxs_spi_txrx_dma(spi,
 436                                                 t->rx_buf, t->len,
 437                                                 flag);
 438                 }
 439
 440                 if (status) {
 441                         stmp_reset_block(ssp->base);
 442                         break;
 443                 }
 444
 445                 m->actual_length += t->len;
 446         }
 447
 448         m->status = status;
 449         spi_finalize_current_message(master);
 450
 451         return status;
 452 }
 453
 454 static const struct of_device_id mxs_spi_dt_ids[] = {
 455         { .compatible = "fsl,imx23-spi", .data = (void *) IMX23_SSP, },
 456         { .compatible = "fsl,imx28-spi", .data = (void *) IMX28_SSP, },
 457         { /* sentinel */ }
 458 };
 459 MODULE_DEVICE_TABLE(of, mxs_spi_dt_ids);
 460
 461 static int mxs_spi_probe(struct platform_device *pdev)
 462 {
 463         const struct of_device_id *of_id =
 464                         of_match_device(mxs_spi_dt_ids, &pdev->dev);
 465         struct device_node *np = pdev->dev.of_node;
 466         struct spi_master *master;
 467         struct mxs_spi *spi;
 468         struct mxs_ssp *ssp;
 469         struct resource *iores;
 470         struct clk *clk;
 471         void __iomem *base;
 472         int devid, clk_freq;
 473         int ret = 0, irq_err;
 474
 475         /*
 476          * Default clock speed for the SPI core. 160MHz seems to
 477          * work reasonably well with most SPI flashes, so use this
 478          * as a default. Override with "clock-frequency" DT prop.
 479          */
 480         const int clk_freq_default = 160000000;
 481
 482         iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 483         irq_err = platform_get_irq(pdev, 0);
 484         if (irq_err < 0)
 485                 return -EINVAL;
 486
 487         base = devm_ioremap_resource(&pdev->dev, iores);
 488         if (IS_ERR(base))
 489                 return PTR_ERR(base);
 490
 491         clk = devm_clk_get(&pdev->dev, NULL);
 492         if (IS_ERR(clk))
 493                 return PTR_ERR(clk);
 494
 495         devid = (enum mxs_ssp_id) of_id->data;
 496         ret = of_property_read_u32(np, "clock-frequency",
 497                                    &clk_freq);
 498         if (ret)
 499                 clk_freq = clk_freq_default;
 500
 501         master = spi_alloc_master(&pdev->dev, sizeof(*spi));
 502         if (!master)
 503                 return -ENOMEM;
 504
 505         master->transfer_one_message = mxs_spi_transfer_one;
 506         master->setup = mxs_spi_setup;
 507         master->bits_per_word_mask = SPI_BPW_MASK(8);
 508         master->mode_bits = SPI_CPOL | SPI_CPHA;
 509         master->num_chipselect = 3;
 510         master->dev.of_node = np;
 511         master->flags = SPI_MASTER_HALF_DUPLEX;
 512
 513         spi = spi_master_get_devdata(master);
 514         ssp = &spi->ssp;
 515         ssp->dev = &pdev->dev;
 516         ssp->clk = clk;
 517         ssp->base = base;
 518         ssp->devid = devid;
 519
 520         init_completion(&spi->c);
 521
 522         ret = devm_request_irq(&pdev->dev, irq_err, mxs_ssp_irq_handler, 0,
 523                                DRIVER_NAME, ssp);
 524         if (ret)
 525                 goto out_master_free;
 526
 527         ssp->dmach = dma_request_slave_channel(&pdev->dev, "rx-tx");
 528         if (!ssp->dmach) {
 529                 dev_err(ssp->dev, "Failed to request DMA\n");
 530                 ret = -ENODEV;
 531                 goto out_master_free;
 532         }
 533
 534         ret = clk_prepare_enable(ssp->clk);
 535         if (ret)
 536                 goto out_dma_release;
 537
 538         clk_set_rate(ssp->clk, clk_freq);
 539         ssp->clk_rate = clk_get_rate(ssp->clk) / 1000;
 540
 541         ret = stmp_reset_block(ssp->base);
 542         if (ret)
 543                 goto out_disable_clk;
 544
 545         platform_set_drvdata(pdev, master);
 546
 547         ret = spi_register_master(master);
 548         if (ret) {
 549                 dev_err(&pdev->dev, "Cannot register SPI master, %d\n", ret);
 550                 goto out_disable_clk;
 551         }
 552
 553         return 0;
 554
 555 out_disable_clk:
 556         clk_disable_unprepare(ssp->clk);
 557 out_dma_release:
 558         dma_release_channel(ssp->dmach);
 559 out_master_free:
 560         spi_master_put(master);
 561         return ret;
 562 }
 563
 564 static int mxs_spi_remove(struct platform_device *pdev)
 565 {
 566         struct spi_master *master;
 567         struct mxs_spi *spi;
 568         struct mxs_ssp *ssp;
 569
 570         master = spi_master_get(platform_get_drvdata(pdev));
 571         spi = spi_master_get_devdata(master);
 572         ssp = &spi->ssp;
 573
 574         spi_unregister_master(master);
 575         clk_disable_unprepare(ssp->clk);
 576         dma_release_channel(ssp->dmach);
 577         spi_master_put(master);
 578
 579         return 0;
 580 }
 581
 582 static struct platform_driver mxs_spi_driver = {
 583         .probe  = mxs_spi_probe,
 584         .remove = mxs_spi_remove,
 585         .driver = {
 586                 .name   = DRIVER_NAME,
 587                 .owner  = THIS_MODULE,
 588                 .of_match_table = mxs_spi_dt_ids,
 589         },
 590 };
 591
 592 module_platform_driver(mxs_spi_driver);
 593
 594 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
 595 MODULE_DESCRIPTION("MXS SPI master driver");
 596 MODULE_LICENSE("GPL");
 597 MODULE_ALIAS("platform:mxs-spi");