drivers/spi/spi-bcm2835.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Driver for Broadcom BCM2835 SPI Controllers
   4  *
   5  * Copyright (C) 2012 Chris Boot
   6  * Copyright (C) 2013 Stephen Warren
   7  * Copyright (C) 2015 Martin Sperl
   8  *
   9  * This driver is inspired by:
  10  * spi-ath79.c, Copyright (C) 2009-2011 Gabor Juhos <juhosg@openwrt.org>
  11  * spi-atmel.c, Copyright (C) 2006 Atmel Corporation
  12  */
  13
  14 #include <linux/clk.h>
  15 #include <linux/completion.h>
  16 #include <linux/debugfs.h>
  17 #include <linux/delay.h>
  18 #include <linux/dma-mapping.h>
  19 #include <linux/dmaengine.h>
  20 #include <linux/err.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/io.h>
  23 #include <linux/kernel.h>
  24 #include <linux/module.h>
  25 #include <linux/of.h>
  26 #include <linux/of_address.h>
  27 #include <linux/of_device.h>
  28 #include <linux/gpio/consumer.h>
  29 #include <linux/gpio/machine.h> /* FIXME: using chip internals */
  30 #include <linux/gpio/driver.h> /* FIXME: using chip internals */
  31 #include <linux/of_irq.h>
  32 #include <linux/spi/spi.h>
  33
  34 /* SPI register offsets */
  35 #define BCM2835_SPI_CS                  0x00
  36 #define BCM2835_SPI_FIFO                0x04
  37 #define BCM2835_SPI_CLK                 0x08
  38 #define BCM2835_SPI_DLEN                0x0c
  39 #define BCM2835_SPI_LTOH                0x10
  40 #define BCM2835_SPI_DC                  0x14
  41
  42 /* Bitfields in CS */
  43 #define BCM2835_SPI_CS_LEN_LONG         0x02000000
  44 #define BCM2835_SPI_CS_DMA_LEN          0x01000000
  45 #define BCM2835_SPI_CS_CSPOL2           0x00800000
  46 #define BCM2835_SPI_CS_CSPOL1           0x00400000
  47 #define BCM2835_SPI_CS_CSPOL0           0x00200000
  48 #define BCM2835_SPI_CS_RXF              0x00100000
  49 #define BCM2835_SPI_CS_RXR              0x00080000
  50 #define BCM2835_SPI_CS_TXD              0x00040000
  51 #define BCM2835_SPI_CS_RXD              0x00020000
  52 #define BCM2835_SPI_CS_DONE             0x00010000
  53 #define BCM2835_SPI_CS_LEN              0x00002000
  54 #define BCM2835_SPI_CS_REN              0x00001000
  55 #define BCM2835_SPI_CS_ADCS             0x00000800
  56 #define BCM2835_SPI_CS_INTR             0x00000400
  57 #define BCM2835_SPI_CS_INTD             0x00000200
  58 #define BCM2835_SPI_CS_DMAEN            0x00000100
  59 #define BCM2835_SPI_CS_TA               0x00000080
  60 #define BCM2835_SPI_CS_CSPOL            0x00000040
  61 #define BCM2835_SPI_CS_CLEAR_RX         0x00000020
  62 #define BCM2835_SPI_CS_CLEAR_TX         0x00000010
  63 #define BCM2835_SPI_CS_CPOL             0x00000008
  64 #define BCM2835_SPI_CS_CPHA             0x00000004
  65 #define BCM2835_SPI_CS_CS_10            0x00000002
  66 #define BCM2835_SPI_CS_CS_01            0x00000001
  67
  68 #define BCM2835_SPI_FIFO_SIZE           64
  69 #define BCM2835_SPI_FIFO_SIZE_3_4       48
  70 #define BCM2835_SPI_DMA_MIN_LENGTH      96
  71 #define BCM2835_SPI_MODE_BITS   (SPI_CPOL | SPI_CPHA | SPI_CS_HIGH \
  72                                 | SPI_NO_CS | SPI_3WIRE)
  73
  74 #define DRV_NAME        "spi-bcm2835"
  75
  76 /* define polling limits */
  77 unsigned int polling_limit_us = 30;
  78 module_param(polling_limit_us, uint, 0664);
  79 MODULE_PARM_DESC(polling_limit_us,
  80                  "time in us to run a transfer in polling mode\n");
  81
  82 /**
  83  * struct bcm2835_spi - BCM2835 SPI controller
  84  * @regs: base address of register map
  85  * @clk: core clock, divided to calculate serial clock
  86  * @irq: interrupt, signals TX FIFO empty or RX FIFO ¾ full
  87  * @tfr: SPI transfer currently processed
  88  * @tx_buf: pointer whence next transmitted byte is read
  89  * @rx_buf: pointer where next received byte is written
  90  * @tx_len: remaining bytes to transmit
  91  * @rx_len: remaining bytes to receive
  92  * @tx_prologue: bytes transmitted without DMA if first TX sglist entry's
  93  *      length is not a multiple of 4 (to overcome hardware limitation)
  94  * @rx_prologue: bytes received without DMA if first RX sglist entry's
  95  *      length is not a multiple of 4 (to overcome hardware limitation)
  96  * @tx_spillover: whether @tx_prologue spills over to second TX sglist entry
  97  * @debugfs_dir: the debugfs directory - neede to remove debugfs when
  98  *      unloading the module
  99  * @count_transfer_polling: count of how often polling mode is used
 100  * @count_transfer_irq: count of how often interrupt mode is used
 101  * @count_transfer_irq_after_polling: count of how often we fall back to
 102  *      interrupt mode after starting in polling mode.
 103  *      These are counted as well in @count_transfer_polling and
 104  *      @count_transfer_irq
 105  * @count_transfer_dma: count how often dma mode is used
 106  */
 107 struct bcm2835_spi {
 108         void __iomem *regs;
 109         struct clk *clk;
 110         int irq;
 111         struct spi_transfer *tfr;
 112         const u8 *tx_buf;
 113         u8 *rx_buf;
 114         int tx_len;
 115         int rx_len;
 116         int tx_prologue;
 117         int rx_prologue;
 118         unsigned int tx_spillover;
 119
 120         struct dentry *debugfs_dir;
 121         u64 count_transfer_polling;
 122         u64 count_transfer_irq;
 123         u64 count_transfer_irq_after_polling;
 124         u64 count_transfer_dma;
 125 };
 126
 127 #if defined(CONFIG_DEBUG_FS)
 128 static void bcm2835_debugfs_create(struct bcm2835_spi *bs,
 129                                    const char *dname)
 130 {
 131         char name[64];
 132         struct dentry *dir;
 133
 134         /* get full name */
 135         snprintf(name, sizeof(name), "spi-bcm2835-%s", dname);
 136
 137         /* the base directory */
 138         dir = debugfs_create_dir(name, NULL);
 139         bs->debugfs_dir = dir;
 140
 141         /* the counters */
 142         debugfs_create_u64("count_transfer_polling", 0444, dir,
 143                            &bs->count_transfer_polling);
 144         debugfs_create_u64("count_transfer_irq", 0444, dir,
 145                            &bs->count_transfer_irq);
 146         debugfs_create_u64("count_transfer_irq_after_polling", 0444, dir,
 147                            &bs->count_transfer_irq_after_polling);
 148         debugfs_create_u64("count_transfer_dma", 0444, dir,
 149                            &bs->count_transfer_dma);
 150 }
 151
 152 static void bcm2835_debugfs_remove(struct bcm2835_spi *bs)
 153 {
 154         debugfs_remove_recursive(bs->debugfs_dir);
 155         bs->debugfs_dir = NULL;
 156 }
 157 #else
 158 static void bcm2835_debugfs_create(struct bcm2835_spi *bs,
 159                                    const char *dname)
 160 {
 161 }
 162
 163 static void bcm2835_debugfs_remove(struct bcm2835_spi *bs)
 164 {
 165 }
 166 #endif /* CONFIG_DEBUG_FS */
 167
 168 static inline u32 bcm2835_rd(struct bcm2835_spi *bs, unsigned reg)
 169 {
 170         return readl(bs->regs + reg);
 171 }
 172
 173 static inline void bcm2835_wr(struct bcm2835_spi *bs, unsigned reg, u32 val)
 174 {
 175         writel(val, bs->regs + reg);
 176 }
 177
 178 static inline void bcm2835_rd_fifo(struct bcm2835_spi *bs)
 179 {
 180         u8 byte;
 181
 182         while ((bs->rx_len) &&
 183                (bcm2835_rd(bs, BCM2835_SPI_CS) & BCM2835_SPI_CS_RXD)) {
 184                 byte = bcm2835_rd(bs, BCM2835_SPI_FIFO);
 185                 if (bs->rx_buf)
 186                         *bs->rx_buf++ = byte;
 187                 bs->rx_len--;
 188         }
 189 }
 190
 191 static inline void bcm2835_wr_fifo(struct bcm2835_spi *bs)
 192 {
 193         u8 byte;
 194
 195         while ((bs->tx_len) &&
 196                (bcm2835_rd(bs, BCM2835_SPI_CS) & BCM2835_SPI_CS_TXD)) {
 197                 byte = bs->tx_buf ? *bs->tx_buf++ : 0;
 198                 bcm2835_wr(bs, BCM2835_SPI_FIFO, byte);
 199                 bs->tx_len--;
 200         }
 201 }
 202
 203 /**
 204  * bcm2835_rd_fifo_count() - blindly read exactly @count bytes from RX FIFO
 205  * @bs: BCM2835 SPI controller
 206  * @count: bytes to read from RX FIFO
 207  *
 208  * The caller must ensure that @bs->rx_len is greater than or equal to @count,
 209  * that the RX FIFO contains at least @count bytes and that the DMA Enable flag
 210  * in the CS register is set (such that a read from the FIFO register receives
 211  * 32-bit instead of just 8-bit).  Moreover @bs->rx_buf must not be %NULL.
 212  */
 213 static inline void bcm2835_rd_fifo_count(struct bcm2835_spi *bs, int count)
 214 {
 215         u32 val;
 216         int len;
 217
 218         bs->rx_len -= count;
 219
 220         while (count > 0) {
 221                 val = bcm2835_rd(bs, BCM2835_SPI_FIFO);
 222                 len = min(count, 4);
 223                 memcpy(bs->rx_buf, &val, len);
 224                 bs->rx_buf += len;
 225                 count -= 4;
 226         }
 227 }
 228
 229 /**
 230  * bcm2835_wr_fifo_count() - blindly write exactly @count bytes to TX FIFO
 231  * @bs: BCM2835 SPI controller
 232  * @count: bytes to write to TX FIFO
 233  *
 234  * The caller must ensure that @bs->tx_len is greater than or equal to @count,
 235  * that the TX FIFO can accommodate @count bytes and that the DMA Enable flag
 236  * in the CS register is set (such that a write to the FIFO register transmits
 237  * 32-bit instead of just 8-bit).
 238  */
 239 static inline void bcm2835_wr_fifo_count(struct bcm2835_spi *bs, int count)
 240 {
 241         u32 val;
 242         int len;
 243
 244         bs->tx_len -= count;
 245
 246         while (count > 0) {
 247                 if (bs->tx_buf) {
 248                         len = min(count, 4);
 249                         memcpy(&val, bs->tx_buf, len);
 250                         bs->tx_buf += len;
 251                 } else {
 252                         val = 0;
 253                 }
 254                 bcm2835_wr(bs, BCM2835_SPI_FIFO, val);
 255                 count -= 4;
 256         }
 257 }
 258
 259 /**
 260  * bcm2835_wait_tx_fifo_empty() - busy-wait for TX FIFO to empty
 261  * @bs: BCM2835 SPI controller
 262  *
 263  * The caller must ensure that the RX FIFO can accommodate as many bytes
 264  * as have been written to the TX FIFO:  Transmission is halted once the
 265  * RX FIFO is full, causing this function to spin forever.
 266  */
 267 static inline void bcm2835_wait_tx_fifo_empty(struct bcm2835_spi *bs)
 268 {
 269         while (!(bcm2835_rd(bs, BCM2835_SPI_CS) & BCM2835_SPI_CS_DONE))
 270                 cpu_relax();
 271 }
 272
 273 /**
 274  * bcm2835_rd_fifo_blind() - blindly read up to @count bytes from RX FIFO
 275  * @bs: BCM2835 SPI controller
 276  * @count: bytes available for reading in RX FIFO
 277  */
 278 static inline void bcm2835_rd_fifo_blind(struct bcm2835_spi *bs, int count)
 279 {
 280         u8 val;
 281
 282         count = min(count, bs->rx_len);
 283         bs->rx_len -= count;
 284
 285         while (count) {
 286                 val = bcm2835_rd(bs, BCM2835_SPI_FIFO);
 287                 if (bs->rx_buf)
 288                         *bs->rx_buf++ = val;
 289                 count--;
 290         }
 291 }
 292
 293 /**
 294  * bcm2835_wr_fifo_blind() - blindly write up to @count bytes to TX FIFO
 295  * @bs: BCM2835 SPI controller
 296  * @count: bytes available for writing in TX FIFO
 297  */
 298 static inline void bcm2835_wr_fifo_blind(struct bcm2835_spi *bs, int count)
 299 {
 300         u8 val;
 301
 302         count = min(count, bs->tx_len);
 303         bs->tx_len -= count;
 304
 305         while (count) {
 306                 val = bs->tx_buf ? *bs->tx_buf++ : 0;
 307                 bcm2835_wr(bs, BCM2835_SPI_FIFO, val);
 308                 count--;
 309         }
 310 }
 311
 312 static void bcm2835_spi_reset_hw(struct spi_controller *ctlr)
 313 {
 314         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 315         u32 cs = bcm2835_rd(bs, BCM2835_SPI_CS);
 316
 317         /* Disable SPI interrupts and transfer */
 318         cs &= ~(BCM2835_SPI_CS_INTR |
 319                 BCM2835_SPI_CS_INTD |
 320                 BCM2835_SPI_CS_DMAEN |
 321                 BCM2835_SPI_CS_TA);
 322         /* and reset RX/TX FIFOS */
 323         cs |= BCM2835_SPI_CS_CLEAR_RX | BCM2835_SPI_CS_CLEAR_TX;
 324
 325         /* and reset the SPI_HW */
 326         bcm2835_wr(bs, BCM2835_SPI_CS, cs);
 327         /* as well as DLEN */
 328         bcm2835_wr(bs, BCM2835_SPI_DLEN, 0);
 329 }
 330
 331 static irqreturn_t bcm2835_spi_interrupt(int irq, void *dev_id)
 332 {
 333         struct spi_controller *ctlr = dev_id;
 334         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 335         u32 cs = bcm2835_rd(bs, BCM2835_SPI_CS);
 336
 337         /*
 338          * An interrupt is signaled either if DONE is set (TX FIFO empty)
 339          * or if RXR is set (RX FIFO >= ¾ full).
 340          */
 341         if (cs & BCM2835_SPI_CS_RXF)
 342                 bcm2835_rd_fifo_blind(bs, BCM2835_SPI_FIFO_SIZE);
 343         else if (cs & BCM2835_SPI_CS_RXR)
 344                 bcm2835_rd_fifo_blind(bs, BCM2835_SPI_FIFO_SIZE_3_4);
 345
 346         if (bs->tx_len && cs & BCM2835_SPI_CS_DONE)
 347                 bcm2835_wr_fifo_blind(bs, BCM2835_SPI_FIFO_SIZE);
 348
 349         /* Read as many bytes as possible from FIFO */
 350         bcm2835_rd_fifo(bs);
 351         /* Write as many bytes as possible to FIFO */
 352         bcm2835_wr_fifo(bs);
 353
 354         if (!bs->rx_len) {
 355                 /* Transfer complete - reset SPI HW */
 356                 bcm2835_spi_reset_hw(ctlr);
 357                 /* wake up the framework */
 358                 complete(&ctlr->xfer_completion);
 359         }
 360
 361         return IRQ_HANDLED;
 362 }
 363
 364 static int bcm2835_spi_transfer_one_irq(struct spi_controller *ctlr,
 365                                         struct spi_device *spi,
 366                                         struct spi_transfer *tfr,
 367                                         u32 cs, bool fifo_empty)
 368 {
 369         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 370
 371         /* update usage statistics */
 372         bs->count_transfer_irq++;
 373
 374         /*
 375          * Enable HW block, but with interrupts still disabled.
 376          * Otherwise the empty TX FIFO would immediately trigger an interrupt.
 377          */
 378         bcm2835_wr(bs, BCM2835_SPI_CS, cs | BCM2835_SPI_CS_TA);
 379
 380         /* fill TX FIFO as much as possible */
 381         if (fifo_empty)
 382                 bcm2835_wr_fifo_blind(bs, BCM2835_SPI_FIFO_SIZE);
 383         bcm2835_wr_fifo(bs);
 384
 385         /* enable interrupts */
 386         cs |= BCM2835_SPI_CS_INTR | BCM2835_SPI_CS_INTD | BCM2835_SPI_CS_TA;
 387         bcm2835_wr(bs, BCM2835_SPI_CS, cs);
 388
 389         /* signal that we need to wait for completion */
 390         return 1;
 391 }
 392
 393 /**
 394  * bcm2835_spi_transfer_prologue() - transfer first few bytes without DMA
 395  * @ctlr: SPI master controller
 396  * @tfr: SPI transfer
 397  * @bs: BCM2835 SPI controller
 398  * @cs: CS register
 399  *
 400  * A limitation in DMA mode is that the FIFO must be accessed in 4 byte chunks.
 401  * Only the final write access is permitted to transmit less than 4 bytes, the
 402  * SPI controller deduces its intended size from the DLEN register.
 403  *
 404  * If a TX or RX sglist contains multiple entries, one per page, and the first
 405  * entry starts in the middle of a page, that first entry's length may not be
 406  * a multiple of 4.  Subsequent entries are fine because they span an entire
 407  * page, hence do have a length that's a multiple of 4.
 408  *
 409  * This cannot happen with kmalloc'ed buffers (which is what most clients use)
 410  * because they are contiguous in physical memory and therefore not split on
 411  * page boundaries by spi_map_buf().  But it *can* happen with vmalloc'ed
 412  * buffers.
 413  *
 414  * The DMA engine is incapable of combining sglist entries into a continuous
 415  * stream of 4 byte chunks, it treats every entry separately:  A TX entry is
 416  * rounded up a to a multiple of 4 bytes by transmitting surplus bytes, an RX
 417  * entry is rounded up by throwing away received bytes.
 418  *
 419  * Overcome this limitation by transferring the first few bytes without DMA:
 420  * E.g. if the first TX sglist entry's length is 23 and the first RX's is 42,
 421  * write 3 bytes to the TX FIFO but read only 2 bytes from the RX FIFO.
 422  * The residue of 1 byte in the RX FIFO is picked up by DMA.  Together with
 423  * the rest of the first RX sglist entry it makes up a multiple of 4 bytes.
 424  *
 425  * Should the RX prologue be larger, say, 3 vis-à-vis a TX prologue of 1,
 426  * write 1 + 4 = 5 bytes to the TX FIFO and read 3 bytes from the RX FIFO.
 427  * Caution, the additional 4 bytes spill over to the second TX sglist entry
 428  * if the length of the first is *exactly* 1.
 429  *
 430  * At most 6 bytes are written and at most 3 bytes read.  Do we know the
 431  * transfer has this many bytes?  Yes, see BCM2835_SPI_DMA_MIN_LENGTH.
 432  *
 433  * The FIFO is normally accessed with 8-bit width by the CPU and 32-bit width
 434  * by the DMA engine.  Toggling the DMA Enable flag in the CS register switches
 435  * the width but also garbles the FIFO's contents.  The prologue must therefore
 436  * be transmitted in 32-bit width to ensure that the following DMA transfer can
 437  * pick up the residue in the RX FIFO in ungarbled form.
 438  */
 439 static void bcm2835_spi_transfer_prologue(struct spi_controller *ctlr,
 440                                           struct spi_transfer *tfr,
 441                                           struct bcm2835_spi *bs,
 442                                           u32 cs)
 443 {
 444         int tx_remaining;
 445
 446         bs->tfr          = tfr;
 447         bs->tx_prologue  = 0;
 448         bs->rx_prologue  = 0;
 449         bs->tx_spillover = false;
 450
 451         if (!sg_is_last(&tfr->tx_sg.sgl[0]))
 452                 bs->tx_prologue = sg_dma_len(&tfr->tx_sg.sgl[0]) & 3;
 453
 454         if (!sg_is_last(&tfr->rx_sg.sgl[0])) {
 455                 bs->rx_prologue = sg_dma_len(&tfr->rx_sg.sgl[0]) & 3;
 456
 457                 if (bs->rx_prologue > bs->tx_prologue) {
 458                         if (sg_is_last(&tfr->tx_sg.sgl[0])) {
 459                                 bs->tx_prologue  = bs->rx_prologue;
 460                         } else {
 461                                 bs->tx_prologue += 4;
 462                                 bs->tx_spillover =
 463                                         !(sg_dma_len(&tfr->tx_sg.sgl[0]) & ~3);
 464                         }
 465                 }
 466         }
 467
 468         /* rx_prologue > 0 implies tx_prologue > 0, so check only the latter */
 469         if (!bs->tx_prologue)
 470                 return;
 471
 472         /* Write and read RX prologue.  Adjust first entry in RX sglist. */
 473         if (bs->rx_prologue) {
 474                 bcm2835_wr(bs, BCM2835_SPI_DLEN, bs->rx_prologue);
 475                 bcm2835_wr(bs, BCM2835_SPI_CS, cs | BCM2835_SPI_CS_TA
 476                                                   | BCM2835_SPI_CS_DMAEN);
 477                 bcm2835_wr_fifo_count(bs, bs->rx_prologue);
 478                 bcm2835_wait_tx_fifo_empty(bs);
 479                 bcm2835_rd_fifo_count(bs, bs->rx_prologue);
 480                 bcm2835_spi_reset_hw(ctlr);
 481
 482                 dma_sync_single_for_device(ctlr->dma_rx->device->dev,
 483                                            sg_dma_address(&tfr->rx_sg.sgl[0]),
 484                                            bs->rx_prologue, DMA_FROM_DEVICE);
 485
 486                 sg_dma_address(&tfr->rx_sg.sgl[0]) += bs->rx_prologue;
 487                 sg_dma_len(&tfr->rx_sg.sgl[0])     -= bs->rx_prologue;
 488         }
 489
 490         /*
 491          * Write remaining TX prologue.  Adjust first entry in TX sglist.
 492          * Also adjust second entry if prologue spills over to it.
 493          */
 494         tx_remaining = bs->tx_prologue - bs->rx_prologue;
 495         if (tx_remaining) {
 496                 bcm2835_wr(bs, BCM2835_SPI_DLEN, tx_remaining);
 497                 bcm2835_wr(bs, BCM2835_SPI_CS, cs | BCM2835_SPI_CS_TA
 498                                                   | BCM2835_SPI_CS_DMAEN);
 499                 bcm2835_wr_fifo_count(bs, tx_remaining);
 500                 bcm2835_wait_tx_fifo_empty(bs);
 501                 bcm2835_wr(bs, BCM2835_SPI_CS, cs | BCM2835_SPI_CS_CLEAR_TX);
 502         }
 503
 504         if (likely(!bs->tx_spillover)) {
 505                 sg_dma_address(&tfr->tx_sg.sgl[0]) += bs->tx_prologue;
 506                 sg_dma_len(&tfr->tx_sg.sgl[0])     -= bs->tx_prologue;
 507         } else {
 508                 sg_dma_len(&tfr->tx_sg.sgl[0])      = 0;
 509                 sg_dma_address(&tfr->tx_sg.sgl[1]) += 4;
 510                 sg_dma_len(&tfr->tx_sg.sgl[1])     -= 4;
 511         }
 512 }
 513
 514 /**
 515  * bcm2835_spi_undo_prologue() - reconstruct original sglist state
 516  * @bs: BCM2835 SPI controller
 517  *
 518  * Undo changes which were made to an SPI transfer's sglist when transmitting
 519  * the prologue.  This is necessary to ensure the same memory ranges are
 520  * unmapped that were originally mapped.
 521  */
 522 static void bcm2835_spi_undo_prologue(struct bcm2835_spi *bs)
 523 {
 524         struct spi_transfer *tfr = bs->tfr;
 525
 526         if (!bs->tx_prologue)
 527                 return;
 528
 529         if (bs->rx_prologue) {
 530                 sg_dma_address(&tfr->rx_sg.sgl[0]) -= bs->rx_prologue;
 531                 sg_dma_len(&tfr->rx_sg.sgl[0])     += bs->rx_prologue;
 532         }
 533
 534         if (likely(!bs->tx_spillover)) {
 535                 sg_dma_address(&tfr->tx_sg.sgl[0]) -= bs->tx_prologue;
 536                 sg_dma_len(&tfr->tx_sg.sgl[0])     += bs->tx_prologue;
 537         } else {
 538                 sg_dma_len(&tfr->tx_sg.sgl[0])      = bs->tx_prologue - 4;
 539                 sg_dma_address(&tfr->tx_sg.sgl[1]) -= 4;
 540                 sg_dma_len(&tfr->tx_sg.sgl[1])     += 4;
 541         }
 542
 543         bs->tx_prologue = 0;
 544 }
 545
 546 static void bcm2835_spi_dma_done(void *data)
 547 {
 548         struct spi_controller *ctlr = data;
 549         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 550
 551         /* reset fifo and HW */
 552         bcm2835_spi_reset_hw(ctlr);
 553
 554         /* and terminate tx-dma as we do not have an irq for it
 555          * because when the rx dma will terminate and this callback
 556          * is called the tx-dma must have finished - can't get to this
 557          * situation otherwise...
 558          */
 559         dmaengine_terminate_async(ctlr->dma_tx);
 560         bcm2835_spi_undo_prologue(bs);
 561
 562         /* and mark as completed */;
 563         complete(&ctlr->xfer_completion);
 564 }
 565
 566 static int bcm2835_spi_prepare_sg(struct spi_controller *ctlr,
 567                                   struct spi_transfer *tfr,
 568                                   bool is_tx)
 569 {
 570         struct dma_chan *chan;
 571         struct scatterlist *sgl;
 572         unsigned int nents;
 573         enum dma_transfer_direction dir;
 574         unsigned long flags;
 575
 576         struct dma_async_tx_descriptor *desc;
 577         dma_cookie_t cookie;
 578
 579         if (is_tx) {
 580                 dir   = DMA_MEM_TO_DEV;
 581                 chan  = ctlr->dma_tx;
 582                 nents = tfr->tx_sg.nents;
 583                 sgl   = tfr->tx_sg.sgl;
 584                 flags = 0 /* no  tx interrupt */;
 585
 586         } else {
 587                 dir   = DMA_DEV_TO_MEM;
 588                 chan  = ctlr->dma_rx;
 589                 nents = tfr->rx_sg.nents;
 590                 sgl   = tfr->rx_sg.sgl;
 591                 flags = DMA_PREP_INTERRUPT;
 592         }
 593         /* prepare the channel */
 594         desc = dmaengine_prep_slave_sg(chan, sgl, nents, dir, flags);
 595         if (!desc)
 596                 return -EINVAL;
 597
 598         /* set callback for rx */
 599         if (!is_tx) {
 600                 desc->callback = bcm2835_spi_dma_done;
 601                 desc->callback_param = ctlr;
 602         }
 603
 604         /* submit it to DMA-engine */
 605         cookie = dmaengine_submit(desc);
 606
 607         return dma_submit_error(cookie);
 608 }
 609
 610 static int bcm2835_spi_transfer_one_dma(struct spi_controller *ctlr,
 611                                         struct spi_device *spi,
 612                                         struct spi_transfer *tfr,
 613                                         u32 cs)
 614 {
 615         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 616         int ret;
 617
 618         /* update usage statistics */
 619         bs->count_transfer_dma++;
 620
 621         /*
 622          * Transfer first few bytes without DMA if length of first TX or RX
 623          * sglist entry is not a multiple of 4 bytes (hardware limitation).
 624          */
 625         bcm2835_spi_transfer_prologue(ctlr, tfr, bs, cs);
 626
 627         /* setup tx-DMA */
 628         ret = bcm2835_spi_prepare_sg(ctlr, tfr, true);
 629         if (ret)
 630                 goto err_reset_hw;
 631
 632         /* start TX early */
 633         dma_async_issue_pending(ctlr->dma_tx);
 634
 635         /* set the DMA length */
 636         bcm2835_wr(bs, BCM2835_SPI_DLEN, bs->tx_len);
 637
 638         /* start the HW */
 639         bcm2835_wr(bs, BCM2835_SPI_CS,
 640                    cs | BCM2835_SPI_CS_TA | BCM2835_SPI_CS_DMAEN);
 641
 642         /* setup rx-DMA late - to run transfers while
 643          * mapping of the rx buffers still takes place
 644          * this saves 10us or more.
 645          */
 646         ret = bcm2835_spi_prepare_sg(ctlr, tfr, false);
 647         if (ret) {
 648                 /* need to reset on errors */
 649                 dmaengine_terminate_sync(ctlr->dma_tx);
 650                 goto err_reset_hw;
 651         }
 652
 653         /* start rx dma late */
 654         dma_async_issue_pending(ctlr->dma_rx);
 655
 656         /* wait for wakeup in framework */
 657         return 1;
 658
 659 err_reset_hw:
 660         bcm2835_spi_reset_hw(ctlr);
 661         bcm2835_spi_undo_prologue(bs);
 662         return ret;
 663 }
 664
 665 static bool bcm2835_spi_can_dma(struct spi_controller *ctlr,
 666                                 struct spi_device *spi,
 667                                 struct spi_transfer *tfr)
 668 {
 669         /* we start DMA efforts only on bigger transfers */
 670         if (tfr->len < BCM2835_SPI_DMA_MIN_LENGTH)
 671                 return false;
 672
 673         /* return OK */
 674         return true;
 675 }
 676
 677 static void bcm2835_dma_release(struct spi_controller *ctlr)
 678 {
 679         if (ctlr->dma_tx) {
 680                 dmaengine_terminate_sync(ctlr->dma_tx);
 681                 dma_release_channel(ctlr->dma_tx);
 682                 ctlr->dma_tx = NULL;
 683         }
 684         if (ctlr->dma_rx) {
 685                 dmaengine_terminate_sync(ctlr->dma_rx);
 686                 dma_release_channel(ctlr->dma_rx);
 687                 ctlr->dma_rx = NULL;
 688         }
 689 }
 690
 691 static void bcm2835_dma_init(struct spi_controller *ctlr, struct device *dev)
 692 {
 693         struct dma_slave_config slave_config;
 694         const __be32 *addr;
 695         dma_addr_t dma_reg_base;
 696         int ret;
 697
 698         /* base address in dma-space */
 699         addr = of_get_address(ctlr->dev.of_node, 0, NULL, NULL);
 700         if (!addr) {
 701                 dev_err(dev, "could not get DMA-register address - not using dma mode\n");
 702                 goto err;
 703         }
 704         dma_reg_base = be32_to_cpup(addr);
 705
 706         /* get tx/rx dma */
 707         ctlr->dma_tx = dma_request_slave_channel(dev, "tx");
 708         if (!ctlr->dma_tx) {
 709                 dev_err(dev, "no tx-dma configuration found - not using dma mode\n");
 710                 goto err;
 711         }
 712         ctlr->dma_rx = dma_request_slave_channel(dev, "rx");
 713         if (!ctlr->dma_rx) {
 714                 dev_err(dev, "no rx-dma configuration found - not using dma mode\n");
 715                 goto err_release;
 716         }
 717
 718         /* configure DMAs */
 719         slave_config.dst_addr = (u32)(dma_reg_base + BCM2835_SPI_FIFO);
 720         slave_config.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
 721
 722         ret = dmaengine_slave_config(ctlr->dma_tx, &slave_config);
 723         if (ret)
 724                 goto err_config;
 725
 726         slave_config.src_addr = (u32)(dma_reg_base + BCM2835_SPI_FIFO);
 727         slave_config.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
 728
 729         ret = dmaengine_slave_config(ctlr->dma_rx, &slave_config);
 730         if (ret)
 731                 goto err_config;
 732
 733         /* all went well, so set can_dma */
 734         ctlr->can_dma = bcm2835_spi_can_dma;
 735         /* need to do TX AND RX DMA, so we need dummy buffers */
 736         ctlr->flags = SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX;
 737
 738         return;
 739
 740 err_config:
 741         dev_err(dev, "issue configuring dma: %d - not using DMA mode\n",
 742                 ret);
 743 err_release:
 744         bcm2835_dma_release(ctlr);
 745 err:
 746         return;
 747 }
 748
 749 static int bcm2835_spi_transfer_one_poll(struct spi_controller *ctlr,
 750                                          struct spi_device *spi,
 751                                          struct spi_transfer *tfr,
 752                                          u32 cs)
 753 {
 754         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 755         unsigned long timeout;
 756
 757         /* update usage statistics */
 758         bs->count_transfer_polling++;
 759
 760         /* enable HW block without interrupts */
 761         bcm2835_wr(bs, BCM2835_SPI_CS, cs | BCM2835_SPI_CS_TA);
 762
 763         /* fill in the fifo before timeout calculations
 764          * if we are interrupted here, then the data is
 765          * getting transferred by the HW while we are interrupted
 766          */
 767         bcm2835_wr_fifo_blind(bs, BCM2835_SPI_FIFO_SIZE);
 768
 769         /* set the timeout to at least 2 jiffies */
 770         timeout = jiffies + 2 + HZ * polling_limit_us / 1000000;
 771
 772         /* loop until finished the transfer */
 773         while (bs->rx_len) {
 774                 /* fill in tx fifo with remaining data */
 775                 bcm2835_wr_fifo(bs);
 776
 777                 /* read from fifo as much as possible */
 778                 bcm2835_rd_fifo(bs);
 779
 780                 /* if there is still data pending to read
 781                  * then check the timeout
 782                  */
 783                 if (bs->rx_len && time_after(jiffies, timeout)) {
 784                         dev_dbg_ratelimited(&spi->dev,
 785                                             "timeout period reached: jiffies: %lu remaining tx/rx: %d/%d - falling back to interrupt mode\n",
 786                                             jiffies - timeout,
 787                                             bs->tx_len, bs->rx_len);
 788                         /* fall back to interrupt mode */
 789
 790                         /* update usage statistics */
 791                         bs->count_transfer_irq_after_polling++;
 792
 793                         return bcm2835_spi_transfer_one_irq(ctlr, spi,
 794                                                             tfr, cs, false);
 795                 }
 796         }
 797
 798         /* Transfer complete - reset SPI HW */
 799         bcm2835_spi_reset_hw(ctlr);
 800         /* and return without waiting for completion */
 801         return 0;
 802 }
 803
 804 static int bcm2835_spi_transfer_one(struct spi_controller *ctlr,
 805                                     struct spi_device *spi,
 806                                     struct spi_transfer *tfr)
 807 {
 808         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 809         unsigned long spi_hz, clk_hz, cdiv, spi_used_hz;
 810         unsigned long hz_per_byte, byte_limit;
 811         u32 cs = bcm2835_rd(bs, BCM2835_SPI_CS);
 812
 813         /* set clock */
 814         spi_hz = tfr->speed_hz;
 815         clk_hz = clk_get_rate(bs->clk);
 816
 817         if (spi_hz >= clk_hz / 2) {
 818                 cdiv = 2; /* clk_hz/2 is the fastest we can go */
 819         } else if (spi_hz) {
 820                 /* CDIV must be a multiple of two */
 821                 cdiv = DIV_ROUND_UP(clk_hz, spi_hz);
 822                 cdiv += (cdiv % 2);
 823
 824                 if (cdiv >= 65536)
 825                         cdiv = 0; /* 0 is the slowest we can go */
 826         } else {
 827                 cdiv = 0; /* 0 is the slowest we can go */
 828         }
 829         spi_used_hz = cdiv ? (clk_hz / cdiv) : (clk_hz / 65536);
 830         bcm2835_wr(bs, BCM2835_SPI_CLK, cdiv);
 831
 832         /* handle all the 3-wire mode */
 833         if (spi->mode & SPI_3WIRE && tfr->rx_buf &&
 834             tfr->rx_buf != ctlr->dummy_rx)
 835                 cs |= BCM2835_SPI_CS_REN;
 836         else
 837                 cs &= ~BCM2835_SPI_CS_REN;
 838
 839         /*
 840          * The driver always uses software-controlled GPIO Chip Select.
 841          * Set the hardware-controlled native Chip Select to an invalid
 842          * value to prevent it from interfering.
 843          */
 844         cs |= BCM2835_SPI_CS_CS_10 | BCM2835_SPI_CS_CS_01;
 845
 846         /* set transmit buffers and length */
 847         bs->tx_buf = tfr->tx_buf;
 848         bs->rx_buf = tfr->rx_buf;
 849         bs->tx_len = tfr->len;
 850         bs->rx_len = tfr->len;
 851
 852         /* Calculate the estimated time in us the transfer runs.  Note that
 853          * there is 1 idle clocks cycles after each byte getting transferred
 854          * so we have 9 cycles/byte.  This is used to find the number of Hz
 855          * per byte per polling limit.  E.g., we can transfer 1 byte in 30 us
 856          * per 300,000 Hz of bus clock.
 857          */
 858         hz_per_byte = polling_limit_us ? (9 * 1000000) / polling_limit_us : 0;
 859         byte_limit = hz_per_byte ? spi_used_hz / hz_per_byte : 1;
 860
 861         /* run in polling mode for short transfers */
 862         if (tfr->len < byte_limit)
 863                 return bcm2835_spi_transfer_one_poll(ctlr, spi, tfr, cs);
 864
 865         /* run in dma mode if conditions are right
 866          * Note that unlike poll or interrupt mode DMA mode does not have
 867          * this 1 idle clock cycle pattern but runs the spi clock without gaps
 868          */
 869         if (ctlr->can_dma && bcm2835_spi_can_dma(ctlr, spi, tfr))
 870                 return bcm2835_spi_transfer_one_dma(ctlr, spi, tfr, cs);
 871
 872         /* run in interrupt-mode */
 873         return bcm2835_spi_transfer_one_irq(ctlr, spi, tfr, cs, true);
 874 }
 875
 876 static int bcm2835_spi_prepare_message(struct spi_controller *ctlr,
 877                                        struct spi_message *msg)
 878 {
 879         struct spi_device *spi = msg->spi;
 880         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 881         u32 cs = bcm2835_rd(bs, BCM2835_SPI_CS);
 882         int ret;
 883
 884         if (ctlr->can_dma) {
 885                 /*
 886                  * DMA transfers are limited to 16 bit (0 to 65535 bytes) by
 887                  * the SPI HW due to DLEN. Split up transfers (32-bit FIFO
 888                  * aligned) if the limit is exceeded.
 889                  */
 890                 ret = spi_split_transfers_maxsize(ctlr, msg, 65532,
 891                                                   GFP_KERNEL | GFP_DMA);
 892                 if (ret)
 893                         return ret;
 894         }
 895
 896         cs &= ~(BCM2835_SPI_CS_CPOL | BCM2835_SPI_CS_CPHA);
 897
 898         if (spi->mode & SPI_CPOL)
 899                 cs |= BCM2835_SPI_CS_CPOL;
 900         if (spi->mode & SPI_CPHA)
 901                 cs |= BCM2835_SPI_CS_CPHA;
 902
 903         bcm2835_wr(bs, BCM2835_SPI_CS, cs);
 904
 905         return 0;
 906 }
 907
 908 static void bcm2835_spi_handle_err(struct spi_controller *ctlr,
 909                                    struct spi_message *msg)
 910 {
 911         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
 912
 913         /* if an error occurred and we have an active dma, then terminate */
 914         dmaengine_terminate_sync(ctlr->dma_tx);
 915         dmaengine_terminate_sync(ctlr->dma_rx);
 916         bcm2835_spi_undo_prologue(bs);
 917
 918         /* and reset */
 919         bcm2835_spi_reset_hw(ctlr);
 920 }
 921
 922 static int chip_match_name(struct gpio_chip *chip, void *data)
 923 {
 924         return !strcmp(chip->label, data);
 925 }
 926
 927 static int bcm2835_spi_setup(struct spi_device *spi)
 928 {
 929         struct gpio_chip *chip;
 930         enum gpio_lookup_flags lflags;
 931
 932         /*
 933          * sanity checking the native-chipselects
 934          */
 935         if (spi->mode & SPI_NO_CS)
 936                 return 0;
 937         /*
 938          * The SPI core has successfully requested the CS GPIO line from the
 939          * device tree, so we are done.
 940          */
 941         if (spi->cs_gpiod)
 942                 return 0;
 943         if (spi->chip_select > 1) {
 944                 /* error in the case of native CS requested with CS > 1
 945                  * officially there is a CS2, but it is not documented
 946                  * which GPIO is connected with that...
 947                  */
 948                 dev_err(&spi->dev,
 949                         "setup: only two native chip-selects are supported\n");
 950                 return -EINVAL;
 951         }
 952
 953         /*
 954          * Translate native CS to GPIO
 955          *
 956          * FIXME: poking around in the gpiolib internals like this is
 957          * not very good practice. Find a way to locate the real problem
 958          * and fix it. Why is the GPIO descriptor in spi->cs_gpiod
 959          * sometimes not assigned correctly? Erroneous device trees?
 960          */
 961
 962         /* get the gpio chip for the base */
 963         chip = gpiochip_find("pinctrl-bcm2835", chip_match_name);
 964         if (!chip)
 965                 return 0;
 966
 967         /*
 968          * Retrieve the corresponding GPIO line used for CS.
 969          * The inversion semantics will be handled by the GPIO core
 970          * code, so we pass GPIOS_OUT_LOW for "unasserted" and
 971          * the correct flag for inversion semantics. The SPI_CS_HIGH
 972          * on spi->mode cannot be checked for polarity in this case
 973          * as the flag use_gpio_descriptors enforces SPI_CS_HIGH.
 974          */
 975         if (of_property_read_bool(spi->dev.of_node, "spi-cs-high"))
 976                 lflags = GPIO_ACTIVE_HIGH;
 977         else
 978                 lflags = GPIO_ACTIVE_LOW;
 979         spi->cs_gpiod = gpiochip_request_own_desc(chip, 8 - spi->chip_select,
 980                                                   DRV_NAME,
 981                                                   lflags,
 982                                                   GPIOD_OUT_LOW);
 983         if (IS_ERR(spi->cs_gpiod))
 984                 return PTR_ERR(spi->cs_gpiod);
 985
 986         /* and set up the "mode" and level */
 987         dev_info(&spi->dev, "setting up native-CS%i to use GPIO\n",
 988                  spi->chip_select);
 989
 990         return 0;
 991 }
 992
 993 static int bcm2835_spi_probe(struct platform_device *pdev)
 994 {
 995         struct spi_controller *ctlr;
 996         struct bcm2835_spi *bs;
 997         int err;
 998
 999         ctlr = spi_alloc_master(&pdev->dev, sizeof(*bs));
1000         if (!ctlr)
1001                 return -ENOMEM;
1002
1003         platform_set_drvdata(pdev, ctlr);
1004
1005         ctlr->use_gpio_descriptors = true;
1006         ctlr->mode_bits = BCM2835_SPI_MODE_BITS;
1007         ctlr->bits_per_word_mask = SPI_BPW_MASK(8);
1008         ctlr->num_chipselect = 3;
1009         ctlr->setup = bcm2835_spi_setup;
1010         ctlr->transfer_one = bcm2835_spi_transfer_one;
1011         ctlr->handle_err = bcm2835_spi_handle_err;
1012         ctlr->prepare_message = bcm2835_spi_prepare_message;
1013         ctlr->dev.of_node = pdev->dev.of_node;
1014
1015         bs = spi_controller_get_devdata(ctlr);
1016
1017         bs->regs = devm_platform_ioremap_resource(pdev, 0);
1018         if (IS_ERR(bs->regs)) {
1019                 err = PTR_ERR(bs->regs);
1020                 goto out_controller_put;
1021         }
1022
1023         bs->clk = devm_clk_get(&pdev->dev, NULL);
1024         if (IS_ERR(bs->clk)) {
1025                 err = PTR_ERR(bs->clk);
1026                 dev_err(&pdev->dev, "could not get clk: %d\n", err);
1027                 goto out_controller_put;
1028         }
1029
1030         bs->irq = platform_get_irq(pdev, 0);
1031         if (bs->irq <= 0) {
1032                 err = bs->irq ? bs->irq : -ENODEV;
1033                 goto out_controller_put;
1034         }
1035
1036         clk_prepare_enable(bs->clk);
1037
1038         bcm2835_dma_init(ctlr, &pdev->dev);
1039
1040         /* initialise the hardware with the default polarities */
1041         bcm2835_wr(bs, BCM2835_SPI_CS,
1042                    BCM2835_SPI_CS_CLEAR_RX | BCM2835_SPI_CS_CLEAR_TX);
1043
1044         err = devm_request_irq(&pdev->dev, bs->irq, bcm2835_spi_interrupt, 0,
1045                                dev_name(&pdev->dev), ctlr);
1046         if (err) {
1047                 dev_err(&pdev->dev, "could not request IRQ: %d\n", err);
1048                 goto out_clk_disable;
1049         }
1050
1051         err = devm_spi_register_controller(&pdev->dev, ctlr);
1052         if (err) {
1053                 dev_err(&pdev->dev, "could not register SPI controller: %d\n",
1054                         err);
1055                 goto out_clk_disable;
1056         }
1057
1058         bcm2835_debugfs_create(bs, dev_name(&pdev->dev));
1059
1060         return 0;
1061
1062 out_clk_disable:
1063         clk_disable_unprepare(bs->clk);
1064 out_controller_put:
1065         spi_controller_put(ctlr);
1066         return err;
1067 }
1068
1069 static int bcm2835_spi_remove(struct platform_device *pdev)
1070 {
1071         struct spi_controller *ctlr = platform_get_drvdata(pdev);
1072         struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr);
1073
1074         bcm2835_debugfs_remove(bs);
1075
1076         /* Clear FIFOs, and disable the HW block */
1077         bcm2835_wr(bs, BCM2835_SPI_CS,
1078                    BCM2835_SPI_CS_CLEAR_RX | BCM2835_SPI_CS_CLEAR_TX);
1079
1080         clk_disable_unprepare(bs->clk);
1081
1082         bcm2835_dma_release(ctlr);
1083
1084         return 0;
1085 }
1086
1087 static const struct of_device_id bcm2835_spi_match[] = {
1088         { .compatible = "brcm,bcm2835-spi", },
1089         {}
1090 };
1091 MODULE_DEVICE_TABLE(of, bcm2835_spi_match);
1092
1093 static struct platform_driver bcm2835_spi_driver = {
1094         .driver         = {
1095                 .name           = DRV_NAME,
1096                 .of_match_table = bcm2835_spi_match,
1097         },
1098         .probe          = bcm2835_spi_probe,
1099         .remove         = bcm2835_spi_remove,
1100 };
1101 module_platform_driver(bcm2835_spi_driver);
1102
1103 MODULE_DESCRIPTION("SPI controller driver for Broadcom BCM2835");
1104 MODULE_AUTHOR("Chris Boot <bootc@bootc.net>");
1105 MODULE_LICENSE("GPL");