drivers/spi/spi_s3c24xx.c

   1 /* linux/drivers/spi/spi_s3c24xx.c
   2  *
   3  * Copyright (c) 2006 Ben Dooks
   4  * Copyright (c) 2006 Simtec Electronics
   5  *      Ben Dooks <ben@simtec.co.uk>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  *
  11 */
  12
  13 #include <linux/init.h>
  14 #include <linux/spinlock.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/delay.h>
  18 #include <linux/errno.h>
  19 #include <linux/err.h>
  20 #include <linux/clk.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/gpio.h>
  23
  24 #include <linux/spi/spi.h>
  25 #include <linux/spi/spi_bitbang.h>
  26
  27 #include <asm/io.h>
  28 #include <asm/dma.h>
  29 #include <mach/hardware.h>
  30
  31 #include <plat/regs-spi.h>
  32 #include <mach/spi.h>
  33
  34 struct s3c24xx_spi {
  35         /* bitbang has to be first */
  36         struct spi_bitbang       bitbang;
  37         struct completion        done;
  38
  39         void __iomem            *regs;
  40         int                      irq;
  41         int                      len;
  42         int                      count;
  43
  44         void                    (*set_cs)(struct s3c2410_spi_info *spi,
  45                                           int cs, int pol);
  46
  47         /* data buffers */
  48         const unsigned char     *tx;
  49         unsigned char           *rx;
  50
  51         struct clk              *clk;
  52         struct resource         *ioarea;
  53         struct spi_master       *master;
  54         struct spi_device       *curdev;
  55         struct device           *dev;
  56         struct s3c2410_spi_info *pdata;
  57 };
  58
  59 #define SPCON_DEFAULT (S3C2410_SPCON_MSTR | S3C2410_SPCON_SMOD_INT)
  60 #define SPPIN_DEFAULT (S3C2410_SPPIN_KEEP)
  61
  62 static inline struct s3c24xx_spi *to_hw(struct spi_device *sdev)
  63 {
  64         return spi_master_get_devdata(sdev->master);
  65 }
  66
  67 static void s3c24xx_spi_gpiocs(struct s3c2410_spi_info *spi, int cs, int pol)
  68 {
  69         gpio_set_value(spi->pin_cs, pol);
  70 }
  71
  72 static void s3c24xx_spi_chipsel(struct spi_device *spi, int value)
  73 {
  74         struct s3c24xx_spi *hw = to_hw(spi);
  75         unsigned int cspol = spi->mode & SPI_CS_HIGH ? 1 : 0;
  76         unsigned int spcon;
  77
  78         switch (value) {
  79         case BITBANG_CS_INACTIVE:
  80                 hw->set_cs(hw->pdata, spi->chip_select, cspol^1);
  81                 break;
  82
  83         case BITBANG_CS_ACTIVE:
  84                 spcon = readb(hw->regs + S3C2410_SPCON);
  85
  86                 if (spi->mode & SPI_CPHA)
  87                         spcon |= S3C2410_SPCON_CPHA_FMTB;
  88                 else
  89                         spcon &= ~S3C2410_SPCON_CPHA_FMTB;
  90
  91                 if (spi->mode & SPI_CPOL)
  92                         spcon |= S3C2410_SPCON_CPOL_HIGH;
  93                 else
  94                         spcon &= ~S3C2410_SPCON_CPOL_HIGH;
  95
  96                 spcon |= S3C2410_SPCON_ENSCK;
  97
  98                 /* write new configration */
  99
 100                 writeb(spcon, hw->regs + S3C2410_SPCON);
 101                 hw->set_cs(hw->pdata, spi->chip_select, cspol);
 102
 103                 break;
 104         }
 105 }
 106
 107 static int s3c24xx_spi_setupxfer(struct spi_device *spi,
 108                                  struct spi_transfer *t)
 109 {
 110         struct s3c24xx_spi *hw = to_hw(spi);
 111         unsigned int bpw;
 112         unsigned int hz;
 113         unsigned int div;
 114         unsigned long clk;
 115
 116         bpw = t ? t->bits_per_word : spi->bits_per_word;
 117         hz  = t ? t->speed_hz : spi->max_speed_hz;
 118
 119         if (bpw != 8) {
 120                 dev_err(&spi->dev, "invalid bits-per-word (%d)\n", bpw);
 121                 return -EINVAL;
 122         }
 123
 124         clk = clk_get_rate(hw->clk);
 125         div = DIV_ROUND_UP(clk, hz * 2) - 1;
 126
 127         if (div > 255)
 128                 div = 255;
 129
 130         dev_dbg(&spi->dev, "setting pre-scaler to %d (wanted %d, got %ld)\n",
 131                 div, hz, clk / (2 * (div + 1)));
 132
 133
 134         writeb(div, hw->regs + S3C2410_SPPRE);
 135
 136         spin_lock(&hw->bitbang.lock);
 137         if (!hw->bitbang.busy) {
 138                 hw->bitbang.chipselect(spi, BITBANG_CS_INACTIVE);
 139                 /* need to ndelay for 0.5 clocktick ? */
 140         }
 141         spin_unlock(&hw->bitbang.lock);
 142
 143         return 0;
 144 }
 145
 146 static int s3c24xx_spi_setup(struct spi_device *spi)
 147 {
 148         int ret;
 149
 150         ret = s3c24xx_spi_setupxfer(spi, NULL);
 151         if (ret < 0) {
 152                 dev_err(&spi->dev, "setupxfer returned %d\n", ret);
 153                 return ret;
 154         }
 155
 156         return 0;
 157 }
 158
 159 static inline unsigned int hw_txbyte(struct s3c24xx_spi *hw, int count)
 160 {
 161         return hw->tx ? hw->tx[count] : 0;
 162 }
 163
 164 static int s3c24xx_spi_txrx(struct spi_device *spi, struct spi_transfer *t)
 165 {
 166         struct s3c24xx_spi *hw = to_hw(spi);
 167
 168         dev_dbg(&spi->dev, "txrx: tx %p, rx %p, len %d\n",
 169                 t->tx_buf, t->rx_buf, t->len);
 170
 171         hw->tx = t->tx_buf;
 172         hw->rx = t->rx_buf;
 173         hw->len = t->len;
 174         hw->count = 0;
 175
 176         init_completion(&hw->done);
 177
 178         /* send the first byte */
 179         writeb(hw_txbyte(hw, 0), hw->regs + S3C2410_SPTDAT);
 180
 181         wait_for_completion(&hw->done);
 182
 183         return hw->count;
 184 }
 185
 186 static irqreturn_t s3c24xx_spi_irq(int irq, void *dev)
 187 {
 188         struct s3c24xx_spi *hw = dev;
 189         unsigned int spsta = readb(hw->regs + S3C2410_SPSTA);
 190         unsigned int count = hw->count;
 191
 192         if (spsta & S3C2410_SPSTA_DCOL) {
 193                 dev_dbg(hw->dev, "data-collision\n");
 194                 complete(&hw->done);
 195                 goto irq_done;
 196         }
 197
 198         if (!(spsta & S3C2410_SPSTA_READY)) {
 199                 dev_dbg(hw->dev, "spi not ready for tx?\n");
 200                 complete(&hw->done);
 201                 goto irq_done;
 202         }
 203
 204         hw->count++;
 205
 206         if (hw->rx)
 207                 hw->rx[count] = readb(hw->regs + S3C2410_SPRDAT);
 208
 209         count++;
 210
 211         if (count < hw->len)
 212                 writeb(hw_txbyte(hw, count), hw->regs + S3C2410_SPTDAT);
 213         else
 214                 complete(&hw->done);
 215
 216  irq_done:
 217         return IRQ_HANDLED;
 218 }
 219
 220 static void s3c24xx_spi_initialsetup(struct s3c24xx_spi *hw)
 221 {
 222         /* for the moment, permanently enable the clock */
 223
 224         clk_enable(hw->clk);
 225
 226         /* program defaults into the registers */
 227
 228         writeb(0xff, hw->regs + S3C2410_SPPRE);
 229         writeb(SPPIN_DEFAULT, hw->regs + S3C2410_SPPIN);
 230         writeb(SPCON_DEFAULT, hw->regs + S3C2410_SPCON);
 231
 232         if (hw->pdata) {
 233                 if (hw->set_cs == s3c24xx_spi_gpiocs)
 234                         gpio_direction_output(hw->pdata->pin_cs, 1);
 235
 236                 if (hw->pdata->gpio_setup)
 237                         hw->pdata->gpio_setup(hw->pdata, 1);
 238         }
 239 }
 240
 241 static int __init s3c24xx_spi_probe(struct platform_device *pdev)
 242 {
 243         struct s3c2410_spi_info *pdata;
 244         struct s3c24xx_spi *hw;
 245         struct spi_master *master;
 246         struct resource *res;
 247         int err = 0;
 248
 249         master = spi_alloc_master(&pdev->dev, sizeof(struct s3c24xx_spi));
 250         if (master == NULL) {
 251                 dev_err(&pdev->dev, "No memory for spi_master\n");
 252                 err = -ENOMEM;
 253                 goto err_nomem;
 254         }
 255
 256         hw = spi_master_get_devdata(master);
 257         memset(hw, 0, sizeof(struct s3c24xx_spi));
 258
 259         hw->master = spi_master_get(master);
 260         hw->pdata = pdata = pdev->dev.platform_data;
 261         hw->dev = &pdev->dev;
 262
 263         if (pdata == NULL) {
 264                 dev_err(&pdev->dev, "No platform data supplied\n");
 265                 err = -ENOENT;
 266                 goto err_no_pdata;
 267         }
 268
 269         platform_set_drvdata(pdev, hw);
 270         init_completion(&hw->done);
 271
 272         /* setup the master state. */
 273
 274         /* the spi->mode bits understood by this driver: */
 275         master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
 276
 277         master->num_chipselect = hw->pdata->num_cs;
 278         master->bus_num = pdata->bus_num;
 279
 280         /* setup the state for the bitbang driver */
 281
 282         hw->bitbang.master         = hw->master;
 283         hw->bitbang.setup_transfer = s3c24xx_spi_setupxfer;
 284         hw->bitbang.chipselect     = s3c24xx_spi_chipsel;
 285         hw->bitbang.txrx_bufs      = s3c24xx_spi_txrx;
 286         hw->bitbang.master->setup  = s3c24xx_spi_setup;
 287
 288         dev_dbg(hw->dev, "bitbang at %p\n", &hw->bitbang);
 289
 290         /* find and map our resources */
 291
 292         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 293         if (res == NULL) {
 294                 dev_err(&pdev->dev, "Cannot get IORESOURCE_MEM\n");
 295                 err = -ENOENT;
 296                 goto err_no_iores;
 297         }
 298
 299         hw->ioarea = request_mem_region(res->start, (res->end - res->start)+1,
 300                                         pdev->name);
 301
 302         if (hw->ioarea == NULL) {
 303                 dev_err(&pdev->dev, "Cannot reserve region\n");
 304                 err = -ENXIO;
 305                 goto err_no_iores;
 306         }
 307
 308         hw->regs = ioremap(res->start, (res->end - res->start)+1);
 309         if (hw->regs == NULL) {
 310                 dev_err(&pdev->dev, "Cannot map IO\n");
 311                 err = -ENXIO;
 312                 goto err_no_iomap;
 313         }
 314
 315         hw->irq = platform_get_irq(pdev, 0);
 316         if (hw->irq < 0) {
 317                 dev_err(&pdev->dev, "No IRQ specified\n");
 318                 err = -ENOENT;
 319                 goto err_no_irq;
 320         }
 321
 322         err = request_irq(hw->irq, s3c24xx_spi_irq, 0, pdev->name, hw);
 323         if (err) {
 324                 dev_err(&pdev->dev, "Cannot claim IRQ\n");
 325                 goto err_no_irq;
 326         }
 327
 328         hw->clk = clk_get(&pdev->dev, "spi");
 329         if (IS_ERR(hw->clk)) {
 330                 dev_err(&pdev->dev, "No clock for device\n");
 331                 err = PTR_ERR(hw->clk);
 332                 goto err_no_clk;
 333         }
 334
 335         /* setup any gpio we can */
 336
 337         if (!pdata->set_cs) {
 338                 if (pdata->pin_cs < 0) {
 339                         dev_err(&pdev->dev, "No chipselect pin\n");
 340                         goto err_register;
 341                 }
 342
 343                 err = gpio_request(pdata->pin_cs, dev_name(&pdev->dev));
 344                 if (err) {
 345                         dev_err(&pdev->dev, "Failed to get gpio for cs\n");
 346                         goto err_register;
 347                 }
 348
 349                 hw->set_cs = s3c24xx_spi_gpiocs;
 350                 gpio_direction_output(pdata->pin_cs, 1);
 351         } else
 352                 hw->set_cs = pdata->set_cs;
 353
 354         s3c24xx_spi_initialsetup(hw);
 355
 356         /* register our spi controller */
 357
 358         err = spi_bitbang_start(&hw->bitbang);
 359         if (err) {
 360                 dev_err(&pdev->dev, "Failed to register SPI master\n");
 361                 goto err_register;
 362         }
 363
 364         return 0;
 365
 366  err_register:
 367         if (hw->set_cs == s3c24xx_spi_gpiocs)
 368                 gpio_free(pdata->pin_cs);
 369
 370         clk_disable(hw->clk);
 371         clk_put(hw->clk);
 372
 373  err_no_clk:
 374         free_irq(hw->irq, hw);
 375
 376  err_no_irq:
 377         iounmap(hw->regs);
 378
 379  err_no_iomap:
 380         release_resource(hw->ioarea);
 381         kfree(hw->ioarea);
 382
 383  err_no_iores:
 384  err_no_pdata:
 385         spi_master_put(hw->master);;
 386
 387  err_nomem:
 388         return err;
 389 }
 390
 391 static int __exit s3c24xx_spi_remove(struct platform_device *dev)
 392 {
 393         struct s3c24xx_spi *hw = platform_get_drvdata(dev);
 394
 395         platform_set_drvdata(dev, NULL);
 396
 397         spi_unregister_master(hw->master);
 398
 399         clk_disable(hw->clk);
 400         clk_put(hw->clk);
 401
 402         free_irq(hw->irq, hw);
 403         iounmap(hw->regs);
 404
 405         if (hw->set_cs == s3c24xx_spi_gpiocs)
 406                 gpio_free(hw->pdata->pin_cs);
 407
 408         release_resource(hw->ioarea);
 409         kfree(hw->ioarea);
 410
 411         spi_master_put(hw->master);
 412         return 0;
 413 }
 414
 415
 416 #ifdef CONFIG_PM
 417
 418 static int s3c24xx_spi_suspend(struct platform_device *pdev, pm_message_t msg)
 419 {
 420         struct s3c24xx_spi *hw = platform_get_drvdata(pdev);
 421
 422         if (hw->pdata && hw->pdata->gpio_setup)
 423                 hw->pdata->gpio_setup(hw->pdata, 0);
 424
 425         clk_disable(hw->clk);
 426         return 0;
 427 }
 428
 429 static int s3c24xx_spi_resume(struct platform_device *pdev)
 430 {
 431         struct s3c24xx_spi *hw = platform_get_drvdata(pdev);
 432
 433         s3c24xx_spi_initialsetup(hw);
 434         return 0;
 435 }
 436
 437 #else
 438 #define s3c24xx_spi_suspend NULL
 439 #define s3c24xx_spi_resume  NULL
 440 #endif
 441
 442 MODULE_ALIAS("platform:s3c2410-spi");
 443 static struct platform_driver s3c24xx_spi_driver = {
 444         .remove         = __exit_p(s3c24xx_spi_remove),
 445         .suspend        = s3c24xx_spi_suspend,
 446         .resume         = s3c24xx_spi_resume,
 447         .driver         = {
 448                 .name   = "s3c2410-spi",
 449                 .owner  = THIS_MODULE,
 450         },
 451 };
 452
 453 static int __init s3c24xx_spi_init(void)
 454 {
 455         return platform_driver_probe(&s3c24xx_spi_driver, s3c24xx_spi_probe);
 456 }
 457
 458 static void __exit s3c24xx_spi_exit(void)
 459 {
 460         platform_driver_unregister(&s3c24xx_spi_driver);
 461 }
 462
 463 module_init(s3c24xx_spi_init);
 464 module_exit(s3c24xx_spi_exit);
 465
 466 MODULE_DESCRIPTION("S3C24XX SPI Driver");
 467 MODULE_AUTHOR("Ben Dooks, <ben@simtec.co.uk>");
 468 MODULE_LICENSE("GPL");