drivers/spi/spi-bitbang.c

   1 /*
   2  * polling/bitbanging SPI master controller driver utilities
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 #include <linux/spinlock.h>
  16 #include <linux/workqueue.h>
  17 #include <linux/interrupt.h>
  18 #include <linux/module.h>
  19 #include <linux/delay.h>
  20 #include <linux/errno.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/slab.h>
  23
  24 #include <linux/spi/spi.h>
  25 #include <linux/spi/spi_bitbang.h>
  26
  27
  28 /*----------------------------------------------------------------------*/
  29
  30 /*
  31  * FIRST PART (OPTIONAL):  word-at-a-time spi_transfer support.
  32  * Use this for GPIO or shift-register level hardware APIs.
  33  *
  34  * spi_bitbang_cs is in spi_device->controller_state, which is unavailable
  35  * to glue code.  These bitbang setup() and cleanup() routines are always
  36  * used, though maybe they're called from controller-aware code.
  37  *
  38  * chipselect() and friends may use spi_device->controller_data and
  39  * controller registers as appropriate.
  40  *
  41  *
  42  * NOTE:  SPI controller pins can often be used as GPIO pins instead,
  43  * which means you could use a bitbang driver either to get hardware
  44  * working quickly, or testing for differences that aren't speed related.
  45  */
  46
  47 struct spi_bitbang_cs {
  48         unsigned        nsecs;  /* (clock cycle time)/2 */
  49         u32             (*txrx_word)(struct spi_device *spi, unsigned nsecs,
  50                                         u32 word, u8 bits);
  51         unsigned        (*txrx_bufs)(struct spi_device *,
  52                                         u32 (*txrx_word)(
  53                                                 struct spi_device *spi,
  54                                                 unsigned nsecs,
  55                                                 u32 word, u8 bits),
  56                                         unsigned, struct spi_transfer *);
  57 };
  58
  59 static unsigned bitbang_txrx_8(
  60         struct spi_device       *spi,
  61         u32                     (*txrx_word)(struct spi_device *spi,
  62                                         unsigned nsecs,
  63                                         u32 word, u8 bits),
  64         unsigned                ns,
  65         struct spi_transfer     *t
  66 ) {
  67         unsigned                bits = t->bits_per_word;
  68         unsigned                count = t->len;
  69         const u8                *tx = t->tx_buf;
  70         u8                      *rx = t->rx_buf;
  71
  72         while (likely(count > 0)) {
  73                 u8              word = 0;
  74
  75                 if (tx)
  76                         word = *tx++;
  77                 word = txrx_word(spi, ns, word, bits);
  78                 if (rx)
  79                         *rx++ = word;
  80                 count -= 1;
  81         }
  82         return t->len - count;
  83 }
  84
  85 static unsigned bitbang_txrx_16(
  86         struct spi_device       *spi,
  87         u32                     (*txrx_word)(struct spi_device *spi,
  88                                         unsigned nsecs,
  89                                         u32 word, u8 bits),
  90         unsigned                ns,
  91         struct spi_transfer     *t
  92 ) {
  93         unsigned                bits = t->bits_per_word;
  94         unsigned                count = t->len;
  95         const u16               *tx = t->tx_buf;
  96         u16                     *rx = t->rx_buf;
  97
  98         while (likely(count > 1)) {
  99                 u16             word = 0;
 100
 101                 if (tx)
 102                         word = *tx++;
 103                 word = txrx_word(spi, ns, word, bits);
 104                 if (rx)
 105                         *rx++ = word;
 106                 count -= 2;
 107         }
 108         return t->len - count;
 109 }
 110
 111 static unsigned bitbang_txrx_32(
 112         struct spi_device       *spi,
 113         u32                     (*txrx_word)(struct spi_device *spi,
 114                                         unsigned nsecs,
 115                                         u32 word, u8 bits),
 116         unsigned                ns,
 117         struct spi_transfer     *t
 118 ) {
 119         unsigned                bits = t->bits_per_word;
 120         unsigned                count = t->len;
 121         const u32               *tx = t->tx_buf;
 122         u32                     *rx = t->rx_buf;
 123
 124         while (likely(count > 3)) {
 125                 u32             word = 0;
 126
 127                 if (tx)
 128                         word = *tx++;
 129                 word = txrx_word(spi, ns, word, bits);
 130                 if (rx)
 131                         *rx++ = word;
 132                 count -= 4;
 133         }
 134         return t->len - count;
 135 }
 136
 137 int spi_bitbang_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
 138 {
 139         struct spi_bitbang_cs   *cs = spi->controller_state;
 140         u8                      bits_per_word;
 141         u32                     hz;
 142
 143         if (t) {
 144                 bits_per_word = t->bits_per_word;
 145                 hz = t->speed_hz;
 146         } else {
 147                 bits_per_word = 0;
 148                 hz = 0;
 149         }
 150
 151         /* spi_transfer level calls that work per-word */
 152         if (!bits_per_word)
 153                 bits_per_word = spi->bits_per_word;
 154         if (bits_per_word <= 8)
 155                 cs->txrx_bufs = bitbang_txrx_8;
 156         else if (bits_per_word <= 16)
 157                 cs->txrx_bufs = bitbang_txrx_16;
 158         else if (bits_per_word <= 32)
 159                 cs->txrx_bufs = bitbang_txrx_32;
 160         else
 161                 return -EINVAL;
 162
 163         /* nsecs = (clock period)/2 */
 164         if (!hz)
 165                 hz = spi->max_speed_hz;
 166         if (hz) {
 167                 cs->nsecs = (1000000000/2) / hz;
 168                 if (cs->nsecs > (MAX_UDELAY_MS * 1000 * 1000))
 169                         return -EINVAL;
 170         }
 171
 172         return 0;
 173 }
 174 EXPORT_SYMBOL_GPL(spi_bitbang_setup_transfer);
 175
 176 /**
 177  * spi_bitbang_setup - default setup for per-word I/O loops
 178  */
 179 int spi_bitbang_setup(struct spi_device *spi)
 180 {
 181         struct spi_bitbang_cs   *cs = spi->controller_state;
 182         struct spi_bitbang      *bitbang;
 183
 184         bitbang = spi_master_get_devdata(spi->master);
 185
 186         if (!cs) {
 187                 cs = kzalloc(sizeof(*cs), GFP_KERNEL);
 188                 if (!cs)
 189                         return -ENOMEM;
 190                 spi->controller_state = cs;
 191         }
 192
 193         /* per-word shift register access, in hardware or bitbanging */
 194         cs->txrx_word = bitbang->txrx_word[spi->mode & (SPI_CPOL|SPI_CPHA)];
 195         if (!cs->txrx_word)
 196                 return -EINVAL;
 197
 198         if (bitbang->setup_transfer) {
 199                 int retval = bitbang->setup_transfer(spi, NULL);
 200                 if (retval < 0)
 201                         return retval;
 202         }
 203
 204         dev_dbg(&spi->dev, "%s, %u nsec/bit\n", __func__, 2 * cs->nsecs);
 205
 206         /* NOTE we _need_ to call chipselect() early, ideally with adapter
 207          * setup, unless the hardware defaults cooperate to avoid confusion
 208          * between normal (active low) and inverted chipselects.
 209          */
 210
 211         /* deselect chip (low or high) */
 212         mutex_lock(&bitbang->lock);
 213         if (!bitbang->busy) {
 214                 bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
 215                 ndelay(cs->nsecs);
 216         }
 217         mutex_unlock(&bitbang->lock);
 218
 219         return 0;
 220 }
 221 EXPORT_SYMBOL_GPL(spi_bitbang_setup);
 222
 223 /**
 224  * spi_bitbang_cleanup - default cleanup for per-word I/O loops
 225  */
 226 void spi_bitbang_cleanup(struct spi_device *spi)
 227 {
 228         kfree(spi->controller_state);
 229 }
 230 EXPORT_SYMBOL_GPL(spi_bitbang_cleanup);
 231
 232 static int spi_bitbang_bufs(struct spi_device *spi, struct spi_transfer *t)
 233 {
 234         struct spi_bitbang_cs   *cs = spi->controller_state;
 235         unsigned                nsecs = cs->nsecs;
 236
 237         return cs->txrx_bufs(spi, cs->txrx_word, nsecs, t);
 238 }
 239
 240 /*----------------------------------------------------------------------*/
 241
 242 /*
 243  * SECOND PART ... simple transfer queue runner.
 244  *
 245  * This costs a task context per controller, running the queue by
 246  * performing each transfer in sequence.  Smarter hardware can queue
 247  * several DMA transfers at once, and process several controller queues
 248  * in parallel; this driver doesn't match such hardware very well.
 249  *
 250  * Drivers can provide word-at-a-time i/o primitives, or provide
 251  * transfer-at-a-time ones to leverage dma or fifo hardware.
 252  */
 253
 254 static int spi_bitbang_prepare_hardware(struct spi_master *spi)
 255 {
 256         struct spi_bitbang      *bitbang;
 257
 258         bitbang = spi_master_get_devdata(spi);
 259
 260         mutex_lock(&bitbang->lock);
 261         bitbang->busy = 1;
 262         mutex_unlock(&bitbang->lock);
 263
 264         return 0;
 265 }
 266
 267 static int spi_bitbang_transfer_one(struct spi_master *master,
 268                                     struct spi_message *m)
 269 {
 270         struct spi_bitbang      *bitbang;
 271         unsigned                nsecs;
 272         struct spi_transfer     *t = NULL;
 273         unsigned                cs_change;
 274         int                     status;
 275         struct spi_device       *spi = m->spi;
 276
 277         bitbang = spi_master_get_devdata(master);
 278
 279         /* FIXME this is made-up ... the correct value is known to
 280          * word-at-a-time bitbang code, and presumably chipselect()
 281          * should enforce these requirements too?
 282          */
 283         nsecs = 100;
 284
 285         cs_change = 1;
 286         status = 0;
 287
 288         list_for_each_entry(t, &m->transfers, transfer_list) {
 289
 290                 if (bitbang->setup_transfer) {
 291                         status = bitbang->setup_transfer(spi, t);
 292                         if (status < 0)
 293                                 break;
 294                 }
 295
 296                 /* set up default clock polarity, and activate chip;
 297                  * this implicitly updates clock and spi modes as
 298                  * previously recorded for this device via setup().
 299                  * (and also deselects any other chip that might be
 300                  * selected ...)
 301                  */
 302                 if (cs_change) {
 303                         bitbang->chipselect(spi, BITBANG_CS_ACTIVE);
 304                         ndelay(nsecs);
 305                 }
 306                 cs_change = t->cs_change;
 307                 if (!t->tx_buf && !t->rx_buf && t->len) {
 308                         status = -EINVAL;
 309                         break;
 310                 }
 311
 312                 /* transfer data.  the lower level code handles any
 313                  * new dma mappings it needs. our caller always gave
 314                  * us dma-safe buffers.
 315                  */
 316                 if (t->len) {
 317                         /* REVISIT dma API still needs a designated
 318                          * DMA_ADDR_INVALID; ~0 might be better.
 319                          */
 320                         if (!m->is_dma_mapped)
 321                                 t->rx_dma = t->tx_dma = 0;
 322                         status = bitbang->txrx_bufs(spi, t);
 323                 }
 324                 if (status > 0)
 325                         m->actual_length += status;
 326                 if (status != t->len) {
 327                         /* always report some kind of error */
 328                         if (status >= 0)
 329                                 status = -EREMOTEIO;
 330                         break;
 331                 }
 332                 status = 0;
 333
 334                 /* protocol tweaks before next transfer */
 335                 if (t->delay_usecs)
 336                         udelay(t->delay_usecs);
 337
 338                 if (cs_change &&
 339                     !list_is_last(&t->transfer_list, &m->transfers)) {
 340                         /* sometimes a short mid-message deselect of the chip
 341                          * may be needed to terminate a mode or command
 342                          */
 343                         ndelay(nsecs);
 344                         bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
 345                         ndelay(nsecs);
 346                 }
 347         }
 348
 349         m->status = status;
 350
 351         /* normally deactivate chipselect ... unless no error and
 352          * cs_change has hinted that the next message will probably
 353          * be for this chip too.
 354          */
 355         if (!(status == 0 && cs_change)) {
 356                 ndelay(nsecs);
 357                 bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
 358                 ndelay(nsecs);
 359         }
 360
 361         spi_finalize_current_message(master);
 362
 363         return status;
 364 }
 365
 366 static int spi_bitbang_unprepare_hardware(struct spi_master *spi)
 367 {
 368         struct spi_bitbang      *bitbang;
 369
 370         bitbang = spi_master_get_devdata(spi);
 371
 372         mutex_lock(&bitbang->lock);
 373         bitbang->busy = 0;
 374         mutex_unlock(&bitbang->lock);
 375
 376         return 0;
 377 }
 378
 379 /*----------------------------------------------------------------------*/
 380
 381 /**
 382  * spi_bitbang_start - start up a polled/bitbanging SPI master driver
 383  * @bitbang: driver handle
 384  *
 385  * Caller should have zero-initialized all parts of the structure, and then
 386  * provided callbacks for chip selection and I/O loops.  If the master has
 387  * a transfer method, its final step should call spi_bitbang_transfer; or,
 388  * that's the default if the transfer routine is not initialized.  It should
 389  * also set up the bus number and number of chipselects.
 390  *
 391  * For i/o loops, provide callbacks either per-word (for bitbanging, or for
 392  * hardware that basically exposes a shift register) or per-spi_transfer
 393  * (which takes better advantage of hardware like fifos or DMA engines).
 394  *
 395  * Drivers using per-word I/O loops should use (or call) spi_bitbang_setup,
 396  * spi_bitbang_cleanup and spi_bitbang_setup_transfer to handle those spi
 397  * master methods.  Those methods are the defaults if the bitbang->txrx_bufs
 398  * routine isn't initialized.
 399  *
 400  * This routine registers the spi_master, which will process requests in a
 401  * dedicated task, keeping IRQs unblocked most of the time.  To stop
 402  * processing those requests, call spi_bitbang_stop().
 403  *
 404  * On success, this routine will take a reference to master. The caller is
 405  * responsible for calling spi_bitbang_stop() to decrement the reference and
 406  * spi_master_put() as counterpart of spi_alloc_master() to prevent a memory
 407  * leak.
 408  */
 409 int spi_bitbang_start(struct spi_bitbang *bitbang)
 410 {
 411         struct spi_master *master = bitbang->master;
 412         int ret;
 413
 414         if (!master || !bitbang->chipselect)
 415                 return -EINVAL;
 416
 417         mutex_init(&bitbang->lock);
 418
 419         if (!master->mode_bits)
 420                 master->mode_bits = SPI_CPOL | SPI_CPHA | bitbang->flags;
 421
 422         if (master->transfer || master->transfer_one_message)
 423                 return -EINVAL;
 424
 425         master->prepare_transfer_hardware = spi_bitbang_prepare_hardware;
 426         master->unprepare_transfer_hardware = spi_bitbang_unprepare_hardware;
 427         master->transfer_one_message = spi_bitbang_transfer_one;
 428
 429         if (!bitbang->txrx_bufs) {
 430                 bitbang->use_dma = 0;
 431                 bitbang->txrx_bufs = spi_bitbang_bufs;
 432                 if (!master->setup) {
 433                         if (!bitbang->setup_transfer)
 434                                 bitbang->setup_transfer =
 435                                          spi_bitbang_setup_transfer;
 436                         master->setup = spi_bitbang_setup;
 437                         master->cleanup = spi_bitbang_cleanup;
 438                 }
 439         }
 440
 441         /* driver may get busy before register() returns, especially
 442          * if someone registered boardinfo for devices
 443          */
 444         ret = spi_register_master(spi_master_get(master));
 445         if (ret)
 446                 spi_master_put(master);
 447
 448         return 0;
 449 }
 450 EXPORT_SYMBOL_GPL(spi_bitbang_start);
 451
 452 /**
 453  * spi_bitbang_stop - stops the task providing spi communication
 454  */
 455 void spi_bitbang_stop(struct spi_bitbang *bitbang)
 456 {
 457         spi_unregister_master(bitbang->master);
 458 }
 459 EXPORT_SYMBOL_GPL(spi_bitbang_stop);
 460
 461 MODULE_LICENSE("GPL");
 462