drivers/spi/spi_mpc83xx.c

   1 /*
   2  * MPC83xx SPI controller driver.
   3  *
   4  * Maintainer: Kumar Gala
   5  *
   6  * Copyright (C) 2006 Polycom, Inc.
   7  *
   8  * This program is free software; you can redistribute  it and/or modify it
   9  * under  the terms of  the GNU General  Public License as published by the
  10  * Free Software Foundation;  either version 2 of the  License, or (at your
  11  * option) any later version.
  12  */
  13 #include <linux/module.h>
  14 #include <linux/init.h>
  15 #include <linux/types.h>
  16 #include <linux/kernel.h>
  17 #include <linux/completion.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/delay.h>
  20 #include <linux/irq.h>
  21 #include <linux/device.h>
  22 #include <linux/spi/spi.h>
  23 #include <linux/spi/spi_bitbang.h>
  24 #include <linux/platform_device.h>
  25 #include <linux/fsl_devices.h>
  26
  27 #include <asm/irq.h>
  28 #include <asm/io.h>
  29
  30 /* SPI Controller registers */
  31 struct mpc83xx_spi_reg {
  32         u8 res1[0x20];
  33         __be32 mode;
  34         __be32 event;
  35         __be32 mask;
  36         __be32 command;
  37         __be32 transmit;
  38         __be32 receive;
  39 };
  40
  41 /* SPI Controller mode register definitions */
  42 #define SPMODE_CI_INACTIVEHIGH  (1 << 29)
  43 #define SPMODE_CP_BEGIN_EDGECLK (1 << 28)
  44 #define SPMODE_DIV16            (1 << 27)
  45 #define SPMODE_REV              (1 << 26)
  46 #define SPMODE_MS               (1 << 25)
  47 #define SPMODE_ENABLE           (1 << 24)
  48 #define SPMODE_LEN(x)           ((x) << 20)
  49 #define SPMODE_PM(x)            ((x) << 16)
  50 #define SPMODE_OP               (1 << 14)
  51
  52 /*
  53  * Default for SPI Mode:
  54  *      SPI MODE 0 (inactive low, phase middle, MSB, 8-bit length, slow clk
  55  */
  56 #define SPMODE_INIT_VAL (SPMODE_CI_INACTIVEHIGH | SPMODE_DIV16 | SPMODE_REV | \
  57                          SPMODE_MS | SPMODE_LEN(7) | SPMODE_PM(0xf))
  58
  59 /* SPIE register values */
  60 #define SPIE_NE         0x00000200      /* Not empty */
  61 #define SPIE_NF         0x00000100      /* Not full */
  62
  63 /* SPIM register values */
  64 #define SPIM_NE         0x00000200      /* Not empty */
  65 #define SPIM_NF         0x00000100      /* Not full */
  66
  67 /* SPI Controller driver's private data. */
  68 struct mpc83xx_spi {
  69         /* bitbang has to be first */
  70         struct spi_bitbang bitbang;
  71         struct completion done;
  72
  73         struct mpc83xx_spi_reg __iomem *base;
  74
  75         /* rx & tx bufs from the spi_transfer */
  76         const void *tx;
  77         void *rx;
  78
  79         /* functions to deal with different sized buffers */
  80         void (*get_rx) (u32 rx_data, struct mpc83xx_spi *);
  81         u32(*get_tx) (struct mpc83xx_spi *);
  82
  83         unsigned int count;
  84         u32 irq;
  85
  86         unsigned nsecs;         /* (clock cycle time)/2 */
  87
  88         u32 sysclk;
  89         u32 rx_shift;           /* RX data reg shift when in qe mode */
  90         u32 tx_shift;           /* TX data reg shift when in qe mode */
  91
  92         bool qe_mode;
  93
  94         void (*activate_cs) (u8 cs, u8 polarity);
  95         void (*deactivate_cs) (u8 cs, u8 polarity);
  96 };
  97
  98 static inline void mpc83xx_spi_write_reg(__be32 __iomem * reg, u32 val)
  99 {
 100         out_be32(reg, val);
 101 }
 102
 103 static inline u32 mpc83xx_spi_read_reg(__be32 __iomem * reg)
 104 {
 105         return in_be32(reg);
 106 }
 107
 108 #define MPC83XX_SPI_RX_BUF(type)                                          \
 109 void mpc83xx_spi_rx_buf_##type(u32 data, struct mpc83xx_spi *mpc83xx_spi) \
 110 {                                                                         \
 111         type * rx = mpc83xx_spi->rx;                                      \
 112         *rx++ = (type)(data >> mpc83xx_spi->rx_shift);                    \
 113         mpc83xx_spi->rx = rx;                                             \
 114 }
 115
 116 #define MPC83XX_SPI_TX_BUF(type)                                \
 117 u32 mpc83xx_spi_tx_buf_##type(struct mpc83xx_spi *mpc83xx_spi)  \
 118 {                                                               \
 119         u32 data;                                               \
 120         const type * tx = mpc83xx_spi->tx;                      \
 121         if (!tx)                                                \
 122                 return 0;                                       \
 123         data = *tx++ << mpc83xx_spi->tx_shift;                  \
 124         mpc83xx_spi->tx = tx;                                   \
 125         return data;                                            \
 126 }
 127
 128 MPC83XX_SPI_RX_BUF(u8)
 129 MPC83XX_SPI_RX_BUF(u16)
 130 MPC83XX_SPI_RX_BUF(u32)
 131 MPC83XX_SPI_TX_BUF(u8)
 132 MPC83XX_SPI_TX_BUF(u16)
 133 MPC83XX_SPI_TX_BUF(u32)
 134
 135 static void mpc83xx_spi_chipselect(struct spi_device *spi, int value)
 136 {
 137         struct mpc83xx_spi *mpc83xx_spi;
 138         u8 pol = spi->mode & SPI_CS_HIGH ? 1 : 0;
 139
 140         mpc83xx_spi = spi_master_get_devdata(spi->master);
 141
 142         if (value == BITBANG_CS_INACTIVE) {
 143                 if (mpc83xx_spi->deactivate_cs)
 144                         mpc83xx_spi->deactivate_cs(spi->chip_select, pol);
 145         }
 146
 147         if (value == BITBANG_CS_ACTIVE) {
 148                 u32 regval = mpc83xx_spi_read_reg(&mpc83xx_spi->base->mode);
 149                 u32 len = spi->bits_per_word;
 150                 if (len == 32)
 151                         len = 0;
 152                 else
 153                         len = len - 1;
 154
 155                 /* mask out bits we are going to set */
 156                 regval &= ~(SPMODE_CP_BEGIN_EDGECLK | SPMODE_CI_INACTIVEHIGH |
 157                             SPMODE_LEN(0xF) | SPMODE_DIV16 | SPMODE_PM(0xF));
 158
 159                 if (spi->mode & SPI_CPHA)
 160                         regval |= SPMODE_CP_BEGIN_EDGECLK;
 161                 if (spi->mode & SPI_CPOL)
 162                         regval |= SPMODE_CI_INACTIVEHIGH;
 163
 164                 regval |= SPMODE_LEN(len);
 165
 166                 if ((mpc83xx_spi->sysclk / spi->max_speed_hz) >= 64) {
 167                         u8 pm = mpc83xx_spi->sysclk / (spi->max_speed_hz * 64);
 168                         if (pm > 0x0f) {
 169                                 printk(KERN_WARNING "MPC83xx SPI: SPICLK can't be less then a SYSCLK/1024!\n"
 170                                                 "Requested SPICLK is %d Hz. Will use %d Hz instead.\n",
 171                                                 spi->max_speed_hz, mpc83xx_spi->sysclk / 1024);
 172                                 pm = 0x0f;
 173                         }
 174                         regval |= SPMODE_PM(pm) | SPMODE_DIV16;
 175                 } else {
 176                         u8 pm = mpc83xx_spi->sysclk / (spi->max_speed_hz * 4);
 177                         regval |= SPMODE_PM(pm);
 178                 }
 179
 180                 /* Turn off SPI unit prior changing mode */
 181                 mpc83xx_spi_write_reg(&mpc83xx_spi->base->mode, 0);
 182                 mpc83xx_spi_write_reg(&mpc83xx_spi->base->mode, regval);
 183                 if (mpc83xx_spi->activate_cs)
 184                         mpc83xx_spi->activate_cs(spi->chip_select, pol);
 185         }
 186 }
 187
 188 static
 189 int mpc83xx_spi_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
 190 {
 191         struct mpc83xx_spi *mpc83xx_spi;
 192         u32 regval;
 193         u8 bits_per_word;
 194         u32 hz;
 195
 196         mpc83xx_spi = spi_master_get_devdata(spi->master);
 197
 198         if (t) {
 199                 bits_per_word = t->bits_per_word;
 200                 hz = t->speed_hz;
 201         } else {
 202                 bits_per_word = 0;
 203                 hz = 0;
 204         }
 205
 206         /* spi_transfer level calls that work per-word */
 207         if (!bits_per_word)
 208                 bits_per_word = spi->bits_per_word;
 209
 210         /* Make sure its a bit width we support [4..16, 32] */
 211         if ((bits_per_word < 4)
 212             || ((bits_per_word > 16) && (bits_per_word != 32)))
 213                 return -EINVAL;
 214
 215         mpc83xx_spi->rx_shift = 0;
 216         mpc83xx_spi->tx_shift = 0;
 217         if (bits_per_word <= 8) {
 218                 mpc83xx_spi->get_rx = mpc83xx_spi_rx_buf_u8;
 219                 mpc83xx_spi->get_tx = mpc83xx_spi_tx_buf_u8;
 220                 if (mpc83xx_spi->qe_mode) {
 221                         mpc83xx_spi->rx_shift = 16;
 222                         mpc83xx_spi->tx_shift = 24;
 223                 }
 224         } else if (bits_per_word <= 16) {
 225                 mpc83xx_spi->get_rx = mpc83xx_spi_rx_buf_u16;
 226                 mpc83xx_spi->get_tx = mpc83xx_spi_tx_buf_u16;
 227                 if (mpc83xx_spi->qe_mode) {
 228                         mpc83xx_spi->rx_shift = 16;
 229                         mpc83xx_spi->tx_shift = 16;
 230                 }
 231         } else if (bits_per_word <= 32) {
 232                 mpc83xx_spi->get_rx = mpc83xx_spi_rx_buf_u32;
 233                 mpc83xx_spi->get_tx = mpc83xx_spi_tx_buf_u32;
 234         } else
 235                 return -EINVAL;
 236
 237         /* nsecs = (clock period)/2 */
 238         if (!hz)
 239                 hz = spi->max_speed_hz;
 240         mpc83xx_spi->nsecs = (1000000000 / 2) / hz;
 241         if (mpc83xx_spi->nsecs > MAX_UDELAY_MS * 1000)
 242                 return -EINVAL;
 243
 244         if (bits_per_word == 32)
 245                 bits_per_word = 0;
 246         else
 247                 bits_per_word = bits_per_word - 1;
 248
 249         regval = mpc83xx_spi_read_reg(&mpc83xx_spi->base->mode);
 250
 251         /* Mask out bits_per_wordgth */
 252         regval &= ~SPMODE_LEN(0xF);
 253         regval |= SPMODE_LEN(bits_per_word);
 254
 255         /* Turn off SPI unit prior changing mode */
 256         mpc83xx_spi_write_reg(&mpc83xx_spi->base->mode, 0);
 257         mpc83xx_spi_write_reg(&mpc83xx_spi->base->mode, regval);
 258
 259         return 0;
 260 }
 261
 262 /* the spi->mode bits understood by this driver: */
 263 #define MODEBITS (SPI_CPOL | SPI_CPHA | SPI_CS_HIGH)
 264
 265 static int mpc83xx_spi_setup(struct spi_device *spi)
 266 {
 267         struct spi_bitbang *bitbang;
 268         struct mpc83xx_spi *mpc83xx_spi;
 269         int retval;
 270
 271         if (spi->mode & ~MODEBITS) {
 272                 dev_dbg(&spi->dev, "setup: unsupported mode bits %x\n",
 273                         spi->mode & ~MODEBITS);
 274                 return -EINVAL;
 275         }
 276
 277         if (!spi->max_speed_hz)
 278                 return -EINVAL;
 279
 280         bitbang = spi_master_get_devdata(spi->master);
 281         mpc83xx_spi = spi_master_get_devdata(spi->master);
 282
 283         if (!spi->bits_per_word)
 284                 spi->bits_per_word = 8;
 285
 286         retval = mpc83xx_spi_setup_transfer(spi, NULL);
 287         if (retval < 0)
 288                 return retval;
 289
 290         dev_dbg(&spi->dev, "%s, mode %d, %u bits/w, %u nsec\n",
 291                 __FUNCTION__, spi->mode & (SPI_CPOL | SPI_CPHA),
 292                 spi->bits_per_word, 2 * mpc83xx_spi->nsecs);
 293
 294         /* NOTE we _need_ to call chipselect() early, ideally with adapter
 295          * setup, unless the hardware defaults cooperate to avoid confusion
 296          * between normal (active low) and inverted chipselects.
 297          */
 298
 299         /* deselect chip (low or high) */
 300         spin_lock(&bitbang->lock);
 301         if (!bitbang->busy) {
 302                 bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
 303                 ndelay(mpc83xx_spi->nsecs);
 304         }
 305         spin_unlock(&bitbang->lock);
 306
 307         return 0;
 308 }
 309
 310 static int mpc83xx_spi_bufs(struct spi_device *spi, struct spi_transfer *t)
 311 {
 312         struct mpc83xx_spi *mpc83xx_spi;
 313         u32 word;
 314
 315         mpc83xx_spi = spi_master_get_devdata(spi->master);
 316
 317         mpc83xx_spi->tx = t->tx_buf;
 318         mpc83xx_spi->rx = t->rx_buf;
 319         mpc83xx_spi->count = t->len;
 320         INIT_COMPLETION(mpc83xx_spi->done);
 321
 322         /* enable rx ints */
 323         mpc83xx_spi_write_reg(&mpc83xx_spi->base->mask, SPIM_NE);
 324
 325         /* transmit word */
 326         word = mpc83xx_spi->get_tx(mpc83xx_spi);
 327         mpc83xx_spi_write_reg(&mpc83xx_spi->base->transmit, word);
 328
 329         wait_for_completion(&mpc83xx_spi->done);
 330
 331         /* disable rx ints */
 332         mpc83xx_spi_write_reg(&mpc83xx_spi->base->mask, 0);
 333
 334         return t->len - mpc83xx_spi->count;
 335 }
 336
 337 irqreturn_t mpc83xx_spi_irq(s32 irq, void *context_data)
 338 {
 339         struct mpc83xx_spi *mpc83xx_spi = context_data;
 340         u32 event;
 341         irqreturn_t ret = IRQ_NONE;
 342
 343         /* Get interrupt events(tx/rx) */
 344         event = mpc83xx_spi_read_reg(&mpc83xx_spi->base->event);
 345
 346         /* We need handle RX first */
 347         if (event & SPIE_NE) {
 348                 u32 rx_data = mpc83xx_spi_read_reg(&mpc83xx_spi->base->receive);
 349
 350                 if (mpc83xx_spi->rx)
 351                         mpc83xx_spi->get_rx(rx_data, mpc83xx_spi);
 352
 353                 ret = IRQ_HANDLED;
 354         }
 355
 356         if ((event & SPIE_NF) == 0)
 357                 /* spin until TX is done */
 358                 while (((event =
 359                          mpc83xx_spi_read_reg(&mpc83xx_spi->base->event)) &
 360                                                 SPIE_NF) == 0)
 361                          cpu_relax();
 362
 363         mpc83xx_spi->count -= 1;
 364         if (mpc83xx_spi->count) {
 365                 if (mpc83xx_spi->tx) {
 366                         u32 word = mpc83xx_spi->get_tx(mpc83xx_spi);
 367                         mpc83xx_spi_write_reg(&mpc83xx_spi->base->transmit,
 368                                               word);
 369                 }
 370         } else {
 371                 complete(&mpc83xx_spi->done);
 372         }
 373
 374         /* Clear the events */
 375         mpc83xx_spi_write_reg(&mpc83xx_spi->base->event, event);
 376
 377         return ret;
 378 }
 379
 380 static int __init mpc83xx_spi_probe(struct platform_device *dev)
 381 {
 382         struct spi_master *master;
 383         struct mpc83xx_spi *mpc83xx_spi;
 384         struct fsl_spi_platform_data *pdata;
 385         struct resource *r;
 386         u32 regval;
 387         int ret = 0;
 388
 389         /* Get resources(memory, IRQ) associated with the device */
 390         master = spi_alloc_master(&dev->dev, sizeof(struct mpc83xx_spi));
 391
 392         if (master == NULL) {
 393                 ret = -ENOMEM;
 394                 goto err;
 395         }
 396
 397         platform_set_drvdata(dev, master);
 398         pdata = dev->dev.platform_data;
 399
 400         if (pdata == NULL) {
 401                 ret = -ENODEV;
 402                 goto free_master;
 403         }
 404
 405         r = platform_get_resource(dev, IORESOURCE_MEM, 0);
 406         if (r == NULL) {
 407                 ret = -ENODEV;
 408                 goto free_master;
 409         }
 410         mpc83xx_spi = spi_master_get_devdata(master);
 411         mpc83xx_spi->bitbang.master = spi_master_get(master);
 412         mpc83xx_spi->bitbang.chipselect = mpc83xx_spi_chipselect;
 413         mpc83xx_spi->bitbang.setup_transfer = mpc83xx_spi_setup_transfer;
 414         mpc83xx_spi->bitbang.txrx_bufs = mpc83xx_spi_bufs;
 415         mpc83xx_spi->sysclk = pdata->sysclk;
 416         mpc83xx_spi->activate_cs = pdata->activate_cs;
 417         mpc83xx_spi->deactivate_cs = pdata->deactivate_cs;
 418         mpc83xx_spi->qe_mode = pdata->qe_mode;
 419         mpc83xx_spi->get_rx = mpc83xx_spi_rx_buf_u8;
 420         mpc83xx_spi->get_tx = mpc83xx_spi_tx_buf_u8;
 421
 422         mpc83xx_spi->rx_shift = 0;
 423         mpc83xx_spi->tx_shift = 0;
 424         if (mpc83xx_spi->qe_mode) {
 425                 mpc83xx_spi->rx_shift = 16;
 426                 mpc83xx_spi->tx_shift = 24;
 427         }
 428
 429         mpc83xx_spi->bitbang.master->setup = mpc83xx_spi_setup;
 430         init_completion(&mpc83xx_spi->done);
 431
 432         mpc83xx_spi->base = ioremap(r->start, r->end - r->start + 1);
 433         if (mpc83xx_spi->base == NULL) {
 434                 ret = -ENOMEM;
 435                 goto put_master;
 436         }
 437
 438         mpc83xx_spi->irq = platform_get_irq(dev, 0);
 439
 440         if (mpc83xx_spi->irq < 0) {
 441                 ret = -ENXIO;
 442                 goto unmap_io;
 443         }
 444
 445         /* Register for SPI Interrupt */
 446         ret = request_irq(mpc83xx_spi->irq, mpc83xx_spi_irq,
 447                           0, "mpc83xx_spi", mpc83xx_spi);
 448
 449         if (ret != 0)
 450                 goto unmap_io;
 451
 452         master->bus_num = pdata->bus_num;
 453         master->num_chipselect = pdata->max_chipselect;
 454
 455         /* SPI controller initializations */
 456         mpc83xx_spi_write_reg(&mpc83xx_spi->base->mode, 0);
 457         mpc83xx_spi_write_reg(&mpc83xx_spi->base->mask, 0);
 458         mpc83xx_spi_write_reg(&mpc83xx_spi->base->command, 0);
 459         mpc83xx_spi_write_reg(&mpc83xx_spi->base->event, 0xffffffff);
 460
 461         /* Enable SPI interface */
 462         regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
 463         if (pdata->qe_mode)
 464                 regval |= SPMODE_OP;
 465
 466         mpc83xx_spi_write_reg(&mpc83xx_spi->base->mode, regval);
 467
 468         ret = spi_bitbang_start(&mpc83xx_spi->bitbang);
 469
 470         if (ret != 0)
 471                 goto free_irq;
 472
 473         printk(KERN_INFO
 474                "%s: MPC83xx SPI Controller driver at 0x%p (irq = %d)\n",
 475                dev->dev.bus_id, mpc83xx_spi->base, mpc83xx_spi->irq);
 476
 477         return ret;
 478
 479 free_irq:
 480         free_irq(mpc83xx_spi->irq, mpc83xx_spi);
 481 unmap_io:
 482         iounmap(mpc83xx_spi->base);
 483 put_master:
 484         spi_master_put(master);
 485 free_master:
 486         kfree(master);
 487 err:
 488         return ret;
 489 }
 490
 491 static int __devexit mpc83xx_spi_remove(struct platform_device *dev)
 492 {
 493         struct mpc83xx_spi *mpc83xx_spi;
 494         struct spi_master *master;
 495
 496         master = platform_get_drvdata(dev);
 497         mpc83xx_spi = spi_master_get_devdata(master);
 498
 499         spi_bitbang_stop(&mpc83xx_spi->bitbang);
 500         free_irq(mpc83xx_spi->irq, mpc83xx_spi);
 501         iounmap(mpc83xx_spi->base);
 502         spi_master_put(mpc83xx_spi->bitbang.master);
 503
 504         return 0;
 505 }
 506
 507 static struct platform_driver mpc83xx_spi_driver = {
 508         .probe = mpc83xx_spi_probe,
 509         .remove = __devexit_p(mpc83xx_spi_remove),
 510         .driver = {
 511                    .name = "mpc83xx_spi",
 512         },
 513 };
 514
 515 static int __init mpc83xx_spi_init(void)
 516 {
 517         return platform_driver_register(&mpc83xx_spi_driver);
 518 }
 519
 520 static void __exit mpc83xx_spi_exit(void)
 521 {
 522         platform_driver_unregister(&mpc83xx_spi_driver);
 523 }
 524
 525 module_init(mpc83xx_spi_init);
 526 module_exit(mpc83xx_spi_exit);
 527
 528 MODULE_AUTHOR("Kumar Gala");
 529 MODULE_DESCRIPTION("Simple MPC83xx SPI Driver");
 530 MODULE_LICENSE("GPL");