2 * SuperH MSIOF SPI Master Interface
4 * Copyright (c) 2009 Magnus Damm
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
12 #include <linux/kernel.h>
13 #include <linux/init.h>
14 #include <linux/delay.h>
15 #include <linux/interrupt.h>
16 #include <linux/platform_device.h>
17 #include <linux/completion.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/gpio.h>
20 #include <linux/bitmap.h>
21 #include <linux/clk.h>
24 #include <linux/spi/spi.h>
25 #include <linux/spi/spi_bitbang.h>
26 #include <linux/spi/sh_msiof.h>
29 #include <asm/unaligned.h>
31 struct sh_msiof_spi_priv {
32 struct spi_bitbang bitbang; /* must be first for spi_bitbang.c */
33 void __iomem *mapbase;
35 struct platform_device *pdev;
36 struct sh_msiof_spi_info *info;
37 struct completion done;
62 #define CTR_TSCKE (1 << 15)
63 #define CTR_TFSE (1 << 14)
64 #define CTR_TXE (1 << 9)
65 #define CTR_RXE (1 << 8)
67 #define STR_TEOF (1 << 23)
68 #define STR_REOF (1 << 7)
70 static unsigned long sh_msiof_read(struct sh_msiof_spi_priv *p, int reg_offs)
75 return ioread16(p->mapbase + reg_offs);
77 return ioread32(p->mapbase + reg_offs);
81 static void sh_msiof_write(struct sh_msiof_spi_priv *p, int reg_offs,
87 iowrite16(value, p->mapbase + reg_offs);
90 iowrite32(value, p->mapbase + reg_offs);
95 static int sh_msiof_modify_ctr_wait(struct sh_msiof_spi_priv *p,
96 unsigned long clr, unsigned long set)
98 unsigned long mask = clr | set;
102 data = sh_msiof_read(p, CTR);
105 sh_msiof_write(p, CTR, data);
107 for (k = 100; k > 0; k--) {
108 if ((sh_msiof_read(p, CTR) & mask) == set)
114 return k > 0 ? 0 : -ETIMEDOUT;
117 static irqreturn_t sh_msiof_spi_irq(int irq, void *data)
119 struct sh_msiof_spi_priv *p = data;
121 /* just disable the interrupt and wake up */
122 sh_msiof_write(p, IER, 0);
131 } const sh_msiof_spi_clk_table[] = {
145 static void sh_msiof_spi_set_clk_regs(struct sh_msiof_spi_priv *p,
146 unsigned long parent_rate,
147 unsigned long spi_hz)
149 unsigned long div = 1024;
152 if (!WARN_ON(!spi_hz || !parent_rate))
153 div = parent_rate / spi_hz;
155 /* TODO: make more fine grained */
157 for (k = 0; k < ARRAY_SIZE(sh_msiof_spi_clk_table); k++) {
158 if (sh_msiof_spi_clk_table[k].div >= div)
162 k = min_t(int, k, ARRAY_SIZE(sh_msiof_spi_clk_table) - 1);
164 sh_msiof_write(p, TSCR, sh_msiof_spi_clk_table[k].scr);
165 sh_msiof_write(p, RSCR, sh_msiof_spi_clk_table[k].scr);
168 static void sh_msiof_spi_set_pin_regs(struct sh_msiof_spi_priv *p,
170 int tx_hi_z, int lsb_first)
176 * CPOL CPHA TSCKIZ RSCKIZ TEDG REDG(!)
182 * (!) Note: REDG is inverted recommended data sheet setting
185 sh_msiof_write(p, FCTR, 0);
186 sh_msiof_write(p, TMDR1, 0xe2000005 | (lsb_first << 24));
187 sh_msiof_write(p, RMDR1, 0x22000005 | (lsb_first << 24));
190 tmp |= cpol << 30; /* TSCKIZ */
191 tmp |= cpol << 28; /* RSCKIZ */
193 edge = cpol ? cpha : !cpha;
195 tmp |= edge << 27; /* TEDG */
196 tmp |= !edge << 26; /* REDG */
197 tmp |= (tx_hi_z ? 2 : 0) << 22; /* TXDIZ */
198 sh_msiof_write(p, CTR, tmp);
201 static void sh_msiof_spi_set_mode_regs(struct sh_msiof_spi_priv *p,
202 const void *tx_buf, void *rx_buf,
207 dr2 = ((bits - 1) << 24) | ((words - 1) << 16);
210 sh_msiof_write(p, TMDR2, dr2);
212 sh_msiof_write(p, TMDR2, dr2 | 1);
215 sh_msiof_write(p, RMDR2, dr2);
217 sh_msiof_write(p, IER, STR_TEOF | STR_REOF);
220 static void sh_msiof_reset_str(struct sh_msiof_spi_priv *p)
222 sh_msiof_write(p, STR, sh_msiof_read(p, STR));
225 static void sh_msiof_spi_write_fifo_8(struct sh_msiof_spi_priv *p,
226 const void *tx_buf, int words, int fs)
228 const unsigned char *buf_8 = tx_buf;
231 for (k = 0; k < words; k++)
232 sh_msiof_write(p, TFDR, buf_8[k] << fs);
235 static void sh_msiof_spi_write_fifo_16(struct sh_msiof_spi_priv *p,
236 const void *tx_buf, int words, int fs)
238 const unsigned short *buf_16 = tx_buf;
241 for (k = 0; k < words; k++)
242 sh_msiof_write(p, TFDR, buf_16[k] << fs);
245 static void sh_msiof_spi_write_fifo_16u(struct sh_msiof_spi_priv *p,
246 const void *tx_buf, int words, int fs)
248 const unsigned short *buf_16 = tx_buf;
251 for (k = 0; k < words; k++)
252 sh_msiof_write(p, TFDR, get_unaligned(&buf_16[k]) << fs);
255 static void sh_msiof_spi_write_fifo_32(struct sh_msiof_spi_priv *p,
256 const void *tx_buf, int words, int fs)
258 const unsigned int *buf_32 = tx_buf;
261 for (k = 0; k < words; k++)
262 sh_msiof_write(p, TFDR, buf_32[k] << fs);
265 static void sh_msiof_spi_write_fifo_32u(struct sh_msiof_spi_priv *p,
266 const void *tx_buf, int words, int fs)
268 const unsigned int *buf_32 = tx_buf;
271 for (k = 0; k < words; k++)
272 sh_msiof_write(p, TFDR, get_unaligned(&buf_32[k]) << fs);
275 static void sh_msiof_spi_read_fifo_8(struct sh_msiof_spi_priv *p,
276 void *rx_buf, int words, int fs)
278 unsigned char *buf_8 = rx_buf;
281 for (k = 0; k < words; k++)
282 buf_8[k] = sh_msiof_read(p, RFDR) >> fs;
285 static void sh_msiof_spi_read_fifo_16(struct sh_msiof_spi_priv *p,
286 void *rx_buf, int words, int fs)
288 unsigned short *buf_16 = rx_buf;
291 for (k = 0; k < words; k++)
292 buf_16[k] = sh_msiof_read(p, RFDR) >> fs;
295 static void sh_msiof_spi_read_fifo_16u(struct sh_msiof_spi_priv *p,
296 void *rx_buf, int words, int fs)
298 unsigned short *buf_16 = rx_buf;
301 for (k = 0; k < words; k++)
302 put_unaligned(sh_msiof_read(p, RFDR) >> fs, &buf_16[k]);
305 static void sh_msiof_spi_read_fifo_32(struct sh_msiof_spi_priv *p,
306 void *rx_buf, int words, int fs)
308 unsigned int *buf_32 = rx_buf;
311 for (k = 0; k < words; k++)
312 buf_32[k] = sh_msiof_read(p, RFDR) >> fs;
315 static void sh_msiof_spi_read_fifo_32u(struct sh_msiof_spi_priv *p,
316 void *rx_buf, int words, int fs)
318 unsigned int *buf_32 = rx_buf;
321 for (k = 0; k < words; k++)
322 put_unaligned(sh_msiof_read(p, RFDR) >> fs, &buf_32[k]);
325 static int sh_msiof_spi_bits(struct spi_device *spi, struct spi_transfer *t)
329 bits = t ? t->bits_per_word : 0;
330 bits = bits ? bits : spi->bits_per_word;
334 static unsigned long sh_msiof_spi_hz(struct spi_device *spi,
335 struct spi_transfer *t)
339 hz = t ? t->speed_hz : 0;
340 hz = hz ? hz : spi->max_speed_hz;
344 static int sh_msiof_spi_setup_transfer(struct spi_device *spi,
345 struct spi_transfer *t)
349 /* noting to check hz values against since parent clock is disabled */
351 bits = sh_msiof_spi_bits(spi, t);
357 return spi_bitbang_setup_transfer(spi, t);
360 static void sh_msiof_spi_chipselect(struct spi_device *spi, int is_on)
362 struct sh_msiof_spi_priv *p = spi_master_get_devdata(spi->master);
365 /* chip select is active low unless SPI_CS_HIGH is set */
366 if (spi->mode & SPI_CS_HIGH)
367 value = (is_on == BITBANG_CS_ACTIVE) ? 1 : 0;
369 value = (is_on == BITBANG_CS_ACTIVE) ? 0 : 1;
371 if (is_on == BITBANG_CS_ACTIVE) {
372 if (!test_and_set_bit(0, &p->flags)) {
373 pm_runtime_get_sync(&p->pdev->dev);
377 /* Configure pins before asserting CS */
378 sh_msiof_spi_set_pin_regs(p, !!(spi->mode & SPI_CPOL),
379 !!(spi->mode & SPI_CPHA),
380 !!(spi->mode & SPI_3WIRE),
381 !!(spi->mode & SPI_LSB_FIRST));
384 /* use spi->controller data for CS (same strategy as spi_gpio) */
385 gpio_set_value((unsigned)spi->controller_data, value);
387 if (is_on == BITBANG_CS_INACTIVE) {
388 if (test_and_clear_bit(0, &p->flags)) {
390 pm_runtime_put(&p->pdev->dev);
395 static int sh_msiof_spi_txrx_once(struct sh_msiof_spi_priv *p,
396 void (*tx_fifo)(struct sh_msiof_spi_priv *,
397 const void *, int, int),
398 void (*rx_fifo)(struct sh_msiof_spi_priv *,
400 const void *tx_buf, void *rx_buf,
406 /* limit maximum word transfer to rx/tx fifo size */
408 words = min_t(int, words, p->tx_fifo_size);
410 words = min_t(int, words, p->rx_fifo_size);
412 /* the fifo contents need shifting */
413 fifo_shift = 32 - bits;
415 /* setup msiof transfer mode registers */
416 sh_msiof_spi_set_mode_regs(p, tx_buf, rx_buf, bits, words);
420 tx_fifo(p, tx_buf, words, fifo_shift);
422 /* setup clock and rx/tx signals */
423 ret = sh_msiof_modify_ctr_wait(p, 0, CTR_TSCKE);
425 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, 0, CTR_RXE);
426 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, 0, CTR_TXE);
428 /* start by setting frame bit */
429 INIT_COMPLETION(p->done);
430 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, 0, CTR_TFSE);
432 dev_err(&p->pdev->dev, "failed to start hardware\n");
436 /* wait for tx fifo to be emptied / rx fifo to be filled */
437 wait_for_completion(&p->done);
441 rx_fifo(p, rx_buf, words, fifo_shift);
443 /* clear status bits */
444 sh_msiof_reset_str(p);
446 /* shut down frame, tx/tx and clock signals */
447 ret = sh_msiof_modify_ctr_wait(p, CTR_TFSE, 0);
448 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, CTR_TXE, 0);
450 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, CTR_RXE, 0);
451 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, CTR_TSCKE, 0);
453 dev_err(&p->pdev->dev, "failed to shut down hardware\n");
460 sh_msiof_write(p, IER, 0);
464 static int sh_msiof_spi_txrx(struct spi_device *spi, struct spi_transfer *t)
466 struct sh_msiof_spi_priv *p = spi_master_get_devdata(spi->master);
467 void (*tx_fifo)(struct sh_msiof_spi_priv *, const void *, int, int);
468 void (*rx_fifo)(struct sh_msiof_spi_priv *, void *, int, int);
475 bits = sh_msiof_spi_bits(spi, t);
477 /* setup bytes per word and fifo read/write functions */
480 tx_fifo = sh_msiof_spi_write_fifo_8;
481 rx_fifo = sh_msiof_spi_read_fifo_8;
482 } else if (bits <= 16) {
484 if ((unsigned long)t->tx_buf & 0x01)
485 tx_fifo = sh_msiof_spi_write_fifo_16u;
487 tx_fifo = sh_msiof_spi_write_fifo_16;
489 if ((unsigned long)t->rx_buf & 0x01)
490 rx_fifo = sh_msiof_spi_read_fifo_16u;
492 rx_fifo = sh_msiof_spi_read_fifo_16;
495 if ((unsigned long)t->tx_buf & 0x03)
496 tx_fifo = sh_msiof_spi_write_fifo_32u;
498 tx_fifo = sh_msiof_spi_write_fifo_32;
500 if ((unsigned long)t->rx_buf & 0x03)
501 rx_fifo = sh_msiof_spi_read_fifo_32u;
503 rx_fifo = sh_msiof_spi_read_fifo_32;
506 /* setup clocks (clock already enabled in chipselect()) */
507 sh_msiof_spi_set_clk_regs(p, clk_get_rate(p->clk),
508 sh_msiof_spi_hz(spi, t));
510 /* transfer in fifo sized chunks */
511 words = t->len / bytes_per_word;
514 while (bytes_done < t->len) {
515 n = sh_msiof_spi_txrx_once(p, tx_fifo, rx_fifo,
516 t->tx_buf + bytes_done,
517 t->rx_buf + bytes_done,
522 bytes_done += n * bytes_per_word;
529 static u32 sh_msiof_spi_txrx_word(struct spi_device *spi, unsigned nsecs,
532 BUG(); /* unused but needed by bitbang code */
536 static int sh_msiof_spi_probe(struct platform_device *pdev)
539 struct spi_master *master;
540 struct sh_msiof_spi_priv *p;
545 master = spi_alloc_master(&pdev->dev, sizeof(struct sh_msiof_spi_priv));
546 if (master == NULL) {
547 dev_err(&pdev->dev, "failed to allocate spi master\n");
552 p = spi_master_get_devdata(master);
554 platform_set_drvdata(pdev, p);
555 p->info = pdev->dev.platform_data;
556 init_completion(&p->done);
558 snprintf(clk_name, sizeof(clk_name), "msiof%d", pdev->id);
559 p->clk = clk_get(&pdev->dev, clk_name);
560 if (IS_ERR(p->clk)) {
561 dev_err(&pdev->dev, "cannot get clock \"%s\"\n", clk_name);
562 ret = PTR_ERR(p->clk);
566 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
567 i = platform_get_irq(pdev, 0);
569 dev_err(&pdev->dev, "cannot get platform resources\n");
573 p->mapbase = ioremap_nocache(r->start, resource_size(r));
575 dev_err(&pdev->dev, "unable to ioremap\n");
580 ret = request_irq(i, sh_msiof_spi_irq, IRQF_DISABLED,
581 dev_name(&pdev->dev), p);
583 dev_err(&pdev->dev, "unable to request irq\n");
588 pm_runtime_enable(&pdev->dev);
590 /* The standard version of MSIOF use 64 word FIFOs */
591 p->tx_fifo_size = 64;
592 p->rx_fifo_size = 64;
594 /* Platform data may override FIFO sizes */
595 if (p->info->tx_fifo_override)
596 p->tx_fifo_size = p->info->tx_fifo_override;
597 if (p->info->rx_fifo_override)
598 p->rx_fifo_size = p->info->rx_fifo_override;
600 /* init master and bitbang code */
601 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
602 master->mode_bits |= SPI_LSB_FIRST | SPI_3WIRE;
604 master->bus_num = pdev->id;
605 master->num_chipselect = p->info->num_chipselect;
606 master->setup = spi_bitbang_setup;
607 master->cleanup = spi_bitbang_cleanup;
609 p->bitbang.master = master;
610 p->bitbang.chipselect = sh_msiof_spi_chipselect;
611 p->bitbang.setup_transfer = sh_msiof_spi_setup_transfer;
612 p->bitbang.txrx_bufs = sh_msiof_spi_txrx;
613 p->bitbang.txrx_word[SPI_MODE_0] = sh_msiof_spi_txrx_word;
614 p->bitbang.txrx_word[SPI_MODE_1] = sh_msiof_spi_txrx_word;
615 p->bitbang.txrx_word[SPI_MODE_2] = sh_msiof_spi_txrx_word;
616 p->bitbang.txrx_word[SPI_MODE_3] = sh_msiof_spi_txrx_word;
618 ret = spi_bitbang_start(&p->bitbang);
622 pm_runtime_disable(&pdev->dev);
628 spi_master_put(master);
633 static int sh_msiof_spi_remove(struct platform_device *pdev)
635 struct sh_msiof_spi_priv *p = platform_get_drvdata(pdev);
638 ret = spi_bitbang_stop(&p->bitbang);
640 pm_runtime_disable(&pdev->dev);
641 free_irq(platform_get_irq(pdev, 0), sh_msiof_spi_irq);
644 spi_master_put(p->bitbang.master);
649 static int sh_msiof_spi_runtime_nop(struct device *dev)
651 /* Runtime PM callback shared between ->runtime_suspend()
652 * and ->runtime_resume(). Simply returns success.
654 * This driver re-initializes all registers after
655 * pm_runtime_get_sync() anyway so there is no need
656 * to save and restore registers here.
661 static struct dev_pm_ops sh_msiof_spi_dev_pm_ops = {
662 .runtime_suspend = sh_msiof_spi_runtime_nop,
663 .runtime_resume = sh_msiof_spi_runtime_nop,
666 static struct platform_driver sh_msiof_spi_drv = {
667 .probe = sh_msiof_spi_probe,
668 .remove = sh_msiof_spi_remove,
670 .name = "spi_sh_msiof",
671 .owner = THIS_MODULE,
672 .pm = &sh_msiof_spi_dev_pm_ops,
676 static int __init sh_msiof_spi_init(void)
678 return platform_driver_register(&sh_msiof_spi_drv);
680 module_init(sh_msiof_spi_init);
682 static void __exit sh_msiof_spi_exit(void)
684 platform_driver_unregister(&sh_msiof_spi_drv);
686 module_exit(sh_msiof_spi_exit);
688 MODULE_DESCRIPTION("SuperH MSIOF SPI Master Interface Driver");
689 MODULE_AUTHOR("Magnus Damm");
690 MODULE_LICENSE("GPL v2");
691 MODULE_ALIAS("platform:spi_sh_msiof");