Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * SuperH MSIOF SPI Controller Interface
4 *
5 * Copyright (c) 2009 Magnus Damm
6 * Copyright (C) 2014 Renesas Electronics Corporation
7 * Copyright (C) 2014-2017 Glider bvba
8 */
9
10#include <linux/bitmap.h>
11#include <linux/clk.h>
12#include <linux/completion.h>
13#include <linux/delay.h>
14#include <linux/dma-mapping.h>
15#include <linux/dmaengine.h>
16#include <linux/err.h>
17#include <linux/interrupt.h>
18#include <linux/io.h>
19#include <linux/iopoll.h>
20#include <linux/kernel.h>
21#include <linux/module.h>
22#include <linux/of.h>
23#include <linux/of_device.h>
24#include <linux/platform_device.h>
25#include <linux/pm_runtime.h>
26#include <linux/sh_dma.h>
27
28#include <linux/spi/sh_msiof.h>
29#include <linux/spi/spi.h>
30
31#include <asm/unaligned.h>
32
33struct sh_msiof_chipdata {
34 u32 bits_per_word_mask;
35 u16 tx_fifo_size;
36 u16 rx_fifo_size;
37 u16 ctlr_flags;
38 u16 min_div_pow;
39};
40
41struct sh_msiof_spi_priv {
42 struct spi_controller *ctlr;
43 void __iomem *mapbase;
44 struct clk *clk;
45 struct platform_device *pdev;
46 struct sh_msiof_spi_info *info;
47 struct completion done;
48 struct completion done_txdma;
49 unsigned int tx_fifo_size;
50 unsigned int rx_fifo_size;
51 unsigned int min_div_pow;
52 void *tx_dma_page;
53 void *rx_dma_page;
54 dma_addr_t tx_dma_addr;
55 dma_addr_t rx_dma_addr;
56 bool native_cs_inited;
57 bool native_cs_high;
58 bool slave_aborted;
59};
60
61#define MAX_SS 3 /* Maximum number of native chip selects */
62
63#define SITMDR1 0x00 /* Transmit Mode Register 1 */
64#define SITMDR2 0x04 /* Transmit Mode Register 2 */
65#define SITMDR3 0x08 /* Transmit Mode Register 3 */
66#define SIRMDR1 0x10 /* Receive Mode Register 1 */
67#define SIRMDR2 0x14 /* Receive Mode Register 2 */
68#define SIRMDR3 0x18 /* Receive Mode Register 3 */
69#define SITSCR 0x20 /* Transmit Clock Select Register */
70#define SIRSCR 0x22 /* Receive Clock Select Register (SH, A1, APE6) */
71#define SICTR 0x28 /* Control Register */
72#define SIFCTR 0x30 /* FIFO Control Register */
73#define SISTR 0x40 /* Status Register */
74#define SIIER 0x44 /* Interrupt Enable Register */
75#define SITDR1 0x48 /* Transmit Control Data Register 1 (SH, A1) */
76#define SITDR2 0x4c /* Transmit Control Data Register 2 (SH, A1) */
77#define SITFDR 0x50 /* Transmit FIFO Data Register */
78#define SIRDR1 0x58 /* Receive Control Data Register 1 (SH, A1) */
79#define SIRDR2 0x5c /* Receive Control Data Register 2 (SH, A1) */
80#define SIRFDR 0x60 /* Receive FIFO Data Register */
81
82/* SITMDR1 and SIRMDR1 */
83#define SIMDR1_TRMD BIT(31) /* Transfer Mode (1 = Master mode) */
84#define SIMDR1_SYNCMD_MASK GENMASK(29, 28) /* SYNC Mode */
85#define SIMDR1_SYNCMD_SPI (2 << 28) /* Level mode/SPI */
86#define SIMDR1_SYNCMD_LR (3 << 28) /* L/R mode */
87#define SIMDR1_SYNCAC_SHIFT 25 /* Sync Polarity (1 = Active-low) */
88#define SIMDR1_BITLSB_SHIFT 24 /* MSB/LSB First (1 = LSB first) */
89#define SIMDR1_DTDL_SHIFT 20 /* Data Pin Bit Delay for MSIOF_SYNC */
90#define SIMDR1_SYNCDL_SHIFT 16 /* Frame Sync Signal Timing Delay */
91#define SIMDR1_FLD_MASK GENMASK(3, 2) /* Frame Sync Signal Interval (0-3) */
92#define SIMDR1_FLD_SHIFT 2
93#define SIMDR1_XXSTP BIT(0) /* Transmission/Reception Stop on FIFO */
94/* SITMDR1 */
95#define SITMDR1_PCON BIT(30) /* Transfer Signal Connection */
96#define SITMDR1_SYNCCH_MASK GENMASK(27, 26) /* Sync Signal Channel Select */
97#define SITMDR1_SYNCCH_SHIFT 26 /* 0=MSIOF_SYNC, 1=MSIOF_SS1, 2=MSIOF_SS2 */
98
99/* SITMDR2 and SIRMDR2 */
100#define SIMDR2_BITLEN1(i) (((i) - 1) << 24) /* Data Size (8-32 bits) */
101#define SIMDR2_WDLEN1(i) (((i) - 1) << 16) /* Word Count (1-64/256 (SH, A1))) */
102#define SIMDR2_GRPMASK1 BIT(0) /* Group Output Mask 1 (SH, A1) */
103
104/* SITSCR and SIRSCR */
105#define SISCR_BRPS_MASK GENMASK(12, 8) /* Prescaler Setting (1-32) */
106#define SISCR_BRPS(i) (((i) - 1) << 8)
107#define SISCR_BRDV_MASK GENMASK(2, 0) /* Baud Rate Generator's Division Ratio */
108#define SISCR_BRDV_DIV_2 0
109#define SISCR_BRDV_DIV_4 1
110#define SISCR_BRDV_DIV_8 2
111#define SISCR_BRDV_DIV_16 3
112#define SISCR_BRDV_DIV_32 4
113#define SISCR_BRDV_DIV_1 7
114
115/* SICTR */
116#define SICTR_TSCKIZ_MASK GENMASK(31, 30) /* Transmit Clock I/O Polarity Select */
117#define SICTR_TSCKIZ_SCK BIT(31) /* Disable SCK when TX disabled */
118#define SICTR_TSCKIZ_POL_SHIFT 30 /* Transmit Clock Polarity */
119#define SICTR_RSCKIZ_MASK GENMASK(29, 28) /* Receive Clock Polarity Select */
120#define SICTR_RSCKIZ_SCK BIT(29) /* Must match CTR_TSCKIZ_SCK */
121#define SICTR_RSCKIZ_POL_SHIFT 28 /* Receive Clock Polarity */
122#define SICTR_TEDG_SHIFT 27 /* Transmit Timing (1 = falling edge) */
123#define SICTR_REDG_SHIFT 26 /* Receive Timing (1 = falling edge) */
124#define SICTR_TXDIZ_MASK GENMASK(23, 22) /* Pin Output When TX is Disabled */
125#define SICTR_TXDIZ_LOW (0 << 22) /* 0 */
126#define SICTR_TXDIZ_HIGH (1 << 22) /* 1 */
127#define SICTR_TXDIZ_HIZ (2 << 22) /* High-impedance */
128#define SICTR_TSCKE BIT(15) /* Transmit Serial Clock Output Enable */
129#define SICTR_TFSE BIT(14) /* Transmit Frame Sync Signal Output Enable */
130#define SICTR_TXE BIT(9) /* Transmit Enable */
131#define SICTR_RXE BIT(8) /* Receive Enable */
132#define SICTR_TXRST BIT(1) /* Transmit Reset */
133#define SICTR_RXRST BIT(0) /* Receive Reset */
134
135/* SIFCTR */
136#define SIFCTR_TFWM_MASK GENMASK(31, 29) /* Transmit FIFO Watermark */
137#define SIFCTR_TFWM_64 (0 << 29) /* Transfer Request when 64 empty stages */
138#define SIFCTR_TFWM_32 (1 << 29) /* Transfer Request when 32 empty stages */
139#define SIFCTR_TFWM_24 (2 << 29) /* Transfer Request when 24 empty stages */
140#define SIFCTR_TFWM_16 (3 << 29) /* Transfer Request when 16 empty stages */
141#define SIFCTR_TFWM_12 (4 << 29) /* Transfer Request when 12 empty stages */
142#define SIFCTR_TFWM_8 (5 << 29) /* Transfer Request when 8 empty stages */
143#define SIFCTR_TFWM_4 (6 << 29) /* Transfer Request when 4 empty stages */
144#define SIFCTR_TFWM_1 (7 << 29) /* Transfer Request when 1 empty stage */
145#define SIFCTR_TFUA_MASK GENMASK(26, 20) /* Transmit FIFO Usable Area */
146#define SIFCTR_TFUA_SHIFT 20
147#define SIFCTR_TFUA(i) ((i) << SIFCTR_TFUA_SHIFT)
148#define SIFCTR_RFWM_MASK GENMASK(15, 13) /* Receive FIFO Watermark */
149#define SIFCTR_RFWM_1 (0 << 13) /* Transfer Request when 1 valid stages */
150#define SIFCTR_RFWM_4 (1 << 13) /* Transfer Request when 4 valid stages */
151#define SIFCTR_RFWM_8 (2 << 13) /* Transfer Request when 8 valid stages */
152#define SIFCTR_RFWM_16 (3 << 13) /* Transfer Request when 16 valid stages */
153#define SIFCTR_RFWM_32 (4 << 13) /* Transfer Request when 32 valid stages */
154#define SIFCTR_RFWM_64 (5 << 13) /* Transfer Request when 64 valid stages */
155#define SIFCTR_RFWM_128 (6 << 13) /* Transfer Request when 128 valid stages */
156#define SIFCTR_RFWM_256 (7 << 13) /* Transfer Request when 256 valid stages */
157#define SIFCTR_RFUA_MASK GENMASK(12, 4) /* Receive FIFO Usable Area (0x40 = full) */
158#define SIFCTR_RFUA_SHIFT 4
159#define SIFCTR_RFUA(i) ((i) << SIFCTR_RFUA_SHIFT)
160
161/* SISTR */
162#define SISTR_TFEMP BIT(29) /* Transmit FIFO Empty */
163#define SISTR_TDREQ BIT(28) /* Transmit Data Transfer Request */
164#define SISTR_TEOF BIT(23) /* Frame Transmission End */
165#define SISTR_TFSERR BIT(21) /* Transmit Frame Synchronization Error */
166#define SISTR_TFOVF BIT(20) /* Transmit FIFO Overflow */
167#define SISTR_TFUDF BIT(19) /* Transmit FIFO Underflow */
168#define SISTR_RFFUL BIT(13) /* Receive FIFO Full */
169#define SISTR_RDREQ BIT(12) /* Receive Data Transfer Request */
170#define SISTR_REOF BIT(7) /* Frame Reception End */
171#define SISTR_RFSERR BIT(5) /* Receive Frame Synchronization Error */
172#define SISTR_RFUDF BIT(4) /* Receive FIFO Underflow */
173#define SISTR_RFOVF BIT(3) /* Receive FIFO Overflow */
174
175/* SIIER */
176#define SIIER_TDMAE BIT(31) /* Transmit Data DMA Transfer Req. Enable */
177#define SIIER_TFEMPE BIT(29) /* Transmit FIFO Empty Enable */
178#define SIIER_TDREQE BIT(28) /* Transmit Data Transfer Request Enable */
179#define SIIER_TEOFE BIT(23) /* Frame Transmission End Enable */
180#define SIIER_TFSERRE BIT(21) /* Transmit Frame Sync Error Enable */
181#define SIIER_TFOVFE BIT(20) /* Transmit FIFO Overflow Enable */
182#define SIIER_TFUDFE BIT(19) /* Transmit FIFO Underflow Enable */
183#define SIIER_RDMAE BIT(15) /* Receive Data DMA Transfer Req. Enable */
184#define SIIER_RFFULE BIT(13) /* Receive FIFO Full Enable */
185#define SIIER_RDREQE BIT(12) /* Receive Data Transfer Request Enable */
186#define SIIER_REOFE BIT(7) /* Frame Reception End Enable */
187#define SIIER_RFSERRE BIT(5) /* Receive Frame Sync Error Enable */
188#define SIIER_RFUDFE BIT(4) /* Receive FIFO Underflow Enable */
189#define SIIER_RFOVFE BIT(3) /* Receive FIFO Overflow Enable */
190
191
192static u32 sh_msiof_read(struct sh_msiof_spi_priv *p, int reg_offs)
193{
194 switch (reg_offs) {
195 case SITSCR:
196 case SIRSCR:
197 return ioread16(p->mapbase + reg_offs);
198 default:
199 return ioread32(p->mapbase + reg_offs);
200 }
201}
202
203static void sh_msiof_write(struct sh_msiof_spi_priv *p, int reg_offs,
204 u32 value)
205{
206 switch (reg_offs) {
207 case SITSCR:
208 case SIRSCR:
209 iowrite16(value, p->mapbase + reg_offs);
210 break;
211 default:
212 iowrite32(value, p->mapbase + reg_offs);
213 break;
214 }
215}
216
217static int sh_msiof_modify_ctr_wait(struct sh_msiof_spi_priv *p,
218 u32 clr, u32 set)
219{
220 u32 mask = clr | set;
221 u32 data;
222
223 data = sh_msiof_read(p, SICTR);
224 data &= ~clr;
225 data |= set;
226 sh_msiof_write(p, SICTR, data);
227
228 return readl_poll_timeout_atomic(p->mapbase + SICTR, data,
229 (data & mask) == set, 1, 100);
230}
231
232static irqreturn_t sh_msiof_spi_irq(int irq, void *data)
233{
234 struct sh_msiof_spi_priv *p = data;
235
236 /* just disable the interrupt and wake up */
237 sh_msiof_write(p, SIIER, 0);
238 complete(&p->done);
239
240 return IRQ_HANDLED;
241}
242
243static void sh_msiof_spi_reset_regs(struct sh_msiof_spi_priv *p)
244{
245 u32 mask = SICTR_TXRST | SICTR_RXRST;
246 u32 data;
247
248 data = sh_msiof_read(p, SICTR);
249 data |= mask;
250 sh_msiof_write(p, SICTR, data);
251
252 readl_poll_timeout_atomic(p->mapbase + SICTR, data, !(data & mask), 1,
253 100);
254}
255
256static const u32 sh_msiof_spi_div_array[] = {
257 SISCR_BRDV_DIV_1, SISCR_BRDV_DIV_2, SISCR_BRDV_DIV_4,
258 SISCR_BRDV_DIV_8, SISCR_BRDV_DIV_16, SISCR_BRDV_DIV_32,
259};
260
261static void sh_msiof_spi_set_clk_regs(struct sh_msiof_spi_priv *p,
262 struct spi_transfer *t)
263{
264 unsigned long parent_rate = clk_get_rate(p->clk);
265 unsigned int div_pow = p->min_div_pow;
266 u32 spi_hz = t->speed_hz;
267 unsigned long div;
268 u32 brps, scr;
269
270 if (!spi_hz || !parent_rate) {
271 WARN(1, "Invalid clock rate parameters %lu and %u\n",
272 parent_rate, spi_hz);
273 return;
274 }
275
276 div = DIV_ROUND_UP(parent_rate, spi_hz);
277 if (div <= 1024) {
278 /* SISCR_BRDV_DIV_1 is valid only if BRPS is x 1/1 or x 1/2 */
279 if (!div_pow && div <= 32 && div > 2)
280 div_pow = 1;
281
282 if (div_pow)
283 brps = (div + 1) >> div_pow;
284 else
285 brps = div;
286
287 for (; brps > 32; div_pow++)
288 brps = (brps + 1) >> 1;
289 } else {
290 /* Set transfer rate composite divisor to 2^5 * 32 = 1024 */
291 dev_err(&p->pdev->dev,
292 "Requested SPI transfer rate %d is too low\n", spi_hz);
293 div_pow = 5;
294 brps = 32;
295 }
296
297 t->effective_speed_hz = parent_rate / (brps << div_pow);
298
299 scr = sh_msiof_spi_div_array[div_pow] | SISCR_BRPS(brps);
300 sh_msiof_write(p, SITSCR, scr);
301 if (!(p->ctlr->flags & SPI_CONTROLLER_MUST_TX))
302 sh_msiof_write(p, SIRSCR, scr);
303}
304
305static u32 sh_msiof_get_delay_bit(u32 dtdl_or_syncdl)
306{
307 /*
308 * DTDL/SYNCDL bit : p->info->dtdl or p->info->syncdl
309 * b'000 : 0
310 * b'001 : 100
311 * b'010 : 200
312 * b'011 (SYNCDL only) : 300
313 * b'101 : 50
314 * b'110 : 150
315 */
316 if (dtdl_or_syncdl % 100)
317 return dtdl_or_syncdl / 100 + 5;
318 else
319 return dtdl_or_syncdl / 100;
320}
321
322static u32 sh_msiof_spi_get_dtdl_and_syncdl(struct sh_msiof_spi_priv *p)
323{
324 u32 val;
325
326 if (!p->info)
327 return 0;
328
329 /* check if DTDL and SYNCDL is allowed value */
330 if (p->info->dtdl > 200 || p->info->syncdl > 300) {
331 dev_warn(&p->pdev->dev, "DTDL or SYNCDL is too large\n");
332 return 0;
333 }
334
335 /* check if the sum of DTDL and SYNCDL becomes an integer value */
336 if ((p->info->dtdl + p->info->syncdl) % 100) {
337 dev_warn(&p->pdev->dev, "the sum of DTDL/SYNCDL is not good\n");
338 return 0;
339 }
340
341 val = sh_msiof_get_delay_bit(p->info->dtdl) << SIMDR1_DTDL_SHIFT;
342 val |= sh_msiof_get_delay_bit(p->info->syncdl) << SIMDR1_SYNCDL_SHIFT;
343
344 return val;
345}
346
347static void sh_msiof_spi_set_pin_regs(struct sh_msiof_spi_priv *p, u32 ss,
348 u32 cpol, u32 cpha,
349 u32 tx_hi_z, u32 lsb_first, u32 cs_high)
350{
351 u32 tmp;
352 int edge;
353
354 /*
355 * CPOL CPHA TSCKIZ RSCKIZ TEDG REDG
356 * 0 0 10 10 1 1
357 * 0 1 10 10 0 0
358 * 1 0 11 11 0 0
359 * 1 1 11 11 1 1
360 */
361 tmp = SIMDR1_SYNCMD_SPI | 1 << SIMDR1_FLD_SHIFT | SIMDR1_XXSTP;
362 tmp |= !cs_high << SIMDR1_SYNCAC_SHIFT;
363 tmp |= lsb_first << SIMDR1_BITLSB_SHIFT;
364 tmp |= sh_msiof_spi_get_dtdl_and_syncdl(p);
365 if (spi_controller_is_slave(p->ctlr)) {
366 sh_msiof_write(p, SITMDR1, tmp | SITMDR1_PCON);
367 } else {
368 sh_msiof_write(p, SITMDR1,
369 tmp | SIMDR1_TRMD | SITMDR1_PCON |
370 (ss < MAX_SS ? ss : 0) << SITMDR1_SYNCCH_SHIFT);
371 }
372 if (p->ctlr->flags & SPI_CONTROLLER_MUST_TX) {
373 /* These bits are reserved if RX needs TX */
374 tmp &= ~0x0000ffff;
375 }
376 sh_msiof_write(p, SIRMDR1, tmp);
377
378 tmp = 0;
379 tmp |= SICTR_TSCKIZ_SCK | cpol << SICTR_TSCKIZ_POL_SHIFT;
380 tmp |= SICTR_RSCKIZ_SCK | cpol << SICTR_RSCKIZ_POL_SHIFT;
381
382 edge = cpol ^ !cpha;
383
384 tmp |= edge << SICTR_TEDG_SHIFT;
385 tmp |= edge << SICTR_REDG_SHIFT;
386 tmp |= tx_hi_z ? SICTR_TXDIZ_HIZ : SICTR_TXDIZ_LOW;
387 sh_msiof_write(p, SICTR, tmp);
388}
389
390static void sh_msiof_spi_set_mode_regs(struct sh_msiof_spi_priv *p,
391 const void *tx_buf, void *rx_buf,
392 u32 bits, u32 words)
393{
394 u32 dr2 = SIMDR2_BITLEN1(bits) | SIMDR2_WDLEN1(words);
395
396 if (tx_buf || (p->ctlr->flags & SPI_CONTROLLER_MUST_TX))
397 sh_msiof_write(p, SITMDR2, dr2);
398 else
399 sh_msiof_write(p, SITMDR2, dr2 | SIMDR2_GRPMASK1);
400
401 if (rx_buf)
402 sh_msiof_write(p, SIRMDR2, dr2);
403}
404
405static void sh_msiof_reset_str(struct sh_msiof_spi_priv *p)
406{
407 sh_msiof_write(p, SISTR,
408 sh_msiof_read(p, SISTR) & ~(SISTR_TDREQ | SISTR_RDREQ));
409}
410
411static void sh_msiof_spi_write_fifo_8(struct sh_msiof_spi_priv *p,
412 const void *tx_buf, int words, int fs)
413{
414 const u8 *buf_8 = tx_buf;
415 int k;
416
417 for (k = 0; k < words; k++)
418 sh_msiof_write(p, SITFDR, buf_8[k] << fs);
419}
420
421static void sh_msiof_spi_write_fifo_16(struct sh_msiof_spi_priv *p,
422 const void *tx_buf, int words, int fs)
423{
424 const u16 *buf_16 = tx_buf;
425 int k;
426
427 for (k = 0; k < words; k++)
428 sh_msiof_write(p, SITFDR, buf_16[k] << fs);
429}
430
431static void sh_msiof_spi_write_fifo_16u(struct sh_msiof_spi_priv *p,
432 const void *tx_buf, int words, int fs)
433{
434 const u16 *buf_16 = tx_buf;
435 int k;
436
437 for (k = 0; k < words; k++)
438 sh_msiof_write(p, SITFDR, get_unaligned(&buf_16[k]) << fs);
439}
440
441static void sh_msiof_spi_write_fifo_32(struct sh_msiof_spi_priv *p,
442 const void *tx_buf, int words, int fs)
443{
444 const u32 *buf_32 = tx_buf;
445 int k;
446
447 for (k = 0; k < words; k++)
448 sh_msiof_write(p, SITFDR, buf_32[k] << fs);
449}
450
451static void sh_msiof_spi_write_fifo_32u(struct sh_msiof_spi_priv *p,
452 const void *tx_buf, int words, int fs)
453{
454 const u32 *buf_32 = tx_buf;
455 int k;
456
457 for (k = 0; k < words; k++)
458 sh_msiof_write(p, SITFDR, get_unaligned(&buf_32[k]) << fs);
459}
460
461static void sh_msiof_spi_write_fifo_s32(struct sh_msiof_spi_priv *p,
462 const void *tx_buf, int words, int fs)
463{
464 const u32 *buf_32 = tx_buf;
465 int k;
466
467 for (k = 0; k < words; k++)
468 sh_msiof_write(p, SITFDR, swab32(buf_32[k] << fs));
469}
470
471static void sh_msiof_spi_write_fifo_s32u(struct sh_msiof_spi_priv *p,
472 const void *tx_buf, int words, int fs)
473{
474 const u32 *buf_32 = tx_buf;
475 int k;
476
477 for (k = 0; k < words; k++)
478 sh_msiof_write(p, SITFDR, swab32(get_unaligned(&buf_32[k]) << fs));
479}
480
481static void sh_msiof_spi_read_fifo_8(struct sh_msiof_spi_priv *p,
482 void *rx_buf, int words, int fs)
483{
484 u8 *buf_8 = rx_buf;
485 int k;
486
487 for (k = 0; k < words; k++)
488 buf_8[k] = sh_msiof_read(p, SIRFDR) >> fs;
489}
490
491static void sh_msiof_spi_read_fifo_16(struct sh_msiof_spi_priv *p,
492 void *rx_buf, int words, int fs)
493{
494 u16 *buf_16 = rx_buf;
495 int k;
496
497 for (k = 0; k < words; k++)
498 buf_16[k] = sh_msiof_read(p, SIRFDR) >> fs;
499}
500
501static void sh_msiof_spi_read_fifo_16u(struct sh_msiof_spi_priv *p,
502 void *rx_buf, int words, int fs)
503{
504 u16 *buf_16 = rx_buf;
505 int k;
506
507 for (k = 0; k < words; k++)
508 put_unaligned(sh_msiof_read(p, SIRFDR) >> fs, &buf_16[k]);
509}
510
511static void sh_msiof_spi_read_fifo_32(struct sh_msiof_spi_priv *p,
512 void *rx_buf, int words, int fs)
513{
514 u32 *buf_32 = rx_buf;
515 int k;
516
517 for (k = 0; k < words; k++)
518 buf_32[k] = sh_msiof_read(p, SIRFDR) >> fs;
519}
520
521static void sh_msiof_spi_read_fifo_32u(struct sh_msiof_spi_priv *p,
522 void *rx_buf, int words, int fs)
523{
524 u32 *buf_32 = rx_buf;
525 int k;
526
527 for (k = 0; k < words; k++)
528 put_unaligned(sh_msiof_read(p, SIRFDR) >> fs, &buf_32[k]);
529}
530
531static void sh_msiof_spi_read_fifo_s32(struct sh_msiof_spi_priv *p,
532 void *rx_buf, int words, int fs)
533{
534 u32 *buf_32 = rx_buf;
535 int k;
536
537 for (k = 0; k < words; k++)
538 buf_32[k] = swab32(sh_msiof_read(p, SIRFDR) >> fs);
539}
540
541static void sh_msiof_spi_read_fifo_s32u(struct sh_msiof_spi_priv *p,
542 void *rx_buf, int words, int fs)
543{
544 u32 *buf_32 = rx_buf;
545 int k;
546
547 for (k = 0; k < words; k++)
548 put_unaligned(swab32(sh_msiof_read(p, SIRFDR) >> fs), &buf_32[k]);
549}
550
551static int sh_msiof_spi_setup(struct spi_device *spi)
552{
553 struct sh_msiof_spi_priv *p =
554 spi_controller_get_devdata(spi->controller);
555 u32 clr, set, tmp;
556
557 if (spi->cs_gpiod || spi_controller_is_slave(p->ctlr))
558 return 0;
559
560 if (p->native_cs_inited &&
561 (p->native_cs_high == !!(spi->mode & SPI_CS_HIGH)))
562 return 0;
563
564 /* Configure native chip select mode/polarity early */
565 clr = SIMDR1_SYNCMD_MASK;
566 set = SIMDR1_SYNCMD_SPI;
567 if (spi->mode & SPI_CS_HIGH)
568 clr |= BIT(SIMDR1_SYNCAC_SHIFT);
569 else
570 set |= BIT(SIMDR1_SYNCAC_SHIFT);
571 pm_runtime_get_sync(&p->pdev->dev);
572 tmp = sh_msiof_read(p, SITMDR1) & ~clr;
573 sh_msiof_write(p, SITMDR1, tmp | set | SIMDR1_TRMD | SITMDR1_PCON);
574 tmp = sh_msiof_read(p, SIRMDR1) & ~clr;
575 sh_msiof_write(p, SIRMDR1, tmp | set);
576 pm_runtime_put(&p->pdev->dev);
577 p->native_cs_high = spi->mode & SPI_CS_HIGH;
578 p->native_cs_inited = true;
579 return 0;
580}
581
582static int sh_msiof_prepare_message(struct spi_controller *ctlr,
583 struct spi_message *msg)
584{
585 struct sh_msiof_spi_priv *p = spi_controller_get_devdata(ctlr);
586 const struct spi_device *spi = msg->spi;
587 u32 ss, cs_high;
588
589 /* Configure pins before asserting CS */
590 if (spi->cs_gpiod) {
591 ss = ctlr->unused_native_cs;
592 cs_high = p->native_cs_high;
593 } else {
594 ss = spi->chip_select;
595 cs_high = !!(spi->mode & SPI_CS_HIGH);
596 }
597 sh_msiof_spi_set_pin_regs(p, ss, !!(spi->mode & SPI_CPOL),
598 !!(spi->mode & SPI_CPHA),
599 !!(spi->mode & SPI_3WIRE),
600 !!(spi->mode & SPI_LSB_FIRST), cs_high);
601 return 0;
602}
603
604static int sh_msiof_spi_start(struct sh_msiof_spi_priv *p, void *rx_buf)
605{
606 bool slave = spi_controller_is_slave(p->ctlr);
607 int ret = 0;
608
609 /* setup clock and rx/tx signals */
610 if (!slave)
611 ret = sh_msiof_modify_ctr_wait(p, 0, SICTR_TSCKE);
612 if (rx_buf && !ret)
613 ret = sh_msiof_modify_ctr_wait(p, 0, SICTR_RXE);
614 if (!ret)
615 ret = sh_msiof_modify_ctr_wait(p, 0, SICTR_TXE);
616
617 /* start by setting frame bit */
618 if (!ret && !slave)
619 ret = sh_msiof_modify_ctr_wait(p, 0, SICTR_TFSE);
620
621 return ret;
622}
623
624static int sh_msiof_spi_stop(struct sh_msiof_spi_priv *p, void *rx_buf)
625{
626 bool slave = spi_controller_is_slave(p->ctlr);
627 int ret = 0;
628
629 /* shut down frame, rx/tx and clock signals */
630 if (!slave)
631 ret = sh_msiof_modify_ctr_wait(p, SICTR_TFSE, 0);
632 if (!ret)
633 ret = sh_msiof_modify_ctr_wait(p, SICTR_TXE, 0);
634 if (rx_buf && !ret)
635 ret = sh_msiof_modify_ctr_wait(p, SICTR_RXE, 0);
636 if (!ret && !slave)
637 ret = sh_msiof_modify_ctr_wait(p, SICTR_TSCKE, 0);
638
639 return ret;
640}
641
642static int sh_msiof_slave_abort(struct spi_controller *ctlr)
643{
644 struct sh_msiof_spi_priv *p = spi_controller_get_devdata(ctlr);
645
646 p->slave_aborted = true;
647 complete(&p->done);
648 complete(&p->done_txdma);
649 return 0;
650}
651
652static int sh_msiof_wait_for_completion(struct sh_msiof_spi_priv *p,
653 struct completion *x)
654{
655 if (spi_controller_is_slave(p->ctlr)) {
656 if (wait_for_completion_interruptible(x) ||
657 p->slave_aborted) {
658 dev_dbg(&p->pdev->dev, "interrupted\n");
659 return -EINTR;
660 }
661 } else {
662 if (!wait_for_completion_timeout(x, HZ)) {
663 dev_err(&p->pdev->dev, "timeout\n");
664 return -ETIMEDOUT;
665 }
666 }
667
668 return 0;
669}
670
671static int sh_msiof_spi_txrx_once(struct sh_msiof_spi_priv *p,
672 void (*tx_fifo)(struct sh_msiof_spi_priv *,
673 const void *, int, int),
674 void (*rx_fifo)(struct sh_msiof_spi_priv *,
675 void *, int, int),
676 const void *tx_buf, void *rx_buf,
677 int words, int bits)
678{
679 int fifo_shift;
680 int ret;
681
682 /* limit maximum word transfer to rx/tx fifo size */
683 if (tx_buf)
684 words = min_t(int, words, p->tx_fifo_size);
685 if (rx_buf)
686 words = min_t(int, words, p->rx_fifo_size);
687
688 /* the fifo contents need shifting */
689 fifo_shift = 32 - bits;
690
691 /* default FIFO watermarks for PIO */
692 sh_msiof_write(p, SIFCTR, 0);
693
694 /* setup msiof transfer mode registers */
695 sh_msiof_spi_set_mode_regs(p, tx_buf, rx_buf, bits, words);
696 sh_msiof_write(p, SIIER, SIIER_TEOFE | SIIER_REOFE);
697
698 /* write tx fifo */
699 if (tx_buf)
700 tx_fifo(p, tx_buf, words, fifo_shift);
701
702 reinit_completion(&p->done);
703 p->slave_aborted = false;
704
705 ret = sh_msiof_spi_start(p, rx_buf);
706 if (ret) {
707 dev_err(&p->pdev->dev, "failed to start hardware\n");
708 goto stop_ier;
709 }
710
711 /* wait for tx fifo to be emptied / rx fifo to be filled */
712 ret = sh_msiof_wait_for_completion(p, &p->done);
713 if (ret)
714 goto stop_reset;
715
716 /* read rx fifo */
717 if (rx_buf)
718 rx_fifo(p, rx_buf, words, fifo_shift);
719
720 /* clear status bits */
721 sh_msiof_reset_str(p);
722
723 ret = sh_msiof_spi_stop(p, rx_buf);
724 if (ret) {
725 dev_err(&p->pdev->dev, "failed to shut down hardware\n");
726 return ret;
727 }
728
729 return words;
730
731stop_reset:
732 sh_msiof_reset_str(p);
733 sh_msiof_spi_stop(p, rx_buf);
734stop_ier:
735 sh_msiof_write(p, SIIER, 0);
736 return ret;
737}
738
739static void sh_msiof_dma_complete(void *arg)
740{
741 complete(arg);
742}
743
744static int sh_msiof_dma_once(struct sh_msiof_spi_priv *p, const void *tx,
745 void *rx, unsigned int len)
746{
747 u32 ier_bits = 0;
748 struct dma_async_tx_descriptor *desc_tx = NULL, *desc_rx = NULL;
749 dma_cookie_t cookie;
750 int ret;
751
752 /* First prepare and submit the DMA request(s), as this may fail */
753 if (rx) {
754 ier_bits |= SIIER_RDREQE | SIIER_RDMAE;
755 desc_rx = dmaengine_prep_slave_single(p->ctlr->dma_rx,
756 p->rx_dma_addr, len, DMA_DEV_TO_MEM,
757 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
758 if (!desc_rx)
759 return -EAGAIN;
760
761 desc_rx->callback = sh_msiof_dma_complete;
762 desc_rx->callback_param = &p->done;
763 cookie = dmaengine_submit(desc_rx);
764 if (dma_submit_error(cookie))
765 return cookie;
766 }
767
768 if (tx) {
769 ier_bits |= SIIER_TDREQE | SIIER_TDMAE;
770 dma_sync_single_for_device(p->ctlr->dma_tx->device->dev,
771 p->tx_dma_addr, len, DMA_TO_DEVICE);
772 desc_tx = dmaengine_prep_slave_single(p->ctlr->dma_tx,
773 p->tx_dma_addr, len, DMA_MEM_TO_DEV,
774 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
775 if (!desc_tx) {
776 ret = -EAGAIN;
777 goto no_dma_tx;
778 }
779
780 desc_tx->callback = sh_msiof_dma_complete;
781 desc_tx->callback_param = &p->done_txdma;
782 cookie = dmaengine_submit(desc_tx);
783 if (dma_submit_error(cookie)) {
784 ret = cookie;
785 goto no_dma_tx;
786 }
787 }
788
789 /* 1 stage FIFO watermarks for DMA */
790 sh_msiof_write(p, SIFCTR, SIFCTR_TFWM_1 | SIFCTR_RFWM_1);
791
792 /* setup msiof transfer mode registers (32-bit words) */
793 sh_msiof_spi_set_mode_regs(p, tx, rx, 32, len / 4);
794
795 sh_msiof_write(p, SIIER, ier_bits);
796
797 reinit_completion(&p->done);
798 if (tx)
799 reinit_completion(&p->done_txdma);
800 p->slave_aborted = false;
801
802 /* Now start DMA */
803 if (rx)
804 dma_async_issue_pending(p->ctlr->dma_rx);
805 if (tx)
806 dma_async_issue_pending(p->ctlr->dma_tx);
807
808 ret = sh_msiof_spi_start(p, rx);
809 if (ret) {
810 dev_err(&p->pdev->dev, "failed to start hardware\n");
811 goto stop_dma;
812 }
813
814 if (tx) {
815 /* wait for tx DMA completion */
816 ret = sh_msiof_wait_for_completion(p, &p->done_txdma);
817 if (ret)
818 goto stop_reset;
819 }
820
821 if (rx) {
822 /* wait for rx DMA completion */
823 ret = sh_msiof_wait_for_completion(p, &p->done);
824 if (ret)
825 goto stop_reset;
826
827 sh_msiof_write(p, SIIER, 0);
828 } else {
829 /* wait for tx fifo to be emptied */
830 sh_msiof_write(p, SIIER, SIIER_TEOFE);
831 ret = sh_msiof_wait_for_completion(p, &p->done);
832 if (ret)
833 goto stop_reset;
834 }
835
836 /* clear status bits */
837 sh_msiof_reset_str(p);
838
839 ret = sh_msiof_spi_stop(p, rx);
840 if (ret) {
841 dev_err(&p->pdev->dev, "failed to shut down hardware\n");
842 return ret;
843 }
844
845 if (rx)
846 dma_sync_single_for_cpu(p->ctlr->dma_rx->device->dev,
847 p->rx_dma_addr, len, DMA_FROM_DEVICE);
848
849 return 0;
850
851stop_reset:
852 sh_msiof_reset_str(p);
853 sh_msiof_spi_stop(p, rx);
854stop_dma:
855 if (tx)
856 dmaengine_terminate_sync(p->ctlr->dma_tx);
857no_dma_tx:
858 if (rx)
859 dmaengine_terminate_sync(p->ctlr->dma_rx);
860 sh_msiof_write(p, SIIER, 0);
861 return ret;
862}
863
864static void copy_bswap32(u32 *dst, const u32 *src, unsigned int words)
865{
866 /* src or dst can be unaligned, but not both */
867 if ((unsigned long)src & 3) {
868 while (words--) {
869 *dst++ = swab32(get_unaligned(src));
870 src++;
871 }
872 } else if ((unsigned long)dst & 3) {
873 while (words--) {
874 put_unaligned(swab32(*src++), dst);
875 dst++;
876 }
877 } else {
878 while (words--)
879 *dst++ = swab32(*src++);
880 }
881}
882
883static void copy_wswap32(u32 *dst, const u32 *src, unsigned int words)
884{
885 /* src or dst can be unaligned, but not both */
886 if ((unsigned long)src & 3) {
887 while (words--) {
888 *dst++ = swahw32(get_unaligned(src));
889 src++;
890 }
891 } else if ((unsigned long)dst & 3) {
892 while (words--) {
893 put_unaligned(swahw32(*src++), dst);
894 dst++;
895 }
896 } else {
897 while (words--)
898 *dst++ = swahw32(*src++);
899 }
900}
901
902static void copy_plain32(u32 *dst, const u32 *src, unsigned int words)
903{
904 memcpy(dst, src, words * 4);
905}
906
907static int sh_msiof_transfer_one(struct spi_controller *ctlr,
908 struct spi_device *spi,
909 struct spi_transfer *t)
910{
911 struct sh_msiof_spi_priv *p = spi_controller_get_devdata(ctlr);
912 void (*copy32)(u32 *, const u32 *, unsigned int);
913 void (*tx_fifo)(struct sh_msiof_spi_priv *, const void *, int, int);
914 void (*rx_fifo)(struct sh_msiof_spi_priv *, void *, int, int);
915 const void *tx_buf = t->tx_buf;
916 void *rx_buf = t->rx_buf;
917 unsigned int len = t->len;
918 unsigned int bits = t->bits_per_word;
919 unsigned int bytes_per_word;
920 unsigned int words;
921 int n;
922 bool swab;
923 int ret;
924
925 /* reset registers */
926 sh_msiof_spi_reset_regs(p);
927
928 /* setup clocks (clock already enabled in chipselect()) */
929 if (!spi_controller_is_slave(p->ctlr))
930 sh_msiof_spi_set_clk_regs(p, t);
931
932 while (ctlr->dma_tx && len > 15) {
933 /*
934 * DMA supports 32-bit words only, hence pack 8-bit and 16-bit
935 * words, with byte resp. word swapping.
936 */
937 unsigned int l = 0;
938
939 if (tx_buf)
940 l = min(round_down(len, 4), p->tx_fifo_size * 4);
941 if (rx_buf)
942 l = min(round_down(len, 4), p->rx_fifo_size * 4);
943
944 if (bits <= 8) {
945 copy32 = copy_bswap32;
946 } else if (bits <= 16) {
947 copy32 = copy_wswap32;
948 } else {
949 copy32 = copy_plain32;
950 }
951
952 if (tx_buf)
953 copy32(p->tx_dma_page, tx_buf, l / 4);
954
955 ret = sh_msiof_dma_once(p, tx_buf, rx_buf, l);
956 if (ret == -EAGAIN) {
957 dev_warn_once(&p->pdev->dev,
958 "DMA not available, falling back to PIO\n");
959 break;
960 }
961 if (ret)
962 return ret;
963
964 if (rx_buf) {
965 copy32(rx_buf, p->rx_dma_page, l / 4);
966 rx_buf += l;
967 }
968 if (tx_buf)
969 tx_buf += l;
970
971 len -= l;
972 if (!len)
973 return 0;
974 }
975
976 if (bits <= 8 && len > 15) {
977 bits = 32;
978 swab = true;
979 } else {
980 swab = false;
981 }
982
983 /* setup bytes per word and fifo read/write functions */
984 if (bits <= 8) {
985 bytes_per_word = 1;
986 tx_fifo = sh_msiof_spi_write_fifo_8;
987 rx_fifo = sh_msiof_spi_read_fifo_8;
988 } else if (bits <= 16) {
989 bytes_per_word = 2;
990 if ((unsigned long)tx_buf & 0x01)
991 tx_fifo = sh_msiof_spi_write_fifo_16u;
992 else
993 tx_fifo = sh_msiof_spi_write_fifo_16;
994
995 if ((unsigned long)rx_buf & 0x01)
996 rx_fifo = sh_msiof_spi_read_fifo_16u;
997 else
998 rx_fifo = sh_msiof_spi_read_fifo_16;
999 } else if (swab) {
1000 bytes_per_word = 4;
1001 if ((unsigned long)tx_buf & 0x03)
1002 tx_fifo = sh_msiof_spi_write_fifo_s32u;
1003 else
1004 tx_fifo = sh_msiof_spi_write_fifo_s32;
1005
1006 if ((unsigned long)rx_buf & 0x03)
1007 rx_fifo = sh_msiof_spi_read_fifo_s32u;
1008 else
1009 rx_fifo = sh_msiof_spi_read_fifo_s32;
1010 } else {
1011 bytes_per_word = 4;
1012 if ((unsigned long)tx_buf & 0x03)
1013 tx_fifo = sh_msiof_spi_write_fifo_32u;
1014 else
1015 tx_fifo = sh_msiof_spi_write_fifo_32;
1016
1017 if ((unsigned long)rx_buf & 0x03)
1018 rx_fifo = sh_msiof_spi_read_fifo_32u;
1019 else
1020 rx_fifo = sh_msiof_spi_read_fifo_32;
1021 }
1022
1023 /* transfer in fifo sized chunks */
1024 words = len / bytes_per_word;
1025
1026 while (words > 0) {
1027 n = sh_msiof_spi_txrx_once(p, tx_fifo, rx_fifo, tx_buf, rx_buf,
1028 words, bits);
1029 if (n < 0)
1030 return n;
1031
1032 if (tx_buf)
1033 tx_buf += n * bytes_per_word;
1034 if (rx_buf)
1035 rx_buf += n * bytes_per_word;
1036 words -= n;
1037
1038 if (words == 0 && (len % bytes_per_word)) {
1039 words = len % bytes_per_word;
1040 bits = t->bits_per_word;
1041 bytes_per_word = 1;
1042 tx_fifo = sh_msiof_spi_write_fifo_8;
1043 rx_fifo = sh_msiof_spi_read_fifo_8;
1044 }
1045 }
1046
1047 return 0;
1048}
1049
1050static const struct sh_msiof_chipdata sh_data = {
1051 .bits_per_word_mask = SPI_BPW_RANGE_MASK(8, 32),
1052 .tx_fifo_size = 64,
1053 .rx_fifo_size = 64,
1054 .ctlr_flags = 0,
1055 .min_div_pow = 0,
1056};
1057
1058static const struct sh_msiof_chipdata rcar_gen2_data = {
1059 .bits_per_word_mask = SPI_BPW_MASK(8) | SPI_BPW_MASK(16) |
1060 SPI_BPW_MASK(24) | SPI_BPW_MASK(32),
1061 .tx_fifo_size = 64,
1062 .rx_fifo_size = 64,
1063 .ctlr_flags = SPI_CONTROLLER_MUST_TX,
1064 .min_div_pow = 0,
1065};
1066
1067static const struct sh_msiof_chipdata rcar_gen3_data = {
1068 .bits_per_word_mask = SPI_BPW_MASK(8) | SPI_BPW_MASK(16) |
1069 SPI_BPW_MASK(24) | SPI_BPW_MASK(32),
1070 .tx_fifo_size = 64,
1071 .rx_fifo_size = 64,
1072 .ctlr_flags = SPI_CONTROLLER_MUST_TX,
1073 .min_div_pow = 1,
1074};
1075
1076static const struct of_device_id sh_msiof_match[] = {
1077 { .compatible = "renesas,sh-mobile-msiof", .data = &sh_data },
1078 { .compatible = "renesas,msiof-r8a7743", .data = &rcar_gen2_data },
1079 { .compatible = "renesas,msiof-r8a7745", .data = &rcar_gen2_data },
1080 { .compatible = "renesas,msiof-r8a7790", .data = &rcar_gen2_data },
1081 { .compatible = "renesas,msiof-r8a7791", .data = &rcar_gen2_data },
1082 { .compatible = "renesas,msiof-r8a7792", .data = &rcar_gen2_data },
1083 { .compatible = "renesas,msiof-r8a7793", .data = &rcar_gen2_data },
1084 { .compatible = "renesas,msiof-r8a7794", .data = &rcar_gen2_data },
1085 { .compatible = "renesas,rcar-gen2-msiof", .data = &rcar_gen2_data },
1086 { .compatible = "renesas,msiof-r8a7796", .data = &rcar_gen3_data },
1087 { .compatible = "renesas,rcar-gen3-msiof", .data = &rcar_gen3_data },
1088 { .compatible = "renesas,rcar-gen4-msiof", .data = &rcar_gen3_data },
1089 { .compatible = "renesas,sh-msiof", .data = &sh_data }, /* Deprecated */
1090 {},
1091};
1092MODULE_DEVICE_TABLE(of, sh_msiof_match);
1093
1094#ifdef CONFIG_OF
1095static struct sh_msiof_spi_info *sh_msiof_spi_parse_dt(struct device *dev)
1096{
1097 struct sh_msiof_spi_info *info;
1098 struct device_node *np = dev->of_node;
1099 u32 num_cs = 1;
1100
1101 info = devm_kzalloc(dev, sizeof(struct sh_msiof_spi_info), GFP_KERNEL);
1102 if (!info)
1103 return NULL;
1104
1105 info->mode = of_property_read_bool(np, "spi-slave") ? MSIOF_SPI_SLAVE
1106 : MSIOF_SPI_MASTER;
1107
1108 /* Parse the MSIOF properties */
1109 if (info->mode == MSIOF_SPI_MASTER)
1110 of_property_read_u32(np, "num-cs", &num_cs);
1111 of_property_read_u32(np, "renesas,tx-fifo-size",
1112 &info->tx_fifo_override);
1113 of_property_read_u32(np, "renesas,rx-fifo-size",
1114 &info->rx_fifo_override);
1115 of_property_read_u32(np, "renesas,dtdl", &info->dtdl);
1116 of_property_read_u32(np, "renesas,syncdl", &info->syncdl);
1117
1118 info->num_chipselect = num_cs;
1119
1120 return info;
1121}
1122#else
1123static struct sh_msiof_spi_info *sh_msiof_spi_parse_dt(struct device *dev)
1124{
1125 return NULL;
1126}
1127#endif
1128
1129static struct dma_chan *sh_msiof_request_dma_chan(struct device *dev,
1130 enum dma_transfer_direction dir, unsigned int id, dma_addr_t port_addr)
1131{
1132 dma_cap_mask_t mask;
1133 struct dma_chan *chan;
1134 struct dma_slave_config cfg;
1135 int ret;
1136
1137 dma_cap_zero(mask);
1138 dma_cap_set(DMA_SLAVE, mask);
1139
1140 chan = dma_request_slave_channel_compat(mask, shdma_chan_filter,
1141 (void *)(unsigned long)id, dev,
1142 dir == DMA_MEM_TO_DEV ? "tx" : "rx");
1143 if (!chan) {
1144 dev_warn(dev, "dma_request_slave_channel_compat failed\n");
1145 return NULL;
1146 }
1147
1148 memset(&cfg, 0, sizeof(cfg));
1149 cfg.direction = dir;
1150 if (dir == DMA_MEM_TO_DEV) {
1151 cfg.dst_addr = port_addr;
1152 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
1153 } else {
1154 cfg.src_addr = port_addr;
1155 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
1156 }
1157
1158 ret = dmaengine_slave_config(chan, &cfg);
1159 if (ret) {
1160 dev_warn(dev, "dmaengine_slave_config failed %d\n", ret);
1161 dma_release_channel(chan);
1162 return NULL;
1163 }
1164
1165 return chan;
1166}
1167
1168static int sh_msiof_request_dma(struct sh_msiof_spi_priv *p)
1169{
1170 struct platform_device *pdev = p->pdev;
1171 struct device *dev = &pdev->dev;
1172 const struct sh_msiof_spi_info *info = p->info;
1173 unsigned int dma_tx_id, dma_rx_id;
1174 const struct resource *res;
1175 struct spi_controller *ctlr;
1176 struct device *tx_dev, *rx_dev;
1177
1178 if (dev->of_node) {
1179 /* In the OF case we will get the slave IDs from the DT */
1180 dma_tx_id = 0;
1181 dma_rx_id = 0;
1182 } else if (info && info->dma_tx_id && info->dma_rx_id) {
1183 dma_tx_id = info->dma_tx_id;
1184 dma_rx_id = info->dma_rx_id;
1185 } else {
1186 /* The driver assumes no error */
1187 return 0;
1188 }
1189
1190 /* The DMA engine uses the second register set, if present */
1191 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1192 if (!res)
1193 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1194
1195 ctlr = p->ctlr;
1196 ctlr->dma_tx = sh_msiof_request_dma_chan(dev, DMA_MEM_TO_DEV,
1197 dma_tx_id, res->start + SITFDR);
1198 if (!ctlr->dma_tx)
1199 return -ENODEV;
1200
1201 ctlr->dma_rx = sh_msiof_request_dma_chan(dev, DMA_DEV_TO_MEM,
1202 dma_rx_id, res->start + SIRFDR);
1203 if (!ctlr->dma_rx)
1204 goto free_tx_chan;
1205
1206 p->tx_dma_page = (void *)__get_free_page(GFP_KERNEL | GFP_DMA);
1207 if (!p->tx_dma_page)
1208 goto free_rx_chan;
1209
1210 p->rx_dma_page = (void *)__get_free_page(GFP_KERNEL | GFP_DMA);
1211 if (!p->rx_dma_page)
1212 goto free_tx_page;
1213
1214 tx_dev = ctlr->dma_tx->device->dev;
1215 p->tx_dma_addr = dma_map_single(tx_dev, p->tx_dma_page, PAGE_SIZE,
1216 DMA_TO_DEVICE);
1217 if (dma_mapping_error(tx_dev, p->tx_dma_addr))
1218 goto free_rx_page;
1219
1220 rx_dev = ctlr->dma_rx->device->dev;
1221 p->rx_dma_addr = dma_map_single(rx_dev, p->rx_dma_page, PAGE_SIZE,
1222 DMA_FROM_DEVICE);
1223 if (dma_mapping_error(rx_dev, p->rx_dma_addr))
1224 goto unmap_tx_page;
1225
1226 dev_info(dev, "DMA available");
1227 return 0;
1228
1229unmap_tx_page:
1230 dma_unmap_single(tx_dev, p->tx_dma_addr, PAGE_SIZE, DMA_TO_DEVICE);
1231free_rx_page:
1232 free_page((unsigned long)p->rx_dma_page);
1233free_tx_page:
1234 free_page((unsigned long)p->tx_dma_page);
1235free_rx_chan:
1236 dma_release_channel(ctlr->dma_rx);
1237free_tx_chan:
1238 dma_release_channel(ctlr->dma_tx);
1239 ctlr->dma_tx = NULL;
1240 return -ENODEV;
1241}
1242
1243static void sh_msiof_release_dma(struct sh_msiof_spi_priv *p)
1244{
1245 struct spi_controller *ctlr = p->ctlr;
1246
1247 if (!ctlr->dma_tx)
1248 return;
1249
1250 dma_unmap_single(ctlr->dma_rx->device->dev, p->rx_dma_addr, PAGE_SIZE,
1251 DMA_FROM_DEVICE);
1252 dma_unmap_single(ctlr->dma_tx->device->dev, p->tx_dma_addr, PAGE_SIZE,
1253 DMA_TO_DEVICE);
1254 free_page((unsigned long)p->rx_dma_page);
1255 free_page((unsigned long)p->tx_dma_page);
1256 dma_release_channel(ctlr->dma_rx);
1257 dma_release_channel(ctlr->dma_tx);
1258}
1259
1260static int sh_msiof_spi_probe(struct platform_device *pdev)
1261{
1262 struct spi_controller *ctlr;
1263 const struct sh_msiof_chipdata *chipdata;
1264 struct sh_msiof_spi_info *info;
1265 struct sh_msiof_spi_priv *p;
1266 unsigned long clksrc;
1267 int i;
1268 int ret;
1269
1270 chipdata = of_device_get_match_data(&pdev->dev);
1271 if (chipdata) {
1272 info = sh_msiof_spi_parse_dt(&pdev->dev);
1273 } else {
1274 chipdata = (const void *)pdev->id_entry->driver_data;
1275 info = dev_get_platdata(&pdev->dev);
1276 }
1277
1278 if (!info) {
1279 dev_err(&pdev->dev, "failed to obtain device info\n");
1280 return -ENXIO;
1281 }
1282
1283 if (info->mode == MSIOF_SPI_SLAVE)
1284 ctlr = spi_alloc_slave(&pdev->dev,
1285 sizeof(struct sh_msiof_spi_priv));
1286 else
1287 ctlr = spi_alloc_master(&pdev->dev,
1288 sizeof(struct sh_msiof_spi_priv));
1289 if (ctlr == NULL)
1290 return -ENOMEM;
1291
1292 p = spi_controller_get_devdata(ctlr);
1293
1294 platform_set_drvdata(pdev, p);
1295 p->ctlr = ctlr;
1296 p->info = info;
1297 p->min_div_pow = chipdata->min_div_pow;
1298
1299 init_completion(&p->done);
1300 init_completion(&p->done_txdma);
1301
1302 p->clk = devm_clk_get(&pdev->dev, NULL);
1303 if (IS_ERR(p->clk)) {
1304 dev_err(&pdev->dev, "cannot get clock\n");
1305 ret = PTR_ERR(p->clk);
1306 goto err1;
1307 }
1308
1309 i = platform_get_irq(pdev, 0);
1310 if (i < 0) {
1311 ret = i;
1312 goto err1;
1313 }
1314
1315 p->mapbase = devm_platform_ioremap_resource(pdev, 0);
1316 if (IS_ERR(p->mapbase)) {
1317 ret = PTR_ERR(p->mapbase);
1318 goto err1;
1319 }
1320
1321 ret = devm_request_irq(&pdev->dev, i, sh_msiof_spi_irq, 0,
1322 dev_name(&pdev->dev), p);
1323 if (ret) {
1324 dev_err(&pdev->dev, "unable to request irq\n");
1325 goto err1;
1326 }
1327
1328 p->pdev = pdev;
1329 pm_runtime_enable(&pdev->dev);
1330
1331 /* Platform data may override FIFO sizes */
1332 p->tx_fifo_size = chipdata->tx_fifo_size;
1333 p->rx_fifo_size = chipdata->rx_fifo_size;
1334 if (p->info->tx_fifo_override)
1335 p->tx_fifo_size = p->info->tx_fifo_override;
1336 if (p->info->rx_fifo_override)
1337 p->rx_fifo_size = p->info->rx_fifo_override;
1338
1339 /* init controller code */
1340 ctlr->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
1341 ctlr->mode_bits |= SPI_LSB_FIRST | SPI_3WIRE;
1342 clksrc = clk_get_rate(p->clk);
1343 ctlr->min_speed_hz = DIV_ROUND_UP(clksrc, 1024);
1344 ctlr->max_speed_hz = DIV_ROUND_UP(clksrc, 1 << p->min_div_pow);
1345 ctlr->flags = chipdata->ctlr_flags;
1346 ctlr->bus_num = pdev->id;
1347 ctlr->num_chipselect = p->info->num_chipselect;
1348 ctlr->dev.of_node = pdev->dev.of_node;
1349 ctlr->setup = sh_msiof_spi_setup;
1350 ctlr->prepare_message = sh_msiof_prepare_message;
1351 ctlr->slave_abort = sh_msiof_slave_abort;
1352 ctlr->bits_per_word_mask = chipdata->bits_per_word_mask;
1353 ctlr->auto_runtime_pm = true;
1354 ctlr->transfer_one = sh_msiof_transfer_one;
1355 ctlr->use_gpio_descriptors = true;
1356 ctlr->max_native_cs = MAX_SS;
1357
1358 ret = sh_msiof_request_dma(p);
1359 if (ret < 0)
1360 dev_warn(&pdev->dev, "DMA not available, using PIO\n");
1361
1362 ret = devm_spi_register_controller(&pdev->dev, ctlr);
1363 if (ret < 0) {
1364 dev_err(&pdev->dev, "devm_spi_register_controller error.\n");
1365 goto err2;
1366 }
1367
1368 return 0;
1369
1370 err2:
1371 sh_msiof_release_dma(p);
1372 pm_runtime_disable(&pdev->dev);
1373 err1:
1374 spi_controller_put(ctlr);
1375 return ret;
1376}
1377
1378static int sh_msiof_spi_remove(struct platform_device *pdev)
1379{
1380 struct sh_msiof_spi_priv *p = platform_get_drvdata(pdev);
1381
1382 sh_msiof_release_dma(p);
1383 pm_runtime_disable(&pdev->dev);
1384 return 0;
1385}
1386
1387static const struct platform_device_id spi_driver_ids[] = {
1388 { "spi_sh_msiof", (kernel_ulong_t)&sh_data },
1389 {},
1390};
1391MODULE_DEVICE_TABLE(platform, spi_driver_ids);
1392
1393#ifdef CONFIG_PM_SLEEP
1394static int sh_msiof_spi_suspend(struct device *dev)
1395{
1396 struct sh_msiof_spi_priv *p = dev_get_drvdata(dev);
1397
1398 return spi_controller_suspend(p->ctlr);
1399}
1400
1401static int sh_msiof_spi_resume(struct device *dev)
1402{
1403 struct sh_msiof_spi_priv *p = dev_get_drvdata(dev);
1404
1405 return spi_controller_resume(p->ctlr);
1406}
1407
1408static SIMPLE_DEV_PM_OPS(sh_msiof_spi_pm_ops, sh_msiof_spi_suspend,
1409 sh_msiof_spi_resume);
1410#define DEV_PM_OPS (&sh_msiof_spi_pm_ops)
1411#else
1412#define DEV_PM_OPS NULL
1413#endif /* CONFIG_PM_SLEEP */
1414
1415static struct platform_driver sh_msiof_spi_drv = {
1416 .probe = sh_msiof_spi_probe,
1417 .remove = sh_msiof_spi_remove,
1418 .id_table = spi_driver_ids,
1419 .driver = {
1420 .name = "spi_sh_msiof",
1421 .pm = DEV_PM_OPS,
1422 .of_match_table = of_match_ptr(sh_msiof_match),
1423 },
1424};
1425module_platform_driver(sh_msiof_spi_drv);
1426
1427MODULE_DESCRIPTION("SuperH MSIOF SPI Controller Interface Driver");
1428MODULE_AUTHOR("Magnus Damm");
1429MODULE_LICENSE("GPL v2");
1/*
2 * SuperH MSIOF SPI Master Interface
3 *
4 * Copyright (c) 2009 Magnus Damm
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 */
11
12#include <linux/bitmap.h>
13#include <linux/clk.h>
14#include <linux/completion.h>
15#include <linux/delay.h>
16#include <linux/err.h>
17#include <linux/gpio.h>
18#include <linux/init.h>
19#include <linux/interrupt.h>
20#include <linux/io.h>
21#include <linux/kernel.h>
22#include <linux/platform_device.h>
23#include <linux/pm_runtime.h>
24
25#include <linux/spi/sh_msiof.h>
26#include <linux/spi/spi.h>
27#include <linux/spi/spi_bitbang.h>
28
29#include <asm/unaligned.h>
30
31struct sh_msiof_spi_priv {
32 struct spi_bitbang bitbang; /* must be first for spi_bitbang.c */
33 void __iomem *mapbase;
34 struct clk *clk;
35 struct platform_device *pdev;
36 struct sh_msiof_spi_info *info;
37 struct completion done;
38 unsigned long flags;
39 int tx_fifo_size;
40 int rx_fifo_size;
41};
42
43#define TMDR1 0x00
44#define TMDR2 0x04
45#define TMDR3 0x08
46#define RMDR1 0x10
47#define RMDR2 0x14
48#define RMDR3 0x18
49#define TSCR 0x20
50#define RSCR 0x22
51#define CTR 0x28
52#define FCTR 0x30
53#define STR 0x40
54#define IER 0x44
55#define TDR1 0x48
56#define TDR2 0x4c
57#define TFDR 0x50
58#define RDR1 0x58
59#define RDR2 0x5c
60#define RFDR 0x60
61
62#define CTR_TSCKE (1 << 15)
63#define CTR_TFSE (1 << 14)
64#define CTR_TXE (1 << 9)
65#define CTR_RXE (1 << 8)
66
67#define STR_TEOF (1 << 23)
68#define STR_REOF (1 << 7)
69
70static u32 sh_msiof_read(struct sh_msiof_spi_priv *p, int reg_offs)
71{
72 switch (reg_offs) {
73 case TSCR:
74 case RSCR:
75 return ioread16(p->mapbase + reg_offs);
76 default:
77 return ioread32(p->mapbase + reg_offs);
78 }
79}
80
81static void sh_msiof_write(struct sh_msiof_spi_priv *p, int reg_offs,
82 u32 value)
83{
84 switch (reg_offs) {
85 case TSCR:
86 case RSCR:
87 iowrite16(value, p->mapbase + reg_offs);
88 break;
89 default:
90 iowrite32(value, p->mapbase + reg_offs);
91 break;
92 }
93}
94
95static int sh_msiof_modify_ctr_wait(struct sh_msiof_spi_priv *p,
96 u32 clr, u32 set)
97{
98 u32 mask = clr | set;
99 u32 data;
100 int k;
101
102 data = sh_msiof_read(p, CTR);
103 data &= ~clr;
104 data |= set;
105 sh_msiof_write(p, CTR, data);
106
107 for (k = 100; k > 0; k--) {
108 if ((sh_msiof_read(p, CTR) & mask) == set)
109 break;
110
111 udelay(10);
112 }
113
114 return k > 0 ? 0 : -ETIMEDOUT;
115}
116
117static irqreturn_t sh_msiof_spi_irq(int irq, void *data)
118{
119 struct sh_msiof_spi_priv *p = data;
120
121 /* just disable the interrupt and wake up */
122 sh_msiof_write(p, IER, 0);
123 complete(&p->done);
124
125 return IRQ_HANDLED;
126}
127
128static struct {
129 unsigned short div;
130 unsigned short scr;
131} const sh_msiof_spi_clk_table[] = {
132 { 1, 0x0007 },
133 { 2, 0x0000 },
134 { 4, 0x0001 },
135 { 8, 0x0002 },
136 { 16, 0x0003 },
137 { 32, 0x0004 },
138 { 64, 0x1f00 },
139 { 128, 0x1f01 },
140 { 256, 0x1f02 },
141 { 512, 0x1f03 },
142 { 1024, 0x1f04 },
143};
144
145static void sh_msiof_spi_set_clk_regs(struct sh_msiof_spi_priv *p,
146 unsigned long parent_rate,
147 unsigned long spi_hz)
148{
149 unsigned long div = 1024;
150 size_t k;
151
152 if (!WARN_ON(!spi_hz || !parent_rate))
153 div = parent_rate / spi_hz;
154
155 /* TODO: make more fine grained */
156
157 for (k = 0; k < ARRAY_SIZE(sh_msiof_spi_clk_table); k++) {
158 if (sh_msiof_spi_clk_table[k].div >= div)
159 break;
160 }
161
162 k = min_t(int, k, ARRAY_SIZE(sh_msiof_spi_clk_table) - 1);
163
164 sh_msiof_write(p, TSCR, sh_msiof_spi_clk_table[k].scr);
165 sh_msiof_write(p, RSCR, sh_msiof_spi_clk_table[k].scr);
166}
167
168static void sh_msiof_spi_set_pin_regs(struct sh_msiof_spi_priv *p,
169 u32 cpol, u32 cpha,
170 u32 tx_hi_z, u32 lsb_first)
171{
172 u32 tmp;
173 int edge;
174
175 /*
176 * CPOL CPHA TSCKIZ RSCKIZ TEDG REDG
177 * 0 0 10 10 1 1
178 * 0 1 10 10 0 0
179 * 1 0 11 11 0 0
180 * 1 1 11 11 1 1
181 */
182 sh_msiof_write(p, FCTR, 0);
183 sh_msiof_write(p, TMDR1, 0xe2000005 | (lsb_first << 24));
184 sh_msiof_write(p, RMDR1, 0x22000005 | (lsb_first << 24));
185
186 tmp = 0xa0000000;
187 tmp |= cpol << 30; /* TSCKIZ */
188 tmp |= cpol << 28; /* RSCKIZ */
189
190 edge = cpol ^ !cpha;
191
192 tmp |= edge << 27; /* TEDG */
193 tmp |= edge << 26; /* REDG */
194 tmp |= (tx_hi_z ? 2 : 0) << 22; /* TXDIZ */
195 sh_msiof_write(p, CTR, tmp);
196}
197
198static void sh_msiof_spi_set_mode_regs(struct sh_msiof_spi_priv *p,
199 const void *tx_buf, void *rx_buf,
200 u32 bits, u32 words)
201{
202 u32 dr2 = ((bits - 1) << 24) | ((words - 1) << 16);
203
204 if (tx_buf)
205 sh_msiof_write(p, TMDR2, dr2);
206 else
207 sh_msiof_write(p, TMDR2, dr2 | 1);
208
209 if (rx_buf)
210 sh_msiof_write(p, RMDR2, dr2);
211
212 sh_msiof_write(p, IER, STR_TEOF | STR_REOF);
213}
214
215static void sh_msiof_reset_str(struct sh_msiof_spi_priv *p)
216{
217 sh_msiof_write(p, STR, sh_msiof_read(p, STR));
218}
219
220static void sh_msiof_spi_write_fifo_8(struct sh_msiof_spi_priv *p,
221 const void *tx_buf, int words, int fs)
222{
223 const u8 *buf_8 = tx_buf;
224 int k;
225
226 for (k = 0; k < words; k++)
227 sh_msiof_write(p, TFDR, buf_8[k] << fs);
228}
229
230static void sh_msiof_spi_write_fifo_16(struct sh_msiof_spi_priv *p,
231 const void *tx_buf, int words, int fs)
232{
233 const u16 *buf_16 = tx_buf;
234 int k;
235
236 for (k = 0; k < words; k++)
237 sh_msiof_write(p, TFDR, buf_16[k] << fs);
238}
239
240static void sh_msiof_spi_write_fifo_16u(struct sh_msiof_spi_priv *p,
241 const void *tx_buf, int words, int fs)
242{
243 const u16 *buf_16 = tx_buf;
244 int k;
245
246 for (k = 0; k < words; k++)
247 sh_msiof_write(p, TFDR, get_unaligned(&buf_16[k]) << fs);
248}
249
250static void sh_msiof_spi_write_fifo_32(struct sh_msiof_spi_priv *p,
251 const void *tx_buf, int words, int fs)
252{
253 const u32 *buf_32 = tx_buf;
254 int k;
255
256 for (k = 0; k < words; k++)
257 sh_msiof_write(p, TFDR, buf_32[k] << fs);
258}
259
260static void sh_msiof_spi_write_fifo_32u(struct sh_msiof_spi_priv *p,
261 const void *tx_buf, int words, int fs)
262{
263 const u32 *buf_32 = tx_buf;
264 int k;
265
266 for (k = 0; k < words; k++)
267 sh_msiof_write(p, TFDR, get_unaligned(&buf_32[k]) << fs);
268}
269
270static void sh_msiof_spi_write_fifo_s32(struct sh_msiof_spi_priv *p,
271 const void *tx_buf, int words, int fs)
272{
273 const u32 *buf_32 = tx_buf;
274 int k;
275
276 for (k = 0; k < words; k++)
277 sh_msiof_write(p, TFDR, swab32(buf_32[k] << fs));
278}
279
280static void sh_msiof_spi_write_fifo_s32u(struct sh_msiof_spi_priv *p,
281 const void *tx_buf, int words, int fs)
282{
283 const u32 *buf_32 = tx_buf;
284 int k;
285
286 for (k = 0; k < words; k++)
287 sh_msiof_write(p, TFDR, swab32(get_unaligned(&buf_32[k]) << fs));
288}
289
290static void sh_msiof_spi_read_fifo_8(struct sh_msiof_spi_priv *p,
291 void *rx_buf, int words, int fs)
292{
293 u8 *buf_8 = rx_buf;
294 int k;
295
296 for (k = 0; k < words; k++)
297 buf_8[k] = sh_msiof_read(p, RFDR) >> fs;
298}
299
300static void sh_msiof_spi_read_fifo_16(struct sh_msiof_spi_priv *p,
301 void *rx_buf, int words, int fs)
302{
303 u16 *buf_16 = rx_buf;
304 int k;
305
306 for (k = 0; k < words; k++)
307 buf_16[k] = sh_msiof_read(p, RFDR) >> fs;
308}
309
310static void sh_msiof_spi_read_fifo_16u(struct sh_msiof_spi_priv *p,
311 void *rx_buf, int words, int fs)
312{
313 u16 *buf_16 = rx_buf;
314 int k;
315
316 for (k = 0; k < words; k++)
317 put_unaligned(sh_msiof_read(p, RFDR) >> fs, &buf_16[k]);
318}
319
320static void sh_msiof_spi_read_fifo_32(struct sh_msiof_spi_priv *p,
321 void *rx_buf, int words, int fs)
322{
323 u32 *buf_32 = rx_buf;
324 int k;
325
326 for (k = 0; k < words; k++)
327 buf_32[k] = sh_msiof_read(p, RFDR) >> fs;
328}
329
330static void sh_msiof_spi_read_fifo_32u(struct sh_msiof_spi_priv *p,
331 void *rx_buf, int words, int fs)
332{
333 u32 *buf_32 = rx_buf;
334 int k;
335
336 for (k = 0; k < words; k++)
337 put_unaligned(sh_msiof_read(p, RFDR) >> fs, &buf_32[k]);
338}
339
340static void sh_msiof_spi_read_fifo_s32(struct sh_msiof_spi_priv *p,
341 void *rx_buf, int words, int fs)
342{
343 u32 *buf_32 = rx_buf;
344 int k;
345
346 for (k = 0; k < words; k++)
347 buf_32[k] = swab32(sh_msiof_read(p, RFDR) >> fs);
348}
349
350static void sh_msiof_spi_read_fifo_s32u(struct sh_msiof_spi_priv *p,
351 void *rx_buf, int words, int fs)
352{
353 u32 *buf_32 = rx_buf;
354 int k;
355
356 for (k = 0; k < words; k++)
357 put_unaligned(swab32(sh_msiof_read(p, RFDR) >> fs), &buf_32[k]);
358}
359
360static int sh_msiof_spi_bits(struct spi_device *spi, struct spi_transfer *t)
361{
362 int bits;
363
364 bits = t ? t->bits_per_word : 0;
365 if (!bits)
366 bits = spi->bits_per_word;
367 return bits;
368}
369
370static unsigned long sh_msiof_spi_hz(struct spi_device *spi,
371 struct spi_transfer *t)
372{
373 unsigned long hz;
374
375 hz = t ? t->speed_hz : 0;
376 if (!hz)
377 hz = spi->max_speed_hz;
378 return hz;
379}
380
381static int sh_msiof_spi_setup_transfer(struct spi_device *spi,
382 struct spi_transfer *t)
383{
384 int bits;
385
386 /* noting to check hz values against since parent clock is disabled */
387
388 bits = sh_msiof_spi_bits(spi, t);
389 if (bits < 8)
390 return -EINVAL;
391 if (bits > 32)
392 return -EINVAL;
393
394 return spi_bitbang_setup_transfer(spi, t);
395}
396
397static void sh_msiof_spi_chipselect(struct spi_device *spi, int is_on)
398{
399 struct sh_msiof_spi_priv *p = spi_master_get_devdata(spi->master);
400 int value;
401
402 /* chip select is active low unless SPI_CS_HIGH is set */
403 if (spi->mode & SPI_CS_HIGH)
404 value = (is_on == BITBANG_CS_ACTIVE) ? 1 : 0;
405 else
406 value = (is_on == BITBANG_CS_ACTIVE) ? 0 : 1;
407
408 if (is_on == BITBANG_CS_ACTIVE) {
409 if (!test_and_set_bit(0, &p->flags)) {
410 pm_runtime_get_sync(&p->pdev->dev);
411 clk_enable(p->clk);
412 }
413
414 /* Configure pins before asserting CS */
415 sh_msiof_spi_set_pin_regs(p, !!(spi->mode & SPI_CPOL),
416 !!(spi->mode & SPI_CPHA),
417 !!(spi->mode & SPI_3WIRE),
418 !!(spi->mode & SPI_LSB_FIRST));
419 }
420
421 /* use spi->controller data for CS (same strategy as spi_gpio) */
422 gpio_set_value((unsigned)spi->controller_data, value);
423
424 if (is_on == BITBANG_CS_INACTIVE) {
425 if (test_and_clear_bit(0, &p->flags)) {
426 clk_disable(p->clk);
427 pm_runtime_put(&p->pdev->dev);
428 }
429 }
430}
431
432static int sh_msiof_spi_txrx_once(struct sh_msiof_spi_priv *p,
433 void (*tx_fifo)(struct sh_msiof_spi_priv *,
434 const void *, int, int),
435 void (*rx_fifo)(struct sh_msiof_spi_priv *,
436 void *, int, int),
437 const void *tx_buf, void *rx_buf,
438 int words, int bits)
439{
440 int fifo_shift;
441 int ret;
442
443 /* limit maximum word transfer to rx/tx fifo size */
444 if (tx_buf)
445 words = min_t(int, words, p->tx_fifo_size);
446 if (rx_buf)
447 words = min_t(int, words, p->rx_fifo_size);
448
449 /* the fifo contents need shifting */
450 fifo_shift = 32 - bits;
451
452 /* setup msiof transfer mode registers */
453 sh_msiof_spi_set_mode_regs(p, tx_buf, rx_buf, bits, words);
454
455 /* write tx fifo */
456 if (tx_buf)
457 tx_fifo(p, tx_buf, words, fifo_shift);
458
459 /* setup clock and rx/tx signals */
460 ret = sh_msiof_modify_ctr_wait(p, 0, CTR_TSCKE);
461 if (rx_buf)
462 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, 0, CTR_RXE);
463 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, 0, CTR_TXE);
464
465 /* start by setting frame bit */
466 INIT_COMPLETION(p->done);
467 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, 0, CTR_TFSE);
468 if (ret) {
469 dev_err(&p->pdev->dev, "failed to start hardware\n");
470 goto err;
471 }
472
473 /* wait for tx fifo to be emptied / rx fifo to be filled */
474 wait_for_completion(&p->done);
475
476 /* read rx fifo */
477 if (rx_buf)
478 rx_fifo(p, rx_buf, words, fifo_shift);
479
480 /* clear status bits */
481 sh_msiof_reset_str(p);
482
483 /* shut down frame, tx/tx and clock signals */
484 ret = sh_msiof_modify_ctr_wait(p, CTR_TFSE, 0);
485 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, CTR_TXE, 0);
486 if (rx_buf)
487 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, CTR_RXE, 0);
488 ret = ret ? ret : sh_msiof_modify_ctr_wait(p, CTR_TSCKE, 0);
489 if (ret) {
490 dev_err(&p->pdev->dev, "failed to shut down hardware\n");
491 goto err;
492 }
493
494 return words;
495
496 err:
497 sh_msiof_write(p, IER, 0);
498 return ret;
499}
500
501static int sh_msiof_spi_txrx(struct spi_device *spi, struct spi_transfer *t)
502{
503 struct sh_msiof_spi_priv *p = spi_master_get_devdata(spi->master);
504 void (*tx_fifo)(struct sh_msiof_spi_priv *, const void *, int, int);
505 void (*rx_fifo)(struct sh_msiof_spi_priv *, void *, int, int);
506 int bits;
507 int bytes_per_word;
508 int bytes_done;
509 int words;
510 int n;
511 bool swab;
512
513 bits = sh_msiof_spi_bits(spi, t);
514
515 if (bits <= 8 && t->len > 15 && !(t->len & 3)) {
516 bits = 32;
517 swab = true;
518 } else {
519 swab = false;
520 }
521
522 /* setup bytes per word and fifo read/write functions */
523 if (bits <= 8) {
524 bytes_per_word = 1;
525 tx_fifo = sh_msiof_spi_write_fifo_8;
526 rx_fifo = sh_msiof_spi_read_fifo_8;
527 } else if (bits <= 16) {
528 bytes_per_word = 2;
529 if ((unsigned long)t->tx_buf & 0x01)
530 tx_fifo = sh_msiof_spi_write_fifo_16u;
531 else
532 tx_fifo = sh_msiof_spi_write_fifo_16;
533
534 if ((unsigned long)t->rx_buf & 0x01)
535 rx_fifo = sh_msiof_spi_read_fifo_16u;
536 else
537 rx_fifo = sh_msiof_spi_read_fifo_16;
538 } else if (swab) {
539 bytes_per_word = 4;
540 if ((unsigned long)t->tx_buf & 0x03)
541 tx_fifo = sh_msiof_spi_write_fifo_s32u;
542 else
543 tx_fifo = sh_msiof_spi_write_fifo_s32;
544
545 if ((unsigned long)t->rx_buf & 0x03)
546 rx_fifo = sh_msiof_spi_read_fifo_s32u;
547 else
548 rx_fifo = sh_msiof_spi_read_fifo_s32;
549 } else {
550 bytes_per_word = 4;
551 if ((unsigned long)t->tx_buf & 0x03)
552 tx_fifo = sh_msiof_spi_write_fifo_32u;
553 else
554 tx_fifo = sh_msiof_spi_write_fifo_32;
555
556 if ((unsigned long)t->rx_buf & 0x03)
557 rx_fifo = sh_msiof_spi_read_fifo_32u;
558 else
559 rx_fifo = sh_msiof_spi_read_fifo_32;
560 }
561
562 /* setup clocks (clock already enabled in chipselect()) */
563 sh_msiof_spi_set_clk_regs(p, clk_get_rate(p->clk),
564 sh_msiof_spi_hz(spi, t));
565
566 /* transfer in fifo sized chunks */
567 words = t->len / bytes_per_word;
568 bytes_done = 0;
569
570 while (bytes_done < t->len) {
571 void *rx_buf = t->rx_buf ? t->rx_buf + bytes_done : NULL;
572 const void *tx_buf = t->tx_buf ? t->tx_buf + bytes_done : NULL;
573 n = sh_msiof_spi_txrx_once(p, tx_fifo, rx_fifo,
574 tx_buf,
575 rx_buf,
576 words, bits);
577 if (n < 0)
578 break;
579
580 bytes_done += n * bytes_per_word;
581 words -= n;
582 }
583
584 return bytes_done;
585}
586
587static u32 sh_msiof_spi_txrx_word(struct spi_device *spi, unsigned nsecs,
588 u32 word, u8 bits)
589{
590 BUG(); /* unused but needed by bitbang code */
591 return 0;
592}
593
594static int sh_msiof_spi_probe(struct platform_device *pdev)
595{
596 struct resource *r;
597 struct spi_master *master;
598 struct sh_msiof_spi_priv *p;
599 char clk_name[16];
600 int i;
601 int ret;
602
603 master = spi_alloc_master(&pdev->dev, sizeof(struct sh_msiof_spi_priv));
604 if (master == NULL) {
605 dev_err(&pdev->dev, "failed to allocate spi master\n");
606 ret = -ENOMEM;
607 goto err0;
608 }
609
610 p = spi_master_get_devdata(master);
611
612 platform_set_drvdata(pdev, p);
613 p->info = pdev->dev.platform_data;
614 init_completion(&p->done);
615
616 snprintf(clk_name, sizeof(clk_name), "msiof%d", pdev->id);
617 p->clk = clk_get(&pdev->dev, clk_name);
618 if (IS_ERR(p->clk)) {
619 dev_err(&pdev->dev, "cannot get clock \"%s\"\n", clk_name);
620 ret = PTR_ERR(p->clk);
621 goto err1;
622 }
623
624 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
625 i = platform_get_irq(pdev, 0);
626 if (!r || i < 0) {
627 dev_err(&pdev->dev, "cannot get platform resources\n");
628 ret = -ENOENT;
629 goto err2;
630 }
631 p->mapbase = ioremap_nocache(r->start, resource_size(r));
632 if (!p->mapbase) {
633 dev_err(&pdev->dev, "unable to ioremap\n");
634 ret = -ENXIO;
635 goto err2;
636 }
637
638 ret = request_irq(i, sh_msiof_spi_irq, IRQF_DISABLED,
639 dev_name(&pdev->dev), p);
640 if (ret) {
641 dev_err(&pdev->dev, "unable to request irq\n");
642 goto err3;
643 }
644
645 p->pdev = pdev;
646 pm_runtime_enable(&pdev->dev);
647
648 /* The standard version of MSIOF use 64 word FIFOs */
649 p->tx_fifo_size = 64;
650 p->rx_fifo_size = 64;
651
652 /* Platform data may override FIFO sizes */
653 if (p->info->tx_fifo_override)
654 p->tx_fifo_size = p->info->tx_fifo_override;
655 if (p->info->rx_fifo_override)
656 p->rx_fifo_size = p->info->rx_fifo_override;
657
658 /* init master and bitbang code */
659 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
660 master->mode_bits |= SPI_LSB_FIRST | SPI_3WIRE;
661 master->flags = 0;
662 master->bus_num = pdev->id;
663 master->num_chipselect = p->info->num_chipselect;
664 master->setup = spi_bitbang_setup;
665 master->cleanup = spi_bitbang_cleanup;
666
667 p->bitbang.master = master;
668 p->bitbang.chipselect = sh_msiof_spi_chipselect;
669 p->bitbang.setup_transfer = sh_msiof_spi_setup_transfer;
670 p->bitbang.txrx_bufs = sh_msiof_spi_txrx;
671 p->bitbang.txrx_word[SPI_MODE_0] = sh_msiof_spi_txrx_word;
672 p->bitbang.txrx_word[SPI_MODE_1] = sh_msiof_spi_txrx_word;
673 p->bitbang.txrx_word[SPI_MODE_2] = sh_msiof_spi_txrx_word;
674 p->bitbang.txrx_word[SPI_MODE_3] = sh_msiof_spi_txrx_word;
675
676 ret = spi_bitbang_start(&p->bitbang);
677 if (ret == 0)
678 return 0;
679
680 pm_runtime_disable(&pdev->dev);
681 err3:
682 iounmap(p->mapbase);
683 err2:
684 clk_put(p->clk);
685 err1:
686 spi_master_put(master);
687 err0:
688 return ret;
689}
690
691static int sh_msiof_spi_remove(struct platform_device *pdev)
692{
693 struct sh_msiof_spi_priv *p = platform_get_drvdata(pdev);
694 int ret;
695
696 ret = spi_bitbang_stop(&p->bitbang);
697 if (!ret) {
698 pm_runtime_disable(&pdev->dev);
699 free_irq(platform_get_irq(pdev, 0), p);
700 iounmap(p->mapbase);
701 clk_put(p->clk);
702 spi_master_put(p->bitbang.master);
703 }
704 return ret;
705}
706
707static int sh_msiof_spi_runtime_nop(struct device *dev)
708{
709 /* Runtime PM callback shared between ->runtime_suspend()
710 * and ->runtime_resume(). Simply returns success.
711 *
712 * This driver re-initializes all registers after
713 * pm_runtime_get_sync() anyway so there is no need
714 * to save and restore registers here.
715 */
716 return 0;
717}
718
719static struct dev_pm_ops sh_msiof_spi_dev_pm_ops = {
720 .runtime_suspend = sh_msiof_spi_runtime_nop,
721 .runtime_resume = sh_msiof_spi_runtime_nop,
722};
723
724static struct platform_driver sh_msiof_spi_drv = {
725 .probe = sh_msiof_spi_probe,
726 .remove = sh_msiof_spi_remove,
727 .driver = {
728 .name = "spi_sh_msiof",
729 .owner = THIS_MODULE,
730 .pm = &sh_msiof_spi_dev_pm_ops,
731 },
732};
733
734static int __init sh_msiof_spi_init(void)
735{
736 return platform_driver_register(&sh_msiof_spi_drv);
737}
738module_init(sh_msiof_spi_init);
739
740static void __exit sh_msiof_spi_exit(void)
741{
742 platform_driver_unregister(&sh_msiof_spi_drv);
743}
744module_exit(sh_msiof_spi_exit);
745
746MODULE_DESCRIPTION("SuperH MSIOF SPI Master Interface Driver");
747MODULE_AUTHOR("Magnus Damm");
748MODULE_LICENSE("GPL v2");
749MODULE_ALIAS("platform:spi_sh_msiof");