drivers/spi/spi-altera.c

   1 /*
   2  * Altera SPI driver
   3  *
   4  * Copyright (C) 2008 Thomas Chou <thomas@wytron.com.tw>
   5  *
   6  * Based on spi_s3c24xx.c, which is:
   7  * Copyright (c) 2006 Ben Dooks
   8  * Copyright (c) 2006 Simtec Electronics
   9  *      Ben Dooks <ben@simtec.co.uk>
  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/interrupt.h>
  17 #include <linux/errno.h>
  18 #include <linux/module.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/spi/spi.h>
  21 #include <linux/io.h>
  22 #include <linux/of.h>
  23
  24 #define DRV_NAME "spi_altera"
  25
  26 #define ALTERA_SPI_RXDATA       0
  27 #define ALTERA_SPI_TXDATA       4
  28 #define ALTERA_SPI_STATUS       8
  29 #define ALTERA_SPI_CONTROL      12
  30 #define ALTERA_SPI_SLAVE_SEL    20
  31
  32 #define ALTERA_SPI_STATUS_ROE_MSK       0x8
  33 #define ALTERA_SPI_STATUS_TOE_MSK       0x10
  34 #define ALTERA_SPI_STATUS_TMT_MSK       0x20
  35 #define ALTERA_SPI_STATUS_TRDY_MSK      0x40
  36 #define ALTERA_SPI_STATUS_RRDY_MSK      0x80
  37 #define ALTERA_SPI_STATUS_E_MSK         0x100
  38
  39 #define ALTERA_SPI_CONTROL_IROE_MSK     0x8
  40 #define ALTERA_SPI_CONTROL_ITOE_MSK     0x10
  41 #define ALTERA_SPI_CONTROL_ITRDY_MSK    0x40
  42 #define ALTERA_SPI_CONTROL_IRRDY_MSK    0x80
  43 #define ALTERA_SPI_CONTROL_IE_MSK       0x100
  44 #define ALTERA_SPI_CONTROL_SSO_MSK      0x400
  45
  46 struct altera_spi {
  47         void __iomem *base;
  48         int irq;
  49         int len;
  50         int count;
  51         int bytes_per_word;
  52         unsigned long imr;
  53
  54         /* data buffers */
  55         const unsigned char *tx;
  56         unsigned char *rx;
  57 };
  58
  59 static inline struct altera_spi *altera_spi_to_hw(struct spi_device *sdev)
  60 {
  61         return spi_master_get_devdata(sdev->master);
  62 }
  63
  64 static void altera_spi_set_cs(struct spi_device *spi, bool is_high)
  65 {
  66         struct altera_spi *hw = altera_spi_to_hw(spi);
  67
  68         if (is_high) {
  69                 hw->imr &= ~ALTERA_SPI_CONTROL_SSO_MSK;
  70                 writel(hw->imr, hw->base + ALTERA_SPI_CONTROL);
  71                 writel(0, hw->base + ALTERA_SPI_SLAVE_SEL);
  72         } else {
  73                 writel(BIT(spi->chip_select), hw->base + ALTERA_SPI_SLAVE_SEL);
  74                 hw->imr |= ALTERA_SPI_CONTROL_SSO_MSK;
  75                 writel(hw->imr, hw->base + ALTERA_SPI_CONTROL);
  76         }
  77 }
  78
  79 static inline unsigned int hw_txbyte(struct altera_spi *hw, int count)
  80 {
  81         if (hw->tx) {
  82                 switch (hw->bytes_per_word) {
  83                 case 1:
  84                         return hw->tx[count];
  85                 case 2:
  86                         return (hw->tx[count * 2]
  87                                 | (hw->tx[count * 2 + 1] << 8));
  88                 }
  89         }
  90         return 0;
  91 }
  92
  93 static int altera_spi_txrx(struct spi_master *master,
  94         struct spi_device *spi, struct spi_transfer *t)
  95 {
  96         struct altera_spi *hw = spi_master_get_devdata(master);
  97
  98         hw->tx = t->tx_buf;
  99         hw->rx = t->rx_buf;
 100         hw->count = 0;
 101         hw->bytes_per_word = DIV_ROUND_UP(t->bits_per_word, 8);
 102         hw->len = t->len / hw->bytes_per_word;
 103
 104         if (hw->irq >= 0) {
 105                 /* enable receive interrupt */
 106                 hw->imr |= ALTERA_SPI_CONTROL_IRRDY_MSK;
 107                 writel(hw->imr, hw->base + ALTERA_SPI_CONTROL);
 108
 109                 /* send the first byte */
 110                 writel(hw_txbyte(hw, 0), hw->base + ALTERA_SPI_TXDATA);
 111         } else {
 112                 while (hw->count < hw->len) {
 113                         unsigned int rxd;
 114
 115                         writel(hw_txbyte(hw, hw->count),
 116                                hw->base + ALTERA_SPI_TXDATA);
 117
 118                         while (!(readl(hw->base + ALTERA_SPI_STATUS) &
 119                                  ALTERA_SPI_STATUS_RRDY_MSK))
 120                                 cpu_relax();
 121
 122                         rxd = readl(hw->base + ALTERA_SPI_RXDATA);
 123                         if (hw->rx) {
 124                                 switch (hw->bytes_per_word) {
 125                                 case 1:
 126                                         hw->rx[hw->count] = rxd;
 127                                         break;
 128                                 case 2:
 129                                         hw->rx[hw->count * 2] = rxd;
 130                                         hw->rx[hw->count * 2 + 1] = rxd >> 8;
 131                                         break;
 132                                 }
 133                         }
 134
 135                         hw->count++;
 136                 }
 137                 spi_finalize_current_transfer(master);
 138         }
 139
 140         return t->len;
 141 }
 142
 143 static irqreturn_t altera_spi_irq(int irq, void *dev)
 144 {
 145         struct spi_master *master = dev;
 146         struct altera_spi *hw = spi_master_get_devdata(master);
 147         unsigned int rxd;
 148
 149         rxd = readl(hw->base + ALTERA_SPI_RXDATA);
 150         if (hw->rx) {
 151                 switch (hw->bytes_per_word) {
 152                 case 1:
 153                         hw->rx[hw->count] = rxd;
 154                         break;
 155                 case 2:
 156                         hw->rx[hw->count * 2] = rxd;
 157                         hw->rx[hw->count * 2 + 1] = rxd >> 8;
 158                         break;
 159                 }
 160         }
 161
 162         hw->count++;
 163
 164         if (hw->count < hw->len) {
 165                 writel(hw_txbyte(hw, hw->count), hw->base + ALTERA_SPI_TXDATA);
 166         } else {
 167                 /* disable receive interrupt */
 168                 hw->imr &= ~ALTERA_SPI_CONTROL_IRRDY_MSK;
 169                 writel(hw->imr, hw->base + ALTERA_SPI_CONTROL);
 170
 171                 spi_finalize_current_transfer(master);
 172         }
 173
 174         return IRQ_HANDLED;
 175 }
 176
 177 static int altera_spi_probe(struct platform_device *pdev)
 178 {
 179         struct altera_spi *hw;
 180         struct spi_master *master;
 181         struct resource *res;
 182         int err = -ENODEV;
 183
 184         master = spi_alloc_master(&pdev->dev, sizeof(struct altera_spi));
 185         if (!master)
 186                 return err;
 187
 188         /* setup the master state. */
 189         master->bus_num = pdev->id;
 190         master->num_chipselect = 16;
 191         master->mode_bits = SPI_CS_HIGH;
 192         master->bits_per_word_mask = SPI_BPW_RANGE_MASK(1, 16);
 193         master->dev.of_node = pdev->dev.of_node;
 194         master->transfer_one = altera_spi_txrx;
 195         master->set_cs = altera_spi_set_cs;
 196
 197         hw = spi_master_get_devdata(master);
 198
 199         /* find and map our resources */
 200         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 201         hw->base = devm_ioremap_resource(&pdev->dev, res);
 202         if (IS_ERR(hw->base)) {
 203                 err = PTR_ERR(hw->base);
 204                 goto exit;
 205         }
 206         /* program defaults into the registers */
 207         hw->imr = 0;            /* disable spi interrupts */
 208         writel(hw->imr, hw->base + ALTERA_SPI_CONTROL);
 209         writel(0, hw->base + ALTERA_SPI_STATUS);        /* clear status reg */
 210         if (readl(hw->base + ALTERA_SPI_STATUS) & ALTERA_SPI_STATUS_RRDY_MSK)
 211                 readl(hw->base + ALTERA_SPI_RXDATA);    /* flush rxdata */
 212         /* irq is optional */
 213         hw->irq = platform_get_irq(pdev, 0);
 214         if (hw->irq >= 0) {
 215                 err = devm_request_irq(&pdev->dev, hw->irq, altera_spi_irq, 0,
 216                                        pdev->name, master);
 217                 if (err)
 218                         goto exit;
 219         }
 220
 221         err = devm_spi_register_master(&pdev->dev, master);
 222         if (err)
 223                 goto exit;
 224         dev_info(&pdev->dev, "base %p, irq %d\n", hw->base, hw->irq);
 225
 226         return 0;
 227 exit:
 228         spi_master_put(master);
 229         return err;
 230 }
 231
 232 #ifdef CONFIG_OF
 233 static const struct of_device_id altera_spi_match[] = {
 234         { .compatible = "ALTR,spi-1.0", },
 235         { .compatible = "altr,spi-1.0", },
 236         {},
 237 };
 238 MODULE_DEVICE_TABLE(of, altera_spi_match);
 239 #endif /* CONFIG_OF */
 240
 241 static struct platform_driver altera_spi_driver = {
 242         .probe = altera_spi_probe,
 243         .driver = {
 244                 .name = DRV_NAME,
 245                 .pm = NULL,
 246                 .of_match_table = of_match_ptr(altera_spi_match),
 247         },
 248 };
 249 module_platform_driver(altera_spi_driver);
 250
 251 MODULE_DESCRIPTION("Altera SPI driver");
 252 MODULE_AUTHOR("Thomas Chou <thomas@wytron.com.tw>");
 253 MODULE_LICENSE("GPL");
 254 MODULE_ALIAS("platform:" DRV_NAME);