1 From e75df4f96373e5d16f8ca13aa031e54cdcfeda62 Mon Sep 17 00:00:00 2001
2 From: John Crispin <blogic@openwrt.org>
3 Date: Wed, 13 Mar 2013 09:29:37 +0100
4 Subject: [PATCH 33/36] SPI: MIPS: lantiq: adds spi-xway
6 This patch adds support for the SPI core found on several Lantiq SoCs.
7 The Driver has been runtime tested in combination with m25p80 Flash Devices
10 Signed-off-by: Daniel Schwierzeck <daniel.schwierzeck@googlemail.com>
11 Signed-off-by: John Crispin <blogic@openwrt.org>
13 drivers/spi/Kconfig | 8 +
14 drivers/spi/Makefile | 1 +
15 drivers/spi/spi-xway.c | 977 ++++++++++++++++++++++++++++++++++++++++++++++++
16 3 files changed, 986 insertions(+)
17 create mode 100644 drivers/spi/spi-xway.c
19 --- a/drivers/spi/Kconfig
20 +++ b/drivers/spi/Kconfig
23 SPI driver for Nuvoton NUC900 series ARM SoCs
26 + tristate "Lantiq SPI controller"
30 + This driver supports the Lantiq SoC SPI controller in master
34 # Add new SPI master controllers in alphabetical order above this line
36 --- a/drivers/spi/Makefile
37 +++ b/drivers/spi/Makefile
39 obj-$(CONFIG_SPI_XCOMM) += spi-xcomm.o
40 obj-$(CONFIG_SPI_XILINX) += spi-xilinx.o
41 obj-$(CONFIG_SPI_XTENSA_XTFPGA) += spi-xtensa-xtfpga.o
42 +obj-$(CONFIG_SPI_XWAY) += spi-xway.o
44 +++ b/drivers/spi/spi-xway.c
47 + * Lantiq SoC SPI controller
49 + * Copyright (C) 2011 Daniel Schwierzeck <daniel.schwierzeck@googlemail.com>
50 + * Copyright (C) 2012 John Crispin <blogic@openwrt.org>
52 + * This program is free software; you can distribute it and/or modify it
53 + * under the terms of the GNU General Public License (Version 2) as
54 + * published by the Free Software Foundation.
57 +#include <linux/init.h>
58 +#include <linux/module.h>
59 +#include <linux/workqueue.h>
60 +#include <linux/platform_device.h>
61 +#include <linux/io.h>
62 +#include <linux/sched.h>
63 +#include <linux/delay.h>
64 +#include <linux/interrupt.h>
65 +#include <linux/completion.h>
66 +#include <linux/spinlock.h>
67 +#include <linux/err.h>
68 +#include <linux/clk.h>
69 +#include <linux/spi/spi.h>
70 +#include <linux/spi/spi_bitbang.h>
71 +#include <linux/of_irq.h>
73 +#include <lantiq_soc.h>
75 +#define LTQ_SPI_CLC 0x00 /* Clock control */
76 +#define LTQ_SPI_PISEL 0x04 /* Port input select */
77 +#define LTQ_SPI_ID 0x08 /* Identification */
78 +#define LTQ_SPI_CON 0x10 /* Control */
79 +#define LTQ_SPI_STAT 0x14 /* Status */
80 +#define LTQ_SPI_WHBSTATE 0x18 /* Write HW modified state */
81 +#define LTQ_SPI_TB 0x20 /* Transmit buffer */
82 +#define LTQ_SPI_RB 0x24 /* Receive buffer */
83 +#define LTQ_SPI_RXFCON 0x30 /* Receive FIFO control */
84 +#define LTQ_SPI_TXFCON 0x34 /* Transmit FIFO control */
85 +#define LTQ_SPI_FSTAT 0x38 /* FIFO status */
86 +#define LTQ_SPI_BRT 0x40 /* Baudrate timer */
87 +#define LTQ_SPI_BRSTAT 0x44 /* Baudrate timer status */
88 +#define LTQ_SPI_SFCON 0x60 /* Serial frame control */
89 +#define LTQ_SPI_SFSTAT 0x64 /* Serial frame status */
90 +#define LTQ_SPI_GPOCON 0x70 /* General purpose output control */
91 +#define LTQ_SPI_GPOSTAT 0x74 /* General purpose output status */
92 +#define LTQ_SPI_FGPO 0x78 /* Forced general purpose output */
93 +#define LTQ_SPI_RXREQ 0x80 /* Receive request */
94 +#define LTQ_SPI_RXCNT 0x84 /* Receive count */
95 +#define LTQ_SPI_DMACON 0xEC /* DMA control */
96 +#define LTQ_SPI_IRNEN 0xF4 /* Interrupt node enable */
97 +#define LTQ_SPI_IRNICR 0xF8 /* Interrupt node interrupt capture */
98 +#define LTQ_SPI_IRNCR 0xFC /* Interrupt node control */
100 +#define LTQ_SPI_CLC_SMC_SHIFT 16 /* Clock divider for sleep mode */
101 +#define LTQ_SPI_CLC_SMC_MASK 0xFF
102 +#define LTQ_SPI_CLC_RMC_SHIFT 8 /* Clock divider for normal run mode */
103 +#define LTQ_SPI_CLC_RMC_MASK 0xFF
104 +#define LTQ_SPI_CLC_DISS BIT(1) /* Disable status bit */
105 +#define LTQ_SPI_CLC_DISR BIT(0) /* Disable request bit */
107 +#define LTQ_SPI_ID_TXFS_SHIFT 24 /* Implemented TX FIFO size */
108 +#define LTQ_SPI_ID_TXFS_MASK 0x3F
109 +#define LTQ_SPI_ID_RXFS_SHIFT 16 /* Implemented RX FIFO size */
110 +#define LTQ_SPI_ID_RXFS_MASK 0x3F
111 +#define LTQ_SPI_ID_REV_MASK 0x1F /* Hardware revision number */
112 +#define LTQ_SPI_ID_CFG BIT(5) /* DMA interface support */
114 +#define LTQ_SPI_CON_BM_SHIFT 16 /* Data width selection */
115 +#define LTQ_SPI_CON_BM_MASK 0x1F
116 +#define LTQ_SPI_CON_EM BIT(24) /* Echo mode */
117 +#define LTQ_SPI_CON_IDLE BIT(23) /* Idle bit value */
118 +#define LTQ_SPI_CON_ENBV BIT(22) /* Enable byte valid control */
119 +#define LTQ_SPI_CON_RUEN BIT(12) /* Receive underflow error enable */
120 +#define LTQ_SPI_CON_TUEN BIT(11) /* Transmit underflow error enable */
121 +#define LTQ_SPI_CON_AEN BIT(10) /* Abort error enable */
122 +#define LTQ_SPI_CON_REN BIT(9) /* Receive overflow error enable */
123 +#define LTQ_SPI_CON_TEN BIT(8) /* Transmit overflow error enable */
124 +#define LTQ_SPI_CON_LB BIT(7) /* Loopback control */
125 +#define LTQ_SPI_CON_PO BIT(6) /* Clock polarity control */
126 +#define LTQ_SPI_CON_PH BIT(5) /* Clock phase control */
127 +#define LTQ_SPI_CON_HB BIT(4) /* Heading control */
128 +#define LTQ_SPI_CON_RXOFF BIT(1) /* Switch receiver off */
129 +#define LTQ_SPI_CON_TXOFF BIT(0) /* Switch transmitter off */
131 +#define LTQ_SPI_STAT_RXBV_MASK 0x7
132 +#define LTQ_SPI_STAT_RXBV_SHIFT 28
133 +#define LTQ_SPI_STAT_BSY BIT(13) /* Busy flag */
134 +#define LTQ_SPI_STAT_RUE BIT(12) /* Receive underflow error flag */
135 +#define LTQ_SPI_STAT_TUE BIT(11) /* Transmit underflow error flag */
136 +#define LTQ_SPI_STAT_AE BIT(10) /* Abort error flag */
137 +#define LTQ_SPI_STAT_RE BIT(9) /* Receive error flag */
138 +#define LTQ_SPI_STAT_TE BIT(8) /* Transmit error flag */
139 +#define LTQ_SPI_STAT_MS BIT(1) /* Master/slave select bit */
140 +#define LTQ_SPI_STAT_EN BIT(0) /* Enable bit */
142 +#define LTQ_SPI_WHBSTATE_SETTUE BIT(15) /* Set transmit underflow error flag */
143 +#define LTQ_SPI_WHBSTATE_SETAE BIT(14) /* Set abort error flag */
144 +#define LTQ_SPI_WHBSTATE_SETRE BIT(13) /* Set receive error flag */
145 +#define LTQ_SPI_WHBSTATE_SETTE BIT(12) /* Set transmit error flag */
146 +#define LTQ_SPI_WHBSTATE_CLRTUE BIT(11) /* Clear transmit underflow error
148 +#define LTQ_SPI_WHBSTATE_CLRAE BIT(10) /* Clear abort error flag */
149 +#define LTQ_SPI_WHBSTATE_CLRRE BIT(9) /* Clear receive error flag */
150 +#define LTQ_SPI_WHBSTATE_CLRTE BIT(8) /* Clear transmit error flag */
151 +#define LTQ_SPI_WHBSTATE_SETME BIT(7) /* Set mode error flag */
152 +#define LTQ_SPI_WHBSTATE_CLRME BIT(6) /* Clear mode error flag */
153 +#define LTQ_SPI_WHBSTATE_SETRUE BIT(5) /* Set receive underflow error flag */
154 +#define LTQ_SPI_WHBSTATE_CLRRUE BIT(4) /* Clear receive underflow error flag */
155 +#define LTQ_SPI_WHBSTATE_SETMS BIT(3) /* Set master select bit */
156 +#define LTQ_SPI_WHBSTATE_CLRMS BIT(2) /* Clear master select bit */
157 +#define LTQ_SPI_WHBSTATE_SETEN BIT(1) /* Set enable bit (operational mode) */
158 +#define LTQ_SPI_WHBSTATE_CLREN BIT(0) /* Clear enable bit (config mode */
159 +#define LTQ_SPI_WHBSTATE_CLR_ERRORS 0x0F50
161 +#define LTQ_SPI_RXFCON_RXFITL_SHIFT 8 /* FIFO interrupt trigger level */
162 +#define LTQ_SPI_RXFCON_RXFITL_MASK 0x3F
163 +#define LTQ_SPI_RXFCON_RXFLU BIT(1) /* FIFO flush */
164 +#define LTQ_SPI_RXFCON_RXFEN BIT(0) /* FIFO enable */
166 +#define LTQ_SPI_TXFCON_TXFITL_SHIFT 8 /* FIFO interrupt trigger level */
167 +#define LTQ_SPI_TXFCON_TXFITL_MASK 0x3F
168 +#define LTQ_SPI_TXFCON_TXFLU BIT(1) /* FIFO flush */
169 +#define LTQ_SPI_TXFCON_TXFEN BIT(0) /* FIFO enable */
171 +#define LTQ_SPI_FSTAT_RXFFL_MASK 0x3f
172 +#define LTQ_SPI_FSTAT_RXFFL_SHIFT 0
173 +#define LTQ_SPI_FSTAT_TXFFL_MASK 0x3f
174 +#define LTQ_SPI_FSTAT_TXFFL_SHIFT 8
176 +#define LTQ_SPI_GPOCON_ISCSBN_SHIFT 8
177 +#define LTQ_SPI_GPOCON_INVOUTN_SHIFT 0
179 +#define LTQ_SPI_FGPO_SETOUTN_SHIFT 8
180 +#define LTQ_SPI_FGPO_CLROUTN_SHIFT 0
182 +#define LTQ_SPI_RXREQ_RXCNT_MASK 0xFFFF /* Receive count value */
183 +#define LTQ_SPI_RXCNT_TODO_MASK 0xFFFF /* Recevie to-do value */
185 +#define LTQ_SPI_IRNEN_F BIT(3) /* Frame end interrupt request */
186 +#define LTQ_SPI_IRNEN_E BIT(2) /* Error end interrupt request */
187 +#define LTQ_SPI_IRNEN_T BIT(0) /* Transmit end interrupt request */
188 +#define LTQ_SPI_IRNEN_R BIT(1) /* Receive end interrupt request */
189 +#define LTQ_SPI_IRNEN_T_XWAY BIT(1) /* Transmit end interrupt request */
190 +#define LTQ_SPI_IRNEN_R_XWAY BIT(0) /* Receive end interrupt request */
191 +#define LTQ_SPI_IRNEN_ALL 0xF
194 + struct spi_bitbang bitbang;
195 + struct completion done;
198 + struct device *dev;
199 + void __iomem *base;
200 + struct clk *fpiclk;
201 + struct clk *spiclk;
211 + struct spi_transfer *curr_transfer;
213 + u32 (*get_tx) (struct ltq_spi *);
217 + unsigned dma_support:1;
218 + unsigned cfg_mode:1;
224 +static inline struct ltq_spi *ltq_spi_to_hw(struct spi_device *spi)
226 + return spi_master_get_devdata(spi->master);
229 +static inline u32 ltq_spi_reg_read(struct ltq_spi *hw, u32 reg)
231 + return ioread32be(hw->base + reg);
234 +static inline void ltq_spi_reg_write(struct ltq_spi *hw, u32 val, u32 reg)
236 + iowrite32be(val, hw->base + reg);
239 +static inline void ltq_spi_reg_setbit(struct ltq_spi *hw, u32 bits, u32 reg)
243 + val = ltq_spi_reg_read(hw, reg);
245 + ltq_spi_reg_write(hw, val, reg);
248 +static inline void ltq_spi_reg_clearbit(struct ltq_spi *hw, u32 bits, u32 reg)
252 + val = ltq_spi_reg_read(hw, reg);
254 + ltq_spi_reg_write(hw, val, reg);
257 +static void ltq_spi_hw_enable(struct ltq_spi *hw)
261 + /* Power-up module */
262 + clk_enable(hw->spiclk);
265 + * Set clock divider for run mode to 1 to
266 + * run at same frequency as FPI bus
268 + clc = (1 << LTQ_SPI_CLC_RMC_SHIFT);
269 + ltq_spi_reg_write(hw, clc, LTQ_SPI_CLC);
272 +static void ltq_spi_hw_disable(struct ltq_spi *hw)
274 + /* Set clock divider to 0 and set module disable bit */
275 + ltq_spi_reg_write(hw, LTQ_SPI_CLC_DISS, LTQ_SPI_CLC);
277 + /* Power-down module */
278 + clk_disable(hw->spiclk);
281 +static void ltq_spi_reset_fifos(struct ltq_spi *hw)
286 + * Enable and flush FIFOs. Set interrupt trigger level to
287 + * half of FIFO count implemented in hardware.
289 + if (hw->txfs > 1) {
290 + val = hw->txfs << (LTQ_SPI_TXFCON_TXFITL_SHIFT - 1);
291 + val |= LTQ_SPI_TXFCON_TXFEN | LTQ_SPI_TXFCON_TXFLU;
292 + ltq_spi_reg_write(hw, val, LTQ_SPI_TXFCON);
295 + if (hw->rxfs > 1) {
296 + val = hw->rxfs << (LTQ_SPI_RXFCON_RXFITL_SHIFT - 1);
297 + val |= LTQ_SPI_RXFCON_RXFEN | LTQ_SPI_RXFCON_RXFLU;
298 + ltq_spi_reg_write(hw, val, LTQ_SPI_RXFCON);
302 +static inline int ltq_spi_wait_ready(struct ltq_spi *hw)
305 + unsigned long timeout;
307 + timeout = jiffies + msecs_to_jiffies(200);
310 + stat = ltq_spi_reg_read(hw, LTQ_SPI_STAT);
311 + if (!(stat & LTQ_SPI_STAT_BSY))
315 + } while (!time_after_eq(jiffies, timeout));
317 + dev_err(hw->dev, "SPI wait ready timed out stat: %x\n", stat);
322 +static void ltq_spi_config_mode_set(struct ltq_spi *hw)
328 + * Putting the SPI module in config mode is only safe if no
329 + * transfer is in progress as indicated by busy flag STATE.BSY.
331 + if (ltq_spi_wait_ready(hw)) {
332 + ltq_spi_reset_fifos(hw);
333 + hw->status = -ETIMEDOUT;
335 + ltq_spi_reg_write(hw, LTQ_SPI_WHBSTATE_CLREN, LTQ_SPI_WHBSTATE);
340 +static void ltq_spi_run_mode_set(struct ltq_spi *hw)
345 + ltq_spi_reg_write(hw, LTQ_SPI_WHBSTATE_SETEN, LTQ_SPI_WHBSTATE);
350 +static u32 ltq_spi_tx_word_u8(struct ltq_spi *hw)
352 + const u8 *tx = hw->tx;
361 +static u32 ltq_spi_tx_word_u16(struct ltq_spi *hw)
363 + const u16 *tx = (u16 *) hw->tx;
372 +static u32 ltq_spi_tx_word_u32(struct ltq_spi *hw)
374 + const u32 *tx = (u32 *) hw->tx;
383 +static void ltq_spi_bits_per_word_set(struct spi_device *spi)
385 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
387 + u8 bits_per_word = spi->bits_per_word;
390 + * Use either default value of SPI device or value
391 + * from current transfer.
393 + if (hw->curr_transfer && hw->curr_transfer->bits_per_word)
394 + bits_per_word = hw->curr_transfer->bits_per_word;
396 + if (bits_per_word <= 8)
397 + hw->get_tx = ltq_spi_tx_word_u8;
398 + else if (bits_per_word <= 16)
399 + hw->get_tx = ltq_spi_tx_word_u16;
400 + else if (bits_per_word <= 32)
401 + hw->get_tx = ltq_spi_tx_word_u32;
403 + /* CON.BM value = bits_per_word - 1 */
404 + bm = (bits_per_word - 1) << LTQ_SPI_CON_BM_SHIFT;
406 + ltq_spi_reg_clearbit(hw, LTQ_SPI_CON_BM_MASK <<
407 + LTQ_SPI_CON_BM_SHIFT, LTQ_SPI_CON);
408 + ltq_spi_reg_setbit(hw, bm, LTQ_SPI_CON);
411 +static void ltq_spi_speed_set(struct spi_device *spi)
413 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
414 + u32 br, max_speed_hz, spi_clk;
415 + u32 speed_hz = spi->max_speed_hz;
418 + * Use either default value of SPI device or value
419 + * from current transfer.
421 + if (hw->curr_transfer && hw->curr_transfer->speed_hz)
422 + speed_hz = hw->curr_transfer->speed_hz;
425 + * SPI module clock is derived from FPI bus clock dependent on
426 + * divider value in CLC.RMS which is always set to 1.
428 + spi_clk = clk_get_rate(hw->fpiclk);
431 + * Maximum SPI clock frequency in master mode is half of
432 + * SPI module clock frequency. Maximum reload value of
433 + * baudrate generator BR is 2^16.
435 + max_speed_hz = spi_clk / 2;
436 + if (speed_hz >= max_speed_hz)
439 + br = (max_speed_hz / speed_hz) - 1;
444 + ltq_spi_reg_write(hw, br, LTQ_SPI_BRT);
447 +static void ltq_spi_clockmode_set(struct spi_device *spi)
449 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
452 + con = ltq_spi_reg_read(hw, LTQ_SPI_CON);
455 + * SPI mode mapping in CON register:
456 + * Mode CPOL CPHA CON.PO CON.PH
462 + if (spi->mode & SPI_CPHA)
463 + con &= ~LTQ_SPI_CON_PH;
465 + con |= LTQ_SPI_CON_PH;
467 + if (spi->mode & SPI_CPOL)
468 + con |= LTQ_SPI_CON_PO;
470 + con &= ~LTQ_SPI_CON_PO;
472 + /* Set heading control */
473 + if (spi->mode & SPI_LSB_FIRST)
474 + con &= ~LTQ_SPI_CON_HB;
476 + con |= LTQ_SPI_CON_HB;
478 + ltq_spi_reg_write(hw, con, LTQ_SPI_CON);
481 +static void ltq_spi_xmit_set(struct ltq_spi *hw, struct spi_transfer *t)
485 + con = ltq_spi_reg_read(hw, LTQ_SPI_CON);
488 + if (t->tx_buf && t->rx_buf) {
489 + con &= ~(LTQ_SPI_CON_TXOFF | LTQ_SPI_CON_RXOFF);
490 + } else if (t->rx_buf) {
491 + con &= ~LTQ_SPI_CON_RXOFF;
492 + con |= LTQ_SPI_CON_TXOFF;
493 + } else if (t->tx_buf) {
494 + con &= ~LTQ_SPI_CON_TXOFF;
495 + con |= LTQ_SPI_CON_RXOFF;
498 + con |= (LTQ_SPI_CON_TXOFF | LTQ_SPI_CON_RXOFF);
500 + ltq_spi_reg_write(hw, con, LTQ_SPI_CON);
503 +static void ltq_spi_internal_cs_activate(struct spi_device *spi)
505 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
508 + fgpo = (1 << (spi->chip_select + LTQ_SPI_FGPO_CLROUTN_SHIFT));
509 + ltq_spi_reg_setbit(hw, fgpo, LTQ_SPI_FGPO);
512 +static void ltq_spi_internal_cs_deactivate(struct spi_device *spi)
514 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
517 + fgpo = (1 << (spi->chip_select + LTQ_SPI_FGPO_SETOUTN_SHIFT));
518 + ltq_spi_reg_setbit(hw, fgpo, LTQ_SPI_FGPO);
521 +static void ltq_spi_chipselect(struct spi_device *spi, int cs)
523 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
525 + if (ltq_spi_wait_ready(hw))
526 + dev_err(&spi->dev, "wait failed\n");
529 + case BITBANG_CS_ACTIVE:
530 + ltq_spi_bits_per_word_set(spi);
531 + ltq_spi_speed_set(spi);
532 + ltq_spi_clockmode_set(spi);
533 + ltq_spi_run_mode_set(hw);
534 + ltq_spi_internal_cs_activate(spi);
537 + case BITBANG_CS_INACTIVE:
538 + ltq_spi_internal_cs_deactivate(spi);
539 + ltq_spi_config_mode_set(hw);
544 +static int ltq_spi_setup_transfer(struct spi_device *spi,
545 + struct spi_transfer *t)
547 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
548 + u8 bits_per_word = spi->bits_per_word;
550 + hw->curr_transfer = t;
552 + if (t && t->bits_per_word)
553 + bits_per_word = t->bits_per_word;
555 + if (bits_per_word > 32)
561 +static int ltq_spi_setup(struct spi_device *spi)
563 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
566 + /* Set default word length to 8 if not set */
567 + if (!spi->bits_per_word)
568 + spi->bits_per_word = 8;
570 + if (spi->bits_per_word > 32)
574 + * Up to six GPIOs can be connected to the SPI module
575 + * via GPIO alternate function to control the chip select lines.
577 + gpocon = (1 << (spi->chip_select +
578 + LTQ_SPI_GPOCON_ISCSBN_SHIFT));
580 + if (spi->mode & SPI_CS_HIGH)
581 + gpocon |= (1 << spi->chip_select);
583 + fgpo = (1 << (spi->chip_select + LTQ_SPI_FGPO_SETOUTN_SHIFT));
585 + ltq_spi_reg_setbit(hw, gpocon, LTQ_SPI_GPOCON);
586 + ltq_spi_reg_setbit(hw, fgpo, LTQ_SPI_FGPO);
591 +static void ltq_spi_cleanup(struct spi_device *spi)
596 +static void ltq_spi_txfifo_write(struct ltq_spi *hw)
601 + /* Determine how much FIFOs are free for TX data */
602 + fstat = ltq_spi_reg_read(hw, LTQ_SPI_FSTAT);
603 + fifo_space = hw->txfs - ((fstat >> LTQ_SPI_FSTAT_TXFFL_SHIFT) &
604 + LTQ_SPI_FSTAT_TXFFL_MASK);
609 + while (hw->tx_cnt < hw->len && fifo_space) {
610 + data = hw->get_tx(hw);
611 + ltq_spi_reg_write(hw, data, LTQ_SPI_TB);
616 +static void ltq_spi_rxfifo_read(struct ltq_spi *hw)
618 + u32 fstat, data, *rx32;
620 + u8 rxbv, shift, *rx8;
622 + /* Determine how much FIFOs are filled with RX data */
623 + fstat = ltq_spi_reg_read(hw, LTQ_SPI_FSTAT);
624 + fifo_fill = ((fstat >> LTQ_SPI_FSTAT_RXFFL_SHIFT)
625 + & LTQ_SPI_FSTAT_RXFFL_MASK);
631 + * The 32 bit FIFO is always used completely independent from the
632 + * bits_per_word value. Thus four bytes have to be read at once
635 + rx32 = (u32 *) hw->rx;
636 + while (hw->len - hw->rx_cnt >= 4 && fifo_fill) {
637 + *rx32++ = ltq_spi_reg_read(hw, LTQ_SPI_RB);
644 + * If there are remaining bytes, read byte count from STAT.RXBV
645 + * register and read the data byte-wise.
647 + while (fifo_fill && hw->rx_cnt < hw->len) {
648 + rxbv = (ltq_spi_reg_read(hw, LTQ_SPI_STAT) >>
649 + LTQ_SPI_STAT_RXBV_SHIFT) & LTQ_SPI_STAT_RXBV_MASK;
650 + data = ltq_spi_reg_read(hw, LTQ_SPI_RB);
652 + shift = (rxbv - 1) * 8;
656 + *rx8++ = (data >> shift) & 0xFF;
667 +static void ltq_spi_rxreq_set(struct ltq_spi *hw)
669 + u32 rxreq, rxreq_max, rxtodo;
671 + rxtodo = ltq_spi_reg_read(hw, LTQ_SPI_RXCNT) & LTQ_SPI_RXCNT_TODO_MASK;
674 + * In RX-only mode the serial clock is activated only after writing
675 + * the expected amount of RX bytes into RXREQ register.
676 + * To avoid receive overflows at high clocks it is better to request
677 + * only the amount of bytes that fits into all FIFOs. This value
678 + * depends on the FIFO size implemented in hardware.
680 + rxreq = hw->len - hw->rx_cnt;
681 + rxreq_max = hw->rxfs << 2;
682 + rxreq = min(rxreq_max, rxreq);
684 + if (!rxtodo && rxreq)
685 + ltq_spi_reg_write(hw, rxreq, LTQ_SPI_RXREQ);
688 +static inline void ltq_spi_complete(struct ltq_spi *hw)
690 + complete(&hw->done);
693 +irqreturn_t ltq_spi_tx_irq(int irq, void *data)
695 + struct ltq_spi *hw = data;
696 + unsigned long flags;
699 + spin_lock_irqsave(&hw->lock, flags);
701 + if (hw->tx_cnt < hw->len)
702 + ltq_spi_txfifo_write(hw);
704 + if (hw->tx_cnt == hw->len)
707 + spin_unlock_irqrestore(&hw->lock, flags);
710 + ltq_spi_complete(hw);
712 + return IRQ_HANDLED;
715 +irqreturn_t ltq_spi_rx_irq(int irq, void *data)
717 + struct ltq_spi *hw = data;
718 + unsigned long flags;
721 + spin_lock_irqsave(&hw->lock, flags);
723 + if (hw->rx_cnt < hw->len) {
724 + ltq_spi_rxfifo_read(hw);
726 + if (hw->tx && hw->tx_cnt < hw->len)
727 + ltq_spi_txfifo_write(hw);
730 + if (hw->rx_cnt == hw->len)
733 + ltq_spi_rxreq_set(hw);
735 + spin_unlock_irqrestore(&hw->lock, flags);
738 + ltq_spi_complete(hw);
740 + return IRQ_HANDLED;
743 +irqreturn_t ltq_spi_err_irq(int irq, void *data)
745 + struct ltq_spi *hw = data;
746 + unsigned long flags;
748 + spin_lock_irqsave(&hw->lock, flags);
750 + /* Disable all interrupts */
751 + ltq_spi_reg_clearbit(hw, LTQ_SPI_IRNEN_ALL, LTQ_SPI_IRNEN);
753 + dev_err(hw->dev, "error %x\n", ltq_spi_reg_read(hw, LTQ_SPI_STAT));
755 + /* Clear all error flags */
756 + ltq_spi_reg_write(hw, LTQ_SPI_WHBSTATE_CLR_ERRORS, LTQ_SPI_WHBSTATE);
759 + ltq_spi_reg_setbit(hw, LTQ_SPI_RXFCON_RXFLU, LTQ_SPI_RXFCON);
760 + ltq_spi_reg_setbit(hw, LTQ_SPI_TXFCON_TXFLU, LTQ_SPI_TXFCON);
763 + spin_unlock_irqrestore(&hw->lock, flags);
765 + ltq_spi_complete(hw);
767 + return IRQ_HANDLED;
770 +static int ltq_spi_txrx_bufs(struct spi_device *spi, struct spi_transfer *t)
772 + struct ltq_spi *hw = ltq_spi_to_hw(spi);
775 + hw->tx = t->tx_buf;
776 + hw->rx = t->rx_buf;
781 + init_completion(&hw->done);
783 + ltq_spi_xmit_set(hw, t);
785 + /* Enable error interrupts */
786 + ltq_spi_reg_setbit(hw, LTQ_SPI_IRNEN_E, LTQ_SPI_IRNEN);
789 + /* Initially fill TX FIFO with as much data as possible */
790 + ltq_spi_txfifo_write(hw);
791 + irq_flags |= hw->irnen_t;
793 + /* Always enable RX interrupt in Full Duplex mode */
795 + irq_flags |= hw->irnen_r;
796 + } else if (hw->rx) {
797 + /* Start RX clock */
798 + ltq_spi_rxreq_set(hw);
800 + /* Enable RX interrupt to receive data from RX FIFOs */
801 + irq_flags |= hw->irnen_r;
804 + /* Enable TX or RX interrupts */
805 + ltq_spi_reg_setbit(hw, irq_flags, LTQ_SPI_IRNEN);
806 + wait_for_completion_interruptible(&hw->done);
808 + /* Disable all interrupts */
809 + ltq_spi_reg_clearbit(hw, LTQ_SPI_IRNEN_ALL, LTQ_SPI_IRNEN);
812 + * Return length of current transfer for bitbang utility code if
813 + * no errors occured during transmission.
816 + hw->status = hw->len;
821 +static const struct ltq_spi_irq_map {
823 + irq_handler_t handler;
824 +} ltq_spi_irqs[] = {
825 + { "spi_rx", ltq_spi_rx_irq },
826 + { "spi_tx", ltq_spi_tx_irq },
827 + { "spi_err", ltq_spi_err_irq },
830 +static int ltq_spi_probe(struct platform_device *pdev)
832 + struct resource irqres[3];
833 + struct spi_master *master;
834 + struct resource *r;
835 + struct ltq_spi *hw;
839 + if (of_irq_to_resource_table(pdev->dev.of_node, irqres, 3) != 3) {
840 + dev_err(&pdev->dev, "IRQ settings missing in device tree\n");
844 + master = spi_alloc_master(&pdev->dev, sizeof(struct ltq_spi));
846 + dev_err(&pdev->dev, "spi_alloc_master\n");
851 + hw = spi_master_get_devdata(master);
853 + r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
855 + dev_err(&pdev->dev, "platform_get_resource\n");
860 + r = devm_request_mem_region(&pdev->dev, r->start, resource_size(r),
863 + dev_err(&pdev->dev, "failed to request memory region\n");
868 + hw->base = devm_ioremap_nocache(&pdev->dev, r->start, resource_size(r));
870 + dev_err(&pdev->dev, "failed to remap memory region\n");
875 + memset(hw->irq, 0, sizeof(hw->irq));
876 + for (i = 0; i < ARRAY_SIZE(ltq_spi_irqs); i++) {
877 + hw->irq[i] = irqres[i].start;
878 + ret = request_irq(hw->irq[i], ltq_spi_irqs[i].handler,
879 + 0, ltq_spi_irqs[i].name, hw);
881 + dev_err(&pdev->dev, "failed to request %s irq (%d)\n",
882 + ltq_spi_irqs[i].name, hw->irq[i]);
887 + hw->fpiclk = clk_get_fpi();
888 + if (IS_ERR(hw->fpiclk)) {
889 + dev_err(&pdev->dev, "failed to get fpi clock\n");
890 + ret = PTR_ERR(hw->fpiclk);
894 + hw->spiclk = clk_get(&pdev->dev, NULL);
895 + if (IS_ERR(hw->spiclk)) {
896 + dev_err(&pdev->dev, "failed to get spi clock gate\n");
897 + ret = PTR_ERR(hw->spiclk);
901 + hw->bitbang.master = spi_master_get(master);
902 + hw->bitbang.chipselect = ltq_spi_chipselect;
903 + hw->bitbang.setup_transfer = ltq_spi_setup_transfer;
904 + hw->bitbang.txrx_bufs = ltq_spi_txrx_bufs;
906 + if (of_machine_is_compatible("lantiq,ase")) {
907 + master->num_chipselect = 3;
909 + hw->irnen_t = LTQ_SPI_IRNEN_T_XWAY;
910 + hw->irnen_r = LTQ_SPI_IRNEN_R_XWAY;
912 + master->num_chipselect = 6;
914 + hw->irnen_t = LTQ_SPI_IRNEN_T;
915 + hw->irnen_r = LTQ_SPI_IRNEN_R;
918 + master->bus_num = pdev->id;
919 + master->setup = ltq_spi_setup;
920 + master->cleanup = ltq_spi_cleanup;
921 + master->dev.of_node = pdev->dev.of_node;
923 + hw->dev = &pdev->dev;
924 + init_completion(&hw->done);
925 + spin_lock_init(&hw->lock);
927 + ltq_spi_hw_enable(hw);
929 + /* Read module capabilities */
930 + id = ltq_spi_reg_read(hw, LTQ_SPI_ID);
931 + hw->txfs = (id >> LTQ_SPI_ID_TXFS_SHIFT) & LTQ_SPI_ID_TXFS_MASK;
932 + hw->rxfs = (id >> LTQ_SPI_ID_RXFS_SHIFT) & LTQ_SPI_ID_RXFS_MASK;
933 + hw->dma_support = (id & LTQ_SPI_ID_CFG) ? 1 : 0;
935 + ltq_spi_config_mode_set(hw);
937 + /* Enable error checking, disable TX/RX, set idle value high */
938 + data = LTQ_SPI_CON_RUEN | LTQ_SPI_CON_AEN |
939 + LTQ_SPI_CON_TEN | LTQ_SPI_CON_REN |
940 + LTQ_SPI_CON_TXOFF | LTQ_SPI_CON_RXOFF | LTQ_SPI_CON_IDLE;
941 + ltq_spi_reg_write(hw, data, LTQ_SPI_CON);
943 + /* Enable master mode and clear error flags */
944 + ltq_spi_reg_write(hw, LTQ_SPI_WHBSTATE_SETMS |
945 + LTQ_SPI_WHBSTATE_CLR_ERRORS, LTQ_SPI_WHBSTATE);
947 + /* Reset GPIO/CS registers */
948 + ltq_spi_reg_write(hw, 0x0, LTQ_SPI_GPOCON);
949 + ltq_spi_reg_write(hw, 0xFF00, LTQ_SPI_FGPO);
951 + /* Enable and flush FIFOs */
952 + ltq_spi_reset_fifos(hw);
954 + ret = spi_bitbang_start(&hw->bitbang);
956 + dev_err(&pdev->dev, "spi_bitbang_start failed\n");
960 + platform_set_drvdata(pdev, hw);
962 + pr_info("Lantiq SoC SPI controller rev %u (TXFS %u, RXFS %u, DMA %u)\n",
963 + id & LTQ_SPI_ID_REV_MASK, hw->txfs, hw->rxfs, hw->dma_support);
968 + ltq_spi_hw_disable(hw);
972 + clk_put(hw->fpiclk);
974 + clk_put(hw->spiclk);
977 + clk_put(hw->fpiclk);
980 + free_irq(hw->irq[i], hw);
983 + spi_master_put(master);
989 +static int ltq_spi_remove(struct platform_device *pdev)
991 + struct ltq_spi *hw = platform_get_drvdata(pdev);
994 + spi_bitbang_stop(&hw->bitbang);
996 + platform_set_drvdata(pdev, NULL);
998 + ltq_spi_config_mode_set(hw);
999 + ltq_spi_hw_disable(hw);
1001 + for (i = 0; i < ARRAY_SIZE(hw->irq); i++)
1002 + if (0 < hw->irq[i])
1003 + free_irq(hw->irq[i], hw);
1006 + clk_put(hw->fpiclk);
1008 + clk_put(hw->spiclk);
1010 + spi_master_put(hw->bitbang.master);
1015 +static const struct of_device_id ltq_spi_match[] = {
1016 + { .compatible = "lantiq,spi-xway" },
1019 +MODULE_DEVICE_TABLE(of, ltq_spi_match);
1021 +static struct platform_driver ltq_spi_driver = {
1022 + .probe = ltq_spi_probe,
1023 + .remove = ltq_spi_remove,
1025 + .name = "spi-xway",
1026 + .owner = THIS_MODULE,
1027 + .of_match_table = ltq_spi_match,
1031 +module_platform_driver(ltq_spi_driver);
1033 +MODULE_DESCRIPTION("Lantiq SoC SPI controller driver");
1034 +MODULE_AUTHOR("Daniel Schwierzeck <daniel.schwierzeck@googlemail.com>");
1035 +MODULE_LICENSE("GPL");
1036 +MODULE_ALIAS("platform:spi-xway");