2 * omap_uwire.c -- MicroWire interface driver for OMAP
4 * Copyright 2003 MontaVista Software Inc. <source@mvista.com>
6 * Ported to 2.6 OMAP uwire interface.
7 * Copyright (C) 2004 Texas Instruments.
9 * Generalization patches by Juha Yrjola <juha.yrjola@nokia.com>
11 * Copyright (C) 2005 David Brownell (ported to 2.6 SPI interface)
12 * Copyright (C) 2006 Nokia
14 * Many updates by Imre Deak <imre.deak@nokia.com>
16 * This program is free software; you can redistribute it and/or modify it
17 * under the terms of the GNU General Public License as published by the
18 * Free Software Foundation; either version 2 of the License, or (at your
19 * option) any later version.
21 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
27 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
28 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * You should have received a copy of the GNU General Public License along
33 * with this program; if not, write to the Free Software Foundation, Inc.,
34 * 675 Mass Ave, Cambridge, MA 02139, USA.
36 #include <linux/kernel.h>
37 #include <linux/init.h>
38 #include <linux/delay.h>
39 #include <linux/platform_device.h>
40 #include <linux/workqueue.h>
41 #include <linux/interrupt.h>
42 #include <linux/err.h>
43 #include <linux/clk.h>
45 #include <linux/spi/spi.h>
46 #include <linux/spi/spi_bitbang.h>
48 #include <asm/system.h>
50 #include <mach/hardware.h>
52 #include <asm/mach-types.h>
55 #include <mach/omap730.h> /* OMAP730_IO_CONF registers */
58 /* FIXME address is now a platform device resource,
59 * and irqs should show there too...
61 #define UWIRE_BASE_PHYS 0xFFFB3000
62 #define UWIRE_BASE ((void *__iomem)IO_ADDRESS(UWIRE_BASE_PHYS))
64 /* uWire Registers: */
65 #define UWIRE_IO_SIZE 0x20
66 #define UWIRE_TDR 0x00
67 #define UWIRE_RDR 0x00
68 #define UWIRE_CSR 0x01
69 #define UWIRE_SR1 0x02
70 #define UWIRE_SR2 0x03
71 #define UWIRE_SR3 0x04
72 #define UWIRE_SR4 0x05
73 #define UWIRE_SR5 0x06
76 #define RDRB (1 << 15)
77 #define CSRB (1 << 14)
78 #define START (1 << 13)
79 #define CS_CMD (1 << 12)
82 #define UWIRE_READ_FALLING_EDGE 0x0001
83 #define UWIRE_READ_RISING_EDGE 0x0000
84 #define UWIRE_WRITE_FALLING_EDGE 0x0000
85 #define UWIRE_WRITE_RISING_EDGE 0x0002
86 #define UWIRE_CS_ACTIVE_LOW 0x0000
87 #define UWIRE_CS_ACTIVE_HIGH 0x0004
88 #define UWIRE_FREQ_DIV_2 0x0000
89 #define UWIRE_FREQ_DIV_4 0x0008
90 #define UWIRE_FREQ_DIV_8 0x0010
91 #define UWIRE_CHK_READY 0x0020
92 #define UWIRE_CLK_INVERTED 0x0040
96 struct spi_bitbang bitbang;
101 unsigned bits_per_word;
105 /* REVISIT compile time constant for idx_shift? */
106 static unsigned int uwire_idx_shift;
108 static inline void uwire_write_reg(int idx, u16 val)
110 __raw_writew(val, UWIRE_BASE + (idx << uwire_idx_shift));
113 static inline u16 uwire_read_reg(int idx)
115 return __raw_readw(UWIRE_BASE + (idx << uwire_idx_shift));
118 static inline void omap_uwire_configure_mode(u8 cs, unsigned long flags)
123 if (flags & UWIRE_CLK_INVERTED)
135 w = uwire_read_reg(reg);
136 w &= ~(0x3f << shift);
138 uwire_write_reg(reg, w);
141 static int wait_uwire_csr_flag(u16 mask, u16 val, int might_not_catch)
145 unsigned long max_jiffies = jiffies + HZ;
148 w = uwire_read_reg(UWIRE_CSR);
149 if ((w & mask) == val)
151 if (time_after(jiffies, max_jiffies)) {
152 printk(KERN_ERR "%s: timeout. reg=%#06x "
153 "mask=%#06x val=%#06x\n",
154 __func__, w, mask, val);
158 if (might_not_catch && c > 64)
164 static void uwire_set_clk1_div(int div1_idx)
168 w = uwire_read_reg(UWIRE_SR3);
171 uwire_write_reg(UWIRE_SR3, w);
174 static void uwire_chipselect(struct spi_device *spi, int value)
176 struct uwire_state *ust = spi->controller_state;
181 BUG_ON(wait_uwire_csr_flag(CSRB, 0, 0));
183 w = uwire_read_reg(UWIRE_CSR);
184 old_cs = (w >> 10) & 0x03;
185 if (value == BITBANG_CS_INACTIVE || old_cs != spi->chip_select) {
186 /* Deselect this CS, or the previous CS */
188 uwire_write_reg(UWIRE_CSR, w);
190 /* activate specfied chipselect */
191 if (value == BITBANG_CS_ACTIVE) {
192 uwire_set_clk1_div(ust->div1_idx);
194 if (spi->mode & SPI_CPOL)
195 uwire_write_reg(UWIRE_SR4, 1);
197 uwire_write_reg(UWIRE_SR4, 0);
199 w = spi->chip_select << 10;
201 uwire_write_reg(UWIRE_CSR, w);
205 static int uwire_txrx(struct spi_device *spi, struct spi_transfer *t)
207 struct uwire_state *ust = spi->controller_state;
208 unsigned len = t->len;
209 unsigned bits = ust->bits_per_word;
214 if (!t->tx_buf && !t->rx_buf)
217 /* Microwire doesn't read and write concurrently */
218 if (t->tx_buf && t->rx_buf)
221 w = spi->chip_select << 10;
225 const u8 *buf = t->tx_buf;
227 /* NOTE: DMA could be used for TX transfers */
229 /* write one or two bytes at a time */
231 /* tx bit 15 is first sent; we byteswap multibyte words
232 * (msb-first) on the way out from memory.
243 pr_debug("%s: write-%d =%04x\n",
244 spi->dev.bus_id, bits, val);
246 if (wait_uwire_csr_flag(CSRB, 0, 0))
249 uwire_write_reg(UWIRE_TDR, val);
252 val = START | w | (bits << 5);
254 uwire_write_reg(UWIRE_CSR, val);
257 /* Wait till write actually starts.
258 * This is needed with MPU clock 60+ MHz.
259 * REVISIT: we may not have time to catch it...
261 if (wait_uwire_csr_flag(CSRB, CSRB, 1))
267 /* REVISIT: save this for later to get more i/o overlap */
268 if (wait_uwire_csr_flag(CSRB, 0, 0))
271 } else if (t->rx_buf) {
274 /* read one or two bytes at a time */
282 val = START | w | (bits << 0);
283 uwire_write_reg(UWIRE_CSR, val);
286 /* Wait till read actually starts */
287 (void) wait_uwire_csr_flag(CSRB, CSRB, 1);
289 if (wait_uwire_csr_flag(RDRB | CSRB,
293 /* rx bit 0 is last received; multibyte words will
294 * be properly byteswapped on the way to memory.
296 val = uwire_read_reg(UWIRE_RDR);
297 val &= (1 << bits) - 1;
303 pr_debug("%s: read-%d =%04x\n",
304 spi->dev.bus_id, bits, val);
314 static int uwire_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
316 struct uwire_state *ust = spi->controller_state;
317 struct uwire_spi *uwire;
327 uwire = spi_master_get_devdata(spi->master);
329 if (spi->chip_select > 3) {
330 pr_debug("%s: cs%d?\n", spi->dev.bus_id, spi->chip_select);
335 bits = spi->bits_per_word;
336 if (t != NULL && t->bits_per_word)
337 bits = t->bits_per_word;
342 pr_debug("%s: wordsize %d?\n", spi->dev.bus_id, bits);
346 ust->bits_per_word = bits;
348 /* mode 0..3, clock inverted separately;
349 * standard nCS signaling;
350 * don't treat DI=high as "not ready"
352 if (spi->mode & SPI_CS_HIGH)
353 flags |= UWIRE_CS_ACTIVE_HIGH;
355 if (spi->mode & SPI_CPOL)
356 flags |= UWIRE_CLK_INVERTED;
358 switch (spi->mode & (SPI_CPOL | SPI_CPHA)) {
361 flags |= UWIRE_WRITE_FALLING_EDGE | UWIRE_READ_RISING_EDGE;
365 flags |= UWIRE_WRITE_RISING_EDGE | UWIRE_READ_FALLING_EDGE;
369 /* assume it's already enabled */
370 rate = clk_get_rate(uwire->ck);
372 hz = spi->max_speed_hz;
373 if (t != NULL && t->speed_hz)
377 pr_debug("%s: zero speed?\n", spi->dev.bus_id);
382 /* F_INT = mpu_xor_clk / DIV1 */
383 for (div1_idx = 0; div1_idx < 4; div1_idx++) {
399 div2 = (rate / div1 + hz - 1) / hz;
404 pr_debug("%s: lowest clock %ld, need %d\n",
405 spi->dev.bus_id, rate / 10 / 8, hz);
410 /* we have to cache this and reset in uwire_chipselect as this is a
411 * global parameter and another uwire device can change it under
413 ust->div1_idx = div1_idx;
414 uwire_set_clk1_div(div1_idx);
422 flags |= UWIRE_FREQ_DIV_2;
427 flags |= UWIRE_FREQ_DIV_4;
434 flags |= UWIRE_FREQ_DIV_8;
438 omap_uwire_configure_mode(spi->chip_select, flags);
439 pr_debug("%s: uwire flags %02x, armxor %lu KHz, SCK %lu KHz\n",
441 clk_get_rate(uwire->ck) / 1000,
448 /* the spi->mode bits understood by this driver: */
449 #define MODEBITS (SPI_CPOL | SPI_CPHA | SPI_CS_HIGH)
451 static int uwire_setup(struct spi_device *spi)
453 struct uwire_state *ust = spi->controller_state;
455 if (spi->mode & ~MODEBITS) {
456 dev_dbg(&spi->dev, "setup: unsupported mode bits %x\n",
457 spi->mode & ~MODEBITS);
462 ust = kzalloc(sizeof(*ust), GFP_KERNEL);
465 spi->controller_state = ust;
468 return uwire_setup_transfer(spi, NULL);
471 static void uwire_cleanup(struct spi_device *spi)
473 kfree(spi->controller_state);
476 static void uwire_off(struct uwire_spi *uwire)
478 uwire_write_reg(UWIRE_SR3, 0);
479 clk_disable(uwire->ck);
481 spi_master_put(uwire->bitbang.master);
484 static int __init uwire_probe(struct platform_device *pdev)
486 struct spi_master *master;
487 struct uwire_spi *uwire;
490 master = spi_alloc_master(&pdev->dev, sizeof *uwire);
494 uwire = spi_master_get_devdata(master);
495 dev_set_drvdata(&pdev->dev, uwire);
497 uwire->ck = clk_get(&pdev->dev, "armxor_ck");
498 if (!uwire->ck || IS_ERR(uwire->ck)) {
499 dev_dbg(&pdev->dev, "no mpu_xor_clk ?\n");
500 spi_master_put(master);
503 clk_enable(uwire->ck);
505 if (cpu_is_omap730())
510 uwire_write_reg(UWIRE_SR3, 1);
512 master->bus_num = 2; /* "official" */
513 master->num_chipselect = 4;
514 master->setup = uwire_setup;
515 master->cleanup = uwire_cleanup;
517 uwire->bitbang.master = master;
518 uwire->bitbang.chipselect = uwire_chipselect;
519 uwire->bitbang.setup_transfer = uwire_setup_transfer;
520 uwire->bitbang.txrx_bufs = uwire_txrx;
522 status = spi_bitbang_start(&uwire->bitbang);
528 static int __exit uwire_remove(struct platform_device *pdev)
530 struct uwire_spi *uwire = dev_get_drvdata(&pdev->dev);
533 // FIXME remove all child devices, somewhere ...
535 status = spi_bitbang_stop(&uwire->bitbang);
540 /* work with hotplug and coldplug */
541 MODULE_ALIAS("platform:omap_uwire");
543 static struct platform_driver uwire_driver = {
545 .name = "omap_uwire",
546 .owner = THIS_MODULE,
548 .remove = __exit_p(uwire_remove),
549 // suspend ... unuse ck
553 static int __init omap_uwire_init(void)
555 /* FIXME move these into the relevant board init code. also, include
556 * H3 support; it uses tsc2101 like H2 (on a different chipselect).
559 if (machine_is_omap_h2()) {
560 /* defaults: W21 SDO, U18 SDI, V19 SCL */
561 omap_cfg_reg(N14_1610_UWIRE_CS0);
562 omap_cfg_reg(N15_1610_UWIRE_CS1);
564 if (machine_is_omap_perseus2()) {
565 /* configure pins: MPU_UW_nSCS1, MPU_UW_SDO, MPU_UW_SCLK */
566 int val = omap_readl(OMAP730_IO_CONF_9) & ~0x00EEE000;
567 omap_writel(val | 0x00AAA000, OMAP730_IO_CONF_9);
570 return platform_driver_probe(&uwire_driver, uwire_probe);
573 static void __exit omap_uwire_exit(void)
575 platform_driver_unregister(&uwire_driver);
578 subsys_initcall(omap_uwire_init);
579 module_exit(omap_uwire_exit);
581 MODULE_LICENSE("GPL");