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