4 * Copyright (C) 2012, 2013 Renesas Solutions Corp.
7 * Copyright (C) 2011 Renesas Solutions Corp.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; version 2 of the License.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/sched.h>
27 #include <linux/errno.h>
28 #include <linux/interrupt.h>
29 #include <linux/platform_device.h>
31 #include <linux/clk.h>
32 #include <linux/dmaengine.h>
33 #include <linux/dma-mapping.h>
34 #include <linux/of_device.h>
35 #include <linux/sh_dma.h>
36 #include <linux/spi/spi.h>
37 #include <linux/spi/rspi.h>
39 #define RSPI_SPCR 0x00 /* Control Register */
40 #define RSPI_SSLP 0x01 /* Slave Select Polarity Register */
41 #define RSPI_SPPCR 0x02 /* Pin Control Register */
42 #define RSPI_SPSR 0x03 /* Status Register */
43 #define RSPI_SPDR 0x04 /* Data Register */
44 #define RSPI_SPSCR 0x08 /* Sequence Control Register */
45 #define RSPI_SPSSR 0x09 /* Sequence Status Register */
46 #define RSPI_SPBR 0x0a /* Bit Rate Register */
47 #define RSPI_SPDCR 0x0b /* Data Control Register */
48 #define RSPI_SPCKD 0x0c /* Clock Delay Register */
49 #define RSPI_SSLND 0x0d /* Slave Select Negation Delay Register */
50 #define RSPI_SPND 0x0e /* Next-Access Delay Register */
51 #define RSPI_SPCR2 0x0f /* Control Register 2 (SH only) */
52 #define RSPI_SPCMD0 0x10 /* Command Register 0 */
53 #define RSPI_SPCMD1 0x12 /* Command Register 1 */
54 #define RSPI_SPCMD2 0x14 /* Command Register 2 */
55 #define RSPI_SPCMD3 0x16 /* Command Register 3 */
56 #define RSPI_SPCMD4 0x18 /* Command Register 4 */
57 #define RSPI_SPCMD5 0x1a /* Command Register 5 */
58 #define RSPI_SPCMD6 0x1c /* Command Register 6 */
59 #define RSPI_SPCMD7 0x1e /* Command Register 7 */
62 #define RSPI_SPBFCR 0x20 /* Buffer Control Register */
63 #define RSPI_SPBFDR 0x22 /* Buffer Data Count Setting Register */
66 #define QSPI_SPBFCR 0x18 /* Buffer Control Register */
67 #define QSPI_SPBDCR 0x1a /* Buffer Data Count Register */
68 #define QSPI_SPBMUL0 0x1c /* Transfer Data Length Multiplier Setting Register 0 */
69 #define QSPI_SPBMUL1 0x20 /* Transfer Data Length Multiplier Setting Register 1 */
70 #define QSPI_SPBMUL2 0x24 /* Transfer Data Length Multiplier Setting Register 2 */
71 #define QSPI_SPBMUL3 0x28 /* Transfer Data Length Multiplier Setting Register 3 */
73 /* SPCR - Control Register */
74 #define SPCR_SPRIE 0x80 /* Receive Interrupt Enable */
75 #define SPCR_SPE 0x40 /* Function Enable */
76 #define SPCR_SPTIE 0x20 /* Transmit Interrupt Enable */
77 #define SPCR_SPEIE 0x10 /* Error Interrupt Enable */
78 #define SPCR_MSTR 0x08 /* Master/Slave Mode Select */
79 #define SPCR_MODFEN 0x04 /* Mode Fault Error Detection Enable */
81 #define SPCR_TXMD 0x02 /* TX Only Mode (vs. Full Duplex) */
82 #define SPCR_SPMS 0x01 /* 3-wire Mode (vs. 4-wire) */
83 /* QSPI on R-Car M2 only */
84 #define SPCR_WSWAP 0x02 /* Word Swap of read-data for DMAC */
85 #define SPCR_BSWAP 0x01 /* Byte Swap of read-data for DMAC */
87 /* SSLP - Slave Select Polarity Register */
88 #define SSLP_SSL1P 0x02 /* SSL1 Signal Polarity Setting */
89 #define SSLP_SSL0P 0x01 /* SSL0 Signal Polarity Setting */
91 /* SPPCR - Pin Control Register */
92 #define SPPCR_MOIFE 0x20 /* MOSI Idle Value Fixing Enable */
93 #define SPPCR_MOIFV 0x10 /* MOSI Idle Fixed Value */
94 #define SPPCR_SPOM 0x04
95 #define SPPCR_SPLP2 0x02 /* Loopback Mode 2 (non-inverting) */
96 #define SPPCR_SPLP 0x01 /* Loopback Mode (inverting) */
98 #define SPPCR_IO3FV 0x04 /* Single-/Dual-SPI Mode IO3 Output Fixed Value */
99 #define SPPCR_IO2FV 0x04 /* Single-/Dual-SPI Mode IO2 Output Fixed Value */
101 /* SPSR - Status Register */
102 #define SPSR_SPRF 0x80 /* Receive Buffer Full Flag */
103 #define SPSR_TEND 0x40 /* Transmit End */
104 #define SPSR_SPTEF 0x20 /* Transmit Buffer Empty Flag */
105 #define SPSR_PERF 0x08 /* Parity Error Flag */
106 #define SPSR_MODF 0x04 /* Mode Fault Error Flag */
107 #define SPSR_IDLNF 0x02 /* RSPI Idle Flag */
108 #define SPSR_OVRF 0x01 /* Overrun Error Flag (RSPI only) */
110 /* SPSCR - Sequence Control Register */
111 #define SPSCR_SPSLN_MASK 0x07 /* Sequence Length Specification */
113 /* SPSSR - Sequence Status Register */
114 #define SPSSR_SPECM_MASK 0x70 /* Command Error Mask */
115 #define SPSSR_SPCP_MASK 0x07 /* Command Pointer Mask */
117 /* SPDCR - Data Control Register */
118 #define SPDCR_TXDMY 0x80 /* Dummy Data Transmission Enable */
119 #define SPDCR_SPLW1 0x40 /* Access Width Specification (RZ) */
120 #define SPDCR_SPLW0 0x20 /* Access Width Specification (RZ) */
121 #define SPDCR_SPLLWORD (SPDCR_SPLW1 | SPDCR_SPLW0)
122 #define SPDCR_SPLWORD SPDCR_SPLW1
123 #define SPDCR_SPLBYTE SPDCR_SPLW0
124 #define SPDCR_SPLW 0x20 /* Access Width Specification (SH) */
125 #define SPDCR_SPRDTD 0x10 /* Receive Transmit Data Select (SH) */
126 #define SPDCR_SLSEL1 0x08
127 #define SPDCR_SLSEL0 0x04
128 #define SPDCR_SLSEL_MASK 0x0c /* SSL1 Output Select (SH) */
129 #define SPDCR_SPFC1 0x02
130 #define SPDCR_SPFC0 0x01
131 #define SPDCR_SPFC_MASK 0x03 /* Frame Count Setting (1-4) (SH) */
133 /* SPCKD - Clock Delay Register */
134 #define SPCKD_SCKDL_MASK 0x07 /* Clock Delay Setting (1-8) */
136 /* SSLND - Slave Select Negation Delay Register */
137 #define SSLND_SLNDL_MASK 0x07 /* SSL Negation Delay Setting (1-8) */
139 /* SPND - Next-Access Delay Register */
140 #define SPND_SPNDL_MASK 0x07 /* Next-Access Delay Setting (1-8) */
142 /* SPCR2 - Control Register 2 */
143 #define SPCR2_PTE 0x08 /* Parity Self-Test Enable */
144 #define SPCR2_SPIE 0x04 /* Idle Interrupt Enable */
145 #define SPCR2_SPOE 0x02 /* Odd Parity Enable (vs. Even) */
146 #define SPCR2_SPPE 0x01 /* Parity Enable */
148 /* SPCMDn - Command Registers */
149 #define SPCMD_SCKDEN 0x8000 /* Clock Delay Setting Enable */
150 #define SPCMD_SLNDEN 0x4000 /* SSL Negation Delay Setting Enable */
151 #define SPCMD_SPNDEN 0x2000 /* Next-Access Delay Enable */
152 #define SPCMD_LSBF 0x1000 /* LSB First */
153 #define SPCMD_SPB_MASK 0x0f00 /* Data Length Setting */
154 #define SPCMD_SPB_8_TO_16(bit) (((bit - 1) << 8) & SPCMD_SPB_MASK)
155 #define SPCMD_SPB_8BIT 0x0000 /* qspi only */
156 #define SPCMD_SPB_16BIT 0x0100
157 #define SPCMD_SPB_20BIT 0x0000
158 #define SPCMD_SPB_24BIT 0x0100
159 #define SPCMD_SPB_32BIT 0x0200
160 #define SPCMD_SSLKP 0x0080 /* SSL Signal Level Keeping */
161 #define SPCMD_SPIMOD_MASK 0x0060 /* SPI Operating Mode (QSPI only) */
162 #define SPCMD_SPIMOD1 0x0040
163 #define SPCMD_SPIMOD0 0x0020
164 #define SPCMD_SPIMOD_SINGLE 0
165 #define SPCMD_SPIMOD_DUAL SPCMD_SPIMOD0
166 #define SPCMD_SPIMOD_QUAD SPCMD_SPIMOD1
167 #define SPCMD_SPRW 0x0010 /* SPI Read/Write Access (Dual/Quad) */
168 #define SPCMD_SSLA_MASK 0x0030 /* SSL Assert Signal Setting (RSPI) */
169 #define SPCMD_BRDV_MASK 0x000c /* Bit Rate Division Setting */
170 #define SPCMD_CPOL 0x0002 /* Clock Polarity Setting */
171 #define SPCMD_CPHA 0x0001 /* Clock Phase Setting */
173 /* SPBFCR - Buffer Control Register */
174 #define SPBFCR_TXRST 0x80 /* Transmit Buffer Data Reset */
175 #define SPBFCR_RXRST 0x40 /* Receive Buffer Data Reset */
176 #define SPBFCR_TXTRG_MASK 0x30 /* Transmit Buffer Data Triggering Number */
177 #define SPBFCR_RXTRG_MASK 0x07 /* Receive Buffer Data Triggering Number */
179 #define DUMMY_DATA 0x00
184 struct spi_master *master;
185 wait_queue_head_t wait;
191 const struct spi_ops *ops;
194 struct dma_chan *chan_tx;
195 struct dma_chan *chan_rx;
197 unsigned dma_width_16bit:1;
198 unsigned dma_callbacked:1;
199 unsigned byte_access:1;
202 static void rspi_write8(const struct rspi_data *rspi, u8 data, u16 offset)
204 iowrite8(data, rspi->addr + offset);
207 static void rspi_write16(const struct rspi_data *rspi, u16 data, u16 offset)
209 iowrite16(data, rspi->addr + offset);
212 static void rspi_write32(const struct rspi_data *rspi, u32 data, u16 offset)
214 iowrite32(data, rspi->addr + offset);
217 static u8 rspi_read8(const struct rspi_data *rspi, u16 offset)
219 return ioread8(rspi->addr + offset);
222 static u16 rspi_read16(const struct rspi_data *rspi, u16 offset)
224 return ioread16(rspi->addr + offset);
227 static void rspi_write_data(const struct rspi_data *rspi, u16 data)
229 if (rspi->byte_access)
230 rspi_write8(rspi, data, RSPI_SPDR);
232 rspi_write16(rspi, data, RSPI_SPDR);
235 static u16 rspi_read_data(const struct rspi_data *rspi)
237 if (rspi->byte_access)
238 return rspi_read8(rspi, RSPI_SPDR);
240 return rspi_read16(rspi, RSPI_SPDR);
243 /* optional functions */
245 int (*set_config_register)(struct rspi_data *rspi, int access_size);
246 int (*transfer_one)(struct spi_master *master, struct spi_device *spi,
247 struct spi_transfer *xfer);
251 * functions for RSPI on legacy SH
253 static int rspi_set_config_register(struct rspi_data *rspi, int access_size)
257 /* Sets output mode, MOSI signal, and (optionally) loopback */
258 rspi_write8(rspi, rspi->sppcr, RSPI_SPPCR);
260 /* Sets transfer bit rate */
261 spbr = clk_get_rate(rspi->clk) / (2 * rspi->max_speed_hz) - 1;
262 rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
264 /* Disable dummy transmission, set 16-bit word access, 1 frame */
265 rspi_write8(rspi, 0, RSPI_SPDCR);
266 rspi->byte_access = 0;
268 /* Sets RSPCK, SSL, next-access delay value */
269 rspi_write8(rspi, 0x00, RSPI_SPCKD);
270 rspi_write8(rspi, 0x00, RSPI_SSLND);
271 rspi_write8(rspi, 0x00, RSPI_SPND);
273 /* Sets parity, interrupt mask */
274 rspi_write8(rspi, 0x00, RSPI_SPCR2);
277 rspi_write16(rspi, SPCMD_SPB_8_TO_16(access_size) | rspi->spcmd,
281 rspi_write8(rspi, SPCR_MSTR, RSPI_SPCR);
287 * functions for RSPI on RZ
289 static int rspi_rz_set_config_register(struct rspi_data *rspi, int access_size)
293 /* Sets output mode, MOSI signal, and (optionally) loopback */
294 rspi_write8(rspi, rspi->sppcr, RSPI_SPPCR);
296 /* Sets transfer bit rate */
297 spbr = clk_get_rate(rspi->clk) / (2 * rspi->max_speed_hz) - 1;
298 rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
300 /* Disable dummy transmission, set byte access */
301 rspi_write8(rspi, SPDCR_SPLBYTE, RSPI_SPDCR);
302 rspi->byte_access = 1;
304 /* Sets RSPCK, SSL, next-access delay value */
305 rspi_write8(rspi, 0x00, RSPI_SPCKD);
306 rspi_write8(rspi, 0x00, RSPI_SSLND);
307 rspi_write8(rspi, 0x00, RSPI_SPND);
310 rspi->spcmd |= SPCMD_SPB_8_TO_16(access_size);
311 rspi_write16(rspi, rspi->spcmd, RSPI_SPCMD0);
314 rspi_write8(rspi, SPCR_MSTR, RSPI_SPCR);
322 static int qspi_set_config_register(struct rspi_data *rspi, int access_size)
327 /* Sets output mode, MOSI signal, and (optionally) loopback */
328 rspi_write8(rspi, rspi->sppcr, RSPI_SPPCR);
330 /* Sets transfer bit rate */
331 spbr = clk_get_rate(rspi->clk) / (2 * rspi->max_speed_hz);
332 rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
334 /* Disable dummy transmission, set byte access */
335 rspi_write8(rspi, 0, RSPI_SPDCR);
336 rspi->byte_access = 1;
338 /* Sets RSPCK, SSL, next-access delay value */
339 rspi_write8(rspi, 0x00, RSPI_SPCKD);
340 rspi_write8(rspi, 0x00, RSPI_SSLND);
341 rspi_write8(rspi, 0x00, RSPI_SPND);
343 /* Data Length Setting */
344 if (access_size == 8)
345 spcmd = SPCMD_SPB_8BIT;
346 else if (access_size == 16)
347 spcmd = SPCMD_SPB_16BIT;
349 spcmd = SPCMD_SPB_32BIT;
351 spcmd |= SPCMD_SCKDEN | SPCMD_SLNDEN | rspi->spcmd | SPCMD_SPNDEN;
353 /* Resets transfer data length */
354 rspi_write32(rspi, 0, QSPI_SPBMUL0);
356 /* Resets transmit and receive buffer */
357 rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, QSPI_SPBFCR);
358 /* Sets buffer to allow normal operation */
359 rspi_write8(rspi, 0x00, QSPI_SPBFCR);
362 rspi_write16(rspi, spcmd, RSPI_SPCMD0);
364 /* Enables SPI function in a master mode */
365 rspi_write8(rspi, SPCR_SPE | SPCR_MSTR, RSPI_SPCR);
370 #define set_config_register(spi, n) spi->ops->set_config_register(spi, n)
372 static void rspi_enable_irq(const struct rspi_data *rspi, u8 enable)
374 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | enable, RSPI_SPCR);
377 static void rspi_disable_irq(const struct rspi_data *rspi, u8 disable)
379 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~disable, RSPI_SPCR);
382 static int rspi_wait_for_interrupt(struct rspi_data *rspi, u8 wait_mask,
387 rspi->spsr = rspi_read8(rspi, RSPI_SPSR);
388 rspi_enable_irq(rspi, enable_bit);
389 ret = wait_event_timeout(rspi->wait, rspi->spsr & wait_mask, HZ);
390 if (ret == 0 && !(rspi->spsr & wait_mask))
396 static int rspi_data_out(struct rspi_data *rspi, u8 data)
398 if (rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE) < 0) {
399 dev_err(&rspi->master->dev, "transmit timeout\n");
402 rspi_write_data(rspi, data);
406 static int rspi_data_in(struct rspi_data *rspi)
410 if (rspi_wait_for_interrupt(rspi, SPSR_SPRF, SPCR_SPRIE) < 0) {
411 dev_err(&rspi->master->dev, "receive timeout\n");
414 data = rspi_read_data(rspi);
418 static int rspi_data_out_in(struct rspi_data *rspi, u8 data)
422 ret = rspi_data_out(rspi, data);
426 return rspi_data_in(rspi);
429 static void rspi_dma_complete(void *arg)
431 struct rspi_data *rspi = arg;
433 rspi->dma_callbacked = 1;
434 wake_up_interruptible(&rspi->wait);
437 static int rspi_dma_map_sg(struct scatterlist *sg, const void *buf,
438 unsigned len, struct dma_chan *chan,
439 enum dma_transfer_direction dir)
441 sg_init_table(sg, 1);
442 sg_set_buf(sg, buf, len);
443 sg_dma_len(sg) = len;
444 return dma_map_sg(chan->device->dev, sg, 1, dir);
447 static void rspi_dma_unmap_sg(struct scatterlist *sg, struct dma_chan *chan,
448 enum dma_transfer_direction dir)
450 dma_unmap_sg(chan->device->dev, sg, 1, dir);
453 static void rspi_memory_to_8bit(void *buf, const void *data, unsigned len)
456 const u8 *src = data;
459 *dst++ = (u16)(*src++);
464 static void rspi_memory_from_8bit(void *buf, const void *data, unsigned len)
467 const u16 *src = data;
475 static int rspi_send_dma(struct rspi_data *rspi, struct spi_transfer *t)
477 struct scatterlist sg;
478 const void *buf = NULL;
479 struct dma_async_tx_descriptor *desc;
483 if (rspi->dma_width_16bit) {
486 * If DMAC bus width is 16-bit, the driver allocates a dummy
487 * buffer. And, the driver converts original data into the
488 * DMAC data as the following format:
489 * original data: 1st byte, 2nd byte ...
490 * DMAC data: 1st byte, dummy, 2nd byte, dummy ...
493 tmp = kmalloc(len, GFP_KERNEL);
496 rspi_memory_to_8bit(tmp, t->tx_buf, t->len);
503 if (!rspi_dma_map_sg(&sg, buf, len, rspi->chan_tx, DMA_TO_DEVICE)) {
507 desc = dmaengine_prep_slave_sg(rspi->chan_tx, &sg, 1, DMA_TO_DEVICE,
508 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
515 * DMAC needs SPTIE, but if SPTIE is set, this IRQ routine will be
516 * called. So, this driver disables the IRQ while DMA transfer.
518 disable_irq(rspi->tx_irq);
520 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | SPCR_TXMD, RSPI_SPCR);
521 rspi_enable_irq(rspi, SPCR_SPTIE);
522 rspi->dma_callbacked = 0;
524 desc->callback = rspi_dma_complete;
525 desc->callback_param = rspi;
526 dmaengine_submit(desc);
527 dma_async_issue_pending(rspi->chan_tx);
529 ret = wait_event_interruptible_timeout(rspi->wait,
530 rspi->dma_callbacked, HZ);
531 if (ret > 0 && rspi->dma_callbacked)
535 rspi_disable_irq(rspi, SPCR_SPTIE);
537 enable_irq(rspi->tx_irq);
540 rspi_dma_unmap_sg(&sg, rspi->chan_tx, DMA_TO_DEVICE);
542 if (rspi->dma_width_16bit)
548 static void rspi_receive_init(const struct rspi_data *rspi)
552 spsr = rspi_read8(rspi, RSPI_SPSR);
553 if (spsr & SPSR_SPRF)
554 rspi_read_data(rspi); /* dummy read */
555 if (spsr & SPSR_OVRF)
556 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPSR) & ~SPSR_OVRF,
560 static void rspi_rz_receive_init(const struct rspi_data *rspi)
562 rspi_receive_init(rspi);
563 rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, RSPI_SPBFCR);
564 rspi_write8(rspi, 0, RSPI_SPBFCR);
567 static void qspi_receive_init(const struct rspi_data *rspi)
571 spsr = rspi_read8(rspi, RSPI_SPSR);
572 if (spsr & SPSR_SPRF)
573 rspi_read_data(rspi); /* dummy read */
574 rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, QSPI_SPBFCR);
575 rspi_write8(rspi, 0, QSPI_SPBFCR);
578 static int rspi_receive_dma(struct rspi_data *rspi, struct spi_transfer *t)
580 struct scatterlist sg, sg_dummy;
581 void *dummy = NULL, *rx_buf = NULL;
582 struct dma_async_tx_descriptor *desc, *desc_dummy;
586 if (rspi->dma_width_16bit) {
588 * If DMAC bus width is 16-bit, the driver allocates a dummy
589 * buffer. And, finally the driver converts the DMAC data into
590 * actual data as the following format:
591 * DMAC data: 1st byte, dummy, 2nd byte, dummy ...
592 * actual data: 1st byte, 2nd byte ...
595 rx_buf = kmalloc(len, GFP_KERNEL);
603 /* prepare dummy transfer to generate SPI clocks */
604 dummy = kzalloc(len, GFP_KERNEL);
609 if (!rspi_dma_map_sg(&sg_dummy, dummy, len, rspi->chan_tx,
614 desc_dummy = dmaengine_prep_slave_sg(rspi->chan_tx, &sg_dummy, 1,
615 DMA_TO_DEVICE, DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
618 goto end_dummy_mapped;
621 /* prepare receive transfer */
622 if (!rspi_dma_map_sg(&sg, rx_buf, len, rspi->chan_rx,
625 goto end_dummy_mapped;
628 desc = dmaengine_prep_slave_sg(rspi->chan_rx, &sg, 1, DMA_FROM_DEVICE,
629 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
635 rspi_receive_init(rspi);
638 * DMAC needs SPTIE, but if SPTIE is set, this IRQ routine will be
639 * called. So, this driver disables the IRQ while DMA transfer.
641 disable_irq(rspi->tx_irq);
642 if (rspi->rx_irq != rspi->tx_irq)
643 disable_irq(rspi->rx_irq);
645 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~SPCR_TXMD, RSPI_SPCR);
646 rspi_enable_irq(rspi, SPCR_SPTIE | SPCR_SPRIE);
647 rspi->dma_callbacked = 0;
649 desc->callback = rspi_dma_complete;
650 desc->callback_param = rspi;
651 dmaengine_submit(desc);
652 dma_async_issue_pending(rspi->chan_rx);
654 desc_dummy->callback = NULL; /* No callback */
655 dmaengine_submit(desc_dummy);
656 dma_async_issue_pending(rspi->chan_tx);
658 ret = wait_event_interruptible_timeout(rspi->wait,
659 rspi->dma_callbacked, HZ);
660 if (ret > 0 && rspi->dma_callbacked)
664 rspi_disable_irq(rspi, SPCR_SPTIE | SPCR_SPRIE);
666 enable_irq(rspi->tx_irq);
667 if (rspi->rx_irq != rspi->tx_irq)
668 enable_irq(rspi->rx_irq);
671 rspi_dma_unmap_sg(&sg, rspi->chan_rx, DMA_FROM_DEVICE);
673 rspi_dma_unmap_sg(&sg_dummy, rspi->chan_tx, DMA_TO_DEVICE);
675 if (rspi->dma_width_16bit) {
677 rspi_memory_from_8bit(t->rx_buf, rx_buf, t->len);
685 static int rspi_is_dma(const struct rspi_data *rspi, struct spi_transfer *t)
687 if (t->tx_buf && rspi->chan_tx)
689 /* If the module receives data by DMAC, it also needs TX DMAC */
690 if (t->rx_buf && rspi->chan_tx && rspi->chan_rx)
696 static int rspi_transfer_out_in(struct rspi_data *rspi,
697 struct spi_transfer *xfer)
699 int remain = xfer->len, ret;
700 const u8 *tx_buf = xfer->tx_buf;
701 u8 *rx_buf = xfer->rx_buf;
704 rspi_receive_init(rspi);
706 spcr = rspi_read8(rspi, RSPI_SPCR);
711 rspi_write8(rspi, spcr, RSPI_SPCR);
714 data = tx_buf ? *tx_buf++ : DUMMY_DATA;
715 ret = rspi_data_out(rspi, data);
719 ret = rspi_data_in(rspi);
727 /* Wait for the last transmission */
728 rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE);
733 static int rspi_transfer_one(struct spi_master *master, struct spi_device *spi,
734 struct spi_transfer *xfer)
736 struct rspi_data *rspi = spi_master_get_devdata(master);
739 if (!rspi_is_dma(rspi, xfer))
740 return rspi_transfer_out_in(rspi, xfer);
743 ret = rspi_send_dma(rspi, xfer);
748 return rspi_receive_dma(rspi, xfer);
753 static int rspi_rz_transfer_out_in(struct rspi_data *rspi,
754 struct spi_transfer *xfer)
756 int remain = xfer->len, ret;
757 const u8 *tx_buf = xfer->tx_buf;
758 u8 *rx_buf = xfer->rx_buf;
761 rspi_rz_receive_init(rspi);
764 data = tx_buf ? *tx_buf++ : DUMMY_DATA;
765 ret = rspi_data_out_in(rspi, data);
773 /* Wait for the last transmission */
774 rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE);
779 static int rspi_rz_transfer_one(struct spi_master *master,
780 struct spi_device *spi,
781 struct spi_transfer *xfer)
783 struct rspi_data *rspi = spi_master_get_devdata(master);
785 return rspi_rz_transfer_out_in(rspi, xfer);
788 static int qspi_transfer_out_in(struct rspi_data *rspi,
789 struct spi_transfer *xfer)
791 int remain = xfer->len, ret;
792 const u8 *tx_buf = xfer->tx_buf;
793 u8 *rx_buf = xfer->rx_buf;
796 qspi_receive_init(rspi);
799 data = tx_buf ? *tx_buf++ : DUMMY_DATA;
800 ret = rspi_data_out_in(rspi, data);
808 /* Wait for the last transmission */
809 rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE);
814 static int qspi_transfer_one(struct spi_master *master, struct spi_device *spi,
815 struct spi_transfer *xfer)
817 struct rspi_data *rspi = spi_master_get_devdata(master);
819 return qspi_transfer_out_in(rspi, xfer);
822 static int rspi_setup(struct spi_device *spi)
824 struct rspi_data *rspi = spi_master_get_devdata(spi->master);
826 rspi->max_speed_hz = spi->max_speed_hz;
828 rspi->spcmd = SPCMD_SSLKP;
829 if (spi->mode & SPI_CPOL)
830 rspi->spcmd |= SPCMD_CPOL;
831 if (spi->mode & SPI_CPHA)
832 rspi->spcmd |= SPCMD_CPHA;
834 /* CMOS output mode and MOSI signal from previous transfer */
836 if (spi->mode & SPI_LOOP)
837 rspi->sppcr |= SPPCR_SPLP;
839 set_config_register(rspi, 8);
844 static void rspi_cleanup(struct spi_device *spi)
848 static int rspi_prepare_message(struct spi_master *master,
849 struct spi_message *message)
851 struct rspi_data *rspi = spi_master_get_devdata(master);
853 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | SPCR_SPE, RSPI_SPCR);
857 static int rspi_unprepare_message(struct spi_master *master,
858 struct spi_message *message)
860 struct rspi_data *rspi = spi_master_get_devdata(master);
862 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~SPCR_SPE, RSPI_SPCR);
866 static irqreturn_t rspi_irq_mux(int irq, void *_sr)
868 struct rspi_data *rspi = _sr;
870 irqreturn_t ret = IRQ_NONE;
873 rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
874 if (spsr & SPSR_SPRF)
875 disable_irq |= SPCR_SPRIE;
876 if (spsr & SPSR_SPTEF)
877 disable_irq |= SPCR_SPTIE;
881 rspi_disable_irq(rspi, disable_irq);
882 wake_up(&rspi->wait);
888 static irqreturn_t rspi_irq_rx(int irq, void *_sr)
890 struct rspi_data *rspi = _sr;
893 rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
894 if (spsr & SPSR_SPRF) {
895 rspi_disable_irq(rspi, SPCR_SPRIE);
896 wake_up(&rspi->wait);
903 static irqreturn_t rspi_irq_tx(int irq, void *_sr)
905 struct rspi_data *rspi = _sr;
908 rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
909 if (spsr & SPSR_SPTEF) {
910 rspi_disable_irq(rspi, SPCR_SPTIE);
911 wake_up(&rspi->wait);
918 static int rspi_request_dma(struct rspi_data *rspi,
919 struct platform_device *pdev)
921 const struct rspi_plat_data *rspi_pd = dev_get_platdata(&pdev->dev);
922 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
924 struct dma_slave_config cfg;
927 if (!res || !rspi_pd)
928 return 0; /* The driver assumes no error. */
930 rspi->dma_width_16bit = rspi_pd->dma_width_16bit;
932 /* If the module receives data by DMAC, it also needs TX DMAC */
933 if (rspi_pd->dma_rx_id && rspi_pd->dma_tx_id) {
935 dma_cap_set(DMA_SLAVE, mask);
936 rspi->chan_rx = dma_request_channel(mask, shdma_chan_filter,
937 (void *)rspi_pd->dma_rx_id);
939 cfg.slave_id = rspi_pd->dma_rx_id;
940 cfg.direction = DMA_DEV_TO_MEM;
942 cfg.src_addr = res->start + RSPI_SPDR;
943 ret = dmaengine_slave_config(rspi->chan_rx, &cfg);
945 dev_info(&pdev->dev, "Use DMA when rx.\n");
950 if (rspi_pd->dma_tx_id) {
952 dma_cap_set(DMA_SLAVE, mask);
953 rspi->chan_tx = dma_request_channel(mask, shdma_chan_filter,
954 (void *)rspi_pd->dma_tx_id);
956 cfg.slave_id = rspi_pd->dma_tx_id;
957 cfg.direction = DMA_MEM_TO_DEV;
958 cfg.dst_addr = res->start + RSPI_SPDR;
960 ret = dmaengine_slave_config(rspi->chan_tx, &cfg);
962 dev_info(&pdev->dev, "Use DMA when tx\n");
971 static void rspi_release_dma(struct rspi_data *rspi)
974 dma_release_channel(rspi->chan_tx);
976 dma_release_channel(rspi->chan_rx);
979 static int rspi_remove(struct platform_device *pdev)
981 struct rspi_data *rspi = platform_get_drvdata(pdev);
983 rspi_release_dma(rspi);
984 clk_disable_unprepare(rspi->clk);
989 static const struct spi_ops rspi_ops = {
990 .set_config_register = rspi_set_config_register,
991 .transfer_one = rspi_transfer_one,
994 static const struct spi_ops rspi_rz_ops = {
995 .set_config_register = rspi_rz_set_config_register,
996 .transfer_one = rspi_rz_transfer_one,
999 static const struct spi_ops qspi_ops = {
1000 .set_config_register = qspi_set_config_register,
1001 .transfer_one = qspi_transfer_one,
1005 static const struct of_device_id rspi_of_match[] = {
1006 /* RSPI on legacy SH */
1007 { .compatible = "renesas,rspi", .data = &rspi_ops },
1008 /* RSPI on RZ/A1H */
1009 { .compatible = "renesas,rspi-rz", .data = &rspi_rz_ops },
1010 /* QSPI on R-Car Gen2 */
1011 { .compatible = "renesas,qspi", .data = &qspi_ops },
1015 MODULE_DEVICE_TABLE(of, rspi_of_match);
1017 static int rspi_parse_dt(struct device *dev, struct spi_master *master)
1022 /* Parse DT properties */
1023 error = of_property_read_u32(dev->of_node, "num-cs", &num_cs);
1025 dev_err(dev, "of_property_read_u32 num-cs failed %d\n", error);
1029 master->num_chipselect = num_cs;
1033 static inline int rspi_parse_dt(struct device *dev, struct spi_master *master)
1037 #endif /* CONFIG_OF */
1039 static int rspi_request_irq(struct device *dev, unsigned int irq,
1040 irq_handler_t handler, const char *suffix,
1043 const char *base = dev_name(dev);
1044 size_t len = strlen(base) + strlen(suffix) + 2;
1045 char *name = devm_kzalloc(dev, len, GFP_KERNEL);
1048 snprintf(name, len, "%s:%s", base, suffix);
1049 return devm_request_irq(dev, irq, handler, 0, name, dev_id);
1052 static int rspi_probe(struct platform_device *pdev)
1054 struct resource *res;
1055 struct spi_master *master;
1056 struct rspi_data *rspi;
1058 const struct of_device_id *of_id;
1059 const struct rspi_plat_data *rspi_pd;
1060 const struct spi_ops *ops;
1062 master = spi_alloc_master(&pdev->dev, sizeof(struct rspi_data));
1063 if (master == NULL) {
1064 dev_err(&pdev->dev, "spi_alloc_master error.\n");
1068 of_id = of_match_device(rspi_of_match, &pdev->dev);
1071 ret = rspi_parse_dt(&pdev->dev, master);
1075 ops = (struct spi_ops *)pdev->id_entry->driver_data;
1076 rspi_pd = dev_get_platdata(&pdev->dev);
1077 if (rspi_pd && rspi_pd->num_chipselect)
1078 master->num_chipselect = rspi_pd->num_chipselect;
1080 master->num_chipselect = 2; /* default */
1083 /* ops parameter check */
1084 if (!ops->set_config_register) {
1085 dev_err(&pdev->dev, "there is no set_config_register\n");
1090 rspi = spi_master_get_devdata(master);
1091 platform_set_drvdata(pdev, rspi);
1093 rspi->master = master;
1095 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1096 rspi->addr = devm_ioremap_resource(&pdev->dev, res);
1097 if (IS_ERR(rspi->addr)) {
1098 ret = PTR_ERR(rspi->addr);
1102 rspi->clk = devm_clk_get(&pdev->dev, NULL);
1103 if (IS_ERR(rspi->clk)) {
1104 dev_err(&pdev->dev, "cannot get clock\n");
1105 ret = PTR_ERR(rspi->clk);
1109 ret = clk_prepare_enable(rspi->clk);
1111 dev_err(&pdev->dev, "unable to prepare/enable clock\n");
1115 init_waitqueue_head(&rspi->wait);
1117 master->bus_num = pdev->id;
1118 master->setup = rspi_setup;
1119 master->transfer_one = ops->transfer_one;
1120 master->cleanup = rspi_cleanup;
1121 master->prepare_message = rspi_prepare_message;
1122 master->unprepare_message = rspi_unprepare_message;
1123 master->mode_bits = SPI_CPHA | SPI_CPOL | SPI_LOOP;
1124 master->dev.of_node = pdev->dev.of_node;
1126 ret = platform_get_irq_byname(pdev, "rx");
1128 ret = platform_get_irq_byname(pdev, "mux");
1130 ret = platform_get_irq(pdev, 0);
1132 rspi->rx_irq = rspi->tx_irq = ret;
1135 ret = platform_get_irq_byname(pdev, "tx");
1140 dev_err(&pdev->dev, "platform_get_irq error\n");
1144 if (rspi->rx_irq == rspi->tx_irq) {
1145 /* Single multiplexed interrupt */
1146 ret = rspi_request_irq(&pdev->dev, rspi->rx_irq, rspi_irq_mux,
1149 /* Multi-interrupt mode, only SPRI and SPTI are used */
1150 ret = rspi_request_irq(&pdev->dev, rspi->rx_irq, rspi_irq_rx,
1153 ret = rspi_request_irq(&pdev->dev, rspi->tx_irq,
1154 rspi_irq_tx, "tx", rspi);
1157 dev_err(&pdev->dev, "request_irq error\n");
1161 ret = rspi_request_dma(rspi, pdev);
1163 dev_err(&pdev->dev, "rspi_request_dma failed.\n");
1167 ret = devm_spi_register_master(&pdev->dev, master);
1169 dev_err(&pdev->dev, "spi_register_master error.\n");
1173 dev_info(&pdev->dev, "probed\n");
1178 rspi_release_dma(rspi);
1180 clk_disable_unprepare(rspi->clk);
1182 spi_master_put(master);
1187 static struct platform_device_id spi_driver_ids[] = {
1188 { "rspi", (kernel_ulong_t)&rspi_ops },
1189 { "rspi-rz", (kernel_ulong_t)&rspi_rz_ops },
1190 { "qspi", (kernel_ulong_t)&qspi_ops },
1194 MODULE_DEVICE_TABLE(platform, spi_driver_ids);
1196 static struct platform_driver rspi_driver = {
1197 .probe = rspi_probe,
1198 .remove = rspi_remove,
1199 .id_table = spi_driver_ids,
1201 .name = "renesas_spi",
1202 .owner = THIS_MODULE,
1203 .of_match_table = of_match_ptr(rspi_of_match),
1206 module_platform_driver(rspi_driver);
1208 MODULE_DESCRIPTION("Renesas RSPI bus driver");
1209 MODULE_LICENSE("GPL v2");
1210 MODULE_AUTHOR("Yoshihiro Shimoda");
1211 MODULE_ALIAS("platform:rspi");