drivers/spi/spi-xilinx.c

   1 /*
   2  * Xilinx SPI controller driver (master mode only)
   3  *
   4  * Author: MontaVista Software, Inc.
   5  *      source@mvista.com
   6  *
   7  * Copyright (c) 2010 Secret Lab Technologies, Ltd.
   8  * Copyright (c) 2009 Intel Corporation
   9  * 2002-2007 (c) MontaVista Software, Inc.
  10
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/init.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/of.h>
  20 #include <linux/platform_device.h>
  21 #include <linux/spi/spi.h>
  22 #include <linux/spi/spi_bitbang.h>
  23 #include <linux/spi/xilinx_spi.h>
  24 #include <linux/io.h>
  25
  26 #define XILINX_SPI_NAME "xilinx_spi"
  27
  28 /* Register definitions as per "OPB Serial Peripheral Interface (SPI) (v1.00e)
  29  * Product Specification", DS464
  30  */
  31 #define XSPI_CR_OFFSET          0x60    /* Control Register */
  32
  33 #define XSPI_CR_LOOP            0x01
  34 #define XSPI_CR_ENABLE          0x02
  35 #define XSPI_CR_MASTER_MODE     0x04
  36 #define XSPI_CR_CPOL            0x08
  37 #define XSPI_CR_CPHA            0x10
  38 #define XSPI_CR_MODE_MASK       (XSPI_CR_CPHA | XSPI_CR_CPOL)
  39 #define XSPI_CR_TXFIFO_RESET    0x20
  40 #define XSPI_CR_RXFIFO_RESET    0x40
  41 #define XSPI_CR_MANUAL_SSELECT  0x80
  42 #define XSPI_CR_TRANS_INHIBIT   0x100
  43 #define XSPI_CR_LSB_FIRST       0x200
  44
  45 #define XSPI_SR_OFFSET          0x64    /* Status Register */
  46
  47 #define XSPI_SR_RX_EMPTY_MASK   0x01    /* Receive FIFO is empty */
  48 #define XSPI_SR_RX_FULL_MASK    0x02    /* Receive FIFO is full */
  49 #define XSPI_SR_TX_EMPTY_MASK   0x04    /* Transmit FIFO is empty */
  50 #define XSPI_SR_TX_FULL_MASK    0x08    /* Transmit FIFO is full */
  51 #define XSPI_SR_MODE_FAULT_MASK 0x10    /* Mode fault error */
  52
  53 #define XSPI_TXD_OFFSET         0x68    /* Data Transmit Register */
  54 #define XSPI_RXD_OFFSET         0x6c    /* Data Receive Register */
  55
  56 #define XSPI_SSR_OFFSET         0x70    /* 32-bit Slave Select Register */
  57
  58 /* Register definitions as per "OPB IPIF (v3.01c) Product Specification", DS414
  59  * IPIF registers are 32 bit
  60  */
  61 #define XIPIF_V123B_DGIER_OFFSET        0x1c    /* IPIF global int enable reg */
  62 #define XIPIF_V123B_GINTR_ENABLE        0x80000000
  63
  64 #define XIPIF_V123B_IISR_OFFSET         0x20    /* IPIF interrupt status reg */
  65 #define XIPIF_V123B_IIER_OFFSET         0x28    /* IPIF interrupt enable reg */
  66
  67 #define XSPI_INTR_MODE_FAULT            0x01    /* Mode fault error */
  68 #define XSPI_INTR_SLAVE_MODE_FAULT      0x02    /* Selected as slave while
  69                                                  * disabled */
  70 #define XSPI_INTR_TX_EMPTY              0x04    /* TxFIFO is empty */
  71 #define XSPI_INTR_TX_UNDERRUN           0x08    /* TxFIFO was underrun */
  72 #define XSPI_INTR_RX_FULL               0x10    /* RxFIFO is full */
  73 #define XSPI_INTR_RX_OVERRUN            0x20    /* RxFIFO was overrun */
  74 #define XSPI_INTR_TX_HALF_EMPTY         0x40    /* TxFIFO is half empty */
  75
  76 #define XIPIF_V123B_RESETR_OFFSET       0x40    /* IPIF reset register */
  77 #define XIPIF_V123B_RESET_MASK          0x0a    /* the value to write */
  78
  79 struct xilinx_spi {
  80         /* bitbang has to be first */
  81         struct spi_bitbang bitbang;
  82         struct completion done;
  83         void __iomem    *regs;  /* virt. address of the control registers */
  84
  85         int             irq;
  86
  87         u8 *rx_ptr;             /* pointer in the Tx buffer */
  88         const u8 *tx_ptr;       /* pointer in the Rx buffer */
  89         int remaining_bytes;    /* the number of bytes left to transfer */
  90         u8 bits_per_word;
  91         unsigned int (*read_fn)(void __iomem *);
  92         void (*write_fn)(u32, void __iomem *);
  93         void (*tx_fn)(struct xilinx_spi *);
  94         void (*rx_fn)(struct xilinx_spi *);
  95 };
  96
  97 static void xspi_write32(u32 val, void __iomem *addr)
  98 {
  99         iowrite32(val, addr);
 100 }
 101
 102 static unsigned int xspi_read32(void __iomem *addr)
 103 {
 104         return ioread32(addr);
 105 }
 106
 107 static void xspi_write32_be(u32 val, void __iomem *addr)
 108 {
 109         iowrite32be(val, addr);
 110 }
 111
 112 static unsigned int xspi_read32_be(void __iomem *addr)
 113 {
 114         return ioread32be(addr);
 115 }
 116
 117 static void xspi_tx8(struct xilinx_spi *xspi)
 118 {
 119         xspi->write_fn(*xspi->tx_ptr, xspi->regs + XSPI_TXD_OFFSET);
 120         xspi->tx_ptr++;
 121 }
 122
 123 static void xspi_tx16(struct xilinx_spi *xspi)
 124 {
 125         xspi->write_fn(*(u16 *)(xspi->tx_ptr), xspi->regs + XSPI_TXD_OFFSET);
 126         xspi->tx_ptr += 2;
 127 }
 128
 129 static void xspi_tx32(struct xilinx_spi *xspi)
 130 {
 131         xspi->write_fn(*(u32 *)(xspi->tx_ptr), xspi->regs + XSPI_TXD_OFFSET);
 132         xspi->tx_ptr += 4;
 133 }
 134
 135 static void xspi_rx8(struct xilinx_spi *xspi)
 136 {
 137         u32 data = xspi->read_fn(xspi->regs + XSPI_RXD_OFFSET);
 138         if (xspi->rx_ptr) {
 139                 *xspi->rx_ptr = data & 0xff;
 140                 xspi->rx_ptr++;
 141         }
 142 }
 143
 144 static void xspi_rx16(struct xilinx_spi *xspi)
 145 {
 146         u32 data = xspi->read_fn(xspi->regs + XSPI_RXD_OFFSET);
 147         if (xspi->rx_ptr) {
 148                 *(u16 *)(xspi->rx_ptr) = data & 0xffff;
 149                 xspi->rx_ptr += 2;
 150         }
 151 }
 152
 153 static void xspi_rx32(struct xilinx_spi *xspi)
 154 {
 155         u32 data = xspi->read_fn(xspi->regs + XSPI_RXD_OFFSET);
 156         if (xspi->rx_ptr) {
 157                 *(u32 *)(xspi->rx_ptr) = data;
 158                 xspi->rx_ptr += 4;
 159         }
 160 }
 161
 162 static void xspi_init_hw(struct xilinx_spi *xspi)
 163 {
 164         void __iomem *regs_base = xspi->regs;
 165
 166         /* Reset the SPI device */
 167         xspi->write_fn(XIPIF_V123B_RESET_MASK,
 168                 regs_base + XIPIF_V123B_RESETR_OFFSET);
 169         /* Disable all the interrupts just in case */
 170         xspi->write_fn(0, regs_base + XIPIF_V123B_IIER_OFFSET);
 171         /* Enable the global IPIF interrupt */
 172         xspi->write_fn(XIPIF_V123B_GINTR_ENABLE,
 173                 regs_base + XIPIF_V123B_DGIER_OFFSET);
 174         /* Deselect the slave on the SPI bus */
 175         xspi->write_fn(0xffff, regs_base + XSPI_SSR_OFFSET);
 176         /* Disable the transmitter, enable Manual Slave Select Assertion,
 177          * put SPI controller into master mode, and enable it */
 178         xspi->write_fn(XSPI_CR_TRANS_INHIBIT | XSPI_CR_MANUAL_SSELECT |
 179                 XSPI_CR_MASTER_MODE | XSPI_CR_ENABLE | XSPI_CR_TXFIFO_RESET |
 180                 XSPI_CR_RXFIFO_RESET, regs_base + XSPI_CR_OFFSET);
 181 }
 182
 183 static void xilinx_spi_chipselect(struct spi_device *spi, int is_on)
 184 {
 185         struct xilinx_spi *xspi = spi_master_get_devdata(spi->master);
 186
 187         if (is_on == BITBANG_CS_INACTIVE) {
 188                 /* Deselect the slave on the SPI bus */
 189                 xspi->write_fn(0xffff, xspi->regs + XSPI_SSR_OFFSET);
 190         } else if (is_on == BITBANG_CS_ACTIVE) {
 191                 /* Set the SPI clock phase and polarity */
 192                 u16 cr = xspi->read_fn(xspi->regs + XSPI_CR_OFFSET)
 193                          & ~XSPI_CR_MODE_MASK;
 194                 if (spi->mode & SPI_CPHA)
 195                         cr |= XSPI_CR_CPHA;
 196                 if (spi->mode & SPI_CPOL)
 197                         cr |= XSPI_CR_CPOL;
 198                 xspi->write_fn(cr, xspi->regs + XSPI_CR_OFFSET);
 199
 200                 /* We do not check spi->max_speed_hz here as the SPI clock
 201                  * frequency is not software programmable (the IP block design
 202                  * parameter)
 203                  */
 204
 205                 /* Activate the chip select */
 206                 xspi->write_fn(~(0x0001 << spi->chip_select),
 207                         xspi->regs + XSPI_SSR_OFFSET);
 208         }
 209 }
 210
 211 /* spi_bitbang requires custom setup_transfer() to be defined if there is a
 212  * custom txrx_bufs().
 213  */
 214 static int xilinx_spi_setup_transfer(struct spi_device *spi,
 215                 struct spi_transfer *t)
 216 {
 217         return 0;
 218 }
 219
 220 static void xilinx_spi_fill_tx_fifo(struct xilinx_spi *xspi)
 221 {
 222         u8 sr;
 223
 224         /* Fill the Tx FIFO with as many bytes as possible */
 225         sr = xspi->read_fn(xspi->regs + XSPI_SR_OFFSET);
 226         while ((sr & XSPI_SR_TX_FULL_MASK) == 0 && xspi->remaining_bytes > 0) {
 227                 if (xspi->tx_ptr)
 228                         xspi->tx_fn(xspi);
 229                 else
 230                         xspi->write_fn(0, xspi->regs + XSPI_TXD_OFFSET);
 231                 xspi->remaining_bytes -= xspi->bits_per_word / 8;
 232                 sr = xspi->read_fn(xspi->regs + XSPI_SR_OFFSET);
 233         }
 234 }
 235
 236 static int xilinx_spi_txrx_bufs(struct spi_device *spi, struct spi_transfer *t)
 237 {
 238         struct xilinx_spi *xspi = spi_master_get_devdata(spi->master);
 239         u32 ipif_ier;
 240
 241         /* We get here with transmitter inhibited */
 242
 243         xspi->tx_ptr = t->tx_buf;
 244         xspi->rx_ptr = t->rx_buf;
 245         xspi->remaining_bytes = t->len;
 246         reinit_completion(&xspi->done);
 247
 248
 249         /* Enable the transmit empty interrupt, which we use to determine
 250          * progress on the transmission.
 251          */
 252         ipif_ier = xspi->read_fn(xspi->regs + XIPIF_V123B_IIER_OFFSET);
 253         xspi->write_fn(ipif_ier | XSPI_INTR_TX_EMPTY,
 254                 xspi->regs + XIPIF_V123B_IIER_OFFSET);
 255
 256         for (;;) {
 257                 u16 cr;
 258                 u8 sr;
 259
 260                 xilinx_spi_fill_tx_fifo(xspi);
 261
 262                 /* Start the transfer by not inhibiting the transmitter any
 263                  * longer
 264                  */
 265                 cr = xspi->read_fn(xspi->regs + XSPI_CR_OFFSET) &
 266                                                         ~XSPI_CR_TRANS_INHIBIT;
 267                 xspi->write_fn(cr, xspi->regs + XSPI_CR_OFFSET);
 268
 269                 wait_for_completion(&xspi->done);
 270
 271                 /* A transmit has just completed. Process received data and
 272                  * check for more data to transmit. Always inhibit the
 273                  * transmitter while the Isr refills the transmit register/FIFO,
 274                  * or make sure it is stopped if we're done.
 275                  */
 276                 cr = xspi->read_fn(xspi->regs + XSPI_CR_OFFSET);
 277                 xspi->write_fn(cr | XSPI_CR_TRANS_INHIBIT,
 278                                xspi->regs + XSPI_CR_OFFSET);
 279
 280                 /* Read out all the data from the Rx FIFO */
 281                 sr = xspi->read_fn(xspi->regs + XSPI_SR_OFFSET);
 282                 while ((sr & XSPI_SR_RX_EMPTY_MASK) == 0) {
 283                         xspi->rx_fn(xspi);
 284                         sr = xspi->read_fn(xspi->regs + XSPI_SR_OFFSET);
 285                 }
 286
 287                 /* See if there is more data to send */
 288                 if (xspi->remaining_bytes <= 0)
 289                         break;
 290         }
 291
 292         /* Disable the transmit empty interrupt */
 293         xspi->write_fn(ipif_ier, xspi->regs + XIPIF_V123B_IIER_OFFSET);
 294
 295         return t->len - xspi->remaining_bytes;
 296 }
 297
 298
 299 /* This driver supports single master mode only. Hence Tx FIFO Empty
 300  * is the only interrupt we care about.
 301  * Receive FIFO Overrun, Transmit FIFO Underrun, Mode Fault, and Slave Mode
 302  * Fault are not to happen.
 303  */
 304 static irqreturn_t xilinx_spi_irq(int irq, void *dev_id)
 305 {
 306         struct xilinx_spi *xspi = dev_id;
 307         u32 ipif_isr;
 308
 309         /* Get the IPIF interrupts, and clear them immediately */
 310         ipif_isr = xspi->read_fn(xspi->regs + XIPIF_V123B_IISR_OFFSET);
 311         xspi->write_fn(ipif_isr, xspi->regs + XIPIF_V123B_IISR_OFFSET);
 312
 313         if (ipif_isr & XSPI_INTR_TX_EMPTY) {    /* Transmission completed */
 314                 complete(&xspi->done);
 315         }
 316
 317         return IRQ_HANDLED;
 318 }
 319
 320 static const struct of_device_id xilinx_spi_of_match[] = {
 321         { .compatible = "xlnx,xps-spi-2.00.a", },
 322         { .compatible = "xlnx,xps-spi-2.00.b", },
 323         {}
 324 };
 325 MODULE_DEVICE_TABLE(of, xilinx_spi_of_match);
 326
 327 static int xilinx_spi_probe(struct platform_device *pdev)
 328 {
 329         struct xilinx_spi *xspi;
 330         struct xspi_platform_data *pdata;
 331         struct resource *res;
 332         int ret, num_cs = 0, bits_per_word = 8;
 333         struct spi_master *master;
 334         u32 tmp;
 335         u8 i;
 336
 337         pdata = dev_get_platdata(&pdev->dev);
 338         if (pdata) {
 339                 num_cs = pdata->num_chipselect;
 340                 bits_per_word = pdata->bits_per_word;
 341         } else {
 342                 of_property_read_u32(pdev->dev.of_node, "xlnx,num-ss-bits",
 343                                           &num_cs);
 344         }
 345
 346         if (!num_cs) {
 347                 dev_err(&pdev->dev,
 348                         "Missing slave select configuration data\n");
 349                 return -EINVAL;
 350         }
 351
 352         master = spi_alloc_master(&pdev->dev, sizeof(struct xilinx_spi));
 353         if (!master)
 354                 return -ENODEV;
 355
 356         /* the spi->mode bits understood by this driver: */
 357         master->mode_bits = SPI_CPOL | SPI_CPHA;
 358
 359         xspi = spi_master_get_devdata(master);
 360         xspi->bitbang.master = master;
 361         xspi->bitbang.chipselect = xilinx_spi_chipselect;
 362         xspi->bitbang.setup_transfer = xilinx_spi_setup_transfer;
 363         xspi->bitbang.txrx_bufs = xilinx_spi_txrx_bufs;
 364         init_completion(&xspi->done);
 365
 366         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 367         xspi->regs = devm_ioremap_resource(&pdev->dev, res);
 368         if (IS_ERR(xspi->regs)) {
 369                 ret = PTR_ERR(xspi->regs);
 370                 goto put_master;
 371         }
 372
 373         master->bus_num = pdev->dev.id;
 374         master->num_chipselect = num_cs;
 375         master->dev.of_node = pdev->dev.of_node;
 376
 377         /*
 378          * Detect endianess on the IP via loop bit in CR. Detection
 379          * must be done before reset is sent because incorrect reset
 380          * value generates error interrupt.
 381          * Setup little endian helper functions first and try to use them
 382          * and check if bit was correctly setup or not.
 383          */
 384         xspi->read_fn = xspi_read32;
 385         xspi->write_fn = xspi_write32;
 386
 387         xspi->write_fn(XSPI_CR_LOOP, xspi->regs + XSPI_CR_OFFSET);
 388         tmp = xspi->read_fn(xspi->regs + XSPI_CR_OFFSET);
 389         tmp &= XSPI_CR_LOOP;
 390         if (tmp != XSPI_CR_LOOP) {
 391                 xspi->read_fn = xspi_read32_be;
 392                 xspi->write_fn = xspi_write32_be;
 393         }
 394
 395         master->bits_per_word_mask = SPI_BPW_MASK(bits_per_word);
 396         xspi->bits_per_word = bits_per_word;
 397         if (xspi->bits_per_word == 8) {
 398                 xspi->tx_fn = xspi_tx8;
 399                 xspi->rx_fn = xspi_rx8;
 400         } else if (xspi->bits_per_word == 16) {
 401                 xspi->tx_fn = xspi_tx16;
 402                 xspi->rx_fn = xspi_rx16;
 403         } else if (xspi->bits_per_word == 32) {
 404                 xspi->tx_fn = xspi_tx32;
 405                 xspi->rx_fn = xspi_rx32;
 406         } else {
 407                 ret = -EINVAL;
 408                 goto put_master;
 409         }
 410
 411         /* SPI controller initializations */
 412         xspi_init_hw(xspi);
 413
 414         xspi->irq = platform_get_irq(pdev, 0);
 415         if (xspi->irq < 0) {
 416                 ret = xspi->irq;
 417                 goto put_master;
 418         }
 419
 420         /* Register for SPI Interrupt */
 421         ret = devm_request_irq(&pdev->dev, xspi->irq, xilinx_spi_irq, 0,
 422                                dev_name(&pdev->dev), xspi);
 423         if (ret)
 424                 goto put_master;
 425
 426         ret = spi_bitbang_start(&xspi->bitbang);
 427         if (ret) {
 428                 dev_err(&pdev->dev, "spi_bitbang_start FAILED\n");
 429                 goto put_master;
 430         }
 431
 432         dev_info(&pdev->dev, "at 0x%08llX mapped to 0x%p, irq=%d\n",
 433                 (unsigned long long)res->start, xspi->regs, xspi->irq);
 434
 435         if (pdata) {
 436                 for (i = 0; i < pdata->num_devices; i++)
 437                         spi_new_device(master, pdata->devices + i);
 438         }
 439
 440         platform_set_drvdata(pdev, master);
 441         return 0;
 442
 443 put_master:
 444         spi_master_put(master);
 445
 446         return ret;
 447 }
 448
 449 static int xilinx_spi_remove(struct platform_device *pdev)
 450 {
 451         struct spi_master *master = platform_get_drvdata(pdev);
 452         struct xilinx_spi *xspi = spi_master_get_devdata(master);
 453         void __iomem *regs_base = xspi->regs;
 454
 455         spi_bitbang_stop(&xspi->bitbang);
 456
 457         /* Disable all the interrupts just in case */
 458         xspi->write_fn(0, regs_base + XIPIF_V123B_IIER_OFFSET);
 459         /* Disable the global IPIF interrupt */
 460         xspi->write_fn(0, regs_base + XIPIF_V123B_DGIER_OFFSET);
 461
 462         spi_master_put(xspi->bitbang.master);
 463
 464         return 0;
 465 }
 466
 467 /* work with hotplug and coldplug */
 468 MODULE_ALIAS("platform:" XILINX_SPI_NAME);
 469
 470 static struct platform_driver xilinx_spi_driver = {
 471         .probe = xilinx_spi_probe,
 472         .remove = xilinx_spi_remove,
 473         .driver = {
 474                 .name = XILINX_SPI_NAME,
 475                 .owner = THIS_MODULE,
 476                 .of_match_table = xilinx_spi_of_match,
 477         },
 478 };
 479 module_platform_driver(xilinx_spi_driver);
 480
 481 MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
 482 MODULE_DESCRIPTION("Xilinx SPI driver");
 483 MODULE_LICENSE("GPL");