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/sh_dma.h>
35 #include <linux/spi/spi.h>
36 #include <linux/spi/rspi.h>
38 #define RSPI_SPCR 0x00 /* Control Register */
39 #define RSPI_SSLP 0x01 /* Slave Select Polarity Register */
40 #define RSPI_SPPCR 0x02 /* Pin Control Register */
41 #define RSPI_SPSR 0x03 /* Status Register */
42 #define RSPI_SPDR 0x04 /* Data Register */
43 #define RSPI_SPSCR 0x08 /* Sequence Control Register */
44 #define RSPI_SPSSR 0x09 /* Sequence Status Register */
45 #define RSPI_SPBR 0x0a /* Bit Rate Register */
46 #define RSPI_SPDCR 0x0b /* Data Control Register */
47 #define RSPI_SPCKD 0x0c /* Clock Delay Register */
48 #define RSPI_SSLND 0x0d /* Slave Select Negation Delay Register */
49 #define RSPI_SPND 0x0e /* Next-Access Delay Register */
50 #define RSPI_SPCR2 0x0f /* Control Register 2 (SH only) */
51 #define RSPI_SPCMD0 0x10 /* Command Register 0 */
52 #define RSPI_SPCMD1 0x12 /* Command Register 1 */
53 #define RSPI_SPCMD2 0x14 /* Command Register 2 */
54 #define RSPI_SPCMD3 0x16 /* Command Register 3 */
55 #define RSPI_SPCMD4 0x18 /* Command Register 4 */
56 #define RSPI_SPCMD5 0x1a /* Command Register 5 */
57 #define RSPI_SPCMD6 0x1c /* Command Register 6 */
58 #define RSPI_SPCMD7 0x1e /* Command Register 7 */
61 #define RSPI_SPBFCR 0x20 /* Buffer Control Register */
62 #define RSPI_SPBFDR 0x22 /* Buffer Data Count Setting Register */
65 #define QSPI_SPBFCR 0x18 /* Buffer Control Register */
66 #define QSPI_SPBDCR 0x1a /* Buffer Data Count Register */
67 #define QSPI_SPBMUL0 0x1c /* Transfer Data Length Multiplier Setting Register 0 */
68 #define QSPI_SPBMUL1 0x20 /* Transfer Data Length Multiplier Setting Register 1 */
69 #define QSPI_SPBMUL2 0x24 /* Transfer Data Length Multiplier Setting Register 2 */
70 #define QSPI_SPBMUL3 0x28 /* Transfer Data Length Multiplier Setting Register 3 */
72 /* SPCR - Control Register */
73 #define SPCR_SPRIE 0x80 /* Receive Interrupt Enable */
74 #define SPCR_SPE 0x40 /* Function Enable */
75 #define SPCR_SPTIE 0x20 /* Transmit Interrupt Enable */
76 #define SPCR_SPEIE 0x10 /* Error Interrupt Enable */
77 #define SPCR_MSTR 0x08 /* Master/Slave Mode Select */
78 #define SPCR_MODFEN 0x04 /* Mode Fault Error Detection Enable */
80 #define SPCR_TXMD 0x02 /* TX Only Mode (vs. Full Duplex) */
81 #define SPCR_SPMS 0x01 /* 3-wire Mode (vs. 4-wire) */
82 /* QSPI on R-Car M2 only */
83 #define SPCR_WSWAP 0x02 /* Word Swap of read-data for DMAC */
84 #define SPCR_BSWAP 0x01 /* Byte Swap of read-data for DMAC */
86 /* SSLP - Slave Select Polarity Register */
87 #define SSLP_SSL1P 0x02 /* SSL1 Signal Polarity Setting */
88 #define SSLP_SSL0P 0x01 /* SSL0 Signal Polarity Setting */
90 /* SPPCR - Pin Control Register */
91 #define SPPCR_MOIFE 0x20 /* MOSI Idle Value Fixing Enable */
92 #define SPPCR_MOIFV 0x10 /* MOSI Idle Fixed Value */
93 #define SPPCR_SPOM 0x04
94 #define SPPCR_SPLP2 0x02 /* Loopback Mode 2 (non-inverting) */
95 #define SPPCR_SPLP 0x01 /* Loopback Mode (inverting) */
97 #define SPPCR_IO3FV 0x04 /* Single-/Dual-SPI Mode IO3 Output Fixed Value */
98 #define SPPCR_IO2FV 0x04 /* Single-/Dual-SPI Mode IO2 Output Fixed Value */
100 /* SPSR - Status Register */
101 #define SPSR_SPRF 0x80 /* Receive Buffer Full Flag */
102 #define SPSR_TEND 0x40 /* Transmit End */
103 #define SPSR_SPTEF 0x20 /* Transmit Buffer Empty Flag */
104 #define SPSR_PERF 0x08 /* Parity Error Flag */
105 #define SPSR_MODF 0x04 /* Mode Fault Error Flag */
106 #define SPSR_IDLNF 0x02 /* RSPI Idle Flag */
107 #define SPSR_OVRF 0x01 /* Overrun Error Flag (RSPI only) */
109 /* SPSCR - Sequence Control Register */
110 #define SPSCR_SPSLN_MASK 0x07 /* Sequence Length Specification */
112 /* SPSSR - Sequence Status Register */
113 #define SPSSR_SPECM_MASK 0x70 /* Command Error Mask */
114 #define SPSSR_SPCP_MASK 0x07 /* Command Pointer Mask */
116 /* SPDCR - Data Control Register */
117 #define SPDCR_TXDMY 0x80 /* Dummy Data Transmission Enable */
118 #define SPDCR_SPLW1 0x40 /* Access Width Specification (RZ) */
119 #define SPDCR_SPLW0 0x20 /* Access Width Specification (RZ) */
120 #define SPDCR_SPLLWORD (SPDCR_SPLW1 | SPDCR_SPLW0)
121 #define SPDCR_SPLWORD SPDCR_SPLW1
122 #define SPDCR_SPLBYTE SPDCR_SPLW0
123 #define SPDCR_SPLW 0x20 /* Access Width Specification (SH) */
124 #define SPDCR_SPRDTD 0x10 /* Receive Transmit Data Select (SH) */
125 #define SPDCR_SLSEL1 0x08
126 #define SPDCR_SLSEL0 0x04
127 #define SPDCR_SLSEL_MASK 0x0c /* SSL1 Output Select (SH) */
128 #define SPDCR_SPFC1 0x02
129 #define SPDCR_SPFC0 0x01
130 #define SPDCR_SPFC_MASK 0x03 /* Frame Count Setting (1-4) (SH) */
132 /* SPCKD - Clock Delay Register */
133 #define SPCKD_SCKDL_MASK 0x07 /* Clock Delay Setting (1-8) */
135 /* SSLND - Slave Select Negation Delay Register */
136 #define SSLND_SLNDL_MASK 0x07 /* SSL Negation Delay Setting (1-8) */
138 /* SPND - Next-Access Delay Register */
139 #define SPND_SPNDL_MASK 0x07 /* Next-Access Delay Setting (1-8) */
141 /* SPCR2 - Control Register 2 */
142 #define SPCR2_PTE 0x08 /* Parity Self-Test Enable */
143 #define SPCR2_SPIE 0x04 /* Idle Interrupt Enable */
144 #define SPCR2_SPOE 0x02 /* Odd Parity Enable (vs. Even) */
145 #define SPCR2_SPPE 0x01 /* Parity Enable */
147 /* SPCMDn - Command Registers */
148 #define SPCMD_SCKDEN 0x8000 /* Clock Delay Setting Enable */
149 #define SPCMD_SLNDEN 0x4000 /* SSL Negation Delay Setting Enable */
150 #define SPCMD_SPNDEN 0x2000 /* Next-Access Delay Enable */
151 #define SPCMD_LSBF 0x1000 /* LSB First */
152 #define SPCMD_SPB_MASK 0x0f00 /* Data Length Setting */
153 #define SPCMD_SPB_8_TO_16(bit) (((bit - 1) << 8) & SPCMD_SPB_MASK)
154 #define SPCMD_SPB_8BIT 0x0000 /* qspi only */
155 #define SPCMD_SPB_16BIT 0x0100
156 #define SPCMD_SPB_20BIT 0x0000
157 #define SPCMD_SPB_24BIT 0x0100
158 #define SPCMD_SPB_32BIT 0x0200
159 #define SPCMD_SSLKP 0x0080 /* SSL Signal Level Keeping */
160 #define SPCMD_SPIMOD_MASK 0x0060 /* SPI Operating Mode (QSPI only) */
161 #define SPCMD_SPIMOD1 0x0040
162 #define SPCMD_SPIMOD0 0x0020
163 #define SPCMD_SPIMOD_SINGLE 0
164 #define SPCMD_SPIMOD_DUAL SPCMD_SPIMOD0
165 #define SPCMD_SPIMOD_QUAD SPCMD_SPIMOD1
166 #define SPCMD_SPRW 0x0010 /* SPI Read/Write Access (Dual/Quad) */
167 #define SPCMD_SSLA_MASK 0x0030 /* SSL Assert Signal Setting (RSPI) */
168 #define SPCMD_BRDV_MASK 0x000c /* Bit Rate Division Setting */
169 #define SPCMD_CPOL 0x0002 /* Clock Polarity Setting */
170 #define SPCMD_CPHA 0x0001 /* Clock Phase Setting */
172 /* SPBFCR - Buffer Control Register */
173 #define SPBFCR_TXRST 0x80 /* Transmit Buffer Data Reset */
174 #define SPBFCR_RXRST 0x40 /* Receive Buffer Data Reset */
175 #define SPBFCR_TXTRG_MASK 0x30 /* Transmit Buffer Data Triggering Number */
176 #define SPBFCR_RXTRG_MASK 0x07 /* Receive Buffer Data Triggering Number */
178 #define DUMMY_DATA 0x00
183 struct spi_master *master;
184 wait_queue_head_t wait;
189 const struct spi_ops *ops;
192 struct dma_chan *chan_tx;
193 struct dma_chan *chan_rx;
195 unsigned dma_width_16bit:1;
196 unsigned dma_callbacked:1;
197 unsigned byte_access:1;
200 static void rspi_write8(const struct rspi_data *rspi, u8 data, u16 offset)
202 iowrite8(data, rspi->addr + offset);
205 static void rspi_write16(const struct rspi_data *rspi, u16 data, u16 offset)
207 iowrite16(data, rspi->addr + offset);
210 static void rspi_write32(const struct rspi_data *rspi, u32 data, u16 offset)
212 iowrite32(data, rspi->addr + offset);
215 static u8 rspi_read8(const struct rspi_data *rspi, u16 offset)
217 return ioread8(rspi->addr + offset);
220 static u16 rspi_read16(const struct rspi_data *rspi, u16 offset)
222 return ioread16(rspi->addr + offset);
225 static void rspi_write_data(const struct rspi_data *rspi, u16 data)
227 if (rspi->byte_access)
228 rspi_write8(rspi, data, RSPI_SPDR);
230 rspi_write16(rspi, data, RSPI_SPDR);
233 static u16 rspi_read_data(const struct rspi_data *rspi)
235 if (rspi->byte_access)
236 return rspi_read8(rspi, RSPI_SPDR);
238 return rspi_read16(rspi, RSPI_SPDR);
241 /* optional functions */
243 int (*set_config_register)(struct rspi_data *rspi, int access_size);
244 int (*transfer_one)(struct spi_master *master, struct spi_device *spi,
245 struct spi_transfer *xfer);
249 * functions for RSPI on legacy SH
251 static int rspi_set_config_register(struct rspi_data *rspi, int access_size)
255 /* Sets output mode(CMOS) and MOSI signal(from previous transfer) */
256 rspi_write8(rspi, 0x00, RSPI_SPPCR);
258 /* Sets transfer bit rate */
259 spbr = clk_get_rate(rspi->clk) / (2 * rspi->max_speed_hz) - 1;
260 rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
262 /* Disable dummy transmission, set 16-bit word access, 1 frame */
263 rspi_write8(rspi, 0, RSPI_SPDCR);
264 rspi->byte_access = 0;
266 /* Sets RSPCK, SSL, next-access delay value */
267 rspi_write8(rspi, 0x00, RSPI_SPCKD);
268 rspi_write8(rspi, 0x00, RSPI_SSLND);
269 rspi_write8(rspi, 0x00, RSPI_SPND);
271 /* Sets parity, interrupt mask */
272 rspi_write8(rspi, 0x00, RSPI_SPCR2);
275 rspi_write16(rspi, SPCMD_SPB_8_TO_16(access_size) | rspi->spcmd,
279 rspi_write8(rspi, SPCR_MSTR, RSPI_SPCR);
285 * functions for RSPI on RZ
287 static int rspi_rz_set_config_register(struct rspi_data *rspi, int access_size)
291 /* Sets output mode */
292 rspi_write8(rspi, 0x00, RSPI_SPPCR);
294 /* Sets transfer bit rate */
295 spbr = clk_get_rate(rspi->clk) / (2 * rspi->max_speed_hz) - 1;
296 rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
298 /* Disable dummy transmission, set byte access */
299 rspi_write8(rspi, SPDCR_SPLBYTE, RSPI_SPDCR);
300 rspi->byte_access = 1;
302 /* Sets RSPCK, SSL, next-access delay value */
303 rspi_write8(rspi, 0x00, RSPI_SPCKD);
304 rspi_write8(rspi, 0x00, RSPI_SSLND);
305 rspi_write8(rspi, 0x00, RSPI_SPND);
308 rspi->spcmd |= SPCMD_SPB_8_TO_16(access_size);
309 rspi_write16(rspi, rspi->spcmd, RSPI_SPCMD0);
312 rspi_write8(rspi, SPCR_MSTR, RSPI_SPCR);
320 static int qspi_set_config_register(struct rspi_data *rspi, int access_size)
325 /* Sets output mode(CMOS) and MOSI signal(from previous transfer) */
326 rspi_write8(rspi, 0x00, RSPI_SPPCR);
328 /* Sets transfer bit rate */
329 spbr = clk_get_rate(rspi->clk) / (2 * rspi->max_speed_hz);
330 rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
332 /* Disable dummy transmission, set byte access */
333 rspi_write8(rspi, 0, RSPI_SPDCR);
334 rspi->byte_access = 1;
336 /* Sets RSPCK, SSL, next-access delay value */
337 rspi_write8(rspi, 0x00, RSPI_SPCKD);
338 rspi_write8(rspi, 0x00, RSPI_SSLND);
339 rspi_write8(rspi, 0x00, RSPI_SPND);
341 /* Data Length Setting */
342 if (access_size == 8)
343 spcmd = SPCMD_SPB_8BIT;
344 else if (access_size == 16)
345 spcmd = SPCMD_SPB_16BIT;
347 spcmd = SPCMD_SPB_32BIT;
349 spcmd |= SPCMD_SCKDEN | SPCMD_SLNDEN | rspi->spcmd | SPCMD_SPNDEN;
351 /* Resets transfer data length */
352 rspi_write32(rspi, 0, QSPI_SPBMUL0);
354 /* Resets transmit and receive buffer */
355 rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, QSPI_SPBFCR);
356 /* Sets buffer to allow normal operation */
357 rspi_write8(rspi, 0x00, QSPI_SPBFCR);
360 rspi_write16(rspi, spcmd, RSPI_SPCMD0);
362 /* Enables SPI function in a master mode */
363 rspi_write8(rspi, SPCR_SPE | SPCR_MSTR, RSPI_SPCR);
368 #define set_config_register(spi, n) spi->ops->set_config_register(spi, n)
370 static void rspi_enable_irq(const struct rspi_data *rspi, u8 enable)
372 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | enable, RSPI_SPCR);
375 static void rspi_disable_irq(const struct rspi_data *rspi, u8 disable)
377 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~disable, RSPI_SPCR);
380 static int rspi_wait_for_interrupt(struct rspi_data *rspi, u8 wait_mask,
385 rspi->spsr = rspi_read8(rspi, RSPI_SPSR);
386 rspi_enable_irq(rspi, enable_bit);
387 ret = wait_event_timeout(rspi->wait, rspi->spsr & wait_mask, HZ);
388 if (ret == 0 && !(rspi->spsr & wait_mask))
394 static int rspi_data_out(struct rspi_data *rspi, u8 data)
396 if (rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE) < 0) {
397 dev_err(&rspi->master->dev, "transmit timeout\n");
400 rspi_write_data(rspi, data);
404 static int rspi_data_in(struct rspi_data *rspi)
408 if (rspi_wait_for_interrupt(rspi, SPSR_SPRF, SPCR_SPRIE) < 0) {
409 dev_err(&rspi->master->dev, "receive timeout\n");
412 data = rspi_read_data(rspi);
416 static int rspi_data_out_in(struct rspi_data *rspi, u8 data)
420 ret = rspi_data_out(rspi, data);
424 return rspi_data_in(rspi);
427 static void rspi_dma_complete(void *arg)
429 struct rspi_data *rspi = arg;
431 rspi->dma_callbacked = 1;
432 wake_up_interruptible(&rspi->wait);
435 static int rspi_dma_map_sg(struct scatterlist *sg, const void *buf,
436 unsigned len, struct dma_chan *chan,
437 enum dma_transfer_direction dir)
439 sg_init_table(sg, 1);
440 sg_set_buf(sg, buf, len);
441 sg_dma_len(sg) = len;
442 return dma_map_sg(chan->device->dev, sg, 1, dir);
445 static void rspi_dma_unmap_sg(struct scatterlist *sg, struct dma_chan *chan,
446 enum dma_transfer_direction dir)
448 dma_unmap_sg(chan->device->dev, sg, 1, dir);
451 static void rspi_memory_to_8bit(void *buf, const void *data, unsigned len)
454 const u8 *src = data;
457 *dst++ = (u16)(*src++);
462 static void rspi_memory_from_8bit(void *buf, const void *data, unsigned len)
465 const u16 *src = data;
473 static int rspi_send_dma(struct rspi_data *rspi, struct spi_transfer *t)
475 struct scatterlist sg;
476 const void *buf = NULL;
477 struct dma_async_tx_descriptor *desc;
481 if (rspi->dma_width_16bit) {
484 * If DMAC bus width is 16-bit, the driver allocates a dummy
485 * buffer. And, the driver converts original data into the
486 * DMAC data as the following format:
487 * original data: 1st byte, 2nd byte ...
488 * DMAC data: 1st byte, dummy, 2nd byte, dummy ...
491 tmp = kmalloc(len, GFP_KERNEL);
494 rspi_memory_to_8bit(tmp, t->tx_buf, t->len);
501 if (!rspi_dma_map_sg(&sg, buf, len, rspi->chan_tx, DMA_TO_DEVICE)) {
505 desc = dmaengine_prep_slave_sg(rspi->chan_tx, &sg, 1, DMA_TO_DEVICE,
506 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
513 * DMAC needs SPTIE, but if SPTIE is set, this IRQ routine will be
514 * called. So, this driver disables the IRQ while DMA transfer.
516 disable_irq(rspi->tx_irq);
518 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | SPCR_TXMD, RSPI_SPCR);
519 rspi_enable_irq(rspi, SPCR_SPTIE);
520 rspi->dma_callbacked = 0;
522 desc->callback = rspi_dma_complete;
523 desc->callback_param = rspi;
524 dmaengine_submit(desc);
525 dma_async_issue_pending(rspi->chan_tx);
527 ret = wait_event_interruptible_timeout(rspi->wait,
528 rspi->dma_callbacked, HZ);
529 if (ret > 0 && rspi->dma_callbacked)
533 rspi_disable_irq(rspi, SPCR_SPTIE);
535 enable_irq(rspi->tx_irq);
538 rspi_dma_unmap_sg(&sg, rspi->chan_tx, DMA_TO_DEVICE);
540 if (rspi->dma_width_16bit)
546 static void rspi_receive_init(const struct rspi_data *rspi)
550 spsr = rspi_read8(rspi, RSPI_SPSR);
551 if (spsr & SPSR_SPRF)
552 rspi_read_data(rspi); /* dummy read */
553 if (spsr & SPSR_OVRF)
554 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPSR) & ~SPSR_OVRF,
558 static void rspi_rz_receive_init(const struct rspi_data *rspi)
560 rspi_receive_init(rspi);
561 rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, RSPI_SPBFCR);
562 rspi_write8(rspi, 0, RSPI_SPBFCR);
565 static void qspi_receive_init(const struct rspi_data *rspi)
569 spsr = rspi_read8(rspi, RSPI_SPSR);
570 if (spsr & SPSR_SPRF)
571 rspi_read_data(rspi); /* dummy read */
572 rspi_write8(rspi, SPBFCR_TXRST | SPBFCR_RXRST, QSPI_SPBFCR);
573 rspi_write8(rspi, 0, QSPI_SPBFCR);
576 static int rspi_receive_dma(struct rspi_data *rspi, struct spi_transfer *t)
578 struct scatterlist sg, sg_dummy;
579 void *dummy = NULL, *rx_buf = NULL;
580 struct dma_async_tx_descriptor *desc, *desc_dummy;
584 if (rspi->dma_width_16bit) {
586 * If DMAC bus width is 16-bit, the driver allocates a dummy
587 * buffer. And, finally the driver converts the DMAC data into
588 * actual data as the following format:
589 * DMAC data: 1st byte, dummy, 2nd byte, dummy ...
590 * actual data: 1st byte, 2nd byte ...
593 rx_buf = kmalloc(len, GFP_KERNEL);
601 /* prepare dummy transfer to generate SPI clocks */
602 dummy = kzalloc(len, GFP_KERNEL);
607 if (!rspi_dma_map_sg(&sg_dummy, dummy, len, rspi->chan_tx,
612 desc_dummy = dmaengine_prep_slave_sg(rspi->chan_tx, &sg_dummy, 1,
613 DMA_TO_DEVICE, DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
616 goto end_dummy_mapped;
619 /* prepare receive transfer */
620 if (!rspi_dma_map_sg(&sg, rx_buf, len, rspi->chan_rx,
623 goto end_dummy_mapped;
626 desc = dmaengine_prep_slave_sg(rspi->chan_rx, &sg, 1, DMA_FROM_DEVICE,
627 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
633 rspi_receive_init(rspi);
636 * DMAC needs SPTIE, but if SPTIE is set, this IRQ routine will be
637 * called. So, this driver disables the IRQ while DMA transfer.
639 disable_irq(rspi->tx_irq);
640 if (rspi->rx_irq != rspi->tx_irq)
641 disable_irq(rspi->rx_irq);
643 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~SPCR_TXMD, RSPI_SPCR);
644 rspi_enable_irq(rspi, SPCR_SPTIE | SPCR_SPRIE);
645 rspi->dma_callbacked = 0;
647 desc->callback = rspi_dma_complete;
648 desc->callback_param = rspi;
649 dmaengine_submit(desc);
650 dma_async_issue_pending(rspi->chan_rx);
652 desc_dummy->callback = NULL; /* No callback */
653 dmaengine_submit(desc_dummy);
654 dma_async_issue_pending(rspi->chan_tx);
656 ret = wait_event_interruptible_timeout(rspi->wait,
657 rspi->dma_callbacked, HZ);
658 if (ret > 0 && rspi->dma_callbacked)
662 rspi_disable_irq(rspi, SPCR_SPTIE | SPCR_SPRIE);
664 enable_irq(rspi->tx_irq);
665 if (rspi->rx_irq != rspi->tx_irq)
666 enable_irq(rspi->rx_irq);
669 rspi_dma_unmap_sg(&sg, rspi->chan_rx, DMA_FROM_DEVICE);
671 rspi_dma_unmap_sg(&sg_dummy, rspi->chan_tx, DMA_TO_DEVICE);
673 if (rspi->dma_width_16bit) {
675 rspi_memory_from_8bit(t->rx_buf, rx_buf, t->len);
683 static int rspi_is_dma(const struct rspi_data *rspi, struct spi_transfer *t)
685 if (t->tx_buf && rspi->chan_tx)
687 /* If the module receives data by DMAC, it also needs TX DMAC */
688 if (t->rx_buf && rspi->chan_tx && rspi->chan_rx)
694 static int rspi_transfer_out_in(struct rspi_data *rspi,
695 struct spi_transfer *xfer)
697 int remain = xfer->len, ret;
698 const u8 *tx_buf = xfer->tx_buf;
699 u8 *rx_buf = xfer->rx_buf;
702 rspi_receive_init(rspi);
704 spcr = rspi_read8(rspi, RSPI_SPCR);
709 rspi_write8(rspi, spcr, RSPI_SPCR);
712 data = tx_buf ? *tx_buf++ : DUMMY_DATA;
713 ret = rspi_data_out(rspi, data);
717 ret = rspi_data_in(rspi);
725 /* Wait for the last transmission */
726 rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE);
731 static int rspi_transfer_one(struct spi_master *master, struct spi_device *spi,
732 struct spi_transfer *xfer)
734 struct rspi_data *rspi = spi_master_get_devdata(master);
737 if (!rspi_is_dma(rspi, xfer))
738 return rspi_transfer_out_in(rspi, xfer);
741 ret = rspi_send_dma(rspi, xfer);
746 return rspi_receive_dma(rspi, xfer);
751 static int rspi_rz_transfer_out_in(struct rspi_data *rspi,
752 struct spi_transfer *xfer)
754 int remain = xfer->len, ret;
755 const u8 *tx_buf = xfer->tx_buf;
756 u8 *rx_buf = xfer->rx_buf;
759 rspi_rz_receive_init(rspi);
762 data = tx_buf ? *tx_buf++ : DUMMY_DATA;
763 ret = rspi_data_out_in(rspi, data);
771 /* Wait for the last transmission */
772 rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE);
777 static int rspi_rz_transfer_one(struct spi_master *master,
778 struct spi_device *spi,
779 struct spi_transfer *xfer)
781 struct rspi_data *rspi = spi_master_get_devdata(master);
783 return rspi_rz_transfer_out_in(rspi, xfer);
786 static int qspi_transfer_out_in(struct rspi_data *rspi,
787 struct spi_transfer *xfer)
789 int remain = xfer->len, ret;
790 const u8 *tx_buf = xfer->tx_buf;
791 u8 *rx_buf = xfer->rx_buf;
794 qspi_receive_init(rspi);
797 data = tx_buf ? *tx_buf++ : DUMMY_DATA;
798 ret = rspi_data_out_in(rspi, data);
806 /* Wait for the last transmission */
807 rspi_wait_for_interrupt(rspi, SPSR_SPTEF, SPCR_SPTIE);
812 static int qspi_transfer_one(struct spi_master *master, struct spi_device *spi,
813 struct spi_transfer *xfer)
815 struct rspi_data *rspi = spi_master_get_devdata(master);
817 return qspi_transfer_out_in(rspi, xfer);
820 static int rspi_setup(struct spi_device *spi)
822 struct rspi_data *rspi = spi_master_get_devdata(spi->master);
824 rspi->max_speed_hz = spi->max_speed_hz;
826 rspi->spcmd = SPCMD_SSLKP;
827 if (spi->mode & SPI_CPOL)
828 rspi->spcmd |= SPCMD_CPOL;
829 if (spi->mode & SPI_CPHA)
830 rspi->spcmd |= SPCMD_CPHA;
832 set_config_register(rspi, 8);
837 static void rspi_cleanup(struct spi_device *spi)
841 static int rspi_prepare_message(struct spi_master *master,
842 struct spi_message *message)
844 struct rspi_data *rspi = spi_master_get_devdata(master);
846 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) | SPCR_SPE, RSPI_SPCR);
850 static int rspi_unprepare_message(struct spi_master *master,
851 struct spi_message *message)
853 struct rspi_data *rspi = spi_master_get_devdata(master);
855 rspi_write8(rspi, rspi_read8(rspi, RSPI_SPCR) & ~SPCR_SPE, RSPI_SPCR);
859 static irqreturn_t rspi_irq_mux(int irq, void *_sr)
861 struct rspi_data *rspi = _sr;
863 irqreturn_t ret = IRQ_NONE;
866 rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
867 if (spsr & SPSR_SPRF)
868 disable_irq |= SPCR_SPRIE;
869 if (spsr & SPSR_SPTEF)
870 disable_irq |= SPCR_SPTIE;
874 rspi_disable_irq(rspi, disable_irq);
875 wake_up(&rspi->wait);
881 static irqreturn_t rspi_irq_rx(int irq, void *_sr)
883 struct rspi_data *rspi = _sr;
886 rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
887 if (spsr & SPSR_SPRF) {
888 rspi_disable_irq(rspi, SPCR_SPRIE);
889 wake_up(&rspi->wait);
896 static irqreturn_t rspi_irq_tx(int irq, void *_sr)
898 struct rspi_data *rspi = _sr;
901 rspi->spsr = spsr = rspi_read8(rspi, RSPI_SPSR);
902 if (spsr & SPSR_SPTEF) {
903 rspi_disable_irq(rspi, SPCR_SPTIE);
904 wake_up(&rspi->wait);
911 static int rspi_request_dma(struct rspi_data *rspi,
912 struct platform_device *pdev)
914 const struct rspi_plat_data *rspi_pd = dev_get_platdata(&pdev->dev);
915 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
917 struct dma_slave_config cfg;
920 if (!res || !rspi_pd)
921 return 0; /* The driver assumes no error. */
923 rspi->dma_width_16bit = rspi_pd->dma_width_16bit;
925 /* If the module receives data by DMAC, it also needs TX DMAC */
926 if (rspi_pd->dma_rx_id && rspi_pd->dma_tx_id) {
928 dma_cap_set(DMA_SLAVE, mask);
929 rspi->chan_rx = dma_request_channel(mask, shdma_chan_filter,
930 (void *)rspi_pd->dma_rx_id);
932 cfg.slave_id = rspi_pd->dma_rx_id;
933 cfg.direction = DMA_DEV_TO_MEM;
935 cfg.src_addr = res->start + RSPI_SPDR;
936 ret = dmaengine_slave_config(rspi->chan_rx, &cfg);
938 dev_info(&pdev->dev, "Use DMA when rx.\n");
943 if (rspi_pd->dma_tx_id) {
945 dma_cap_set(DMA_SLAVE, mask);
946 rspi->chan_tx = dma_request_channel(mask, shdma_chan_filter,
947 (void *)rspi_pd->dma_tx_id);
949 cfg.slave_id = rspi_pd->dma_tx_id;
950 cfg.direction = DMA_MEM_TO_DEV;
951 cfg.dst_addr = res->start + RSPI_SPDR;
953 ret = dmaengine_slave_config(rspi->chan_tx, &cfg);
955 dev_info(&pdev->dev, "Use DMA when tx\n");
964 static void rspi_release_dma(struct rspi_data *rspi)
967 dma_release_channel(rspi->chan_tx);
969 dma_release_channel(rspi->chan_rx);
972 static int rspi_remove(struct platform_device *pdev)
974 struct rspi_data *rspi = platform_get_drvdata(pdev);
976 rspi_release_dma(rspi);
977 clk_disable(rspi->clk);
982 static int rspi_request_irq(struct device *dev, unsigned int irq,
983 irq_handler_t handler, const char *suffix,
986 const char *base = dev_name(dev);
987 size_t len = strlen(base) + strlen(suffix) + 2;
988 char *name = devm_kzalloc(dev, len, GFP_KERNEL);
991 snprintf(name, len, "%s:%s", base, suffix);
992 return devm_request_irq(dev, irq, handler, 0, name, dev_id);
995 static int rspi_probe(struct platform_device *pdev)
997 struct resource *res;
998 struct spi_master *master;
999 struct rspi_data *rspi;
1002 const struct rspi_plat_data *rspi_pd = dev_get_platdata(&pdev->dev);
1003 const struct spi_ops *ops;
1004 const struct platform_device_id *id_entry = pdev->id_entry;
1006 ops = (struct spi_ops *)id_entry->driver_data;
1007 /* ops parameter check */
1008 if (!ops->set_config_register) {
1009 dev_err(&pdev->dev, "there is no set_config_register\n");
1013 master = spi_alloc_master(&pdev->dev, sizeof(struct rspi_data));
1014 if (master == NULL) {
1015 dev_err(&pdev->dev, "spi_alloc_master error.\n");
1019 rspi = spi_master_get_devdata(master);
1020 platform_set_drvdata(pdev, rspi);
1022 rspi->master = master;
1024 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1025 rspi->addr = devm_ioremap_resource(&pdev->dev, res);
1026 if (IS_ERR(rspi->addr)) {
1027 ret = PTR_ERR(rspi->addr);
1031 snprintf(clk_name, sizeof(clk_name), "%s%d", id_entry->name, pdev->id);
1032 rspi->clk = devm_clk_get(&pdev->dev, clk_name);
1033 if (IS_ERR(rspi->clk)) {
1034 dev_err(&pdev->dev, "cannot get clock\n");
1035 ret = PTR_ERR(rspi->clk);
1038 clk_enable(rspi->clk);
1040 init_waitqueue_head(&rspi->wait);
1042 if (rspi_pd && rspi_pd->num_chipselect)
1043 master->num_chipselect = rspi_pd->num_chipselect;
1045 master->num_chipselect = 2; /* default */
1047 master->bus_num = pdev->id;
1048 master->setup = rspi_setup;
1049 master->transfer_one = ops->transfer_one;
1050 master->cleanup = rspi_cleanup;
1051 master->prepare_message = rspi_prepare_message;
1052 master->unprepare_message = rspi_unprepare_message;
1053 master->mode_bits = SPI_CPHA | SPI_CPOL;
1055 ret = platform_get_irq_byname(pdev, "rx");
1057 ret = platform_get_irq_byname(pdev, "mux");
1059 ret = platform_get_irq(pdev, 0);
1061 rspi->rx_irq = rspi->tx_irq = ret;
1064 ret = platform_get_irq_byname(pdev, "tx");
1069 dev_err(&pdev->dev, "platform_get_irq error\n");
1073 if (rspi->rx_irq == rspi->tx_irq) {
1074 /* Single multiplexed interrupt */
1075 ret = rspi_request_irq(&pdev->dev, rspi->rx_irq, rspi_irq_mux,
1078 /* Multi-interrupt mode, only SPRI and SPTI are used */
1079 ret = rspi_request_irq(&pdev->dev, rspi->rx_irq, rspi_irq_rx,
1082 ret = rspi_request_irq(&pdev->dev, rspi->tx_irq,
1083 rspi_irq_tx, "tx", rspi);
1086 dev_err(&pdev->dev, "request_irq error\n");
1090 ret = rspi_request_dma(rspi, pdev);
1092 dev_err(&pdev->dev, "rspi_request_dma failed.\n");
1096 ret = devm_spi_register_master(&pdev->dev, master);
1098 dev_err(&pdev->dev, "spi_register_master error.\n");
1102 dev_info(&pdev->dev, "probed\n");
1107 rspi_release_dma(rspi);
1109 clk_disable(rspi->clk);
1111 spi_master_put(master);
1116 static struct spi_ops rspi_ops = {
1117 .set_config_register = rspi_set_config_register,
1118 .transfer_one = rspi_transfer_one,
1121 static struct spi_ops rspi_rz_ops = {
1122 .set_config_register = rspi_rz_set_config_register,
1123 .transfer_one = rspi_rz_transfer_one,
1126 static struct spi_ops qspi_ops = {
1127 .set_config_register = qspi_set_config_register,
1128 .transfer_one = qspi_transfer_one,
1131 static struct platform_device_id spi_driver_ids[] = {
1132 { "rspi", (kernel_ulong_t)&rspi_ops },
1133 { "rspi-rz", (kernel_ulong_t)&rspi_rz_ops },
1134 { "qspi", (kernel_ulong_t)&qspi_ops },
1138 MODULE_DEVICE_TABLE(platform, spi_driver_ids);
1140 static struct platform_driver rspi_driver = {
1141 .probe = rspi_probe,
1142 .remove = rspi_remove,
1143 .id_table = spi_driver_ids,
1145 .name = "renesas_spi",
1146 .owner = THIS_MODULE,
1149 module_platform_driver(rspi_driver);
1151 MODULE_DESCRIPTION("Renesas RSPI bus driver");
1152 MODULE_LICENSE("GPL v2");
1153 MODULE_AUTHOR("Yoshihiro Shimoda");
1154 MODULE_ALIAS("platform:rspi");